ruby-push-notifications 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d47dcca6cd9dfae155c566c9b2b90ba334e5e3f5
-  data.tar.gz: 957bc60afb47661d910e50f771c46ea108dbe7df
+  metadata.gz: 2d72d6fd41a6da51fd7fd7faf2cd56774da3126e
+  data.tar.gz: e697f8afde5d62663cf3c1dc3b84599ff770b341
 SHA512:
-  metadata.gz: e0c21ac5060259358f3a304934cc562e7d959b7dd3894ce8aaaf87843a49cbf3a5764e450d48f606db1469bafb6f01a423cacabf4d20300e34433f15db550190
-  data.tar.gz: a012744bfd5eab89450238c778786a84a6bde7df4a7ccd406d0a0fc0bb3f7b53443c8e41708d05b52621b5678b93a136a99d741e8c1a8accaf7b36413969f51b
+  metadata.gz: ffd77ae1e4711f547a1a06adab7573e63d9a3cd136a8ead4349d2e2d963b4fb7ad899803d455ce6f8ec34cdd5b79d578ce21c2d8915acd3660759e04ca5ae09c
+  data.tar.gz: aa82f2753c87135fba244eb6397a1c85a72827aeb0ca53e21ee8b81067f0a0d2132d3d0cb0f3ac43d89e0ff7a291dde143316a0cd6193eb479db2c32bbf1de16

data/.gitignore

@@ -35,3 +35,4 @@ Gemfile.lock
 .DS_Store
 
 examples/*.bak
+.idea/

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in ruby-push-notifications.gemspec
 gemspec
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -37,9 +37,10 @@ Or install it yourself as:
 For completely detailed examples:
 
 1. [Apple iOS example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/apns.rb)
-2. [Google Android example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/gcm.rb)
-3. [Windows Phone(MPNS) example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/mpns.rb)
-4. [Windows Phone(WNS) example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/wns.rb)
+2. [Google Android example (GCM)](https://github.com/calonso/ruby-push-notifications/tree/master/examples/gcm.rb)
+3. [Google Android example (FCM)](https://github.com/calonso/ruby-push-notifications/tree/master/examples/fcm.rb)
+4. [Windows Phone(MPNS) example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/mpns.rb)
+5. [Windows Phone(WNS) example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/wns.rb)
 
 ## Pending tasks
 

data/examples/fcm.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+registration_ids = [
+  'First registration id here',
+  'Second registration id here'
+]
+
+# Example JSON payload
+payload = {
+  "notification": {
+    "title": 'Greetings Test',
+    "body": 'Remember to test! ALOT!',
+    "forceStart": 1,
+    "sound": 'default',
+    "vibrate": 'true',
+    "icon": 'fcm_push_icon'
+  },
+  "android": {
+    "priority": 'high',
+    "vibrate": 'true'
+  },
+  "data": {
+    "url": 'https://www.google.com'
+  },
+  "webpush": {
+    "headers": {
+      "TTL": '60'
+    }
+  },
+  "priority": 'high'
+}
+
+notification = RubyPushNotifications::FCM::FCMNotification.new registration_ids, payload
+
+pusher = RubyPushNotifications::FCM::FCMPusher.new "Your app's FCM key"
+
+pusher.push [notification]
+p 'Notification sending results:'
+p "Success: #{notification.success}, Failed: #{notification.failed}"
+p 'Details:'
+p notification.individual_results

data/lib/ruby-push-notifications.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ruby-push-notifications/notification_results_manager'
 require 'ruby-push-notifications/apns'
 require 'ruby-push-notifications/gcm'
+require 'ruby-push-notifications/fcm'
 require 'ruby-push-notifications/mpns'
 require 'ruby-push-notifications/wns'

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'ruby-push-notifications/fcm/fcm_connection'
+require 'ruby-push-notifications/fcm/fcm_notification'
+require 'ruby-push-notifications/fcm/fcm_pusher'
+require 'ruby-push-notifications/fcm/fcm_response'
+require 'ruby-push-notifications/fcm/fcm_error'
+require 'ruby-push-notifications/fcm/fcm_result'

data/lib/ruby-push-notifications/fcm/fcm_connection.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/https'
+
+module RubyPushNotifications
+  module FCM
+    # Encapsulates a connection to the FCM service
+    # Responsible for final connection with the service.
+    #
+    # @author Carlos Alonso
+    class FCMConnection
+
+      # @private The URL of the Android FCM endpoint
+      # Credits: https://github.com/calos0921 - for this url change to FCM std
+      FCM_URL = 'https://fcm.googleapis.com/fcm/send'
+
+      # @private Content-Type HTTP Header string
+      CONTENT_TYPE_HEADER = 'Content-Type'
+
+      # @private Application/JSON content type
+      JSON_CONTENT_TYPE = 'application/json'
+
+      # @private Authorization HTTP Header String
+      AUTHORIZATION_HEADER = 'Authorization'
+
+      # Issues a POST request to the FCM send endpoint to
+      # submit the given notifications.
+      #
+      # @param notification [String]. The text to POST
+      # @param key [String]. The FCM sender id to use
+      #    (https://developer.android.com/google/fcm/fcm.html#senderid)
+      # @param options [Hash] optional. Options for #post. Currently supports:
+      #   * url [String]: URL of the FCM endpoint. Defaults to the official FCM URL.
+      #   * open_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      #   * read_timeout [Integer]: Number of seconds to wait for one block to be read. Defaults to 30.
+      # @return [FCMResponse]. The FCMResponse that encapsulates the received response
+      def self.post(notification, key, options = {})
+        headers = {
+          CONTENT_TYPE_HEADER => JSON_CONTENT_TYPE,
+          AUTHORIZATION_HEADER => "key=#{key}"
+        }
+
+        url = URI.parse options.fetch(:url, FCM_URL)
+        http = Net::HTTP.new url.host, url.port
+        http.use_ssl = url.scheme == 'https'
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.open_timeout = options.fetch(:open_timeout, 30)
+        http.read_timeout = options.fetch(:read_timeout, 30)
+
+        response = http.post url.path, notification, headers
+
+        FCMResponse.new response.code.to_i, response.body
+      end
+    end
+  end
+end

data/lib/ruby-push-notifications/fcm/fcm_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    # Base class for all FCM related errors
+    #
+    # @author Carlos Alonso
+    class FCMError < StandardError; end
+
+    class MalformedFCMJSONError < FCMError; end
+
+    class FCMAuthError < FCMError; end
+
+    class FCMInternalError < FCMError; end
+
+    class UnexpectedFCMResponseError < FCMError; end
+  end
+end

data/lib/ruby-push-notifications/fcm/fcm_notification.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    # Encapsulates a FCM Notification.
+    # By default only Required fields are set.
+    # (https://developer.android.com/google/fcm/server-ref.html#send-downstream)
+    #
+    # @author Carlos Alonso
+    class FCMNotification
+      attr_reader :registration_ids, :data
+
+      include RubyPushNotifications::NotificationResultsManager
+
+      # Initializes the notification
+      #
+      # @param [Array]. Array with the receiver's FCM registration ids.
+      # @param [Hash]. Payload to send.
+      def initialize(registration_ids, data)
+        @registration_ids = registration_ids
+        @data = data
+      end
+
+      def make_payload
+        { registration_ids: @registration_ids }.merge(@data)
+      end
+
+      # @return [String]. The FCM's JSON format for the payload to send.
+      #    (https://developer.android.com/google/fcm/server-ref.html#send-downstream)
+      # Credits: https://github.com/calos0921 - for this url change to FCM std
+      def as_fcm_json
+        JSON.dump(make_payload)
+      end
+    end
+  end
+end

data/lib/ruby-push-notifications/fcm/fcm_pusher.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+
+    # This class is responsible for sending notifications to the FCM service.
+    #
+    # @author Carlos Alonso
+    class FCMPusher
+
+      # Initializes the FCMPusher
+      #
+      # @param key [String]. FCM sender id to use
+      #   ((https://developer.android.com/google/fcm/fcm.html#senderid))
+      # @param options [Hash] optional. Options for FCMPusher. Currently supports:
+      #   * url [String]: URL of the FCM endpoint. Defaults to the official FCM URL.
+      #   * open_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      #   * read_timeout [Integer]: Number of seconds to wait for one block to be read. Defaults to 30.
+      def initialize(key, options = {})
+        @key = key
+        @options = options
+      end
+
+      # Actually pushes the given notifications.
+      # Assigns every notification an array with the result of each
+      # individual notification.
+      #
+      # @param notifications [Array]. Array of FCMNotification to send.
+      def push(notifications)
+        notifications.each do |notif|
+          notif.results = FCMConnection.post notif.as_fcm_json, @key, @options
+        end
+      end
+    end
+  end
+end

data/lib/ruby-push-notifications/fcm/fcm_response.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+
+    # This class encapsulates a response received from the FCM service
+    # and helps parsing and understanding the received meesages/codes.
+    #
+    # @author Carlos Alonso
+    class FCMResponse
+
+      # @return [Integer] the number of successfully sent notifications
+      attr_reader :success
+
+      # @return [Integer] the number of failed notifications
+      attr_reader :failed
+
+      # @return [Integer] the number of received canonical IDS
+      #    (https://developer.android.com/google/fcm/server-ref.html#table4)
+      attr_reader :canonical_ids
+
+      # @return [Array] Array of a FCMResult for every receiver of the notification
+      #   sent indicating the result of the operation.
+      attr_reader :results
+      alias_method :individual_results, :results
+
+      # Initializes the FCMResponse and runs response parsing
+      #
+      # @param code [Integer]. The HTTP status code received
+      # @param body [String]. The response body received.
+      # @raise MalformedFCMJsonError if code == 400 Bad Request
+      # @raise FCMAuthError if code == 401 Unauthorized
+      # @raise FCMInternalError if code == 5xx
+      # @raise UnexpectedFCMResponseError if code != 200
+      def initialize(code, body)
+        case code
+        when 200
+          parse_response body
+        when 400
+          raise MalformedFCMJSONError, body
+        when 401
+          raise FCMAuthError, body
+        when 500..599
+          raise FCMInternalError, body
+        else
+          raise UnexpectedFCMResponseError, code
+        end
+      end
+
+      def ==(other)
+        (other.is_a?(FCMResponse) &&
+          success == other.success &&
+          failed == other.failed &&
+          canonical_ids == other.canonical_ids &&
+          results == other.results) || super(other)
+      end
+
+      private
+
+      # Parses the response extracting counts for successful, failed and
+      # containing canonical ID messages.
+      # Also creates the results array assigning a FCMResult subclass for each
+      # registration ID the notification was sent to.
+      #
+      # @param body [String]. The response body
+      def parse_response(body)
+        json = JSON.parse body, symbolize_names: true
+        @success = json[:success]
+        @failed = json[:failure]
+        @canonical_ids = json[:canonical_ids]
+        @results = (json[:results] || []).map { |result| fcm_result_for result }
+      end
+
+      # Factory method that, for each FCM result object assigns a FCMResult
+      # subclass.
+      #
+      # @param result [Hash]. FCM Result parsed hash
+      # @return [FCMResult]. Corresponding FCMResult subclass
+      def fcm_result_for(result)
+        if canonical_id = result[:registration_id]
+          FCMCanonicalIDResult.new canonical_id
+        elsif error = result[:error]
+          FCMResultError.new error
+        else
+          FCMResultOK.new
+        end
+      end
+    end
+  end
+end

data/lib/ruby-push-notifications/fcm/fcm_result.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    # Class that encapsulates the result of a single sent notification to a single
+    # Registration ID
+    # (https://developer.android.com/google/fcm/server-ref.html#table4)
+    # @author Carlos Alonso
+    class FCMResult; end
+
+    # Indicates that the notification was successfully sent to the corresponding
+    # registration ID
+    class FCMResultOK < FCMResult
+
+      def ==(other)
+        other.is_a?(FCMResultOK) || super(other)
+      end
+    end
+
+    # Indicates that the notification was successfully sent to the corresponding
+    # registration ID but FCM sent a canonical ID for it, so the received canonical
+    # ID should be used as registration ID ASAP.
+    class FCMCanonicalIDResult < FCMResult
+
+      # @return [String]. The suggested canonical ID from FCM
+      attr_reader :canonical_id
+
+      def initialize(canonical_id)
+        @canonical_id = canonical_id
+      end
+
+      def ==(other)
+        (other.is_a?(FCMCanonicalIDResult) && @canonical_id == other.canonical_id) ||
+          super(other)
+      end
+    end
+
+    # An error occurred sending the notification to the registration ID.
+    class FCMResultError < FCMResult
+
+      # @return [String]. The error sent by FCM
+      attr_accessor :error
+
+      def initialize(error)
+        @error = error
+      end
+
+      def ==(other)
+        (other.is_a?(FCMResultError) && @error == other.error) || super(other)
+      end
+    end
+  end
+end

data/ruby-push-notifications.gemspec

@@ -1,9 +1,8 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "ruby-push-notifications"
-  spec.version       = "1.2.0"
+  spec.version       = "1.3.0"
   spec.authors       = ['Carlos Alonso']
-  spec.email         = ['info@mrcalonso.com']
   spec.summary       = %q{iOS, Android and Windows Phone Push Notifications made easy!}
   spec.description   = %q{Easy to use gem to send iOS, Android and Windows Phone Push notifications}
   spec.homepage      = 'https://github.com/calonso/ruby-push-notifications'
@@ -19,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'builder', '~> 3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
+  # spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'factory_girl', '~> 4.0'
   spec.add_development_dependency 'webmock', '~> 1.20'

data/spec/factories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryGirl.define do
   sequence :apns_token do |i|
     "ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b596#{i}"
@@ -7,6 +9,10 @@ FactoryGirl.define do
     "APA91bHPRgkF3JUikC4ENAHEeMrd41Zxv3hVZjC9KtT8OvPVGJ-hQMRKRrZuJAEcl7B338qju59zJMjw2DELjzEvxwYv7hH5Ynpc1ODQ0aT4U4OFEeco8ohsN5PjL1iC2dNtk2BAokeMCg2ZXKqpc8FXKmhX94kIxQ#{i}"
   end
 
+  sequence :fcm_registration_id do |i|
+    "egp-7jEODbM:APA91bGODoU9taMK10FDVvJI_ZhKXHl_GKoLKIDrQ0PTJn5SD2mFOtOiPxeTlkATAYI-eU4oucF6rPsAiXdgu9fFbmuDsprmx_bakCFPvIoN1Axg8SzqtnZpzagc0LZOJxNeZB-VVgcc#{i}"
+  end
+
   sequence :mpns_device_url do |i|
     "http://s.notify.live.net/u/1/bn1/HmQAAACP-0esPuxBSkzBNNXH4W0lV3lK-stEw6eRfpXX39uYbM7IwehXOTO9pRBjaaGECWOdD_7x5j5U4w4iXG4hGxer/d2luZG93c3Bob25lZGVmYXVsdA/EMDhx32Q5BG0DWnZpuVX1g/kRFAu0-jnhMQ-HG94rXzrbb0wQk#{i}"
   end

data/spec/factories/notifications.rb

@@ -1,26 +1,63 @@
+# frozen_string_literal: true
+
 FactoryGirl.define do
-  factory :apns_notification, class: 'RubyPushNotifications::APNS::APNSNotification' do
+  factory :apns_notification,
+          class: 'RubyPushNotifications::APNS::APNSNotification' do
     tokens { [generate(:apns_token)] }
     data a: 1
 
     initialize_with { new tokens, data }
   end
 
-  factory :gcm_notification, class: 'RubyPushNotifications::GCM::GCMNotification' do
+  factory :gcm_notification,
+          class: 'RubyPushNotifications::GCM::GCMNotification' do
     registration_ids { [generate(:gcm_registration_id)] }
     data a: 1
 
     initialize_with { new registration_ids, data }
   end
 
-  factory :mpns_notification, class: 'RubyPushNotifications::MPNS::MPNSNotification' do
+  factory :fcm_notification,
+          class: 'RubyPushNotifications::FCM::FCMNotification' do
+    registration_ids { [generate(:fcm_registration_id)] }
+    data a:
+           {
+             notification: {
+               title: 'Greetings Test',
+               body: 'Remember to test! ALOT!',
+               forceStart: 1,
+               sound: 'default',
+               vibrate: 'true',
+               icon: 'fcm_push_icon'
+             },
+             android: {
+               priority: 'high',
+               vibrate: 'true'
+             },
+             data: {
+               url: 'https://www.google.com'
+             },
+             webpush: {
+               headers: {
+                 TTL: '60'
+               }
+             },
+             priority: 'high'
+           }
+
+    initialize_with { new registration_ids, data }
+  end
+
+  factory :mpns_notification,
+          class: 'RubyPushNotifications::MPNS::MPNSNotification' do
     device_urls { [generate(:mpns_device_url)] }
     data message: { value1: 'hello' }
 
     initialize_with { new device_urls, data }
   end
 
-  factory :wns_notification, class: 'RubyPushNotifications::WNS::WNSNotification' do
+  factory :wns_notification,
+          class: 'RubyPushNotifications::WNS::WNSNotification' do
     device_urls { [generate(:wns_device_url)] }
     data message: { value1: 'hello' }
 

data/spec/ruby-push-notifications/fcm/fcm_connection_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    describe FCMConnection do
+      describe '::post' do
+        let(:body) { 'abc' }
+        let(:key) { 'def' }
+        let(:response) { JSON.dump a: 1 }
+
+        before do
+          stub_request(
+            :post,
+            'https://fcm.googleapis.com/fcm/send'
+          ).to_return status: [200, 'OK'],
+                      body: response
+        end
+        it 'runs the right request' do
+          FCMConnection.post body, key
+          url = 'https://fcm.googleapis.com/fcm/send'
+          headers = { 'Content-Type' => 'application/json',
+                      'Authorization' => "key=#{key}" }
+
+          expect(
+            WebMock
+          ).to have_requested(:post, url).with(body: body,
+                                               headers: headers).once
+        end
+
+        context 'when :url option is present' do
+          it 'posts data to a custom FCM endpoint' do
+            test_url = 'https://example.com/fcm/send'
+            stub_request(:post, test_url).to_return status: [200, 'OK'],
+                                                    body: response
+
+            FCMConnection.post body, key, url: test_url
+            url = 'https://example.com/fcm/send'
+            headers = { 'Content-Type' => 'application/json',
+                        'Authorization' => "key=#{key}" }
+
+            expect(
+              WebMock
+            ).to have_requested(:post,
+                                url).with(body: body,
+                                          headers: headers).once
+          end
+        end
+
+        it 'returns the response encapsulated in a FCMResponse object' do
+          expect(FCMConnection.post(body, key)).to eq FCMResponse.new(200,
+                                                                      response)
+        end
+      end
+    end
+  end
+end

data/spec/ruby-push-notifications/fcm/fcm_notification_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    describe FCMNotification do
+      let(:registration_ids) { %w[a] }
+      let(:data) do
+        {
+          a: {
+            notification: {
+              title: 'Greetings Test',
+              body: 'Remember to test! ALOT!',
+              forceStart: 1,
+              sound: 'default',
+              vibrate: 'true',
+              icon: 'fcm_push_icon'
+            },
+            android: {
+              priority: 'high',
+              vibrate: 'true'
+            },
+            data: {
+              url: 'https://www.google.com'
+            },
+            webpush: {
+              headers: {
+                TTL: '60'
+              }
+            },
+            priority: 'high'
+          }
+        }
+      end
+
+      let(:notification) do
+        build :fcm_notification,
+              registration_ids: registration_ids,
+              data: data
+      end
+
+      it 'builds the right fcm json' do
+        test_case = { registration_ids: registration_ids }.merge(data)
+        expect(notification.as_fcm_json).to include(JSON.dump(test_case))
+      end
+
+      it 'validates the registration_ids format'
+
+      # According to
+      # https://developer.android.com/google/fcm/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) { [FCMCanonicalIDResult.new(canonical_id)] }
+        let(:results) do
+          FCMResponse.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/fcm/fcm_pusher_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    describe FCMPusher do
+      let(:fcm_key) { 'fcm key' }
+      let(:pusher) { FCMPusher.new fcm_key }
+
+      describe '#push' do
+        let(:notif1) { build :fcm_notification }
+        let(:notif2) { build :fcm_notification }
+        let(:response) { JSON.dump a: 1 }
+
+        before do
+          stub_request(:post, 'https://fcm.googleapis.com/fcm/send').
+            to_return status: [200, 'OK'], body: response
+        end
+
+        it 'submits every notification' do
+          pusher.push [notif1, notif2]
+
+          expect(WebMock).
+            to have_requested(:post, 'https://fcm.googleapis.com/fcm/send').
+              with(body: notif1.as_fcm_json, headers: { 'Content-Type' => 'application/json', 'Authorization' => "key=#{fcm_key}" }).
+              once
+
+          expect(WebMock).
+            to have_requested(:post, 'https://fcm.googleapis.com/fcm/send').
+              with(body: notif2.as_fcm_json, headers: { 'Content-Type' => 'application/json', 'Authorization' => "key=#{fcm_key}" }).
+              once
+        end
+
+        it 'sets results to notifications' do
+          expect do
+            pusher.push [notif1, notif2]
+          end.to change { [notif1, notif2].map &:results }.from([nil, nil]).to [FCMResponse.new(200, response)] * 2
+        end
+
+        it 'splits notifications with more than 1000 destinations in parts'
+      end
+    end
+  end
+end

data/spec/ruby-push-notifications/fcm/fcm_response_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module RubyPushNotifications
+  module FCM
+    describe FCMResponse do
+      describe 'success' do
+        let(:successful_messages) { 3 }
+        let(:failed_messages) { 1 }
+        let(:canonical_ids) { 2 }
+        let(:body) {
+          JSON.dump(
+            multicast_id: 123456789,
+            success: successful_messages,
+            failure: failed_messages,
+            canonical_ids: canonical_ids,
+            results: [
+              { message_id: 1,
+                registration_id: 'new_reg_id' },
+              { message_id: 2,
+                registration_id: 'new_reg_id_2' },
+              { message_id: 3 },
+              { message_id: 4,
+                error: 'NotRegistered' }
+            ]
+          )
+        }
+
+        let(:response) { FCMResponse.new 200, body }
+
+        it 'parses the number of successfully processed notifications' do
+          expect(response.success).to eq successful_messages
+        end
+
+        it 'parses the number of failed messages' do
+          expect(response.failed).to eq failed_messages
+        end
+
+        it 'parses the number of canonical ids received' do
+          expect(response.canonical_ids).to eq canonical_ids
+        end
+
+        it 'parses the results' do
+          expect(
+            response.results
+          ).to eq [FCMCanonicalIDResult.new('new_reg_id'),
+                   FCMCanonicalIDResult.new('new_reg_id_2'),
+                   FCMResultOK.new,
+                   FCMResultError.new('NotRegistered')]
+        end
+      end
+
+      describe 'errors' do
+        let(:dummy_response_body) { 'dummy response body' }
+        describe '400 Bad Request error code' do
+          it 'raises a MalformedFCMJSONError' do
+            expect do
+              FCMResponse.new 400, dummy_response_body
+            end.to raise_error MalformedFCMJSONError, dummy_response_body
+          end
+        end
+
+        describe '401 Unauthorized error code' do
+          it 'raises a FCMAuthError' do
+            expect do
+              FCMResponse.new 401, dummy_response_body
+            end.to raise_error FCMAuthError, dummy_response_body
+          end
+        end
+
+        describe '500 Internal Server Error error code' do
+          it 'raises a FCMInternalError' do
+            expect do
+              FCMResponse.new 500, dummy_response_body
+            end.to raise_error FCMInternalError, dummy_response_body
+          end
+        end
+
+        describe '302 Found error code' do
+          it 'raises a UnexpectedFCMResponseError' do
+            expect do
+              FCMResponse.new 302, dummy_response_body
+            end.to raise_error UnexpectedFCMResponseError, '302'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'simplecov'
 SimpleCov.start
@@ -15,7 +16,7 @@ Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
 def apns_binary(json, token, id)
   json = JSON.dump(json) if json.is_a?(Hash)
   [
-    2, 56+json.bytesize, 1, 32, token, 2, json.bytesize, json,
+    2, 56 + json.bytesize, 1, 32, token, 2, json.bytesize, json,
     3, 4, id, 4, 4, (Time.now + RubyPushNotifications::APNS::APNSNotification::WEEKS_4).to_i, 5, 1, 10
   ].pack 'cNcnH64cna*cnNcnNcnc'
 end

data/spec/support/factory_girl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods
 end

data/spec/support/results_shared_examples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples 'right results' do |success, failed, individual_results|
   it 'has the expected success value' do
     expect(notification.success).to eq success

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-push-notifications
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Carlos Alonso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,8 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.20'
 description: Easy to use gem to send iOS, Android and Windows Phone Push notifications
-email:
-- info@mrcalonso.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,6 +123,7 @@ files:
 - README.md
 - Rakefile
 - examples/apns.rb
+- examples/fcm.rb
 - examples/gcm.rb
 - examples/mpns.rb
 - examples/wns.rb
@@ -120,6 +134,13 @@ files:
 - 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/fcm.rb
+- lib/ruby-push-notifications/fcm/fcm_connection.rb
+- lib/ruby-push-notifications/fcm/fcm_error.rb
+- lib/ruby-push-notifications/fcm/fcm_notification.rb
+- lib/ruby-push-notifications/fcm/fcm_pusher.rb
+- lib/ruby-push-notifications/fcm/fcm_response.rb
+- lib/ruby-push-notifications/fcm/fcm_result.rb
 - lib/ruby-push-notifications/gcm.rb
 - lib/ruby-push-notifications/gcm/gcm_connection.rb
 - lib/ruby-push-notifications/gcm/gcm_error.rb
@@ -147,6 +168,10 @@ files:
 - spec/ruby-push-notifications/apns/apns_connection_spec.rb
 - spec/ruby-push-notifications/apns/apns_notification_spec.rb
 - spec/ruby-push-notifications/apns/apns_pusher_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_connection_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_notification_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_pusher_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_response_spec.rb
 - spec/ruby-push-notifications/gcm/gcm_connection_spec.rb
 - spec/ruby-push-notifications/gcm/gcm_notification_spec.rb
 - spec/ruby-push-notifications/gcm/gcm_pusher_spec.rb
@@ -184,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: iOS, Android and Windows Phone Push Notifications made easy!
@@ -194,6 +219,10 @@ test_files:
 - spec/ruby-push-notifications/apns/apns_connection_spec.rb
 - spec/ruby-push-notifications/apns/apns_notification_spec.rb
 - spec/ruby-push-notifications/apns/apns_pusher_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_connection_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_notification_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_pusher_spec.rb
+- spec/ruby-push-notifications/fcm/fcm_response_spec.rb
 - spec/ruby-push-notifications/gcm/gcm_connection_spec.rb
 - spec/ruby-push-notifications/gcm/gcm_notification_spec.rb
 - spec/ruby-push-notifications/gcm/gcm_pusher_spec.rb