rpush 2.2.0 → 2.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ade9eddd89766399d488b8d364041c517911c0cc
-  data.tar.gz: 3ee953452451b0ea1318de7f52e090ab58bd6439
+  metadata.gz: f5611fd691dabad23056a88e8f2365f6ce04b763
+  data.tar.gz: 82754af135986e7b53c8f2243336a407072c513a
 SHA512:
-  metadata.gz: 9f10cb58e8a84f852a43bd9d2b7b7bea5df1d8f3bed8638297601960a9365254e4605376f340f78dcc3c1e0296269a31b97554705f588642cc1dc481ec905d22
-  data.tar.gz: ed5f267363e0b76deaf60811109c8e6fe9ef63e95f35c8e4bc266edd46efc4f4c1900e2a47116a92ff1463a761b5533c085c1f166f04c6a2acbffae4ef31c39c
+  metadata.gz: c8c6f6eb789c720bec7c28c080855014032a510fae0e84faa009c5fa19891e6d879959161d693256177c3cd7eee3dad5dcb7b9b3396245b4d51103b0d84b662b
+  data.tar.gz: 7ce71396e9811513f8387824869f9770ce851d67afaf28ad5ff22429de91d66b71027e7cf085d8f4de5e2a95487616752477b4dda8aa00b450c94c5d78c71f0e

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.3.0 (unreleased)
+  * Add 'version' CLI command.
+  * Rpush::Wpns::Notification now supports setting the 'data' attribute.
+  * ActiveRecord is now directed to the configured Rpush logger (#104).
+  * Logs are reopened when the HUP signal is received (#95).
+  * Fix setting config.redis_options (#114).
+  * Increase frequency of TCP keepalive probes on Linux.
+  * APNs notifications are no longer marked as failed when a dropped connection is detected, as it's impossible to know exactly how many actually failed (if any).
+  * Notifications are now retried instead of being marked as failed if a TCP/HTTP connection cannot be established.
+
 ## 2.2.0 (Oct 7, 2014)
   * Numerous command-line fixes, sorry folks!
   * Add 'rpush push' command-line command for one-off use.

data/README.md

@@ -61,7 +61,7 @@ app.save!
 ```ruby
 n = Rpush::Apns::Notification.new
 n.app = Rpush::Apns::App.find_by_name("ios_app")
-n.device_token = "..."
+n.device_token = "..." # 64-character hex string
 n.alert = "hi mom!"
 n.data = { foo: :bar }
 n.save!
@@ -126,7 +126,7 @@ app.save!
 n = Rpush::Wpns::Notification.new
 n.app = Rpush::Wpns::App.find_by_name("windows_phone_app")
 n.uri = "http://..."
-n.alert = "..."
+n.data = {title:"MyApp", body:"Hello world", param:"user_param1"}
 n.save!
 ```
 
@@ -143,16 +143,15 @@ rpush start
 
 See `rpush help` for all available commands and options.
 
-#### Embedded inside an existing process
+#### One-off, manual
 
-```ruby
-# Call this during startup of your application, for example, by adding it to the end of config/rpush.rb
-Rpush.embed
-```
+On the command-line:
 
-See [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API) for more details.
+```
+rpush push
+```
 
-#### Manually (in a scheduler)
+In your code:
 
 ```ruby
 Rpush.push
@@ -161,6 +160,15 @@ Rpush.apns_feedback
 
 See [Push API](https://github.com/rpush/rpush/wiki/Push-API) for more details.
 
+#### Embedded inside an existing process
+
+```ruby
+# Call this during startup of your application, for example, by adding it to the end of config/rpush.rb
+Rpush.embed
+```
+
+See [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API) for more details.
+
 ### Configuration
 
 See [Configuration](https://github.com/rpush/rpush/wiki/Configuration) for a list of options.

data/lib/generators/rpush_migration_generator.rb

@@ -6,7 +6,7 @@ class RpushMigrationGenerator < Rails::Generators::Base
     @time ||= Time.now.utc
     @calls ||= -1
     @calls += 1
-    (@time + @calls.seconds).strftime("%Y%m%d%H%M%S")
+    (@time + @calls.seconds).strftime('%Y%m%d%H%M%S')
   end
 
   def copy_migration

data/lib/rpush.rb

@@ -19,7 +19,10 @@ require 'rpush/deprecatable'
 require 'rpush/logger'
 require 'rpush/multi_json_helper'
 require 'rpush/configuration'
-require 'rpush/reflection'
+require 'rpush/reflection_collection'
+require 'rpush/reflection_public_methods'
+require 'rpush/reflectable'
+require 'rpush/plugin'
 require 'rpush/embed'
 require 'rpush/push'
 require 'rpush/apns_feedback'

data/lib/rpush/apns_feedback.rb

@@ -1,7 +1,7 @@
 module Rpush
   def self.apns_feedback
     require 'rpush/daemon'
-    Rpush::Daemon.initialize_store
+    Rpush::Daemon.common_init
 
     Rpush::Apns::App.all.each do |app|
       receiver = Rpush::Daemon::Apns::FeedbackReceiver.new(app)

data/lib/rpush/cli.rb

@@ -1,12 +1,10 @@
 # encoding: UTF-8
 
 require 'thor'
-require 'term/ansicolor'
+require 'ansi/code'
 
 module Rpush
   class CLI < Thor
-    include Term::ANSIColor
-
     def self.detect_rails?
       ['bin/rails', 'script/rails'].any? { |path| File.exist?(path) }
     end
@@ -22,9 +20,7 @@ module Rpush
     option 'pid-file', type: :string, aliases: '-p'
     desc 'start', 'Start Rpush'
     def start
-      underscore_option_names
-      check_ruby_version
-      configure_rpush
+      config_setup
 
       require 'rpush/daemon'
       Rpush::Daemon.start
@@ -33,9 +29,7 @@ module Rpush
     desc 'stop', 'Stop Rpush'
     option 'pid-file', type: :string, aliases: '-p'
     def stop
-      underscore_option_names
-      check_ruby_version
-      configure_rpush
+      config_setup
       ensure_pid_file_set
 
       if File.exist?(Rpush.config.pid_file)
@@ -53,21 +47,21 @@ module Rpush
           end
         end
 
-        puts green('✔')
+        puts ANSI.green { '✔' }
       else
         STDERR.puts("* Rpush isn't running? #{Rpush.config.pid_file} does not exist.")
         return
       end
     end
 
-    desc 'init', 'Initialize Rpush into the current directory.'
+    desc 'init', 'Initialize Rpush into the current directory'
     option 'active-record', type: :boolean, desc: 'Install ActiveRecord migrations'
     def init
       underscore_option_names
       check_ruby_version
       require 'rails/generators'
 
-      puts "* #{green('Installing config...')}"
+      puts "* " + ANSI.green { 'Installing config...' }
       $RPUSH_CONFIG_PATH = default_config_path # rubocop:disable Style/GlobalVars
       Rails::Generators.invoke('rpush_config')
 
@@ -76,7 +70,7 @@ module Rpush
       unless options.key?('active_record')
         has_answer = false
         until has_answer
-          STDOUT.write "\n* #{green('Install ActiveRecord migrations?')} [y/n]: "
+          STDOUT.write "\n* #{ANSI.green { 'Install ActiveRecord migrations?' }} [y/n]: "
           STDOUT.flush
           answer = STDIN.gets.chomp.downcase
           has_answer = %w(y n).include?(answer)
@@ -87,7 +81,7 @@ module Rpush
 
       Rails::Generators.invoke('rpush_migration', ['--force']) if install_migrations
 
-      puts "\n* #{green('Next steps:')}"
+      puts "\n* #{ANSI.green { 'Next steps:' }}"
       puts "  - Run 'db:migrate'." if install_migrations
       puts "  - Review and update your configuration in #{default_config_path}."
       puts "  - Create your first app, see https://github.com/rpush/rpush for examples."
@@ -96,16 +90,25 @@ module Rpush
 
     desc 'push', 'Deliver all pending notifications and then exit'
     def push
-      underscore_option_names
-      check_ruby_version
-      configure_rpush
+      config_setup
       Rpush.config.foreground = true
 
       Rpush.push
     end
 
-    private
+    desc 'version', 'Print Rpush version'
+    def version
+      puts Rpush::VERSION
+    end
 
+    private
+      
+    def config_setup
+      underscore_option_names
+      check_ruby_version
+      configure_rpush
+    end
+    
     def configure_rpush
       load_rails_environment || load_standalone
     end
@@ -117,7 +120,7 @@ module Rpush
         ENV['RAILS_ENV'] = options['rails_env']
         load 'config/environment.rb'
         Rpush.config.update(options)
-        puts green('✔')
+        puts ANSI.green { '✔' }
 
         return true
       end
@@ -127,7 +130,7 @@ module Rpush
 
     def load_standalone
       if !File.exist?(options[:config])
-        STDERR.puts(red('ERROR: ') + "#{options[:config]} does not exist. Please run 'rpush init' to generate it or specify the --config option.")
+        STDERR.puts(ANSI.red { 'ERROR: ' } + "#{options[:config]} does not exist. Please run 'rpush init' to generate it or specify the --config option.")
         exit 1
       else
         load options[:config]
@@ -146,12 +149,12 @@ module Rpush
     def ensure_pid_file_set
       return unless Rpush.config.pid_file.blank?
 
-      STDERR.puts(red('ERROR: ') + 'config.pid_file is not set.')
+      STDERR.puts(ANSI.red { 'ERROR: ' } + 'config.pid_file is not set.')
       exit 1
     end
 
     def check_ruby_version
-      STDERR.puts(yellow('WARNING: ') + "You are using an old and unsupported version of Ruby.") if RUBY_VERSION <= '1.9.3' && RUBY_ENGINE == 'ruby'
+      STDERR.puts(ANSI.yellow { 'WARNING: ' } + "You are using an old and unsupported version of Ruby.") if RUBY_VERSION <= '1.9.3' && RUBY_ENGINE == 'ruby'
     end
 
     def underscore_option_names

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

@@ -25,7 +25,7 @@ module Rpush
                 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.'
+                errors.add :certificate, 'value must contain a certificate and a private key.'
               end
             end
             result

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

@@ -38,7 +38,7 @@ module Rpush
             self.data = (data || {}).merge(CONTENT_AVAILABLE_KEY => true)
           end
 
-          def as_json # rubocop:disable Metrics/PerceivedComplexity
+          def as_json # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
             json = ActiveSupport::OrderedHash.new
 
             if data && data.key?(MDM_KEY)
@@ -64,7 +64,7 @@ module Rpush
             json
           end
 
-          def to_binary(options = {})
+          def to_binary(options = {}) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
             frame_payload = payload
             frame_id = options[:for_validation] ? 0 : id
             frame = ""

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

@@ -7,7 +7,13 @@ module Rpush
             base.instance_eval do
               validates :uri, presence: true
               validates :uri, format: { with: %r{https?://[\S]+} }
-              validates :alert, presence: true
+              validates :data, presence: true
+            end
+            def alert=(value)
+              return unless value
+              data = self.data || {}
+              data['title'] = value
+              self.data = data
             end
           end
         end

data/lib/rpush/configuration.rb

@@ -8,37 +8,24 @@ module Rpush
   def self.configure
     if block_given?
       yield config
-      initialize_client
+      config.initialize_client
     end
   end
 
-  def self.initialize_client
-    return if @client_initialized
-    require "rpush/client/#{config.client}"
-    client_module = Rpush::Client.const_get(config.client.to_s.camelize)
-    Rpush.send(:include, client_module)
-
-    [:Apns, :Gcm, :Wpns, :Adm].each do |service|
-      Rpush.const_set(service, client_module.const_get(service))
-    end
-
-    @client_initialized = true
-  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]
+  CONFIG_ATTRS = CURRENT_ATTRS + DEPRECATED_ATTRS
 
-  CONFIG_ATTRS = [:push_poll, :feedback_poll, :embedded, :pid_file, :batch_size,
-                  :push, :client, :logger, :log_file, :foreground, :log_level,
-                  # Deprecated
-                  :log_dir]
-
-  class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
-  end
+  class ConfigurationError < StandardError; end
+  class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS); end
 
   class Configuration < Struct.new(*CONFIG_ATTRS)
     include Deprecatable
 
     deprecated(:log_dir=, '2.3.0', 'Please use log_file instead.')
 
-    delegate :redis_options, :redis_options=, to: :Modis
+    delegate :redis_options, to: '::Modis'
 
     def initialize
       super
@@ -72,19 +59,42 @@ module Rpush
       super(logger)
     end
 
+    def client=(client)
+      super
+      initialize_client
+    end
+
+    def redis_options=(options)
+      Modis.redis_options = options if client == :redis
+    end
+
     def set_defaults
       self.push_poll = 2
       self.feedback_poll = 60
       self.batch_size = 100
-      self.client = :active_record
       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
 
       # Internal options.
       self.embedded = false
       self.push = false
     end
+
+    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)
+
+      [:Apns, :Gcm, :Wpns, :Adm].each do |service|
+        Rpush.const_set(service, client_module.const_get(service))
+      end
+
+      @client_initialized = true
+    end
   end
 end

data/lib/rpush/daemon.rb

@@ -8,7 +8,6 @@ require 'net/http/persistent'
 
 require 'rpush/daemon/errors'
 require 'rpush/daemon/constants'
-require 'rpush/daemon/reflectable'
 require 'rpush/daemon/loggable'
 require 'rpush/daemon/string_helpers'
 require 'rpush/daemon/interruptible_sleep'
@@ -48,17 +47,15 @@ require 'rpush/daemon/adm'
 
 module Rpush
   module Daemon
-    extend Term::ANSIColor
-
     class << self
       attr_accessor :store
     end
 
     def self.start
       Process.daemon if daemonize?
-      SignalHandler.start
-      initialize_store
       write_pid_file
+      SignalHandler.start
+      common_init
       Synchronizer.sync
 
       # No further store connections will be made from this thread.
@@ -87,7 +84,7 @@ module Rpush
         Feeder.stop
         AppRunner.stop
         delete_pid_file
-        puts green('✔') if Rpush.config.foreground
+        puts ANSI.green { '✔' } if Rpush.config.foreground
       end
     end
 
@@ -97,7 +94,14 @@ module Rpush
       @shutdown_lock
     end
 
-    def self.initialize_store
+    def self.common_init
+      init_store
+      init_plugins
+    end
+
+    protected
+
+    def self.init_store
       return if store
       begin
         name = Rpush.config.client.to_s
@@ -110,7 +114,12 @@ module Rpush
       end
     end
 
-    protected
+    def self.init_plugins
+      Rpush.plugins.each do |name, plugin|
+        plugin.init_block.call
+        Rpush.logger.info("[plugin:#{name}] Loaded.")
+      end
+    end
 
     def self.daemonize?
       !(Rpush.config.push || Rpush.config.foreground || Rpush.config.embedded || Rpush.jruby?)
@@ -136,7 +145,7 @@ module Rpush
       if Rpush::Daemon::AppRunner.app_ids.count == 0
         puts <<-EOS
 
-* #{green('Is this your first time using Rpush?')}
+* #{ANSI.green { 'Is this your first time using Rpush?' }}
   You need to create an App before you can start using Rpush.
   Please refer to the documentation at https://github.com/rpush/rpush