Rocket Pants is a neat API builder for Rails built on top of Action Controller.
It comes with a lot of functionalities such as automatic response meta data, rspec support and out of box ActiveRecord error mapping, just to name a few.
Rocket pants also captures errors that have happened on the server side and serves the API consumer with a nice json:
But since rocket pants handles capturing errors for you, your regular error tracking tool such as Airbrake or Bugsnag won’t be able to catch it - e.g. you won’t get a notification or an email that something went wrong!
I’ve crawled around the code base to figure out how to push a notication when something goes wrong. Somebody failed to mention this in the README - but there’s also a error tracking support module.
Or if you’re using some other service, you can add a custom notifier:
I ended up submitting some pull requests to get automatic support for Bugsnag and to get the documentation updated which got merged pretty fast and should be released in the next version of Rocket Pants.
I would say that this is an textbook example of contributing with documentation - if someone else did this, (s)he would save me at least an hour of going around the codebase, finding a module I didn’t know even existed and implementing it in my app.