rpush 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 927abaa3a2c391f3d390a0075f5aeaf3ae12a9d0
-  data.tar.gz: b272119c8cc1ba826dea17fd5e0bde2e261e12a5
+  metadata.gz: dcd5a386e63d453ba0a442b2636d17c9f5d1163d
+  data.tar.gz: 6bcf897de27d5f489e237ec004883e0d31685741
 SHA512:
-  metadata.gz: f30b21a842cca1acfa350be012d2292bb0a2dcb85ab3a859d37f5e63836af026def22481aa6b2d09fe6bfb5527ba8964c3033e804c64274a9ce1119c058b74aa
-  data.tar.gz: 559c85b0d96ae83c36c37ce62080a6d0f054fadaac6ec26d5b1035cef2f1c1fbcd33efa9da75737608335cf12cda30c463ce5a4b71304f7bc05a0b1858eb2036
+  metadata.gz: a35052dca2662df7e86819c6e74eb9ea31fd892da03701c771924dd2c9858bd7b5f36e330cb9e5093300df4809cf627617115e9548514af62a0a4bab1437367d
+  data.tar.gz: 1947d69afa9d7fd55688da01a0e5e25d62b4cde78b23c2b66a78b66a044c0fe05650851a2331108a2f2042a2a0133da96be22714484f7a965be15aea204c39dd

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 2.4.0 (Fed 18, 2015)
+  Features:
+  * Support for MongoDB (using Mongoid).
+  * config.feedback_poll is now deprecated, use config.apns.feedback_receiver.frequency instead.
+  * Add config.apns.feedback_receiver.enabled to optionally enable the APNs feedback receiver (#129).
+  * Passing configuration options directly to Rpush.embed and Rpush.push is now deprecated.
+
+  Bug fixes:
+  * Fix setting the log level when using Rails 4+ or without Rails (#124).
+  * Fix the possibility for excessive error logging when using APNs (#128).
+  * Re-use timestamp when replacing a migration with the same name (#91).
+  * Ensure App/Notification type is updated during 2.0 upgrade migration (#102).
+
 ## 2.3.2 (Jan 30, 2015)
   Bug fixes:
   * Internal sleep mechanism would sometimes no wait for the full duration specified.

data/README.md

@@ -19,7 +19,7 @@ Rpush aims to be the *de facto* gem for sending push notifications in Ruby. Its
 
 #### Feature Highlights
 
-* Use [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord) or [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis) for storage.
+* Use [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord), [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis) or [**MongoDB**](https://github.com/rpush/rpush/wiki/Using-Mongodb) for storage.
 * Plugins for [**Bugsnag**](https://github.com/rpush/rpush-plugin-bugsnag),
 [**Sentry**](https://github.com/rpush/rpush-plugin-sentry), [**StatsD**](https://github.com/rpush/rpush-plugin-statsd).
 * Seamless integration with your projects, including **Rails**.

data/lib/generators/rpush_migration_generator.rb

@@ -2,11 +2,25 @@ class RpushMigrationGenerator < 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')
+  class << self
+    attr_accessor :next_template
+
+    def next_migration_number(path)
+      return new_migration_number unless next_template
+
+      if existing_migration = migration_exists?(File.expand_path('db/migrate'), next_template)
+        return File.basename(existing_migration).scan(/(\d+)_/).flatten.first
+      end
+
+      new_migration_number
+    end
+
+    def new_migration_number
+      @time ||= Time.now.utc
+      @calls ||= -1
+      @calls += 1
+      (@time + @calls.seconds).strftime('%Y%m%d%H%M%S')
+    end
   end
 
   def copy_migration
@@ -36,6 +50,7 @@ class RpushMigrationGenerator < Rails::Generators::Base
    end
 
   def add_rpush_migration(template)
-      migration_template "#{template}.rb", "db/migrate/#{template}.rb"
+    self.class.next_template = template
+    migration_template "#{template}.rb", "db/migrate/#{template}.rb"
   end
 end

data/lib/generators/templates/rpush.rb

@@ -1,6 +1,6 @@
 Rpush.configure do |config|
 
-  # Supported clients are :active_record and :redis.
+  # Supported clients are :active_record, :redis and :mongoid
   config.client = :active_record
 
   # Options passed to Redis.new
@@ -9,9 +9,6 @@ Rpush.configure do |config|
   # Frequency in seconds to check for new notifications.
   config.push_poll = 2
 
-  # Frequency in seconds to check for feedback
-  config.feedback_poll = 60
-
   # 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
@@ -24,11 +21,14 @@ Rpush.configure do |config|
   # Path to log file. Relative to current directory unless absolute.
   config.log_file = 'log/rpush.log'
 
-  config.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::INFO
+  config.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::DEBUG
 
   # Define a custom logger.
   # config.logger = MyLogger.new
 
+  # config.apns.feedback_receiver.enabled = true
+  # config.apns.feedback_receiver.frequency = 60
+
  end
 
 Rpush.reflect do |on|

data/lib/generators/templates/rpush_2_0_0_updates.rb

@@ -1,4 +1,18 @@
 class Rpush200Updates < ActiveRecord::Migration
+  module Rpush
+    class App < ActiveRecord::Base
+      self.table_name = 'rpush_apps'
+    end
+
+    class Notification < ActiveRecord::Base
+      self.table_name = 'rpush_notifications'
+    end
+  end
+
+  def self.update_type(model, from, to)
+    model.where(type: from).update_all(type: to)
+  end
+
   def self.up
     add_column :rpush_notifications, :processing, :boolean, null: false, default: false
     add_column :rpush_notifications, :priority, :integer, null: true
@@ -16,9 +30,19 @@ class Rpush200Updates < ActiveRecord::Migration
     else
       change_column :rpush_feedback, :app_id, :integer
     end
+
+    [:Apns, :Gcm, :Wpns, :Adm].each do |service|
+      update_type(Rpush200Updates::Rpush::App, "Rpush::#{service}::App", "Rpush::Client::ActiveRecord::#{service}::App")
+      update_type(Rpush200Updates::Rpush::Notification, "Rpush::#{service}::Notification", "Rpush::Client::ActiveRecord::#{service}::Notification")
+    end
   end
 
   def self.down
+    [:Apns, :Gcm, :Wpns, :Adm].each do |service|
+      update_type(Rpush200Updates::Rpush::App, "Rpush::Client::ActiveRecord::#{service}::App", "Rpush::#{service}::App")
+      update_type(Rpush200Updates::Rpush::Notification, "Rpush::Client::ActiveRecord::#{service}::Notification", "Rpush::#{service}::Notification")
+    end
+
     change_column :rpush_feedback, :app_id, :string
     rename_column :rpush_feedback, :app_id, :app
 

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

@@ -66,7 +66,7 @@ module Rpush
 
           def to_binary(options = {}) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
             frame_payload = payload
-            frame_id = options[:for_validation] ? 0 : id
+            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*")

data/lib/rpush/client/mongoid.rb

@@ -0,0 +1,31 @@
+
+# :nocov:
+begin
+  require 'mongoid'
+  require 'autoinc'
+rescue LoadError
+  puts
+  str = "* Please add 'rpush-mongoid' to your Gemfile to use the Mongoid client. *"
+  puts "*" * str.size
+  puts str
+  puts "*" * str.size
+  puts
+end
+
+require 'rpush/client/active_model'
+
+require 'rpush/client/mongoid/notification'
+require 'rpush/client/mongoid/app'
+
+require 'rpush/client/mongoid/apns/notification'
+require 'rpush/client/mongoid/apns/feedback'
+require 'rpush/client/mongoid/apns/app'
+
+require 'rpush/client/mongoid/gcm/notification'
+require 'rpush/client/mongoid/gcm/app'
+
+require 'rpush/client/mongoid/wpns/notification'
+require 'rpush/client/mongoid/wpns/app'
+
+require 'rpush/client/mongoid/adm/notification'
+require 'rpush/client/mongoid/adm/app'

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

@@ -0,0 +1,14 @@
+module Rpush
+  module Client
+    module Mongoid
+      module Adm
+        class App < Rpush::Client::Mongoid::App
+          include Rpush::Client::ActiveModel::Adm::App
+
+          field :access_token, type: String
+          field :access_token_expiration, type: Time
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,21 @@
+module Rpush
+  module Client
+    module Mongoid
+      module Apns
+        class Feedback
+          include ::Mongoid::Document
+
+          field :device_token, type: String
+          field :failed_at, type: Time
+
+          belongs_to :app
+
+          validates :device_token, presence: true
+          validates :failed_at, presence: true
+
+          validates_with Rpush::Client::ActiveModel::Apns::DeviceTokenFormatValidator
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module Mongoid
+      module Apns
+        class Notification < Rpush::Client::Mongoid::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
+
+          def to_binary(options = {})
+            super(options.merge(id_attribute: :integer_id))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/mongoid/app.rb

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module Mongoid
+      class App
+        include ::Mongoid::Document
+
+        field :name, type: String
+        field :environment, type: String
+        field :certificate, type: String
+        field :password, type: String
+        field :connections, type: Integer, default: 1
+        field :auth_key, type: String
+        field :client_id, type: String
+        field :client_secret, type: String
+
+        index name: 1
+
+        validates :name, presence: true
+        validates_numericality_of :connections, greater_than: 0, only_integer: true
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,43 @@
+module Rpush
+  module Client
+    module Mongoid
+      class Notification
+        include ::Mongoid::Document
+        include ::Mongoid::Autoinc
+        include Rpush::MultiJsonHelper
+        include Rpush::Client::ActiveModel::Notification
+
+        field :badge, type: Integer
+        field :device_token, type: String
+        field :sound, type: String, default: 'default'
+        field :alert, type: String
+        field :data, type: Hash
+        field :expiry, type: Integer, default: 1.day.to_i
+        field :delivered, type: Boolean, default: false
+        field :delivered_at, type: Time
+        field :processing, type: Boolean, default: false
+        field :failed, type: Boolean, default: false
+        field :failed_at, type: Time
+        field :fail_after, type: Time
+        field :retries, type: Integer, default: 0
+        field :error_code, type: Integer
+        field :error_description, type: String
+        field :deliver_after, type: Time
+        field :alert_is_json, type: Boolean
+        field :collapse_key, type: String
+        field :delay_while_idle, type: Boolean
+        field :registration_ids, type: Array
+        field :uri, type: String
+        field :priority, type: Integer
+        field :url_args, type: Array
+        field :category, type: String
+
+        field :integer_id, type: Integer
+        increments :integer_id, model_name: name
+        index integer_id: 1
+
+        belongs_to :app
+      end
+    end
+  end
+end

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

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

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

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

data/lib/rpush/client/redis.rb

@@ -1,6 +1,8 @@
+
 # :nocov:
 begin
   require 'modis'
+  require 'redis'
 rescue LoadError
   puts
   str = "* Please add 'rpush-redis' to your Gemfile to use the Redis client. *"
@@ -10,8 +12,6 @@ rescue LoadError
   puts
 end
 
-require 'redis'
-
 require 'rpush/client/active_model'
 
 require 'rpush/client/redis/app'

data/lib/rpush/configuration.rb

@@ -1,35 +1,64 @@
 require 'pathname'
 
 module Rpush
-  def self.config
-    @config ||= Rpush::Configuration.new
-  end
+  class << self
+    attr_writer :config
+
+    def config
+      @config ||= Rpush::Configuration.new
+    end
 
-  def self.configure
-    if block_given?
+    def configure
+      return unless block_given?
       yield config
       config.initialize_client
     end
   end
 
-  CURRENT_ATTRS = [:push_poll, :feedback_poll, :embedded, :pid_file, :batch_size,
-                   :push, :client, :logger, :log_file, :foreground, :log_level, :plugin]
-  DEPRECATED_ATTRS = [:log_dir]
+  CURRENT_ATTRS = [:push_poll, :embedded, :pid_file, :batch_size, :push, :client, :logger, :log_file, :foreground, :log_level, :plugin, :apns]
+  DEPRECATED_ATTRS = [:feedback_poll]
   CONFIG_ATTRS = CURRENT_ATTRS + DEPRECATED_ATTRS
 
   class ConfigurationError < StandardError; end
-  class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS); end
+  class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS); end # rubocop:disable Style/StructInheritance
 
-  class Configuration < Struct.new(*CONFIG_ATTRS)
-    include Deprecatable
+  class ApnsFeedbackReceiverConfiguration < Struct.new(:frequency, :enabled) # rubocop:disable Style/StructInheritance
+    def initialize
+      super
+      self.enabled = true
+      self.frequency = 60
+    end
+  end
+
+  class ApnsConfiguration < Struct.new(:feedback_receiver) # rubocop:disable Style/StructInheritance
+    def initialize
+      super
+      self.feedback_receiver = ApnsFeedbackReceiverConfiguration.new
+    end
+  end
 
-    deprecated(:log_dir=, '2.3.0', 'Please use log_file instead.')
+  class Configuration < Struct.new(*CONFIG_ATTRS) # rubocop:disable Style/StructInheritance
+    include Deprecatable
 
     delegate :redis_options, to: '::Modis'
 
     def initialize
       super
-      set_defaults
+
+      self.push_poll = 2
+      self.batch_size = 100
+      self.logger = nil
+      self.log_file = 'log/rpush.log'
+      self.pid_file = 'tmp/rpush.pid'
+      self.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::DEBUG
+      self.plugin = OpenStruct.new
+      self.foreground = false
+
+      self.apns = ApnsConfiguration.new
+
+      # Internal options.
+      self.embedded = false
+      self.push = false
     end
 
     def update(other)
@@ -68,31 +97,21 @@ module Rpush
       Modis.redis_options = options if client == :redis
     end
 
-    def set_defaults
-      self.push_poll = 2
-      self.feedback_poll = 60
-      self.batch_size = 100
-      self.logger = nil
-      self.log_file = 'log/rpush.log'
-      self.pid_file = 'tmp/rpush.pid'
-      self.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::INFO
-      self.plugin = OpenStruct.new
-      self.foreground = false
-
-      # Internal options.
-      self.embedded = false
-      self.push = false
+    def feedback_poll=(frequency)
+      apns.feedback_receiver.frequency = frequency
     end
+    deprecated(:feedback_poll=, '2.5.0', 'Please use apns.feedback_receiver.frequency= instead.')
 
     def initialize_client
       return if @client_initialized
       raise ConfigurationError, 'Rpush.config.client is not set.' unless client
       require "rpush/client/#{client}"
+
       client_module = Rpush::Client.const_get(client.to_s.camelize)
-      Rpush.send(:include, client_module)
+      Rpush.send(:include, client_module) unless Rpush.ancestors.include?(client_module)
 
       [:Apns, :Gcm, :Wpns, :Adm].each do |service|
-        Rpush.const_set(service, client_module.const_get(service))
+        Rpush.const_set(service, client_module.const_get(service)) unless Rpush.const_defined?(service)
       end
 
       @client_initialized = true