rapns 2.0.5 → 3.0.0.beta.1

data/spec/unit/daemon/apns/delivery_spec.rb

@@ -0,0 +1,154 @@
+require 'unit_spec_helper'
+
+describe Rapns::Daemon::Apns::Delivery do
+  let(:app) { stub(:name => 'MyApp') }
+  let(:notification) { stub.as_null_object }
+  let(:logger) { stub(:error => nil, :info => nil) }
+  let(:config) { stub(:check_for_errors => true) }
+  let(:connection) { stub(:select => false, :write => nil, :reconnect => nil, :close => nil, :connect => nil) }
+  let(:delivery) { Rapns::Daemon::Apns::Delivery.new(app, connection, notification) }
+
+  def perform
+    begin
+      delivery.perform
+    rescue Rapns::DeliveryError, Rapns::Apns::DisconnectionError
+    end
+  end
+
+  before do
+    Rapns::Daemon.stub(:logger => logger, :config => config)
+  end
+
+  it "sends the binary version of the notification" do
+    notification.stub(:to_binary => "hi mom")
+    connection.should_receive(:write).with("hi mom")
+    perform
+  end
+
+  it "logs the notification delivery" do
+    notification.stub(:id => 666, :device_token => 'abc123')
+    logger.should_receive(:info).with("[MyApp] 666 sent to abc123")
+    perform
+  end
+
+  it "marks the notification as delivered" do
+    notification.should_receive(:delivered=).with(true)
+    perform
+  end
+
+  it "sets the time the notification was delivered" do
+    now = Time.now
+    Time.stub(:now).and_return(now)
+    notification.should_receive(:delivered_at=).with(now)
+    perform
+  end
+
+  it "does not trigger validations when saving the notification" do
+    notification.should_receive(:save!).with(:validate => false)
+    perform
+  end
+
+  it "updates notification with the ability to reconnect the database" do
+    delivery.should_receive(:with_database_reconnect_and_retry)
+    perform
+  end
+
+  it 'does not check for errors if check_for_errors config option is false' do
+    config.stub(:check_for_errors => false)
+    delivery.should_not_receive(:check_for_error)
+    perform
+  end
+
+  describe "when delivery fails" do
+    before { connection.stub(:select => true, :read => [8, 4, 69].pack("ccN")) }
+
+    it "updates notification with the ability to reconnect the database" do
+      delivery.should_receive(:with_database_reconnect_and_retry)
+      perform
+    end
+
+    it "sets the notification as not delivered" do
+      notification.should_receive(:delivered=).with(false)
+      perform
+    end
+
+    it "sets the notification delivered_at timestamp to nil" do
+      notification.should_receive(:delivered_at=).with(nil)
+      perform
+    end
+
+    it "sets the notification as failed" do
+      notification.should_receive(:failed=).with(true)
+      perform
+    end
+
+    it "sets the notification failed_at timestamp" do
+      now = Time.now
+      Time.stub(:now).and_return(now)
+      notification.should_receive(:failed_at=).with(now)
+      perform
+    end
+
+    it "sets the notification error code" do
+      notification.should_receive(:error_code=).with(4)
+      perform
+    end
+
+    it "logs the delivery error" do
+      error = Rapns::DeliveryError.new(4, 12, "Missing payload")
+      Rapns::DeliveryError.stub(:new => error)
+      expect { delivery.perform }.to raise_error(error)
+    end
+
+    it "sets the notification error description" do
+      notification.should_receive(:error_description=).with("Missing payload")
+      perform
+    end
+
+    it "skips validation when saving the notification" do
+      notification.should_receive(:save!).with(:validate => false)
+      perform
+    end
+
+    it "reads 6 bytes from the socket" do
+      connection.should_receive(:read).with(6).and_return(nil)
+      perform
+    end
+
+    it "does not attempt to read from the socket if the socket was not selected for reading after the timeout" do
+      connection.stub(:select => nil)
+      connection.should_not_receive(:read)
+      perform
+    end
+
+    it "reconnects the socket" do
+      connection.should_receive(:reconnect)
+      perform
+    end
+
+    it "logs that the connection is being reconnected" do
+      Rapns::Daemon.logger.should_receive(:error).with("[MyApp] Error received, reconnecting...")
+      perform
+    end
+
+    context "when the APNs disconnects without returning an error" do
+      before do
+        connection.stub(:read => nil)
+      end
+
+      it 'raises a DisconnectError error if the connection is closed without an error being returned' do
+        expect { delivery.perform }.to raise_error(Rapns::Apns::DisconnectionError)
+      end
+
+      it 'does not set the error code on the notification' do
+        notification.should_receive(:error_code=).with(nil)
+        perform
+      end
+
+      it 'sets the error description on the notification' do
+        notification.should_receive(:error_description=).with("APNs disconnected without returning an error.")
+        perform
+      end
+    end
+  end
+end

data/spec/{rapns/daemon → unit/daemon/apns}/feedback_receiver_spec.rb

@@ -1,21 +1,21 @@
-require "spec_helper"
+require "unit_spec_helper"
 
-describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
+describe Rapns::Daemon::Apns::FeedbackReceiver, 'check_for_feedback' do
   let(:host) { 'feedback.push.apple.com' }
   let(:port) { 2196 }
   let(:poll) { 60 }
   let(:certificate) { stub }
   let(:password) { stub }
-  let(:app) { 'my_app' }
+  let(:app) { stub(:name => 'my_app', :password => password, :certificate => certificate) }
   let(:connection) { stub(:connect => nil, :read => nil, :close => nil) }
   let(:logger) { stub(:error => nil, :info => nil) }
-  let(:receiver) { Rapns::Daemon::FeedbackReceiver.new(app, host, port, poll, certificate, password) }
+  let(:receiver) { Rapns::Daemon::Apns::FeedbackReceiver.new(app, host, port, poll) }
 
   before do
     receiver.stub(:interruptible_sleep)
     Rapns::Daemon.logger = logger
-    Rapns::Daemon::Connection.stub(:new => connection)
-    Rapns::Feedback.stub(:create!)
+    Rapns::Daemon::Apns::Connection.stub(:new => connection)
+    Rapns::Apns::Feedback.stub(:create!)
     receiver.instance_variable_set("@stop", false)
   end
 
@@ -30,8 +30,8 @@ describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
     end
   end
 
-  it 'instantiates a new connection' do  
-    Rapns::Daemon::Connection.should_receive(:new).with("FeedbackReceiver:#{app}", host, port, certificate, password)
+  it 'instantiates a new connection' do
+    Rapns::Daemon::Apns::Connection.should_receive(:new).with("FeedbackReceiver:#{app.name}", host, port, certificate, password)
     receiver.check_for_feedback
   end
 
@@ -58,7 +58,7 @@ describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
 
   it 'creates the feedback' do
     stub_connection_read_with_tuple
-    Rapns::Feedback.should_receive(:create!).with(:failed_at => Time.at(1323533325), :device_token => '834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17', :app => 'my_app')
+    Rapns::Apns::Feedback.should_receive(:create!).with(:failed_at => Time.at(1323533325), :device_token => '834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17', :app => app)
     receiver.check_for_feedback
   end
 
@@ -66,7 +66,7 @@ describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
     error = StandardError.new('bork!')
     connection.stub(:read).and_raise(error)
     Rapns::Daemon.logger.should_receive(:error).with(error)
-    lambda { receiver.check_for_feedback }.should raise_error
+    receiver.check_for_feedback
   end
 
   it 'sleeps for the feedback poll period' do
@@ -92,10 +92,10 @@ describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
 
   it 'calls the configuration feedback_callback when feedback is received and the callback is set' do
     stub_connection_read_with_tuple
-    Rapns::configuration.feedback_callback = Proc.new {}
+    Rapns.configuration.feedback_callback = Proc.new {}
     feedback = Object.new
-    Rapns::Feedback.stub(:create! => feedback)
-    Rapns::configuration.feedback_callback.should_receive(:call).with(feedback)
+    Rapns::Apns::Feedback.stub(:create! => feedback)
+    Rapns.configuration.feedback_callback.should_receive(:call).with(feedback)
     receiver.check_for_feedback
   end
 
@@ -115,4 +115,4 @@ describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
     Rapns::configuration.feedback_callback = callback
     receiver.check_for_feedback
   end
-end
+end

data/spec/unit/daemon/app_runner_shared.rb

@@ -0,0 +1,66 @@
+shared_examples_for "an AppRunner subclass" do
+  let(:queue) { stub(:notifications_processed? => true, :push => nil) }
+
+  before { Rapns::Daemon::DeliveryQueue.stub(:new => queue) }
+  after { Rapns::Daemon::AppRunner.runners.clear }
+
+  describe 'start' do
+    it 'starts a delivery handler for each connection' do
+      handler.should_receive(:start)
+      runner.start
+    end
+
+    it 'assigns the queue to the handler' do
+      handler.should_receive(:queue=).with(queue)
+      runner.start
+    end
+  end
+
+  describe 'enqueue' do
+    let(:notification) { stub }
+
+    it 'enqueues the notification' do
+      queue.should_receive(:push).with(notification)
+      runner.enqueue(notification)
+    end
+  end
+
+  describe 'stop' do
+    before { runner.start }
+
+    it 'stops the delivery handlers' do
+      handler.should_receive(:stop)
+      runner.stop
+    end
+  end
+
+  describe 'idle?' do
+    it 'is idle if all notifications have been processed' do
+      queue.stub(:notifications_processed? => true)
+      runner.idle?.should be_true
+    end
+
+    it 'is not idle if not all notifications have been processed' do
+      queue.stub(:notifications_processed? => false)
+      runner.idle?.should be_false
+    end
+  end
+
+  describe 'sync' do
+    before { runner.start }
+
+    it 'reduces the number of handlers if needed' do
+      handler.should_receive(:stop)
+      new_app = app_class.new
+      new_app.stub(:connections => app.connections - 1)
+      runner.sync(new_app)
+    end
+
+    it 'increases the number of handlers if needed' do
+      runner.should_receive(:start_handler).and_return(handler)
+      new_app = app_class.new
+      new_app.stub(:connections => app.connections + 1)
+      runner.sync(new_app)
+    end
+  end
+end

data/spec/unit/daemon/app_runner_spec.rb

@@ -0,0 +1,78 @@
+require 'unit_spec_helper'
+
+describe Rapns::Daemon::AppRunner, 'stop' do
+  let(:runner) { stub }
+  before { Rapns::Daemon::AppRunner.runners['app'] = runner }
+  after { Rapns::Daemon::AppRunner.runners.clear }
+
+  it 'stops all runners' do
+    runner.should_receive(:stop)
+    Rapns::Daemon::AppRunner.stop
+  end
+end
+
+describe Rapns::Daemon::AppRunner, 'deliver' do
+  let(:runner) { stub }
+  let(:notification) { stub(:app_id => 1) }
+  let(:logger) { stub(:error => nil) }
+
+  before do
+    Rapns::Daemon.stub(:logger => logger)
+    Rapns::Daemon::AppRunner.runners[1] = runner
+  end
+
+  after { Rapns::Daemon::AppRunner.runners.clear }
+
+  it 'enqueues the notification' do
+    runner.should_receive(:enqueue).with(notification)
+    Rapns::Daemon::AppRunner.enqueue(notification)
+  end
+
+  it 'logs an error if there is no runner to deliver the notification' do
+    notification.stub(:app_id => 2, :id => 123)
+    logger.should_receive(:error).with("No such app '#{notification.app_id}' for notification #{notification.id}.")
+    Rapns::Daemon::AppRunner.enqueue(notification)
+  end
+end
+
+describe Rapns::Daemon::AppRunner, 'sync' do
+  let(:app) { Rapns::Apns::App.new }
+  let(:new_app) { Rapns::Apns::App.new }
+  let(:runner) { stub(:sync => nil, :stop => nil, :start => nil) }
+  let(:logger) { stub(:error => nil) }
+  let(:queue) { Rapns::Daemon::DeliveryQueue.new }
+
+  before do
+    app.stub(:id => 1)
+    new_app.stub(:id => 2)
+    Rapns::Daemon::DeliveryQueue.stub(:new => queue)
+    Rapns::Daemon::AppRunner.runners[app.id] = runner
+    Rapns::App.stub(:all => [app])
+  end
+
+  after { Rapns::Daemon::AppRunner.runners.clear }
+
+  it 'loads all apps' do
+    Rapns::App.should_receive(:all)
+    Rapns::Daemon::AppRunner.sync
+  end
+
+  it 'instructs existing runners to sync' do
+    runner.should_receive(:sync).with(app)
+    Rapns::Daemon::AppRunner.sync
+  end
+
+  it 'starts a runner for a new app' do
+    Rapns::App.stub(:all => [app, new_app])
+    new_runner = stub
+    Rapns::Daemon::Apns::AppRunner.should_receive(:new).with(new_app).and_return(new_runner)
+    new_runner.should_receive(:start)
+    Rapns::Daemon::AppRunner.sync
+  end
+
+  it 'deletes old apps' do
+    Rapns::App.stub(:all => [])
+    runner.should_receive(:stop)
+    Rapns::Daemon::AppRunner.sync
+  end
+end

data/spec/{rapns → unit}/daemon/database_reconnectable_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "unit_spec_helper"
 
 describe Rapns::Daemon::DatabaseReconnectable do
   class TestDouble
@@ -7,7 +7,6 @@ describe Rapns::Daemon::DatabaseReconnectable do
     attr_reader :name
 
     def initialize(error, max_calls)
-      @name = 'TestDouble'
       @error = error
       @max_calls = max_calls
       @calls = 0
@@ -53,12 +52,12 @@ describe Rapns::Daemon::DatabaseReconnectable do
   end
 
   it "should log that the database is being reconnected" do
-    Rapns::Daemon.logger.should_receive(:warn).with("[TestDouble] Lost connection to database, reconnecting...")
+    Rapns::Daemon.logger.should_receive(:warn).with("Lost connection to database, reconnecting...")
     test_double.perform
   end
 
   it "should log the reconnection attempt" do
-    Rapns::Daemon.logger.should_receive(:warn).with("[TestDouble] Attempt 1")
+    Rapns::Daemon.logger.should_receive(:warn).with("Attempt 1")
     test_double.perform
   end
 
@@ -91,7 +90,7 @@ describe Rapns::Daemon::DatabaseReconnectable do
     end
 
     it "should log the 2nd attempt" do
-      Rapns::Daemon.logger.should_receive(:warn).with("[TestDouble] Attempt 2")
+      Rapns::Daemon.logger.should_receive(:warn).with("Attempt 2")
       test_double.perform
     end
 

data/spec/{rapns → unit}/daemon/delivery_error_spec.rb

@@ -1,10 +1,10 @@
-require "spec_helper"
+require "unit_spec_helper"
 
 describe Rapns::DeliveryError do
   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)"
+    error.message.should == "Unable to deliver notification 12, received error 4 (Missing payload)"
   end
 
   it "returns the error code" do

data/spec/unit/daemon/delivery_handler_shared.rb

@@ -0,0 +1,19 @@
+shared_examples_for 'an DeliveryHandler subclass' do
+  it "instructs the queue to wakeup the thread when told to stop" do
+    thread = stub(:join => nil)
+    Thread.stub(:new => thread)
+    queue.should_receive(:wakeup).with(thread)
+    delivery_handler.start
+    delivery_handler.stop
+  end
+
+  describe "when being stopped" do
+    before { queue.pop }
+
+    it "does not attempt to deliver a notification when a DeliveryQueue::::WakeupError is raised" do
+      queue.stub(:pop).and_raise(Rapns::Daemon::DeliveryQueue::WakeupError)
+      delivery_handler.should_not_receive(:deliver)
+      delivery_handler.send(:handle_next_notification)
+    end
+  end
+end

data/spec/{rapns → unit}/daemon/delivery_queue_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "unit_spec_helper"
 
 describe Rapns::Daemon::DeliveryQueue do
   let(:queue) { Rapns::Daemon::DeliveryQueue.new }

data/spec/{rapns → unit}/daemon/feeder_spec.rb

@@ -1,79 +1,79 @@
-require "spec_helper"
+require "unit_spec_helper"
 
 describe Rapns::Daemon::Feeder do
-  let(:poll) { 2 }
   let(:config) { stub(:batch_size => 5000) }
-  let(:notification) { Rapns::Notification.create!(:device_token => "a" * 64, :app => 'my_app') }
+  let!(:app) { Rapns::Apns::App.create!(:name => 'my_app', :environment => 'development', :certificate => TEST_CERT) }
+  let(:notification) { Rapns::Apns::Notification.create!(:device_token => "a" * 64, :app => app) }
   let(:logger) { stub }
 
   before do
-    Rapns::Daemon::Feeder.stub(:sleep)
-    Rapns::Daemon::Feeder.stub(:interruptible_sleep)
     Rapns::Daemon.stub(:logger => logger, :config => config)
-    Rapns::Daemon::Feeder.instance_variable_set("@stop", false)
-    Rapns::Daemon::AppRunner.stub(:ready => ['my_app'])
-    Rapns::Daemon::AppRunner.stub(:ready => ['my_app'])
+    Rapns::Daemon::Feeder.instance_variable_set("@stop", true)
+    Rapns::Daemon::AppRunner.stub(:idle => [stub(:app => app)])
+  end
+
+  def start
+    Rapns::Daemon::Feeder.start(0)
   end
 
   it "checks for new notifications with the ability to reconnect the database" do
     Rapns::Daemon::Feeder.should_receive(:with_database_reconnect_and_retry)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    start
   end
 
   it 'loads notifications in batches' do
-    relation = stub
-    relation.should_receive(:find_each).with(:batch_size => 5000)
+    relation = stub.as_null_object
+    relation.should_receive(:limit).with(5000)
     Rapns::Notification.stub(:ready_for_delivery => relation)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    start
   end
 
-  it "delivers the notification" do
+  it "enqueue the notification" do
     notification.update_attributes!(:delivered => false)
-    Rapns::Daemon::AppRunner.should_receive(:deliver).with(notification)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_receive(:enqueue).with(notification)
+    start
   end
 
   it 'does not enqueue the notification if the app runner is still processing the previous batch' do
-    Rapns::Daemon::AppRunner.stub(:ready => [])
-    Rapns::Daemon::AppRunner.should_not_receive(:deliver)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_not_receive(:enqueue)
+    start
   end
 
   it "enqueues an undelivered notification without deliver_after set" do
     notification.update_attributes!(:delivered => false, :deliver_after => nil)
-    Rapns::Daemon::AppRunner.should_receive(:deliver).with(notification)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_receive(:enqueue).with(notification)
+    start
   end
 
   it "enqueues a notification with a deliver_after time in the past" do
     notification.update_attributes!(:delivered => false, :deliver_after => 1.hour.ago)
-    Rapns::Daemon::AppRunner.should_receive(:deliver).with(notification)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_receive(:enqueue).with(notification)
+    start
   end
 
   it "does not enqueue a notification with a deliver_after time in the future" do
     notification.update_attributes!(:delivered => false, :deliver_after => 1.hour.from_now)
-    Rapns::Daemon::AppRunner.should_not_receive(:deliver)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_not_receive(:enqueue)
+    start
   end
 
   it "does not enqueue a previously delivered notification" do
     notification.update_attributes!(:delivered => true, :delivered_at => Time.now)
-    Rapns::Daemon::AppRunner.should_not_receive(:deliver)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_not_receive(:enqueue)
+    start
   end
 
   it "does not enqueue a notification that has previously failed delivery" do
     notification.update_attributes!(:delivered => false, :failed => true)
-    Rapns::Daemon::AppRunner.should_not_receive(:deliver)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    Rapns::Daemon::AppRunner.should_not_receive(:enqueue)
+    start
   end
 
   it "logs errors" do
     e = StandardError.new("bork")
     Rapns::Notification.stub(:ready_for_delivery).and_raise(e)
     Rapns::Daemon.logger.should_receive(:error).with(e)
-    Rapns::Daemon::Feeder.enqueue_notifications
+    start
   end
 
   it "interrupts sleep when stopped" do
@@ -84,12 +84,12 @@ describe Rapns::Daemon::Feeder do
   it "enqueues notifications when started" do
     Rapns::Daemon::Feeder.should_receive(:enqueue_notifications).at_least(:once)
     Rapns::Daemon::Feeder.stub(:loop).and_yield
-    Rapns::Daemon::Feeder.start(poll)
+    start
   end
 
   it "sleeps for the given period" do
-    Rapns::Daemon::Feeder.should_receive(:interruptible_sleep).with(poll)
+    Rapns::Daemon::Feeder.should_receive(:interruptible_sleep).with(2)
     Rapns::Daemon::Feeder.stub(:loop).and_yield
-    Rapns::Daemon::Feeder.start(poll)
+    Rapns::Daemon::Feeder.start(2)
   end
-end
+end

data/spec/unit/daemon/gcm/app_runner_spec.rb

@@ -0,0 +1,15 @@
+require 'unit_spec_helper'
+require File.dirname(__FILE__) + '/../app_runner_shared.rb'
+
+describe Rapns::Daemon::Gcm::AppRunner do
+  it_behaves_like 'an AppRunner subclass'
+
+  let(:app_class) { Rapns::Gcm::App }
+  let(:app) { app_class.new }
+  let(:runner) { Rapns::Daemon::Gcm::AppRunner.new(app) }
+  let(:handler) { stub(:start => nil, :stop => nil, :queue= => nil) }
+
+  before do
+    Rapns::Daemon::Gcm::DeliveryHandler.stub(:new => handler)
+  end
+end

data/spec/unit/daemon/gcm/delivery_handler_spec.rb

@@ -0,0 +1,36 @@
+require "unit_spec_helper"
+require File.dirname(__FILE__) + '/../delivery_handler_shared.rb'
+
+describe Rapns::Daemon::Gcm::DeliveryHandler do
+  it_should_behave_like 'an DeliveryHandler subclass'
+
+  let(:app) { stub }
+  let(:delivery_handler) { Rapns::Daemon::Gcm::DeliveryHandler.new(app) }
+  let(:notification) { stub }
+  let(:http) { stub(:shutdown => nil)}
+  let(:queue) { Rapns::Daemon::DeliveryQueue.new }
+
+  before do
+    Net::HTTP::Persistent.stub(:new => http)
+    Rapns::Daemon::Gcm::Delivery.stub(:perform)
+    delivery_handler.queue = queue
+    queue.push(notification)
+  end
+
+  it 'performs delivery of an notification' do
+    Rapns::Daemon::Gcm::Delivery.should_receive(:perform).with(app, http, notification)
+    delivery_handler.start
+    delivery_handler.stop
+  end
+
+  it 'initiates a persistent connection object' do
+    Net::HTTP::Persistent.should_receive(:new).with('rapns')
+    Rapns::Daemon::Gcm::DeliveryHandler.new(app)
+  end
+
+  it 'shuts down the http connection stopped' do
+    http.should_receive(:shutdown)
+    delivery_handler.start
+    delivery_handler.stop
+  end
+end