Project

rapns_rails_2

0.0
No commit activity in last 3 years
No release in over 3 years
rapns_rails_2marcrohloff/rapns_rails_2HomepageDocumentationSource CodeWiki
Professional grade APNs and GCM for Ruby with Rails 2 compatibility
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,952
Stars
2
Forks
0
Watchers
2
 Releases
Current version
3.6.1
Total releases
4
First release
2013-10-02
Latest release
2020-08-12
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Average date of last 50 commits
2014-04-25
Reverse Dependencies
0

 Dependencies

Runtime

multi_json
~> 1.0
net-http-persistent
>= 0
 Project Readme

Build Status Code Climate

Rapns - Professional grade APNs and GCM for Ruby.

  • Supports both APNs (iOS) and GCM (Google Cloud Messaging, Android).
  • 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.
  • Built with love.

Who uses Rapns?

GateGuru and Desk.com, among others!

I'd love to hear if you use Rapns - @ileitch on twitter.

Getting Started

Add Rapns to your Gemfile:

gem 'rapns'

Generate the migrations, rapns.yml and migrate:

rails g rapns
rake db:migrate

Create an App & Notification

APNs

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 apns_certificate_will_expire reflection to monitor when your certificate is due to expire.

GCM

Note: This version is updated to use the legacy FCM API

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.

Starting Rapns

As a daemon:

cd /path/to/rails/app
rapns <Rails environment> [options]

Inside an existing process (see Embedding API):

Rapns.embed

Please note that only ever a single instance of Rapns should be running.

In a scheduler (see Push API):

Rapns.push
Rapns.apns_feedback

See Configuration for a list of options, or run rapns --help.

Updating Rapns

After updating you should run rails g rapns to check for any new migrations.

Wiki

General

APNs

GCM

Contributing

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.

Contributors

Thank you to the following wonderful people for contributing: