apnotic 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94b898f82f8673a61f6ab3bd745fa8eb906027ca
-  data.tar.gz: 56d23827cb003d10af4189a2ab67b03e560f83f6
+  metadata.gz: 5cb5a06e46cf7b22e0c960e30007dcd7dcd2fe33
+  data.tar.gz: f97f34e8538fd271cb0a169780136575a85d49b5
 SHA512:
-  metadata.gz: a75456d48d44c43da3e61da09ad1bce0ab94340554de54831b9e425d338ad712d2147066a76ad70ad4029a8f3bc8d332ea3733d530008ac9a06ba2e05aabdd1a
-  data.tar.gz: 995629c68ef5c73f94d95ab68cac75d7895c8e3744a6d37dcb463dc7472d738461faf797d8e1b5b9ff5ae6023596a2e4de486ed86ed2226e9a4ae09df7a2f032
+  metadata.gz: 3036c76078e4d49bc86f314237ef7c731497028f899e39285a99178f3f1357196eb55f9f3e680e5cd2070e08ce9234fe486449394c889ee1a040caec4edf5218
+  data.tar.gz: a396a147c7667c004e483895719a7b6ab8f89291c45d423636bf3568c40a9e2513506dbe3134149bdaab4016ae5c848b8be25113b7c5387666c5c1b4f017624e

data/README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/ostinelli/apnotic.svg?branch=master)](https://travis-ci.org/ostinelli/apnotic)
 [![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)
 
 # Apnotic
 
@@ -7,7 +8,7 @@ Apnotic is a gem for sending Apple Push Notifications using the [HTTP-2 specific
 
 
 ## Why "Yet Another APN" gem?
-If you have used the previous Apple Push Notification specifications you may have noticed that it was hard to know whether a Push Notification was successful or not. It is a common problem that has been reported multiple times. In addition, you had to run a separate Feedback service to retrieve the list of the device tokens that were no longer valid, and ensure to purge them from your systems.
+If you have used the previous Apple Push Notification specifications you may have noticed that it was hard to know whether a Push Notification was successful or not. It was a common problem that has been reported multiple times. In addition, you had to run a separate Feedback service to retrieve the list of the device tokens that were no longer valid, and ensure to purge them from your systems.
 
 All of this is solved by using the HTTP-2 APN specifications. Every Push Notification you make returns a response stating if the Push was successful or, if not, which problems were encountered. This includes the case when invalid device tokens are used, hence making it unnecessary to have a separate Feedback service.
 
@@ -52,14 +53,14 @@ response.body     # => ""
 connection.close
 ```
 
-### With Sidekiq / Rescue
-A practical example of a Sidekiq / Rescue worker will probably have to:
+### With Sidekiq / Rescue / ...
+A practical usage of a Sidekiq / Rescue worker probably has to:
 
  * Use a pool of persistent connections.
  * Send a push notification.
  * Remove a device with an invalid token. 
 
-An example of a Sidekiq worker with such features follows.
+An example of a Sidekiq worker with such features follows. This presumes a Rails environment, and a model `Device`.
 
 ```ruby
 require 'apnotic'
@@ -105,7 +106,7 @@ Apnotic::Connection.new(options)
 
 | Option | Description
 |-----|-----
-| :cert_path | Required. The path to a valid APNS push certificate in .pem format (see "Convert your certificate" here below for instructions).
+| :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.
 | :uri | Optional. Defaults to https://api.push.apple.com:443.
 
@@ -120,12 +121,15 @@ Apnotic::Connection.development(options)
 #### Methods
 
  * **uri** → **`URI`**
+ 
  Returns the URI of the APNS endpoint.
 
  * **cert_path** → **`string`**
+ 
  Returns the path to the certificate
  
  * **push(notification, timeout=30)** → **`Apnotic::Response` or `nil`**
+ 
  Sends a notification. Returns `nil` in case a timeout occurs.
 
 
@@ -162,10 +166,11 @@ These are all Accessor attributes.
 | `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. If you don't provide any, one will be generated for you.
+| `apns_id` | Refer to the [APNs Provider API](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/APNsProviderAPI.html) for details.
 | `expiration` | "
 | `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).
 
 For example:
 
@@ -177,6 +182,18 @@ notification.sound    = "bells.wav"
 notification.priority = 5
 ```
 
+For a [Safari push notification](https://developer.apple.com/notifications/safari-push-notifications/):
+
+```ruby
+notification = Apnotic::Notification.new(token)
+
+notification.alert    = {
+  title:  "Flight A998 Now Boarding",
+  body:   "Boarding has begun for Flight A998.",
+  action: "View"
+}
+notification.url_args = ["boarding", "A998"]
+```
 
 ### `Apnotic::Response`
 The response to a call to `connection.push`.
@@ -184,19 +201,23 @@ The response to a call to `connection.push`.
 #### Methods
 
  * **headers** → **`hash`**
+ 
  Returns a Hash containing the Headers of the response.
 
  * **status** → **`string`**
+ 
  Returns the status code.
 
  * **body** → **`hash` or `string`**
+ 
  Returns the body of the response in Hash format if a valid JSON was returned, otherwise just the RAW body.
 
  * **headers** → **`boolean`**
+ 
  Returns if the push was successful.
 
 
-## Converting Your Certificate
+## Getting Your APNs Certificate
 
 > These instructions come from another great gem, [apn_on_rails](https://github.com/PRX/apn_on_rails).
 
@@ -206,7 +227,7 @@ Once you have the certificate from Apple for your application, export your key a
 2. Right click and choose `Export 2 items…`. 
 3. Choose the p12 format from the drop down and name it `cert.p12`.
 
-Now covert the p12 file to a pem file:
+Optionally, you may covert the p12 file to a pem file (this step is optional because Apnotic natively supports p12 files):
 ```
 $ openssl pkcs12 -in cert.p12 -out apple_push_notification_production.pem -nodes -clcerts
 ```

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.8.0"
+  spec.add_dependency "net-http2", "~> 0.9.2"
   spec.add_dependency "connection_pool", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/apnotic/connection.rb

@@ -21,7 +21,7 @@ module Apnotic
       @cert_path = options[:cert_path]
       @cert_pass = options[:cert_pass]
 
-      raise "Cert file not found: #{@cert_path}" unless @cert_path && File.exist?(@cert_path)
+      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)
     end
@@ -44,12 +44,29 @@ module Apnotic
 
     def ssl_context
       @ssl_context ||= begin
-        ctx         = OpenSSL::SSL::SSLContext.new
-        certificate = File.read(@cert_path)
-        ctx.key     = OpenSSL::PKey::RSA.new(certificate, @cert_pass)
-        ctx.cert    = OpenSSL::X509::Certificate.new(certificate)
+        ctx = OpenSSL::SSL::SSLContext.new
+        begin
+          p12 = OpenSSL::PKCS12.new(certificate, @cert_pass)
+          ctx.key  = p12.key
+          ctx.cert = p12.certificate
+        rescue OpenSSL::PKCS12::PKCS12Error
+          ctx.key  = OpenSSL::PKey::RSA.new(certificate, @cert_pass)
+          ctx.cert = OpenSSL::X509::Certificate.new(certificate)
+        end
         ctx
       end
     end
+
+    def certificate
+      @certificate ||= begin
+        if @cert_path.respond_to?(:read)
+          cert = @cert_path.read
+          @cert_path.rewind if @cert_path.respond_to?(:rewind)
+        else
+          cert = File.read(@cert_path)
+        end
+        cert
+      end
+    end
   end
 end

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
+    attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :url_args
     attr_accessor :apns_id, :expiration, :priority, :topic
 
     def initialize(token)
@@ -20,11 +20,14 @@ module Apnotic
     private
 
     def to_hash
-      aps = { alert: alert }
+      aps = {}
+
+      aps.merge!(alert: alert) if alert
       aps.merge!(badge: badge) if badge
       aps.merge!(sound: sound) if sound
-      aps.merge!(content_available: content_available) if content_available
       aps.merge!(category: category) if category
+      aps.merge!('content-available' => content_available) if content_available
+      aps.merge!('url-args' => url_args) if url_args
 
       n = { aps: aps }
       n.merge!(custom_payload) if custom_payload

data/lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apnotic
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-05-01 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.8.0
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement