- Supports both APNs (iOS) and GCM (Google Cloud Messaging, Android).
- Seamless Rails integration.
- Scalable - choose the number of threads each app spawns.
- Designed for uptime - signal -HUP to add, update apps.
- Stable - reconnects database and network connections when lost.
- Works with MRI, JRuby, Rubinius 1.8 and 1.9.
- Airbrake integration.
2.x users please read upgrading from 2.x to 3.0
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
-
Open up Keychain Access and select the
Certificatescategory in the sidebar. -
Expand the disclosure arrow next to the iOS Push Services certificate you want to export.
-
Select both the certificate and private key.
-
Right click and select
Export 2 items.... -
Save the file as
cert.p12, make sure the File Format isPersonal Information Exchange (p12). -
If you decide to set a password for your exported certificate, please read the 'Adding Apps' section below.
-
Convert the certificate to a .pem, where
<environment>should bedevelopmentorproduction, depending on the certificate you exported.openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem
app = Rapns::Apns::App.new
app.name = "ios_app"
app.certificate = File.read("/path/to/development.pem")
app.environment = "development"
app.password = "certificate password"
app.connections = 1
app.save!app = Rapns::Gcm::App.new
app.name = "android_app"
app.auth_key = "..."
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!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!cd /path/to/rails/app
rapns <Rails environment> [options]
See Configuration for a list of options, or run rapns --help.
After updating you should run rails g rapns to check for any new migrations.
- 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.
Thank you to the following wonderful people for contributing: