rpush 4.0.1 → 5.1.0

data/lib/rpush/client/redis/apns2/notification.rb

@@ -3,6 +3,7 @@ module Rpush
     module Redis
       module Apns2
         class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
           include Rpush::Client::ActiveModel::Apns2::Notification
         end
       end

data/lib/rpush/client/redis/app.rb

@@ -18,7 +18,8 @@ module Rpush
         attribute :apn_key_id, :string
         attribute :team_id, :string
         attribute :bundle_id, :string
- 
+        attribute :feedback_enabled, :boolean, default: true
+
         index :name
 
         validates :name, presence: true

data/lib/rpush/client/redis/notification.rb

@@ -20,7 +20,7 @@ module Rpush
 
         attribute :badge, :integer
         attribute :device_token, :string
-        attribute :sound, :string, default: 'default'
+        attribute :sound, [:string, :hash], strict: false, default: 'default'
         attribute :alert, [:string, :hash], strict: false
         attribute :data, :hash
         attribute :expiry, :integer, default: 1.day.to_i
@@ -34,6 +34,7 @@ module Rpush
         attribute :error_description, :string
         attribute :deliver_after, :timestamp
         attribute :alert_is_json, :boolean
+        attribute :sound_is_json, :boolean
         attribute :app_id, :integer
         attribute :collapse_key, :string
         attribute :delay_while_idle, :boolean
@@ -43,6 +44,7 @@ module Rpush
         attribute :url_args, :array
         attribute :category, :string
         attribute :content_available, :boolean, default: false
+        attribute :dry_run, :boolean, default: false
         attribute :mutable_content, :boolean, default: false
         attribute :notification, :hash
         attribute :thread_id, :string

data/lib/rpush/client/redis/pushy/notification.rb

@@ -9,7 +9,6 @@ module Rpush
 
           def time_to_live=(value)
             self.expiry = value
-            super
           end
         end
       end

data/lib/rpush/daemon.rb

@@ -109,7 +109,7 @@ module Rpush
         Feeder.stop
         AppRunner.stop
         delete_pid_file
-        puts ANSI.green { '✔' } if Rpush.config.foreground
+        puts Rainbow('✔').red if Rpush.config.foreground
       end
     end
 
@@ -168,7 +168,7 @@ module Rpush
       if Rpush::Daemon::AppRunner.app_ids.count == 0
         puts <<-EOS
 
-* #{ANSI.green { 'Is this your first time using Rpush?' }}
+* #{Rainbow('Is this your first time using Rpush?').green}
   You need to create an App before you can start using Rpush.
   Please refer to the documentation at https://github.com/rpush/rpush
 

data/lib/rpush/daemon/apns/feedback_receiver.rb

@@ -24,6 +24,7 @@ module Rpush
 
         def start
           return if Rpush.config.push
+          return unless @app.feedback_enabled
           Rpush.logger.info("[#{@app.name}] Starting feedback receiver... ", true)
 
           @thread = Thread.new do
@@ -36,7 +37,7 @@ module Rpush
             Rpush::Daemon.store.release_connection
           end
 
-          puts ANSI.green { '✔' } if Rpush.config.foreground
+          puts Rainbow('✔').green if Rpush.config.foreground
         end
 
         def stop

data/lib/rpush/daemon/apns2/delivery.rb

@@ -7,6 +7,7 @@ module Rpush
 
       class Delivery < Rpush::Daemon::Delivery
         RETRYABLE_CODES = [ 429, 500, 503 ]
+        CLIENT_JOIN_TIMEOUT = 60
 
         def initialize(app, http2_client, batch)
           @app = app
@@ -20,7 +21,11 @@ module Rpush
           end
 
           # Send all preprocessed requests at once
-          @client.join
+          @client.join(timeout: CLIENT_JOIN_TIMEOUT)
+        rescue NetHttp2::AsyncRequestTimeout => error
+          mark_batch_retryable(Time.now + 10.seconds, error)
+          @client.close
+          raise
         rescue Errno::ECONNREFUSED, SocketError => error
           mark_batch_retryable(Time.now + 10.seconds, error)
           raise

data/lib/rpush/daemon/apnsp8/delivery.rb

@@ -7,6 +7,7 @@ module Rpush
 
       class Delivery < Rpush::Daemon::Delivery
         RETRYABLE_CODES = [ 429, 500, 503 ]
+        CLIENT_JOIN_TIMEOUT = 60
 
         def initialize(app, http2_client, token_provider, batch)
           @app = app
@@ -22,7 +23,11 @@ module Rpush
           end
 
           # Send all preprocessed requests at once
-          @client.join
+          @client.join(timeout: CLIENT_JOIN_TIMEOUT)
+        rescue NetHttp2::AsyncRequestTimeout => error
+          mark_batch_retryable(Time.now + 10.seconds, error)
+          @client.close
+          raise
         rescue Errno::ECONNREFUSED, SocketError, HTTP2::Error::StreamLimitExceeded => error
           # TODO restart connection when StreamLimitExceeded
           mark_batch_retryable(Time.now + 10.seconds, error)
@@ -133,7 +138,7 @@ module Rpush
           jwt_token = @token_provider.token
 
           headers = {}
-          
+
           headers['content-type'] = 'application/json'
           headers['apns-expiration'] = '0'
           headers['apns-priority'] = '10'

data/lib/rpush/daemon/app_runner.rb

@@ -29,7 +29,7 @@ module Rpush
         Rpush.logger.info("[#{app.name}] Starting #{pluralize(app.connections, 'dispatcher')}... ", true)
         runner = @runners[app.id] = new(app)
         runner.start_dispatchers
-        puts ANSI.green { '✔' } if Rpush.config.foreground
+        puts Rainbow('✔').green if Rpush.config.foreground
         runner.start_loops
       rescue StandardError => e
         @runners.delete(app.id)

data/lib/rpush/daemon/dispatcher/apns_http2.rb

@@ -2,11 +2,13 @@ module Rpush
   module Daemon
     module Dispatcher
       class ApnsHttp2
+        include Loggable
+        include Reflectable
 
         URLS = {
           production: 'https://api.push.apple.com:443',
-          development: 'https://api.development.push.apple.com:443',
-          sandbox: 'https://api.development.push.apple.com:443'
+          development: 'https://api.sandbox.push.apple.com:443',
+          sandbox: 'https://api.sandbox.push.apple.com:443'
         }
 
         DEFAULT_TIMEOUT = 60

data/lib/rpush/daemon/dispatcher/apnsp8_http2.rb

@@ -7,7 +7,8 @@ module Rpush
 
         URLS = {
           production: 'https://api.push.apple.com',
-          development: 'https://api.development.push.apple.com'
+          development: 'https://api.sandbox.push.apple.com',
+          sandbox: 'https://api.sandbox.push.apple.com'
         }
 
         DEFAULT_TIMEOUT = 60

data/lib/rpush/daemon/signal_handler.rb

@@ -29,7 +29,7 @@ module Rpush
 
       def self.start_handler(read_io)
         @thread = Thread.new do
-          while readable_io = IO.select([read_io]) # rubocop:disable AssignmentInCondition
+          while readable_io = IO.select([read_io]) # rubocop:disable Lint/AssignmentInCondition
             signal = readable_io.first[0].gets.strip
 
             begin

data/lib/rpush/daemon/store/active_record.rb

@@ -183,7 +183,7 @@ module Rpush
 
         private
 
-        def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists
+        def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable Metrics/ParameterLists
           with_database_reconnect_and_retry do
             notification.assign_attributes(attrs)
             notification.data = data

data/lib/rpush/daemon/store/active_record/reconnectable.rb

@@ -67,7 +67,7 @@ module Rpush
 
           def check_database_is_connected
             # Simply asking the adapter for the connection state is not sufficient.
-            Rpush::Client::ActiveRecord::Notification.count
+            Rpush::Client::ActiveRecord::Notification.exists?
           end
 
           def sleep_to_avoid_thrashing

data/lib/rpush/daemon/store/redis.rb

@@ -138,7 +138,7 @@ module Rpush
           nil
         end
 
-        def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists
+        def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable Metrics/ParameterLists
           notification.assign_attributes(attrs)
           notification.data = data
           notification.registration_ids = registration_ids

data/lib/rpush/daemon/wns/badge_request.rb

@@ -4,14 +4,19 @@ module Rpush
       class BadgeRequest
         def self.create(notification, access_token)
           body = BadgeRequestPayload.new(notification).to_xml
-          uri  = URI.parse(notification.uri)
-          post = Net::HTTP::Post.new(
-            uri.request_uri,
+          uri = URI.parse(notification.uri)
+          headers = {
             "Content-Length" => body.length.to_s,
             "Content-Type" => "text/xml",
             "X-WNS-Type" => "wns/badge",
             "X-WNS-RequestForStatus" => "true",
             "Authorization" => "Bearer #{access_token}"
+          }
+          headers['X-WNS-PRIORITY'] = notification.priority.to_s if notification.priority
+
+          post = Net::HTTP::Post.new(
+            uri.request_uri,
+            headers
           )
           post.body = body
           post

data/lib/rpush/daemon/wns/raw_request.rb

@@ -5,14 +5,21 @@ module Rpush
         def self.create(notification, access_token)
           body = notification.data.to_json
           uri = URI.parse(notification.uri)
-          post = Net::HTTP::Post.new(
-            uri.request_uri,
+          headers = {
             "Content-Length" => body.length.to_s,
             "Content-Type" => "application/octet-stream",
             "X-WNS-Type" => "wns/raw",
             "X-WNS-RequestForStatus" => "true",
             "Authorization" => "Bearer #{access_token}"
+          }
+
+          headers['X-WNS-PRIORITY'] = notification.priority.to_s if notification.priority
+
+          post = Net::HTTP::Post.new(
+            uri.request_uri,
+            headers
           )
+
           post.body = body
           post
         end

data/lib/rpush/daemon/wns/toast_request.rb

@@ -5,13 +5,17 @@ module Rpush
         def self.create(notification, access_token)
           body = ToastRequestPayload.new(notification).to_xml
           uri  = URI.parse(notification.uri)
-          post = Net::HTTP::Post.new(
-            uri.request_uri,
+          headers = {
             "Content-Length" => body.length.to_s,
             "Content-Type" => "text/xml",
             "X-WNS-Type" => "wns/toast",
             "X-WNS-RequestForStatus" => "true",
             "Authorization" => "Bearer #{access_token}"
+          }
+          headers['X-WNS-PRIORITY'] = notification.priority.to_s if notification.priority
+          post = Net::HTTP::Post.new(
+            uri.request_uri,
+            headers
           )
           post.body = body
           post

data/lib/rpush/version.rb

@@ -1,8 +1,8 @@
 module Rpush
   module VERSION
-    MAJOR = 4
-    MINOR = 0
-    TINY = 1
+    MAJOR = 5
+    MINOR = 1
+    TINY = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/spec/.rubocop.yml

@@ -1,4 +1,4 @@
 inherit_from: ../.rubocop.yml
 
-RescueModifier:
+Style/RescueModifier:
   Enabled: false

data/spec/functional/apns2_spec.rb

@@ -228,5 +228,41 @@ describe 'APNs http2 adapter' do
         Rpush.push
       end
     end
+
+    context 'when waiting for requests to complete times out' do
+      before(:each) do
+        expect(fake_client).to receive(:join) { raise(NetHttp2::AsyncRequestTimeout) }
+      end
+
+      it 'closes the client' do
+        create_notification
+        expect(fake_client).to receive(:close)
+        Rpush.push
+      end
+
+      it 'reflects :error' do
+        reflected_error = false
+        Rpush.reflect do |on|
+          on.error do |error|
+            reflected_error = true
+            expect(error).to be_kind_of(StandardError)
+            reflector.accept
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+
+        expect(reflected_error).to be true
+      end
+
+      it 'fails but retries delivery several times' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :retries)
+      end
+    end
   end
 end

data/spec/functional/gcm_priority_spec.rb

@@ -0,0 +1,40 @@
+require 'functional_spec_helper'
+
+describe 'GCM priority' do
+  let(:app) { Rpush::Gcm::App.new }
+  let(:notification) { Rpush::Gcm::Notification.new }
+  let(:hydrated_notification) { Rpush::Gcm::Notification.find(notification.id) }
+  let(:response) { double(Net::HTTPResponse, code: 200) }
+  let(:http) { double(Net::HTTP::Persistent, request: response, shutdown: nil) }
+  let(:priority) { 'normal' }
+
+  before do
+    app.name = 'test'
+    app.auth_key = 'abc123'
+    app.save!
+
+    notification.app_id = app.id
+    notification.registration_ids = ['foo']
+    notification.data = { message: 'test' }
+    notification.priority = priority
+    notification.save!
+
+    allow(Net::HTTP::Persistent).to receive_messages(new: http)
+  end
+
+  it 'supports normal priority' do
+    expect(hydrated_notification.as_json['priority']).to eq('normal')
+  end
+
+  context 'high priority' do
+    let(:priority) { 'high' }
+
+    it 'supports high priority' do
+      expect(hydrated_notification.as_json['priority']).to eq('high')
+    end
+  end
+
+  it 'does not add an error when receiving expected priority' do
+    expect(hydrated_notification.errors.messages[:priority]).to be_empty
+  end
+end

data/spec/support/active_record_setup.rb

@@ -39,6 +39,9 @@ require 'generators/templates/rpush_3_2_0_add_apns_p8'
 require 'generators/templates/rpush_3_2_4_updates'
 require 'generators/templates/rpush_3_3_0_updates'
 require 'generators/templates/rpush_3_3_1_updates'
+require 'generators/templates/rpush_4_1_0_updates'
+require 'generators/templates/rpush_4_1_1_updates'
+require 'generators/templates/rpush_4_2_0_updates'
 
 migrations = [
   AddRpush,
@@ -53,7 +56,10 @@ migrations = [
   Rpush320AddApnsP8,
   Rpush324Updates,
   Rpush330Updates,
-  Rpush331Updates
+  Rpush331Updates,
+  Rpush410Updates,
+  Rpush411Updates,
+  Rpush420Updates
 ]
 
 unless ENV['TRAVIS']

data/spec/support/simplecov_helper.rb

@@ -18,7 +18,7 @@ module SimpleCovHelper
         end
       end
 
-      formatter SimpleCov::Formatter::MultiFormatter[*formatters]
+      formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
     end
   end
 end

data/spec/unit/apns_feedback_spec.rb

@@ -1,13 +1,15 @@
 require 'unit_spec_helper'
 
 describe Rpush, 'apns_feedback' do
-  let!(:apns_app) do
-    Rpush::Apns::App.create!(name: 'test', environment: 'production', certificate: TEST_CERT)
-  end
-
-  let!(:gcm_app) do
-    Rpush::Gcm::App.create!(name: 'MyApp', auth_key: 'abc123')
+  let!(:apns_app) { Rpush::Apns::App.create!(apns_app_params) }
+  let(:apns_app_params) do
+    {
+      name: 'test',
+      environment: 'production',
+      certificate: TEST_CERT
+    }
   end
+  let!(:gcm_app) { Rpush::Gcm::App.create!(name: 'MyApp', auth_key: 'abc123') }
 
   let(:receiver) { double(check_for_feedback: nil) }
 
@@ -25,4 +27,13 @@ describe Rpush, 'apns_feedback' do
     expect(receiver).to receive(:check_for_feedback)
     Rpush.apns_feedback
   end
+
+  context 'feedback disabled' do
+    let(:apns_app_params) { super().merge(feedback_enabled: false) }
+
+    it 'does not initialize feedback receiver' do
+      expect(Rpush::Daemon::Apns::FeedbackReceiver).not_to receive(:new)
+      Rpush.apns_feedback
+    end
+  end
 end