boyhood

Boyhood

WaterBoy Ruby Client

Installation

Add this line to your application's Gemfile:

gem 'boyhood'

And then execute:

$ bundle

Or install it yourself as:

$ gem install boyhood

Usage

  # Sends a notification.
  Boyhood.api_key = "YOUR_API_KEY"
  Boyhood.notify(
    notification: "some_notification_id",
    recipient: {users: [{id: 123456}]},
    data: {some: "data"}
  )

  # Finds sample data for a notification.
  Boyhood.sample_data('some_notification_id', default_value: 'DEFAULT_VALUE')

See all options at https://github.com/edmodo/waterboy#send-notifications-using-rest-api

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/[my-github-username]/boyhood/fork )
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 a new Pull Request