action_push_native 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c37771ec586061a95004904931f0ffc841177a104fa27b8f5c9404bdef33bcc8
-  data.tar.gz: d39db792468a2516ce99d9330f0612b1ba1ef1ba194ee0cfa3b4f493164c214e
+  metadata.gz: 597ea29826dc73cb9a6215038924dae218c5b415e754657ea01fa543420eb9ee
+  data.tar.gz: 1a058af0f6d383e2fe3b7ce0832c27f35d6f2e86026adce2871a4394c98644b8
 SHA512:
-  metadata.gz: 761d8d0a9eeb0f4914fa2129dda438958babf02354be17ed87b8264ebd052d10ff73a98723afbeb40c6dc0253de81f26ed37fc93588b3315b08264181cee1554
-  data.tar.gz: b0351f879b5fcf6a244c053bcd375ea4803071ec82d8d56329bd22e4eb7a346f8219f56b34497c27faf705a094490164399df7526dbf04daf89b8d73344d9330
+  metadata.gz: 1d667e9975da93ba1a4e998103af3b5c0258c763d50931e5658c2c76f9d59db85ef43711a87ca8f86d82cb531f7e0cc907d1fed25a22ad4eaa33777f642c73c6
+  data.tar.gz: 6dcb6f3230a3df117044353b2d04b8ce9130e886bde3ab96ef1b93371eb906346d073efaa3185594722d52d32280b6ad4b06e2d476cab23838dcfb7edff9ed65

data/README.md

@@ -75,8 +75,8 @@ shared:
   apple:
     # Token auth params
     # See https://developer.apple.com/documentation/usernotifications/establishing-a-token-based-connection-to-apns
-    key_id: your_key_id
-    encryption_key: your_apple_encryption_key
+    key_id: <%= Rails.application.credentials.dig(:action_push_native, :apns, :key_id) %>
+    encryption_key: <%= Rails.application.credentials.dig(:action_push_native, :apns, :encryption_key)&.dump %>
 
     team_id: your_apple_team_id
     # Your identifier found on https://developer.apple.com/account/resources/identifiers/list
@@ -85,7 +85,7 @@ shared:
   google:
     # Your Firebase project service account credentials
     # See https://firebase.google.com/docs/cloud-messaging/auth-server
-    encryption_key: your_service_account_json_file
+    encryption_key: <%= Rails.application.credentials.dig(:action_push_native, :fcm, :encryption_key)&.dump %>
 
     # Firebase project_id
     project_id: your_project_id
@@ -130,16 +130,16 @@ shared:
     calendar:
       # Token auth params
       # See https://developer.apple.com/documentation/usernotifications/establishing-a-token-based-connection-to-apns
-      key_id: calendar_key_id
-      encryption_key: calendar_apple_encryption_key
+      key_id: <%= Rails.application.credentials.dig(:action_push_native, :apns, :calendar, :key_id) %>
+      encryption_key: <%= Rails.application.credentials.dig(:action_push_native, :apns, :calendar, :encryption_key)&.dump %>
       # Your identifier found on https://developer.apple.com/account/resources/identifiers/list
       topic: calendar.bundle.identifier
 
     email:
       # Token auth params
       # See https://developer.apple.com/documentation/usernotifications/establishing-a-token-based-connection-to-apns
-      key_id: email_key_id
-      encryption_key: email_apple_encryption_key
+      key_id: <%= Rails.application.credentials.dig(:action_push_native, :apns, :email, :key_id) %>
+      encryption_key: <%= Rails.application.credentials.dig(:action_push_native, :apns, :email, :encryption_key)&.dump %>
       # Your identifier found on https://developer.apple.com/account/resources/identifiers/list
       topic: email.bundle.identifier
 
@@ -147,7 +147,7 @@ shared:
     calendar:
       # Your Firebase project service account credentials
       # See https://firebase.google.com/docs/cloud-messaging/auth-server
-      encryption_key: calendar_service_account_json_file
+      encryption_key: <%= Rails.application.credentials.dig(:action_push_native, :fcm, :calendar, :encryption_key)&.dump %>
 
       # Firebase project_id
       project_id: calendar_project_id
@@ -155,7 +155,7 @@ shared:
     email:
       # Your Firebase project service account credentials
       # See https://firebase.google.com/docs/cloud-messaging/auth-server
-      encryption_key: email_service_account_json_file
+      encryption_key: <%= Rails.application.credentials.dig(:action_push_native, :fcm, :email, :encryption_key)&.dump %>
 
       # Firebase project_id
       project_id: email_project_id
@@ -212,7 +212,7 @@ You can use `with_apple` for Apple and `with_google` for Google:
 
 ```ruby
 notification = ApplicationPushNotification
-  .with_apple(category: "observable")
+  .with_apple(aps: { category: "observable", "thread-id": "greeting"}, "apns-priority": "1")
   .with_google(data: { badge: 1 })
   .new(title: "Hello world!")
 ```
@@ -234,7 +234,7 @@ and `body`.
 You can create a silent notification via the `silent` method:
 
 ```ruby
-notification = ApplicationPushNotification.silent.with_data(id: 1)
+notification = ApplicationPushNotification.silent.with_data(id: 1).new
 ```
 
 This will create a silent notification for both Apple and Google platforms and sets an application
@@ -271,7 +271,7 @@ by adding extra arguments to the notification constructor:
   data = { calendar_id: @calendar.id, identity_id: @identity.id }
 
   notification = CalendarPushNotification
-    .with_apple(custom_payload: data)
+    .with_apple(data)
     .with_google(data: data)
     .new(calendar_id: 123)
 
@@ -311,7 +311,7 @@ end
 | :sound           | The sound to play when the notification is received.
 | :high_priority   | Whether the notification should be sent with high priority (default: true).
 | :google_data     | The Google-specific payload for the notification.
-| :apple_data      | The Apple-specific payload for the notification.
+| :apple_data      | The Apple-specific payload for the notification. It can also be used to override APNs request headers, such as `apns-push-type`, `apns-priority`, etc.
 | :data            | The data payload for the notification, sent to all platforms.
 | **               | Any additional attributes passed to the constructor will be merged in the `context` hash.
 
@@ -320,7 +320,7 @@ end
 | Name           | Description
 |------------------|------------
 | :with_apple           | Set the Apple-specific payload for the notification.
-| :with_google          | Set the Google-specific payload for the notification.
+| :with_google          | Set the Google-specific payload for the notification. It can also be used to override APNs request headers, such as `apns-push-type`, `apns-priority`, etc.
 | :with_data            | Set the data payload for the notification, sent to all platforms.
 | :silent               | Create a silent notification that does not trigger a visual alert on the device.
 

data/app/jobs/action_push_native/notification_job.rb

@@ -40,7 +40,7 @@ module ActionPushNative
 
     with_options retry_options do
       retry_on TimeoutError, wait: 1.minute
-      retry_on ConnectionError, ConnectionPool::TimeoutError, attempts: 20
+      retry_on ConnectionError, HTTPX::PoolTimeoutError, attempts: 20
 
       # Altough unexpected, these are short-lived errors that can be retried most of the times.
       retry_on ForbiddenError, BadRequestError

data/lib/action_push_native/configured_notification.rb

@@ -16,7 +16,7 @@ module ActionPushNative
 
     def silent
       @options = options.merge(high_priority: false)
-      with_apple(content_available: 1)
+      with_apple(aps: { "content-available": 1 })
     end
 
     def with_apple(apple_data)

data/lib/action_push_native/service/apns/apnotic_legacy_converter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Converts the legacy `apple_data` format from the Apnotic gem
+# to the new format expected by the APNs API.
+#
+# Temporary compatibility layer: It will be removed in the next release.
+class ActionPushNative::Service::Apns::ApnoticLegacyConverter
+  APS_FIELDS = %i[
+    alert badge sound content_available category url_args mutable_content thread_id
+    target_content_id interruption_level relevance_score
+    stale_date content_state timestamp event dismissal_date
+  ].freeze
+  APNS_HEADERS = %i[ expiration priority topic push_type ]
+
+  def self.convert(apple_data)
+    apple_data.each_with_object({}) do |(key, value), converted|
+      if key.in?(APS_FIELDS)
+        converted[:aps] ||= {}
+        converted_key = key.to_s.dasherize.to_sym
+        converted[:aps][converted_key] = value
+        ActionPushNative.deprecator.warn("Passing the `#{key}` field directly is deprecated. Please use `.with_apple(aps: { \"#{converted_key}\": ... })` instead.")
+      elsif key.in?(APNS_HEADERS)
+        converted_key = "apns-#{key.to_s.dasherize}".to_sym
+        converted[converted_key] = value
+        ActionPushNative.deprecator.warn("Passing the `#{key}` header directly is deprecated. Please use `.with_apple(\"#{converted_key}\": ...)` instead.")
+      elsif key == :apns_collapse_id
+        converted_key = key.to_s.dasherize.to_sym
+        converted[converted_key] = value
+        ActionPushNative.deprecator.warn("Passing the `#{key}` header directly is deprecated. Please use `.with_apple(\"#{converted_key}\": ...)` instead.")
+      elsif key == :custom_payload
+        converted.merge!(value)
+        ActionPushNative.deprecator.warn("Passing `custom_payload` is deprecated. Please use `.with_apple(#{value})` instead.")
+      else
+        converted[key] = value
+      end
+    end
+  end
+end

data/lib/action_push_native/service/apns/httpx_session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class ActionPushNative::Service::Apns::HttpxSession
+  DEFAULT_POOL_SIZE       = 5
+  DEFAULT_REQUEST_TIMEOUT = 30.seconds
+  DEVELOPMENT_SERVER_URL  = "https://api.sandbox.push.apple.com:443"
+  PRODUCTION_SERVER_URL   = "https://api.push.apple.com:443"
+
+  def initialize(config)
+    @session = \
+      HTTPX.
+        plugin(:persistent, close_on_fork: true).
+        with(pool_options: { max_connections: config[:connection_pool_size] || DEFAULT_POOL_SIZE }).
+        with(timeout: { request_timeout: config[:request_timeout] || DEFAULT_REQUEST_TIMEOUT }).
+        with(origin: config[:connect_to_development_server] ? DEVELOPMENT_SERVER_URL : PRODUCTION_SERVER_URL)
+    @token_provider = ActionPushNative::Service::Apns::TokenProvider.new(config)
+  end
+
+  def post(*uri, **options)
+    options[:headers][:authorization] = "Bearer #{token_provider.fresh_access_token}"
+    session.post(*uri, **options)
+  end
+
+  private
+    attr_reader :token_provider, :session
+end

data/lib/action_push_native/service/apns/token_provider.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class ActionPushNative::Service::Apns::TokenProvider
+  EXPIRED = -1
+
+  def initialize(config)
+    @config = config
+    @expires_at = EXPIRED
+  end
+
+  def fresh_access_token
+    regenerate_if_expired
+    token
+  end
+
+  private
+    attr_reader :config, :token, :expires_at
+
+    # See https://developer.apple.com/documentation/usernotifications/establishing-a-token-based-connection-to-apns#Refresh-your-token-regularly
+    def regenerate_if_expired
+      if Time.now.utc >= expires_at
+        @expires_at = 30.minutes.from_now.utc
+        @token = generate
+      end
+    end
+
+    def generate
+      payload = { iss: config.fetch(:team_id), iat: Time.now.utc.to_i }
+      header  = { kid: config.fetch(:key_id) }
+      private_key = OpenSSL::PKey::EC.new(config.fetch(:encryption_key))
+      JWT.encode(payload, private_key, "ES256", header)
+    end
+end

data/lib/action_push_native/service/apns.rb

@@ -3,118 +3,99 @@
 module ActionPushNative
   module Service
     class Apns
-      DEFAULT_TIMEOUT   = 30.seconds
-      DEFAULT_POOL_SIZE = 5
+      include NetworkErrorHandling
+
+      # Per-application HTTPX session
+      cattr_accessor :httpx_sessions
 
       def initialize(config)
         @config = config
       end
 
-      # Per-application connection pools
-      cattr_accessor :connection_pools
-
       def push(notification)
-        reset_connection_error
-
-        connection_pool.with do |connection|
-          rescue_and_reraise_network_errors do
-            apnotic_notification = apnotic_notification_from(notification)
-            Rails.logger.info("Pushing APNs notification: #{apnotic_notification.apns_id}")
-
-            response = connection.push \
-              apnotic_notification,
-              timeout: config[:request_timeout] || DEFAULT_TIMEOUT
-            raise connection_error if connection_error
-            handle_response_error(response) unless response&.ok?
-          end
-        end
+        notification.apple_data = ApnoticLegacyConverter.convert(notification.apple_data) if notification.apple_data.present?
+
+        headers, payload = headers_from(notification), payload_from(notification)
+        Rails.logger.info("Pushing APNs notification: #{headers[:"apns-id"]}")
+        response = httpx_session.post("3/device/#{notification.token}", json: payload, headers: headers)
+        handle_error(response) if response.error
       end
 
       private
-        attr_reader :config, :connection_error
-
-        def reset_connection_error
-          @connection_error = nil
-        end
+        attr_reader :config
 
-        def connection_pool
-          self.class.connection_pools ||= {}
-          self.class.connection_pools[config] ||= build_connection_pool
+        PRIORITIES = { high: 10, normal: 5 }.freeze
+        HEADERS = %i[ apns-id apns-push-type apns-priority apns-topic apns-expiration apns-collapse-id ].freeze
+
+        def headers_from(notification)
+          push_type = notification.apple_data&.dig(:aps, :"content-available") == 1 ? "background" : "alert"
+          custom_apple_headers = notification.apple_data&.slice(*HEADERS) || {}
+
+          {
+            "apns-push-type": push_type,
+            "apns-id": SecureRandom.uuid,
+            "apns-priority": notification.high_priority ? PRIORITIES[:high] : PRIORITIES[:normal],
+            "apns-topic": config.fetch(:topic)
+          }.merge(custom_apple_headers).compact
         end
 
-        def build_connection_pool
-          build_method = config[:connect_to_development_server] ? "development" : "new"
-          Apnotic::ConnectionPool.public_send(build_method, {
-            auth_method: :token,
-            cert_path: StringIO.new(config.fetch(:encryption_key)),
-            key_id: config.fetch(:key_id),
-            team_id: config.fetch(:team_id)
-          }, size: config[:connection_pool_size] || DEFAULT_POOL_SIZE) do |connection|
-            # Prevents the main thread from crashing collecting the connection error from the off-thread
-            # and raising it afterwards.
-            connection.on(:error) { |error| @connection_error = error }
-          end
+        def payload_from(notification)
+          payload = \
+            {
+              aps: {
+                alert: { title: notification.title, body: notification.body },
+                badge: notification.badge,
+                "thread-id": notification.thread_id,
+                sound: notification.sound
+              }
+            }
+
+          payload = payload.merge notification.data if notification.data.present?
+          custom_apple_payload = notification.apple_data&.except(*HEADERS) || {}
+          payload = payload.deep_merge custom_apple_payload
+
+          payload.dig(:aps, :alert)&.compact!
+          payload[:aps]&.compact_blank!
+          payload.compact
         end
 
-        def rescue_and_reraise_network_errors
-          begin
-            yield
-          rescue Errno::ETIMEDOUT => e
-            raise ActionPushNative::TimeoutError, e.message
-          rescue Errno::ECONNRESET, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError => e
-            raise ActionPushNative::ConnectionError, e.message
-          rescue OpenSSL::SSL::SSLError => e
-            if e.message.include?("SSL_connect")
-              raise ActionPushNative::ConnectionError, e.message
-            else
-              raise
-            end
-          end
+        def httpx_session
+          self.class.httpx_sessions ||= {}
+          self.class.httpx_sessions[config] ||= HttpxSession.new(config)
         end
 
-        PRIORITIES = { high: 10, normal: 5 }.freeze
-
-        def apnotic_notification_from(notification)
-          Apnotic::Notification.new(notification.token).tap do |n|
-            n.topic = config.fetch(:topic)
-            n.alert = { title: notification.title, body: notification.body }.compact
-            n.badge = notification.badge
-            n.thread_id = notification.thread_id
-            n.sound = notification.sound
-            n.priority = notification.high_priority ? PRIORITIES[:high] : PRIORITIES[:normal]
-            n.custom_payload = notification.data
-            notification.apple_data&.each do |key, value|
-              n.public_send("#{key.to_s.underscore}=", value)
-            end
+        def handle_error(response)
+          if response.is_a?(HTTPX::ErrorResponse)
+            handle_network_error(response.error)
+          else
+            handle_apns_error(response)
           end
         end
 
-        def handle_response_error(response)
-          code = response&.status
-          reason = response.body["reason"] if response
+        def handle_apns_error(response)
+          status = response.status
+          reason = JSON.parse(response.body.to_s)["reason"] unless response.body.empty?
 
-          Rails.logger.error("APNs response error #{code}: #{reason}") if reason
+          Rails.logger.error("APNs response error #{status}: #{reason}") if reason
 
-          case [ code, reason ]
-          in [ nil, _ ]
-            raise ActionPushNative::TimeoutError
-          in [ "400", "BadDeviceToken" ]
+          case [ status, reason ]
+          in [ 400, "BadDeviceToken" ]
             raise ActionPushNative::TokenError, reason
-          in [ "400", "DeviceTokenNotForTopic" ]
+          in [ 400, "DeviceTokenNotForTopic" ]
             raise ActionPushNative::BadDeviceTopicError, reason
-          in [ "400", _ ]
+          in [ 400, _ ]
             raise ActionPushNative::BadRequestError, reason
-          in [ "403", _ ]
+          in [ 403, _ ]
             raise ActionPushNative::ForbiddenError, reason
-          in [ "404", _ ]
+          in [ 404, _ ]
             raise ActionPushNative::NotFoundError, reason
-          in [ "410", _ ]
+          in [ 410, _ ]
             raise ActionPushNative::TokenError, reason
-          in [ "413", _ ]
+          in [ 413, _ ]
             raise ActionPushNative::PayloadTooLargeError, reason
-          in [ "429", _ ]
+          in [ 429, _ ]
             raise ActionPushNative::TooManyRequestsError, reason
-          in [ "503", _ ]
+          in [ 503, _ ]
             raise ActionPushNative::ServiceUnavailableError, reason
           else
             raise ActionPushNative::InternalServerError, reason

data/lib/action_push_native/service/fcm/httpx_session.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class ActionPushNative::Service::Fcm::HttpxSession
+  # FCM suggests at least a 10s timeout for requests, we set 15 to add some buffer.
+  # https://firebase.google.com/docs/cloud-messaging/scale-fcm#timeouts
+  DEFAULT_REQUEST_TIMEOUT = 15.seconds
+  DEFAULT_POOL_SIZE       = 5
+
+  def initialize(config)
+    @session = \
+      HTTPX.
+        plugin(:persistent, close_on_fork: true).
+        with(timeout: { request_timeout: config[:request_timeout] || DEFAULT_REQUEST_TIMEOUT }).
+        with(pool_options: { max_connections: config[:connection_pool_size] || DEFAULT_POOL_SIZE }).
+        with(origin: "https://fcm.googleapis.com")
+    @token_provider = ActionPushNative::Service::Fcm::TokenProvider.new(config)
+  end
+
+  def post(*uri, **options)
+    options[:headers] ||= {}
+    options[:headers][:authorization] = "Bearer #{token_provider.fresh_access_token}"
+    session.post(*uri, **options)
+  end
+
+  private
+    attr_reader :token_provider, :session
+end

data/lib/action_push_native/service/fcm/token_provider.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class ActionPushNative::Service::Fcm::TokenProvider
+  EXPIRED = -1
+
+  def initialize(config)
+    @config = config
+    @expires_at = EXPIRED
+  end
+
+  def fresh_access_token
+    regenerate_if_expired
+    token
+  end
+
+  private
+    attr_reader :config, :token, :expires_at
+
+    def regenerate_if_expired
+      regenerate if Time.now.utc >= expires_at
+    end
+
+    REFRESH_BUFFER = 1.minutes
+
+    def regenerate
+      authorizer = Google::Auth::ServiceAccountCredentials.make_creds \
+        json_key_io: StringIO.new(config.fetch(:encryption_key)),
+        scope: "https://www.googleapis.com/auth/firebase.messaging"
+      oauth2 = authorizer.fetch_access_token!
+      @token = oauth2["access_token"]
+      @expires_at = oauth2["expires_in"].seconds.from_now.utc - REFRESH_BUFFER
+    end
+end

data/lib/action_push_native/service/fcm.rb

@@ -3,22 +3,28 @@
 module ActionPushNative
   module Service
     class Fcm
-      # FCM suggests at least a 10s timeout for requests, we set 15 to add some buffer.
-      # https://firebase.google.com/docs/cloud-messaging/scale-fcm#timeouts
-      DEFAULT_TIMEOUT = 15.seconds
+      include NetworkErrorHandling
+
+      # Per-application HTTPX session
+      cattr_accessor :httpx_sessions
 
       def initialize(config)
         @config = config
       end
 
       def push(notification)
-        response = post_request payload_from(notification)
-        handle_error(response) unless response.code == "200"
+        response = httpx_session.post("v1/projects/#{config.fetch(:project_id)}/messages:send", json: payload_from(notification))
+        handle_error(response) if response.error
       end
 
       private
         attr_reader :config
 
+        def httpx_session
+          self.class.httpx_sessions ||= {}
+          self.class.httpx_sessions[config] ||= HttpxSession.new(config)
+        end
+
         def payload_from(notification)
           deep_compact({
             message: {
@@ -56,64 +62,37 @@ module ActionPushNative
           hash.compact.transform_values(&:to_s)
         end
 
-        def post_request(payload)
-          uri = URI("https://fcm.googleapis.com/v1/projects/#{config.fetch(:project_id)}/messages:send")
-          request = Net::HTTP::Post.new(uri)
-          request["Authorization"] = "Bearer #{access_token}"
-          request["Content-Type"]  = "application/json"
-          request.body             = payload.to_json
-
-          rescue_and_reraise_network_errors do
-            Net::HTTP.start(uri.host, uri.port, use_ssl: true, read_timeout: config[:request_timeout] || DEFAULT_TIMEOUT) do |http|
-              http.request(request)
-            end
-          end
-        end
-
-        def rescue_and_reraise_network_errors
-          yield
-        rescue Net::ReadTimeout, Net::OpenTimeout => e
-          raise ActionPushNative::TimeoutError, e.message
-        rescue Errno::ECONNRESET, SocketError => e
-          raise ActionPushNative::ConnectionError, e.message
-        rescue OpenSSL::SSL::SSLError => e
-          if e.message.include?("SSL_connect")
-            raise ActionPushNative::ConnectionError, e.message
+        def handle_error(response)
+          if response.is_a?(HTTPX::ErrorResponse)
+            handle_network_error(response.error)
           else
-            raise
+            handle_fcm_error(response)
           end
         end
 
-        def access_token
-          authorizer = Google::Auth::ServiceAccountCredentials.make_creds \
-            json_key_io: StringIO.new(config.fetch(:encryption_key)),
-            scope: "https://www.googleapis.com/auth/firebase.messaging"
-          authorizer.fetch_access_token!["access_token"]
-        end
-
-        def handle_error(response)
-          code = response.code
+        def handle_fcm_error(response)
+          status = response.status
           reason = \
             begin
-              JSON.parse(response.body).dig("error", "message")
+              JSON.parse(response.body.to_s).dig("error", "message")
             rescue JSON::ParserError
-              response.body
+              response.body.to_s
             end
 
-          Rails.logger.error("FCM response error #{code}: #{reason}")
+          Rails.logger.error("FCM response error #{status}: #{reason}")
 
           case
           when reason =~ /message is too big/i
             raise ActionPushNative::PayloadTooLargeError, reason
-          when code == "400"
+          when status == 400
             raise ActionPushNative::BadRequestError, reason
-          when code == "404"
+          when status == 404
             raise ActionPushNative::TokenError, reason
-          when code.in?([ "401", "403" ])
+          when status.in?([ 401, 403 ])
             raise ActionPushNative::ForbiddenError, reason
-          when code == "429"
+          when status == 429
             raise ActionPushNative::TooManyRequestsError, reason
-          when code == "503"
+          when status == 503
             raise ActionPushNative::ServiceUnavailableError, reason
           else
             raise ActionPushNative::InternalServerError, reason

data/lib/action_push_native/service/network_error_handling.rb

@@ -0,0 +1,20 @@
+module ActionPushNative::Service::NetworkErrorHandling
+  private
+
+  def handle_network_error(error)
+    case error
+    when Errno::ETIMEDOUT, HTTPX::TimeoutError
+      raise ActionPushNative::TimeoutError, error.message
+    when Errno::ECONNRESET, Errno::ECONNABORTED, Errno::ECONNREFUSED, Errno::EHOSTUNREACH,
+      SocketError, IOError, EOFError, Errno::EPIPE, Errno::EINVAL, HTTPX::ConnectionError,
+      HTTPX::TLSError, HTTPX::Connection::HTTP2::Error
+      raise ActionPushNative::ConnectionError, error.message
+    when OpenSSL::SSL::SSLError
+      if error.message.include?("SSL_connect")
+        raise ActionPushNative::ConnectionError, error.message
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/action_push_native/version.rb

@@ -1,3 +1,3 @@
 module ActionPushNative
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/action_push_native.rb

@@ -3,9 +3,9 @@
 require "zeitwerk"
 require "action_push_native/engine"
 require "action_push_native/errors"
-require "net/http"
-require "apnotic"
+require "httpx"
 require "googleauth"
+require "jwt"
 
 loader= Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.ignore("#{__dir__}/generators")
@@ -37,4 +37,8 @@ module ActionPushNative
       platform_config
     end
   end
+
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new
+  end
 end

data/lib/generators/action_push_native/install/templates/config/push.yml.tt

@@ -1,16 +1,17 @@
 shared:
+  # Use bin/rails credentials:edit to set the apns secrets (as action_push_native:apns:key_id|encryption_key)
   apple:
     # Token auth params
     # See https://developer.apple.com/documentation/usernotifications/establishing-a-token-based-connection-to-apns
-    key_id: your_key_id
-    encryption_key: your_apple_encryption_key
+    key_id: <%%= Rails.application.credentials.dig(:action_push_native, :apns, :key_id) %>
+    encryption_key: <%%= Rails.application.credentials.dig(:action_push_native, :apns, :encryption_key)&.dump %>
 
     team_id: your_apple_team_id
     # Your identifier found on https://developer.apple.com/account/resources/identifiers/list
     topic: your.bundle.identifier
 
     # Set this to the number of threads used to process notifications (default: 5).
-    # When the pool size is too small a ConnectionPool::TimeoutError error will be raised.
+    # When the pool size is too small a HTTPX::PoolTimeoutError error will be raised.
     # connection_pool_size: 5
 
     # Change the request timeout (default: 30).
@@ -20,15 +21,20 @@ shared:
     # Please note that anything built directly from Xcode and loaded on your phone will have
     # the app generate DEVELOPMENT tokens, while everything else (TestFlight, Apple Store, ...)
     # will be considered as PRODUCTION environment.
-    # connect_to_development_server: <%# Rails.env.development? %>
+    # connect_to_development_server: <%%# Rails.env.development? %>
 
+  # Use bin/rails credentials:edit to set the fcm secrets (as action_push_native:fcm:encryption_key)
   google:
     # Your Firebase project service account credentials
     # See https://firebase.google.com/docs/cloud-messaging/auth-server
-    encryption_key: your_service_account_json_file
+    encryption_key: <%%= Rails.application.credentials.dig(:action_push_native, :fcm, :encryption_key)&.dump %>
 
     # Firebase project_id
     project_id: your_project_id
 
+    # Set this to the number of threads used to process notifications (default: 5).
+    # When the pool size is too small a HTTPX::PoolTimeoutError error will be raised.
+    # connection_pool_size: 5
+
     # Change the request timeout (default: 15).
     # request_timeout: 30

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_push_native
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jacopo Beschi
@@ -52,47 +52,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: apnotic
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: googleauth
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: net-http
+  name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.14'
 description: Send push notifications to mobile apps
 email:
 - jacopo@37signals.com
@@ -112,7 +112,13 @@ files:
 - lib/action_push_native/errors.rb
 - lib/action_push_native/notification.rb
 - lib/action_push_native/service/apns.rb
+- lib/action_push_native/service/apns/apnotic_legacy_converter.rb
+- lib/action_push_native/service/apns/httpx_session.rb
+- lib/action_push_native/service/apns/token_provider.rb
 - lib/action_push_native/service/fcm.rb
+- lib/action_push_native/service/fcm/httpx_session.rb
+- lib/action_push_native/service/fcm/token_provider.rb
+- lib/action_push_native/service/network_error_handling.rb
 - lib/action_push_native/version.rb
 - lib/generators/action_push_native/install/install_generator.rb
 - lib/generators/action_push_native/install/templates/app/jobs/application_push_notification_job.rb.tt
@@ -139,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Send push notifications to mobile apps
 test_files: []