rpush 1.0.0-java → 2.0.0-java

data/lib/generators/templates/add_wpns.rb

@@ -6,11 +6,11 @@ class AddWpns < ActiveRecord::Migration
   end
 
   def self.up
-    add_column :rapns_notifications, :uri, :string, :null => true
+    add_column :rapns_notifications, :uri, :string, null: true
   end
 
   def self.down
-    AddWpns::Rapns::Notification.where(:type => 'Rapns::Wpns::Notification').delete_all
+    AddWpns::Rapns::Notification.where(type: 'Rapns::Wpns::Notification').delete_all
     remove_column :rapns_notifications, :uri
   end
 end

data/lib/generators/templates/create_rapns_apps.rb

@@ -1,11 +1,11 @@
 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.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

data/lib/generators/templates/create_rapns_feedback.rb

@@ -1,8 +1,8 @@
 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.string    :device_token,          null: false, limit: 64
+      t.timestamp :failed_at,             null: false
       t.timestamps
     end
 

data/lib/generators/templates/create_rapns_notifications.rb

@@ -1,28 +1,28 @@
 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.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'
+    add_index :rapns_notifications, [:delivered, :failed, :deliver_after], name: 'index_rapns_notifications_multi'
   end
 
   def self.down
     if index_name_exists?(:rapns_notifications, 'index_rapns_notifications_multi', true)
-      remove_index :rapns_notifications, :name => 'index_rapns_notifications_multi'
+      remove_index :rapns_notifications, name: 'index_rapns_notifications_multi'
     end
     drop_table :rapns_notifications
   end

data/lib/generators/templates/rpush.rb

@@ -2,6 +2,12 @@
 
  Rpush.configure do |config|
 
+  # Supported clients are :active_record and :redis.
+  # config.client = :active_record
+
+  # Options passed to Redis.new
+  # config.redis_options = {}
+
   # Run in the foreground?
   # config.foreground = false
 
@@ -11,15 +17,12 @@
   # Frequency in seconds to check for feedback
   # config.feedback_poll = 60
 
-  # Disable APNs error checking after notification delivery.
-  # config.check_for_errors = true
-
-  # ActiveRecord notifications batch size.
+  # The maximum number of notifications to load from the store every `push_poll` seconds.
+  # If some notifications are still enqueued internally, Rpush will load the batch_size less
+  # the number enqueued. An exception to this is if the service is able to receive multiple
+  # notification payloads over the connection with a single write, such as APNs.
   # config.batch_size = 100
 
-  # Perform updates to the storage backend in batches to reduce IO.
-  # config.batch_storage_updates = true
-
   # Path to write PID file. Relative to Rails root unless absolute.
   # config.pid_file = '/path/to/rpush.pid'
 
@@ -56,12 +59,22 @@ Rpush.reflect do |on|
   # on.notification_failed do |notification|
   # end
 
+  # Called when the notification delivery failed and only the notification ID
+  # is present in memory.
+  # on.notification_id_failed do |app, notification_id, error_code, error_description|
+  # end
+
   # Called when a notification will be retried at a later date.
   # Call 'deliver_after' on the notification for the next delivery date
   # and 'retries' for the number of times this notification has been retried.
   # on.notification_will_retry do |notification|
   # end
 
+  # Called when a notification will be retried and only the notification ID
+  # is present in memory.
+  # on.notification_id_will_retry do |app, notification_id, retry_after|
+  # end
+
   # Called when a TCP connection is lost and will be reconnected.
   # on.tcp_connection_lost do |app, error|
   # end
@@ -98,6 +111,14 @@ Rpush.reflect do |on|
   # on.adm_canonical_id do |old_id, canonical_id|
   # end
 
+  # Called when Failed to deliver to ADM. Check the 'reason' string for further
+  # explanations.
+  #
+  # If the reason is the string 'Unregistered', you should remove
+  # this registration id from your records.
+  # on.adm_failed_to_recipient do |notification, registration_id, reason|
+  # end
+
   # Called when an exception is raised.
   # on.error do |error|
   # end

data/lib/generators/templates/rpush_2_0_0_updates.rb

@@ -0,0 +1,42 @@
+class Rpush200Updates < ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :processing, :boolean, null: false, default: false
+    add_column :rpush_notifications, :priority, :integer, null: true
+
+    if index_name_exists?(:rpush_notifications, :index_rpush_notifications_multi, true)
+      remove_index :rpush_notifications, name: :index_rpush_notifications_multi
+    end
+
+    add_index :rpush_notifications, [:delivered, :failed], name: 'index_rpush_notifications_multi', where: 'NOT delivered AND NOT failed'
+
+    rename_column :rpush_feedback, :app, :app_id
+
+    if postgresql?
+      execute('ALTER TABLE rpush_feedback ALTER COLUMN app_id TYPE integer USING (trim(app_id)::integer)')
+    else
+      change_column :rpush_feedback, :app_id, :integer
+    end
+  end
+
+  def self.down
+    change_column :rpush_feedback, :app_id, :string
+    rename_column :rpush_feedback, :app_id, :app
+
+    if index_name_exists?(:rpush_notifications, :index_rpush_notifications_multi, true)
+      remove_index :rpush_notifications, name: :index_rpush_notifications_multi
+    end
+
+    add_index :rpush_notifications, [:app_id, :delivered, :failed, :deliver_after], name: 'index_rpush_notifications_multi'
+
+    remove_column :rpush_notifications, :priority
+    remove_column :rpush_notifications, :processing
+  end
+
+  def self.adapter_name
+    ActiveRecord::Base.configurations[Rails.env]['adapter']
+  end
+
+  def self.postgresql?
+    adapter_name =~ /postgresql/
+  end
+end

data/lib/rpush/client/active_model/adm/app.rb

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Adm
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :client_id, :client_secret, presence: true
+            end
+          end
+
+          def access_token_expired?
+            access_token_expiration.nil? || access_token_expiration < Time.now
+          end
+
+          def service_name
+            'adm'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/adm/data_validator.rb

@@ -0,0 +1,14 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Adm
+        class DataValidator < ::ActiveModel::Validator
+          def validate(record)
+            return unless record.collapse_key.nil? && record.data.nil?
+            record.errors[:data] << 'must be set unless collapse_key is specified'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/adm/notification.rb

@@ -0,0 +1,28 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Adm
+        module Notification
+          def self.included(base)
+            base.instance_eval do
+              validates :registration_ids, presence: true
+
+              validates_with Rpush::Client::ActiveModel::PayloadDataSizeValidator, limit: 6144
+              validates_with Rpush::Client::ActiveModel::RegistrationIdsCountValidator, limit: 100
+
+              validates_with Rpush::Client::ActiveModel::Adm::DataValidator
+            end
+          end
+
+          def as_json
+            json = { 'data' => data }
+            json['consolidationKey'] = collapse_key if collapse_key
+            # number of seconds before message is expired
+            json['expiresAfter'] = expiry if expiry
+            json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/apns/app.rb

@@ -0,0 +1,37 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :environment, presence: true, inclusion: { in: %w(development production sandbox) }
+              validates :certificate, presence: true
+              validate :certificate_has_matching_private_key
+            end
+          end
+
+          def service_name
+            'apns'
+          end
+
+          private
+
+          def certificate_has_matching_private_key
+            result = false
+            if certificate.present?
+              begin
+                x509 = OpenSSL::X509::Certificate.new(certificate)
+                pkey = OpenSSL::PKey::RSA.new(certificate, password)
+                result = x509 && pkey
+              rescue OpenSSL::OpenSSLError
+                errors.add :certificate, 'Certificate value must contain a certificate and a private key.'
+              end
+            end
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/apns/binary_notification_validator.rb

@@ -0,0 +1,16 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns
+        class BinaryNotificationValidator < ::ActiveModel::Validator
+          MAX_BYTES = 256
+
+          def validate(record)
+            return unless record.payload_size > MAX_BYTES
+            record.errors[:base] << "APN notification cannot be larger than #{MAX_BYTES} bytes. Try condensing your alert and device attributes."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/apns/device_token_format_validator.rb

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

data/lib/rpush/client/active_model/apns/notification.rb

@@ -0,0 +1,90 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns
+        module Notification
+          APNS_DEFAULT_EXPIRY = 1.day.to_i
+          APNS_PRIORITY_IMMEDIATE = 10
+          APNS_PRIORITY_CONSERVE_POWER = 5
+          APNS_PRIORITIES = [APNS_PRIORITY_IMMEDIATE, APNS_PRIORITY_CONSERVE_POWER]
+
+          def self.included(base)
+            base.instance_eval do
+              validates :device_token, presence: true
+              validates :badge, numericality: true, allow_nil: true
+              validates :priority, inclusion: { in: APNS_PRIORITIES }, allow_nil: true
+
+              validates_with Rpush::Client::ActiveModel::Apns::DeviceTokenFormatValidator
+              validates_with Rpush::Client::ActiveModel::Apns::BinaryNotificationValidator
+
+              base.const_set('APNS_DEFAULT_EXPIRY', APNS_DEFAULT_EXPIRY) unless base.const_defined?('APNS_DEFAULT_EXPIRY')
+              base.const_set('APNS_PRIORITY_IMMEDIATE', APNS_PRIORITY_IMMEDIATE) unless base.const_defined?('APNS_PRIORITY_IMMEDIATE')
+              base.const_set('APNS_PRIORITY_CONSERVE_POWER', APNS_PRIORITY_CONSERVE_POWER) unless base.const_defined?('APNS_PRIORITY_CONSERVE_POWER')
+            end
+          end
+
+          def device_token=(token)
+            write_attribute(:device_token, token.delete(" <>")) unless token.nil?
+          end
+
+          MDM_KEY = '__rpush_mdm__'
+          def mdm=(magic)
+            self.data = (data || {}).merge(MDM_KEY => magic)
+          end
+
+          CONTENT_AVAILABLE_KEY = '__rpush_content_available__'
+          def content_available=(bool)
+            return unless bool
+            self.data = (data || {}).merge(CONTENT_AVAILABLE_KEY => true)
+          end
+
+          def as_json # rubocop:disable Metrics/PerceivedComplexity
+            json = ActiveSupport::OrderedHash.new
+
+            if data && data.key?(MDM_KEY)
+              json['mdm'] = data[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 data && data[CONTENT_AVAILABLE_KEY]
+                json['aps']['content-available'] = 1
+              end
+
+              if data
+                non_aps_attributes = data.reject { |k, _| k == CONTENT_AVAILABLE_KEY }
+                non_aps_attributes.each { |k, v| json[k.to_s] = v }
+              end
+            end
+
+            json
+          end
+
+          def to_binary(options = {})
+            frame_id = options[:for_validation] ? 0 : id
+            frame = ""
+            frame << [1, 32, device_token].pack("cnH*")
+            frame << [2, payload.bytesize, payload].pack("cna*")
+            frame << [3, 4, frame_id].pack("cnN")
+            frame << [4, 4, expiry || APNS_DEFAULT_EXPIRY].pack("cnN")
+            frame << [5, 1, priority_for_frame].pack("cnc")
+            [2, frame.bytesize].pack("cN") + frame
+          end
+
+          private
+
+          def priority_for_frame
+            # It is an error to use APNS_PRIORITY_IMMEDIATE for a notification that only contains content-available.
+            if as_json['aps'].keys == ['content-available']
+              APNS_PRIORITY_CONSERVE_POWER
+            else
+              priority || APNS_PRIORITY_IMMEDIATE
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/gcm/app.rb

@@ -0,0 +1,19 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Gcm
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :auth_key, presence: true
+            end
+          end
+
+          def service_name
+            'gcm'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/gcm/expiry_collapse_key_mutual_inclusion_validator.rb

@@ -0,0 +1,14 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Gcm
+        class ExpiryCollapseKeyMutualInclusionValidator < ::ActiveModel::Validator
+          def validate(record)
+            return unless record.collapse_key && !record.expiry
+            record.errors[:expiry] << 'must be set when using a collapse_key'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/gcm/notification.rb

@@ -0,0 +1,31 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Gcm
+        module Notification
+          def self.included(base)
+            base.instance_eval do
+              validates :registration_ids, presence: true
+
+              validates_with Rpush::Client::ActiveModel::PayloadDataSizeValidator, limit: 4096
+              validates_with Rpush::Client::ActiveModel::RegistrationIdsCountValidator, limit: 1000
+
+              validates_with Rpush::Client::ActiveModel::Gcm::ExpiryCollapseKeyMutualInclusionValidator
+            end
+          end
+
+          def as_json
+            json = {
+              'registration_ids' => registration_ids,
+              'delay_while_idle' => delay_while_idle,
+              'data' => data
+            }
+            json['collapse_key'] = collapse_key if collapse_key
+            json['time_to_live'] = expiry if expiry
+            json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/notification.rb

@@ -0,0 +1,26 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Notification
+        def self.included(base)
+          base.instance_eval do
+            validates :expiry, numericality: true, allow_nil: true
+            validates :app, presence: true
+          end
+        end
+
+        def payload
+          multi_json_dump(as_json)
+        end
+
+        def payload_size
+          payload.bytesize
+        end
+
+        def payload_data_size
+          multi_json_dump(as_json['data']).bytesize
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/payload_data_size_validator.rb

@@ -0,0 +1,13 @@
+module Rpush
+  module Client
+    module ActiveModel
+      class PayloadDataSizeValidator < ::ActiveModel::Validator
+        def validate(record)
+          limit = options[:limit] || 1024
+          return unless record.data && record.payload_data_size > limit
+          record.errors[:base] << "Notification payload data cannot be larger than #{limit} bytes."
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/registration_ids_count_validator.rb

@@ -0,0 +1,13 @@
+module Rpush
+  module Client
+    module ActiveModel
+      class RegistrationIdsCountValidator < ::ActiveModel::Validator
+        def validate(record)
+          limit = options[:limit] || 100
+          return unless record.registration_ids && record.registration_ids.size > limit
+          record.errors[:base] << "Number of registration_ids cannot be larger than #{limit}."
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/wpns/app.rb

@@ -0,0 +1,13 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wpns
+        module App
+          def service_name
+            'wpns'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/wpns/notification.rb

@@ -0,0 +1,17 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wpns
+        module Notification
+          def self.included(base)
+            base.instance_eval do
+              validates :uri, presence: true
+              validates :uri, format: { with: %r{https?://[\S]+} }
+              validates :alert, presence: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model.rb

@@ -0,0 +1,21 @@
+require 'active_model'
+
+require 'rpush/client/active_model/notification'
+require 'rpush/client/active_model/payload_data_size_validator'
+require 'rpush/client/active_model/registration_ids_count_validator'
+
+require 'rpush/client/active_model/apns/binary_notification_validator'
+require 'rpush/client/active_model/apns/device_token_format_validator'
+require 'rpush/client/active_model/apns/app'
+require 'rpush/client/active_model/apns/notification'
+
+require 'rpush/client/active_model/adm/data_validator'
+require 'rpush/client/active_model/adm/app'
+require 'rpush/client/active_model/adm/notification'
+
+require 'rpush/client/active_model/gcm/expiry_collapse_key_mutual_inclusion_validator'
+require 'rpush/client/active_model/gcm/app'
+require 'rpush/client/active_model/gcm/notification'
+
+require 'rpush/client/active_model/wpns/app'
+require 'rpush/client/active_model/wpns/notification'

data/lib/rpush/client/active_record/adm/app.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Adm
+        class App < Rpush::Client::ActiveRecord::App
+          include Rpush::Client::ActiveModel::Adm::App
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record/adm/notification.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Adm
+        class Notification < Rpush::Client::ActiveRecord::Notification
+          include Rpush::Client::ActiveModel::Adm::Notification
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record/apns/app.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Apns
+        class App < Rpush::Client::ActiveRecord::App
+          include Rpush::Client::ActiveModel::Apns::App
+        end
+      end
+    end
+  end
+end