mercurius 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ab94d197c802c11b53e6fc8dc34090237b456af
-  data.tar.gz: 4dbcf381ccc7185f1cb27514ac24ff3d80bf8332
+  metadata.gz: ad8436c06b411a85bb1392ae8829e647150a8813
+  data.tar.gz: 7b6021819a0c16f5b65c609e391c86eef4b10215
 SHA512:
-  metadata.gz: 098bd1d77a6e27e53e52cc873aeee6b8428569d47fbf855af51cd2624ab0470c7cfede9e0dc8b1e092100e779d78c6d0843751bacbba837e332102b2351e77f7
-  data.tar.gz: fee9b5c35b361e65a8d4496e9127f5627b2078ab249349477b9827fe24855125c0664bf66fc5946735d2a7fc7539eb87d9856cfd3d8f8904724c5165b08f21a3
+  metadata.gz: f82468ba84b84c9fce6f0a8dc0b977724eda79378b1c70f1c6511be8f4d16e4baff266979c3a94dd73b08c3b4c04ce979960dae2b4afe26dd790041a7d42197e
+  data.tar.gz: 4c563b18ed858c1433ae0ff53199597028464d73f40f2b9361c0a9dd36add2fb1fc95055318c240c04809725cc5473f1315a1d1f76609695d954fe7ef178dce2

data/README.md

@@ -71,6 +71,23 @@ The deliver method can be called in the following ways:
     token_array = ['token123', 'token456']
     apns_service.deliver apns_notification, token_array             # multiple recipients
 
+## Testing
+
+`GCM::Service` and `APNS::Service` can accept which type of connection they use to deliver pushes.
+Mercurius provides several mock connections for convenient testing. You can create a custom fake
+connection if you require a special use case.
+
+```ruby
+# Tokens passed will return successfully from GCM
+GCM::Service.new connection: GCM::SuccessfulConnection.new
+
+# Tokens passed will return a NotRegistered error from the fake GCM
+GCM::Service.new connection: GCM::UnregisteredDeviceTokenConnection.new('token123')
+
+# Tokens passed as keys will return their mapped value as the canonical ID
+GCM::Service.new connection: GCM::CanonicalIdConnection.new('token123' => 'canonical123')
+```
+
 ## Contributing
 
 Please fork, modify, and send a pull request if you want to help improve this gem.

data/lib/mercurius/apns.rb

@@ -12,10 +12,7 @@ module APNS
     attr_accessor :host, :port, :pem
 
     def mode=(mode)
-      raise InvalidApnsModeError.new unless HOSTS.include? mode.to_sym
-      @host = HOSTS[mode.to_sym]
+      @host = HOSTS.fetch(mode.to_sym) { raise InvalidApnsModeError.new }
     end
-
   end
-
 end

data/lib/mercurius/apns/service.rb

@@ -4,15 +4,15 @@ module APNS
 
     MAX_NUMBER_OF_RETRIES = 3
 
-    attr_accessor :host, :port, :pem
-    attr_reader :connection, :attempts
+    attr_accessor :host, :port, :pem, :connection
+    attr_reader :attempts
 
     def initialize(*)
       super
       @host ||= APNS.host
       @port ||= APNS.port
-      @pem  ||= APNS.pem
-      @connection = APNS::Connection.new(@host, @port, @pem)
+      @pem ||= APNS.pem
+      @connection ||= APNS::Connection.new(@host, @port, @pem)
       @attempts = 0
     end
 

data/lib/mercurius/gcm.rb

@@ -5,5 +5,4 @@ module GCM
   class << self
     attr_accessor :host, :key
   end
-
 end

data/lib/mercurius/gcm/service.rb

@@ -4,14 +4,14 @@ module GCM
 
     BATCH_SIZE = 999
 
-    attr_accessor :host, :key
-    attr_reader :connection, :attempts
+    attr_accessor :host, :key, :connection
+    attr_reader :attempts
 
     def initialize(*)
       super
       @host ||= GCM.host
-      @key  ||= GCM.key
-      @connection = GCM::Connection.new(@host, @key)
+      @key ||= GCM.key
+      @connection ||= GCM::Connection.new(@host, @key)
       @attempts = 0
     end
 

data/lib/mercurius/testing.rb

@@ -1,7 +1,8 @@
-require 'mercurius/testing/base'
-require 'mercurius/testing/delivery'
-require 'mercurius/testing/result'
-require 'mercurius/testing/service'
+require 'mercurius/testing/fake_response'
 
-APNS::Service.send :prepend, Mercurius::Testing::Service
-GCM::Service.send :prepend, Mercurius::Testing::Service
+require 'mercurius/testing/gcm/token_serializer'
+require 'mercurius/testing/gcm/successful_connection'
+require 'mercurius/testing/gcm/canonical_id_connection'
+require 'mercurius/testing/gcm/unregistered_device_token_connection'
+
+require 'mercurius/testing/apns/successful_connection'

data/lib/mercurius/testing/apns/successful_connection.rb

@@ -0,0 +1,28 @@
+module APNS
+  class SuccessfulConnection
+    def initialize
+      @_open = false
+    end
+
+    def open
+      @_open = true
+      @ssl = FakeSocket.new
+      @socket = FakeSocket.new
+    end
+
+    def close
+      @_open = false
+    end
+
+    def closed?
+      not @_open
+    end
+
+    def write(data)
+      @ssl.write data
+    end
+
+    def read
+    end
+  end
+end

data/lib/mercurius/testing/fake_response.rb

@@ -0,0 +1,14 @@
+module Mercurius
+  class FakeResponse
+    attr_accessor :body, :status
+
+    def initialize(options = {})
+      @body = options[:body]
+      @status = options[:status]
+    end
+
+    def success?
+      (200..399).include? @status
+    end
+  end
+end

data/lib/mercurius/testing/gcm/canonical_id_connection.rb

@@ -0,0 +1,30 @@
+module GCM
+  class CanonicalIdConnection
+    include GCM::TokenSerializer
+
+    def initialize(canonical_ids_map)
+      @canonical_ids_map = canonical_ids_map
+    end
+
+    def write(json)
+      tokens = json[:registration_ids]
+
+      json = {
+        'multicast_id' => '123',
+        'success' => tokens.size,
+        'failure' => 0,
+        'canonical_ids' => number_of_tokens_mapped_to_canonical_ids(tokens),
+        'results' => canonical_token_json(tokens, @canonical_ids_map)
+      }.to_json
+
+      Mercurius::FakeResponse.new body: json, status: 200
+    end
+
+    private
+      def number_of_tokens_mapped_to_canonical_ids(tokens)
+        tokens.count do |token|
+          @canonical_ids_map.key? token
+        end
+      end
+  end
+end

data/lib/mercurius/testing/gcm/successful_connection.rb

@@ -0,0 +1,19 @@
+module GCM
+  class SuccessfulConnection
+    include GCM::TokenSerializer
+
+    def write(json)
+      tokens = json[:registration_ids]
+
+      json = {
+        'multicast_id' => '123',
+        'success' => tokens.size,
+        'failure' => 0,
+        'canonical_ids' => 0,
+        'results' => valid_token_json(tokens)
+      }.to_json
+
+      Mercurius::FakeResponse.new body: json, status: 200
+    end
+  end
+end

data/lib/mercurius/testing/gcm/token_serializer.rb

@@ -0,0 +1,25 @@
+module GCM
+  module TokenSerializer
+    def valid_token_json(tokens)
+      tokens.map do |token|
+        { 'message_id' => SecureRandom.hex }
+      end
+    end
+
+    def invalid_token_json(tokens, error)
+      tokens.map do |token|
+        { 'error' => error }
+      end
+    end
+
+    def canonical_token_json(tokens, canonical_ids_map)
+      tokens.map do |token|
+        hash = { 'message_id' => SecureRandom.hex }
+        if canonical_id = canonical_ids_map[token]
+          hash['registration_id'] = canonical_id
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/mercurius/testing/gcm/unregistered_device_token_connection.rb

@@ -0,0 +1,25 @@
+module GCM
+  class UnregisteredDeviceTokenConnection
+    include GCM::TokenSerializer
+
+    def initialize(*invalid_tokens)
+      @invalid_tokens = invalid_tokens
+    end
+
+    def write(json)
+      invalid, valid = json[:registration_ids].partition do |token|
+        @invalid_tokens.include? token
+      end
+
+      json = {
+        'multicast_id' => '123',
+        'success' => valid.size,
+        'failure' => invalid.size,
+        'canonical_ids' => 0,
+        'results' => valid_token_json(valid).concat(invalid_token_json(invalid, 'NotRegistered'))
+      }.to_json
+
+      Mercurius::FakeResponse.new body: json, status: 200
+    end
+  end
+end

data/lib/mercurius/version.rb

@@ -1,3 +1,3 @@
 module Mercurius
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/spec/lib/testing_spec.rb

@@ -1,45 +1,58 @@
-%w(service base result delivery).each do |rb|
-  require File.expand_path("../../../lib/mercurius/testing/#{rb}", __FILE__)
-end
-
 describe 'Test mode' do
+  context 'GCM' do
+    let(:message) { GCM::Notification.new(data: { alert: 'Hey' }) }
 
-  class GCM::MockService < GCM::Service
-    include Mercurius::Testing::Service
-  end
-
-  class APNS::MockService < APNS::Service
-    include Mercurius::Testing::Service
-  end
+    describe 'Normal test connection' do
+      let(:service) do
+        GCM::Service.new connection: GCM::SuccessfulConnection.new
+      end
 
-  after do
-    Mercurius::Testing::Base.reset
-  end
+      it 'Returns all devices sent successfully' do
+        responses = service.deliver message, 'token123', 'token456'
+        expect(responses.results.succeeded.size).to eq 2
+        expect(responses.results.failed.size).to eq 0
+      end
+    end
 
-  context 'GCM' do
-    let(:service) { GCM::MockService.new }
-    let(:message) { GCM::Notification.new(data: { alert: 'Hey' }) }
+    describe 'Invalid device token connection' do
+      let(:service) do
+        GCM::Service.new connection: GCM::UnregisteredDeviceTokenConnection.new('token456')
+      end
+
+      it 'Returns invalid device errors for the tokens provided' do
+        responses = service.deliver message, 'token123', 'token456'
+        expect(responses.results.failed.size).to eq 1
+        expect(responses.results.failed[0].token).to eq 'token456'
+        expect(responses.results.failed[0].error).to eq 'NotRegistered'
+      end
+    end
 
-    it 'returns the deliveries sent to GCM' do
-      result = service.deliver message, 'token123'
-      delivery = Mercurius::Testing::Base.deliveries[0]
-      expect(delivery.device_tokens).to include 'token123'
-      expect(delivery.notification.data).to eq Hash[alert: 'Hey']
-      expect(result).to be_a_kind_of Mercurius::Testing::Result
+    describe 'Canonical ID token connection' do
+      let(:service) do
+        GCM::Service.new connection: GCM::CanonicalIdConnection.new('token456' => 'canonicalToken999')
+      end
+
+      it 'returns canonical IDs for the tokens provided' do
+        responses = service.deliver message, 'token123', 'token456'
+        expect(responses.results.with_canonical_ids.size).to eq 1
+        expect(responses.results.with_canonical_ids[0].token).to eq 'token456'
+        expect(responses.results.with_canonical_ids[0].canonical_id).to eq 'canonicalToken999'
+      end
+
+      it 'matches the canonical count with the amount provided to the connection' do
+        responses = service.deliver message, 'token123', 'token456'
+        expect(responses[0].to_h['canonical_ids']).to eq 1
+      end
     end
   end
 
   context 'APNS' do
-    let(:service) { APNS::MockService.new }
+    let(:service) { APNS::Service.new connection: APNS::SuccessfulConnection.new }
     let(:message) { APNS::Notification.new(alert: 'Hey') }
 
     it 'returns the deliveries sent to APNS' do
       result = service.deliver message, 'token123'
-      delivery = Mercurius::Testing::Base.deliveries[0]
-      expect(delivery.device_tokens).to include 'token123'
-      expect(delivery.notification.alert).to eq 'Hey'
-      expect(result).to be_a_kind_of Mercurius::Testing::Result
+      # Not sure what to test here...
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'mercurius'
+require 'mercurius/testing'
 require 'webmock/rspec'
 require 'support/fake_socket'
 
-WebMock.disable_net_connect!
+WebMock.disable_net_connect!

data/spec/support/fake_socket.rb

@@ -26,5 +26,4 @@ class FakeSocket < StringIO
   def closed?
     @_open == false
   end
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mercurius
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - John Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -132,7 +132,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -160,10 +159,12 @@ files:
 - lib/mercurius/gcm/result_collection.rb
 - lib/mercurius/gcm/service.rb
 - lib/mercurius/testing.rb
-- lib/mercurius/testing/base.rb
-- lib/mercurius/testing/delivery.rb
-- lib/mercurius/testing/result.rb
-- lib/mercurius/testing/service.rb
+- lib/mercurius/testing/apns/successful_connection.rb
+- lib/mercurius/testing/fake_response.rb
+- lib/mercurius/testing/gcm/canonical_id_connection.rb
+- lib/mercurius/testing/gcm/successful_connection.rb
+- lib/mercurius/testing/gcm/token_serializer.rb
+- lib/mercurius/testing/gcm/unregistered_device_token_connection.rb
 - lib/mercurius/version.rb
 - mercurius.gemspec
 - spec/lib/apns_notification_spec.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-mercurius

data/lib/mercurius/testing/base.rb

@@ -1,21 +0,0 @@
-module Mercurius
-  module Testing
-    class Base
-
-      def self.deliveries
-        @@deliveries ||= []
-      end
-
-      def self.reset
-        @@deliveries = []
-      end
-
-      def self.deliveries_to(device_token)
-        deliveries.select do |delivery|
-          delivery.device_tokens.include? device_token
-        end
-      end
-
-    end
-  end
-end

data/lib/mercurius/testing/delivery.rb

@@ -1,6 +0,0 @@
-module Mercurius
-  module Testing
-    class Delivery < Struct.new(:notification, :device_tokens)
-    end
-  end
-end

data/lib/mercurius/testing/result.rb

@@ -1,32 +0,0 @@
-module Mercurius
-  module Testing
-    class Result
-      attr_reader :responses
-
-      def initialize(notification)
-        @notification = notification
-        @responses = []
-      end
-
-      def success?
-        true
-      end
-
-      def process_response(*)
-      end
-
-      def failed_responses
-        []
-      end
-
-      def failed_device_tokens
-        []
-      end
-
-      def has_canonical_ids?
-        false
-      end
-
-    end
-  end
-end

data/lib/mercurius/testing/service.rb

@@ -1,17 +0,0 @@
-module Mercurius
-  module Testing
-    module Service
-
-      def deliver(notification, *device_tokens)
-        Mercurius::Testing::Base.deliveries << Mercurius::Testing::Delivery.new(notification, Array(device_tokens).flatten)
-        Mercurius::Testing::Result.new notification
-      end
-
-      def deliver_topic(notification, topic)
-        Mercurius::Testing::Base.deliveries << Mercurius::Testing::Delivery.new(notification, [topic])
-        Mercurius::Testing::Result.new notification
-      end
-
-    end
-  end
-end