rapns 0.2.2 → 0.2.3

data/README.md

@@ -44,7 +44,7 @@ If you want to use rapns in environments other than development or production, y
 ### Options:
 
 * `host` the APNs host to connect to, either `gateway.sandbox.push.apple.com` or `gateway.sandbox.push.apple.com`.
-* `port` the APNs port. Currently 2195 for both hosts.
+* `port` the APNs port. Currently `2195` for both hosts.
 * `certificate` The path to your .pem certificate, `config/rapns` is automatically checked if a relative path is given.
 * `certificate_password` (default: blank) the password you used when exporting your certificate, if any.
 * `airbrake_notify` (default: true) Enables/disables error notifications via Airbrake.
@@ -59,7 +59,11 @@ If you want to use rapns in environments other than development or production, y
     
 ### Options
 
-* `--foreground` will prevent rapns from forking into a daemon. Activity information will be printed to the screen.
+* `--foreground` will prevent rapns from forking into a daemon.
+
+## Logging
+
+rapns logs activity to `rapns.log` in your Rails log directory. This is also printed to STDOUT when running in the foreground. When running as a daemon rapns does not print to STDOUT or STDERR.
 
 ## Sending a Notification
 
@@ -74,7 +78,7 @@ If you want to use rapns in environments other than development or production, y
     n.save!
 
 * `sound` defaults to `1.aiff`. You can either set it to a custom .aiff file, or `nil` for no sound.
-* `expiry` is the time in seconds the APNs will spend trying to deliver the notification to the device. The notification is discarded if it has not been delivered in this time. Default is 1 day.
+* `expiry` is the time in seconds the APNs (not rapns) will spend trying to deliver the notification to the device. The notification is discarded if it has not been delivered in this time. Default is 1 day.
 * `attributes_for_device` is the `NSDictionary` argument passed to your iOS app in either `didFinishLaunchingWithOptions` or `didReceiveRemoteNotification`.
 * `deliver_after` is not required, but may be set if you'd like to delay delivery of the notification to a specific time in the future.
 
@@ -109,4 +113,4 @@ Fork as usual and go crazy!
 
 When running specs, please note that the ActiveRecord adapter can be changed by setting the `ADAPTER` environment variable. For example: `ADAPTER=postgresql rake`.
 
-Available adapters for testing are 'mysql', 'mysql2' and 'postgresql'.
+Available adapters for testing are `mysql`, `mysql2` and `postgresql`.

data/lib/rapns/daemon/connection.rb

@@ -39,7 +39,7 @@ module Rapns
           @ssl_socket.flush
 
           check_for_error
-        rescue Errno::EPIPE => e
+        rescue Errno::EPIPE, OpenSSL::SSL::SSLError => e
           Rapns::Daemon.logger.error("[#{@name}] Lost connection to #{Rapns::Daemon.configuration.host}:#{Rapns::Daemon.configuration.port}, reconnecting...")
           @tcp_socket, @ssl_socket = connect_socket
 

data/lib/rapns/daemon/delivery_handler.rb

@@ -4,7 +4,7 @@ module Rapns
       STOP = 0x666
 
       def start
-        @thread = Thread.new do 
+        Thread.new do 
           loop do
             break if @stop
             handle_next_notification
@@ -18,32 +18,39 @@ module Rapns
 
       protected
 
+      def deliver(notification)
+        Rapns::Daemon.connection_pool.claim_connection do |connection|
+          begin
+            connection.write(notification.to_binary)
+
+            notification.delivered = true
+            notification.delivered_at = Time.now
+            notification.save!(:validate => false)
+
+            Rapns::Daemon.logger.info("Notification #{notification.id} delivered to #{notification.device_token}")
+          rescue Rapns::DeliveryError => error
+            handle_delivery_error(notification, error)
+          end
+        end
+      end
+
+      def handle_delivery_error(notification, error)
+        Rapns::Daemon.logger.error(error)
+
+        notification.delivered = false
+        notification.delivered_at = nil
+        notification.failed = true
+        notification.failed_at = Time.now
+        notification.error_code = error.code
+        notification.error_description = error.description
+        notification.save!(:validate => false)
+      end
+
       def handle_next_notification
         notification = Rapns::Daemon.delivery_queue.pop
         begin
           return if notification == STOP
-
-          Rapns::Daemon.connection_pool.claim_connection do |connection|
-            begin
-              connection.write(notification.to_binary)
-
-              notification.delivered = true
-              notification.delivered_at = Time.now
-              notification.save!(:validate => false)
-
-              Rapns::Daemon.logger.info("Notification #{notification.id} delivered to #{notification.device_token}")
-            rescue Rapns::DeliveryError => error
-              Rapns::Daemon.logger.error(error)
-
-              notification.delivered = false
-              notification.delivered_at = nil
-              notification.failed = true
-              notification.failed_at = Time.now
-              notification.error_code = error.code
-              notification.error_description = error.description
-              notification.save!(:validate => false)
-            end
-          end
+          deliver(notification)
         rescue StandardError => e
           Rapns::Daemon.logger.error(e)
         ensure

data/lib/rapns/daemon/delivery_queue.rb

@@ -4,8 +4,8 @@ module Rapns
       def initialize(num_handlers)
         @num_handlers = num_handlers
         @queue = Queue.new
-        @feeder_threads = []
-        @mutex = Mutex.new
+        @feeder = nil
+        @handler_mutex = Mutex.new
       end
 
       def push(obj)
@@ -17,7 +17,7 @@ module Rapns
       end
 
       def handler_available
-        @mutex.synchronize do
+        @handler_mutex.synchronize do
           signal_feeder if handler_available?
         end
       end
@@ -28,19 +28,16 @@ module Rapns
 
       def signal_feeder
         begin
-          t = @feeder_threads.shift
-          t.wakeup if t
+          @feeder.wakeup if @feeder
         rescue ThreadError
           retry
         end
       end
 
       def wait_for_available_handler
-        Thread.exclusive do
-          if @queue.size >= @num_handlers
-            @feeder_threads << Thread.current
-            Thread.stop
-          end
+        if !handler_available?
+          @feeder = Thread.current
+          @feeder.stop
         end
       end
     end

data/lib/rapns/daemon/feeder.rb

@@ -7,13 +7,21 @@ ADAPTER_ERRORS = [PGError, Mysql::Error, Mysql2::Error]
 module Rapns
   module Daemon
     class Feeder
-      def self.start
+      def self.start(foreground)
+        connect unless foreground
+
         loop do
           break if @stop
           enqueue_notifications
         end
       end
 
+      def self.stop
+        @stop = true
+      end
+
+      protected
+
       def self.enqueue_notifications
         begin
           Rapns::Notification.ready_for_delivery.each do |notification|
@@ -31,27 +39,36 @@ module Rapns
         sleep Rapns::Daemon.configuration.poll
       end
 
-      def self.stop
-        @stop = true
-      end
-
       def self.reconnect
         Rapns::Daemon.logger.warn('Lost connection to database, reconnecting...')
         attempts = 0
         loop do
           begin
             Rapns::Daemon.logger.warn("Attempt #{attempts += 1}")
-            ActiveRecord::Base.clear_all_connections!
-            ActiveRecord::Base.establish_connection
-            Rapns::Notification.count
+            connect
+            check_is_connected
             break
           rescue *ADAPTER_ERRORS => e
             Rapns::Daemon.logger.error(e, :airbrake_notify => false)
-            sleep 2 # Avoid thrashing.
+            sleep_to_avoid_thrashing
           end
         end
         Rapns::Daemon.logger.warn('Database reconnected')
       end
+
+      def self.connect
+        ActiveRecord::Base.clear_all_connections!
+        ActiveRecord::Base.establish_connection
+      end
+
+      def self.check_is_connected
+        # Simple asking the adapter for the connection state is not sufficient.
+        Rapns::Notification.count
+      end
+
+      def self.sleep_to_avoid_thrashing
+        sleep 2
+      end
     end
   end
 end

data/lib/rapns/daemon/logger.rb

@@ -13,7 +13,7 @@ module Rapns
       end
 
       def error(msg, options = {})
-        airbrake_notify(msg) if msg.is_a?(Exception) && options[:airbrake_notify] != false
+        airbrake_notify(msg) if notify_via_airbrake?(msg, options)
         log(:error, msg, 'ERROR')
       end
 
@@ -44,6 +44,10 @@ module Rapns
           HoptoadNotifier.notify(e)
         end
       end
+
+      def notify_via_airbrake?(msg, options)
+        msg.is_a?(Exception) && options[:airbrake_notify] != false
+      end
     end
   end
 end

data/lib/rapns/daemon.rb

@@ -36,10 +36,7 @@ module Rapns
 
       self.delivery_queue = DeliveryQueue.new(configuration.connections)
 
-      unless foreground?
-        daemonize
-        ActiveRecord::Base.establish_connection
-      end
+      daemonize unless foreground?
 
       write_pid_file
 
@@ -49,8 +46,8 @@ module Rapns
       self.connection_pool = ConnectionPool.new(configuration.connections)
       connection_pool.populate
 
-      logger.info("Ready")
-      Feeder.start
+      logger.info('Ready')
+      Feeder.start(foreground?)
     end
 
     protected

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/spec/rapns/daemon/connection_spec.rb

@@ -160,6 +160,51 @@ describe Rapns::Daemon::Connection, "when the connection is lost" do
   end
 end
 
+describe Rapns::Daemon::Connection, "when an SSL error occurs during write" do
+  before do
+    @connection = Rapns::Daemon::Connection.new("Connection 1")
+    @ssl_socket = mock("SSLSocket")
+    @connection.instance_variable_set("@ssl_socket", @ssl_socket)
+    @connection.stub(:connect_socket).and_return([mock("TCPSocket"), @ssl_socket])
+    @ssl_socket.stub(:write).and_raise(OpenSSL::SSL::SSLError)
+    @logger = mock("Logger", :error => nil)
+    Rapns::Daemon.stub(:logger).and_return(@logger)
+    @connection.stub(:sleep)
+    configuration = mock("Configuration", :host => "localhost", :port => 123)
+    Rapns::Daemon.stub(:configuration).and_return(configuration)
+  end
+
+  it "should log a error" do
+    Rapns::Daemon.logger.should_receive(:error).with("[Connection 1] Lost connection to localhost:123, reconnecting...")
+    begin
+      @connection.write(nil)
+    rescue Rapns::Daemon::ConnectionError
+    end
+  end
+
+  it "should retry to make a connection 3 times" do
+    @connection.should_receive(:connect_socket).exactly(3).times
+    begin
+      @connection.write(nil)
+    rescue Rapns::Daemon::ConnectionError
+    end
+  end
+
+  it "should raise a ConnectionError after 3 attempts at reconnecting" do
+    expect do
+      @connection.write(nil)
+    end.to raise_error(Rapns::Daemon::ConnectionError, "Connection 1 tried 3 times to reconnect but failed: #<OpenSSL::SSL::SSLError: OpenSSL::SSL::SSLError>")
+  end
+
+  it "should sleep 1 second before retrying the connection" do
+    @connection.should_receive(:sleep).with(1)
+    begin
+      @connection.write(nil)
+    rescue Rapns::Daemon::ConnectionError
+    end
+  end
+end
+
 describe Rapns::Daemon::Connection, "when sending a notification" do
   before do
     @connection = Rapns::Daemon::Connection.new("Connection 1")

data/spec/rapns/daemon/feeder_spec.rb

@@ -11,6 +11,18 @@ describe Rapns::Daemon::Feeder do
     Rapns::Daemon.stub(:configuration => mock("Configuration", :poll => 2))
   end
 
+  it "should reconnect to the database when daemonized" do
+    Rapns::Daemon::Feeder.stub(:loop)
+    ActiveRecord::Base.should_receive(:establish_connection)
+    Rapns::Daemon::Feeder.start(false)
+  end
+
+  it "should not reconnect to the database when running in the foreground" do
+    Rapns::Daemon::Feeder.stub(:loop)
+    ActiveRecord::Base.should_not_receive(:establish_connection)
+    Rapns::Daemon::Feeder.start(true)
+  end
+
   it "should enqueue an undelivered notification" do
     @notification.update_attributes!(:delivered => false)
     Rapns::Daemon.delivery_queue.should_receive(:push)

data/spec/rapns/daemon_spec.rb

@@ -87,12 +87,6 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon.start("development", false)
   end
 
-  it "should re-establish the connection to the database after being forked" do
-    ActiveRecord::Base.should_receive(:establish_connection)
-    Rapns::Daemon.stub(:daemonize)
-    Rapns::Daemon.start("development", false)
-  end
-
   it "should not fork a child process if the foreground option is true" do
     Rapns::Daemon.should_not_receive(:daemonize)
     Rapns::Daemon.start("development", true)

data/spec/spec_helper.rb

@@ -21,6 +21,7 @@ require 'generators/templates/create_rapns_notifications'
 CreateRapnsNotifications.down rescue ActiveRecord::StatementInvalid
 CreateRapnsNotifications.up
 
+require 'bundler'
 Bundler.require(:default)
 
 require 'shoulda'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000Z
+date: 2011-11-04 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use library for Apple's Push Notification Service with Rails
   3