Rgcm
Ruby mapper for Google Cloud Messaging
Installation
Add this line to your application's Gemfile:
gem 'rgcm'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rgcm
Usage
Rgcm::Message.new('_API_KEY_').post('_GCM_REGESTRATION_ID_', { foo: 'bar' }) # => Rgcm::Response
Rgcm::Message.new('_API_KEY_').post(['_GCM_REGESTRATION_ID_1_', '_GCM_REGESTRATION_ID_2_'], { foo: 'bar' }) # => Rgcm::Response
With collapse_key:
Rgcm::Message.new('_API_KEY_').post('_GCM_REGESTRATION_ID_', { foo: 'bar' }, {collapse_key: 'collapse_key'}) # => Rgcm::Response
With time_to_live:
Rgcm::Message.new('_API_KEY_').post('_GCM_REGESTRATION_ID_', { foo: 'bar' }, {time_to_live: 3}) # => Rgcm::Response
With rails YML config file:
development:
api_key: '_API_KEY_'
test:
api_key: '_API_KEY_'
production:
api_key: '_API_KEY_'
Rgcm::Message.new.post('_GCM_REGESTRATION_ID_', { foo: 'bar' }) # => Rgcm::Response
Rgcm::Message.new.post(['_GCM_REGESTRATION_ID_1_', '_GCM_REGESTRATION_ID_2_'], { foo: 'bar' }) # => Rgcm::Response
Rgcm::Response methods:
{
"multicast_id":5030383832068975557,
"success":1,
"failure":0,
"canonical_ids":0,
"results":[
{ "message_id":"0:1403425286258916%62dfd0f6e116c072" }
]
}
response = Rgcm::Message.new('_API_KEY_').post('_GCM_REGESTRATION_ID_', { foo: 'bar' })
response.count_successes # => 1
response.count_failures # => 0
response.has_successes? # => true
response.has_failures? # => false
response.results # => '{ "message_id":"0:1403425286258916%62dfd0f6e116c072" }'
response.results_with_successes # => '{ "message_id":"0:1403425286258916%62dfd0f6e116c072" }'
response.results_with_errors # => nil
response.results_with_canonical_ids # => nil
Contributing
- Fork it ( http://github.com//rgcm/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request