apnotic 1.6.1 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fabb07ff303f54456a91694d9025ee9a6416012c99459316e973a61d9d4e23de
-  data.tar.gz: 50fb64db3f3dd88c6e4f32081745c47b41b01fbb89e10a62c3cfb57db6cb7c63
+  metadata.gz: b8b5ad73f27fa8e662219ed4cbfb6f005421b5eea231db56a7c70df4f36133e2
+  data.tar.gz: 3fbea27f1a1e4286588cf64ec168dc3391df328eb01081a4b18e50cf893986d0
 SHA512:
-  metadata.gz: ecf745aea19457f69c661c44dcee4655693d9195db5eeeab36a6050781f6be6e2e04f24ccdd8c3233038dffc0e674ef9558a27e93c430c33d4076ef7e254ea96
-  data.tar.gz: eeb22010a7c06e12ba72239dff31fbedc353485b9b8380aadf6c654136a22b7fc09f5db0f0147915e7f2914e08a8178937937cc61ed2c022bd5ff476c1487c9b
+  metadata.gz: aaf851556ae88f4d70fc8142c49553379ba769d8566d172fb9b3ec2fc083ab25ade7d1835d8e821ca46f747dbe4b53514f9f0941621442d962c1c82eab2fbdf8
+  data.tar.gz: fa75cf207e666aa958007f08ef4f655166458acdfd3eb734bc1866b80a3ba0332dd8bb5367a924550ad885139f3e7cb9a160c11c696e2b2f463cfee27e6e43e5

data/.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.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
+    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

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.1
+ruby 3.2.1

data/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) 2016 Roberto Ostinelli.
+Copyright (c) 2016-2023 Roberto Ostinelli.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/ostinelli/apnotic.svg?branch=master)](https://travis-ci.org/ostinelli/apnotic)
+[![Build Status](https://github.com/ostinelli/apnotic/actions/workflows/ci.yml/badge.svg)](https://github.com/ostinelli/apnotic/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/ostinelli/apnotic/badges/gpa.svg)](https://codeclimate.com/github/ostinelli/apnotic)
 [![Gem Version](https://badge.fury.io/rb/apnotic.svg)](https://badge.fury.io/rb/apnotic)
 
@@ -201,16 +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.
-| :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
+| 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:
 
@@ -224,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`
@@ -315,10 +318,18 @@ 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+
+| `stale_date` | 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 16+
+| `content_state` | 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 16+
+| `timestamp` | 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 16+
+| `event` | 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 16+
 | `apns_id` | Refer to [Communicating with APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for details.
 | `expiration` | "
 | `priority` | "
 | `topic` | "
+| `push_type` | Refer to [Sending Notification Requests to APNs](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for details, defaults to alert or background (when content-availabe key is set to 1)
 | `url_args` | Values for [Safari push notifications](https://developer.apple.com/library/mac/documentation/NetworkingInternet/Conceptual/NotificationProgrammingGuideForWebsites/PushNotifications/PushNotifications.html#//apple_ref/doc/uid/TP40013225-CH3-SW12).
 | `mutable_content` | Key for [UNNotificationServiceExtension](https://developer.apple.com/reference/usernotifications/unnotificationserviceextension).
 | `apns_collapse_id` | Key for setting the identification of a notification and allowing for the updating of the content of that notification in a subsequent push. More information avaible in [WWDC 2016 - Session 707 Introduction to Notifications](https://developer.apple.com/videos/play/wwdc2016/707/?time=1134). iOS 10+
@@ -352,21 +363,21 @@ 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`
@@ -374,21 +385,21 @@ 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
 

data/apnotic.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email                 = ["roberto@ostinelli.net"]
   spec.summary               = %q{Apnotic is an Apple Push Notification gem able to provide instant feedback.}
   spec.homepage              = "http://github.com/ostinelli/apnotic"
-  spec.required_ruby_version = '>=2.1.0'
+  spec.required_ruby_version = '>=2.4.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

data/lib/apnotic/abstract_notification.rb

@@ -11,7 +11,8 @@ module Apnotic
                   :priority,
                   :topic,
                   :apns_collapse_id,
-                  :authorization
+                  :authorization,
+                  :push_type
 
     def initialize(token)
       @token   = token

data/lib/apnotic/connection.rb

@@ -114,6 +114,7 @@ module Apnotic
     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
@@ -146,5 +147,8 @@ module Apnotic
       @provider_token_cache.call
     end
 
+    def development?
+      url == APPLE_DEVELOPMENT_SERVER_URL
+    end
   end
 end

data/lib/apnotic/instance_cache.rb

@@ -17,12 +17,16 @@ module Apnotic
     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

data/lib/apnotic/notification.rb

@@ -4,6 +4,8 @@ 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
+    attr_accessor :stale_date, :content_state, :timestamp, :event
 
     def background_notification?
       aps.count == 1 && aps.key?('content-available') && aps['content-available'] == 1
@@ -21,6 +23,13 @@ module Apnotic
         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
+        result.merge!('stale-date' => stale_date) if stale_date
+        result.merge!('content-state' => content_state) if content_state
+        result.merge!('timestamp' => timestamp) if timestamp
+        result.merge!('event' => event) if event
       end
     end
 

data/lib/apnotic/provider_token.rb

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

data/lib/apnotic/request.rb

@@ -16,7 +16,7 @@ module Apnotic
       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-push-type' => notification.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

data/lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.7.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apnotic
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.1
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2023-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http2
@@ -93,10 +93,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".tool-versions"
-- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -128,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Apnotic is an Apple Push Notification gem able to provide instant feedback.

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-branches:
-  only:
-    - master
-
-before_install:
-  - gem install bundler