fcm-ruby-push-notifications 1.2.0

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

@@ -0,0 +1,53 @@
+module RubyPushNotifications
+  module WNS
+    describe WNSConnection do
+
+      describe '::post' do
+        let(:body) { 'abc' }
+        let(:headers) {
+          {
+            'x-wns-notificationstatus' => 'Received',
+            'x-wns-deviceconnectionstatus' => 'Connected',
+            'x-wns-status' => 'Received'
+          }
+        }
+        let(:push_types) { RubyPushNotifications::WNS::WNSConnection::WP_TARGETS }
+        let(:access_token) { 'token' }
+        let(:device_urls) { [generate(:wns_device_url)] }
+        let(:toast_data) { { title: 'Title', message: 'Hello WNS World!', type: :toast } }
+        let(:toast_notification) { build :wns_notification, device_urls: device_urls, data: toast_data }
+        let(:wns_connection) { RubyPushNotifications::WNS::WNSConnection }
+
+        before do
+          stub_request(:post, %r{hk2.notify.windows.com}).
+            to_return status: [200, 'OK'], body: body, headers: headers
+        end
+
+        it 'runs the right request' do
+          WNSConnection.post toast_notification, access_token
+          headers = {
+            wns_connection::CONTENT_TYPE_HEADER => wns_connection::CONTENT_TYPE[:toast],
+            wns_connection::X_WNS_TYPE_HEADER => wns_connection::WP_TARGETS[:toast],
+            wns_connection::CONTENT_LENGTH_HEADER => toast_notification.as_wns_xml.length.to_s,
+            wns_connection::AUTHORIZATION_HEADER => "Bearer #{access_token}",
+            wns_connection::REQUEST_FOR_STATUS_HEADER => 'true'
+          }
+          expect(WebMock).
+            to have_requested(:post, toast_notification.device_urls[0]).
+              with(body: toast_notification.as_wns_xml, headers: headers).
+                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(WNSConnection.post toast_notification, access_token).to eq WNSResponse.new(responses)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,177 @@
+module RubyPushNotifications
+  module WNS
+    describe WNSNotification do
+      let(:device_urls) { %w(a b c) }
+      let(:raw_data) { { message: { title: 'Title', message: 'Hello WNS World!'} } }
+      let(:raw_notification) { build :wns_notification, data: raw_data }
+      let(:toast_data) { { title: 'Title', message: 'Hello WNS World!', type: :toast } }
+      let(:toast_notification) { build :wns_notification, device_urls: device_urls, data: toast_data }
+      let(:tile_data) { { message: 'Hello WNS World!', image: 'http://image.com/image.jpg', type: :tile } }
+      let(:tile_notification) { build :wns_notification, device_urls: device_urls, data: tile_data }
+      let(:badge_data) { { value: 10, type: :badge } }
+      let(:badge_notification) { build :wns_notification, device_urls: device_urls, data: badge_data }
+
+      describe 'raw xml' do
+        it 'builds the right wns raw xml' do
+          xml = '<?xml version="1.0" encoding="UTF-8"?>'
+          xml << '<root><title>Title</title><message>Hello WNS World!</message></root>'
+          expect(raw_notification.as_wns_xml).to eq xml
+        end
+
+        context 'without message' do
+          let(:raw_data) { {} }
+
+          it 'builds the right wns raw xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<root></root>'
+            expect(raw_notification.as_wns_xml).to eq xml
+          end
+        end
+      end
+
+      describe 'badge xml' do
+        it 'builds the right wns badge xml' do
+          xml = '<?xml version="1.0" encoding="UTF-8"?>'
+          xml << '<badge value="10"/>'
+          expect(badge_notification.as_wns_xml).to eq xml
+        end
+
+        context 'without value' do
+          let(:badge_data) { { type: :badge } }
+
+          it 'builds the right wns badge xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<badge value=""/>'
+            expect(badge_notification.as_wns_xml).to eq xml
+          end
+        end
+      end
+
+      describe 'toast xml' do
+        it 'builds the right wns toast xml' do
+          xml = '<?xml version="1.0" encoding="UTF-8"?>'
+          xml << '<toast>'
+          xml << '<visual>'
+          xml << '<binding template="ToastText02">'
+          xml << '<text id="1">Title</text>'
+          xml << '<text id="2">Hello WNS World!</text>'
+          xml << '</binding>'
+          xml << '</visual>'
+          xml << '</toast>'
+          expect(toast_notification.as_wns_xml).to eq xml
+        end
+
+        context 'when params present' do
+          let(:toast_data) { super().merge(param: { var1: 'value1', var2: 'value2'}) }
+
+          it 'builds the right wns toast xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<toast launch="{&quot;var1&quot;:&quot;value1&quot;,&quot;var2&quot;:&quot;value2&quot;}">'
+            xml << '<visual>'
+            xml << '<binding template="ToastText02">'
+            xml << '<text id="1">Title</text>'
+            xml << '<text id="2">Hello WNS World!</text>'
+            xml << '</binding>'
+            xml << '</visual>'
+            xml << '</toast>'
+            expect(toast_notification.as_wns_xml).to eq xml
+          end
+        end
+
+        context 'when template present' do
+          let(:toast_data) { super().merge(template: 'custom_template') }
+
+          it 'builds the right wns toast xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<toast>'
+            xml << '<visual>'
+            xml << '<binding template="custom_template">'
+            xml << '<text id="1">Title</text>'
+            xml << '<text id="2">Hello WNS World!</text>'
+            xml << '</binding>'
+            xml << '</visual>'
+            xml << '</toast>'
+            expect(toast_notification.as_wns_xml).to eq xml
+          end
+        end
+
+        context 'without title and message' do
+          let(:toast_data) { { type: :toast } }
+
+          it 'builds the right wns toast xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<toast>'
+            xml << '<visual>'
+            xml << '<binding template="ToastText02">'
+            xml << '<text id="1"></text>'
+            xml << '<text id="2"></text>'
+            xml << '</binding>'
+            xml << '</visual>'
+            xml << '</toast>'
+            expect(toast_notification.as_wns_xml).to eq xml
+          end
+        end
+      end
+
+      describe 'toast xml' do
+        it 'builds the right wns tile xml' do
+          xml = '<?xml version="1.0" encoding="UTF-8"?>'
+          xml << '<tile>'
+          xml << '<visual>'
+          xml << '<binding template="TileWideImageAndText01">'
+          xml << '<image src="http://image.com/image.jpg"/>'
+          xml << '<text>Hello WNS World!</text>'
+          xml << '</binding>'
+          xml << '</visual>'
+          xml << '</tile>'
+          expect(tile_notification.as_wns_xml).to eq xml
+        end
+
+        context 'when template present' do
+          let(:tile_data) { super().merge(template: 'custom_template') }
+
+          it 'builds the right wns toast xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<tile>'
+            xml << '<visual>'
+            xml << '<binding template="custom_template">'
+            xml << '<image src="http://image.com/image.jpg"/>'
+            xml << '<text>Hello WNS World!</text>'
+            xml << '</binding>'
+            xml << '</visual>'
+            xml << '</tile>'
+            expect(tile_notification.as_wns_xml).to eq xml
+          end
+        end
+
+        context 'without image and message' do
+          let(:tile_data) { { type: :tile } }
+
+          it 'builds the right wns toast xml' do
+            xml = '<?xml version="1.0" encoding="UTF-8"?>'
+            xml << '<tile>'
+            xml << '<visual>'
+            xml << '<binding template="TileWideImageAndText01">'
+            xml << '<image src=""/>'
+            xml << '<text></text>'
+            xml << '</binding>'
+            xml << '</visual>'
+            xml << '</tile>'
+            expect(tile_notification.as_wns_xml).to eq xml
+          end
+        end
+      end
+
+      it_behaves_like 'a proper results manager' do
+        let(:notification) { build :wns_notification }
+        let(:success_count) { 1 }
+        let(:failures_count) { 0 }
+        let(:device_url) { generate :wns_device_url }
+        let(:individual_results) { [WNSResultOK.new(device_url, {})] }
+        let(:results) do
+          WNSResponse.new [{ code: 200, device_url: device_url, headers: {} }]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+module RubyPushNotifications
+  module WNS
+    describe WNSPusher do
+      let(:access_token) { 'token' }
+      let(:pusher) { WNSPusher.new(access_token) }
+
+      describe '#push' do
+        let(:device_urls) { [generate(:wns_device_url)] }
+        let(:notifications) { build_list(:wns_notification, 2, device_urls: ['http://hk2.notify.windows.com/1'], data: { message: { value1: 'hello' } }).to_a }
+        let(:raw_notification) { build :wns_notification }
+        let(:toast_data) { { title: 'Title', message: 'Hello WNS World!', type: :toast } }
+        let(:toast_notification) { build :wns_notification, device_urls: device_urls, data: toast_data }
+        let(:tile_data) { { message: 'Hello WNS World!', image: 'http://image.com/image.jpg', type: :tile } }
+        let(:tile_notification) { build :wns_notification, device_urls: device_urls, data: tile_data }
+        let(:badge_data) { { value: 10, type: :badge } }
+        let(:badge_notification) { build :wns_notification, device_urls: device_urls, data: badge_data }
+
+        let(:headers) {
+          {
+            'x-wns-notificationstatus' => 'Received',
+            'x-wns-deviceconnectionstatus' => 'Connected',
+            'x-wns-status' => 'Received'
+          }
+        }
+        let(:wns_connection) { RubyPushNotifications::WNS::WNSConnection }
+        let(:response) { [ { device_url: 'http://hk2.notify.windows.com/1', headers: headers, code: 200 } ]}
+
+        before do
+          stub_request(:post, %r{hk2.notify.windows.com}).
+            to_return status: [200, 'OK'], headers: headers
+        end
+
+        it 'submits every notification' do
+          pusher.push [raw_notification, toast_notification, tile_notification, badge_notification]
+          %i(raw toast tile badge).each do |push_type|
+            headers = {
+              wns_connection::CONTENT_TYPE_HEADER => wns_connection::CONTENT_TYPE[push_type],
+              wns_connection::X_WNS_TYPE_HEADER => wns_connection::WP_TARGETS[push_type],
+              wns_connection::CONTENT_LENGTH_HEADER => public_send("#{push_type}_notification").as_wns_xml.length.to_s,
+              wns_connection::AUTHORIZATION_HEADER => "Bearer #{access_token}",
+              wns_connection::REQUEST_FOR_STATUS_HEADER => 'true'
+            }
+            expect(WebMock).
+              to have_requested(:post, public_send("#{push_type}_notification").device_urls[0]).
+                with(body: public_send("#{push_type}_notification").as_wns_xml, headers: headers).
+                  once
+          end
+        end
+
+        it 'sets results to notifications' do
+          expect do
+            pusher.push notifications
+          end.to change { notifications.map(&:results) }.from([nil, nil]).to [WNSResponse.new(response)] * 2
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module RubyPushNotifications
+  module WNS
+    describe WNSResponse do
+
+      describe 'success' do
+
+        let(:successful_messages) { 2 }
+        let(:failed_messages) { 7 }
+        let(:headers) {
+          {
+            'x-wns-notificationstatus' => 'Received',
+            'x-wns-deviceconnectionstatus' => 'Connected',
+            'x-wns-status' => 'Received'
+          }
+        }
+
+        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 },
+            { device_url: '9', headers: headers, code: 410 }
+          ]
+        }
+
+        let(:response) { WNSResponse.new responses }
+        let(:result) { WNSResultOK.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 [
+            WNSResultOK.new('1', headers),
+            WNSResultOK.new('2', headers),
+            MalformedWNSResultError.new('3'),
+            WNSAuthError.new('4'),
+            WNSInvalidError.new('5', headers),
+            WNSLimitError.new('6', headers),
+            WNSPreConditionError.new('7', headers),
+            WNSInternalError.new('8'),
+            WNSExpiredError.new('9', headers)
+          ]
+        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.status).to eq 'Received'
+        end
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require :defaults, :development
+require 'webmock/rspec'
+
+require 'ruby-push-notifications'
+
+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,
+    3, 4, id, 4, 4, (Time.now + RubyPushNotifications::APNS::APNSNotification::WEEKS_4).to_i, 5, 1, 10
+  ].pack 'cNcnH64cna*cnNcnNcnc'
+end
+
+WebMock.disable_net_connect!(:allow => "codeclimate.com")

data/spec/support/dummy.pem

@@ -0,0 +1,44 @@
+-----BEGIN CERTIFICATE-----
+MIICsDCCAhmgAwIBAgIJALwzrJEIBOaeMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQwHhcNMTEwOTMwMTUyNjM2WhcNMjEwOTI3MTUyNjM2WjBF
+MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50
+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB
+gQC88Ckwru9VR2p2KJ1WQyqesLzr95taNbhkYfsd0j8Tl0MGY5h+dczCaMQz0YY3
+xHXuU5yAQQTZjiks+D3KA3cx+iKDf2p1q77oXxQcx5CkrXBWTaX2oqVtHm3aX23B
+AIORGuPk00b4rT3cld7VhcEFmzRNbyI0EqLMAxIwceUKSQIDAQABo4GnMIGkMB0G
+A1UdDgQWBBSGmOdvSXKXclic5UOKPW35JLMEEjB1BgNVHSMEbjBsgBSGmOdvSXKX
+clic5UOKPW35JLMEEqFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUt
+U3RhdGUxITAfBgNVBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJALwzrJEI
+BOaeMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAcPfWn49pgAX54ji5
+SiUPFFNCuQGSSTHh2I+TMrs1G1Mb3a0X1dV5CNLRyXyuVxsqhiM/H2veFnTz2Q4U
+wdY/kPxE19Auwcz9AvCkw7ol1LIlLfJvBzjzOjEpZJNtkXTx8ROSooNrDeJl3HyN
+cciS5hf80XzIFqwhzaVS9gmiyM8=
+-----END CERTIFICATE-----
+-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEA6Lr0lAvQrywXhMnXpJaTBL6edduZUY20piiT82Vasere343B
+wcQFUMwGV9CrjSeOMI9jN/0PEw5ZJ5s4AwqYePxy3K05t6MV5UrDx6na7POfUOmC
+sfp+KgURY4jQUtOvbHeXr4CjXiMEOJcTTuRaiqy24tjcwkNsHW4/QRyZ1BdKI+8H
+x9HqpdwaVn2rCx36ZVukMUqv6y7m8QkDog02oLrneYQy8oMaVwkIcxNxFJzVqobN
+SDGXH2Wdh7usoF8P3PD+EuzCgCeP/kqLym4BYXp6tzJj3hT/85xxpsOjIulLuubK
+wJz9hngJ/C14DBjXjUmkN38R7XEkR3jvp0K09wIDAQABAoIBAF0irEwu6kWf/I18
+hRrt00obyqhZyGKVtgykwoiuJauCpSgY0q5rdsEd1RABhxXHFaUjTM6ULBsxK8ao
+3GKDM/9+76yWejmeP13ybKUTuXQIDuK/gDkfiKviOVI+5zeuVU6wEXj/nuFGXCMV
+enmg8wb6FXp01Ou9NaAVhaTWAE2afOQSZnI52NUNdV8qvic7+CXpq/W5A/eRIR9v
+aGaEzglyXPq3N8LUEjqx5abFijCT3fcLwvO2yOs8gxVhwrS0cr30JXnRxqmEghk9
+GsHyJvUyIEz2BFuzJ8sd0xVgej5wxPcdPcmVnGPGYZ/l+tSSw8XaXqmiBhPEElaa
+wBET0qECgYEA/aJrYviMbKzS0FuTLNVjEM/Zj60xgVMSZZ9GOqrm4nyIkxFLHmGC
+rnfeLiAnT0FlCZlO2vA71vXj8dNbhWSxD8EOCvu/oCcAJc0rmkmOgPIRrQMGcd7I
+s3RbT0ZykuX+JW2SlnMWIPPW4QK5MXfqNux42J/6jC/q0iaeGNPBC9ECgYEA6uaf
++YdIHgEYkgn8WjY3i8rX98QmXL9565nFmQe7RmzBZrzFLyKd7FjxjYIz1hk+CfFS
+jhMb4WNdeVvV8AVPTiTHomCxdVasfadfadsfdPFCHbkbizenFJf0DNx14qe7eSds
+2gQSZ3eTD7XdFNxqwF1dvPXPtDbVBa8SHlijDkcCgYB1tX4e9Xi+Ksq/tfAsu295
+auzuOBOkkDgWf3+pVI1IiUEc98aj998dNzYes/9qUdAhT0wAYcNztLQwE8YCt0NR
+K2hoAoPhQJhZ8skMlpyTDUTUxXWlPR5p4lNKDEi6EhELr7l7Jzga3O9Zh9kIsz04
+djBzYHN3wfk5xIBUx1ltMQKBgBMA8XRIg4cZ45j9AdNyi2/dyzcaQVhDjWOIHzpQ
+K9B4v/TF1NYJYOlcEL64B+WMST6YrWsdFKZZWZiV22r9ovrZcuUqGXE7PMgpXGcE
+jZZZTlYFQbszl2rNGEtqEodxtnMIw3+n0K1aOSWOOwKTCnfhldHRuSoFPZqmHTsj
+RJ3FAoGAXpx+ulBu99kOxOWWofmP7ff9DF3doF+Jmjwo6KdOAIq++74hNRgYCIKM
+X+4TSnmu8qBOt++r+EaBgxb+m+36iQxJRhU25ggzlA97v7n7KSxdyt7OLCe5zXP5
+iiMWAO+qJD6ZyHlzVz0wwu3nAvkhjTxQ2c3+7xjUwCZK1lXjvvM=
+-----END RSA PRIVATE KEY-----

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+
+FactoryGirl.find_definitions

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