rapns 0.2.3 → 1.0.0

data/spec/rapns/daemon/feedback_receiver_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe Rapns::Daemon::FeedbackReceiver, 'check_for_feedback' do
+  let(:connection) { stub(:connect => nil, :read => nil, :close => nil) }
+  let(:logger) { stub(:error => nil, :info => nil) }
+
+  before do
+    Rapns::Daemon::FeedbackReceiver.stub(:interruptible_sleep)
+    Rapns::Daemon.logger = logger
+    Rapns::Daemon::Connection.stub(:new => connection)
+    Rapns::Feedback.stub(:create!)
+    Rapns::Daemon.configuration = stub(:feedback => stub(:host => 'feedback.push.apple.com', :port => 2196, :poll => 60))
+    Rapns::Daemon::FeedbackReceiver.instance_variable_set("@stop", false)
+  end
+
+  def stub_connection_read_with_tuple
+    connection.unstub(:read)
+
+    def connection.read(bytes)
+      if !@called
+        @called = true
+        "N\xE3\x84\r\x00 \x83OxfU\xEB\x9F\x84aJ\x05\xAD}\x00\xAF1\xE5\xCF\xE9:\xC3\xEA\a\x8F\x1D\xA4M*N\xB0\xCE\x17"
+      end
+    end
+  end
+
+  it 'instantiates a new connection' do  
+    Rapns::Daemon::Connection.should_receive(:new).with("FeedbackReceiver", 'feedback.push.apple.com', 2196)
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'connects to the feeback service' do
+    connection.should_receive(:connect)
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'closes the connection' do
+    connection.should_receive(:close)
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'reads from the connection' do
+    connection.should_receive(:read).with(38)
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'logs the feedback' do
+    stub_connection_read_with_tuple
+    Rapns::Daemon.logger.should_receive(:info).with("[FeedbackReceiver] Delivery failed at 2011-12-10 16:08:45 UTC for 834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17")
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'creates the feedback' do
+    stub_connection_read_with_tuple
+    Rapns::Feedback.should_receive(:create!).with(:failed_at => Time.at(1323533325), :device_token => '834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17')
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'logs errors' do
+    error = StandardError.new('bork!')
+    connection.stub(:read).and_raise(error)
+    Rapns::Daemon.logger.should_receive(:error).with(error)
+    Rapns::Daemon::FeedbackReceiver.check_for_feedback
+  end
+
+  it 'sleeps for the feedback poll period' do
+    Rapns::Daemon::FeedbackReceiver.stub(:check_for_feedback)
+    Rapns::Daemon::FeedbackReceiver.should_receive(:interruptible_sleep).with(60).at_least(:once)
+    Thread.stub(:new).and_yield
+    Rapns::Daemon::FeedbackReceiver.stub(:loop).and_yield
+    Rapns::Daemon::FeedbackReceiver.start
+  end
+
+  it 'checks for feedback when started' do
+    Rapns::Daemon::FeedbackReceiver.should_receive(:check_for_feedback).at_least(:once)
+    Thread.stub(:new).and_yield
+    Rapns::Daemon::FeedbackReceiver.stub(:loop).and_yield
+    Rapns::Daemon::FeedbackReceiver.start
+  end
+
+  it 'interrupts sleep when stopped' do
+    Rapns::Daemon::FeedbackReceiver.stub(:check_for_feedback)
+    Rapns::Daemon::FeedbackReceiver.should_receive(:interrupt_sleep)
+    Rapns::Daemon::FeedbackReceiver.stop
+  end
+end

data/spec/rapns/daemon/feeder_spec.rb

@@ -3,12 +3,14 @@ require "spec_helper"
 describe Rapns::Daemon::Feeder do
   before do
     Rapns::Daemon::Feeder.stub(:sleep)
+    Rapns::Daemon::Feeder.stub(:interruptible_sleep)
     @notification = Rapns::Notification.create!(:device_token => "a" * 64)
     @logger = mock("Logger", :info => nil, :error => nil, :warn => nil)
     Rapns::Daemon.stub(:logger).and_return(@logger)
-    @queue = mock(:push => nil, :wait_for_available_handler => nil)
+    @queue = mock(:push => nil, :notifications_processed? => true)
     Rapns::Daemon.stub(:delivery_queue).and_return(@queue)
-    Rapns::Daemon.stub(:configuration => mock("Configuration", :poll => 2))
+    Rapns::Daemon.stub(:configuration => mock("Configuration", :push => stub(:poll => 2)))
+    Rapns::Daemon::Feeder.instance_variable_set("@stop", false)
   end
 
   it "should reconnect to the database when daemonized" do
@@ -59,13 +61,10 @@ describe Rapns::Daemon::Feeder do
     Rapns::Daemon::Feeder.enqueue_notifications
   end
 
-  it "should sleep for the given period" do
-    Rapns::Daemon::Feeder.should_receive(:sleep).with(2)
-    Rapns::Daemon::Feeder.enqueue_notifications
-  end
-
-  it "should wait for a delivery handler to become available" do
-    Rapns::Daemon.delivery_queue.should_receive(:wait_for_available_handler)
+  it "should not enqueue more notifications if other are still being processed" do
+    Rapns::Daemon.delivery_queue.stub(:notifications_processed? => false)
+    Rapns::Notification.should_not_receive(:ready_for_delivery)
+    Rapns::Daemon.delivery_queue.should_not_receive(:push)
     Rapns::Daemon::Feeder.enqueue_notifications
   end
 
@@ -76,6 +75,23 @@ describe Rapns::Daemon::Feeder do
     Rapns::Daemon::Feeder.enqueue_notifications
   end
 
+  it "interrupts sleep when stopped" do
+    Rapns::Daemon::Feeder.should_receive(:interrupt_sleep)
+    Rapns::Daemon::Feeder.stop
+  end
+
+  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(true)
+  end
+
+  it "should sleep for the given period" do
+    Rapns::Daemon::Feeder.should_receive(:interruptible_sleep).with(2)
+    Rapns::Daemon::Feeder.stub(:loop).and_yield
+    Rapns::Daemon::Feeder.start(true)
+  end
+
   context "when the database connection is lost" do
     let(:error) { adapter_error.new("db down!") }
     before do

data/spec/rapns/daemon/interruptible_sleep_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Rapns::Daemon::InterruptibleSleep do
+  class SleepTest
+    extend Rapns::Daemon::InterruptibleSleep
+  end
+
+  before do
+    IO.stub(:pipe)
+    IO.stub(:select)
+  end
+
+  it 'creates a new pipe' do
+    IO.should_receive(:pipe)
+    SleepTest.interruptible_sleep 1
+  end
+
+  it 'selects on the reader' do
+    rd = stub
+    IO.stub(:pipe => [rd, stub])
+    IO.should_receive(:select).with([rd], nil, nil, 1)
+    SleepTest.interruptible_sleep 1
+  end
+
+  it 'closes the writer' do
+    wr = stub
+    IO.stub(:pipe => [stub, wr])
+    SleepTest.interruptible_sleep 1
+    wr.should_receive(:close)
+    SleepTest.interrupt_sleep
+  end
+end

data/spec/rapns/daemon/logger_spec.rb

@@ -1,26 +1,26 @@
 require "spec_helper"
 
-describe Rapns::Daemon::Logger do
-  module Rails
-    def self.logger
-      @logger
-    end
+module Rails
+  def self.logger
+    @logger
+  end
 
-    def self.logger=(logger)
-      @logger = logger
-    end
+  def self.logger=(logger)
+    @logger = logger
   end
+end
 
-  module HoptoadNotifier
-    def self.notify(e)
-    end
+module HoptoadNotifier
+  def self.notify(e)
   end
+end
 
-  module Airbrake
-    def self.notify(e)
-    end
+module Airbrake
+  def self.notify(e)
   end
+end
 
+describe Rapns::Daemon::Logger do
   before do
     Rails.stub(:root).and_return("/rails_root")
     @buffered_logger = mock("BufferedLogger", :info => nil, :error => nil, :level => 0, :auto_flushing => 1, :auto_flushing= => nil)
@@ -81,6 +81,26 @@ describe Rapns::Daemon::Logger do
     logger.error(e)
   end
 
+  context "without Airbrake defined" do
+    before do
+      Object.send(:remove_const, :Airbrake)
+    end
+
+    after do
+      module Airbrake
+        def self.notify(e)
+        end
+      end
+    end
+
+    it "should notify using HoptoadNotifier" do
+      e = RuntimeError.new("hi mom")
+      logger = Rapns::Daemon::Logger.new(:foreground => false, :airbrake_notify => true)
+      HoptoadNotifier.should_receive(:notify).with(e)
+      logger.error(e)
+    end
+  end
+
   it "should not notify Airbrake of the exception if the airbrake_notify option is false" do
     e = RuntimeError.new("hi mom")
     logger = Rapns::Daemon::Logger.new(:foreground => false, :airbrake_notify => false)

data/spec/rapns/daemon_spec.rb

@@ -4,27 +4,43 @@ describe Rapns::Daemon, "when starting" do
   module Rails
   end
 
+  let(:config) do
+    {
+      "airbrake_notify" => true,
+      "certificate" => "development.pem",
+      "certificate_password" => "abc123",
+      "pid_file" => "rapns.pid",
+      "push" => {
+        "port" => 123,
+        "host" => "localhost",
+        "poll" => 4,
+        "connections" => 3
+      },
+      "feedback" => {
+        "port" => 123,
+        "host" => "localhost",
+        "poll" => 30,
+      }
+    }
+  end
+
   before do
     Rails.stub(:root).and_return("/rails_root")
 
     @configuration = Rapns::Daemon::Configuration.new("development", "/rails_root/config/rapns/rapns.yml")
-    @configuration.stub(:read_config).and_return({"development" => {"port" => 123, "host" => "localhost", "certificate" => "development.pem", "certificate_password" => "abc123", "pid_file" => "rapns.pid"}})
+    @configuration.stub(:read_config).and_return({"development" => config})
     Rapns::Daemon::Configuration.stub(:new).and_return(@configuration)
 
     @certificate = Rapns::Daemon::Certificate.new("/rails_root/config/rapns/development.pem")
     @certificate.stub(:read_certificate).and_return("certificate contents")
     Rapns::Daemon::Certificate.stub(:new).and_return(@certificate)
 
-    @connection_pool = Rapns::Daemon::ConnectionPool.new(3)
-    @connection_pool.stub(:populate)
-    Rapns::Daemon::ConnectionPool.stub(:new).and_return(@connection_pool)
-
     @handler_pool = Rapns::Daemon::DeliveryHandlerPool.new(3)
     @handler_pool.stub(:populate)
     Rapns::Daemon::DeliveryHandlerPool.stub(:new).and_return(@handler_pool)
 
+    Rapns::Daemon::FeedbackReceiver.stub(:start)
     Rapns::Daemon::Feeder.stub(:start)
-    Rapns::Daemon::Feeder.stub(:wait)
     Rapns::Daemon.stub(:daemonize)
     Rapns::Daemon.stub(:write_pid_file)
     @logger = mock("Logger", :info => nil)
@@ -54,22 +70,11 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon.certificate.should == @certificate
   end
 
-  it "should populate the connection pool" do
-    Rapns::Daemon::ConnectionPool.should_receive(:new).with(3).and_return(@connection_pool)
-    @connection_pool.should_receive(:populate)
-    Rapns::Daemon.start("development", {})
-  end
-
-  it "should initialize the delivery queue with the number of connection as its signal point" do
-    Rapns::Daemon::DeliveryQueue.should_receive(:new).with(3)
+  it "should initialize the delivery queue" do
+    Rapns::Daemon::DeliveryQueue.should_receive(:new)
     Rapns::Daemon.start("development", {})
   end
 
-  it "should make the connection pool accessible" do
-    Rapns::Daemon.start("development", {})
-    Rapns::Daemon.connection_pool.should == @connection_pool
-  end
-
   it "should populate the delivery handler pool" do
     Rapns::Daemon::DeliveryHandlerPool.should_receive(:new).with(3).and_return(@handler_pool)
     @handler_pool.should_receive(:populate)
@@ -97,6 +102,11 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon.start("development", {})
   end
 
+  it "should start the feedback receiver" do
+    Rapns::Daemon::FeedbackReceiver.should_receive(:start)
+    Rapns::Daemon.start("development", true)
+  end
+
   it "should start the feeder" do
     Rapns::Daemon::Feeder.should_receive(:start)
     Rapns::Daemon.start("development", true)
@@ -118,8 +128,7 @@ describe Rapns::Daemon, "when being shutdown" do
   before do
     Rails.stub(:root).and_return("/rails_root")
     Rapns::Daemon::Feeder.stub(:stop)
-    @connection_pool = mock("ConnectionPool", :drain => nil)
-    Rapns::Daemon.stub(:connection_pool).and_return(@connection_pool)
+    Rapns::Daemon::FeedbackReceiver.stub(:stop)
     @handler_pool = mock("DeliveryHandlerPool", :drain => nil)
     Rapns::Daemon.stub(:delivery_handler_pool).and_return(@handler_pool)
     @configuration = mock("Configuration", :pid_file => File.join(Rails.root, "rapns.pid"))
@@ -127,19 +136,13 @@ describe Rapns::Daemon, "when being shutdown" do
     Rapns::Daemon.stub(:puts)
   end
 
-  it "should stop the feeder" do
-    Rapns::Daemon::Feeder.should_receive(:stop)
+  it "should stop the feedback receiver" do
+    Rapns::Daemon::FeedbackReceiver.should_receive(:stop)
     Rapns::Daemon.send(:shutdown)
   end
 
-  it "should drain the connection pool" do
-    @connection_pool.should_receive(:drain)
-    Rapns::Daemon.send(:shutdown)
-  end
-
-  it "should not attempt to drain the connection pool if it has not been initialized" do
-    Rapns::Daemon.stub(:connection_pool).and_return(nil)
-    @connection_pool.should_not_receive(:drain)
+  it "should stop the feeder" do
+    Rapns::Daemon::Feeder.should_receive(:stop)
     Rapns::Daemon.send(:shutdown)
   end
 

data/spec/rapns/feedback_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Rapns::Feedback do
+  it { should validate_presence_of(:device_token) }
+  it { should validate_presence_of(:failed_at) }
+
+  it "should validate the format of the device_token" do
+    notification = Rapns::Feedback.new(:device_token => "{$%^&*()}")
+    notification.valid?.should be_false
+    notification.errors[:device_token].include?("is invalid").should be_true
+  end
+end

data/spec/rapns/notification_spec.rb

@@ -68,6 +68,11 @@ describe Rapns::Notification, "as_json" do
     notification.as_json["aps"].key?("alert").should be_false
   end
 
+  it "should encode the alert as JSON if it is a Hash" do
+    notification = Rapns::Notification.new(:alert => { 'body' => "hi mom", 'alert-loc-key' => "View" })
+    notification.as_json["aps"]["alert"].should == { 'body' => "hi mom", 'alert-loc-key' => "View" }
+  end
+
   it "should include the badge if present" do
     notification = Rapns::Notification.new(:badge => 6)
     notification.as_json["aps"]["badge"].should == 6

data/spec/spec_helper.rb

@@ -17,9 +17,12 @@ end
 puts "Using #{$adapter} adapter."
 ActiveRecord::Base.establish_connection('adapter' => $adapter, 'database' => 'rapns_test')
 require 'generators/templates/create_rapns_notifications'
+require 'generators/templates/create_rapns_feedback'
 
-CreateRapnsNotifications.down rescue ActiveRecord::StatementInvalid
-CreateRapnsNotifications.up
+[CreateRapnsNotifications, CreateRapnsFeedback].each do |migration|
+  migration.down rescue ActiveRecord::StatementInvalid
+  migration.up
+end
 
 require 'bundler'
 Bundler.require(:default)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000 Z
+date: 2011-12-11 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use library for Apple's Push Notification Service with Rails
   3
@@ -21,6 +21,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/generators/rapns_generator.rb
+- lib/generators/templates/create_rapns_feedback.rb
 - lib/generators/templates/create_rapns_notifications.rb
 - lib/generators/templates/rapns.yml
 - lib/rapns.rb
@@ -29,14 +30,17 @@ files:
 - lib/rapns/daemon/certificate.rb
 - lib/rapns/daemon/configuration.rb
 - lib/rapns/daemon/connection.rb
-- lib/rapns/daemon/connection_pool.rb
 - lib/rapns/daemon/delivery_error.rb
 - lib/rapns/daemon/delivery_handler.rb
 - lib/rapns/daemon/delivery_handler_pool.rb
 - lib/rapns/daemon/delivery_queue.rb
+- lib/rapns/daemon/feedback_receiver.rb
 - lib/rapns/daemon/feeder.rb
+- lib/rapns/daemon/interruptible_sleep.rb
 - lib/rapns/daemon/logger.rb
 - lib/rapns/daemon/pool.rb
+- lib/rapns/device_token_format_validator.rb
+- lib/rapns/feedback.rb
 - lib/rapns/notification.rb
 - lib/rapns/patches.rb
 - lib/rapns/patches/rails/3.1.0/postgresql_adapter.rb
@@ -45,14 +49,17 @@ files:
 - README.md
 - spec/rapns/daemon/certificate_spec.rb
 - spec/rapns/daemon/configuration_spec.rb
-- spec/rapns/daemon/connection_pool_spec.rb
 - spec/rapns/daemon/connection_spec.rb
 - spec/rapns/daemon/delivery_error_spec.rb
 - spec/rapns/daemon/delivery_handler_pool_spec.rb
 - spec/rapns/daemon/delivery_handler_spec.rb
+- spec/rapns/daemon/delivery_queue_spec.rb
+- spec/rapns/daemon/feedback_receiver_spec.rb
 - spec/rapns/daemon/feeder_spec.rb
+- spec/rapns/daemon/interruptible_sleep_spec.rb
 - spec/rapns/daemon/logger_spec.rb
 - spec/rapns/daemon_spec.rb
+- spec/rapns/feedback_spec.rb
 - spec/rapns/notification_spec.rb
 - spec/spec_helper.rb
 - bin/rapns
@@ -83,13 +90,17 @@ summary: Easy to use library for Apple's Push Notification Service with Rails 3
 test_files:
 - spec/rapns/daemon/certificate_spec.rb
 - spec/rapns/daemon/configuration_spec.rb
-- spec/rapns/daemon/connection_pool_spec.rb
 - spec/rapns/daemon/connection_spec.rb
 - spec/rapns/daemon/delivery_error_spec.rb
 - spec/rapns/daemon/delivery_handler_pool_spec.rb
 - spec/rapns/daemon/delivery_handler_spec.rb
+- spec/rapns/daemon/delivery_queue_spec.rb
+- spec/rapns/daemon/feedback_receiver_spec.rb
 - spec/rapns/daemon/feeder_spec.rb
+- spec/rapns/daemon/interruptible_sleep_spec.rb
 - spec/rapns/daemon/logger_spec.rb
 - spec/rapns/daemon_spec.rb
+- spec/rapns/feedback_spec.rb
 - spec/rapns/notification_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/rapns/daemon/connection_pool.rb

@@ -1,31 +0,0 @@
-module Rapns
-  module Daemon
-    class ConnectionPool < Pool
-
-      def claim_connection
-        connection = nil
-        begin
-          connection = @queue.pop
-          yield connection
-        ensure
-          @queue.push(connection) if connection
-        end
-        connection
-      end
-
-      protected
-
-      def new_object_for_pool(i)
-        Connection.new("Connection #{i}")
-      end
-
-      def object_added_to_pool(object)
-        object.connect
-      end
-
-      def object_removed_from_pool(object)
-        object.close
-      end
-    end
-  end
-end

data/spec/rapns/daemon/connection_pool_spec.rb

@@ -1,40 +0,0 @@
-require "spec_helper"
-
-describe Rapns::Daemon::ConnectionPool do
-  before do
-    @connection = mock("Connection", :connect => nil)
-    Rapns::Daemon::Connection.stub(:new).and_return(@connection)
-    @pool = Rapns::Daemon::ConnectionPool.new(3)
-  end
-
-  it "should populate the pool" do
-    Rapns::Daemon::Connection.should_receive(:new).exactly(3).times
-    @pool.populate
-  end
-
-  it "should tell each connection to close when drained" do
-    @pool.populate
-    @connection.should_receive(:close).exactly(3).times
-    @pool.drain
-  end
-end
-
-describe Rapns::Daemon::ConnectionPool, "when claiming a connection" do
-  before do
-    @connection = mock("Connection", :connect => nil)
-    Rapns::Daemon::Connection.stub(:new).and_return(@connection)
-    @pool = Rapns::Daemon::ConnectionPool.new(3)
-  end
-
-  it "should pop the connection from the pool" do
-    @pool.instance_variable_get("@queue").should_receive(:pop)
-    @pool.claim_connection {}
-  end
-
-  it "shuld push the connection into the pool after use" do
-    @pool.instance_variable_get("@queue").stub(:pop).and_return(@connection)
-    @pool.instance_variable_get("@queue").should_receive(:push).with(@connection)
-    @pool.claim_connection {}
-  end
-end
-