1.7 upstream refresh

.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

README.md

@@ -86,7 +86,7 @@ end
 connection.push_async(push)
 
 # wait for all requests to be completed
-connection.join
+connection.join(timeout: 5)
 
 # close the connection
 connection.close
@@ -201,12 +201,19 @@ To create a new persistent connection:
 Apnotic::Connection.new(options)
 ```
 
-| Option | Description
-|-----|-----
-| :cert_path | Required. The path to a valid APNS push certificate in `.pem` or `.p12` format, or any object that responds to `:read`.
-| :cert_pass | Optional. The certificate's password.
-| :url | Optional. Defaults to https://api.push.apple.com:443.
-| :connect_timeout | Optional. Expressed in seconds, defaults to 30.
+| Option           | Description
+|------------------|------------
+| :cert_path       | `Required` The path to a valid APNS push certificate or any object that responds to `:read`. Supported formats: `.pem`, `.p12` (`:cert` auth), or `.p8` (`:token` auth).
+| :cert_pass       | `Optional` The certificate's password.
+| :auth_method     | `Optional` The options are `:cert` or `:token`. Defaults to `:cert`.
+| :team_id         | `Required for :token auth` Team ID from [Membership Details](https://developer.apple.com/account/#!/membership/).
+| :key_id          | `Required for :token auth` ID from [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/authkeys).
+| :url             | `Optional` Defaults to https://api.push.apple.com:443.
+| :connect_timeout | `Optional` Expressed in seconds, defaults to 30.
+| :proxy_addr      | `Optional` Proxy server. e.g. http://proxy.example.com
+| :proxy_port      | `Optional` Proxy port. e.g. 8080
+| :proxy_user      | `Optional` User name for proxy authentication. e.g. user_name
+| :proxy_pass      | `Optional` Password for proxy authentication. e.g. pass_word
 
 Note that since `:cert_path` can be any object that responds to `:read`, it is possible to pass in a certificate string directly by wrapping it up in a `StringIO` object:
 
@@ -220,47 +227,47 @@ It is also possible to create a connection that points to the Apple Development
 Apnotic::Connection.development(options)
 ```
 
-> The concepts of PRODUCTION and DEVELOPMENT are different from what they used to be in previous specifications. Anything built directly from XCode and loaded on your phone will have the app generate DEVELOPMENT tokens, while everything else (TestFlight, Apple Store, HockeyApp, ...) will be considered as PRODUCTION environment.
+> The concepts of PRODUCTION and DEVELOPMENT are different from what they used to be in previous specifications. Anything built directly from Xcode and loaded on your phone will have the app generate DEVELOPMENT tokens, while everything else (TestFlight, Apple Store, HockeyApp, ...) will be considered as PRODUCTION environment.
 
 #### Methods
 
- * **cert_path** → **`string`**
+- **cert_path** → **`string`**
 
- Returns the path to the certificate.
+    Returns the path to the certificate.
 
- * **on(event, &block)**
+- **on(event, &block)**
 
-Allows to set a callback for the connection. The only available event is `:error`, which allows to set a callback when an error is raised at socket level, hence in the underlying socket thread.
+    Allows to set a callback for the connection. The only available event is `:error`, which allows to set a callback when an error is raised at socket level, hence in the underlying socket thread.
 
-```ruby
-connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
-```
+    ```ruby
+    connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+    ```
 
-> If the `:error` callback is not set, the underlying socket thread may raise an error in the main thread at unexpected execution times.
+    > If the `:error` callback is not set, the underlying socket thread may raise an error in the main thread at unexpected execution times.
 
- * **url** → **`URL`**
+- **url** → **`URL`**
 
- Returns the URL of the APNS endpoint.
+    Returns the URL of the APNS endpoint.
 
 ##### Blocking calls
 
- * **push(notification, timeout: 30)** → **`Apnotic::Response` or `nil`**
+- **push(notification, timeout: 30)** → **`Apnotic::Response` or `nil`**
 
- Sends a notification. Returns `nil` in case a timeout occurs.
+    Sends a notification. Returns `nil` in case a timeout occurs.
 
 ##### Non-blocking calls
 
- * **prepare_push(notification)** → **`Apnotic::Push`**
+- **prepare_push(notification)** → **`Apnotic::Push`**
 
- Prepares an async push.
+    Prepares an async push.
 
- ```ruby
- push = client.prepare_push(notification)
- ```
+    ```ruby
+    push = client.prepare_push(notification)
+    ```
 
- * **push_async(push)**
+- **push_async(push)**
 
-  Sends the push asynchronously.
+    Sends the push asynchronously.
 
 
 ### `Apnotic::ConnectionPool`
@@ -311,6 +318,9 @@ These are all Accessor attributes.
 | `category` | "
 | `custom_payload` | "
 | `thread_id` | "
+| `target_content_id` | "
+| `interruption_level` | Refer to [Payload Key Reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification#2943363) for details. iOS 15+
+| `relevance_score` | Refer to [Payload Key Reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification#2943363) for details. iOS 15+
 | `apns_id` | Refer to [Communicating with APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for details.
 | `expiration` | "
 | `priority` | "
@@ -348,43 +358,43 @@ The response to a call to `connection.push`.
 
 #### Methods
 
- * **body** → **`hash` or `string`**
+-  **body** → **`hash` or `string`**
 
- Returns the body of the response in Hash format if a valid JSON was returned, otherwise just the RAW body.
+    Returns the body of the response in Hash format if a valid JSON was returned, otherwise just the RAW body.
 
-  * **headers** → **`hash`**
+- **headers** → **`hash`**
 
- Returns a Hash containing the Headers of the response.
+    Returns a Hash containing the Headers of the response.
 
- * **ok?** → **`boolean`**
+- **ok?** → **`boolean`**
 
- Returns if the push was successful.
+    Returns if the push was successful.
 
- * **status** → **`string`**
+- **status** → **`string`**
 
-Returns the status code.
+    Returns the status code.
 
 
 ### `Apnotic::Push`
 The push object to be sent in an async call.
 
 #### Methods
 
- * **http2_request**  → **`NetHttp2::Request`**
+- **http2_request**  → **`NetHttp2::Request`**
 
- Returns the HTTP/2 request of the push.
+    Returns the HTTP/2 request of the push.
 
- * **on(event, &block)**
+- **on(event, &block)**
 
- Allows to set a callback for the request. Available events are:
+    Allows to set a callback for the request. Available events are:
 
-  * `:response`: triggered when a response is fully received (called once).
+    `:response`: triggered when a response is fully received (called once).
 
- Even if Apnotic is thread-safe, the async callbacks will be executed in a different thread, so ensure that your code in the callbacks is thread-safe.
+    Even if Apnotic is thread-safe, the async callbacks will be executed in a different thread, so ensure that your code in the callbacks is thread-safe.
 
- ```ruby
- push.on(:response) { |response| p response.headers }
- ```
+    ```ruby
+    push.on(:response) { |response| p response.headers }
+    ```
 
 ## Getting Your APNs Certificate
 

lib/apnotic/abstract_notification.rb

@@ -26,6 +26,10 @@ def authorization_header
       authorization ? "bearer #{authorization}" : nil
     end
 
+    def background_notification?
+      false
+    end
+
     private
 
     def to_hash

lib/apnotic/connection.rb

@@ -5,6 +5,7 @@ module Apnotic
 
   APPLE_DEVELOPMENT_SERVER_URL = "https://api.sandbox.push.apple.com:443"
   APPLE_PRODUCTION_SERVER_URL  = "https://api.push.apple.com:443"
+  PROXY_SETTINGS_KEYS = [:proxy_addr, :proxy_port, :proxy_user, :proxy_pass]
 
   class Connection
     attr_reader :url, :cert_path
@@ -28,7 +29,15 @@ def initialize(options={})
 
       raise "Cert file not found: #{@cert_path}" unless @cert_path && (@cert_path.respond_to?(:read) || File.exist?(@cert_path))
 
-      @client = NetHttp2::Client.new(@url, ssl_context: ssl_context, connect_timeout: @connect_timeout)
+      http2_options = {
+        ssl_context: ssl_context,
+        connect_timeout: @connect_timeout
+      }
+      PROXY_SETTINGS_KEYS.each do |key|
+        http2_options[key] = options[key] if options[key]
+      end
+
+      @client = NetHttp2::Client.new(@url, http2_options)
     end
 
     def push(notification, options={})
@@ -63,8 +72,8 @@ def close
       @client.close
     end
 
-    def join
-      @client.join
+    def join(timeout: nil)
+      @client.join(timeout: timeout)
     end
 
     def on(event, &block)
@@ -92,7 +101,7 @@ def streams_available?
     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
+        1
       else
         @client.remote_settings[:settings_max_concurrent_streams]
       end
@@ -105,6 +114,7 @@ def ssl_context
     def build_ssl_context
       @build_ssl_context ||= begin
         ctx = OpenSSL::SSL::SSLContext.new
+        ctx.security_level = 1 if development? && ctx.respond_to?(:security_level)
         begin
           p12      = OpenSSL::PKCS12.new(certificate, @cert_pass)
           ctx.key  = p12.key
@@ -137,5 +147,8 @@ def provider_token
       @provider_token_cache.call
     end
 
+    def development?
+      url == APPLE_DEVELOPMENT_SERVER_URL
+    end
   end
 end

lib/apnotic/instance_cache.rb

@@ -17,12 +17,16 @@ def call
     private
 
     def expired?
-      Time.now - @cached_at >= @ttl
+      now - @cached_at >= @ttl
     end
 
     def new_value
-      @cached_at = Time.now
+      @cached_at = now
       @cached_value = @instance.send(@method)
     end
+
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
   end
 end

lib/apnotic/notification.rb

@@ -4,6 +4,11 @@ module Apnotic
 
   class Notification < AbstractNotification
     attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :url_args, :mutable_content, :thread_id
+    attr_accessor :target_content_id, :interruption_level, :relevance_score
+
+    def background_notification?
+      aps.count == 1 && aps.key?('content-available') && aps['content-available'] == 1
+    end
 
     private
 
@@ -17,6 +22,9 @@ def aps
         result.merge!('url-args' => url_args) if url_args
         result.merge!('mutable-content' => mutable_content) if mutable_content
         result.merge!('thread-id' => thread_id) if thread_id
+        result.merge!('target-content-id' => target_content_id) if target_content_id
+        result.merge!('interruption-level' => interruption_level) if interruption_level
+        result.merge!('relevance-score' => relevance_score) if relevance_score
       end
     end
 

lib/apnotic/provider_token.rb

@@ -26,7 +26,7 @@ def header
     def payload
       JSON.generate({
         iss: @team_id,
-        iat: Time.now.to_i
+        iat: Time.now.utc.to_i
       })
     end
 

lib/apnotic/request.rb

@@ -17,6 +17,7 @@ def build_headers_for(notification)
       h.merge!('apns-id' => notification.apns_id) if notification.apns_id
       h.merge!('apns-expiration' => notification.expiration) if notification.expiration
       h.merge!('apns-priority' => notification.priority) if notification.priority
+      h.merge!('apns-push-type' => notification.background_notification? ? 'background' : 'alert' )
       h.merge!('apns-topic' => notification.topic) if notification.topic
       h.merge!('apns-collapse-id' => notification.apns_collapse_id) if notification.apns_collapse_id
       h.merge!('authorization' => notification.authorization_header) if notification.authorization_header

lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = '1.4.2'.freeze
+  VERSION = '1.7.0'.freeze
 end