rpush 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0da1cac03ae3688486b3d3a35f9adf1aff283bed
-  data.tar.gz: 3710bfdf83a7fd76a790a42d4ee95278ed07f7e2
+  metadata.gz: 927abaa3a2c391f3d390a0075f5aeaf3ae12a9d0
+  data.tar.gz: b272119c8cc1ba826dea17fd5e0bde2e261e12a5
 SHA512:
-  metadata.gz: e84ccee43191d9876c30f4df293299dc8c4d08de3ad96882aec3eb7fc0302217d32de0b1bede2faa296d686a9fa4c451ebb8a27a0560f664dcb5d578765465ae
-  data.tar.gz: 6cd9310c439cb97f8eab52456303d94b3c2c43872498a7c361f6343031b545476c2200707b1645f462de2b151fe585b6b476234edf7864a6875fe3c69a4156e6
+  metadata.gz: f30b21a842cca1acfa350be012d2292bb0a2dcb85ab3a859d37f5e63836af026def22481aa6b2d09fe6bfb5527ba8964c3033e804c64274a9ce1119c058b74aa
+  data.tar.gz: 559c85b0d96ae83c36c37ce62080a6d0f054fadaac6ec26d5b1035cef2f1c1fbcd33efa9da75737608335cf12cda30c463ce5a4b71304f7bc05a0b1858eb2036

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.3.2 (Jan 30, 2015)
+  Bug fixes:
+  * Internal sleep mechanism would sometimes no wait for the full duration specified.
+  * Rpush.push nows delivers all pending notifications before returning.
+  * Require thor >= 0.18.1 (#121).
+
 ## 2.3.1 (Jan 24, 2015)
   * Fix CPU thrashing while waiting for an APNs connection be established (#119).
 

data/README.md

@@ -7,24 +7,27 @@
 
 ### Rpush. The push notification service for Ruby.
 
-* Supported services:
+Rpush aims to be the *de facto* gem for sending push notifications in Ruby. Its core goals are ease of use, reliability and a rich feature set. Rpush provides numerous advanced features not found in others gems, giving you greater control & insight as your project grows. These are a few of the reasons why companies worldwide rely on Rpush to deliver their notifications.
+
+#### Supported Services
+
   * [**Apple Push Notification Service**](#apple-push-notification-service)
     * Including Safari Push Notifications.
   * [**Google Cloud Messaging**](#google-cloud-messaging)
   * [**Amazon Device Messaging**](#amazon-device-messaging)
   * [**Windows Phone Push Notification Service**](#windows-phone-notification-service)
 
-* Supported storage backends:
-  * [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord)
-  * [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis)
+#### Feature Highlights
 
-* Optional Rails integration (version 3 & 4).
+* Use [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord) or [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis) 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**.
+* Run as a [daemon](https://github.com/rpush/rpush#as-a-daemon-recommended), inside a [job queue](https://github.com/rpush/rpush/wiki/Push-API), on the [command-line](https://github.com/rpush/rpush#on-the-command-line) or [embedded](https://github.com/rpush/rpush/wiki/Embedding-API) in another process.
 * 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.
+* Works with **MRI**, **JRuby** and **Rubinius**.
 
 
 ### Getting Started
@@ -35,11 +38,11 @@ Add it to your Gemfile:
 gem 'rpush'
 ```
 
-Initialize Rpush into your project. Rails will be detected automatically.
+Initialize Rpush into your project. **Rails will be detected automatically.**
 
-```
-cd /path/to/project
-rpush init
+```sh
+$ cd /path/to/project
+$ rpush init
 ```
 
 ### Create an App & Notification
@@ -134,24 +137,24 @@ n.save!
 
 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/project
-rpush start
-```
-
 See `rpush help` for all available commands and options.
 
-#### One-off, manual
-
-On the command-line:
+#### As a daemon
 
+```sh
+$ cd /path/to/project
+$ rpush start
 ```
-rpush push
+
+#### On the command-line
+
+```sh
+$ rpush push
 ```
 
-In your code:
+Rpush will deliver all pending notifications and then exit.
+
+#### In a scheduled job
 
 ```ruby
 Rpush.push
@@ -163,11 +166,16 @@ 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
+if defined?(Rails)
+  ActiveSupport.on_load(:after_initialize) do
+    Rpush.embed
+  end
+else
+  Rpush.embed
+end
 ```
 
-See [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API) for more details.
+Call this during startup of your application, for example, by adding it to the end of `config/rpush.rb`. See [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API) for more details.
 
 ### Configuration
 
@@ -177,7 +185,7 @@ See [Configuration](https://github.com/rpush/rpush/wiki/Configuration) for a lis
 
 You should run `rpush init` after upgrading Rpush to check for configuration and migration changes.
 
-### Wiki
+### From The Wiki
 
 ### General
 * [Using Redis](https://github.com/rpush/rpush/wiki/Using-Redis)

data/lib/rpush/configuration.rb

@@ -77,6 +77,7 @@ module Rpush
       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

data/lib/rpush/daemon/feeder.rb

@@ -3,9 +3,15 @@ module Rpush
     class Feeder
       extend Reflectable
 
-      def self.start
+      def self.start(push_mode = false)
         self.should_stop = false
-        Rpush.config.push ? enqueue_notifications : feed_forever
+
+        @thread = Thread.new do
+          push_mode ? feed_all : feed_forever
+          Rpush::Daemon.store.release_connection
+        end
+
+        @thread.join
       end
 
       def self.stop
@@ -22,18 +28,16 @@ module Rpush
         attr_accessor :should_stop
       end
 
-      def self.feed_forever
-        @thread = Thread.new do
-          loop do
-            enqueue_notifications
-            interruptible_sleeper.sleep
-            break if should_stop
-          end
+      def self.feed_all
+        enqueue_notifications until Rpush::Daemon.store.pending_delivery_count == 0
+      end
 
-          Rpush::Daemon.store.release_connection
+      def self.feed_forever
+        loop do
+          enqueue_notifications
+          interruptible_sleeper.sleep
+          break if should_stop
         end
-
-        @thread.join
       end
 
       def self.enqueue_notifications

data/lib/rpush/daemon/interruptible_sleep.rb

@@ -5,15 +5,21 @@ module Rpush
     class InterruptibleSleep
       def initialize(duration)
         @duration = duration
-        @obj = Object.new
-        @obj.extend(MonitorMixin)
-        @condition = @obj.new_cond
         @stop = false
+
+        @wakeup_obj = Object.new
+        @wakeup_obj.extend(MonitorMixin)
+        @wakeup_condition = @wakeup_obj.new_cond
+
+        @sleep_obj = Object.new
+        @sleep_obj.extend(MonitorMixin)
+        @sleep_condition = @sleep_obj.new_cond
       end
 
       def sleep
         return if @stop
-        @obj.synchronize { @condition.wait(100_000) }
+        goto_sleep
+        wait_for_wakeup
       end
 
       def start
@@ -21,6 +27,7 @@ module Rpush
 
         @thread = Thread.new do
           loop do
+            wait_for_sleeper
             break if @stop
             Kernel.sleep(@duration)
             wakeup
@@ -35,7 +42,21 @@ module Rpush
       end
 
       def wakeup
-        @obj.synchronize { @condition.signal }
+        @wakeup_obj.synchronize { @wakeup_condition.signal }
+      end
+
+      private
+
+      def goto_sleep
+        @sleep_obj.synchronize { @sleep_condition.signal }
+      end
+
+      def wait_for_wakeup
+        @wakeup_obj.synchronize { @wakeup_condition.wait(@duration * 2) }
+      end
+
+      def wait_for_sleeper
+        @sleep_obj.synchronize { @sleep_condition.wait }
       end
     end
   end

data/lib/rpush/daemon/store/active_record.rb

@@ -165,6 +165,10 @@ module Rpush
           Rpush.logger.error(e)
         end
 
+        def pending_delivery_count
+          ready_for_delivery.count
+        end
+
         private
 
         def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists

data/lib/rpush/daemon/store/interface.rb

@@ -8,7 +8,7 @@ module Rpush
                           :create_gcm_notification, :create_adm_notification, :update_app,
                           :update_notification, :release_connection,
                           :all_apps, :app, :mark_ids_failed, :mark_ids_retryable,
-                          :reopen_log]
+                          :reopen_log, :pending_delivery_count]
 
         def self.check(klass)
           missing = PUBLIC_METHODS - klass.instance_methods.map(&:to_sym)

data/lib/rpush/daemon/store/redis.rb

@@ -106,6 +106,15 @@ module Rpush
         def reopen_log
         end
 
+        def pending_delivery_count
+          Modis.with_connection do |redis|
+            pending = redis.zrange(Rpush::Client::Redis::Notification.absolute_pending_namespace, 0, -1)
+            retryable = redis.zrangebyscore(Rpush::Client::Redis::Notification.absolute_retryable_namespace, 0, Time.now.to_i)
+
+            pending.count + retryable.count
+          end
+        end
+
         private
 
         def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists
@@ -133,6 +142,7 @@ module Rpush
         end
 
         def pending_notification_ids(limit)
+          limit = [0, limit - 1].max # 'zrange key 0 1' will return 2 values, not 1.
           pending_ns = Rpush::Client::Redis::Notification.absolute_pending_namespace
 
           Modis.with_connection do |redis|

data/lib/rpush/embed.rb

@@ -9,6 +9,7 @@ module Rpush
     config = Rpush::ConfigurationWithoutDefaults.new
     options.each { |k, v| config.send("#{k}=", v) }
     config.embedded = true
+    config.foreground = true
     Rpush.config.update(config)
     Kernel.at_exit { shutdown }
     @embed_thread = Thread.new { Rpush::Daemon.start }

data/lib/rpush/logger.rb

@@ -69,6 +69,7 @@ module Rpush
       end
 
       formatted_msg = "[#{Time.now.to_s(:db)}] "
+      formatted_msg << '[rpush] ' if Rpush.config.embedded
       formatted_msg << "[#{prefix}] " if prefix
       formatted_msg << msg
 

data/lib/rpush/push.rb

@@ -9,8 +9,7 @@ module Rpush
 
     Rpush::Daemon.common_init
     Rpush::Daemon::Synchronizer.sync
-    Rpush::Daemon::Feeder.start
-    # TODO: Wait until there are no more notifications.
+    Rpush::Daemon::Feeder.start(true) # non-blocking
     Rpush::Daemon::AppRunner.stop
   end
 end

data/lib/rpush/version.rb

@@ -1,3 +1,3 @@
 module Rpush
-  VERSION = '2.3.1'
+  VERSION = '2.3.2'
 end

data/spec/functional/adm_spec.rb

@@ -20,11 +20,11 @@ describe 'ADM' do
     notification.data = { message: 'test' }
     notification.save!
 
-    Net::HTTP::Persistent.stub(new: http)
+    allow(Net::HTTP::Persistent).to receive_messages(new: http)
   end
 
   it 'delivers a notification successfully' do
-    response.stub(body: JSON.dump(registrationID: notification.registration_ids.first.to_s))
+    allow(response).to receive_messages(body: JSON.dump(registrationID: notification.registration_ids.first.to_s))
 
     expect do
       Rpush.push
@@ -33,12 +33,10 @@ describe 'ADM' do
   end
 
   it 'fails to deliver a notification successfully' do
-    response.stub(code: 400, body: JSON.dump(reason: 'error', registrationID: notification.registration_ids.first.to_s))
-
-    expect do
-      Rpush.push
-      notification.reload
-    end.to_not change(notification, :delivered).to(true)
+    allow(response).to receive_messages(code: 400, body: JSON.dump(reason: 'error', registrationID: notification.registration_ids.first.to_s))
+    Rpush.push
+    notification.reload
+    expect(notification.delivered).to eq(false)
   end
 
   it 'retries notification that fail due to a SocketError' do

data/spec/functional/apns_spec.rb

@@ -33,8 +33,8 @@ describe 'APNs' do
   end
 
   def stub_tcp_connection
-    Rpush::Daemon::TcpConnection.any_instance.stub(connect_socket: [tcp_socket, ssl_socket])
-    Rpush::Daemon::TcpConnection.any_instance.stub(setup_ssl_context: double.as_null_object)
+    allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(connect_socket: [tcp_socket, ssl_socket])
+    allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(setup_ssl_context: double.as_null_object)
     stub_const('Rpush::Daemon::TcpConnection::IO', io_double)
   end
 
@@ -55,13 +55,13 @@ describe 'APNs' do
   end
 
   def fail_notification(notification)
-    ssl_socket.stub(read: [8, 4, notification.id].pack('ccN'))
+    allow(ssl_socket).to receive_messages(read: [8, 4, notification.id].pack('ccN'))
     enable_io_select
   end
 
   def enable_io_select
     called = false
-    io_double.stub(:select) do
+    allow(io_double).to receive(:select) do
       if called
         nil
       else
@@ -88,9 +88,9 @@ describe 'APNs' do
     allow(ssl_socket).to receive(:read).and_return(tuple, nil)
     Rpush.apns_feedback
     feedback = Rpush::Apns::Feedback.all.first
-    feedback.should_not be_nil
-    feedback.app_id.should eq(app.id)
-    feedback.device_token.should eq('834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17')
+    expect(feedback).not_to be_nil
+    expect(feedback.app_id).to eq(app.id)
+    expect(feedback.device_token).to eq('834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17')
   end
 
   describe 'delivery failures' do
@@ -132,7 +132,7 @@ describe 'APNs' do
 
     describe 'with a failed connection' do
       it 'retries all notifications' do
-        Rpush::Daemon::TcpConnection.any_instance.stub(sleep: nil)
+        allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(sleep: nil)
         expect(ssl_socket).to receive(:write).at_least(1).times.and_raise(Errno::EPIPE)
         notifications = 2.times.map { create_notification }
         notifications.each { |n| wait_for_notification_to_retry(n) }
@@ -159,7 +159,7 @@ describe 'APNs' do
 
         expect(failed_ids).to_not include(notification1.id)
         notification1.reload
-        notification1.delivered.should be_true
+        expect(notification1.delivered).to eq(true)
       end
 
       it 'marks notifications following the failed one as retryable' do

data/spec/functional/embed_spec.rb

@@ -23,10 +23,10 @@ describe 'embedding' do
   end
 
   def stub_tcp_connection
-    Rpush::Daemon::TcpConnection.any_instance.stub(connect_socket: [tcp_socket, ssl_socket])
-    Rpush::Daemon::TcpConnection.any_instance.stub(setup_ssl_context: double.as_null_object)
+    allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(connect_socket: [tcp_socket, ssl_socket])
+    allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(setup_ssl_context: double.as_null_object)
     stub_const('Rpush::Daemon::TcpConnection::IO', io_double)
-    Rpush::Daemon::Apns::FeedbackReceiver.stub(new: double.as_null_object)
+    allow(Rpush::Daemon::Apns::FeedbackReceiver).to receive_messages(new: double.as_null_object)
   end
 
   before do

data/spec/functional/gcm_spec.rb

@@ -16,11 +16,11 @@ describe 'GCM' do
     notification.data = { message: 'test' }
     notification.save!
 
-    Net::HTTP::Persistent.stub(new: http)
+    allow(Net::HTTP::Persistent).to receive_messages(new: http)
   end
 
   it 'delivers a notification successfully' do
-    response.stub(body: JSON.dump(results: [{ message_id: notification.registration_ids.first.to_s }]))
+    allow(response).to receive_messages(body: JSON.dump(results: [{ message_id: notification.registration_ids.first.to_s }]))
 
     expect do
       Rpush.push
@@ -29,12 +29,10 @@ describe 'GCM' do
   end
 
   it 'fails to deliver a notification successfully' do
-    response.stub(body: JSON.dump(results: [{ error: 'Err' }]))
-
-    expect do
-      Rpush.push
-      notification.reload
-    end.to_not change(notification, :delivered).to(true)
+    allow(response).to receive_messages(body: JSON.dump(results: [{ error: 'Err' }]))
+    Rpush.push
+    notification.reload
+    expect(notification.delivered).to eq(false)
   end
 
   it 'retries notification that fail due to a SocketError' do