apnotic 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1a10d2e906280964fd17047d5a6dbd4401f0a81
-  data.tar.gz: 05e865f118c12f829b7232d5c2f44e5d43bcc0c0
+  metadata.gz: 9493fd00daf33a8bd13d087bcd119929b236372e
+  data.tar.gz: 68215cff5cfc93dd0aafdccf2188da4f6fe9b085
 SHA512:
-  metadata.gz: 335531c6db288c0befc75bf91235ae2cd5387810b9410d6e8a342af89aeee0b81ab6e739a73f1762abb78aa7919876b8f1962517e96b1330b89d20a0998208d9
-  data.tar.gz: 9b413dcd3a8aa1cabbb8d7dd544b3d72a7a1627e92fe2bd91939e2dd17d08fc14c2c129582d60c70f45ab4a22e24b837be55cb9d5916dbc667ffee08e9f62ea0
+  metadata.gz: 5bad7e789438d5e5710a433501dff4e41fa50633f22fe0eb9814653919b41a8ea34a84747854c17a0ccdb850e84f720cf9d31f293a79e6a5b5c82ba2b80d7b77
+  data.tar.gz: 54014458ff59af3703d94b00ffe61a3074c05ba962b60c8183f084a89a113d5051f50235c0d43b0e8c8c4a8db850ab504382b7dab8432940b8a8a4ea1762b0dd

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.0
+ruby-2.3.1

data/README.md

@@ -28,6 +28,10 @@ gem 'apnotic'
 ## Usage
 
 ### Standalone
+
+#### Sync pushes
+Sync pushes are blocking calls that will wait for an APNs response before proceeding.
+
 ```ruby
 require 'apnotic'
 
@@ -53,6 +57,42 @@ response.body     # => ""
 connection.close
 ```
 
+#### Async pushes
+If you are sending out a considerable amount of push notifications, you may consider using async pushes to send out multiple requests in non-blocking calls. This allows to take full advantage of HTTP/2 streams.
+
+```ruby
+require 'apnotic'
+
+# create a persistent connection
+connection = Apnotic::Connection.new(cert_path: "apns_certificate.pem", cert_pass: "pass")
+
+# create a notification for a specific device token
+token = "6c267f26b173cd9595ae2f6702b1ab560371a60e7c8a9e27419bd0fa4a42e58f"
+
+notification       = Apnotic::Notification.new(token)
+notification.alert = "Notification from Apnotic!"
+
+# prepare push
+push = connection.prepare_push(notification)
+push.on(:response) do |response|
+  # read the response
+  response.ok?      # => true
+  response.status   # => '200'
+  response.headers  # => {":status"=>"200", "apns-id"=>"6f2cd350-bfad-4af0-a8bc-0d501e9e1799"}
+  response.body     # => ""
+end
+
+# send
+connection.push_async(push)
+
+# wait for all requests to be completed
+connection.join
+
+# close the connection
+connection.close
+```
+
+
 ### With Sidekiq / Rescue / ...
 A practical usage of a Sidekiq / Rescue worker probably has to:
 
@@ -93,6 +133,7 @@ end
 
 > The official [APNs Provider API documentation](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/APNsProviderAPI.html) explains how to interpret the responses given by the APNS.
 
+You may also consider using async pushes instead in a Sidekiq / Rescue worker.
 
 
 ## Objects
@@ -129,10 +170,26 @@ Apnotic::Connection.development(options)
 
  Returns the path to the certificate
 
+##### Blocking calls
+
  * **push(notification, timeout: 30)** → **`Apnotic::Response` or `nil`**
 
  Sends a notification. Returns `nil` in case a timeout occurs.
 
+##### Non-blocking calls
+
+ * **prepare_push(notification)** → **`Apnotic::Push`**
+
+ Prepares an async push.
+
+ ```ruby
+ push = client.prepare_push(notification)
+ ```
+
+ * **push_async(push)**
+
+  Sends the push asynchronously.
+
 
 ### `Apnotic::ConnectionPool`
 For your convenience, a wrapper around the [Connection Pool](https://github.com/mperham/connection_pool) gem is here for you. To create a new connection pool:
@@ -172,6 +229,7 @@ These are all Accessor attributes.
 | `priority` | "
 | `topic` | "
 | `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).
 
 For example:
 
@@ -218,6 +276,29 @@ The response to a call to `connection.push`.
  Returns the body of the response in Hash format if a valid JSON was returned, otherwise just the RAW body.
 
 
+### `Apnotic::Push`
+The push object to be sent in an async call.
+
+#### Methods
+
+ * **on(event, &block)**
+
+ Allows to set a callback for the request. Available events are:
+
+  * `: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.
+
+ ```ruby
+ push.on(:response) { |response| p response.headers }
+ ```
+
+ * **http2_request**  → **`NetHttp2::Request`**
+ 
+ Returns the HTTP/2 request of the push.
+
+
+
 ## Getting Your APNs Certificate
 
 > These instructions come from another great gem, [apn_on_rails](https://github.com/PRX/apn_on_rails).

data/apnotic.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "net-http2", "~> 0.11.0"
+  spec.add_dependency "net-http2", "~> 0.12.0"
   spec.add_dependency "connection_pool", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/apnotic.rb

@@ -1,6 +1,7 @@
 require 'apnotic/connection'
 require 'apnotic/connection_pool'
 require 'apnotic/notification'
+require 'apnotic/push'
 require 'apnotic/request'
 require 'apnotic/response'
 require 'apnotic/version'

data/lib/apnotic/connection.rb

@@ -17,9 +17,9 @@ module Apnotic
     end
 
     def initialize(options={})
-      @url                = options[:url] || APPLE_PRODUCTION_SERVER_URL
-      @cert_path          = options[:cert_path]
-      @cert_pass          = options[:cert_pass]
+      @url             = options[:url] || APPLE_PRODUCTION_SERVER_URL
+      @cert_path       = options[:cert_path]
+      @cert_pass       = options[:cert_pass]
       @connect_timeout = options[:connect_timeout] || 30
 
       raise "Cert file not found: #{@cert_path}" unless @cert_path && (@cert_path.respond_to?(:read) || File.exist?(@cert_path))
@@ -37,10 +37,27 @@ module Apnotic
       Apnotic::Response.new(headers: response.headers, body: response.body) if response
     end
 
+    def push_async(push)
+      @client.call_async(push.http2_request)
+    end
+
+    def prepare_push(notification)
+      request       = Apnotic::Request.new(notification)
+      http2_request = @client.prepare_request(:post, request.path,
+        body:    request.body,
+        headers: request.headers
+      )
+      Apnotic::Push.new(http2_request)
+    end
+
     def close
       @client.close
     end
 
+    def join
+      @client.join
+    end
+
     private
 
     def ssl_context

data/lib/apnotic/notification.rb

@@ -5,7 +5,7 @@ module Apnotic
 
   class Notification
     attr_reader :token
-    attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :url_args
+    attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :url_args, :mutable_content
     attr_accessor :apns_id, :expiration, :priority, :topic
 
     def initialize(token)
@@ -28,6 +28,7 @@ module Apnotic
       aps.merge!(category: category) if category
       aps.merge!('content-available' => content_available) if content_available
       aps.merge!('url-args' => url_args) if url_args
+      aps.merge!('mutable-content' => mutable_content) if mutable_content
 
       n = { aps: aps }
       n.merge!(custom_payload) if custom_payload

data/lib/apnotic/push.rb

@@ -0,0 +1,38 @@
+module Apnotic
+
+  class Push
+    attr_reader :http2_request
+
+    def initialize(http2_request)
+      @http2_request = http2_request
+      @headers       = {}
+      @data          = ''
+      @events        = {}
+
+      listen_for_http2_events
+    end
+
+    def on(event, &block)
+      raise ArgumentError, 'on event must provide a block' unless block_given?
+
+      @events[event] ||= []
+      @events[event] << block
+    end
+
+    def emit(event, arg)
+      return unless @events[event]
+      @events[event].each { |b| b.call(arg) }
+    end
+
+    private
+
+    def listen_for_http2_events
+      @http2_request.on(:headers) { |headers| @headers.merge!(headers) }
+      @http2_request.on(:body_chunk) { |chunk| @data << chunk }
+      @http2_request.on(:close) do
+        response = Apnotic::Response.new(headers: @headers, body: @data)
+        emit(:response, response)
+      end
+    end
+  end
+end

data/lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apnotic
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http2
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ files:
 - lib/apnotic/connection.rb
 - lib/apnotic/connection_pool.rb
 - lib/apnotic/notification.rb
+- lib/apnotic/push.rb
 - lib/apnotic/request.rb
 - lib/apnotic/response.rb
 - lib/apnotic/version.rb