rapns 3.0.0-java

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+##  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 Rapns::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 rapns.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,138 @@
+[![Build Status](https://secure.travis-ci.org/ileitch/rapns.png?branch=master)](http://travis-ci.org/ileitch/rapns)
+
+### Rapns - Professional grade APNs and GCM daemon
+
+* 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](http://airbrakeapp.com/) integration.
+
+### 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 migration, rapns.yml and migrate:
+
+    rails g rapns
+    rake db:migrate
+
+## Generating Certificates
+
+1. Open up Keychain Access and select the `Certificates` category in the sidebar.
+2. Expand the disclosure arrow next to the iOS Push Services certificate you want to export.
+3. Select both the certificate and private key.
+4. Right click and select `Export 2 items...`.
+5. Save the file as `cert.p12`, make sure the File Format is `Personal Information Exchange (p12)`.
+6. If you decide to set a password for your exported certificate, please read the 'Adding Apps' section below.
+7. Convert the certificate to a .pem, where `<environment>` should be `development` or `production`, depending on the certificate you exported.
+
+    `openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem`
+
+## Create an App
+
+#### APNs
+```ruby
+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!
+```
+
+#### GCM
+```ruby
+app = Rapns::Gcm::App.new
+app.name = "android_app"
+app.auth_key = "..."
+app.connections = 1
+app.save!
+```
+
+## Create a Notification
+
+#### APNs
+```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!
+```
+
+#### GCM
+```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!
+```
+
+## Starting Rapns
+
+    cd /path/to/rails/app
+    rapns <Rails environment> [options]
+
+See [Configuration](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.
+
+## Wiki
+
+### General
+* [Configuration](wiki/Configuration)
+* [Upgrading from 2.x to 3.0](wiki/Upgrading-from-version-2.x-to-3.0)
+* [Deploying to Heroku](wiki/Heroku)
+* [Hot App Updates](wiki/Hot-App-Updates)
+
+### APNs
+* [Advanced APNs Features](wiki/Advanced-APNs-Features)
+* [APNs Delivery Failure Handling](wiki/APNs-Delivery-Failure-Handling)
+* [Why open multiple connections to the APNs?](wiki/Why-open-multiple-connections-to-the-APNs%3F)
+* [Silent failures might be dropped connections](wiki/Dropped-connections)
+
+### 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:
+
+* [@blakewatters](https://github.com/blakewatters)
+* [@forresty](https://github.com/forresty)
+* [@sjmadsen](https://github.com/sjmadsen)
+* [@ivanyv](https://github.com/ivanyv)
+* [@taybenlor](https://github.com/taybenlor)
+* [@tompesman](https://github.com/tompesman)
+* [@EpicDraws](https://github.com/EpicDraws)
+* [@dei79](https://github.com/dei79)
+* [@adorr](https://github.com/adorr)
+* [@mattconnolly](https://github.com/mattconnolly)
+* [@emeitch](https://github.com/emeitch)

data/bin/rapns

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rapns'
+
+environment = ARGV[0]
+
+banner = 'Usage: rapns <Rails environment> [options]'
+if environment.nil? || environment =~ /^-/
+  puts banner
+  exit 1
+end
+
+# A mock configuration to be used before the Rails environment is loaded.
+class CommandlineConfig < Struct.new(*Rapns::CONFIG_ATTRS); end
+config = CommandlineConfig.new
+
+ARGV.options do |opts|
+  opts.banner = banner
+  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. Default: #{config.push_poll}.") { |n| config.push_poll = n }
+  opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback. Default: #{config.feedback_poll}.") { |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('-n', '--no-airbrake-notify', 'Disables error notifications via Airbrake.') { config.airbrake_notify = 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, 'ActiveRecord notifications batch size.') { |n| config.batch_size = n }
+  opts.on('-v', '--version', 'Print this version of rapns.') { puts "rapns #{Rapns::VERSION}"; exit }
+  opts.on('-h', '--help', 'You\'re looking at it.') { puts opts; exit }
+  opts.parse!
+end
+
+ENV['RAILS_ENV'] = environment
+load 'config/environment.rb'
+load 'config/initializers/rapns.rb' if File.exist?('config/initializers/rapns.rb')
+
+Rapns.config.update(config)
+
+require 'rapns/daemon'
+require 'rapns/patches'
+
+Rapns::Daemon.start

data/config/database.yml

@@ -0,0 +1,39 @@
+# postgresql is the default if no ADAPTER environment variable is set when running specs.
+
+postgresql:
+  adapter: postgresql
+  database: rapns_test
+  host: localhost
+  username: postgres
+  password: ""
+
+jdbcpostgresql:
+  adapter: jdbcpostgresql
+  database: rapns_test
+  host: localhost
+  username: postgres
+  password: ""
+
+mysql:
+  adapter: mysql
+  database: rapns_test
+  host: localhost
+  username: rapns_test
+  password: ""
+  encoding: utf8
+
+mysql2:
+  adapter: mysql
+  database: rapns_test
+  host: localhost
+  username: rapns_test
+  password: ""
+  encoding: utf8
+
+jdbcmysql:
+  adapter: jdbcmysql
+  database: rapns_test
+  host: localhost
+  username: rapns_test
+  password: ""
+  encoding: utf8

data/lib/generators/rapns_generator.rb

@@ -0,0 +1,34 @@
+class RapnsGenerator < 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
+    add_rapns_migration('create_rapns_notifications')
+    add_rapns_migration('create_rapns_feedback')
+    add_rapns_migration('add_alert_is_json_to_rapns_notifications')
+    add_rapns_migration('add_app_to_rapns')
+    add_rapns_migration('create_rapns_apps')
+    add_rapns_migration('add_gcm')
+  end
+
+   def copy_config
+    copy_file 'rapns.rb', 'config/initializers/rapns.rb'
+  end
+
+  protected
+
+  def add_rapns_migration(template)
+    migration_dir = File.expand_path('db/migrate')
+
+    if !self.class.migration_exists?(migration_dir, template)
+      migration_template "#{template}.rb", "db/migrate/#{template}.rb"
+    end
+  end
+end

data/lib/generators/templates/add_alert_is_json_to_rapns_notifications.rb

@@ -0,0 +1,9 @@
+class AddAlertIsJsonToRapnsNotifications < ActiveRecord::Migration
+  def self.up
+    add_column :rapns_notifications, :alert_is_json, :boolean, :null => true, :default => false
+  end
+
+  def self.down
+    remove_column :rapns_notifications, :alert_is_json
+  end
+end

data/lib/generators/templates/add_app_to_rapns.rb

@@ -0,0 +1,11 @@
+class AddAppToRapns < ActiveRecord::Migration
+  def self.up
+    add_column :rapns_notifications, :app, :string, :null => true
+    add_column :rapns_feedback, :app, :string, :null => true
+  end
+
+  def self.down
+    remove_column :rapns_notifications, :app
+    remove_column :rapns_feedback, :app
+  end
+end

data/lib/generators/templates/add_gcm.rb

@@ -0,0 +1,94 @@
+class AddGcm < ActiveRecord::Migration
+  module Rapns
+    class App < ActiveRecord::Base
+      self.table_name = 'rapns_apps'
+    end
+
+    class Notification < ActiveRecord::Base
+      belongs_to :app
+      self.table_name = 'rapns_notifications'
+    end
+  end
+
+  def self.up
+    add_column :rapns_notifications, :type, :string, :null => true
+    add_column :rapns_apps, :type, :string, :null => true
+
+    AddGcm::Rapns::Notification.update_all :type => 'Rapns::Apns::Notification'
+    AddGcm::Rapns::App.update_all :type => 'Rapns::Apns::App'
+
+    change_column_null :rapns_notifications, :type, false
+    change_column_null :rapns_apps, :type, false
+    change_column_null :rapns_notifications, :device_token, true
+    change_column_null :rapns_notifications, :expiry, true
+    change_column_null :rapns_apps, :environment, true
+    change_column_null :rapns_apps, :certificate, true
+
+    change_column :rapns_notifications, :error_description, :text
+    change_column :rapns_notifications, :sound, :string, :default => 'default'
+
+    rename_column :rapns_notifications, :attributes_for_device, :data
+    rename_column :rapns_apps, :key, :name
+
+    add_column :rapns_apps, :auth_key, :string, :null => true
+
+    add_column :rapns_notifications, :collapse_key, :string, :null => true
+    add_column :rapns_notifications, :delay_while_idle, :boolean, :null => false, :default => false
+    add_column :rapns_notifications, :registration_ids, :text, :null => true
+    add_column :rapns_notifications, :app_id, :integer, :null => true
+    add_column :rapns_notifications, :retries, :integer, :null => true, :default => 0
+
+    Rapns::Notification.reset_column_information
+    Rapns::App.reset_column_information
+
+    Rapns::App.all.each do |app|
+      Rapns::Notification.update_all(['app_id = ?', app.id], ['app = ?', app.name])
+    end
+
+    change_column_null :rapns_notifications, :app_id, false
+    remove_column :rapns_notifications, :app
+
+    remove_index :rapns_notifications, :name => "index_rapns_notifications_multi"
+    add_index :rapns_notifications, [:app_id, :delivered, :failed, :deliver_after], :name => "index_rapns_notifications_multi"
+  end
+
+  def self.down
+    AddGcm::Rapns::Notification.where(:type => 'Rapns::Gcm::Notification').delete_all
+
+    remove_column :rapns_notifications, :type
+    remove_column :rapns_apps, :type
+
+    change_column_null :rapns_notifications, :device_token, false
+    change_column_null :rapns_notifications, :expiry, false
+    change_column_null :rapns_apps, :environment, false
+    change_column_null :rapns_apps, :certificate, false
+
+    change_column :rapns_notifications, :error_description, :string
+    change_column :rapns_notifications, :sound, :string, :default => '1.aiff'
+
+    rename_column :rapns_notifications, :data, :attributes_for_device
+    rename_column :rapns_apps, :name, :key
+
+    remove_column :rapns_apps, :auth_key
+
+    remove_column :rapns_notifications, :collapse_key
+    remove_column :rapns_notifications, :delay_while_idle
+    remove_column :rapns_notifications, :registration_ids
+    remove_column :rapns_notifications, :retries
+
+    add_column :rapns_notifications, :app, :string, :null => true
+
+    Rapns::Notification.reset_column_information
+    Rapns::App.reset_column_information
+
+    Rapns::App.all.each do |app|
+      Rapns::Notification.update_all(['app = ?', app.key], ['app_id = ?', app.id])
+    end
+
+    change_column_null :rapns_notifications, :key, false
+    remove_column :rapns_notifications, :app_id
+
+    remove_index :rapns_notifications, :name => "index_rapns_notifications_multi"
+    add_index :rapns_notifications, [:delivered, :failed, :deliver_after], :name => "index_rapns_notifications_multi"
+  end
+end

data/lib/generators/templates/create_rapns_apps.rb

@@ -0,0 +1,16 @@
+class CreateRapnsApps < ActiveRecord::Migration
+  def self.up
+    create_table :rapns_apps do |t|
+      t.string    :key,             :null => false
+      t.string    :environment,     :null => false
+      t.text      :certificate,     :null => false
+      t.string    :password,        :null => true
+      t.integer   :connections,     :null => false, :default => 1
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :rapns_apps
+  end
+end

data/lib/generators/templates/create_rapns_feedback.rb

@@ -0,0 +1,15 @@
+class CreateRapnsFeedback < ActiveRecord::Migration
+  def self.up
+    create_table :rapns_feedback do |t|
+      t.string    :device_token,          :null => false, :limit => 64
+      t.timestamp :failed_at,             :null => false
+      t.timestamps
+    end
+
+    add_index :rapns_feedback, :device_token
+  end
+
+  def self.down
+    drop_table :rapns_feedback
+  end
+end

data/lib/generators/templates/create_rapns_notifications.rb

@@ -0,0 +1,26 @@
+class CreateRapnsNotifications < ActiveRecord::Migration
+  def self.up
+    create_table :rapns_notifications do |t|
+      t.integer   :badge,                 :null => true
+      t.string    :device_token,          :null => false, :limit => 64
+      t.string    :sound,                 :null => true,  :default => "1.aiff"
+      t.string    :alert,                 :null => true
+      t.text      :attributes_for_device, :null => true
+      t.integer   :expiry,                :null => false, :default => 1.day.to_i
+      t.boolean   :delivered,             :null => false, :default => false
+      t.timestamp :delivered_at,          :null => true
+      t.boolean   :failed,                :null => false, :default => false
+      t.timestamp :failed_at,             :null => true
+      t.integer   :error_code,            :null => true
+      t.string    :error_description,     :null => true
+      t.timestamp :deliver_after,         :null => true
+      t.timestamps
+    end
+
+    add_index :rapns_notifications, [:delivered, :failed, :deliver_after], :name => "index_rapns_notifications_multi"
+  end
+
+  def self.down
+    drop_table :rapns_notifications
+  end
+end

data/lib/generators/templates/rapns.rb

@@ -0,0 +1,39 @@
+ # Rapns configuration. Options set here are overridden by command-line options.
+
+ Rapns.configure do |config|
+
+  # Run in the foreground?
+  # config.foreground = false
+
+  # Frequency in seconds to check for new notifications.
+  # config.push_poll = 2
+
+  # Frequency in seconds to check for feedback
+  # config.feedback_poll = 60
+
+  # Enable/Disable error notifications via Airbrake.
+  # config.airbrake_notify = true
+
+  # Disable APNs error checking after notification delivery.
+  # config.check_for_errors = true
+
+  # ActiveRecord notifications batch size.
+  # config.batch_size = 5000
+
+  # Path to write PID file. Relative to Rails root unless absolute.
+  # config.pid_file = '/path/to/rapns.pid'
+
+  # Define a block that will be called with a Rapns::Apns::Feedback instance
+  # when feedback is received from the APNs that a notification has
+  # failed to be delivered. Further notifications should not be sent to the device.
+  #
+  # Example:
+  # config.on_apns_feedback do |feedback|
+  #   device = Device.find_by_device_token(feedback.device_token)
+  #   if device
+  #     device.active = false
+  #     device.save!
+  #   end
+  # end
+
+ end

data/lib/rapns/apns/app.rb

@@ -0,0 +1,8 @@
+module Rapns
+  module Apns
+    class App < Rapns::App
+      validates :environment, :presence => true, :inclusion => { :in => %w(development production) }
+      validates :certificate, :presence => true
+    end
+  end
+end

data/lib/rapns/apns/binary_notification_validator.rb

@@ -0,0 +1,12 @@
+module Rapns
+  module Apns
+    class BinaryNotificationValidator < ActiveModel::Validator
+
+      def validate(record)
+        if record.payload_size > 256
+          record.errors[:base] << "APN notification cannot be larger than 256 bytes. Try condensing your alert and device attributes."
+        end
+      end
+    end
+  end
+end

data/lib/rapns/apns/device_token_format_validator.rb

@@ -0,0 +1,12 @@
+module Rapns
+  module Apns
+    class DeviceTokenFormatValidator < ActiveModel::Validator
+
+      def validate(record)
+        if record.device_token !~ /^[a-z0-9]{64}$/
+          record.errors[:device_token] << "is invalid"
+        end
+      end
+    end
+  end
+end

data/lib/rapns/apns/feedback.rb

@@ -0,0 +1,14 @@
+module Rapns
+  module Apns
+    class Feedback < ActiveRecord::Base
+      self.table_name = 'rapns_feedback'
+
+      attr_accessible :device_token, :failed_at, :app
+
+      validates :device_token, :presence => true
+      validates :failed_at, :presence => true
+
+      validates_with Rapns::Apns::DeviceTokenFormatValidator
+    end
+  end
+end

data/lib/rapns/apns/notification.rb

@@ -0,0 +1,86 @@
+module Rapns
+  module Apns
+    class Notification < Rapns::Notification
+      class MultipleAppAssignmentError < StandardError; end
+
+      validates :device_token, :presence => true
+      validates :badge, :numericality => true, :allow_nil => true
+
+      validates_with Rapns::Apns::DeviceTokenFormatValidator
+      validates_with Rapns::Apns::BinaryNotificationValidator
+      validates_with Rapns::Apns::RequiredFieldsValidator
+
+      alias_method :attributes_for_device=, :data=
+      alias_method :attributes_for_device, :data
+
+      def device_token=(token)
+        write_attribute(:device_token, token.delete(" <>")) if !token.nil?
+      end
+
+      def alert=(alert)
+        if alert.is_a?(Hash)
+          write_attribute(:alert, multi_json_dump(alert))
+          self.alert_is_json = true if has_attribute?(:alert_is_json)
+        else
+          write_attribute(:alert, alert)
+          self.alert_is_json = false if has_attribute?(:alert_is_json)
+        end
+      end
+
+      def alert
+        string_or_json = read_attribute(:alert)
+
+        if has_attribute?(:alert_is_json)
+          if alert_is_json?
+            multi_json_load(string_or_json)
+          else
+            string_or_json
+          end
+        else
+          multi_json_load(string_or_json) rescue string_or_json
+        end
+      end
+
+      MDM_KEY = '__rapns_mdm__'
+      def mdm=(magic)
+        self.attributes_for_device = { MDM_KEY => magic }
+      end
+
+      CONTENT_AVAILABLE_KEY = '__rapns_content_available__'
+      def content_available=(bool)
+        return unless bool
+        self.attributes_for_device = { CONTENT_AVAILABLE_KEY => true }
+      end
+
+      def as_json
+        json = ActiveSupport::OrderedHash.new
+
+        if attributes_for_device && attributes_for_device.key?(MDM_KEY)
+          json['mdm'] = attributes_for_device[MDM_KEY]
+        else
+          json['aps'] = ActiveSupport::OrderedHash.new
+          json['aps']['alert'] = alert if alert
+          json['aps']['badge'] = badge if badge
+          json['aps']['sound'] = sound if sound
+
+          if attributes_for_device && attributes_for_device[CONTENT_AVAILABLE_KEY]
+            json['aps']['content-available'] = 1
+          end
+
+          if attributes_for_device
+            non_aps_attributes = attributes_for_device.reject { |k, v| k == CONTENT_AVAILABLE_KEY }
+            non_aps_attributes.each { |k, v| json[k.to_s] = v.to_s }
+          end
+        end
+
+        json
+      end
+
+      def to_binary(options = {})
+        id_for_pack = options[:for_validation] ? 0 : id
+        [1, id_for_pack, expiry, 0, 32, device_token, payload_size, payload].pack("cNNccH*na*")
+      end
+
+    end
+  end
+end

data/lib/rapns/apns/required_fields_validator.rb

@@ -0,0 +1,14 @@
+module Rapns
+  module Apns
+    class RequiredFieldsValidator < ActiveModel::Validator
+
+      # Notifications must contain one of alert, badge or sound as per:
+      # https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html
+      def validate(record)
+        if record.alert.nil? && record.badge.nil? && record.sound.nil?
+          record.errors[:base] << "APN Notification must contain one of alert, badge, or sound"
+        end
+      end
+    end
+  end
+end