- Supports both APNs (iOS), GCM (Google Cloud Messaging, Android), ADM (Amazon Device Messaging) and WPNs (Windows Phone).
- Seamless Rails (3, 4) integration.
- Scalable - choose the number of persistent connections for each app.
- Designed for uptime - signal -HUP to add, update apps.
- Stable - reconnects database and network connections when lost.
- Run as a daemon or inside an existing processs.
- Use in a scheduler for low-workload deployments (Push API).
- Reflection API for fine-grained instrumentation and error handling (Reflection API).
- Works with MRI, JRuby, Rubinius 1.9, 2.0, 2.1.
- Built with love.
GateGuru and Desk.com, among others!
I'd love to hear if you use Rapns - @ileitch on twitter.
Add Rapns to your Gemfile:
gem 'rapns'
Generate the migrations, rapns.yml and migrate:
rails g rapns
rake db:migrate
If this is your first time using the APNs, you will need to generate SSL certificates. See Generating Certificates for instructions.
app = Rapns::Apns::App.new
app.name = "ios_app"
app.certificate = File.read("/path/to/sandbox.pem")
app.environment = "sandbox" # APNs environment.
app.password = "certificate password"
app.connections = 1
app.save!n = Rapns::Apns::Notification.new
n.app = Rapns::Apns::App.find_by_name("ios_app")
n.device_token = "..."
n.alert = "hi mom!"
n.attributes_for_device = {:foo => :bar}
n.save!You should also implement the ssl_certificate_will_expire reflection to monitor when your certificate is due to expire.
app = Rapns::Gcm::App.new
app.name = "android_app"
app.auth_key = "..."
app.connections = 1
app.save!n = Rapns::Gcm::Notification.new
n.app = Rapns::Gcm::App.find_by_name("android_app")
n.registration_ids = ["..."]
n.data = {:message => "hi mom!"}
n.save!GCM also requires you to respond to Canonical IDs.
app = Rapns::Adm::App.new
app.name = "kindle_app"
app.client_id = "..."
app.client_secret = "..."
app.connections = 1
app.save!n = Rapns::Adm::Notification.new
n.app = Rapns::Adm::App.find_by_name("kindle_app")
n.registration_ids = ["..."]
n.data = {:message => "hi mom!"}
n.collapse_key = "Optional consolidationKey"
n.save!For more documentation on ADM.
app = Rapns::Wpns::App.new
app.name = "windows_phone_app"
app.connections = 1
app.save!n = Rapns::Wpns::Notification.new
n.app = Rapns::Wpns::App.find_by_name("windows_phone_app")
n.uri = "http://..."
n.alert = "..."
n.save!As a daemon:
cd /path/to/rails/app
rapns <Rails environment> [options]
Inside an existing process (see Embedding API):
Rapns.embedPlease note that only ever a single instance of Rapns should be running.
In a scheduler (see Push API):
Rapns.push
Rapns.apns_feedbackSee Configuration for a list of options, or run rapns --help.
After updating you should run rails g rapns to check for any new migrations.
To clean up completed (delivered or failed) notifications:
bundle exec rake rapns:notifications:clean DAYS=<Number of days greater than 0>
- Configuration
- Upgrading from 2.x to 3.0
- Deploying to Heroku
- Hot App Updates
- Signals
- Reflection API
- Push API
- Embedding API
- Implementing your own storage backend
- Generating Certificates
- Advanced APNs Features
- APNs Delivery Failure Handling
- Why open multiple connections to the APNs?
- Silent failures might be dropped connections
Fork as usual and go crazy!
When running specs, please note that the ActiveRecord adapter can be changed by setting the ADAPTER environment variable. For example: ADAPTER=postgresql rake.
Available adapters for testing are mysql, mysql2 and postgresql.
Note that the database username is changed at runtime to be the currently logged in user's name. So if you're testing with mysql and you're using a user named 'bob', you will need to grant a mysql user 'bob' access to the 'rapns_test' mysql database.