rpush_extended 3.2.5

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, '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 = 2048
+
+          def validate(record)
+            return unless record.payload.bytesize > 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]\w+$/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,104 @@
+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
+
+          MUTABLE_CONTENT_KEY = '__rpush_mutable_content__'
+          def mutable_content=(bool)
+            return unless bool
+            self.data = (data || {}).merge(MUTABLE_CONTENT_KEY => true)
+          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(options = nil) # rubocop:disable Metrics/AbcSize, 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
+              json['aps']['category'] = category if category
+              json['aps']['url-args'] = url_args if url_args
+              json['aps']['thread-id'] = thread_id if thread_id
+
+              if data && data[MUTABLE_CONTENT_KEY]
+                json['aps']['mutable-content'] = 1
+              end
+
+              if data && data[CONTENT_AVAILABLE_KEY]
+                json['aps']['content-available'] = 1
+              end
+
+              if data
+                non_aps_attributes = data.reject { |k, _| k == CONTENT_AVAILABLE_KEY || k == MUTABLE_CONTENT_KEY }
+                non_aps_attributes.each { |k, v| json[k.to_s] = v }
+              end
+            end
+
+            json
+          end
+
+          def to_binary(options = {})
+            frame_payload = payload
+            frame_id = options[:for_validation] ? 0 : send(options.fetch(:id_attribute, :id))
+            frame = ""
+            frame << [1, 32, device_token].pack("cnH*")
+            frame << [2, frame_payload.bytesize, frame_payload].pack("cna*")
+            frame << [3, 4, frame_id].pack("cnN")
+            frame << [4, 4, expiry ? Time.now.to_i + expiry.to_i : 0].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'].try(: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/apns2/app.rb

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns2
+        module App
+          extend Rpush::Client::ActiveModel::Apns::App
+
+          def service_name
+            'apns2'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns2
+        include Rpush::Client::ActiveModel::Apns
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apnsp8
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :environment, presence: true, inclusion: { in: %w(development production sandbox) }
+              validates :apn_key, presence: true
+              validates :apn_key_id, presence: true
+              validates :team_id, presence: true
+              validates :bundle_id, presence: true
+            end
+          end
+
+          def service_name
+            'apnsp8'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apnsp8
+        include Rpush::Client::ActiveModel::Apns
+      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,59 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Gcm
+        module Notification
+          GCM_PRIORITY_HIGH = Rpush::Client::ActiveModel::Apns::Notification::APNS_PRIORITY_IMMEDIATE
+          GCM_PRIORITY_NORMAL = Rpush::Client::ActiveModel::Apns::Notification::APNS_PRIORITY_CONSERVE_POWER
+          GCM_PRIORITIES = [GCM_PRIORITY_HIGH, GCM_PRIORITY_NORMAL]
+
+          def self.included(base)
+            base.instance_eval do
+              validates :registration_ids, presence: true
+              validates :priority, inclusion: { in: GCM_PRIORITIES }, allow_nil: 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
+
+          # This is a hack. The schema defines `priority` to be an integer, but GCM expects a string.
+          # But for users of rpush to have an API they might expect (setting priority to `high`, not 10)
+          # we do a little conversion here.
+          # I'm not happy about it, but this will have to do until I can take a further look.
+          def priority=(priority)
+            case priority
+              when 'high'
+                super(GCM_PRIORITY_HIGH)
+              when 'normal'
+                super(GCM_PRIORITY_NORMAL)
+              else
+                errors.add(:priority, 'must be one of either "normal" or "high"')
+            end
+          end
+
+          def as_json(options = nil)
+            json = {
+                'registration_ids' => registration_ids,
+                'delay_while_idle' => delay_while_idle,
+                'data' => data
+            }
+            json['collapse_key'] = collapse_key if collapse_key
+            json['content_available'] = content_available if content_available
+            json['notification'] = notification if notification
+            json['priority'] = priority_for_notification if priority
+            json['time_to_live'] = expiry if expiry
+            json
+          end
+
+          def priority_for_notification
+            return 'high' if priority == GCM_PRIORITY_HIGH
+            'normal' if priority == GCM_PRIORITY_NORMAL
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+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_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/pushy/app.rb

@@ -0,0 +1,20 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Pushy
+        module App
+          def self.included(base)
+            base.instance_eval do
+              alias_attribute :api_key, :auth_key
+              validates :api_key, presence: true
+            end
+          end
+
+          def service_name
+            'pushy'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Pushy
+        module Notification
+          def self.included(base)
+            base.instance_eval do
+              alias_attribute :time_to_live, :expiry
+
+              validates :time_to_live, numericality: { only_integer: true, greater_than: 0 }, allow_nil: true
+              validates :registration_ids, presence: true
+              validates :data, presence: true
+
+              validates_with Rpush::Client::ActiveModel::Pushy::TimeToLiveValidator
+              validates_with Rpush::Client::ActiveModel::PayloadDataSizeValidator, limit: 4096
+              validates_with Rpush::Client::ActiveModel::RegistrationIdsCountValidator, limit: 1000
+            end
+          end
+
+          def as_json(_options = nil)
+            {
+              'data'             => data,
+              'time_to_live'     => time_to_live,
+              'registration_ids' => registration_ids
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/pushy/time_to_live_validator.rb

@@ -0,0 +1,14 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Pushy
+        class TimeToLiveValidator < ::ActiveModel::Validator
+          def validate(record)
+            return if record.time_to_live.blank? || record.time_to_live <= 1.year.seconds
+            record.errors.add(:time_to_live, 'The maximum value is 1 year')
+          end
+        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/wns/app.rb

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wns
+        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
+            'wns'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wns
+        module Notification
+          module InstanceMethods
+            def alert=(value)
+              return unless value
+              data = self.data || {}
+              data['title'] = value
+              self.data = data
+            end
+
+            def skip_data_validation?
+              false
+            end
+          end
+
+          def self.included(base)
+            base.instance_eval do
+              include InstanceMethods
+
+              validates :uri, presence: true
+              validates :uri, format: { with: %r{https?://[\S]+} }
+              validates :data, presence: true, unless: :skip_data_validation?
+            end
+          end
+        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,28 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wpns
+        module Notification
+          module InstanceMethods
+            def alert=(value)
+              return unless value
+              data = self.data || {}
+              data['title'] = value
+              self.data = data
+            end
+          end
+
+          def self.included(base)
+            base.instance_eval do
+              include InstanceMethods
+
+              validates :uri, presence: true
+              validates :uri, format: { with: %r{https?://[\S]+} }
+              validates :data, presence: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model.rb

@@ -0,0 +1,34 @@
+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/apns2/app'
+require 'rpush/client/active_model/apns2/notification'
+
+require 'rpush/client/active_model/apnsp8/app'
+require 'rpush/client/active_model/apnsp8/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'
+
+require 'rpush/client/active_model/wns/app'
+require 'rpush/client/active_model/wns/notification'
+
+require 'rpush/client/active_model/pushy/app'
+require 'rpush/client/active_model/pushy/notification'
+require 'rpush/client/active_model/pushy/time_to_live_validator'

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

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

@@ -0,0 +1,18 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Apns
+        class Feedback < ::ActiveRecord::Base
+          self.table_name = 'rpush_feedback'
+
+          belongs_to :app, class_name: 'Rpush::Client::ActiveRecord::App'
+
+          validates :device_token, presence: true
+          validates :failed_at, presence: true
+
+          validates_with Rpush::Client::ActiveModel::Apns::DeviceTokenFormatValidator
+        end
+      end
+    end
+  end
+end