rpush 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b35cfade151c01d8fc40a3c2c600294eacfbfe0
-  data.tar.gz: e9da0a8194b7916eab23ad91b8158e48f506247f
+  metadata.gz: ddc24f899bd6b0f1eed7b50b40f16658290cec0e
+  data.tar.gz: bffc9e9752d7d53fa65dd6f6f1498e6a0f8d3ad4
 SHA512:
-  metadata.gz: a5b4463d42d74de9fa8a68cdcc424b0990d7b6e34fae5a920875b042dba246a6901a4666ff2452d6ef37f1325232764537a41ed06b2f8dc318a84ef9ae3b368b
-  data.tar.gz: 0fc2176665da6cabbc9459bd35d1cb7b782771195fd882122808ccad7e35f9303675da12bf0c2c7617c17b4a8bdc271742a8ead20b790711b2d25f6fb5fe0657
+  metadata.gz: 458e8e80010377460ad4968ac03ac448e435d221fb6385a7045a023e07114f69635d5f3f130c2c3bcf68b4ac35396d50a58de888154959275a326d5e680ab059
+  data.tar.gz: 85197cad6ac231852aeba0c1d405a9f2eaab8a4b60523cc7e9b223d6598436a53075dd6eadf7a7611f38e32a03173cbf04d1804445215e474f738de1af76ce61

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 2.0.0 (unreleased)
+## 2.0.0 (Sept 6, 2014)
   * Use APNs enhanced binary format version 2.
   * Support running multiple Rpush processes when using ActiveRecord and Redis.
   * APNs error detection is now performed asynchronously, 'check_for_errors' is therefore deprecated.
@@ -11,6 +11,7 @@
   * The 'batch_storage_updates' config option has been deprecated, storage backends will now always batch updates where appropriate.
   * The rpush process title updates with number of queued notifications and number of dispatchers.
   * Rpush::Apns::Feedback#app has been renamed to app_id and is now an Integer.
+  * An app is restarted when the HUP signal is received if its certificate or environment attribute changed.
 
 ## 1.0.0 (Feb 9, 2014)
   * Renamed to Rpush (from Rapns). Version number reset to 1.0.0.

data/README.md

@@ -7,15 +7,23 @@
 
 ### Rpush. The push notification service for Ruby.
 
-* Supports:
+* Supported services:
   * **Apple Push Notification Service**
   * **Google Cloud Messaging**
   * **Amazon Device Messaging**
-  * **Windows Phone Push Notification Service**.
+  * **Windows Phone Push Notification Service**
+
+
+* Supported storage backends:
+  * ActiveRecord
+  * Redis
+  * More coming soon!
+
+
 * Seamless Rails (3, 4) integration.
-* Scalable - choose the number of persistent connections for each app.
-* Designed for uptime - signal -HUP to add, update apps.
-* Run as a daemon or inside an [existing processs](https://github.com/rpush/rpush/wiki/Embedding-API).
+* Scales vertically (threading) and horizontally (multiple processes).
+* Designed for uptime - new apps are loaded automatically, signal `HUP` to update running apps.
+* Run as a daemon or inside an [existing process](https://github.com/rpush/rpush/wiki/Embedding-API).
 * Use in a scheduler for low-workload deployments ([Push API](https://github.com/rpush/rpush/wiki/Push-API)).
 * Hooks for fine-grained instrumentation and error handling ([Reflection API](https://github.com/rpush/rpush/wiki/Reflection-API)).
 * Works with MRI, JRuby and Rubinius.
@@ -122,31 +130,40 @@ n.alert = "..."
 n.save!
 ```
 
-### Starting Rpush
+### Running Rpush
 
-As a daemon (recommended):
+It is recommended to run Rpush as a separate process in most cases, though embedding and manual modes are provided for low-workload environments.
+
+#### As a daemon (recommended):
 
     cd /path/to/rails/app
     rpush <Rails environment> [options]
 
-Inside an existing process (see [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API)):
+#### Embedded inside an existing process
 
 ```ruby
+# Call this during startup of your application, for example, by adding it to the end of config/initializers/rpush.rb
 Rpush.embed
 ```
 
-In a scheduler (see [Push API](https://github.com/rpush/rpush/wiki/Push-API)):
+See [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API) for more details.
+
+#### Manually (in a scheduler)
 
 ```ruby
 Rpush.push
 Rpush.apns_feedback
 ```
 
+See [Push API](https://github.com/rpush/rpush/wiki/Push-API) for more details.
+
+### Configuration
+
 See [Configuration](https://github.com/rpush/rpush/wiki/Configuration) for a list of options, or run `rpush --help`.
 
 ### Updating Rpush
 
-After updating you should run `rails g rpush` to check for any new migrations.
+If you're using ActiveRecord, you should run `rails g rpush` after upgrading Rpush to check for any new migrations.
 
 ### Wiki
 

data/bin/rpush

@@ -12,10 +12,10 @@ options = ARGV.options do |opts|
   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.") { |n| config.push_poll = n }
   opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback.") { |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('-e', '--no-error-checks', 'Disable APNs error checking after notification delivery.') { config.check_for_errors = false } # deprecated
   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, 'Storage backend notification batch size.') { |n| config.batch_size = n }
-  opts.on('-B', '--[no-]batch-storage-updates', 'Perform storage updates in batches.') { |v| config.batch_storage_updates = v }
+  opts.on('-B', '--[no-]batch-storage-updates', 'Perform storage updates in batches.') { |v| config.batch_storage_updates = v } # deprecated
   opts.on('-v', '--version', 'Print the version.') do
     puts "rpush #{Rpush::VERSION}"
     exit

data/lib/generators/templates/rpush.rb

@@ -119,7 +119,6 @@ Rpush.reflect do |on|
   # 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

@@ -7,7 +7,7 @@ class Rpush200Updates < ActiveRecord::Migration
       remove_index :rpush_notifications, name: :index_rpush_notifications_multi
     end
 
-    add_index :rpush_notifications, [:processing, :delivered, :failed, :deliver_after], name: 'index_rpush_notifications_multi'
+    add_index :rpush_notifications, [:delivered, :failed], name: 'index_rpush_notifications_multi', where: 'NOT delivered AND NOT failed'
 
     rename_column :rpush_feedback, :app, :app_id
 

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

@@ -14,6 +14,8 @@ module Rpush
         attribute :client_id, :string
         attribute :client_secret, :string
 
+        index :name
+
         validates :name, presence: true
         validates_numericality_of :connections, greater_than: 0, only_integer: true
       end

data/lib/rpush/daemon.rb

@@ -51,8 +51,8 @@ module Rpush
     end
 
     def self.start
-      SignalHandler.start
       Process.daemon if daemonize?
+      SignalHandler.start
       initialize_store
       write_pid_file
       Synchronizer.sync

data/lib/rpush/daemon/app_runner.rb

@@ -4,7 +4,9 @@ module Rpush
       extend Reflectable
       include Reflectable
       include Loggable
+      extend Loggable
       include StringHelpers
+      extend StringHelpers
 
       @runners = {}
 
@@ -24,6 +26,7 @@ module Rpush
       def self.start_app(app)
         @runners[app.id] = new(app)
         @runners[app.id].start
+        log_info("[#{app.name}] Started, #{pluralize(app.connections, 'dispatcher')}.")
       rescue StandardError => e
         @runners.delete(app.id)
         Rpush.logger.error("[#{app.name}] Exception raised during startup. Notifications will not be delivered for this app.")
@@ -32,7 +35,15 @@ module Rpush
       end
 
       def self.stop_app(app_id)
-        @runners.delete(app_id).stop
+        runner = @runners.delete(app_id)
+        if runner
+          runner.stop
+          log_info("[#{runner.app.name}] Stopped.")
+        end
+      end
+
+      def self.app_with_id(app_id)
+        @runners[app_id].app
       end
 
       def self.app_running?(app)

data/lib/rpush/daemon/signal_handler.rb

@@ -7,42 +7,47 @@ module Rpush
 
       def self.start
         return unless trap_signals?
-        @shutting_down = false
+
         read_io, @write_io = IO.pipe
         start_handler(read_io)
         %w(INT TERM HUP USR2).each do |signal|
-          Signal.trap(signal) { @write_io.write("#{Signal.list[signal]}\n") }
+          Signal.trap(signal) { @write_io.puts(signal) }
         end
       end
 
       def self.stop
-        @write_io.write("shutdown\n") if @write_io
+        @write_io.puts('break') if @write_io
         @thread.join if @thread
       end
 
       def self.start_handler(read_io)
         @thread = Thread.new do
-          loop do
-            case read_io.readline.strip.to_i
-            when Signal.list['HUP']
-              Synchronizer.sync
-              Feeder.wakeup
-            when Signal.list['USR2']
-              AppRunner.debug
-            when Signal.list['INT'], Signal.list['TERM']
-              Thread.new { handle_shutdown_signal }
-            else
-              break
+          while readable_io = IO.select([read_io]) # rubocop:disable AssignmentInCondition
+            signal = readable_io.first[0].gets.strip
+
+            begin
+              case signal
+              when 'HUP'
+                Synchronizer.sync
+                Feeder.wakeup
+              when 'USR2'
+                AppRunner.debug
+              when 'INT', 'TERM'
+                Thread.new { Rpush::Daemon.shutdown }
+                break
+              when 'break'
+                break
+              else
+                Rpush.logger.error("Unhandled signal: #{signal}")
+              end
+            rescue StandardError => e
+              Rpush.logger.error("Error raised when hndling signal '#{signal}'")
+              Rpush.logger.error(e)
             end
           end
         end
       end
 
-      def self.handle_shutdown_signal
-        @shutting_down = true
-        Rpush::Daemon.shutdown
-      end
-
       def self.trap_signals?
         !Rpush.config.embedded
       end

data/lib/rpush/daemon/synchronizer.rb

@@ -14,13 +14,19 @@ module Rpush
       end
 
       def self.sync_app(app)
-        unless AppRunner.app_running?(app)
+        if !AppRunner.app_running?(app)
           AppRunner.start_app(app)
-          log_info("[#{app.name}] Started, #{pluralize(app.connections, 'dispatcher')}.")
-          return
+        elsif certificate_changed?(app)
+          log_info("[#{app.name}] Certificate changed, restarting...")
+          AppRunner.stop_app(app.id)
+          AppRunner.start_app(app)
+        elsif environment_changed?(app)
+          log_info("[#{app.name}] Environment changed, restarting...")
+          AppRunner.stop_app(app.id)
+          AppRunner.start_app(app)
+        else
+          sync_dispatcher_count(app)
         end
-
-        sync_dispatcher_count(app)
       end
 
       def self.sync_dispatcher_count(app)
@@ -39,6 +45,16 @@ module Rpush
         num_dispatchers = AppRunner.num_dispatchers_for_app(app)
         log_info("[#{app.name}] #{start_stop_str} #{pluralize(diff.abs, 'dispatcher')}. #{num_dispatchers} running.")
       end
+
+      def self.certificate_changed?(app)
+        old_app = AppRunner.app_with_id(app.id)
+        app.certificate != old_app.certificate
+      end
+
+      def self.environment_changed?(app)
+        old_app = AppRunner.app_with_id(app.id)
+        app.environment != old_app.environment
+      end
     end
   end
 end

data/lib/rpush/version.rb

@@ -1,3 +1,3 @@
 module Rpush
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.0.0'
 end

data/spec/functional/apns_spec.rb

@@ -127,17 +127,16 @@ describe 'APNs' do
         notification1.delivered.should be_true
       end
 
-      it 'marks notifications following the failed one as retryable' # do
-      #   # Such hacks. Set the poll frequency high enough that we'll only ever feed once.
-      #   Rpush.config.push_poll = 1_000_000
-      #
-      #   notifications.each { |n| wait_for_notification_to_deliver(n) }
-      #   fail_notification(notification2)
-      #
-      #   [notification3, notification4].each do |n|
-      #     wait_for_notification_to_retry(n)
-      #   end
-      # end
+      it 'marks notifications following the failed one as retryable' do
+        Rpush.config.push_poll = 1_000_000
+
+        notifications.each { |n| wait_for_notification_to_deliver(n) }
+        fail_notification(notification2)
+
+        [notification3, notification4].each do |n|
+          wait_for_notification_to_retry(n)
+        end
+      end
 
       describe 'without an error response' do
         it 'marks all notifications as failed' do

data/spec/functional/synchronization_spec.rb

@@ -16,6 +16,9 @@ describe 'Synchronization' do
     app.name = 'test'
     app.auth_key = 'abc123'
     app.connections = 2
+    app.certificate = TEST_CERT_WITH_PASSWORD
+    app.password = 'fubar'
+    app.environment = 'sandbox'
     app.save!
 
     Rpush.embed
@@ -43,4 +46,23 @@ describe 'Synchronization' do
     Rpush.sync
     Rpush::Daemon::AppRunner.app_running?(app).should be_false
   end
+
+  it 'restarts an app when the certificate is changed' do
+    app.certificate = TEST_CERT
+    app.password = nil
+    app.save!
+    Rpush.sync
+
+    running_app = Rpush::Daemon::AppRunner.app_with_id(app.id)
+    expect(running_app.certificate).to eql(TEST_CERT)
+  end
+
+  it 'restarts an app when the environment is changed' do
+    app.environment = 'production'
+    app.save!
+    Rpush.sync
+
+    running_app = Rpush::Daemon::AppRunner.app_with_id(app.id)
+    expect(running_app.environment).to eql('production')
+  end
 end

data/spec/unit/daemon/app_runner_spec.rb

@@ -32,7 +32,7 @@ module Rpush
 end
 
 describe Rpush::Daemon::AppRunner, 'enqueue' do
-  let(:app) { double(id: 1) }
+  let(:app) { double(id: 1, name: 'Test', connections: 1) }
   let(:notification) { double(app_id: 1) }
   let(:runner) { double(Rpush::Daemon::AppRunner, enqueue: nil, start: nil, stop: nil) }
   let(:logger) { double(Rpush::Logger, error: nil, info: nil) }
@@ -53,7 +53,7 @@ describe Rpush::Daemon::AppRunner, 'enqueue' do
 
   it 'starts the app if a runner does not exist' do
     notification = double(app_id: 3)
-    new_app = double(Rpush::App, id: 3)
+    new_app = double(Rpush::App, id: 3, name: 'NewApp', connections: 1)
     Rpush::Daemon.store = double(app: new_app)
     Rpush::Daemon::AppRunner.enqueue([notification])
     Rpush::Daemon::AppRunner.app_running?(new_app).should be_true

data/spec/unit/daemon/signal_handler_spec.rb

@@ -69,4 +69,27 @@ describe Rpush::Daemon::SignalHandler do
       end
     end
   end
+
+  describe 'error handing' do
+    let(:error) { StandardError.new('test') }
+
+    before { Rpush.stub(logger: double(error: nil)) }
+
+    it 'logs errors received when handling a signal' do
+      Rpush::Daemon::Synchronizer.stub(:sync).and_raise(error)
+      expect(Rpush.logger).to receive(:error).with(error)
+      with_handler_start_stop do
+        signal_handler('HUP')
+      end
+    end
+
+    it 'does not interrupt processing of further errors' do
+      Rpush::Daemon::Synchronizer.stub(:sync).and_raise(error)
+      expect(Rpush::Daemon::AppRunner).to receive(:debug)
+      with_handler_start_stop do
+        signal_handler('HUP')
+        signal_handler('USR2')
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -249,9 +249,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2