push_kit-apns 1.0.0.pre.beta1 → 1.0.0.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a37cc16b4ed2fa5d99091530b2352cfce87b8329b7573c2a57cd66c8f951c6
-  data.tar.gz: d7d6b80348f17dec42e2ba44cc1c2b8e9348a4cd5979b63e4194d0aa728f7d5a
+  metadata.gz: c4f29c8b7460101c8ec4600ce6022417c69d3376d1aee4549ba71a58ac162559
+  data.tar.gz: ead2f9a335f5f4fc1466c94dbf6d8baf3963159c9827308dc67eee3ba8f3a7ab
 SHA512:
-  metadata.gz: c3bf44f4cd9d0935ed1ed3ea76f5ae5d7407ec9723946f8086e262a5184f8e92f62ba69268585c706c66bf21e5a3fab6529858e9af2c57f03139a859a0772747
-  data.tar.gz: 39b9bf33159a6a53669515700f169d9865c8442aa8d05d625c34032bfc9b46b9c14571cc2fd3bd190992c5eade594dbd029fc9c7f638aa75c0429c5fd039a37e
+  metadata.gz: 4df1526f02a8b544cd79d222c8aaf2719423d81b001db0f58a828d2c71cc57a32d3c6e39045ad4d76a51e2acdde0723aef8b09921d3fc2c7f1df83eff2a9a543
+  data.tar.gz: 1e50eaefee64b92302f2328eec3c9d146af40212c864209134f4db19650cc8ec142de1bca32984b83eaf62d5e9e946a626b99938a1ed4331b76ae6d3e088f8aa

data/README.md

@@ -38,6 +38,26 @@ This allows us to maintain a connection to the Apple Push Notification service a
 
 See [Communicating with APNs - Best Practices for Managing Connections](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW8) for more info on this.
 
+---
+
+PushKit also provides a couple of convenience helper methods to create and store clients for use anywhere the PushKit::APNS model is accessible.
+
+For example, in a Rails app you could create an initializer and add the following:
+
+```ruby
+PushKit::APNS.prepare(
+  :default,
+  key: PushKit::APNS.load_key('/path/to/APNsAuthKey_XXXXXXXXXX.p8'),
+  key_id: 'XXXXXXXXXX',
+  team_id: 'XXXXXXXXXX',
+  topic: 'com.example.app'
+)
+```
+
+Later, when you're ready to send a notification you can use ```PushKit::APNS.clients[:default]``` to retrieve the client instance.
+
+You can specify any arbitrary value as the key instead of *:default* which allows you to create multiple instance if required.
+
 ### Additional Options
 
 There are a few additional options you can specify when creating a client.
@@ -77,11 +97,11 @@ notification.device_token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 Then using our `PushKit::APNS` instance we created earlier, deliver the notification:
 
 ```ruby
-apns.deliver(notification)
+client.deliver(notification) do |notification, success, response|
+  # ...
+end
 ```
 
-EXPLAIN_ASYNC_NEEDS_WAIT
-
 ---
 
 The `PushKit::APNS::Notification` instance has a *:device_token* attribute which needs to be set to the token of the device you're sending the notification to.
@@ -106,7 +126,7 @@ notifications = notification.for_tokens(*tokens)
 When you're ready, you can just deliver the array of notifications:
 
 ```ruby
-client.deliver(notifications) do |notification, result|
+client.deliver(*notifications) do |notification, success, response|
   # ...
 end
 ```

data/lib/push_kit/apns.rb

@@ -33,14 +33,15 @@ module PushKit
 
     # Create a new PushClient instance.
     #
-    # @param options [Hash]              The APNS options:
-    #        host    [String|Symbol]     The host (can also be :production or :development).
-    #        port    [Integer|Symbol]    The port number (can also be :default or :alternative).
-    #        topic   [String]            The APNS topic (matches the app's bundle identifier).
-    #        key     [OpenSSL::PKey::EC] The elliptic curve key to use for authentication.
-    #        key_id  [String]            The identifier for the elliptic curve key.
-    #        team_id [String]            The identifier for the Apple Developer team.
-    #        topic   [String]            The topic for your application (usually the bundle identifier).
+    # @param  options [Hash]
+    #         host    [String|Symbol]             The host (can also be :production or :development).
+    #         port    [Integer|Symbol]            The port number (can also be :default or :alternative).
+    #         topic   [String]                    The APNS topic (matches the app's bundle identifier).
+    #         key     [OpenSSL::PKey::EC]         The elliptic curve key to use for authentication.
+    #         key_id  [String]                    The identifier for the elliptic curve key.
+    #         team_id [String]                    The identifier for the Apple Developer team.
+    #         topic   [String]                    The topic for your application (usually the bundle identifier).
+    # @return         [PushKit::APNS::PushClient] A client.
     #
     def self.client(options = {})
       options = {
@@ -61,5 +62,24 @@ module PushKit
         token_generator: token_generator
       )
     end
+
+    # @return [Hash] A collection of `PushKit::APNS::PushClient` instances.
+    #
+    def self.clients
+      @clients ||= {}
+    end
+
+    # Prepare a client.
+    #
+    # This method creates a `PushKit::APNS::PushClient` instance using the #client method, then stores it in the
+    # #clients Hash using an identifier you specify.
+    # Storing the clients in this way provides on-demand access without requiring the use of global variables.
+    #
+    # @param identifier [Symbol] The key to use within the #clients Hash.
+    # @param options    [Hash]   The options to pass to the #client method.
+    #
+    def self.prepare(identifier, options = {})
+      clients[identifier] = client(options)
+    end
   end
 end

data/lib/push_kit/apns/constants.rb

@@ -4,6 +4,6 @@ module PushKit
   module APNS
     # @return [String] The gem's semantic version number.
     #
-    VERSION = '1.0.0-beta1'
+    VERSION = '1.0.0-beta2'
   end
 end

data/spec/push_kit/apns/notification/localization_spec.rb

@@ -3,7 +3,7 @@
 require 'push_kit/apns/notification/localization'
 
 RSpec.describe PushKit::APNS::Notification::Localization, :unit do
-  def localization(params = {})
+  def build(params = {})
     default_params = {
       key: 'HELLO_WORLD',
       arguments: nil
@@ -12,16 +12,16 @@ RSpec.describe PushKit::APNS::Notification::Localization, :unit do
     described_class.new(**default_params.merge(params))
   end
 
-  subject { localization }
+  subject(:localization) { build }
 
   it { is_expected.to have_accessor(:key) }
   it { is_expected.to have_accessor(:arguments) }
 
   describe '#initialize' do
     let(:key)       { 'A_KEY' }
-    let(:arguments) { ['An Argument'] }
+    let(:arguments) { ['An argument'] }
 
-    subject { localization(key: key, arguments: arguments) }
+    subject { build(key: key, arguments: arguments) }
 
     it 'sets #key' do
       expect(subject.key).to eq(key)
@@ -34,56 +34,67 @@ RSpec.describe PushKit::APNS::Notification::Localization, :unit do
 
   describe '#payload' do
     context 'when localizing a supported attribute' do
-      let(:payload) { subject.payload(:title) }
+      subject { localization.payload(:title) }
 
-      it 'includes #key as the prefixed loc-key attribute' do
-        subject.key = 'TITLE_KEY'
-        expect(payload).to include('title-loc-key' => 'TITLE_KEY')
+      context 'when #key is set' do
+        before { localization.key = 'TITLE_KEY' }
+
+        it 'includes the correct loc-key attribute and value' do
+          expect(subject).to include('title-loc-key' => 'TITLE_KEY')
+        end
       end
 
-      it 'includes #arguments as the prefixed loc-args attribute' do
-        subject.arguments = ['An Argument']
-        expect(payload).to include('title-loc-args' => ['An Argument'])
+      context 'when #arguments is set' do
+        before { localization.arguments = ['An argument'] }
+
+        it 'includes the correct loc-args attribute and value' do
+          expect(subject).to include('title-loc-args' => ['An argument'])
+        end
       end
 
-      context 'without #arguments' do
-        before { subject.arguments = nil }
+      context 'when #arguments is nil' do
+        before { localization.arguments = nil }
 
-        it 'excludes the prefixed loc-args attribute' do
-          expect(payload).not_to have_key('title-loc-args')
+        it 'excludes the correct loc-args attribute' do
+          expect(subject).not_to have_key('title-loc-args')
         end
       end
     end
 
     context 'when localizing an unsupported attribute' do
-      let(:attribute) { :some_unknown_attribute }
-      let(:payload)   { subject.payload(attribute) }
+      subject { localization.payload(:some_unknown_attribute) }
 
       it 'returns nil' do
-        expect(payload).to be_nil
+        expect(subject).to be nil
       end
     end
   end
 
   describe '#prefix' do
-    def prefix(*args)
-      subject.instance_eval { prefix(*args) }
-    end
+    def self.it_returns(prefix, with: nil)
+      context "with :#{with}" do
+        subject { prefix(with) }
 
-    it "returns 'title-' for :title" do
-      expect(prefix(:title)).to eq('title-')
+        it "returns '#{prefix}'" do
+          expect(subject).to eq(prefix)
+        end
+      end
     end
 
-    it "returns 'subtitle-' for :subtitle" do
-      expect(prefix(:subtitle)).to eq('subtitle-')
+    def prefix(*args)
+      localization.instance_eval { prefix(*args) }
     end
 
-    it "returns '' for :body" do
-      expect(prefix(:body)).to eq('')
-    end
+    it_returns 'title-',    with: :title
+    it_returns 'subtitle-', with: :subtitle
+    it_returns '',          with: :body
 
-    it 'returns nil for an unknown attribute' do
-      expect(prefix(:some_unknown_attribute)).to be_nil
+    context 'with an unknown attribute' do
+      subject { prefix(:some_unknown_attribute) }
+
+      it 'returns nil' do
+        expect(subject).to be nil
+      end
     end
   end
 end

data/spec/push_kit/apns_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'push_kit/apns'
+
+RSpec.describe PushKit::APNS do
+  subject { described_class }
+
+  describe '.load_key' do
+    context 'when the file does not exist' do
+      let(:path) { '/path/to/key' }
+
+      before do
+        expect(File).to receive(:file?).with(path).and_return(false)
+      end
+
+      it 'raises an ArgumentError' do
+        expect { subject.load_key(path) }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
+  describe '.clients' do
+    it 'returns a Hash' do
+      expect(subject.clients).to be_a(Hash)
+    end
+  end
+
+  describe '.prepare' do
+    it 'stores the client in #clients' do
+      expect(subject).to receive(:client).and_return(:a_client_object)
+      subject.prepare(:default)
+      expect(subject.clients).to include(default: :a_client_object)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: push_kit-apns
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta1
+  version: 1.0.0.pre.beta2
 platform: ruby
 authors:
 - Nialto Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -155,6 +155,7 @@ files:
 - spec/push_kit/apns/constants_spec.rb
 - spec/push_kit/apns/notification/localization_spec.rb
 - spec/push_kit/apns/notification_spec.rb
+- spec/push_kit/apns_spec.rb
 - spec/spec_helper.rb
 - spec/support/have_accessor.rb
 homepage: https://github.com/nialtoservices/push_kit-apns
@@ -185,5 +186,6 @@ test_files:
 - spec/push_kit/apns/constants_spec.rb
 - spec/push_kit/apns/notification/localization_spec.rb
 - spec/push_kit/apns/notification_spec.rb
+- spec/push_kit/apns_spec.rb
 - spec/spec_helper.rb
 - spec/support/have_accessor.rb