Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

RAPNS IS NOW RPUSH

  • Loading branch information...
commit af4627eb5328ca002decee9edc3cef4dcc1259f0 1 parent 2c78490
@ileitch authored
Showing with 3 additions and 189 deletions.
  1. +3 −189 README.md
View
192 README.md
@@ -1,191 +1,5 @@
-[![Build Status](https://secure.travis-ci.org/ileitch/rapns.png?branch=master)](http://travis-ci.org/ileitch/rapns)
-[![Code Climate](https://codeclimate.com/github/ileitch/rapns.png)](https://codeclimate.com/github/ileitch/rapns)
-[![Coverage Status](https://coveralls.io/repos/ileitch/rapns/badge.png?branch=master)](https://coveralls.io/r/ileitch/rapns?branch=master)
-[![Gem Version](https://badge.fury.io/rb/rapns.png)](http://badge.fury.io/rb/rapns)
+# RAPNS HAS MOVED.
-### Rapns - Professional grade APNs, GCM, ADM and WPNs for Ruby.
+## It is now called Rpush, the repository is here: [https://github.com/rpush/rpush](https://github.com/rpush/rpush).
-* 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](https://github.com/ileitch/rapns/wiki/Embedding-API).
-* Use in a scheduler for low-workload deployments ([Push API](https://github.com/ileitch/rapns/wiki/Push-API)).
-* Reflection API for fine-grained instrumentation and error handling ([Reflection API](https://github.com/ileitch/rapns/wiki/Reflection-API)).
-* Works with MRI, JRuby, Rubinius 1.9, 2.0, 2.1.
-* Built with love.
-
-### Who uses Rapns?
-
-[GateGuru](http://gateguruapp.com) and [Desk.com](http://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](https://github.com/ileitch/rapns/wiki/Generating-Certificates) for instructions.
-
-```ruby
-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!
-```
-
-```ruby
-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](https://github.com/ileitch/rapns/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
-
-#### GCM
-
-```ruby
-app = Rapns::Gcm::App.new
-app.name = "android_app"
-app.auth_key = "..."
-app.connections = 1
-app.save!
-```
-
-```ruby
-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](https://github.com/ileitch/rapns/wiki/Canonical-IDs).
-
-#### ADM
-
-```ruby
-app = Rapns::Adm::App.new
-app.name = "kindle_app"
-app.client_id = "..."
-app.client_secret = "..."
-app.connections = 1
-app.save!
-```
-
-```ruby
-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](https://developer.amazon.com/sdk/adm.html).
-
-#### WPNS
-
-```ruby
-app = Rapns::Wpns::App.new
-app.name = "windows_phone_app"
-app.connections = 1
-app.save!
-```
-
-```ruby
-n = Rapns::Wpns::Notification.new
-n.app = Rapns::Wpns::App.find_by_name("windows_phone_app")
-n.uri = "http://..."
-n.alert = "..."
-n.save!
-```
-
-## Starting Rapns
-
-As a daemon:
-
- cd /path/to/rails/app
- rapns <Rails environment> [options]
-
-Inside an existing process (see [Embedding API](https://github.com/ileitch/rapns/wiki/Embedding-API)):
-
-```ruby
-Rapns.embed
-```
-
-*Please note that only ever a single instance of Rapns should be running.*
-
-In a scheduler (see [Push API](https://github.com/ileitch/rapns/wiki/Push-API)):
-
-```ruby
-Rapns.push
-Rapns.apns_feedback
-```
-
-See [Configuration](https://github.com/ileitch/rapns/wiki/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.
-
-## Rake task
-
-To clean up completed (*delivered* or *failed*) notifications:
-
- bundle exec rake rapns:notifications:clean DAYS=<Number of days greater than 0>
-
-## Wiki
-
-### General
-* [Configuration](https://github.com/ileitch/rapns/wiki/Configuration)
-* [Upgrading from 2.x to 3.0](https://github.com/ileitch/rapns/wiki/Upgrading-from-version-2.x-to-3.0)
-* [Deploying to Heroku](https://github.com/ileitch/rapns/wiki/Heroku)
-* [Hot App Updates](https://github.com/ileitch/rapns/wiki/Hot-App-Updates)
-* [Signals](https://github.com/ileitch/rapns/wiki/Signals)
-* [Reflection API](https://github.com/ileitch/rapns/wiki/Reflection-API)
-* [Push API](https://github.com/ileitch/rapns/wiki/Push-API)
-* [Embedding API](https://github.com/ileitch/rapns/wiki/Embedding-API)
-* [Implementing your own storage backend](https://github.com/ileitch/rapns/wiki/Implementing-your-own-storage-backend)
-
-### APNs
-* [Generating Certificates](https://github.com/ileitch/rapns/wiki/Generating-Certificates)
-* [Advanced APNs Features](https://github.com/ileitch/rapns/wiki/Advanced-APNs-Features)
-* [APNs Delivery Failure Handling](https://github.com/ileitch/rapns/wiki/APNs-Delivery-Failure-Handling)
-* [Why open multiple connections to the APNs?](https://github.com/ileitch/rapns/wiki/Why-open-multiple-connections-to-the-APNs%3F)
-* [Silent failures might be dropped connections](https://github.com/ileitch/rapns/wiki/Dropped-connections)
-
-### GCM
-* [Notification Options](https://github.com/ileitch/rapns/wiki//GCM-Notification-Options)
-* [Canonical IDs](https://github.com/ileitch/rapns/wiki/Canonical-IDs)
-* [Delivery Failures & Retries](https://github.com/ileitch/rapns/wiki/Delivery-Failures-&-Retries)
-
-## 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.
+### Instructions for migrating are here: [https://github.com/rpush/rpush/wiki/Moving-from-Rapns-to-Rpush](https://github.com/rpush/rpush/wiki/Moving-from-Rapns-to-Rpush).
Please sign in to comment.
Something went wrong with that request. Please try again.