rapns 2.0.5 → 3.0.0.beta.1

data/lib/rapns/binary_notification_validator.rb

@@ -1,10 +0,0 @@
-module Rapns
-  class BinaryNotificationValidator < ActiveModel::Validator
-
-    def validate(record)
-      if record.payload_size > 256
-        record.errors[:base] << "APN notification cannot be larger than 256 bytes. Try condensing your alert and device attributes."
-      end
-    end
-  end
-end

data/lib/rapns/daemon/connection.rb

@@ -1,114 +0,0 @@
-module Rapns
-  module Daemon
-    class ConnectionError < StandardError; end
-
-    class Connection
-      attr_accessor :last_write
-
-      def self.idle_period
-        30.minutes
-      end
-
-      def initialize(name, host, port, certificate, password)
-        @name = name
-        @host = host
-        @port = port
-        @certificate = certificate
-        @password = password
-        written
-      end
-
-      def connect
-        @ssl_context = setup_ssl_context
-        @tcp_socket, @ssl_socket = connect_socket
-      end
-
-      def close
-        begin
-          @ssl_socket.close if @ssl_socket
-          @tcp_socket.close if @tcp_socket
-        rescue IOError
-        end
-      end
-
-      def read(num_bytes)
-        @ssl_socket.read(num_bytes)
-      end
-
-      def select(timeout)
-        IO.select([@ssl_socket], nil, nil, timeout)
-      end
-
-      def write(data)
-        reconnect_idle if idle_period_exceeded?
-
-        retry_count = 0
-
-        begin
-          write_data(data)
-        rescue Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError => e
-          retry_count += 1;
-
-          if retry_count == 1
-            Rapns::Daemon.logger.error("[#{@name}] Lost connection to #{@host}:#{@port} (#{e.class.name}), reconnecting...")
-          end
-
-          if retry_count <= 3
-            reconnect
-            sleep 1
-            retry
-          else
-            raise ConnectionError, "#{@name} tried #{retry_count-1} times to reconnect but failed (#{e.class.name})."
-          end
-        end
-      end
-
-      def reconnect
-        close
-        @tcp_socket, @ssl_socket = connect_socket
-      end
-
-      protected
-
-      def reconnect_idle
-        Rapns::Daemon.logger.info("[#{@name}] Idle period exceeded, reconnecting...")
-        reconnect
-      end
-
-      def idle_period_exceeded?
-        Time.now - last_write > self.class.idle_period
-      end
-
-      def write_data(data)
-        @ssl_socket.write(data)
-        @ssl_socket.flush
-        written
-      end
-
-      def written
-        self.last_write = Time.now
-      end
-
-      def setup_ssl_context
-        ssl_context = OpenSSL::SSL::SSLContext.new
-        ssl_context.key = OpenSSL::PKey::RSA.new(@certificate, @password)
-        ssl_context.cert = OpenSSL::X509::Certificate.new(@certificate)
-        ssl_context
-      end
-
-      def connect_socket
-        tcp_socket = TCPSocket.new(@host, @port)
-        tcp_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
-        tcp_socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
-        ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, @ssl_context)
-        ssl_socket.sync = true
-        ssl_socket.connect
-        Rapns::Daemon.logger.info("[#{@name}] Connected to #{@host}:#{@port}")
-        [tcp_socket, ssl_socket]
-      rescue StandardError => e
-        Rapns::Daemon.logger.error("[#{@name}] Error connecting to #{@host}:#{@port} : #{e}")
-        raise
-      end
-    end
-  end
-end

data/lib/rapns/daemon/delivery_handler_pool.rb

@@ -1,18 +0,0 @@
-module Rapns
-  module Daemon
-    class DeliveryHandlerPool
-      def initialize
-        @handlers = []
-      end
-
-      def <<(handler)
-        @handlers << handler
-        handler.start
-      end
-
-      def drain
-        @handlers.pop.stop while !@handlers.empty?
-      end
-    end
-  end
-end

data/lib/rapns/daemon/disconnection_error.rb

@@ -1,14 +0,0 @@
-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/daemon/feedback_receiver.rb

@@ -1,82 +0,0 @@
-module Rapns
-  module Daemon
-    class FeedbackReceiver
-      include InterruptibleSleep
-      include DatabaseReconnectable
-
-      FEEDBACK_TUPLE_BYTES = 38
-
-      def initialize(name, host, port, poll, certificate, password)
-        @name = name
-        @host = host
-        @port = port
-        @poll = poll
-        @certificate = certificate
-        @password = password
-      end
-
-      def start
-        @thread = Thread.new do
-          loop do
-            begin
-              break if @stop
-              check_for_feedback
-            rescue OpenSSL::SSL::SSLError
-              # stop the thread if there is an SSL error. Other errors might be recoverable,
-              # and retrying later might make sense (for example, a network outage)
-              @stop = true
-              break
-            rescue
-              # error will be logged in check_for_feedback
-            end
-            interruptible_sleep @poll
-          end
-        end
-      end
-
-      def stop
-        @stop = true
-        interrupt_sleep
-        @thread.join if @thread
-      end
-
-      def check_for_feedback
-        connection = nil
-        begin
-          connection = Connection.new("FeedbackReceiver:#{@name}", @host, @port, @certificate, @password)
-          connection.connect
-
-          while tuple = connection.read(FEEDBACK_TUPLE_BYTES)
-            timestamp, device_token = parse_tuple(tuple)
-            create_feedback(timestamp, device_token)
-          end
-        rescue StandardError => e
-          Rapns::Daemon.logger.error(e)
-          raise
-        ensure
-          connection.close if connection
-        end
-      end
-
-      protected
-
-      def parse_tuple(tuple)
-        failed_at, _, device_token = tuple.unpack("N1n1H*")
-        [Time.at(failed_at).utc, device_token]
-      end
-
-      def create_feedback(failed_at, device_token)
-        formatted_failed_at = failed_at.strftime("%Y-%m-%d %H:%M:%S UTC")
-        with_database_reconnect_and_retry do
-          Rapns::Daemon.logger.info("[FeedbackReceiver:#{@name}] Delivery failed at #{formatted_failed_at} for #{device_token}")
-          feedback = Rapns::Feedback.create!(:failed_at => failed_at, :device_token => device_token, :app => @name)
-          begin
-            Rapns.configuration.feedback_callback.call(feedback) if Rapns.configuration.feedback_callback
-          rescue Exception => e
-            Rapns::Daemon.logger.error(e)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rapns/device_token_format_validator.rb

@@ -1,10 +0,0 @@
-module Rapns
-  class DeviceTokenFormatValidator < ActiveModel::Validator
-
-    def validate(record)
-      if record.device_token !~ /^[a-z0-9]{64}$/
-        record.errors[:device_token] << "is invalid"
-      end
-    end
-  end
-end

data/lib/rapns/feedback.rb

@@ -1,12 +0,0 @@
-module Rapns
-  class Feedback < ActiveRecord::Base
-    self.table_name = 'rapns_feedback'
-
-    attr_accessible :device_token, :failed_at, :app
-
-    validates :device_token, :presence => true
-    validates :failed_at, :presence => true
-
-    validates_with Rapns::DeviceTokenFormatValidator
-  end
-end

data/spec/rapns/daemon/app_runner_spec.rb

@@ -1,193 +0,0 @@
-require 'spec_helper'
-
-describe Rapns::Daemon::AppRunner do
-  let(:app) { stub(:key => 'app', :certificate => 'cert', :password => '', :connections => 1) }
-  let(:queue) { stub(:notifications_processed? => true, :push => nil) }
-  let(:receiver) { stub(:start => nil, :stop => nil) }
-  let(:handler) { stub(:start => nil, :stop => nil) }
-  let(:push_config) { stub(:host => 'gateway.push.apple.com', :port => 2195) }
-  let(:feedback_config) { stub(:host => 'feedback.push.apple.com', :port => 2196, :poll => 60) }
-  let(:runner) { Rapns::Daemon::AppRunner.new(app, push_config.host, push_config.port,
-    feedback_config.host, feedback_config.port, feedback_config.poll) }
-
-  before do
-    Rapns::Daemon::DeliveryQueue.stub(:new => queue)
-    Rapns::Daemon::FeedbackReceiver.stub(:new => receiver)
-    Rapns::Daemon::DeliveryHandler.stub(:new => handler)
-  end
-
-  after { Rapns::Daemon::AppRunner.all.clear }
-
-  describe 'start' do
-    it 'starts a feedback receiver' do
-      Rapns::Daemon::FeedbackReceiver.should_receive(:new).with(app.key, feedback_config.host, feedback_config.port, feedback_config.poll, app.certificate, app.password)
-      receiver.should_receive(:start)
-      runner.start
-    end
-
-    it 'starts a delivery handler for each connection' do
-      Rapns::Daemon::DeliveryHandler.should_receive(:new).with(queue, app.key, push_config.host,
-        push_config.port, app.certificate, app.password)
-      handler.should_receive(:start)
-      runner.start
-    end
-  end
-
-  describe 'deliver' do
-    let(:notification) { stub }
-
-    it 'enqueues the notification' do
-      queue.should_receive(:push).with(notification)
-      runner.deliver(notification)
-    end
-  end
-
-  describe 'stop' do
-    before { runner.start }
-
-    it 'stops the delivery handlers' do
-      handler.should_receive(:stop)
-      runner.stop
-    end
-
-    it 'stops the feedback receiver' do
-      receiver.should_receive(:stop)
-      runner.stop
-    end
-  end
-
-  describe 'ready?' do
-    it 'is ready if all notifications have been processed' do
-      queue.stub(:notifications_processed? => true)
-      runner.ready?.should be_true
-    end
-
-    it 'is not ready if not all notifications have been processed' do
-      queue.stub(:notifications_processed? => false)
-      runner.ready?.should be_false
-    end
-  end
-
-  describe 'sync' do
-    let(:new_app) { stub(:key => 'app', :certificate => 'cert', :password => '', :connections => 1) }
-    before { runner.start }
-
-    it 'reduces the number of handlers if needed' do
-      handler.should_receive(:stop)
-      new_app.stub(:connections => app.connections - 1)
-      runner.sync(new_app)
-    end
-
-    it 'increases the number of handlers if needed' do
-      new_handler = stub
-      Rapns::Daemon::DeliveryHandler.should_receive(:new).and_return(new_handler)
-      new_handler.should_receive(:start)
-      new_app.stub(:connections => app.connections + 1)
-      runner.sync(new_app)
-    end
-  end
-end
-
-describe Rapns::Daemon::AppRunner, 'stop' do
-  let(:runner) { stub }
-  before { Rapns::Daemon::AppRunner.all['app'] = runner }
-  after { Rapns::Daemon::AppRunner.all.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 => 'app') }
-  let(:logger) { stub(:error => nil) }
-
-  before do
-    Rapns::Daemon.stub(:logger => logger)
-    Rapns::Daemon::AppRunner.all['app'] = runner
-  end
-
-  after { Rapns::Daemon::AppRunner.all.clear }
-
-  it 'delivers the notification' do
-    runner.should_receive(:deliver).with(notification)
-    Rapns::Daemon::AppRunner.deliver(notification)
-  end
-
-  it 'logs an error if there is no runner to deliver the notification' do
-    notification.stub(:app => 'unknonw', :id => 123)
-    logger.should_receive(:error).with("No such app '#{notification.app}' for notification #{notification.id}.")
-    Rapns::Daemon::AppRunner.deliver(notification)
-  end
-end
-
-describe Rapns::Daemon::AppRunner, 'ready' do
-  let(:runner1) { stub(:ready? => true) }
-  let(:runner2) { stub(:ready? => false) }
-
-  before do
-    Rapns::Daemon::AppRunner.all['app1'] = runner1
-    Rapns::Daemon::AppRunner.all['app2'] = runner2
-  end
-
-  after { Rapns::Daemon::AppRunner.all.clear }
-
-  it 'returns apps that are ready for more notifications' do
-    Rapns::Daemon::AppRunner.ready.should == ['app1']
-  end
-end
-
-describe Rapns::Daemon::AppRunner, 'sync' do
-  let(:app) { stub(:key => 'app', :environment => 'development') }
-  let(:new_app) { stub(:key => 'new_app', :environment => 'development') }
-  let(:runner) { stub(:sync => nil, :stop => nil) }
-  let(:new_runner) { stub }
-  let(:logger) { stub(:error => nil) }
-  let(:config) { stub(:feedback_poll => 60) }
-
-  before do
-    Rapns::Daemon.stub(:config => config, :logger => logger)
-    Rapns::Daemon::AppRunner.all['app'] = runner
-    Rapns::App.stub(:all => [app])
-  end
-
-  after { Rapns::Daemon::AppRunner.all.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 with a production certificate' do
-    new_app.stub(:environment => 'production')
-    Rapns::App.stub(:all => [new_app])
-    new_runner = stub 
-    Rapns::Daemon::AppRunner.should_receive(:new).with(new_app, 'gateway.push.apple.com', 2195,
-      'feedback.push.apple.com', 2196, config.feedback_poll).and_return(new_runner)
-    new_runner.should_receive(:start)
-    Rapns::Daemon::AppRunner.sync
-  end
-
-  it 'starts a runner for a new app with a development certificate' do
-    new_app.stub(:environment => 'development')
-    Rapns::App.stub(:all => [new_app])
-    new_runner = stub 
-    Rapns::Daemon::AppRunner.should_receive(:new).with(new_app, 'gateway.sandbox.push.apple.com', 2195,
-      'feedback.sandbox.push.apple.com', 2196, config.feedback_poll).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/daemon/delivery_handler_pool_spec.rb

@@ -1,17 +0,0 @@
-require "spec_helper"
-
-describe Rapns::Daemon::DeliveryHandlerPool do
-  let(:pool) { Rapns::Daemon::DeliveryHandlerPool.new }
-  let(:handler) { stub(:start => nil, :stop => nil) }
-  
-  it 'starts the handler when added to the pool' do
-    handler.should_receive(:start)
-    pool << handler
-  end
-
-  it 'stops each handler when drained' do
-    pool << handler
-    handler.should_receive(:stop)
-    pool.drain
-  end
-end

data/spec/rapns/daemon/delivery_handler_spec.rb

@@ -1,206 +0,0 @@
-require "spec_helper"
-
-describe Rapns::Daemon::DeliveryHandler do
-  let(:queue) { Rapns::Daemon::DeliveryQueue.new }
-  let(:name) { 'my_app:0' }
-  let(:host) { 'localhost' }
-  let(:port) { 2195 }
-  let(:certificate) { stub }
-  let(:password) { stub }
-  let(:delivery_handler) { Rapns::Daemon::DeliveryHandler.new(queue, name, host, port, certificate, password) }
-  let(:connection) { stub(:select => false, :write => nil, :reconnect => nil, :close => nil, :connect => nil) }
-  let(:logger) { stub(:error => nil, :info => nil) }
-  let(:notification) { stub.as_null_object }
-  let(:config) { stub(:check_for_errors => true) }
-  let(:delivery_queues) { [] }
-
-  before do
-    Rapns::Daemon::Connection.stub(:new => connection)
-    Rapns::Daemon.stub(:delivery_queues => delivery_queues, :logger => logger, :config => config)
-    queue.push(notification) 
-  end
-
-  it "instantiates a new connection" do
-    Rapns::Daemon::Connection.should_receive(:new).with("DeliveryHandler:#{name}", host, port, certificate, password)
-    delivery_handler
-  end
-
-  it "connects the socket when started" do
-    connection.should_receive(:connect)
-    delivery_handler.start
-    delivery_handler.stop
-  end
-
-  it "instructs the queue to wakeup the thread when told to stop" do
-    thread = stub
-    Thread.stub(:new => thread)
-    queue.should_receive(:wakeup).with(thread)
-    delivery_handler.start
-    delivery_handler.stop
-  end
-
-  it "sends the binary version of the notification" do
-    notification.stub(:to_binary => "hi mom")
-    connection.should_receive(:write).with("hi mom")
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it "logs the notification delivery" do
-    notification.stub(:id => 666, :device_token => 'abc123')
-    logger.should_receive(:info).with("[DeliveryHandler:my_app:0] 666 sent to abc123")
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it "marks the notification as delivered" do
-    notification.should_receive(:delivered=).with(true)
-    delivery_handler.send(:handle_next_notification)
-  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)
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it "does not trigger validations when saving the notification" do
-    notification.should_receive(:save!).with(:validate => false)
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it "updates notification with the ability to reconnect the database" do
-    delivery_handler.should_receive(:with_database_reconnect_and_retry)
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it "logs if an error is raised when updating the notification" do
-    e = StandardError.new("bork!")
-    notification.stub(:save!).and_raise(e)
-    Rapns::Daemon.logger.should_receive(:error).with(e)
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it "notifies the delivery queue the notification has been processed" do
-    queue.should_receive(:notification_processed)
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  it 'does not check for errors if check_for_errors config option is false' do
-    config.stub(:check_for_errors => false)
-    delivery_handler.should_not_receive(:check_for_error)
-    delivery_handler.send(:handle_next_notification)
-  end
-
-  describe "when being stopped" do
-    before { queue.pop }
-
-    it "closes the connection when a DeliveryQueue::WakeupError is raised" do
-      connection.should_receive(:close)
-      queue.stub(:pop).and_raise(Rapns::Daemon::DeliveryQueue::WakeupError)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    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
-
-  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_handler.should_receive(:with_database_reconnect_and_retry)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "sets the notification as not delivered" do
-      notification.should_receive(:delivered=).with(false)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "sets the notification delivered_at timestamp to nil" do
-      notification.should_receive(:delivered_at=).with(nil)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "sets the notification as failed" do
-      notification.should_receive(:failed=).with(true)
-      delivery_handler.send(:handle_next_notification)
-    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)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "sets the notification error code" do
-      notification.should_receive(:error_code=).with(4)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "logs the delivery error" do
-      error = Rapns::DeliveryError.new(4, 12, "Missing payload")
-      Rapns::DeliveryError.stub(:new => error)
-      logger.should_receive(:error).with(error)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "sets the notification error description" do
-      notification.should_receive(:error_description=).with("Missing payload")
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "skips validation when saving the notification" do
-      notification.should_receive(:save!).with(:validate => false)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "reads 6 bytes from the socket" do
-      connection.should_receive(:read).with(6).and_return(nil)
-      delivery_handler.send(:handle_next_notification)
-    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)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "reconnects the socket" do
-      connection.should_receive(:reconnect)
-      delivery_handler.send(:handle_next_notification)
-    end
-
-    it "logs that the connection is being reconnected" do
-      Rapns::Daemon.logger.should_receive(:error).with("[DeliveryHandler:my_app:0] Error received, reconnecting...")
-      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 'raises 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)
-      end
-    end
-  end
-end

data/spec/rapns/feedback_spec.rb

@@ -1,12 +0,0 @@
-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
-    feedback = Rapns::Feedback.new(:device_token => "{$%^&*()}")
-    feedback.valid?.should be_false
-    feedback.errors[:device_token].include?("is invalid").should be_true
-  end
-end