# UnofficialBuildkiteClient

Unofficial [Buildkite](https://buildkite.com) API client.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'unofficial_buildkite_client'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install unofficial_buildkite_client

## Usage

```ruby
ENV["BUILDKITE_ACCESS_TOKEN"] = "xxxxxxxxxxxxxxx"
client = UnofficialBuildkiteClient.new(org_slug: "rails", pipeline_slug: "rails")
# or
# client = UnofficialBuildkiteClient.new(access_token: "xxxxxxxxxxxxxx", org_slug: "rails", pipeline_slug: "rails")
builds = client.fetch_builds(created_at_from: "2019-04-19T07:00", first: 1, state: ["FAILED", "PASSED"])
build = client.fetch_build(number: builds.first[:number])
job = build[:jobs].first
log = client.fetch_log(build_number: job[:build_number], job_id: job[:id])
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mtsmfm/unofficial_buildkite_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the UnofficialBuildkiteClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/unofficial_buildkite_client/blob/master/CODE_OF_CONDUCT.md).