The sick-beard gem provides a Ruby interface for interacting with the Sick Beard PRV API. Pull requests are always welcome.
Drop me a message for any questions, suggestions, requests, bugs or submit them to the issue log.
Add this line to your application's Gemfile:
gem 'sick-beard'
And then execute:
$ bundle
Or install it yourself as:
$ gem install sick-beard
The specs for this Gem should give you some idea of how to make use of the API. For now they will be the usage information. As always Pull Requests for better documentation are welcome.
The tests for the API have been mocked using VCR and WebMock.
Actual calls to a Sick Beard have been mocked out to prevent storage of valid API credentials and making superflous API calls while testing. As such, in order to run existing tests, using the mocked API requests, the only thing that needs to be done is to run the specs (e.g., bundle exec rake spec or bundle exec guard start).
However, if you want to refresh the actual server API responses you will need to re-record all of the VCR cassettes. This can be achieved simply by performing the following two steps:
- Delete all the cassettes (
rm spec/cassettes/*.yml) - Run specs passing the API key as environment variable (
SICKBEARD_API_URI='http://uri.to/sickbeard' SICBEARD_API_KEY=realapikey bundle exec rake spec)
- Fork it
- Create a topic branch (
git checkout -b topic) - Make your changes
- Squash your changes into one commit
- Create new Pull Request against this squashed commit
This is a permanent fork of bigkevmcd / sickbeard. Thank you to Kevin McDermott for a starting point.