Rushover
A simple ruby Pushover client. Pushover allows sending simple push notifications to clients on iOS and Android devices.
Installation
Add this line to your application's Gemfile:
gem 'rushover'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rushover
Usage
require "rushover"
client = Rushover::Client.new(your_app_token)
resp = client.notify(user_key, "some message", :priority => 1, :title => "a title!")
resp.ok? # => true
# You can also send emergency priority 2 messages
# Note you must provide expire and retry options for this to succeed
client.notify(user_key, "some message", :priority => 2, :expire => 180, :retry => 60)
# Check a receipt
client.receipt("S2sXbSL2IKfl6caouD8hJXVn4SoD36")
# Validate that a user exists
client.validate!(existing_user_key) # => true
client.validate!(existing_user_key, existing_device) # => true
# Also provides a User class for convenience. Just keeps the user key
# around if you want to deal with a User object
user = Rushover::User.new(user_key, rushover_client)
user.notify("some user message", :title => "another title")Optional params to the Pushover like priority or title are passed through.
Calls to #notify will return a Rushover::Response. Pushover app uses
:status => 1 for success, 0 for failures. The response can be checked for
success with #ok?, or mined like a plain old hash.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request