rpush 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 915d2b22f7338ed473b11711d2928b99f77b140d
+  data.tar.gz: 70614eb04113241f04021e1d691bd595a12bb0d3
+SHA512:
+  metadata.gz: d307e38e19be35ffd0bafcef76e5601371760b78d0f4fb6481d223a9db5a3ff706ca527eb61ee315b1f53f30c576b8d93fe8f402462371c864eb6f92b052f633
+  data.tar.gz: fd82f029800ef107c7b0cb312084763244e11a5f499add5f0530133b59737f1d98a8db7274dbaedbbcc17c62f9858559c0a4d4c25e9252ffd4d0841e20f8a15d

data/CHANGELOG.md

@@ -0,0 +1,99 @@
+## 1.0.0 (Feb 9, 2014)
+  * Renamed to Rpush (from Rapns). Version number reset to 1.0.0.
+  * Reduce default batch size to 100.
+  * Fix sqlite3 support (#160).
+  * Drop support for Ruby 1.8.
+  * Improve APNs certificate validation errors (#192) @mattconnolly).
+  * Support for Windows Phone notifications (#191) (@matiaslina).
+  * Support for Amazon device messaging (#173) (@darrylyip).
+  * Add two new GCM reflections: gcm_delivered_to_recipient, gcm_failed_to_recipient (#184) (@jakeonfire).
+  * Fix migration issues (#181) (@jcoleman).
+  * Add GCM gcm_invalid_registration_id reflection (#171) (@marcrohloff).
+  * Feature: wakeup feeder via UDP socket (#164) (@mattconnolly).
+  * Fix reflections when using batches (#161).
+  * Only perform APNs certificate validation for APNs apps (#133).
+  * The deprecated on_apns_feedback has now been removed.
+  * The deprecated airbrake_notify config option has been removed.
+  * Removed the deprecated ability to set attributes_for_device using mass-assignment.
+  * Fixed issue where database connections may not be released from the connection pool.
+
+## 3.4.1 (Aug 30, 2013)
+  * Silence unintended airbrake_notify deprecation warning (#158).
+  * Add :dependent => :destroy to app notifications (#156).
+
+## 3.4.0 (Aug 28, 2013)
+  * Rails 4 support.
+  * Add apns_certificate_will_expire reflection.
+  * Perform storage update in batches where possible, to increase throughput.
+  * airbrake_notify is now deprecated, use the Reflection API instead.
+  * Fix calling the notification_delivered reflection twice (#149).
+
+## 3.3.2 (June 30, 2013)
+  * Fix Rails 3.0.x compatibility (#138) (@yoppi).
+  * Ensure Rails does not set a default value for text columns (#137).
+  * Fix error in down action for add_gcm migration (#135) (@alexperto).
+
+## 3.3.1 (June 2, 2013)
+  * Fix compatibility with postgres_ext (#104).
+  * Add ability to switch the logger (@maxsz).
+  * Do not validate presence of alert, badge or sound - not actually required by the APNs (#129) (@wilg).
+  * Catch IOError from an APNs connection. (@maxsz).
+  * Allow nested hashes in APNs notification attributes (@perezda).
+
+## 3.3.0 (April 21, 2013)
+  * GCM: collapse_key is no longer required to set expiry (time_to_live).
+  * Add reflection for GCM canonical IDs.
+  * Add Rpush::Daemon.store to decouple storage backend.
+
+## 3.2.0 (Apr 1, 2013)
+  * Rpush.apns_feedback for one time feedback retrieval. Rpush.push no longer checks for feedback (#117, #105).
+  * Lazily connect to the APNs only when a notification is to be delivered (#111).
+  * Ensure all notifications are sent when using Rpush.push (#107).
+  * Fix issue with running Rpush.push more than once in the same process (#106).
+
+## 3.1.0 (Jan 26, 2013)
+  * Rpush.reflect API for fine-grained introspection.
+  * Rpush.embed API for embedding Rpush into an existing process.
+  * Rpush.push API for using Rpush in scheduled jobs.
+  * Fix issue with integration with ActiveScaffold (#98) (@jeffarena).
+  * Fix content-available setter for APNs (#95) (@dup2).
+  * GCM validation fixes (#96) (@DianthuDia).
+
+## 3.0.1 (Dec 16, 2012)
+  * Fix compatibility with Rails 3.0.x. Fixes #89.
+
+## 3.0.0 (Dec 15, 2012)
+  * Add support for Google Cloud Messaging.
+  * Fix Heroku logging issue.
+
+##  2.0.5 (Nov 4, 2012) ##
+  * Support content-available (#68).
+  * Append to log files.
+  * Fire a callback when Feedback is received.
+
+## 2.0.5.rc1 (Oct 5, 2012) ##
+  * Release db connections back into the pool after use (#72).
+  * Continue to start daemon if a connection cannot be made during startup (#62) (@mattconnolly).
+
+## 2.0.4 (Aug 6, 2012) ##
+  * Don't exit when there aren't any Rpush::App instances, just warn (#55).
+
+## 2.0.3 (July 26, 2012) ##
+  * JRuby support.
+  * Explicitly list all attributes instead of calling column_names (#53).
+
+## 2.0.2 (July 25, 2012) ##
+  * Support MultiJson < 1.3.0.
+  * Make all model attributes accessible.
+
+## 2.0.1 (July 7, 2012) ##
+  * Fix delivery when using Ruby 1.8.
+  * MultiJson support.
+
+## 2.0.0 (June 19, 2012) ##
+
+  * Support for multiple apps.
+  * Hot Updates - add/remove apps without restart.
+  * MDM support.
+  * Removed rpush.yml in favour of command line options.
+  * Started the changelog!

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Ian Leitch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,189 @@
+[![Build Status](https://secure.travis-ci.org/rpush/rpush.png?branch=master)](http://travis-ci.org/rpush/rpush)
+[![Code Climate](https://codeclimate.com/github/rpush/rpush.png)](https://codeclimate.com/github/rpush/rpush)
+[![Coverage Status](https://coveralls.io/repos/rpush/rpush/badge.png?branch=master)](https://coveralls.io/r/rpush/rpush?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rpush.png)](http://badge.fury.io/rb/rpush)
+
+<img src="https://raw.github.com/rpush/rpush/master/rpush.png" align="right" width="200px" />
+
+### Rpush. The push notification service for Ruby.
+
+* Supports:
+  * **Apple Push Notification Service**
+  * **Google Cloud Messaging)**
+  * **Amazon Devide Messaging**
+  * **Windows Push Notification Service**.
+* Seamless Rails (3, 4) integration.
+* Scalable - choose the number of persistent connections for each app.
+* Designed for uptime - signal -HUP to add, update apps.
+* Run as a daemon or inside an [existing processs](https://github.com/rpush/rpush/wiki/Embedding-API).
+* Use in a scheduler for low-workload deployments ([Push API](https://github.com/rpush/rpush/wiki/Push-API)).
+* Hooks for fine-grained instrumentation and error handling ([Reflection API](https://github.com/rpush/rpush/wiki/Reflection-API)).
+* Works with MRI, JRuby, Rubinius 1.9, 2.0, 2.1.
+
+
+### Getting Started
+
+Add it to your Gemfile:
+
+```ruby
+gem 'rpush'
+```
+
+Generate the migrations, rpush.yml and migrate:
+
+```
+rails g rpush
+rake db:migrate
+```
+
+### Create an App & Notification
+
+#### Apple Push Notification Service
+
+If this is your first time using the APNs, you will need to generate SSL certificates. See [Generating Certificates](https://github.com/rpush/rpush/wiki/Generating-Certificates) for instructions.
+
+```ruby
+app = Rpush::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 = Rpush::Apns::Notification.new
+n.app = Rpush::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/rpush/rpush/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
+
+#### Google Cloud Messaging
+
+```ruby
+app = Rpush::Gcm::App.new
+app.name = "android_app"
+app.auth_key = "..."
+app.connections = 1
+app.save!
+```
+
+```ruby
+n = Rpush::Gcm::Notification.new
+n.app = Rpush::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/rpush/rpush/wiki/Canonical-IDs).
+
+#### Amazon Device Messaging
+
+```ruby
+app = Rpush::Adm::App.new
+app.name = "kindle_app"
+app.client_id = "..."
+app.client_secret = "..."
+app.connections = 1
+app.save!
+```
+
+```ruby
+n = Rpush::Adm::Notification.new
+n.app = Rpush::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).
+
+#### Windows Phone Notification Service
+
+```ruby
+app = Rpush::Wpns::App.new
+app.name = "windows_phone_app"
+app.connections = 1
+app.save!
+```
+
+```ruby
+n = Rpush::Wpns::Notification.new
+n.app = Rpush::Wpns::App.find_by_name("windows_phone_app")
+n.uri = "http://..."
+n.alert = "..."
+n.save!
+```
+
+### Starting Rpush
+
+As a daemon:
+
+    cd /path/to/rails/app
+    rpush <Rails environment> [options]
+
+Inside an existing process (see [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API)):
+
+```ruby
+Rpush.embed
+```
+
+*Please note that only ever a single instance of Rpush should be running.*
+
+In a scheduler (see [Push API](https://github.com/rpush/rpush/wiki/Push-API)):
+
+```ruby
+Rpush.push
+Rpush.apns_feedback
+```
+
+See [Configuration](https://github.com/rpush/rpush/wiki/Configuration) for a list of options, or run `rpush --help`.
+
+### Updating Rpush
+
+After updating you should run `rails g rpush` to check for any new migrations.
+
+### Wiki
+
+### General
+* [Configuration](https://github.com/rpush/rpush/wiki/Configuration)
+* [Moving from Rapns](https://github.com/rpush/rpush/wiki/Moving-from-Rapns-to-Rpush)
+* [Deploying to Heroku](https://github.com/rpush/rpush/wiki/Heroku)
+* [Hot App Updates](https://github.com/rpush/rpush/wiki/Hot-App-Updates)
+* [Signals](https://github.com/rpush/rpush/wiki/Signals)
+* [Reflection API](https://github.com/rpush/rpush/wiki/Reflection-API)
+* [Push API](https://github.com/rpush/rpush/wiki/Push-API)
+* [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API)
+* [Implementing your own storage backend](https://github.com/rpush/rpush/wiki/Implementing-your-own-storage-backend)
+* [Upgrading from 2.x to 3.0](https://github.com/rpush/rpush/wiki/Upgrading-from-version-2.x-to-3.0)
+
+### Apple Push Notification Service
+* [Generating Certificates](https://github.com/rpush/rpush/wiki/Generating-Certificates)
+* [Advanced APNs Features](https://github.com/rpush/rpush/wiki/Advanced-APNs-Features)
+* [APNs Delivery Failure Handling](https://github.com/rpush/rpush/wiki/APNs-Delivery-Failure-Handling)
+* [Why open multiple connections to the APNs?](https://github.com/rpush/rpush/wiki/Why-open-multiple-connections-to-the-APNs%3F)
+* [Silent failures might be dropped connections](https://github.com/rpush/rpush/wiki/Dropped-connections)
+
+### Google Cloud Messaging
+* [Notification Options](https://github.com/rpush/rpush/wiki//GCM-Notification-Options)
+* [Canonical IDs](https://github.com/rpush/rpush/wiki/Canonical-IDs)
+* [Delivery Failures & Retries](https://github.com/rpush/rpush/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 'rpush_test'
+mysql database.

data/bin/rpush

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rpush'
+
+environment = ARGV[0]
+
+config = Rpush::ConfigurationWithoutDefaults.new
+
+options = ARGV.options do |opts|
+  opts.banner = 'Usage: rpush <Rails environment> [options]'
+  opts.on('-f', '--foreground', 'Run in the foreground.') { config.foreground = true }
+  opts.on('-P N', '--db-poll N', Integer, "Frequency in seconds to check for new notifications.") { |n| config.push_poll = n }
+  opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback.") { |n| config.feedback_poll = n }
+  opts.on('-e', '--no-error-checks', 'Disable APNs error checking after notification delivery.') { config.check_for_errors = false }
+  opts.on('-p PATH', '--pid-file PATH', String, 'Path to write PID file. Relative to Rails root unless absolute.') { |path| config.pid_file = path }
+  opts.on('-b N', '--batch-size N', Integer, 'Storage backend notification batch size.') { |n| config.batch_size = n }
+  opts.on('-B', '--[no-]batch-storage-updates', 'Perform storage updates in batches.') { |v| config.batch_storage_updates = v }
+  opts.on('-v', '--version', 'Print the version.') { puts "rpush #{Rpush::VERSION}"; exit }
+  opts.on('-h', '--help', 'You\'re looking at it.') { puts opts; exit }
+end
+
+if environment.nil? || environment =~ /^-/
+  puts options.to_s
+  exit 1
+end
+
+options.parse!
+
+ENV['RAILS_ENV'] = environment
+load 'config/environment.rb'
+load 'config/initializers/rpush.rb' if File.exist?('config/initializers/rpush.rb')
+
+Rpush.config.update(config)
+Rpush.require_for_daemon
+Rpush::Daemon.start

data/config/database.yml

@@ -0,0 +1,44 @@
+# postgresql is the default if no ADAPTER environment variable is set when running specs.
+
+postgresql:
+  adapter: postgresql
+  database: rpush_test
+  host: localhost
+  username: postgres
+  password: ""
+
+jdbcpostgresql:
+  adapter: jdbcpostgresql
+  database: rpush_test
+  host: localhost
+  username: postgres
+  password: ""
+
+mysql2:
+  adapter: mysql2
+  database: rpush_test
+  host: localhost
+  username: rpush_test
+  password: ""
+  encoding: utf8
+
+jdbcmysql:
+  adapter: jdbcmysql
+  database: rpush_test
+  host: localhost
+  username: rpush_test
+  password: ""
+  encoding: utf8
+
+jdbch2:
+  adapter: h2
+  url: jdbc:h2:file:/tmp/rpush_test;AUTO_SERVER=TRUE
+  username: rpush_test
+  password: ""
+  pool: 128
+  timeout: 5000
+  encoding: utf8
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/tmp/rpush_test.sqlite3

data/lib/generators/rpush_generator.rb

@@ -0,0 +1,44 @@
+class RpushGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    @time ||= Time.now.utc
+    @calls ||= -1
+    @calls += 1
+    (@time + @calls.seconds).strftime("%Y%m%d%H%M%S")
+  end
+
+  def copy_migration
+    if has_migration?('create_rapns_notifications')
+      add_rpush_migration('create_rapns_feedback')
+      add_rpush_migration('add_alert_is_json_to_rapns_notifications')
+      add_rpush_migration('add_app_to_rapns')
+      add_rpush_migration('create_rapns_apps')
+      add_rpush_migration('add_gcm')
+      add_rpush_migration('add_wpns')
+      add_rpush_migration('add_adm')
+      add_rpush_migration('rename_rapns_to_rpush')
+      add_rpush_migration('add_fail_after_to_rpush_notifications')
+    else
+      add_rpush_migration('add_rpush')
+    end
+  end
+
+   def copy_config
+    copy_file 'rpush.rb', 'config/initializers/rpush.rb'
+  end
+
+  protected
+
+  def add_rpush_migration(template)
+    if !has_migration?(template)
+      migration_template "#{template}.rb", "db/migrate/#{template}.rb"
+    end
+  end
+
+  def has_migration?(template)
+    migration_dir = File.expand_path('db/migrate')
+    self.class.migration_exists?(migration_dir, template)
+  end
+end

data/lib/generators/templates/add_adm.rb

@@ -0,0 +1,23 @@
+class AddAdm < ActiveRecord::Migration
+  module Rapns
+    class Notification < ActiveRecord::Base
+      self.table_name = 'rapns_notifications'
+    end
+  end
+
+  def self.up
+    add_column :rapns_apps, :client_id, :string, :null => true
+    add_column :rapns_apps, :client_secret, :string, :null => true
+    add_column :rapns_apps, :access_token, :string, :null => true
+    add_column :rapns_apps, :access_token_expiration, :datetime, :null => true
+  end
+
+  def self.down
+    AddAdm::Rapns::Notification.where(:type => 'Rapns::Adm::Notification').delete_all
+
+    remove_column :rapns_apps, :client_id
+    remove_column :rapns_apps, :client_secret
+    remove_column :rapns_apps, :access_token
+    remove_column :rapns_apps, :access_token_expiration
+  end
+end