Table of Contents

1. Supported Ruby versions
2. Supported frameworks
3. Documentation
4. Changelog
5. Contributing
   1. To contribute your code:
   2. Running the tests
   3. License

Honeybadger for Ruby

This is the notifier gem for integrating apps with the :zap: Honeybadger Exception Notifier for Ruby and Rails.

When an uncaught exception occurs, Honeybadger will POST the relevant data to the Honeybadger server specified in your environment.

Supported Ruby versions

Honeybadger officially supports the following Ruby versions and implementations:

Ruby	Version
MRI	>= 1.9.3
JRuby	>= 1.7 (1.9 mode)
Rubinius	>= 2.0

Supported frameworks

The following frameworks are supported:

Framework	Version	Native?
Rails	>= 3.0	yes
Sinatra	>= 1.2.1	yes
Rack	>= 1.0	middleware

Rails and Sinatra are supported natively (install/configure the gem and you're done). For vanilla Rack apps, we provide a collection of middleware that must be installed manually.

Integrating with other libraries/frameworks is simple! See the documentation to learn about our public API, and see Contributing to suggest a patch.

Documentation

• Basic usage
• Full documentation

Changelog

See https://github.com/honeybadger-io/honeybadger-ruby/releases

Contributing

If you're adding a new feature, please submit an issue as a preliminary step; that way you can be (moderately) sure that your pull request will be accepted.

To contribute your code:

1. Fork it.
2. Create a topic branch git checkout -b my_branch
3. Commit your changes git commit -am "Boom"
4. Push to your branch git push origin my_branch
5. Send a pull request

Running the tests

We're using the Appraisal gem to run our RSpec test suite against multiple versions of Rails.

• The unit test suite can be run with rake (aliased to rake spec:unit).
• The integration test suite can be run with rake spec:features.

License

The Honeybadger gem is MIT licensed. See the LICENSE file in this repository for details.