Contents

Bugsnag API Toolkit for Ruby
============================

The library allows for quick read/write access to the [Bugsnag API](https://bugsnag.com/docs/api) from your Ruby applications. You can use this library to build your own applications which leverage data found in your Bugsnag dashboard.

If you are looking to automatically detect crashes in your Ruby apps, you should take a look at the [Bugsnag Ruby Detection Library](https://bugsnag.com/docs/notifiers/ruby) instead.

This library shares code and philosophies with the fantastic [Octokit](https://github.com/octokit/octokit.rb) library.


## Installation

Add this line to your application's Gemfile:

    gem "bugsnag-api"

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install bugsnag-api


## Usage

```ruby
# Configure a Bugsnag API client
Bugsnag::Api.configure do |config|
  config.auth_token = "your-account-api-token"
end

# Fetch information about the authenticated account
account = Bugsnag::Api.account

# Get a list of users on this account
users = Bugsnag::Api.users(account.id)

# Get a list of the projects on this account
projects = Bugsnag::Api.projects(account.id)

# Get a list of errors on a project
errors = Bugsnag::Api.errors(projects.first.id)
```


## Documentation

Full documentation of available methods can be found here:
<http://rubydoc.info/github/bugsnag/bugsnag-api-ruby>


## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
bugsnag-api-1.0.1	README.md