apnotic 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bfb47d774564845182d268e32f8820017d0ba32
-  data.tar.gz: 47334f8ffb95809e4c224570c4d4f5ba1b747eb7
+  metadata.gz: f37b786ef147c1553a73571851e796091f9ed2c8
+  data.tar.gz: 80eea7c2ccbe00fb57b8327ef911d6f0c0eeab11
 SHA512:
-  metadata.gz: 84259061d8e09e4ba609b0ae4e99980236984570c64207eed01f0cd3102aa361ec276829609891bc84c237f99df344dac232a69dabeb6672e67150b67c8cde03
-  data.tar.gz: fdb1ba71863a3520f3005817980dcc0e06073791b4958488517053b458a52bec3a22fa32704da7588cfe25b7b7cab0e4e9422671d0354be4b8fe107e1dc8830a
+  metadata.gz: 687b7ab85bbfbbcd125fc6bcfc435cdcf11df33e74635d631d698d5b94682f2dc0e9481bd6887c480b4e587a395a33b3c2b91a21f93606457b822d303fb9282f
+  data.tar.gz: 8e8a154fb3cd33ab1113cfcb30477447d2d1c7fb689ff67a2a13078a6b7211e292099c3824cefc3c3a3ea3dcfe26f00fc4c5920d442a8aad6d0b06248a02a13e

data/.gitignore

@@ -2,6 +2,7 @@
 .*.sw[a-z]
 *.un~
 Session.vim
+.tags
 
 # mine
 .idea

data/README.md

@@ -92,6 +92,37 @@ connection.join
 connection.close
 ```
 
+#### Mobile Device Management (MDM) notifications
+
+If you are building an iOS MDM solution, you can as well use apnotic to send mdm push notifications with the `Apnotic::MdmNotification` class. Sending a MDM notification requires a token and a push magic value, which is sent by the iOS device during its MDM enrollment:
+
+```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'
+
+# push magic value given by the iOS device during enrollment
+push_magic = '7F399691-C3D9-4795-ACF8-0B51D7073497'
+
+notification = Apnotic::MdmNotification.new(token: token, push_magic: push_magic)
+
+# send (this is a blocking call)
+response = connection.push(notification)
+
+# read the response
+response.ok?      # => true
+response.status   # => '200'
+response.headers  # => {":status"=>"200", "apns-id"=>"6f2cd350-bfad-4af0-a8bc-0d501e9e1799"}
+response.body     # => ""
+
+# close the connection
+connection.close
+```
+
 #### Token-based authentication
 Token-based authentication is supported. There are several advantages with token-based auth:
 

data/lib/apnotic.rb

@@ -3,6 +3,7 @@ require 'apnotic/provider_token'
 require 'apnotic/connection'
 require 'apnotic/connection_pool'
 require 'apnotic/notification'
+require 'apnotic/mdm_notification'
 require 'apnotic/push'
 require 'apnotic/request'
 require 'apnotic/response'

data/lib/apnotic/abstract_notification.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'json'
+
+module Apnotic
+  class AbstractNotification
+    attr_reader :token
+    attr_accessor :apns_id,
+                  :expiration,
+                  :priority,
+                  :topic,
+                  :apns_collapse_id,
+                  :authorization
+
+    def initialize(token)
+      @token   = token
+      @apns_id = SecureRandom.uuid
+    end
+
+    def body
+      JSON.dump(to_hash).force_encoding(Encoding::BINARY)
+    end
+
+    def authorization_header
+      authorization ? "bearer #{authorization}" : nil
+    end
+
+    private
+
+    def to_hash
+      raise NotImplementedError, 'implement the to_hash method in a child class'
+    end
+  end
+end

data/lib/apnotic/connection.rb

@@ -79,12 +79,10 @@ module Apnotic
     end
 
     def delayed_push_async(push)
-      if streams_available?
-        @client.call_async(push.http2_request)
-      else
+      until streams_available? do
         sleep 0.001
-        delayed_push_async(push)
       end
+      @client.call_async(push.http2_request)
     end
 
     def streams_available?

data/lib/apnotic/mdm_notification.rb

@@ -0,0 +1,19 @@
+require 'apnotic/abstract_notification'
+
+module Apnotic
+
+  class MdmNotification < AbstractNotification
+    attr_reader :push_magic
+
+    def initialize(push_magic:, token:)
+      super(token)
+      @push_magic = push_magic
+    end
+
+    private
+
+    def to_hash
+      { mdm: push_magic }
+    end
+  end
+end

data/lib/apnotic/notification.rb

@@ -1,42 +1,28 @@
-require 'securerandom'
-require 'json'
+require 'apnotic/abstract_notification'
 
 module Apnotic
 
-  class Notification
-    attr_reader :token
+  class Notification < AbstractNotification
     attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :url_args, :mutable_content
-    attr_accessor :apns_id, :expiration, :priority, :topic, :apns_collapse_id, :authorization
 
-    def initialize(token)
-      @token   = token
-      @apns_id = SecureRandom.uuid
-    end
-
-    def body
-      JSON.dump(to_hash).force_encoding(Encoding::BINARY)
-    end
+    private
 
-    def authorization_header
-      authorization ? "bearer #{authorization}" : nil
+    def aps
+      {}.tap do |result|
+        result.merge!(alert: alert) if alert
+        result.merge!(badge: badge) if badge
+        result.merge!(sound: sound) if sound
+        result.merge!(category: category) if category
+        result.merge!('content-available' => content_available) if content_available
+        result.merge!('url-args' => url_args) if url_args
+        result.merge!('mutable-content' => mutable_content) if mutable_content
+      end
     end
 
-    private
-
     def to_hash
-      aps = {}
-
-      aps.merge!(alert: alert) if alert
-      aps.merge!(badge: badge) if badge
-      aps.merge!(sound: sound) if sound
-      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
-      n
+      { aps: aps }.tap do |result|
+        result.merge!(custom_payload) if custom_payload
+      end
     end
   end
 end

data/lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apnotic
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http2
@@ -106,9 +106,11 @@ files:
 - bin/console
 - bin/setup
 - lib/apnotic.rb
+- lib/apnotic/abstract_notification.rb
 - lib/apnotic/connection.rb
 - lib/apnotic/connection_pool.rb
 - lib/apnotic/instance_cache.rb
+- lib/apnotic/mdm_notification.rb
 - lib/apnotic/notification.rb
 - lib/apnotic/provider_token.rb
 - lib/apnotic/push.rb