rpush 2.4.0 → 2.5.0

data/lib/rpush/reflection_public_methods.rb

@@ -1,9 +1,11 @@
 module Rpush
-  def self.reflect
-    yield reflection_stack[0] if block_given?
+  @reflection_stack ||= [ReflectionCollection.new]
+
+  class << self
+    attr_reader :reflection_stack
   end
 
-  def self.reflection_stack
-    @reflection_stack ||= [ReflectionCollection.new]
+  def self.reflect
+    yield reflection_stack[0] if block_given?
   end
 end

data/lib/rpush/version.rb

@@ -1,3 +1,3 @@
 module Rpush
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/spec/functional/apns_spec.rb

@@ -11,7 +11,7 @@ describe 'APNs' do
 
   before do
     Rpush.config.push_poll = 0.5
-    stub_tcp_connection
+    stub_tcp_connection(tcp_socket, ssl_socket, io_double)
   end
 
   def create_app
@@ -32,12 +32,6 @@ describe 'APNs' do
     notification
   end
 
-  def stub_tcp_connection
-    allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(connect_socket: [tcp_socket, ssl_socket])
-    allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(setup_ssl_context: double.as_null_object)
-    stub_const('Rpush::Daemon::TcpConnection::IO', io_double)
-  end
-
   def wait
     sleep 0.1
   end
@@ -71,10 +65,6 @@ describe 'APNs' do
     end
   end
 
-  def timeout(&blk)
-    Timeout.timeout(10, &blk)
-  end
-
   it 'delivers a notification successfully' do
     notification = create_notification
     expect do

data/spec/functional/cli_spec.rb

@@ -0,0 +1,35 @@
+require 'functional_spec_helper'
+
+describe Rpush::CLI do
+  def create_app
+    app = Rpush::Apns::App.new
+    app.certificate = TEST_CERT
+    app.name = 'test'
+    app.environment = 'sandbox'
+    app.save!
+    app
+  end
+
+  describe 'status' do
+    let(:tcp_socket) { double(TCPSocket, setsockopt: nil, close: nil) }
+    let(:ssl_socket) { double(OpenSSL::SSL::SSLSocket, :sync= => nil, connect: nil, write: nil, flush: nil, read: nil, close: nil) }
+    let(:io_double) { double(select: nil) }
+
+    before do
+      create_app
+      stub_tcp_connection(tcp_socket, ssl_socket, io_double)
+      Rpush.embed
+
+      timeout do
+        Thread.pass until File.exist?(Rpush::Daemon::Rpc.socket_path)
+      end
+    end
+
+    after { timeout { Rpush.shutdown } }
+
+    it 'prints the status' do
+      expect(subject).to receive(:puts).with(/app_runners:/)
+      subject.status
+    end
+  end
+end

data/spec/functional_spec_helper.rb

@@ -4,7 +4,17 @@ require 'database_cleaner'
 DatabaseCleaner.strategy = :truncation
 
 def functional_example?(metadata)
-  metadata[:file_path] =~ /spec\/functional/
+  metadata[:file_path] =~ %r{/spec/functional/}
+end
+
+def timeout(&blk)
+  Timeout.timeout(10, &blk)
+end
+
+def stub_tcp_connection(tcp_socket, ssl_socket, io_double)
+  allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(connect_socket: [tcp_socket, ssl_socket])
+  allow_any_instance_of(Rpush::Daemon::TcpConnection).to receive_messages(setup_ssl_context: double.as_null_object)
+  stub_const('Rpush::Daemon::TcpConnection::IO', io_double)
 end
 
 RSpec.configure do |config|

data/spec/spec_helper.rb

@@ -3,9 +3,6 @@ def client
   (ENV['CLIENT'] || :active_record).to_sym
 end
 
-require 'bundler/setup'
-Bundler.require(:default)
-
 if !ENV['TRAVIS'] || (ENV['TRAVIS'] && ENV['QUALITY'] == 'true')
   begin
     require './spec/support/simplecov_helper'
@@ -16,6 +13,9 @@ if !ENV['TRAVIS'] || (ENV['TRAVIS'] && ENV['QUALITY'] == 'true')
   end
 end
 
+require 'timecop'
+require 'activerecord-jdbc-adapter' if defined? JRUBY_VERSION
+
 require 'rpush'
 require 'rpush/daemon'
 require 'rpush/client/redis'
@@ -42,6 +42,7 @@ RPUSH_ROOT = '/tmp/rails_root'
 
 Rpush.configure do |config|
   config.client = client
+  config.log_level = ::Logger::Severity::DEBUG
 end
 
 RPUSH_CLIENT = Rpush.config.client

data/spec/support/active_record_setup.rb

@@ -33,7 +33,7 @@ require 'generators/templates/rpush_2_1_0_updates'
 migrations = [AddRpush, Rpush200Updates, Rpush210Updates]
 
 unless ENV['TRAVIS']
-  migrations.reverse.each do |m|
+  migrations.reverse_each do |m|
     begin
       m.down
     rescue ActiveRecord::StatementInvalid => e

data/spec/unit/client/active_record/apns/notification_spec.rb

@@ -217,7 +217,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, "bug #31" do
 
   it 'does confuse a JSON looking string as JSON if the alert_is_json attribute is not present' do
     notification = Rpush::Client::ActiveRecord::Apns::Notification.new
-    allow(notification).to receive_messages(:has_attribute? => false)
+    allow(notification).to receive_messages(has_attribute?: false)
     notification.alert = "{\"one\":2}"
     expect(notification.alert).to eq('one' => 2)
   end

data/spec/unit/configuration_spec.rb

@@ -43,11 +43,4 @@ describe Rpush::Configuration do
     Rpush.config.redis_options = { hi: :mom }
     expect(Modis.redis_options).to eq(hi: :mom)
   end
-
-  it 'deprecates feedback_poll=' do
-    expect(Rpush::Deprecation).to receive(:warn).with(/feedback_poll= is deprecated/)
-    expect do
-      Rpush.config.feedback_poll = 123
-    end.to change { Rpush.config.apns.feedback_receiver.frequency }.to(123)
-  end
 end

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

@@ -78,14 +78,14 @@ describe Rpush::Daemon::Adm::Delivery do
     it 'logs that the notification was not delivered' do
       allow(response).to receive_messages(body: JSON.dump('reason' => 'InvalidRegistrationId'))
       expect(logger).to receive(:warn).with("[MyApp] bad_request: xyz (InvalidRegistrationId)")
-      expect { perform }.to raise_error
+      expect { perform }.to raise_error(Rpush::DeliveryError)
     end
 
     it 'reflects' do
       allow(response).to receive_messages(body: JSON.dump('registrationID' => 'canonical123', 'reason' => 'Unregistered'))
       allow(notification).to receive_messages(registration_ids: ['1'])
       expect(delivery).to receive(:reflect).with(:adm_failed_to_recipient, notification, '1', 'Unregistered')
-      expect { perform }.to raise_error
+      expect { perform }.to raise_error(Rpush::DeliveryError)
     end
   end
 

data/spec/unit/daemon/app_runner_spec.rb

@@ -94,9 +94,8 @@ describe Rpush::Daemon::AppRunner, 'debug' do
 
   after { Rpush::Daemon::AppRunner.stop_app(app.id) }
 
-  it 'prints debug app states to the log' do
-    expect(Rpush.logger).to receive(:info).with(kind_of(String))
-    Rpush::Daemon::AppRunner.debug
+  it 'returns the app runner status' do
+    expect(Rpush::Daemon::AppRunner.status.key?(:app_runners)).to eq(true)
   end
 end
 

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

@@ -16,7 +16,7 @@ describe Rpush::Daemon::Gcm::Delivery do
   end
 
   def perform_with_rescue
-    expect { perform }.to raise_error
+    expect { perform }.to raise_error(StandardError)
   end
 
   before do

data/spec/unit/daemon/tcp_connection_spec.rb

@@ -126,7 +126,7 @@ describe Rpush::Daemon::TcpConnection do
       end
 
       it 'logs that the certificate has been revoked' do
-        expect(logger).to receive(:warn).with('[Connection 0] Certificate has been revoked.')
+        expect(logger).to receive(:error).with('[Connection 0] Certificate has been revoked.')
         expect { connection.connect }.to raise_error(Rpush::Daemon::TcpConnectionError, 'OpenSSL::SSL::SSLError, certificate revoked')
       end
     end

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

@@ -0,0 +1,171 @@
+require 'unit_spec_helper'
+
+describe Rpush::Daemon::Wns::Delivery do
+  let(:app) { Rpush::Wns::App.create!(name: "MyApp", client_id: "someclient", client_secret: "somesecret", access_token: "access_token", access_token_expiration: Time.now + (60 * 10)) }
+  let(:notification) { Rpush::Wns::Notification.create!(app: app, data: { title: "MyApp", body: "Example notification", param: "/param1" }, uri: "http://some.example/", deliver_after: Time.now) }
+  let(:logger) { double(error: nil, info: nil, warn: nil) }
+  let(:response) { double(code: 200, header: {}, body: '') }
+  let(:http) { double(shutdown: nil, request: response) }
+  let(:now) { Time.parse('2012-10-14 00:00:00') }
+  let(:batch) { double(mark_failed: nil, mark_delivered: nil, mark_retryable: nil, notification_processed: nil) }
+  let(:delivery) { Rpush::Daemon::Wns::Delivery.new(app, http, notification, batch) }
+  let(:store) { double(create_wpns_notification: double(id: 2), update_app: nil) }
+
+  def perform
+    delivery.perform
+  end
+
+  def perform_with_rescue
+    expect { perform }.to raise_error(StandardError)
+  end
+
+  before do
+    allow(delivery).to receive_messages(reflect: nil)
+    allow(Rpush::Daemon).to receive_messages(store: store)
+    allow(Time).to receive_messages(now: now)
+    allow(Rpush).to receive_messages(logger: logger)
+  end
+
+  shared_examples_for "an notification with some delivery faliures" do
+    let(:new_notification) { Rpush::Wns::Notification.where('id != ?', notification.id).first }
+
+    before { allow(response).to receive_messages(body: JSON.dump(body)) }
+
+    it "marks the original notification falied" do
+      expect(delivery).to receive(:mark_failed) do |error|
+        expect(error.message).to match(error_description)
+      end
+      perform_with_rescue
+    end
+
+    it "raises a DeliveryError" do
+      expect { perform }.to raise_error(Rpush::DeliveryError)
+    end
+  end
+
+  describe "an 200 response without an access token" do
+    before do
+      allow(app).to receive_messages(access_token_expired?: true)
+      allow(response).to receive_messages(to_hash: {}, code: 200, body: JSON.dump(access_token: "dummy_access_token", expires_in: 60))
+    end
+
+    it 'set the access token for the app' do
+      expect(delivery).to receive(:update_access_token).with("access_token" => "dummy_access_token", "expires_in" => 60)
+      expect(store).to receive(:update_app).with app
+      perform
+    end
+  end
+
+  describe "an 200 response with a valid access token" do
+    before do
+      allow(response).to receive_messages(code: 200)
+    end
+
+    it "marks the notification as delivered if delivered successfully to all devices" do
+      allow(response).to receive_messages(body: JSON.dump("failure" => 0))
+      allow(response).to receive_messages(to_hash: { "X-WNS-Status" => ["received"] })
+      expect(batch).to receive(:mark_delivered).with(notification)
+      perform
+    end
+
+    it "retries the notification when the queue is full" do
+      allow(response).to receive_messages(body: JSON.dump("failure" => 0))
+      allow(response).to receive_messages(to_hash: { "X-WNS-Status" => ["channelthrottled"] })
+      expect(batch).to receive(:mark_retryable).with(notification, Time.now + (60 * 10))
+      perform
+    end
+
+    it "marks the notification as failed if the notification is suppressed" do
+      allow(response).to receive_messages(body: JSON.dump("faliure" => 0))
+      allow(response).to receive_messages(to_hash: { "X-WNS-Status" => ["dropped"], "X-WNS-Error-Description" => "" })
+      error = Rpush::DeliveryError.new(200, notification.id, 'Notification was received but suppressed by the service ().')
+      expect(delivery).to receive(:mark_failed).with(error)
+      perform_with_rescue
+    end
+  end
+
+  describe "an 400 response" do
+    before { allow(response).to receive_messages(code: 400) }
+    it "marks notifications as failed" do
+      error = Rpush::DeliveryError.new(400, notification.id, 'One or more headers were specified incorrectly or conflict with another header.')
+      expect(delivery).to receive(:mark_failed).with(error)
+      perform_with_rescue
+    end
+  end
+
+  describe "an 404 response" do
+    before { allow(response).to receive_messages(code: 404) }
+    it "marks notifications as failed" do
+      error = Rpush::DeliveryError.new(404, notification.id, 'The channel URI is not valid or is not recognized by WNS.')
+      expect(delivery).to receive(:mark_failed).with(error)
+      perform_with_rescue
+    end
+  end
+
+  describe "an 405 response" do
+    before { allow(response).to receive_messages(code: 405) }
+    it "marks notifications as failed" do
+      error = Rpush::DeliveryError.new(405, notification.id, 'Invalid method (GET, CREATE); only POST (Windows or Windows Phone) or DELETE (Windows Phone only) is allowed.')
+      expect(delivery).to receive(:mark_failed).with(error)
+      perform_with_rescue
+    end
+  end
+
+  describe "an 406 response" do
+    before { allow(response).to receive_messages(code: 406) }
+
+    it "retries the notification" do
+      expect(batch).to receive(:mark_retryable).with(notification, Time.now + (60 * 60))
+      perform
+    end
+
+    it "logs a warning that the notification will be retried" do
+      notification.retries = 1
+      notification.deliver_after = now + 2
+      expect(logger).to receive(:warn).with("[MyApp] Per-day throttling limit reached. Notification #{notification.id} will be retried after 2012-10-14 00:00:02 (retry 1).")
+      perform
+    end
+  end
+
+  describe "an 412 response" do
+    before { allow(response).to receive_messages(code: 412) }
+
+    it "retries the notification" do
+      expect(batch).to receive(:mark_retryable).with(notification, Time.now + (60 * 60))
+      perform
+    end
+
+    it "logs a warning that the notification will be retried" do
+      notification.retries = 1
+      notification.deliver_after = now + 2
+      expect(logger).to receive(:warn).with("[MyApp] Device unreachable. Notification #{notification.id} will be retried after 2012-10-14 00:00:02 (retry 1).")
+      perform
+    end
+  end
+
+  describe "an 503 response" do
+    before { allow(response).to receive_messages(code: 503) }
+
+    it "retries the notification exponentially" do
+      expect(delivery).to receive(:mark_retryable_exponential).with(notification)
+      perform
+    end
+
+    it 'logs a warning that the notification will be retried.' do
+      notification.retries = 1
+      notification.deliver_after = now + 2
+      expect(logger).to receive(:warn).with("[MyApp] Service Unavailable. Notification #{notification.id} will be retried after 2012-10-14 00:00:02 (retry 1).")
+      perform
+    end
+  end
+
+  describe 'an un-handled response' do
+    before { allow(response).to receive_messages(code: 418) }
+
+    it 'marks the notification as failed' do
+      error = Rpush::DeliveryError.new(418, notification.id, "I'm a Teapot")
+      expect(delivery).to receive(:mark_failed).with(error)
+      perform_with_rescue
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ describe Rpush::Daemon::Wpns::Delivery do
   end
 
   def perform_with_rescue
-    expect { perform }.to raise_error
+    expect { perform }.to raise_error(StandardError)
   end
 
   before do

data/spec/unit/daemon_spec.rb

@@ -13,6 +13,8 @@ describe Rpush::Daemon, "when starting" do
     allow(Rpush::Daemon::Feeder).to receive(:start)
     allow(Rpush::Daemon::Synchronizer).to receive(:sync)
     allow(Rpush::Daemon::AppRunner).to receive(:stop)
+    allow(Rpush::Daemon::Rpc::Server).to receive(:start)
+    allow(Rpush::Daemon::Rpc::Server).to receive(:stop)
     allow(Rpush::Daemon).to receive(:exit)
     allow(Rpush::Daemon).to receive(:puts)
     allow(Rpush::Daemon::SignalHandler).to receive(:start)

data/spec/unit/embed_spec.rb

@@ -17,13 +17,6 @@ describe Rpush, 'embed' do
     expect(Rpush::Daemon).to receive(:start)
     Rpush.embed
   end
-
-  it 'overrides the default config options with those given as a hash' do
-    Rpush::Deprecation.muted do
-      Rpush.config.push_poll = 4
-      expect { Rpush.embed(push_poll: 2) }.to change(Rpush.config, :push_poll).to(2)
-    end
-  end
 end
 
 describe Rpush, 'shutdown' do
@@ -44,11 +37,11 @@ describe Rpush, 'sync' do
   end
 end
 
-describe Rpush, 'debug' do
+describe Rpush, 'status' do
   before { Rpush.config.embedded = true }
 
-  it 'debugs the AppRunner' do
-    expect(Rpush::Daemon::AppRunner).to receive(:debug)
-    Rpush.debug
+  it 'returns the AppRunner status' do
+    expect(Rpush::Daemon::AppRunner).to receive_messages(status: { status: true })
+    expect(Rpush.status).to eq(status: true)
   end
 end