rpush 2.7.0 → 3.0.0.rc1

data/lib/rpush/client/active_model.rb

@@ -9,6 +9,9 @@ require 'rpush/client/active_model/apns/device_token_format_validator'
 require 'rpush/client/active_model/apns/app'
 require 'rpush/client/active_model/apns/notification'
 
+require 'rpush/client/active_model/apns2/app'
+require 'rpush/client/active_model/apns2/notification'
+
 require 'rpush/client/active_model/adm/data_validator'
 require 'rpush/client/active_model/adm/app'
 require 'rpush/client/active_model/adm/notification'

data/lib/rpush/client/active_model/apns/notification.rb

@@ -32,6 +32,12 @@ module Rpush
             self.data = (data || {}).merge(MDM_KEY => magic)
           end
 
+          MUTABLE_CONTENT_KEY = '__rpush_mutable_content__'
+          def mutable_content=(bool)
+            return unless bool
+            self.data = (data || {}).merge(MUTABLE_CONTENT_KEY => true)
+          end
+
           CONTENT_AVAILABLE_KEY = '__rpush_content_available__'
           def content_available=(bool)
             return unless bool
@@ -51,12 +57,16 @@ module Rpush
               json['aps']['category'] = category if category
               json['aps']['url-args'] = url_args if url_args
 
+              if data && data[MUTABLE_CONTENT_KEY]
+                json['aps']['mutable-content'] = 1
+              end
+
               if data && data[CONTENT_AVAILABLE_KEY]
                 json['aps']['content-available'] = 1
               end
 
               if data
-                non_aps_attributes = data.reject { |k, _| k == CONTENT_AVAILABLE_KEY }
+                non_aps_attributes = data.reject { |k, _| k == CONTENT_AVAILABLE_KEY || k == MUTABLE_CONTENT_KEY }
                 non_aps_attributes.each { |k, v| json[k.to_s] = v }
               end
             end

data/lib/rpush/client/active_model/apns2/app.rb

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns2
+        module App
+          extend Rpush::Client::ActiveModel::Apns::App
+
+          def service_name
+            'apns2'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns2
+        include Rpush::Client::ActiveModel::Apns
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record.rb

@@ -9,6 +9,9 @@ require 'rpush/client/active_record/apns/notification'
 require 'rpush/client/active_record/apns/feedback'
 require 'rpush/client/active_record/apns/app'
 
+require 'rpush/client/active_record/apns2/notification'
+require 'rpush/client/active_record/apns2/app'
+
 require 'rpush/client/active_record/gcm/notification'
 require 'rpush/client/active_record/gcm/app'
 

data/lib/rpush/client/active_record/apns/feedback.rb

@@ -5,10 +5,6 @@ module Rpush
         class Feedback < ::ActiveRecord::Base
           self.table_name = 'rpush_feedback'
 
-          if Rpush.attr_accessible_available?
-            attr_accessible :device_token, :failed_at, :app_id
-          end
-
           belongs_to :app, class_name: 'Rpush::Client::ActiveRecord::App'
 
           validates :device_token, presence: true

data/lib/rpush/client/active_record/apns2/app.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Apns2
+        class App < Rpush::Client::ActiveRecord::App
+          include Rpush::Client::ActiveModel::Apns2::App
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Apns2
+        class Notification < Rpush::Client::ActiveRecord::Apns::Notification
+        end
+      end
+    end
+  end
+end

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

@@ -4,10 +4,6 @@ module Rpush
       class App < ::ActiveRecord::Base
         self.table_name = 'rpush_apps'
 
-        if Rpush.attr_accessible_available?
-          attr_accessible :name, :environment, :certificate, :password, :connections, :auth_key, :client_id, :client_secret
-        end
-
         has_many :notifications, class_name: 'Rpush::Client::ActiveRecord::Notification', dependent: :destroy
 
         validates :name, presence: true, uniqueness: { scope: [:type, :environment] }

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

@@ -12,13 +12,6 @@ module Rpush
 
         belongs_to :app, class_name: 'Rpush::Client::ActiveRecord::App'
 
-        if Rpush.attr_accessible_available?
-          attr_accessible :badge, :device_token, :sound, :alert, :data, :expiry, :delivered,
-                          :delivered_at, :failed, :failed_at, :error_code, :error_description, :deliver_after,
-                          :alert_is_json, :app, :app_id, :collapse_key, :delay_while_idle, :registration_ids,
-                          :uri, :url_args, :category, :content_available, :notification
-        end
-
         def data=(attrs)
           return unless attrs
           fail ArgumentError, 'must be a Hash' unless attrs.is_a?(Hash)

data/lib/rpush/client/redis.rb

@@ -21,6 +21,9 @@ require 'rpush/client/redis/apns/app'
 require 'rpush/client/redis/apns/notification'
 require 'rpush/client/redis/apns/feedback'
 
+require 'rpush/client/redis/apns2/app'
+require 'rpush/client/redis/apns2/notification'
+
 require 'rpush/client/redis/gcm/app'
 require 'rpush/client/redis/gcm/notification'
 

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

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module Redis
+      module Apns2
+        class App < Rpush::Client::Redis::App
+          include Rpush::Client::ActiveModel::Apns2::App
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module Redis
+      module Apns2
+        class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Apns2::Notification
+        end
+      end
+    end
+  end
+end

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

@@ -43,6 +43,7 @@ module Rpush
         attribute :url_args, :array
         attribute :category, :string
         attribute :content_available, :boolean, default: false
+        attribute :mutable_content, :boolean, default: false
         attribute :notification, :hash
 
         def app

data/lib/rpush/daemon.rb

@@ -24,6 +24,7 @@ require 'rpush/daemon/dispatcher_loop'
 require 'rpush/daemon/dispatcher/http'
 require 'rpush/daemon/dispatcher/tcp'
 require 'rpush/daemon/dispatcher/apns_tcp'
+require 'rpush/daemon/dispatcher/apns_http2'
 require 'rpush/daemon/service_config_methods'
 require 'rpush/daemon/retry_header_parser'
 require 'rpush/daemon/ring_buffer'
@@ -40,6 +41,9 @@ require 'rpush/daemon/apns/delivery'
 require 'rpush/daemon/apns/feedback_receiver'
 require 'rpush/daemon/apns'
 
+require 'rpush/daemon/apns2/delivery'
+require 'rpush/daemon/apns2'
+
 require 'rpush/daemon/gcm/delivery'
 require 'rpush/daemon/gcm'
 
@@ -102,9 +106,7 @@ module Rpush
     end
 
     def self.shutdown_lock
-      return @shutdown_lock if @shutdown_lock
-      @shutdown_lock = Mutex.new
-      @shutdown_lock
+      @shutdown_lock ||= Mutex.new
     end
 
     def self.common_init

data/lib/rpush/daemon/apns2.rb

@@ -0,0 +1,10 @@
+module Rpush
+  module Daemon
+    module Apns2
+      extend ServiceConfigMethods
+
+      batch_deliveries true
+      dispatcher :apns_http2
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+module Rpush
+  module Daemon
+    module Apns2
+      # https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html
+
+      HTTP2_HEADERS_KEY = 'headers'
+
+      class Delivery < Rpush::Daemon::Delivery
+        RETRYABLE_CODES = [ 429, 500, 503 ]
+
+        def initialize(app, http2_client, batch)
+          @app = app
+          @client = http2_client
+          @batch = batch
+        end
+
+        def perform
+          @client.on(:error) { |err| mark_batch_retryable(Time.now + 10.seconds, err) }
+
+          @batch.each_notification do |notification|
+            prepare_async_post(notification)
+          end
+
+          # Send all preprocessed requests at once
+          @client.join
+        rescue Errno::ECONNREFUSED, SocketError => error
+          mark_batch_retryable(Time.now + 10.seconds, error)
+          raise
+        rescue StandardError => error
+          mark_batch_failed(error)
+          raise
+        ensure
+          @batch.all_processed
+        end
+
+        protected
+        ######################################################################
+
+        def prepare_async_post(notification)
+          response = {}
+
+          request = build_request(notification)
+          http_request = @client.prepare_request(:post, request[:path],
+            body:    request[:body],
+            headers: request[:headers]
+          )
+
+          http_request.on(:headers) do |hdrs|
+            response[:code] = hdrs[':status'].to_i
+          end
+
+          http_request.on(:body_chunk) do |body_chunk|
+            next unless body_chunk.present?
+
+            response[:failure_reason] = JSON.parse(body_chunk)['reason']
+          end
+
+          http_request.on(:close) { handle_response(notification, response) }
+
+          @client.call_async(http_request)
+        end
+
+        def handle_response(notification, response)
+          code = response[:code]
+          case code
+          when 200
+            ok(notification)
+          when *RETRYABLE_CODES
+            service_unavailable(notification, response)
+          else
+            reflect(:notification_id_failed,
+              @app,
+              notification.id, code,
+              response[:failure_reason])
+            @batch.mark_failed(notification, response[:code], response[:failure_reason])
+            failed_message_to_log(notification, response)
+          end
+        end
+
+        def ok(notification)
+          log_info("#{notification.id} sent to #{notification.device_token}")
+          @batch.mark_delivered(notification)
+        end
+
+        def service_unavailable(notification, response)
+          @batch.mark_retryable(notification, Time.now + 10.seconds)
+          # Logs should go last as soon as we need to initialize
+          # retry time to display it in log
+          failed_message_to_log(notification, response)
+          retry_message_to_log(notification)
+        end
+
+        def build_request(notification)
+          {
+            path:    "/3/device/#{notification.device_token}",
+            headers: prepare_headers(notification),
+            body:    prepare_body(notification)
+          }
+        end
+
+        def prepare_body(notification)
+          hash = notification.as_json.except(HTTP2_HEADERS_KEY)
+          JSON.dump(hash).force_encoding(Encoding::BINARY)
+        end
+
+        def prepare_headers(notification)
+          notification_data(notification)[HTTP2_HEADERS_KEY] || {}
+        end
+
+        def notification_data(notification)
+          notification.data || {}
+        end
+
+        def retry_message_to_log(notification)
+          log_warn("Notification #{notification.id} will be retried after "\
+            "#{notification.deliver_after.strftime('%Y-%m-%d %H:%M:%S')} "\
+            "(retry #{notification.retries}).")
+        end
+
+        def failed_message_to_log(notification, response)
+          log_error("Notification #{notification.id} failed, "\
+            "#{response[:code]}/#{response[:failure_reason]}")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Rpush
+  module Daemon
+    module Dispatcher
+      class ApnsHttp2
+
+        URLS = {
+          production: 'https://api.push.apple.com:443',
+          development: 'https://api.development.push.apple.com:443'
+        }
+
+        DEFAULT_TIMEOUT = 60
+
+        def initialize(app, delivery_class, _options = {})
+          @app = app
+          @delivery_class = delivery_class
+
+          url = URLS[app.environment.to_sym]
+          @client = NetHttp2::Client.new(url,
+            ssl_context:     prepare_ssl_context,
+            connect_timeout: DEFAULT_TIMEOUT)
+        end
+
+        def dispatch(payload)
+          @delivery_class.new(@app, @client, payload.batch).perform
+        end
+
+        def cleanup
+          @client.close
+        end
+
+        private
+
+        def prepare_ssl_context
+          @ssl_context ||= begin
+            ctx = OpenSSL::SSL::SSLContext.new
+            begin
+              p12      = OpenSSL::PKCS12.new(@app.certificate, @app.password)
+              ctx.key  = p12.key
+              ctx.cert = p12.certificate
+            rescue OpenSSL::PKCS12::PKCS12Error
+              ctx.key  = OpenSSL::PKey::RSA.new(@app.certificate, @app.password)
+              ctx.cert = OpenSSL::X509::Certificate.new(@app.certificate)
+            end
+            ctx
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,7 @@ module Rpush
 
         def cleanup
           if Rpush.config.push
-            # In push mode only a single batch is sent, followed my immediate shutdown.
+            # In push mode only a single batch is sent, followed by immediate shutdown.
             # Allow the error receiver time to handle any errors.
             @reconnect_disabled = true
             sleep 1

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

@@ -5,7 +5,7 @@ module Rpush
         def initialize(app, delivery_class, _options = {})
           @app = app
           @delivery_class = delivery_class
-          @http = Net::HTTP::Persistent.new('rpush')
+          @http = Net::HTTP::Persistent.new(name: 'rpush')
         end
 
         def dispatch(payload)

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

@@ -1,12 +1,12 @@
 module Rpush
   module Daemon
     module Gcm
-      # http://developer.android.com/guide/google/gcm/gcm.html#response
+      # https://firebase.google.com/docs/cloud-messaging/server
       class Delivery < Rpush::Daemon::Delivery
         include MultiJsonHelper
 
-        host = 'https://gcm-http.googleapis.com'
-        GCM_URI = URI.parse("#{host}/gcm/send")
+        host = 'https://fcm.googleapis.com'
+        FCM_URI = URI.parse("#{host}/fcm/send")
         UNAVAILABLE_STATES = %w(Unavailable InternalServerError)
         INVALID_REGISTRATION_ID_STATES = %w(InvalidRegistration MismatchSenderId NotRegistered InvalidPackageName)
 
@@ -142,10 +142,10 @@ module Rpush
         end
 
         def do_post
-          post = Net::HTTP::Post.new(GCM_URI.path, 'Content-Type'  => 'application/json',
+          post = Net::HTTP::Post.new(FCM_URI.path, 'Content-Type'  => 'application/json',
                                                    'Authorization' => "key=#{@notification.app.auth_key}")
           post.body = @notification.as_json.to_json
-          @http.request(GCM_URI, post)
+          @http.request(FCM_URI, post)
         end
       end