rpush 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deccc35a73da0b426daeb20fdbbe287be5e9df9e4b8c8fcd5ef2b69c6663da68
-  data.tar.gz: c7038ba47604bde8a322beff513ab999e1a2692e56bd83b983cb757301e7e590
+  metadata.gz: 2177b25e8710a0539b82b9bade18da563e0b1b1f5509da42be346969a909e83b
+  data.tar.gz: 2c46fec2c2c9858caf0447e2dc5843fae5249edc5b08604141ea3ecbaa95fb5f
 SHA512:
-  metadata.gz: 2a405b20855ef2d3c77f33c842058f95da8c7436a911712e221d5d199af82708dc8b5757f11219d2e31787311f8ea8f25384f85821c806f5492998436770743e
-  data.tar.gz: 4fdfe15b520768b4cbcc24c09c8859fa220fccfe18aed3a00680ff317d70ef95a4503f240262a1bdaf4aa0c4ea10be20478a4d1080e11b9b466458a8a68374c0
+  metadata.gz: c45d7e698704104dc19487636dba80a7278b739a6377d091b334ecedbe90c9b8475f08329e4a767e2ad45d7c3e9981d927558dd21c09e9de7c3cba20fb825993
+  data.tar.gz: 2ae04d72abc05c39c16605f545f78a2a8e829a60a1c6280b68df4e66d28d4c522e47b29ef9b259c18bf2e9b61c90955a686af07582d6426b679c2550851dc16e

data/CHANGELOG.md

@@ -12,8 +12,22 @@
 
 - None
 
+## 3.2.0 (2018-06-13)
+
+When upgrading, don't forget to run `bundle exec rpush init` to get all the latest migrations.
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- Added support for P8 certificate Apple push notifications [#386](https://github.com/rpush/rpush/pull/386) (by [@mariannegru](https://github.com/mariannegru)
+
 ## 3.1.1 (2018-04-16)
 
+When upgrading, don't forget to run `bundle exec rpush init` to get all the latest migrations.
+
 ### Breaking Changes
 
 - None

data/README.md

@@ -80,10 +80,34 @@ You should also implement the [ssl_certificate_will_expire](https://github.com/r
 
 To use the newer APNs Api replace `Rpush::Apns::App` with `Rpush::Apns2::App`.
 
+To use the p8 APNs Api replace `Rpush::Apns::App` with `Rpush::Apnsp8::App`.
+
+```ruby
+app = Rpush::Apnsp8::App.new
+app.name = "ios_app"
+app.apn_key = File.read("/path/to/sandbox.p8")
+app.environment = "development" # APNs environment.
+app.apn_key_id = "APN KEY ID"
+app.team_id = "TEAM ID"
+app.bundle_id = "BUNDLE ID"
+app.connections = 1
+app.save!
+```
+
+```ruby
+n = Rpush::Apns::Notification.new
+n.app = Rpush::Apnsp8::App.find_by_name("ios_app")
+n.device_token = "..." # 64-character hex string
+n.alert = "hi mom!"
+n.data = { foo: :bar }
+n.save!
+```
 #### Firebase Cloud Messaging
 
 FCM and GCM are – as of writing – compatible with each other. See also [this comment](https://github.com/rpush/rpush/issues/284#issuecomment-228330206) for further references.
 
+Please refer to the Firebase Console on where to find your `auth_key` (probably called _Server Key_ there). To verify you have the right key, use tools like [Postman](https://www.getpostman.com/), [HTTPie](https://httpie.org/), `curl` or similar before reporting a new issue. See also [this comment](https://github.com/rpush/rpush/issues/346#issuecomment-289218776).
+
 ```ruby
 app = Rpush::Gcm::App.new
 app.name = "android_app"

data/lib/generators/rpush_migration_generator.rb

@@ -46,6 +46,7 @@ class RpushMigrationGenerator < Rails::Generators::Base
     add_rpush_migration('rpush_3_0_1_updates')
     add_rpush_migration('rpush_3_1_0_add_pushy')
     add_rpush_migration('rpush_3_1_1_updates')
+    add_rpush_migration('rpush_3_2_0_add_apns_p8')
   end
 
   protected

data/lib/generators/templates/rpush_3_2_0_add_apns_p8.rb

@@ -0,0 +1,15 @@
+class Rpush320AddApnsP8 < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_apps, :apn_key, :string, null: true
+    add_column :rpush_apps, :apn_key_id, :string, null: true
+    add_column :rpush_apps, :team_id, :string, null: true
+    add_column :rpush_apps, :bundle_id, :string, null: true
+  end
+
+  def self.down
+    remove_column :rpush_apps, :apn_key
+    remove_column :rpush_apps, :apn_key_id
+    remove_column :rpush_apps, :team_id
+    remove_column :rpush_apps, :bundle_id
+  end
+end

data/lib/rpush.rb

@@ -2,6 +2,7 @@ require 'logger'
 require 'multi_json'
 require 'active_support/all'
 require 'net-http2'
+require 'jwt'
 
 require 'rails'
 

data/lib/rpush/client/active_model.rb

@@ -12,6 +12,9 @@ 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/apnsp8/app'
+require 'rpush/client/active_model/apnsp8/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/apnsp8/app.rb

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apnsp8
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :environment, presence: true, inclusion: { in: %w(development production sandbox) }
+              validates :apn_key, presence: true
+              validates :apn_key_id, presence: true
+              validates :team_id, presence: true
+              validates :bundle_id, presence: true
+            end
+          end
+
+          def service_name
+            'apnsp8'
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/rpush/client/active_record.rb

@@ -12,6 +12,9 @@ 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/apnsp8/notification'
+require 'rpush/client/active_record/apnsp8/app'
+
 require 'rpush/client/active_record/gcm/notification'
 require 'rpush/client/active_record/gcm/app'
 

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

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

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

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

data/lib/rpush/client/redis.rb

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

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

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

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

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

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

@@ -14,7 +14,11 @@ module Rpush
         attribute :client_id, :string
         attribute :client_secret, :string
         attribute :api_key, :string
-
+        attribute :apn_key, :string
+        attribute :apn_key_id, :string
+        attribute :team_id, :string
+        attribute :bundle_id, :string
+ 
         index :name
 
         validates :name, presence: true

data/lib/rpush/daemon.rb

@@ -25,6 +25,7 @@ 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/dispatcher/apnsp8_http2'
 require 'rpush/daemon/service_config_methods'
 require 'rpush/daemon/retry_header_parser'
 require 'rpush/daemon/ring_buffer'
@@ -44,6 +45,10 @@ require 'rpush/daemon/apns'
 require 'rpush/daemon/apns2/delivery'
 require 'rpush/daemon/apns2'
 
+require 'rpush/daemon/apnsp8/delivery'
+require 'rpush/daemon/apnsp8/token'
+require 'rpush/daemon/apnsp8'
+
 require 'rpush/daemon/gcm/delivery'
 require 'rpush/daemon/gcm'
 

data/lib/rpush/daemon/apnsp8.rb

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

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

@@ -0,0 +1,166 @@
+module Rpush
+  module Daemon
+    module Apnsp8
+      # 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, token_provider, batch)
+          @app = app
+          @client = http2_client
+          @batch = batch
+          @first_push = true
+          @token_provider = token_provider
+        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, HTTP2::Error::StreamLimitExceeded => error
+          # TODO restart connection when StreamLimitExceeded
+          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)
+          log_warn(request)
+          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) }
+
+          if @first_push
+            @first_push = false
+            @client.call_async(http_request)
+          else
+            delayed_push_async(http_request)
+          end
+        end
+
+        def delayed_push_async(http_request)
+          until streams_available? do
+            sleep 0.001
+          end
+          @client.call_async(http_request)
+        end
+
+        def streams_available?
+          remote_max_concurrent_streams - @client.stream_count > 0
+        end
+
+        def remote_max_concurrent_streams
+          # 0x7fffffff is the default value from http-2 gem (2^31)
+          if @client.remote_settings[:settings_max_concurrent_streams] == 0x7fffffff
+            0
+          else
+            @client.remote_settings[:settings_max_concurrent_streams]
+          end
+        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)
+          jwt_token = @token_provider.token
+
+          headers = {}
+          
+          headers['content-type'] = 'application/json'
+          headers['apns-expiration'] = '0'
+          headers['apns-priority'] = '10'
+          headers['apns-topic'] = @app.bundle_id
+          headers['authorization'] = "bearer #{jwt_token}"
+
+          headers.merge 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/apnsp8/token.rb

@@ -0,0 +1,33 @@
+module Rpush
+  module Daemon
+    module Apnsp8
+      TOKEN_TTL = 30 * 60
+      class Token
+
+        def initialize(app)
+          @app = app
+        end
+
+        def token
+          if @cached_token && !expired_token?
+            @cached_token
+          else
+            new_token
+          end
+        end
+        
+        private
+
+        def new_token
+          @cached_token_at = Time.now
+          ec_key = OpenSSL::PKey::EC.new(@app.apn_key)
+          @cached_token = JWT.encode({iss: @app.team_id, iat: Time.now.to_i}, ec_key, 'ES256', {alg: 'ES256', kid: @app.apn_key_id})
+        end
+
+        def expired_token?
+          Time.now - @cached_token_at >= TOKEN_TTL
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Rpush
+  module Daemon
+    module Dispatcher
+      class Apnsp8Http2
+
+        URLS = {
+          production: 'https://api.push.apple.com',
+          development: 'https://api.development.push.apple.com'
+        }
+
+        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, connect_timeout: DEFAULT_TIMEOUT)
+          @token_provider = Rpush::Daemon::Apnsp8::Token.new(@app)
+        end
+
+        def dispatch(payload)
+
+          @delivery_class.new(@app, @client, @token_provider, payload.batch).perform
+        end
+
+        def cleanup
+          @client.close
+        end
+      end
+    end
+  end
+end

data/lib/rpush/daemon/service_config_methods.rb

@@ -5,7 +5,8 @@ module Rpush
         http:       Rpush::Daemon::Dispatcher::Http,
         tcp:        Rpush::Daemon::Dispatcher::Tcp,
         apns_tcp:   Rpush::Daemon::Dispatcher::ApnsTcp,
-        apns_http2: Rpush::Daemon::Dispatcher::ApnsHttp2
+        apns_http2: Rpush::Daemon::Dispatcher::ApnsHttp2,
+        apnsp8_http2: Rpush::Daemon::Dispatcher::Apnsp8Http2
       }
 
       def batch_deliveries(value = nil)

data/lib/rpush/version.rb

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

data/spec/support/active_record_setup.rb

@@ -35,6 +35,7 @@ require 'generators/templates/rpush_3_0_0_updates'
 require 'generators/templates/rpush_3_0_1_updates'
 require 'generators/templates/rpush_3_1_0_add_pushy'
 require 'generators/templates/rpush_3_1_1_updates'
+require 'generators/templates/rpush_3_2_0_add_apns_p8'
 
 migrations = [
   AddRpush,
@@ -45,7 +46,8 @@ migrations = [
   Rpush300Updates,
   Rpush301Updates,
   Rpush310AddPushy,
-  Rpush311Updates
+  Rpush311Updates,
+  Rpush320AddApnsP8
 ]
 
 unless ENV['TRAVIS']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -372,6 +386,7 @@ files:
 - lib/generators/templates/rpush_3_0_1_updates.rb
 - lib/generators/templates/rpush_3_1_0_add_pushy.rb
 - lib/generators/templates/rpush_3_1_1_updates.rb
+- lib/generators/templates/rpush_3_2_0_add_apns_p8.rb
 - lib/rpush.rb
 - lib/rpush/apns_feedback.rb
 - lib/rpush/cli.rb
@@ -385,6 +400,8 @@ files:
 - lib/rpush/client/active_model/apns/notification.rb
 - lib/rpush/client/active_model/apns2/app.rb
 - lib/rpush/client/active_model/apns2/notification.rb
+- lib/rpush/client/active_model/apnsp8/app.rb
+- lib/rpush/client/active_model/apnsp8/notification.rb
 - lib/rpush/client/active_model/gcm/app.rb
 - lib/rpush/client/active_model/gcm/expiry_collapse_key_mutual_inclusion_validator.rb
 - lib/rpush/client/active_model/gcm/notification.rb
@@ -406,6 +423,8 @@ files:
 - lib/rpush/client/active_record/apns/notification.rb
 - lib/rpush/client/active_record/apns2/app.rb
 - lib/rpush/client/active_record/apns2/notification.rb
+- lib/rpush/client/active_record/apnsp8/app.rb
+- lib/rpush/client/active_record/apnsp8/notification.rb
 - lib/rpush/client/active_record/app.rb
 - lib/rpush/client/active_record/gcm/app.rb
 - lib/rpush/client/active_record/gcm/notification.rb
@@ -426,6 +445,8 @@ files:
 - lib/rpush/client/redis/apns/notification.rb
 - lib/rpush/client/redis/apns2/app.rb
 - lib/rpush/client/redis/apns2/notification.rb
+- lib/rpush/client/redis/apnsp8/app.rb
+- lib/rpush/client/redis/apnsp8/notification.rb
 - lib/rpush/client/redis/app.rb
 - lib/rpush/client/redis/gcm/app.rb
 - lib/rpush/client/redis/gcm/notification.rb
@@ -447,6 +468,9 @@ files:
 - lib/rpush/daemon/apns/feedback_receiver.rb
 - lib/rpush/daemon/apns2.rb
 - lib/rpush/daemon/apns2/delivery.rb
+- lib/rpush/daemon/apnsp8.rb
+- lib/rpush/daemon/apnsp8/delivery.rb
+- lib/rpush/daemon/apnsp8/token.rb
 - lib/rpush/daemon/app_runner.rb
 - lib/rpush/daemon/batch.rb
 - lib/rpush/daemon/constants.rb
@@ -454,6 +478,7 @@ files:
 - lib/rpush/daemon/delivery_error.rb
 - lib/rpush/daemon/dispatcher/apns_http2.rb
 - lib/rpush/daemon/dispatcher/apns_tcp.rb
+- lib/rpush/daemon/dispatcher/apnsp8_http2.rb
 - lib/rpush/daemon/dispatcher/http.rb
 - lib/rpush/daemon/dispatcher/tcp.rb
 - lib/rpush/daemon/dispatcher_loop.rb