ruby-push-notifications 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7b8ecbc7d2752899f6c7081d0c849fd7dd9cc7f
-  data.tar.gz: 97f72204c96b4a227e129d66db78e1150f4feaa8
+  metadata.gz: 7a7eaae46825cd8916811bc2026c97c0714d9d65
+  data.tar.gz: 991a6c2960c32cc9de04cb0ef84daac41863da33
 SHA512:
-  metadata.gz: 69c53b62f014059b8ca6ab9e516b2aa7551120ad503359bacda5b317923ca1b770e5c393358f573149a805d0cd78e9023f582629fd05328e99a46477c487c6e6
-  data.tar.gz: 18c6182eda7142c486e0cbca88e5e04193bfb9282631c2e2a4ffa9fb9a8575b2e0754875f9ef100f23accf0f7788c04a1db5d93468741570e49bedcbe00e0fd9
+  metadata.gz: e536c3e750f114ad262920acbd63c9f3dd020aaded4088ac718725a33d87b558ce2caf237cf2a7aa9c41ca98300982a4280f64b587872d18380fd1581435b11e
+  data.tar.gz: 2118a29ead19bafc9edd4ac2b58333e11dbd060395dc35245f9cc2093b13df0a40a5e2cc33eded400e55a7c3b138bbd5ff4561d75fa190f2e6e2e7612bd1cd44

data/.ruby-style.yml

@@ -507,7 +507,7 @@ Metrics/CyclomaticComplexity:
 Metrics/LineLength:
   Description: Limit lines to 80 characters.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits
-  Enabled: true
+  Enabled: false
   Max: 80
   AllowURI: true
   URISchemes:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-push-notifications (0.2.2)
+    ruby-push-notifications (0.3.0)
       builder (~> 3.2)
 
 GEM

data/examples/apns.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env bundle exec ruby
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
@@ -13,4 +13,7 @@ notification = RubyPushNotifications::APNS::APNSNotification.new tokens, { aps:
 
 pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/path/to/your/apps/certificate.pem'), true)
 pusher.push [notification]
-p notification.results
+p 'Notification sending results:'
+p "Success: #{notification.success}, Failed: #{notification.failed}"
+p 'Details:'
+p notification.individual_results

data/examples/gcm.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env bundle exec ruby
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
@@ -13,4 +13,7 @@ notification = RubyPushNotifications::GCM::GCMNotification.new registration_ids,
 
 pusher = RubyPushNotifications::GCM::GCMPusher.new "Your app's GCM key"
 pusher.push [notification]
-p notification.results
+p 'Notification sending results:'
+p "Success: #{notification.success}, Failed: #{notification.failed}"
+p 'Details:'
+p notification.individual_results

data/examples/mpns.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env bundle exec ruby
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
@@ -14,4 +14,7 @@ notification = RubyPushNotifications::MPNS::MPNSNotification.new device_urls, {
 
 pusher = RubyPushNotifications::MPNS::MPNSPusher.new
 pusher.push [notification]
-p notification.results
+p 'Notification sending results:'
+p "Success: #{notification.success}, Failed: #{notification.failed}"
+p 'Details:'
+p notification.individual_results

data/lib/ruby-push-notifications/apns/apns_notification.rb

@@ -10,13 +10,11 @@ module RubyPushNotifications
     #
     # @author Carlos Alonso
     class APNSNotification
+      include RubyPushNotifications::NotificationResultsManager
 
       # @private. 4 weeks in seconds
       WEEKS_4 = 2419200
 
-      # @return [Array]. Array with the results from sending this notification
-      attr_accessor :results
-
       # Initializes the APNS Notification
       #
       # @param [Array]. Array containing all destinations for the notification

data/lib/ruby-push-notifications/apns/apns_pusher.rb

@@ -64,7 +64,7 @@ module RubyPushNotifications
         conn.close
 
         notifications.each do |notif|
-          notif.results = results.slice! 0, notif.count
+          notif.results = APNSResults.new(results.slice! 0, notif.count)
         end
       end
     end

data/lib/ruby-push-notifications/apns/apns_results.rb

@@ -0,0 +1,30 @@
+module RubyPushNotifications
+  module APNS
+    # This class is responsible for holding and
+    # managing result of a pushed notification.
+    #
+    # @author Carlos Alonso
+    class APNSResults
+
+      # @return [Array] of each destination's individual result.
+      attr_reader :individual_results
+
+      # Initializes the result
+      #
+      # @param [Array] containing each destination's individual result.
+      def initialize(results)
+        @individual_results = results
+      end
+
+      # @return [Integer] numer of successfully pushed notifications
+      def success
+        @success ||= individual_results.count { |r| r == NO_ERROR_STATUS_CODE }
+      end
+
+      # @return [Integer] number of failed notifications
+      def failed
+        @failed ||= individual_results.count { |r| r != NO_ERROR_STATUS_CODE }
+      end
+    end
+  end
+end

data/lib/ruby-push-notifications/apns.rb

@@ -41,4 +41,5 @@ end
 require 'ruby-push-notifications/apns/apns_connection'
 require 'ruby-push-notifications/apns/apns_notification'
 require 'ruby-push-notifications/apns/apns_pusher'
+require 'ruby-push-notifications/apns/apns_results'
 

data/lib/ruby-push-notifications/gcm/gcm_notification.rb

@@ -7,9 +7,7 @@ module RubyPushNotifications
     #
     # @author Carlos Alonso
     class GCMNotification
-
-      # @return [Array]. Array with the results from sending this notification
-      attr_accessor :results
+      include RubyPushNotifications::NotificationResultsManager
 
       # Initializes the notification
       #

data/lib/ruby-push-notifications/gcm/gcm_response.rb

@@ -21,6 +21,7 @@ module RubyPushNotifications
       # @return [Array] Array of a GCMResult for every receiver of the notification
       #   sent indicating the result of the operation.
       attr_reader :results
+      alias_method :individual_results, :results
 
       # Initializes the GCMResponse and runs response parsing
       #

data/lib/ruby-push-notifications/mpns/mpns_notification.rb

@@ -7,9 +7,7 @@ module RubyPushNotifications
     # (http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202945)
     #
     class MPNSNotification
-
-      # @return [MPNSResponse]. MPNSResponse with the results from sending this notification.
-      attr_accessor :results
+      include RubyPushNotifications::NotificationResultsManager
 
       # @return [Hash]. Payload to send.
       #   Toast :title => a bold message

data/lib/ruby-push-notifications/mpns/mpns_response.rb

@@ -16,6 +16,7 @@ module RubyPushNotifications
       # @return [Array] Array of a MPNSResult for every receiver of the notification
       #   sent indicating the result of the operation.
       attr_reader :results
+      alias_method :individual_results, :results
 
       # Initializes the MPNSResponse and runs response parsing
       #

data/lib/ruby-push-notifications/mpns/mpns_result.rb

@@ -32,7 +32,7 @@ module RubyPushNotifications
       # @return [String]. The subscription status.
       attr_accessor :subscription_status
 
-      def initialize(device_url, headers = nil)
+      def initialize(device_url, headers)
         @device_url = device_url
         @notification_status = headers[X_NOTIFICATION_STATUS]
         @device_connection_status = headers[X_DEVICE_CONNECTION_STATUS]

data/lib/ruby-push-notifications/notification_results_manager.rb

@@ -0,0 +1,14 @@
+module RubyPushNotifications
+  # This module contains the required behavior expected by particular notifications
+  #
+  # @author Carlos Alonso
+  module NotificationResultsManager
+    extend Forwardable
+
+    def_delegators :@results, :success, :failed, :individual_results
+
+    # The corresponding object with the results from sending this notification
+    # that also will respond to #success, #failed and #individual_results
+    attr_accessor :results
+  end
+end

data/lib/ruby-push-notifications/version.rb

@@ -1,3 +1,3 @@
 module RubyPushNotifications
-  VERSION = "0.2.2"
+  VERSION = '0.3.0'
 end

data/lib/ruby-push-notifications.rb

@@ -1,4 +1,5 @@
 require 'ruby-push-notifications/version'
+require 'ruby-push-notifications/notification_results_manager'
 require 'ruby-push-notifications/apns'
 require 'ruby-push-notifications/gcm'
 require 'ruby-push-notifications/mpns'

data/spec/ruby-push-notifications/apns/apns_notification_spec.rb

@@ -2,28 +2,39 @@
 module RubyPushNotifications
   module APNS
     describe APNSNotification do
-      describe 'building messages for each token' do
 
-        let(:device_tokens) { ['12', '34'] }
-        let(:data) { { a: 1 } }
-        let(:notification) { APNSNotification.new device_tokens, data }
-        let(:notif_id) { 1 }
+      let(:device_tokens) { ['12', '34'] }
+      let(:data) { { a: 1 } }
+      let(:notification) { APNSNotification.new device_tokens, data }
+      let(:notif_id) { 1 }
 
-        it 'successfully creates the apns binary' do
-          json = JSON.dump data
-          expect do |b|
-            notification.each_message notif_id, &b
-          end.to yield_successive_args apns_binary(json, device_tokens[0], notif_id), apns_binary(json, device_tokens[1], notif_id+1)
-        end
+      it 'successfully creates the apns binary' do
+        json = JSON.dump data
+        expect do |b|
+          notification.each_message notif_id, &b
+        end.to yield_successive_args apns_binary(json, device_tokens[0], notif_id), apns_binary(json, device_tokens[1], notif_id + 1)
+      end
 
-        it 'caches the payload' do
-          expect(JSON).to receive(:dump).with(data).once.and_return 'dummy string'
-          notification.each_message(notif_id) { }
-        end
+      it 'caches the payload' do
+        expect(JSON).to receive(:dump).with(data).once.and_return 'dummy string'
+        notification.each_message(notif_id) {}
+      end
+
+      it 'validates the data'
 
-        it 'validates the data'
+      it 'validates the tokens'
 
-        it 'validates the tokens'
+      it_behaves_like 'a proper results manager' do
+        let(:success_count) { 2 }
+        let(:failures_count) { 1 }
+        let(:individual_results) do
+          [
+            NO_ERROR_STATUS_CODE,
+            PROCESSING_ERROR_STATUS_CODE,
+            NO_ERROR_STATUS_CODE
+          ]
+        end
+        let(:results) { APNSResults.new individual_results }
       end
     end
   end

data/spec/ruby-push-notifications/apns/apns_pusher_spec.rb

@@ -36,10 +36,10 @@ module RubyPushNotifications
                 pusher.push [notification]
               end
 
-              it 'saves the results into the notification' do
-                expect do
-                  pusher.push [notification]
-                end.to change { notification.results }.from(nil).to [NO_ERROR_STATUS_CODE]
+              describe 'results' do
+                before { pusher.push [notification] }
+
+                include_examples 'right results', 1, 0, [NO_ERROR_STATUS_CODE]
               end
             end
 
@@ -55,10 +55,10 @@ module RubyPushNotifications
                 pusher.push [notification]
               end
 
-              it 'saves the error' do
-                expect do
-                  pusher.push [notification]
-                end.to change { notification.results }.from(nil).to [PROCESSING_ERROR_STATUS_CODE]
+              describe 'results' do
+                before { pusher.push [notification] }
+
+                include_examples 'right results', 0, 1, [PROCESSING_ERROR_STATUS_CODE]
               end
             end
           end
@@ -82,10 +82,10 @@ module RubyPushNotifications
                 pusher.push [notification]
               end
 
-              it 'saves the results into the notification' do
-                expect do
-                  pusher.push [notification]
-                end.to change { notification.results }.from(nil).to [NO_ERROR_STATUS_CODE, NO_ERROR_STATUS_CODE]
+              describe 'results' do
+                before { pusher.push [notification] }
+
+                include_examples 'right results', 2, 0, [NO_ERROR_STATUS_CODE] * 2
               end
             end
 
@@ -109,10 +109,10 @@ module RubyPushNotifications
                   pusher.push [notification]
                 end
 
-                it 'stores the error' do
-                  expect do
-                    pusher.push [notification]
-                  end.to change { notification.results }.from(nil).to [PROCESSING_ERROR_STATUS_CODE, NO_ERROR_STATUS_CODE]
+                describe 'results' do
+                  before { pusher.push [notification] }
+
+                  include_examples 'right results', 1, 1, [PROCESSING_ERROR_STATUS_CODE, NO_ERROR_STATUS_CODE]
                 end
               end
 
@@ -129,10 +129,10 @@ module RubyPushNotifications
                   pusher.push [notification]
                 end
 
-                it 'stores the error' do
-                  expect do
-                    pusher.push [notification]
-                  end.to change { notification.results }.from(nil).to [PROCESSING_ERROR_STATUS_CODE, NO_ERROR_STATUS_CODE]
+                describe 'results' do
+                  before { pusher.push [notification] }
+
+                  include_examples 'right results', 1, 1, [PROCESSING_ERROR_STATUS_CODE, NO_ERROR_STATUS_CODE]
                 end
               end
 
@@ -149,10 +149,10 @@ module RubyPushNotifications
                   pusher.push [notification]
                 end
 
-                it 'stores the error' do
-                  expect do
-                    pusher.push [notification]
-                  end.to change { notification.results }.from(nil).to [NO_ERROR_STATUS_CODE, PROCESSING_ERROR_STATUS_CODE]
+                describe 'results' do
+                  before { pusher.push [notification] }
+
+                  include_examples 'right results', 1, 1, [NO_ERROR_STATUS_CODE, PROCESSING_ERROR_STATUS_CODE]
                 end
               end
             end
@@ -180,9 +180,8 @@ module RubyPushNotifications
             end
 
             it 'saves results' do
-              expect do
-                pusher.push notifications
-              end.to change { notifications.map { |n| n.results } }.from([nil]*10).to([[NO_ERROR_STATUS_CODE]]*10)
+              pusher.push notifications
+              expect(notifications.map(&:individual_results)).to eq [[NO_ERROR_STATUS_CODE]] * 10
             end
           end
 
@@ -224,9 +223,8 @@ module RubyPushNotifications
               end
 
               it 'saves the statuses' do
-                expect do
-                  pusher.push notifications
-                end.to change { notifications.map { |n| n.results } }.from([nil]*10).to [
+                pusher.push notifications
+                expect(notifications.map(&:individual_results)).to eq [
                     [PROCESSING_ERROR_STATUS_CODE],
                     [NO_ERROR_STATUS_CODE],
                     [MISSING_DEVICE_TOKEN_STATUS_CODE],
@@ -275,9 +273,8 @@ module RubyPushNotifications
               end
 
               it 'saves the statuses' do
-                expect do
-                  pusher.push notifications
-                end.to change { notifications.map { |n| n.results } }.from([nil]*10).to [
+                pusher.push notifications
+                expect(notifications.map(&:individual_results)).to eq [
                     [PROCESSING_ERROR_STATUS_CODE],
                     [NO_ERROR_STATUS_CODE],
                     [MISSING_DEVICE_TOKEN_STATUS_CODE],

data/spec/ruby-push-notifications/gcm/gcm_notification_spec.rb

@@ -19,6 +19,19 @@ module RubyPushNotifications
       # According to https://developer.android.com/google/gcm/server-ref.html#table1
       it 'validates the data'
 
+      it_behaves_like 'a proper results manager' do
+        let(:success_count) { 2 }
+        let(:failures_count) { 1 }
+        let(:canonical_id) { 'abcd' }
+        let(:individual_results) { [GCMCanonicalIDResult.new(canonical_id)] }
+        let(:results) do
+          GCMResponse.new 200, JSON.dump(
+            success: success_count, failure: failures_count, results: [
+              registration_id: canonical_id
+            ]
+            )
+        end
+      end
     end
   end
 end

data/spec/ruby-push-notifications/mpns/mpns_notification_spec.rb

@@ -38,6 +38,16 @@ module RubyPushNotifications
 
       it 'validates the data'
 
+      it_behaves_like 'a proper results manager' do
+        let(:notification) { build :mpns_notification }
+        let(:success_count) { 1 }
+        let(:failures_count) { 0 }
+        let(:device_url) { generate :mpns_device_url }
+        let(:individual_results) { [MPNSResultOK.new(device_url, {})] }
+        let(:results) do
+          MPNSResponse.new [{ code: 200, device_url: device_url, headers: {} }]
+        end
+      end
     end
   end
 end

data/spec/support/results_shared_examples.rb

@@ -0,0 +1,31 @@
+shared_examples 'right results' do |success, failed, individual_results|
+  it 'has the expected success value' do
+    expect(notification.success).to eq success
+  end
+
+  it 'has the expected failed value' do
+    expect(notification.failed).to eq failed
+  end
+
+  it 'has the expected individual_results' do
+    expect(notification.individual_results).to eq individual_results
+  end
+end
+
+shared_examples 'a proper results manager' do
+  describe 'results management' do
+    before { notification.results = results }
+
+    it 'gives the success count' do
+      expect(notification.success).to eq success_count
+    end
+
+    it 'gives the failures count' do
+      expect(notification.failed).to eq failures_count
+    end
+
+    it 'gives the individual results' do
+      expect(notification.individual_results).to eq individual_results
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-push-notifications
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Carlos Alonso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -119,6 +119,7 @@ files:
 - lib/ruby-push-notifications/apns/apns_connection.rb
 - lib/ruby-push-notifications/apns/apns_notification.rb
 - lib/ruby-push-notifications/apns/apns_pusher.rb
+- lib/ruby-push-notifications/apns/apns_results.rb
 - lib/ruby-push-notifications/gcm.rb
 - lib/ruby-push-notifications/gcm/gcm_connection.rb
 - lib/ruby-push-notifications/gcm/gcm_error.rb
@@ -132,6 +133,7 @@ files:
 - lib/ruby-push-notifications/mpns/mpns_pusher.rb
 - lib/ruby-push-notifications/mpns/mpns_response.rb
 - lib/ruby-push-notifications/mpns/mpns_result.rb
+- lib/ruby-push-notifications/notification_results_manager.rb
 - lib/ruby-push-notifications/version.rb
 - ruby-push-notifications.gemspec
 - spec/factories.rb
@@ -150,6 +152,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/dummy.pem
 - spec/support/factory_girl.rb
+- spec/support/results_shared_examples.rb
 homepage: https://github.com/calonso/ruby-push-notifications
 licenses:
 - MIT
@@ -191,4 +194,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/dummy.pem
 - spec/support/factory_girl.rb
+- spec/support/results_shared_examples.rb
 has_rdoc: