ruby-push-notifications 1.1.0 → 1.2.0

data/lib/ruby-push-notifications/wns/wns_result.rb

@@ -0,0 +1,208 @@
+module RubyPushNotifications
+  module WNS
+    # Class that encapsulates the result of a single sent notification to a single
+    # Device URL
+    # https://msdn.microsoft.com/en-us/library/windows/apps/hh465435.aspx#WNSResponseCodes
+    class WNSResult
+      # @return [String]. Receiver WNS device URL.
+      attr_accessor :device_url
+
+      # @private X-WNS-NotificationStatus HTTP Header string
+      X_NOTIFICATION_STATUS  = 'x-wns-notificationstatus'
+
+      # @private X-WNS-DeviceConnectionStatus HTTP Header string
+      X_DEVICE_CONNECTION_STATUS  = 'x-wns-deviceconnectionstatus'
+
+      # @private X-SubscriptionStatus HTTP Header string
+      X_STATUS  = 'x-wns-status'
+    end
+
+    # Indicates that the notification was successfully sent to the corresponding
+    # device URL
+    class WNSResultOK < WNSResult
+      # @return [String]. The status of the notification received
+      # by the Windows Notification Service.
+      attr_accessor :notification_status
+
+      # @return [String]. The connection status of the device.
+      attr_accessor :device_connection_status
+
+      # @return [String]. Notification status.
+      attr_accessor :status
+
+      def initialize(device_url, headers)
+        @device_url = device_url
+        @notification_status = headers[X_NOTIFICATION_STATUS]
+        @device_connection_status = headers[X_DEVICE_CONNECTION_STATUS]
+        @status = headers[X_STATUS]
+      end
+
+      def ==(other)
+        (other.is_a?(WNSResultOK) &&
+          device_url == other.device_url &&
+          notification_status == other.notification_status &&
+          device_connection_status == other.device_connection_status &&
+          status == other.status) || super(other)
+      end
+    end
+
+    # This error occurs when the cloud service sends a notification
+    # request with a bad XML document or malformed notification URI.
+    class MalformedWNSResultError < WNSResult
+      def initialize(device_url)
+        @device_url = device_url
+      end
+
+      def ==(other)
+        (other.is_a?(MalformedWNSResultError) &&
+          device_url == other.device_url) || super(other)
+      end
+    end
+
+    # Sending this notification is unauthorized.
+    class WNSAuthError < WNSResult
+      def initialize(device_url)
+        @device_url = device_url
+      end
+
+      def ==(other)
+        (other.is_a?(WNSAuthError) &&
+          device_url == other.device_url) || super(other)
+      end
+    end
+
+    # Notification is invalid and is not present on the Push Notification Service.
+    class WNSInvalidError < WNSResult
+      # @return [String]. The status of the notification received
+      # by the Windows Notification Service.
+      attr_accessor :notification_status
+
+      # @return [String]. The connection status of the device.
+      attr_accessor :device_connection_status
+
+      # @return [String]. Notification status.
+      attr_accessor :status
+
+      def initialize(device_url, headers)
+        @device_url = device_url
+        @notification_status = headers[X_NOTIFICATION_STATUS]
+        @device_connection_status = headers[X_DEVICE_CONNECTION_STATUS]
+        @status = headers[X_STATUS]
+      end
+
+      def ==(other)
+        (other.is_a?(WNSInvalidError) &&
+          device_url == other.device_url &&
+          notification_status == other.notification_status &&
+          device_connection_status == other.device_connection_status &&
+          status == other.status) || super(other)
+      end
+    end
+
+    # This error occurs when an unauthenticated cloud service has reached
+    # the per-day throttling limit for a subscription,
+    # or when a cloud service (authenticated or unauthenticated)
+    # has sent too many notifications per second.
+    class WNSLimitError < WNSResult
+      # @return [String]. The status of the notification received
+      # by the Windows Notification Service.
+      attr_accessor :notification_status
+
+      # @return [String]. The connection status of the device.
+      attr_accessor :device_connection_status
+
+      # @return [String]. Notification status.
+      attr_accessor :status
+
+      def initialize(device_url, headers)
+        @device_url = device_url
+        @notification_status = headers[X_NOTIFICATION_STATUS]
+        @device_connection_status = headers[X_DEVICE_CONNECTION_STATUS]
+        @status = headers[X_STATUS]
+      end
+
+      def ==(other)
+        (other.is_a?(WNSLimitError) &&
+          device_url == other.device_url &&
+          notification_status == other.notification_status &&
+          device_connection_status == other.device_connection_status &&
+          status == other.status) || super(other)
+      end
+    end
+
+    # The device is in a disconnected state.
+    class WNSPreConditionError < WNSResult
+      # @return [String]. The status of the notification received
+      # by the Windows Notification Service.
+      attr_accessor :notification_status
+
+      # @return [String]. The connection status of the device.
+      attr_accessor :device_connection_status
+
+      def initialize(device_url, headers)
+        @device_url = device_url
+        @notification_status = headers[X_NOTIFICATION_STATUS]
+        @device_connection_status = headers[X_DEVICE_CONNECTION_STATUS]
+      end
+
+      def ==(other)
+        (other.is_a?(WNSPreConditionError) &&
+          device_url == other.device_url &&
+          notification_status == other.notification_status &&
+          device_connection_status == other.device_connection_status) || super(other)
+      end
+    end
+
+    # The device is in a disconnected state.
+    class WNSExpiredError < WNSResult
+      # @return [String]. The status of the notification received
+      # by the Windows Notification Service.
+      attr_accessor :notification_status
+
+      # @return [String]. The connection status of the device.
+      attr_accessor :device_connection_status
+
+      # @return [String]. Notification status.
+      attr_accessor :status
+
+      def initialize(device_url, headers)
+        @device_url = device_url
+        @notification_status = headers[X_NOTIFICATION_STATUS]
+        @device_connection_status = headers[X_DEVICE_CONNECTION_STATUS]
+        @status = 'Expired'.freeze
+      end
+
+      def ==(other)
+        (other.is_a?(WNSExpiredError) &&
+          device_url == other.device_url &&
+          notification_status == other.notification_status &&
+          device_connection_status == other.device_connection_status &&
+          status == other.status) || super(other)
+      end
+    end
+
+    # The Push Notification Service is unable to process the request.
+    class WNSInternalError < WNSResult
+      def initialize(device_url)
+        @device_url = device_url
+      end
+
+      def ==(other)
+        (other.is_a?(WNSInternalError) &&
+          device_url == other.device_url) || super(other)
+      end
+    end
+
+    # Unknow Error
+    class WNSResultError < WNSResult
+      def initialize(device_url)
+        @device_url = device_url
+      end
+
+      def ==(other)
+        (other.is_a?(WNSResultError) &&
+          device_url == other.device_url) || super(other)
+      end
+    end
+  end
+end

data/ruby-push-notifications.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "ruby-push-notifications"
-  spec.version       = "1.1.0"
+  spec.version       = "1.2.0"
   spec.authors       = ['Carlos Alonso']
   spec.email         = ['info@mrcalonso.com']
   spec.summary       = %q{iOS, Android and Windows Phone Push Notifications made easy!}

data/spec/factories.rb

@@ -1,4 +1,3 @@
-
 FactoryGirl.define do
   sequence :apns_token do |i|
     "ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b596#{i}"
@@ -12,4 +11,7 @@ FactoryGirl.define do
     "http://s.notify.live.net/u/1/bn1/HmQAAACP-0esPuxBSkzBNNXH4W0lV3lK-stEw6eRfpXX39uYbM7IwehXOTO9pRBjaaGECWOdD_7x5j5U4w4iXG4hGxer/d2luZG93c3Bob25lZGVmYXVsdA/EMDhx32Q5BG0DWnZpuVX1g/kRFAu0-jnhMQ-HG94rXzrbb0wQk#{i}"
   end
 
+  sequence :wns_device_url do |i|
+    "https://hk2.notify.windows.com/?token=AwYAAABe%2bpjShu%2fzcVaaf1NPm%2b2dpiosm7RnmBJGMVkBDiYNXpAEp0mETldEu8axFoamgwb%2fdKCuNSfGGDHZ3RcaO2fcNGfxC6Y4Yp3xTFkDOhv5kNfgSXef7pSP0uwueIpqbWI%3d#{i}"
+  end
 end

data/spec/factories/notifications.rb

@@ -20,4 +20,11 @@ FactoryGirl.define do
     initialize_with { new device_urls, data }
   end
 
+  factory :wns_notification, class: 'RubyPushNotifications::WNS::WNSNotification' do
+    device_urls { [generate(:wns_device_url)] }
+    data message: { value1: 'hello' }
+
+    initialize_with { new device_urls, data }
+  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

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