https://github.com/topfreegames/simple_gcm
https://github.com/topfreegames/simple_gcm
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/topfreegames/simple_gcm
- Owner: topfreegames
- License: mit
- Created: 2015-02-11T17:07:16.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-02-11T17:18:08.000Z (over 10 years ago)
- Last Synced: 2023-08-01T23:50:06.593Z (about 2 years ago)
- Language: Ruby
- Size: 176 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gcm (Google Cloud Messaging)
simple_gcm sends push notifications to Android devices via google [gcm](http://developer.android.com/guide/google/gcm/index.html).
##Installation
```console
$ gem install simple_gcm
```
##Requirements
An Android device running 2.2 or newer, its registration token, and a google API Key registered for gcm.
##Usage
Sending one notification at a time:
```ruby
require 'simple_gcm'
sender = SimpleGCM::Sender.new(api_key: "your_api_key")
message = SimpleGCM::Message.new(:data => {alert => "your message"})
begin
result = sender.send(:registration_id => "your_phone_registration_id", :message => message)
puts result.message_id
puts result.registration_id
rescue SimpleGCM::Error::MissingRegistration => e; puts e
rescue SimpleGCM::Error::InvalidRegistration => e; puts e
rescue SimpleGCM::Error::MismatchSenderId => e; puts e
rescue SimpleGCM::Error::NotRegistered => e; puts e
rescue SimpleGCM::Error::MessageTooBig => e; puts e
rescue SimpleGCM::Error::AuthenticationError => e; puts e
rescue SimpleGCM::Error::ServerUnavailable => e; puts e
rescue SimpleGCM::Error::Unknown => e; puts e
rescue Exception => e
end
```
## Contributing to gcm
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
## Copyright
Copyright (c) 2012 Leonardo Bessa. See LICENSE.txt for
further details.