rapns 1.0.0 → 1.0.1

data/lib/rapns/daemon.rb

@@ -6,6 +6,7 @@ require 'rapns/daemon/interruptible_sleep'
 require 'rapns/daemon/configuration'
 require 'rapns/daemon/certificate'
 require 'rapns/daemon/delivery_error'
+require 'rapns/daemon/disconnection_error'
 require 'rapns/daemon/pool'
 require 'rapns/daemon/connection'
 require 'rapns/daemon/delivery_queue'

data/lib/rapns/daemon/delivery_error.rb

@@ -1,15 +1,15 @@
 module Rapns
   class DeliveryError < StandardError
-    attr_reader :code, :description, :notification_id
+    attr_reader :code, :description
 
-    def initialize(code, description, notification_id)
+    def initialize(code, notification_id, description)
       @code = code
-      @description = description
       @notification_id = notification_id
+      @description = description
     end
 
     def message
-      "Unable to deliver notification #{notification_id}, received APN error #{code} (#{description})"
+      "Unable to deliver notification #{@notification_id}, received APN error #{@code} (#{@description})"
     end
   end
 end

data/lib/rapns/daemon/delivery_handler.rb

@@ -2,8 +2,6 @@ module Rapns
   module Daemon
     class DeliveryHandler
       STOP = 0x666
-      ERROR_CMD = 8
-      OK_STATUS = 0
       SELECT_TIMEOUT = 0.5
       ERROR_TUPLE_BYTES = 6
       APN_ERRORS = {
@@ -53,7 +51,7 @@ module Rapns
           notification.save!(:validate => false)
 
           Rapns::Daemon.logger.info("Notification #{notification.id} delivered to #{notification.device_token}")
-        rescue Rapns::DeliveryError => error
+        rescue Rapns::DeliveryError, Rapns::DisconnectionError => error
           handle_delivery_error(notification, error)
           raise
         end
@@ -71,22 +69,22 @@ module Rapns
 
       def check_for_error
         if @connection.select(SELECT_TIMEOUT)
-          delivery_error = nil
+          error = nil
 
-          if error = @connection.read(ERROR_TUPLE_BYTES)
-            cmd, status, notification_id = error.unpack("ccN")
+          if tuple = @connection.read(ERROR_TUPLE_BYTES)
+            cmd, code, notification_id = tuple.unpack("ccN")
 
-            if cmd == ERROR_CMD && status != OK_STATUS
-              description = APN_ERRORS[status] || "Unknown error. Possible rapns bug?"
-              delivery_error = Rapns::DeliveryError.new(status, description, notification_id)
-            end
+            description = APN_ERRORS[code.to_i] || "Unknown error. Possible rapns bug?"
+            error = Rapns::DeliveryError.new(code, notification_id, description)
+          else
+            error = Rapns::DisconnectionError.new
           end
 
           begin
             Rapns::Daemon.logger.error("[#{@name}] Error received, reconnecting...")
             @connection.reconnect
           ensure
-            raise delivery_error if delivery_error
+            raise error if error
           end
         end
       end

data/lib/rapns/daemon/disconnection_error.rb

@@ -0,0 +1,14 @@
+module Rapns
+  class DisconnectionError < StandardError
+    attr_reader :code, :description
+
+    def initialize
+      @code = nil
+      @description = "APNs disconnected without returning an error."
+    end
+
+    def message
+      "The APNs disconnected without returning an error. This may indicate you are using an invalid certificate for the host."
+    end
+  end
+end

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/rapns/daemon/delivery_error_spec.rb

@@ -1,11 +1,13 @@
 require "spec_helper"
 
 describe Rapns::DeliveryError do
-  before do
-    @error = Rapns::DeliveryError.new(4, "Missing payload", 12)
+  let(:error) { Rapns::DeliveryError.new(4, 12, "Missing payload") }
+
+  it "returns an informative message" do
+    error.message.should == "Unable to deliver notification 12, received APN error 4 (Missing payload)"
   end
 
-  it "should give an informative message" do
-    @error.message.should == "Unable to deliver notification 12, received APN error 4 (Missing payload)"
+  it "returns the error code" do
+    error.code.should == 4
   end
 end

data/spec/rapns/daemon/delivery_handler_spec.rb

@@ -90,8 +90,6 @@ describe Rapns::Daemon::DeliveryHandler do
   describe "when delivery fails" do
     before do
       @connection.stub(:select => true, :read => [8, 4, 69].pack("ccN"), :reconnect => nil)
-      @error = Rapns::DeliveryError.new(4, "Missing payload", 69)
-      Rapns::DeliveryError.stub(:new => @error)
     end
 
     it "should set the notification as not delivered" do
@@ -122,7 +120,9 @@ describe Rapns::Daemon::DeliveryHandler do
     end
 
     it "should log the delivery error" do
-      Rapns::Daemon.logger.should_receive(:error).with(@error)
+      error = Rapns::DeliveryError.new(4, 12, "Missing payload")
+      Rapns::DeliveryError.stub(:new => error)
+      Rapns::Daemon.logger.should_receive(:error).with(error)
       delivery_handler.send(:handle_next_notification)
     end
 
@@ -136,16 +136,6 @@ describe Rapns::Daemon::DeliveryHandler do
       delivery_handler.send(:handle_next_notification)
     end
 
-    it "should not raise a DeliveryError if the packet cmd value is not 8" do
-      @connection.stub(:read).and_return([6, 4, 12].pack("ccN"))
-      expect { delivery_handler.send(:handle_next_notification) }.should_not raise_error(Rapns::DeliveryError)
-    end
-
-    it "should not raise a DeliveryError if the status code is 0 (no error)" do
-      @connection.stub(:read).and_return([8, 0, 12].pack("ccN"))
-      expect { delivery_handler.send(:handle_next_notification) }.should_not raise_error(Rapns::DeliveryError)
-    end
-
     it "should read 6 bytes from the socket" do
       @connection.should_receive(:read).with(6).and_return(nil)
       delivery_handler.send(:handle_next_notification)
@@ -157,46 +147,37 @@ describe Rapns::Daemon::DeliveryHandler do
       delivery_handler.send(:handle_next_notification)
     end
 
-    it "should not raise a DeliveryError if the socket read returns nothing" do
-      @connection.stub(:read).with(6).and_return(nil)
-      expect { delivery_handler.send(:handle_next_notification) }.should_not raise_error(Rapns::DeliveryError)
-    end
-
     it "should reconnect the socket" do
       @connection.should_receive(:reconnect)
-      begin
-        delivery_handler.send(:handle_next_notification)
-      rescue Rapns::DeliveryError
-      end
+      delivery_handler.send(:handle_next_notification)
     end
 
     it "should log that the connection is being reconnected" do
       Rapns::Daemon.logger.should_receive(:error).with("[DeliveryHandler 0] Error received, reconnecting...")
-      begin
+      delivery_handler.send(:handle_next_notification)
+    end
+
+    context "when the APNs disconnects without returning an error" do
+      before do
+        @connection.stub(:read => nil)
+      end
+
+      it 'should raise a DisconnectError error if the connection is closed without an error being returned' do
+        error = Rapns::DisconnectionError.new
+        Rapns::DisconnectionError.should_receive(:new).and_return(error)
+        Rapns::Daemon.logger.should_receive(:error).with(error)
+        delivery_handler.send(:handle_next_notification)
+      end
+
+      it 'does not set the error code on the notification' do
+        @notification.should_receive(:error_code=).with(nil)
+        delivery_handler.send(:handle_next_notification)
+      end
+
+      it 'sets the error descriptipon on the notification' do
+        @notification.should_receive(:error_description=).with("APNs disconnected without returning an error.")
         delivery_handler.send(:handle_next_notification)
-      rescue Rapns::DeliveryError
       end
     end
   end
-end
-
-# describe Rapns::Daemon::Connection, "when receiving an error packet" do
-#   before do
-#     @notification = Rapns::Notification.create!(:device_token => "a" * 64)
-#     @notification.stub(:save!)
-#     @connection = Rapns::Daemon::Connection.new('Connection 0', 'gateway.push.apple.com', 2195)
-#     @ssl_socket = mock("SSLSocket", :write => nil, :flush => nil, :close => nil, :read => [8, 4, @notification.id].pack("ccN"))
-#     @connection.stub(:setup_ssl_context)
-#     @connection.stub(:connect_socket).and_return([@tcp_socket, @ssl_socket])
-#     IO.stub(:select).and_return([@ssl_socket, [], []])
-#     logger = mock("Logger", :error => nil, :warn => nil)
-#     Rapns::Daemon.stub(:logger).and_return(logger)
-#     @connection.connect
-#   end
-# 
-#   it "should raise a DeliveryError when an error is received" do
-#     expect { @connection.write("msg with an error") }.should raise_error(Rapns::DeliveryError)
-#   end
-# 
-
-# end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-11 00:00:00.000000000 Z
+date: 2011-12-12 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use library for Apple's Push Notification Service with Rails
   3
@@ -34,6 +34,7 @@ files:
 - lib/rapns/daemon/delivery_handler.rb
 - lib/rapns/daemon/delivery_handler_pool.rb
 - lib/rapns/daemon/delivery_queue.rb
+- lib/rapns/daemon/disconnection_error.rb
 - lib/rapns/daemon/feedback_receiver.rb
 - lib/rapns/daemon/feeder.rb
 - lib/rapns/daemon/interruptible_sleep.rb