rpush 2.4.0-java → 2.6.0-java

data/lib/rpush/embed.rb

@@ -1,21 +1,13 @@
 module Rpush
-  def self.embed(options = {})
+  def self.embed
     require 'rpush/daemon'
 
-    unless options.empty?
-      warning = "Passing configuration options directly to Rpush.embed is deprecated and will be removed from Rpush 2.5.0. Please setup configuration using Rpush.configure { |config| ... } before calling embed."
-      Rpush::Deprecation.warn_with_backtrace(warning)
-    end
-
     if @embed_thread
       STDERR.puts 'Rpush.embed can only be run once inside this process.'
     end
 
-    config = Rpush::ConfigurationWithoutDefaults.new
-    options.each { |k, v| config.send("#{k}=", v) }
-    config.embedded = true
-    config.foreground = true
-    Rpush.config.update(config)
+    Rpush.config.embedded = true
+    Rpush.config.foreground = true
     Kernel.at_exit { shutdown }
     @embed_thread = Thread.new { Rpush::Daemon.start }
   end
@@ -24,6 +16,10 @@ module Rpush
     return unless Rpush.config.embedded
     Rpush::Daemon.shutdown
     @embed_thread.join if @embed_thread
+  rescue StandardError => e
+    STDERR.puts(e.message)
+    STDERR.puts(e.backtrace.join("\n"))
+  ensure
     @embed_thread = nil
   end
 
@@ -32,8 +28,14 @@ module Rpush
     Rpush::Daemon::Synchronizer.sync
   end
 
-  def self.debug
+  def self.status
     return unless Rpush.config.embedded
-    Rpush::Daemon::AppRunner.debug
+    status = Rpush::Daemon::AppRunner.status
+    Rpush.logger.info(JSON.pretty_generate(status))
+    status
+  end
+
+  def self.debug
+    status
   end
 end

data/lib/rpush/logger.rb

@@ -11,6 +11,10 @@ module Rpush
       error('Logging disabled.')
     end
 
+    def debug(msg, inline = false)
+      log(:debug, msg, inline)
+    end
+
     def info(msg, inline = false)
       log(:info, msg, inline)
     end

data/lib/rpush/plugin.rb

@@ -32,7 +32,7 @@ module Rpush
       Rpush.config.plugin.send("#{@name}=", @config)
     end
 
-    def init(&block) # rubocop:disable Style/TrivialAccessors
+    def init(&block)
       @init_block = block
     end
 

data/lib/rpush/push.rb

@@ -1,17 +1,8 @@
 module Rpush
-  def self.push(options = {})
+  def self.push
     require 'rpush/daemon'
 
-    unless options.empty?
-      warning = "Passing configuration options directly to Rpush.push is deprecated and will be removed from Rpush 2.5.0. Please setup configuration using Rpush.configure { |config| ... } before calling push."
-      Rpush::Deprecation.warn_with_backtrace(warning)
-    end
-
-    config = Rpush::ConfigurationWithoutDefaults.new
-    options.each { |k, v| config.send("#{k}=", v) }
-    config.push = true
-    Rpush.config.update(config)
-
+    Rpush.config.push = true
     Rpush::Daemon.common_init
     Rpush::Daemon::Synchronizer.sync
     Rpush::Daemon::Feeder.start(true) # non-blocking

data/lib/rpush/reflection_collection.rb

@@ -6,7 +6,7 @@ module Rpush
       :apns_feedback, :notification_enqueued, :notification_delivered,
       :notification_failed, :notification_will_retry, :gcm_delivered_to_recipient,
       :gcm_failed_to_recipient, :gcm_canonical_id, :gcm_invalid_registration_id,
-      :error, :adm_canonical_id, :adm_failed_to_recipient,
+      :error, :adm_canonical_id, :adm_failed_to_recipient, :wns_invalid_channel,
       :tcp_connection_lost, :ssl_certificate_will_expire, :ssl_certificate_revoked,
       :notification_id_will_retry, :notification_id_failed
     ]
@@ -17,30 +17,28 @@ module Rpush
       class_eval(<<-RUBY, __FILE__, __LINE__)
         def #{reflection}(*args, &blk)
           raise "block required" unless block_given?
-          reflections[:#{reflection}] = blk
+          @reflections[:#{reflection}] = blk
         end
       RUBY
     end
 
+    def initialize
+      @reflections = {}
+    end
+
     def __dispatch(reflection, *args)
-      reflection = reflection.to_sym
+      blk = @reflections[reflection]
 
-      unless REFLECTIONS.include?(reflection)
-        fail NoSuchReflectionError, reflection
-      end
+      if blk
+        blk.call(*args)
 
-      if DEPRECATIONS.key?(reflection)
-        replacement, removal_version = DEPRECATIONS[reflection]
-        Rpush::Deprecation.warn("#{reflection} is deprecated and will be removed in version #{removal_version}. Use #{replacement} instead.")
+        if DEPRECATIONS.key?(reflection)
+          replacement, removal_version = DEPRECATIONS[reflection]
+          Rpush::Deprecation.warn("#{reflection} is deprecated and will be removed in version #{removal_version}. Use #{replacement} instead.")
+        end
+      elsif !REFLECTIONS.include?(reflection)
+        raise NoSuchReflectionError, reflection
       end
-
-      reflections[reflection].call(*args) if reflections[reflection]
-    end
-
-    private
-
-    def reflections
-      @reflections ||= {}
     end
   end
 end

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.6.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,36 @@
+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(:configure_rpush) { true }
+      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

@@ -29,11 +29,12 @@ ActiveRecord::Base.establish_connection(db_config[SPEC_ADAPTER])
 require 'generators/templates/add_rpush'
 require 'generators/templates/rpush_2_0_0_updates'
 require 'generators/templates/rpush_2_1_0_updates'
+require 'generators/templates/rpush_2_6_0_updates'
 
-migrations = [AddRpush, Rpush200Updates, Rpush210Updates]
+migrations = [AddRpush, Rpush200Updates, Rpush210Updates, Rpush260Updates]
 
 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/client/active_record/gcm/notification_spec.rb

@@ -31,4 +31,9 @@ describe Rpush::Client::ActiveRecord::Gcm::Notification do
     notification.expiry = 100
     expect(notification.as_json['time_to_live']).to eq 100
   end
+
+  it 'includes content_available in the payload' do
+    notification.content_available = true
+    expect(notification.as_json['content_available']).to eq true
+  end
 end if active_record?

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