rapns_rails_2 3.4.3

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

@@ -0,0 +1,287 @@
+require File.expand_path("spec/unit_spec_helper")
+
+describe Rapns::Daemon::Apns::Connection do
+  let(:rsa_key) { double }
+  let(:certificate) { double }
+  let(:password) { double }
+  let(:x509_certificate) { OpenSSL::X509::Certificate.new(TEST_CERT) }
+  let(:ssl_context) { double(:key= => nil, :cert= => nil, :cert => x509_certificate) }
+  let(:host) { 'gateway.push.apple.com' }
+  let(:port) { '2195' }
+  let(:tcp_socket) { double(:setsockopt => nil, :close => nil) }
+  let(:ssl_socket) { double(:sync= => nil, :connect => nil, :close => nil, :write => nil, :flush => nil) }
+  let(:logger) { double(:info => nil, :error => nil, :warn => nil) }
+  let(:app) { double(:name => 'Connection 0', :certificate => certificate, :password => password)}
+  let(:connection) { Rapns::Daemon::Apns::Connection.new(app, host, port) }
+
+  before do
+    OpenSSL::SSL::SSLContext.stub(:new => ssl_context)
+    OpenSSL::PKey::RSA.stub(:new => rsa_key)
+    OpenSSL::X509::Certificate.stub(:new => x509_certificate)
+    TCPSocket.stub(:new => tcp_socket)
+    OpenSSL::SSL::SSLSocket.stub(:new => ssl_socket)
+    Rapns.stub(:logger => logger)
+    connection.stub(:reflect)
+  end
+
+  it "reads the number of bytes from the SSL socket" do
+    ssl_socket.should_receive(:read).with(123)
+    connection.connect
+    connection.read(123)
+  end
+
+  it "selects on the SSL socket until the given timeout" do
+    IO.should_receive(:select).with([ssl_socket], nil, nil, 10)
+    connection.connect
+    connection.select(10)
+  end
+
+  describe "when setting up the SSL context" do
+    it "sets the key on the context" do
+      OpenSSL::PKey::RSA.should_receive(:new).with(certificate, password).and_return(rsa_key)
+      ssl_context.should_receive(:key=).with(rsa_key)
+      connection.connect
+    end
+
+    it "sets the cert on the context" do
+      OpenSSL::X509::Certificate.should_receive(:new).with(certificate).and_return(x509_certificate)
+      ssl_context.should_receive(:cert=).with(x509_certificate)
+      connection.connect
+    end
+  end
+
+  describe "when connecting the socket" do
+    it "creates a TCP socket using the configured host and port" do
+      TCPSocket.should_receive(:new).with(host, port).and_return(tcp_socket)
+      connection.connect
+    end
+
+    it "creates a new SSL socket using the TCP socket and SSL context" do
+      OpenSSL::SSL::SSLSocket.should_receive(:new).with(tcp_socket, ssl_context).and_return(ssl_socket)
+      connection.connect
+    end
+
+    it "sets the sync option on the SSL socket" do
+      ssl_socket.should_receive(:sync=).with(true)
+      connection.connect
+    end
+
+    it "connects the SSL socket" do
+      ssl_socket.should_receive(:connect)
+      connection.connect
+    end
+
+    it "sets the socket option TCP_NODELAY" do
+      tcp_socket.should_receive(:setsockopt).with(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+      connection.connect
+    end
+
+    it "sets the socket option SO_KEEPALIVE" do
+      tcp_socket.should_receive(:setsockopt).with(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
+      connection.connect
+    end
+
+    describe 'certificate expiry' do
+      it 'reflects if the certificate will expire soon' do
+        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        connection.should_receive(:reflect).with(:apns_certificate_will_expire, app, cert.not_after)
+        Timecop.freeze(cert.not_after.to_datetime - 3.days) { connection.connect }
+      end
+
+      it 'logs that the certificate will expire soon' do
+        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        logger.should_receive(:warn).with("[#{app.name}] Certificate will expire at 2022-09-07 03:18:32 UTC.")
+        Timecop.freeze(cert.not_after.to_datetime - 3.days) { connection.connect }
+      end
+
+      it 'does not reflect if the certificate will not expire soon' do
+        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        connection.should_not_receive(:reflect).with(:apns_certificate_will_expire, app, kind_of(Time))
+        Timecop.freeze(cert.not_after.to_datetime - 2.months) { connection.connect }
+      end
+
+      it 'logs that the certificate has expired' do
+        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        logger.should_receive(:error).with("[#{app.name}] Certificate expired at 2022-09-07 03:18:32 UTC.")
+        Timecop.freeze(cert.not_after.to_datetime + 1.day) { connection.connect rescue Rapns::Apns::CertificateExpiredError }
+      end
+
+      it 'raises an error if the certificate has expired' do
+        cert = OpenSSL::X509::Certificate.new(app.certificate)
+        Timecop.freeze(cert.not_after.to_datetime + 1.day) do
+          expect { connection.connect }.to raise_error(Rapns::Apns::CertificateExpiredError)
+        end
+      end
+    end
+  end
+
+  describe "when shuting down the connection" do
+    it "closes the TCP socket" do
+      connection.connect
+      tcp_socket.should_receive(:close)
+      connection.close
+    end
+
+    it "does not attempt to close the TCP socket if it is not connected" do
+      connection.connect
+      tcp_socket.should_not_receive(:close)
+      connection.instance_variable_set("@tcp_socket", nil)
+      connection.close
+    end
+
+    it "closes the SSL socket" do
+      connection.connect
+      ssl_socket.should_receive(:close)
+      connection.close
+    end
+
+    it "does not attempt to close the SSL socket if it is not connected" do
+      connection.connect
+      ssl_socket.should_not_receive(:close)
+      connection.instance_variable_set("@ssl_socket", nil)
+      connection.close
+    end
+
+    it "ignores IOError when the socket is already closed" do
+      tcp_socket.stub(:close).and_raise(IOError)
+      connection.connect
+      connection.close
+    end
+  end
+
+  shared_examples_for "when the write fails" do
+    before do
+      connection.stub(:sleep)
+      connection.connect
+      ssl_socket.stub(:write).and_raise(error_type)
+    end
+
+    it 'reflects the connection has been lost' do
+      connection.should_receive(:reflect).with(:apns_connection_lost, app, kind_of(error_type))
+      begin
+        connection.write(nil)
+      rescue Rapns::Daemon::Apns::ConnectionError
+      end
+    end
+
+    it "logs that the connection has been lost once only" do
+      logger.should_receive(:error).with("[Connection 0] Lost connection to gateway.push.apple.com:2195 (#{error_type.name}), reconnecting...").once
+      begin
+        connection.write(nil)
+      rescue Rapns::Daemon::Apns::ConnectionError
+      end
+    end
+
+    it "retries to make a connection 3 times" do
+      connection.should_receive(:reconnect).exactly(3).times
+      begin
+        connection.write(nil)
+      rescue Rapns::Daemon::Apns::ConnectionError
+      end
+    end
+
+    it "raises a ConnectionError after 3 attempts at reconnecting" do
+      expect do
+        connection.write(nil)
+      end.to raise_error(Rapns::Daemon::Apns::ConnectionError, "Connection 0 tried 3 times to reconnect but failed (#{error_type.name}).")
+    end
+
+    it "sleeps 1 second before retrying the connection" do
+      connection.should_receive(:sleep).with(1)
+      begin
+        connection.write(nil)
+      rescue Rapns::Daemon::Apns::ConnectionError
+      end
+    end
+  end
+
+  describe "when write raises an Errno::EPIPE" do
+    it_should_behave_like "when the write fails"
+
+    def error_type
+      Errno::EPIPE
+    end
+  end
+
+  describe "when write raises an Errno::ETIMEDOUT" do
+    it_should_behave_like "when the write fails"
+
+    def error_type
+      Errno::ETIMEDOUT
+    end
+  end
+
+  describe "when write raises an OpenSSL::SSL::SSLError" do
+    it_should_behave_like "when the write fails"
+
+    def error_type
+      OpenSSL::SSL::SSLError
+    end
+  end
+
+  describe "when write raises an IOError" do
+    it_should_behave_like "when the write fails"
+
+    def error_type
+      IOError
+    end
+  end
+
+  describe "when reconnecting" do
+    before { connection.connect }
+
+    it 'closes the socket' do
+      connection.should_receive(:close)
+      connection.send(:reconnect)
+    end
+
+    it 'connects the socket' do
+      connection.should_receive(:connect_socket)
+      connection.send(:reconnect)
+    end
+  end
+
+  describe "when sending a notification" do
+    before { connection.connect }
+
+    it "writes the data to the SSL socket" do
+      ssl_socket.should_receive(:write).with("blah")
+      connection.write("blah")
+    end
+
+    it "flushes the SSL socket" do
+      ssl_socket.should_receive(:flush)
+      connection.write("blah")
+    end
+  end
+
+  describe 'idle period' do
+    before { connection.connect }
+
+    it 'reconnects if the connection has been idle for more than the defined period' do
+      Rapns::Daemon::Apns::Connection.stub(:idle_period => 0.1)
+      sleep 0.2
+      connection.should_receive(:reconnect)
+      connection.write('blah')
+    end
+
+    it 'resets the last write time' do
+      now = Time.now
+      Time.stub(:now => now)
+      connection.write('blah')
+      connection.last_write.should == now
+    end
+
+    it 'does not reconnect if the connection has not been idle for more than the defined period' do
+      connection.should_not_receive(:reconnect)
+      connection.write('blah')
+    end
+
+    it 'logs the the connection is idle' do
+      Rapns::Daemon::Apns::Connection.stub(:idle_period => 0.1)
+      sleep 0.2
+      Rapns.logger.should_receive(:info).with('[Connection 0] Idle period exceeded, reconnecting...')
+      connection.write('blah')
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require File.expand_path("spec/unit_spec_helper")
+require File.dirname(__FILE__) + '/../delivery_handler_shared.rb'
+
+describe Rapns::Daemon::Apns::DeliveryHandler do
+  it_should_behave_like 'an DeliveryHandler subclass'
+
+  let(:host) { 'gateway.push.apple.com' }
+  let(:port) { 2195 }
+  let(:certificate) { double }
+  let(:password) { double }
+  let(:app) { double(:password => password, :certificate => certificate, :name => 'MyApp', :environment => 'production')}
+  let(:delivery_handler) { Rapns::Daemon::Apns::DeliveryHandler.new(app) }
+  let(:connection) { double(:connection, :select => false, :write => nil, :reconnect => nil, :close => nil, :connect => nil) }
+  let(:notification) { double(:notification) }
+  let(:batch) { double(:batch, :notification_processed => nil) }
+  let(:http) { double(:http, :shutdown => nil)}
+  let(:queue) { Queue.new }
+  let(:delivery) { double(:perform => nil) }
+
+  before do
+    Rapns::Daemon::Apns::Connection.stub(:new => connection)
+    Rapns::Daemon::Apns::Delivery.stub(:new => delivery)
+    delivery_handler.queue = queue
+    queue.push([notification, batch])
+  end
+
+  def run_delivery_handler
+    delivery_handler.start
+    delivery_handler.stop
+    delivery_handler.wakeup
+    delivery_handler.wait
+  end
+
+  it "instantiates a new connection" do
+    Rapns::Daemon::Apns::Connection.should_receive(:new).with(app, host, port)
+    run_delivery_handler
+  end
+
+  it "connects the socket" do
+    connection.should_receive(:connect)
+    run_delivery_handler
+  end
+
+  it 'performs delivery of an notification' do
+    Rapns::Daemon::Apns::Delivery.should_receive(:new).with(app, connection, notification, batch).and_return(delivery)
+    delivery.should_receive(:perform)
+    run_delivery_handler
+  end
+
+  it 'closes the connection stopped' do
+    connection.should_receive(:close)
+    run_delivery_handler
+  end
+
+  it 'does not attempt to close the connection if the connection was not established' do
+    connection.should_not_receive(:close)
+    delivery_handler.stop
+  end
+end

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

@@ -0,0 +1,101 @@
+require File.expand_path("spec/unit_spec_helper")
+
+describe Rapns::Daemon::Apns::Delivery do
+  let(:app) { double(:name => 'MyApp') }
+  let(:notification) { double(:id => 123).as_null_object }
+  let(:batch) { double(:mark_failed => nil, :mark_delivered => nil) }
+  let(:logger) { double(:error => nil, :info => nil) }
+  let(:config) { double(:check_for_errors => true) }
+  let(:connection) { double(:select => false, :write => nil, :reconnect => nil, :close => nil, :connect => nil) }
+  let(:delivery) { Rapns::Daemon::Apns::Delivery.new(app, connection, notification, batch) }
+
+  def perform
+    begin
+      delivery.perform
+    rescue Rapns::DeliveryError, Rapns::Apns::DisconnectionError
+    end
+  end
+
+  before do
+    Rapns.stub(:config => config, :logger => logger)
+  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
+    batch.should_receive(:mark_delivered).with(notification)
+    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 "marks the notification as failed" do
+      batch.should_receive(:mark_failed).with(notification, 4, "Missing payload")
+      perform
+    end
+
+    it "logs the delivery error" do
+      # checking for the doublebed error doesn't work in jruby, but checking
+      # for the exception by class does.
+
+      #error = Rapns::DeliveryError.new(4, 12, "Missing payload")
+      #Rapns::DeliveryError.stub(:new => error)
+      #expect { delivery.perform }.to raise_error(error)
+
+      expect { delivery.perform }.to raise_error(Rapns::DeliveryError)
+    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.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 'marks the notification as failed' do
+        batch.should_receive(:mark_failed).with(notification, nil, "APNs disconnected without returning an error.")
+        perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require File.expand_path("spec/unit_spec_helper")
+
+describe Rapns::Apns::DisconnectionError do
+  let(:error) { Rapns::Apns::DisconnectionError.new }
+
+  it 'returns a nil error code' do
+    error.code.should be_nil
+  end
+
+  it 'contains an error description' do
+    error.description
+  end
+
+  it 'returns a message' do
+    error.message
+    error.to_s
+  end
+end

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

@@ -0,0 +1,134 @@
+require File.expand_path("spec/unit_spec_helper")
+
+describe Rapns::Daemon::Apns::FeedbackReceiver, 'check_for_feedback' do
+
+  let(:host) { 'feedback.push.apple.com' }
+  let(:port) { 2196 }
+  let(:poll) { 60 }
+  let(:certificate) { double }
+  let(:password) { double }
+  let(:app) { double(:name => 'my_app', :password => password, :certificate => certificate, :environment => 'production') }
+  let(:connection) { double(:connect => nil, :read => nil, :close => nil) }
+  let(:logger) { double(:error => nil, :info => nil) }
+  let(:receiver) { Rapns::Daemon::Apns::FeedbackReceiver.new(app, poll) }
+  let(:feedback) { double }
+
+  before do
+    receiver.stub(:interruptible_sleep)
+    Rapns.stub(:logger => logger)
+    Rapns::Daemon::Apns::Connection.stub(:new => connection)
+    receiver.instance_variable_set("@stop", false)
+    Rapns::Daemon.stub(:store => double(:create_apns_feedback => feedback))
+  end
+
+  def double_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::Apns::Connection.should_receive(:new).with(app, host, port)
+    receiver.check_for_feedback
+  end
+
+  it 'connects to the feeback service' do
+    connection.should_receive(:connect)
+    receiver.check_for_feedback
+  end
+
+  it 'closes the connection' do
+    connection.should_receive(:close)
+    receiver.check_for_feedback
+  end
+
+  it 'reads from the connection' do
+    connection.should_receive(:read).with(38)
+    receiver.check_for_feedback
+  end
+
+  it 'logs the feedback' do
+    double_connection_read_with_tuple
+    Rapns.logger.should_receive(:info).with("[my_app] [FeedbackReceiver] Delivery failed at 2011-12-10 16:08:45 UTC for 834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17.")
+    receiver.check_for_feedback
+  end
+
+  it 'creates the feedback' do
+    Rapns::Daemon.store.should_receive(:create_apns_feedback).with(Time.at(1323533325), '834f786655eb9f84614a05ad7d00af31e5cfe93ac3ea078f1da44d2a4eb0ce17', app)
+    double_connection_read_with_tuple
+    receiver.check_for_feedback
+  end
+
+  it 'logs errors' do
+    error = StandardError.new('bork!')
+    connection.stub(:read).and_raise(error)
+    Rapns.logger.should_receive(:error).with(error)
+    receiver.check_for_feedback
+  end
+
+  it 'sleeps for the feedback poll period' do
+    receiver.stub(:check_for_feedback)
+    sleeper = double(Rapns::Daemon::InterruptibleSleep, :sleep => false)
+    sleeper.should_receive(:sleep).with(60).at_least(:once)
+    receiver.stub :interruptible_sleep => sleeper
+    Thread.stub(:new).and_yield
+    receiver.stub(:loop).and_yield
+    receiver.start
+  end
+
+  it 'checks for feedback when started' do
+    sleeper = double(Rapns::Daemon::InterruptibleSleep, :sleep => false)
+    receiver.stub :interruptible_sleep => sleeper
+    receiver.should_receive(:check_for_feedback).at_least(:once)
+    Thread.stub(:new).and_yield
+    receiver.stub(:loop).and_yield
+    receiver.start
+  end
+
+  it 'interrupts sleep when stopped' do
+    sleeper = double(Rapns::Daemon::InterruptibleSleep, :sleep => false)
+    receiver.stub :interruptible_sleep => sleeper
+    receiver.stub(:check_for_feedback)
+    sleeper.should_receive(:interrupt_sleep)
+    receiver.stop
+  end
+
+  it 'reflects feedback was received' do
+    double_connection_read_with_tuple
+    receiver.should_receive(:reflect).with(:apns_feedback, feedback)
+    receiver.check_for_feedback
+  end
+
+  it 'calls the apns_feedback_callback when feedback is received and the callback is set' do
+    double_connection_read_with_tuple
+    Rapns.config.apns_feedback_callback = Proc.new {}
+    Rapns.config.apns_feedback_callback.should_receive(:call).with(feedback)
+    receiver.check_for_feedback
+  end
+
+  it 'catches exceptions in the apns_feedback_callback' do
+    error = StandardError.new('bork!')
+    double_connection_read_with_tuple
+    callback = Proc.new { raise error }
+    Rapns::Deprecation.muted do
+      Rapns.config.on_apns_feedback &callback
+    end
+    lambda { receiver.check_for_feedback }.should_not raise_error
+  end
+
+  it 'logs an exception from the apns_feedback_callback' do
+    error = StandardError.new('bork!')
+    double_connection_read_with_tuple
+    callback = Proc.new { raise error }
+    Rapns.logger.should_receive(:error).with(error)
+    Rapns::Deprecation.muted do
+      Rapns.config.on_apns_feedback &callback
+    end
+    receiver.check_for_feedback
+  end
+end

data/spec/unit/daemon/app_runner_shared.rb

@@ -0,0 +1,83 @@
+shared_examples_for "an AppRunner subclass" do
+  let(:queue) { double(:push => nil) }
+
+  before { Queue.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 'adds the delivery handler to the collection' do
+      handler_collection.should_receive(:push).with(handler)
+      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) { double }
+    let(:batch) { double(:notifications => [notification]) }
+
+    it 'enqueues the batch' do
+      queue.should_receive(:push).with([notification, batch])
+      runner.enqueue(batch)
+    end
+
+    it 'reflects the notification has been enqueued' do
+      runner.should_receive(:reflect).with(:notification_enqueued, notification)
+      runner.enqueue(batch)
+    end
+  end
+
+  describe 'stop' do
+    before { runner.start }
+
+    it 'stops the delivery handlers' do
+      handler_collection.should_receive(:stop)
+      runner.stop
+    end
+  end
+
+  describe 'idle?' do
+    it 'is idle if all notifications have been processed' do
+      runner.batch = double(:complete? => true)
+      runner.idle?.should be_true
+    end
+
+    it 'is idle if the runner has no associated batch' do
+      runner.batch = nil
+      runner.idle?.should be_true
+    end
+
+    it 'is not idle if not all notifications have been processed' do
+      runner.batch = double(:complete? => false)
+      runner.idle?.should be_false
+    end
+  end
+
+  describe 'sync' do
+    before { runner.start }
+
+    it 'reduces the number of handlers if needed' do
+      handler_collection.should_receive(:pop)
+      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)
+      handler_collection.should_receive(:push).with(handler)
+      new_app = app_class.new
+      new_app.stub(:connections => app.connections + 1)
+      runner.sync(new_app)
+    end
+  end
+end