fcm-ruby-push-notifications 1.2.0

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

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

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

@@ -0,0 +1,37 @@
+
+module RubyPushNotifications
+  module GCM
+    describe GCMNotification do
+
+      let(:registration_ids) { %w(a b c) }
+      let(:data) { { a: 1 } }
+      let(:notification) { build :gcm_notification, registration_ids: registration_ids, data: data }
+
+      it 'builds the right gcm json' do
+        expect(notification.as_gcm_json).to eq JSON.dump(
+          registration_ids: registration_ids,
+          data: data
+        )
+      end
+
+      it 'validates the registration_ids format'
+
+      # 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/gcm/gcm_pusher_spec.rb

@@ -0,0 +1,45 @@
+
+module RubyPushNotifications
+  module GCM
+    describe GCMPusher do
+
+      let(:gcm_key) { 'gcm key' }
+      let(:pusher) { GCMPusher.new gcm_key }
+
+      describe '#push' do
+
+        let(:notif1) { build :gcm_notification }
+        let(:notif2) { build :gcm_notification }
+        let(:response) { JSON.dump a: 1 }
+
+        before do
+          stub_request(:post, 'https://android.googleapis.com/gcm/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://android.googleapis.com/gcm/send').
+              with(body: notif1.as_gcm_json, headers: { 'Content-Type' => 'application/json', 'Authorization' => "key=#{gcm_key}" }).
+                once
+
+          expect(WebMock).
+            to have_requested(:post, 'https://android.googleapis.com/gcm/send').
+              with(body: notif2.as_gcm_json, headers: { 'Content-Type' => 'application/json', 'Authorization' => "key=#{gcm_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 [GCMResponse.new(200, response)]*2
+        end
+
+        it 'splits notifications with more than 1000 destinations in parts'
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+
+module RubyPushNotifications
+  module GCM
+    describe GCMResponse 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) { GCMResponse.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 [GCMCanonicalIDResult.new('new_reg_id'), GCMCanonicalIDResult.new('new_reg_id_2'), GCMResultOK.new, GCMResultError.new('NotRegistered')]
+        end
+      end
+
+      describe 'errors' do
+        let(:dummy_response_body) { 'dummy response body' }
+        describe '400 Bad Request error code' do
+          it 'raises a MalformedGCMJSONError' do
+            expect do
+              GCMResponse.new 400, dummy_response_body
+            end.to raise_error MalformedGCMJSONError, dummy_response_body
+          end
+        end
+
+        describe '401 Unauthorized error code' do
+          it 'raises a GCMAuthError' do
+            expect do
+              GCMResponse.new 401, dummy_response_body
+            end.to raise_error GCMAuthError, dummy_response_body
+          end
+        end
+
+        describe '500 Internal Server Error error code' do
+          it 'raises a GCMInternalError' do
+            expect do
+              GCMResponse.new 500, dummy_response_body
+            end.to raise_error GCMInternalError, dummy_response_body
+          end
+        end
+
+        describe '302 Found error code' do
+          it 'raises a UnexpectedGCMResponseError' do
+            expect do
+              GCMResponse.new 302, dummy_response_body
+            end.to raise_error UnexpectedGCMResponseError, '302'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+
+module RubyPushNotifications
+  module MPNS
+    describe MPNSConnection do
+
+      describe '::post' do
+
+        let(:body) { 'abc' }
+        let(:headers) {
+          {
+            'x-notificationstatus' => 'Received',
+            'x-deviceconnectionstatus' => 'Connected',
+            'x-subscriptionstatus' => 'Active'
+          }
+        }
+        let(:device_urls) { [generate(:mpns_device_url)] }
+        let(:toast_data) { { title: 'Title', message: 'Hello MPNS World!', type: :toast } }
+        let(:toast_notification) { build :mpns_notification, device_urls: device_urls, data: toast_data }
+
+        before do
+          stub_request(:post, %r{s.notify.live.net}).
+            to_return status: [200, 'OK'], body: body, headers: headers
+        end
+
+        it 'runs the right request' do
+          MPNSConnection.post toast_notification
+
+          expect(WebMock).
+            to have_requested(:post, toast_notification.device_urls[0]).
+              with(body: toast_notification.as_mpns_xml, headers: { 'Content-Type' => 'text/xml', 'X-NotificationClass' => '2', 'X-WindowsPhone-Target' => :toast}).
+                once
+        end
+
+        it 'returns the response encapsulated in a Hash object' do
+          responses =  [
+            { device_url: toast_notification.device_urls[0],
+              headers: headers,
+              code: 200
+            }
+          ]
+          expect(MPNSConnection.post toast_notification).to eq MPNSResponse.new(responses)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+
+module RubyPushNotifications
+  module MPNS
+    describe MPNSNotification do
+
+      let(:device_urls) { %w(a b c) }
+      let(:raw_notification) { build :mpns_notification }
+      let(:toast_data) { { title: 'Title', message: 'Hello MPNS World!', type: :toast } }
+      let(:toast_notification) { build :mpns_notification, device_urls: device_urls, data: toast_data }
+      let(:tile_data) { { count: 1, title: 'Hello MPNS World!', type: :tile } }
+      let(:tile_notification) { build :mpns_notification, device_urls: device_urls, data: tile_data }
+
+      it 'builds the right mpns raw xml' do
+        xml = '<?xml version="1.0" encoding="UTF-8"?>'
+        xml << '<root><value1>hello</value1></root>'
+        expect(raw_notification.as_mpns_xml).to eq xml
+      end
+
+      it 'builds the right mpns toast xml' do
+        xml = '<?xml version="1.0" encoding="UTF-8"?>'
+        xml << '<wp:Notification xmlns:wp="WPNotification"><wp:Toast>'
+        xml << '<wp:Text1>Title</wp:Text1>'
+        xml << '<wp:Text2>Hello MPNS World!</wp:Text2>'
+        xml << '</wp:Toast></wp:Notification>'
+        expect(toast_notification.as_mpns_xml).to eq xml
+      end
+
+      it 'builds the right mpns tile xml' do
+        xml = '<?xml version="1.0" encoding="UTF-8"?>'
+        xml << '<wp:Notification xmlns:wp="WPNotification"><wp:Tile>'
+        xml << '<wp:Count>1</wp:Count>'
+        xml << '<wp:Title>Hello MPNS World!</wp:Title>'
+        xml << '</wp:Tile></wp:Notification>'
+        expect(tile_notification.as_mpns_xml).to eq xml
+      end
+
+      it 'validates the mpns format'
+
+      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/ruby-push-notifications/mpns/mpns_pusher_spec.rb

@@ -0,0 +1,59 @@
+
+module RubyPushNotifications
+  module MPNS
+    describe MPNSPusher do
+
+      let(:pusher) { MPNSPusher.new }
+
+      describe '#push' do
+
+        let(:device_urls) { [generate(:mpns_device_url)] }
+        let(:notif1) { build :mpns_notification, device_urls: ['http://s.notify.live.net/1'],  data: { message: { value1: 'hello' } } }
+        let(:notif2) { build :mpns_notification, device_urls: ['http://s.notify.live.net/1'], data: { message: { value1: 'hello' } } }
+        let(:raw_notification) { build :mpns_notification }
+        let(:toast_data) { { title: 'Title', message: 'Hello MPNS World!', type: :toast } }
+        let(:toast_notification) { build :mpns_notification, device_urls: device_urls, data: toast_data }
+        let(:tile_data) { { count: 1, title: 'Hello MPNS World!', type: :tile } }
+        let(:tile_notification) { build :mpns_notification, device_urls: device_urls, data: tile_data }
+        let(:headers) {
+          {
+            'x-notificationstatus' => 'Received',
+            'x-deviceconnectionstatus' => 'Connected',
+            'x-subscriptionstatus' => 'Active'
+          }
+        }
+        let(:response) { [ { device_url: 'http://s.notify.live.net/1', headers: headers, code: 200 } ]}
+
+        before do
+          stub_request(:post, %r{s.notify.live.net}).
+            to_return status: [200, 'OK'], headers: headers
+        end
+
+        it 'submits every notification' do
+          pusher.push [raw_notification, toast_notification, tile_notification]
+          expect(WebMock).
+            to have_requested(:post, raw_notification.device_urls[0]).
+              with(body: raw_notification.as_mpns_xml, headers: { 'Content-Type' => 'text/xml', 'X-NotificationClass' => '3'}).
+                once
+
+          expect(WebMock).
+            to have_requested(:post, toast_notification.device_urls[0]).
+              with(body: toast_notification.as_mpns_xml, headers: { 'Content-Type' => 'text/xml', 'X-NotificationClass' => '2', 'X-WindowsPhone-Target' => :toast}).
+                once
+
+          expect(WebMock).
+            to have_requested(:post, tile_notification.device_urls[0]).
+              with(body: tile_notification.as_mpns_xml, headers: { 'Content-Type' => 'text/xml', 'X-NotificationClass' => '1', 'X-WindowsPhone-Target' => 'token'}).
+                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 [MPNSResponse.new(response)]*2
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+
+module RubyPushNotifications
+  module MPNS
+    describe MPNSResponse do
+
+      describe 'success' do
+
+        let(:successful_messages) { 2 }
+        let(:failed_messages) { 6 }
+        let(:headers) {
+          {
+            'x-notificationstatus' => 'Received',
+            'x-deviceconnectionstatus' => 'Connected',
+            'x-subscriptionstatus' => 'Active'
+          }
+        }
+
+        let(:responses) {
+          [
+            { device_url: '1', headers: headers, code: 200 },
+            { device_url: '2', headers: headers, code: 200 },
+            { device_url: '3', code: 400 },
+            { device_url: '4', code: 401 },
+            { device_url: '5', headers: headers, code: 404 },
+            { device_url: '6', headers: headers, code: 406 },
+            { device_url: '7', headers: headers, code: 412 },
+            { device_url: '8', code: 503 }
+          ]
+        }
+
+        let(:response) { MPNSResponse.new responses }
+        let(:result) { MPNSResultOK.new '1', headers }
+
+        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 results' do
+          expect(response.results).to eq [
+            MPNSResultOK.new('1', headers),
+            MPNSResultOK.new('2', headers),
+            MalformedMPNSResultError.new('3'),
+            MPNSAuthError.new('4'),
+            MPNSInvalidError.new('5', headers),
+            MPNSLimitError.new('6', headers),
+            MPNSPreConditionError.new('7', headers),
+            MPNSInternalError.new('8')
+          ]
+        end
+
+        it 'parses headers to result attributes' do
+          expect(result.notification_status).to eq 'Received'
+          expect(result.device_connection_status).to eq 'Connected'
+          expect(result.subscription_status).to eq 'Active'
+        end
+
+      end
+    end
+  end
+end

data/spec/ruby-push-notifications/wns/wns_access_spec.rb

@@ -0,0 +1,76 @@
+module RubyPushNotifications
+  module WNS
+    describe WNSAccess do
+      describe '::access_token' do
+        let(:sid) { 'sid' }
+        let(:secret) { 'secret' }
+
+        context 'when service return status OK' do
+          let(:body) {
+            "{\"token_type\":\"bearer\",\"access_token\":\"real_access_token\",\"expires_in\":86400}"
+          }
+          before do
+            stub_request(:post, "https://login.live.com/accesstoken.srf").
+              to_return status: [200, 'OK'], body: body
+          end
+
+          it 'returns correct response' do
+            response = OpenStruct.new(
+              status_code: 200,
+              status: 'OK',
+              error: nil,
+              error_description: nil,
+              access_token: 'real_access_token',
+              token_ttl: 86400
+            )
+            expect(WNSAccess.new(sid, secret).get_token.response).to eq(response)
+          end
+        end
+
+        context 'when service return an error' do
+          context 'when bad credentials' do
+            let(:body) {
+              "{\"error\":\"invalid_client\",\"error_description\":\"Invalid client id\"}"
+            }
+            before do
+              stub_request(:post, "https://login.live.com/accesstoken.srf").
+                to_return status: [400, 'Bad Request'], body: body
+            end
+
+            it 'returns correct response' do
+              response = OpenStruct.new(
+                status_code: 400,
+                status: 'Bad Request',
+                error: 'invalid_client',
+                error_description: 'Invalid client id',
+                access_token: nil,
+                token_ttl: nil
+              )
+              expect(WNSAccess.new(sid, secret).get_token.response).to eq(response)
+            end
+          end
+
+          context 'when bad request' do
+            let(:body) { '' }
+            before do
+              stub_request(:post, "https://login.live.com/accesstoken.srf").
+                to_return status: [500, 'Internal Server Error'], body: body
+            end
+
+            it 'returns correct response' do
+              response = OpenStruct.new(
+                status_code: 500,
+                status: 'Internal Server Error',
+                error: nil,
+                error_description: nil,
+                access_token: nil,
+                token_ttl: nil
+              )
+              expect(WNSAccess.new(sid, secret).get_token.response).to eq(response)
+            end
+          end
+        end
+      end
+    end
+  end
+end