apnotic 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82da596366fb53518eda9385937fcfb9e7fe476c
-  data.tar.gz: fea67c61a31550b9dcac35b0ed4db95dc3352a3c
+  metadata.gz: 97653d26a662ae9a7faa8d9d4c2914de5f17b83e
+  data.tar.gz: a069da2ff88b6de95d2ad3f118a7eb4f22fb240b
 SHA512:
-  metadata.gz: 7bf391d0311597c6c511fbac29c6918c83543edc977a6f05de8beac0e8633b3ae11ce7630c3859726dd0f8d677945a898119107564a41ba9967b22d5de1efa6a
-  data.tar.gz: 6695fc6cebfc5608fc2c3def9eb7fa54f6ab1404af333b7e9647b0619dd41624c298417e0c039202b2d1c9b8cab26a82751957bad455f01f660f57058fceef68
+  metadata.gz: e86c4f893bcdee198dad0f6276d4f5d4c05b4999bf4ae5cdeccd91450f99bbecd05a9fd8a67abfa60e14f8c498bbfd9d14872b47a534c244809e7db8908275b4
+  data.tar.gz: 2e7820e5123299223fdf0e027c8a6bdb5500768d68a1a68afe59a3c88f5bc878c20a9fa8071e75fec6899b404e04cc7164fa4cd163b72de5011ded48fdb6a3c4

data/.travis.yml

@@ -4,6 +4,8 @@ rvm:
   - 2.2
   - 2.3.0
   - 2.3.1
+  - 2.3.2
+  - 2.3.3
 
 branches:
   only:

data/README.md

@@ -94,7 +94,7 @@ connection.close
 
 
 ### With Sidekiq / Rescue / ...
-> In case that errors are encountered, Apnotic will repair the underlying connection but will not retry the requests that have failed. For this reason, it is recommended to use a queue engine that will retry unsuccessful pushes.
+> In case that errors are encountered, Apnotic will raise the error and repair the underlying connection, but it will not retry the requests that have failed. This is by design,  so that the job manager (Sidekiq, Resque,...) can retry the job that failed. For this reason, it is recommended to use a queue engine that will retry unsuccessful pushes.
 
 A practical usage of a Sidekiq / Rescue worker probably has to:
 
@@ -151,11 +151,17 @@ 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_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.
 
+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:
+
+```ruby
+Apnotic::Connection.new(cert_path: StringIO.new("pem cert as string"))
+```
+
 It is also possible to create a connection that points to the Apple Development servers by calling instead:
 
 ```ruby
@@ -166,13 +172,23 @@ Apnotic::Connection.development(options)
 
 #### Methods
 
- * **url** → **`URL`**
+ * **cert_path** → **`string`**
 
- Returns the URL of the APNS endpoint.
+ Returns the path to the certificate.
 
- * **cert_path** → **`string`**
+ * **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.
+
+```ruby
+connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+```
 
- Returns the path to the certificate
+> 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`**
+
+ Returns the URL of the APNS endpoint.
 
 ##### Blocking calls
 
@@ -210,6 +226,13 @@ APNOTIC_POOL = Apnotic::ConnectionPool.new({
 }, size: 5)
 ```
 
+It is also possible to create a connection pool that points to the Apple Development servers by calling instead:
+
+```ruby
+Apnotic::ConnectionPool.development(connection_options, connection_pool_options)
+```
+
+
 ### `Apnotic::Notification`
 To create a notification for a specific device token:
 
@@ -222,13 +245,13 @@ These are all Accessor attributes.
 
 | Method | Documentation
 |-----|-----
-| `alert` | Refer to the official Apple documentation of [The Notification Payload](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/TheNotificationPayload.html) for details.
+| `alert` | Refer to the official Apple documentation of [The Payload Key Reference](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html) for details.
 | `badge` | "
 | `sound` | "
 | `content_available` | "
 | `category` | "
 | `custom_payload` | "
-| `apns_id` | Refer to the [APNs Provider API](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/APNsProviderAPI.html) for details.
+| `apns_id` | Refer to [Communicating with APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for details.
 | `expiration` | "
 | `priority` | "
 | `topic` | "
@@ -259,26 +282,27 @@ notification.alert    = {
 notification.url_args = ["boarding", "A998"]
 ```
 
+
 ### `Apnotic::Response`
 The response to a call to `connection.push`.
 
 #### Methods
 
- * **ok?** → **`boolean`**
-
- Returns if the push was successful.
+ * **body** → **`hash` or `string`**
 
- * **headers** → **`hash`**
+ Returns the body of the response in Hash format if a valid JSON was returned, otherwise just the RAW body.
+ 
+  * **headers** → **`hash`**
 
  Returns a Hash containing the Headers of the response.
+ 
+ * **ok?** → **`boolean`**
 
- * **status** → **`string`**
-
- Returns the status code.
+ Returns if the push was successful.
 
- * **body** → **`hash` or `string`**
+ * **status** → **`string`**
 
- Returns the body of the response in Hash format if a valid JSON was returned, otherwise just the RAW body.
+Returns the status code.
 
 
 ### `Apnotic::Push`
@@ -286,6 +310,10 @@ The push object to be sent in an async call.
 
 #### Methods
 
+ * **http2_request**  → **`NetHttp2::Request`**
+ 
+ Returns the HTTP/2 request of the push.
+ 
  * **on(event, &block)**
 
  Allows to set a callback for the request. Available events are:
@@ -298,12 +326,6 @@ The push object to be sent in an async call.
  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).
@@ -319,6 +341,14 @@ Optionally, you may covert the p12 file to a pem file (this step is optional bec
 $ openssl pkcs12 -in cert.p12 -out apple_push_notification_production.pem -nodes -clcerts
 ```
 
+
+## Thread-Safety
+Apnotic is thread-safe. However, some caution is imperative:
+
+  * The async callbacks will be executed in a different thread, so ensure that your code in the callbacks is thread-safe.
+  * Errors in the underlying socket loop thread will be raised in the main thread at unexpected execution times, unless you specify the `:error` callback on the Connection. If you're using Apnotic with a job manager you should be fine by not specifying this callback.
+
+
 ## Contributing
 So you want to contribute? That's great! Please follow the guidelines below. It will make it easier to get merged in.
 
@@ -326,7 +356,7 @@ Before implementing a new feature, please submit a ticket to discuss what you in
 
 Do not commit to master in your fork. Provide a clean branch without merge commits. Every pull request should have its own topic branch. In this way, every additional adjustments to the original pull request might be done easily, and squashed with `git rebase -i`. The updated branch will be visible in the same pull request, so there will be no need to open new pull requests when there are changes to be applied.
 
-Ensure to include proper testing. To run tests you simply have to be in the project's root directory and run:
+Ensure that proper testing is included. To run tests you simply have to be in the project's root directory and run:
 
 ```bash
 $ rake

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.14", "< 2"
+  spec.add_dependency "net-http2", ">= 0.15", "< 2"
   spec.add_dependency "connection_pool", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/apnotic/connection.rb

@@ -58,6 +58,10 @@ module Apnotic
       @client.join
     end
 
+    def on(event, &block)
+      @client.on(event, &block)
+    end
+
     private
 
     def ssl_context

data/lib/apnotic/connection_pool.rb

@@ -4,9 +4,17 @@ module Apnotic
 
   class ConnectionPool
 
-    def self.new(options={}, pool_options={})
-      ::ConnectionPool.new(pool_options) do
-        Apnotic::Connection.new(options)
+    class << self
+      def new(options={}, pool_options={})
+        ::ConnectionPool.new(pool_options) do
+          Apnotic::Connection.new(options)
+        end
+      end
+
+      def development(options={}, pool_options={})
+        ::ConnectionPool.new(pool_options) do
+          Apnotic::Connection.development(options)
+        end
       end
     end
   end

data/lib/apnotic/request.rb

@@ -14,8 +14,8 @@ module Apnotic
     def build_headers_for(notification)
       h = {}
       h.merge!('apns-id' => notification.apns_id) if notification.apns_id
-      h.merge!('apns-expiration' => notification.expiration.to_s) if notification.expiration
-      h.merge!('apns-priority' => notification.priority.to_s) if notification.priority
+      h.merge!('apns-expiration' => notification.expiration) if notification.expiration
+      h.merge!('apns-priority' => notification.priority) if notification.priority
       h.merge!('apns-topic' => notification.topic) if notification.topic
       h.merge!('apns-collapse-id' => notification.apns_collapse_id) if notification.apns_collapse_id
       h

data/lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = "1.0.1"
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apnotic
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http2
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'