fcm-ruby-push-notifications 1.2.0

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

@@ -0,0 +1,101 @@
+require 'builder'
+
+module RubyPushNotifications
+  module WNS
+    # Encapsulates a WNS Notification.
+    # Actually support for raw, toast, tiles notifications
+    # (http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202945)
+    #
+    class WNSNotification
+      include RubyPushNotifications::NotificationResultsManager
+
+      # @return [Hash]. Payload to send.
+      #   Toast :title => a bold message
+      #     :message => the small message
+      #     :param => a string parameter that is passed to the app
+      #   Tile :image => a new image for the tile
+      #     :count => a number to show on the tile
+      #     :title => the new title of the tile
+      #     :back_image => an image for the back of the tile
+      #     :back_title => a title on the back of the tile
+      #     :back_content => some content (text) for the back
+      #   Raw :message => the full Hash message body
+      attr_reader :data
+
+      # @return [Array]. Array with the receiver's WNS device URLs.
+      attr_reader :device_urls
+
+      # Initializes the notification
+      #
+      # @param [Array]. Array with the receiver's device urls.
+      # @param [Hash]. Payload to send.
+      #   Toast :title => a bold message
+      #     :message => the small message
+      #     :param => a string parameter that is passed to the app
+      #   Tile :image => a new image for the tile
+      #     :count => a number to show on the tile
+      #     :title => the new title of the tile
+      #     :back_image => an image for the back of the tile
+      #     :back_title => a title on the back of the tile
+      #     :back_content => some content (text) for the back
+      #   Raw :message => the full XML message body
+      def initialize(device_urls, data)
+        @device_urls = device_urls
+        @data = data
+        @data[:type] ||= :raw
+      end
+
+      # @return [String]. The WNS's XML format for the payload to send.
+      # (https://docs.microsoft.com/en-us/uwp/schemas/tiles/tiles-xml-schema-portal)
+      def as_wns_xml
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        if data[:type] != :raw
+          case data[:type]
+          when :toast
+            xml.tag!('toast', **launch_params(data)) do
+              xml.tag!('visual') do
+                xml.tag!('binding', template: data[:template] || 'ToastText02') do
+                  xml.tag!('text', id: 1) { xml.text!(data[:title].to_s) }
+                  xml.tag!('text', id: 2) { xml.text!(data[:message].to_s) }
+                end
+              end
+            end
+          when :tile
+            xml.tag!('tile') do
+              xml.tag!('visual') do
+                xml.tag!('binding', template: data[:template] || 'TileWideImageAndText01') do
+                  xml.tag!('image', src: data[:image].to_s)
+                  xml.tag!('text') { xml.text!(data[:message].to_s) }
+                end
+              end
+            end
+          when :badge
+            xml.tag!('badge', value: data[:value])
+          end
+        else
+          xml.root { build_hash(xml, data[:message]) }
+        end
+        xml.target!
+      end
+
+      def each_device
+        @device_urls.each do |url|
+          yield(URI.parse url)
+        end
+      end
+
+      def build_hash(xml, options)
+        return unless options
+        options.each do |k, v|
+          xml.tag!(k.to_s) { v.is_a?(Hash) ? build_hash(xml, v) : xml.text!(v.to_s) }
+        end
+      end
+
+      def launch_params(data)
+        return {} unless data[:param]
+        { launch: data[:param].to_json }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module RubyPushNotifications
+  module WNS
+
+    # This class is responsible for sending notifications to the WNS service.
+    #
+    class WNSPusher
+
+      # Initializes the WNSPusher
+      #
+      # @param access_token [String]. WNS access token.
+      # @param options [Hash] optional. Options for GCMPusher. Currently supports:
+      #   * 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.
+      # (http://msdn.microsoft.com/pt-br/library/windows/apps/ff941099)
+      def initialize(access_token, options = {})
+        @access_token = access_token
+        @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 WNSNotification to send.
+      def push(notifications)
+        notifications.each do |notif|
+          notif.results = WNSConnection.post notif, @access_token, @options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module RubyPushNotifications
+  module WNS
+
+    # This class encapsulates a response received from the WNS service
+    # and helps parsing and understanding the received messages/codes.
+    #
+    class WNSResponse
+
+      # @return [Integer] the number of successfully sent notifications
+      attr_reader :success
+
+      # @return [Integer] the number of failed notifications
+      attr_reader :failed
+
+      # @return [Array] Array of a WNSResult for every receiver of the notification
+      #   sent indicating the result of the operation.
+      attr_reader :results
+      alias_method :individual_results, :results
+
+      # Initializes the WNSResponse and runs response parsing
+      #
+      # @param responses [Array]. Array with device_urls and http responses
+      def initialize(responses)
+        parse_response responses
+      end
+
+      def ==(other)
+        (other.is_a?(WNSResponse) &&
+          success == other.success &&
+          failed == other.failed &&
+          results == other.results) || super(other)
+      end
+
+      private
+
+      # Parses the response extracting counts for successful, failed messages.
+      # Also creates the results array assigning a WNSResult subclass for each
+      # device URL the notification was sent to.
+      #
+      # @param responses [Array]. Array of hash responses
+      def parse_response(responses)
+        @success = responses.count { |response| response[:code] == 200 }
+        @failed = responses.count { |response| response[:code] != 200 }
+        @results = responses.map do |response|
+          wns_result_for response[:code],
+                          response[:device_url],
+                          response[:headers]
+        end
+      end
+
+      # Factory method that, for each WNS result object assigns a WNSResult
+      # subclass.
+      #
+      # @param code [Integer]. The HTTP status code received
+      # @param device_url [String]. The receiver's WNS device url.
+      # @param headers [Hash]. The HTTP headers received.
+      # @return [WNSResult]. Corresponding WNSResult subclass
+      def wns_result_for(code, device_url, headers)
+        case code
+        when 200
+          WNSResultOK.new device_url, headers
+        when 400
+          MalformedWNSResultError.new device_url
+        when 401
+          WNSAuthError.new device_url
+        when 404
+          WNSInvalidError.new device_url, headers
+        when 406
+          WNSLimitError.new device_url, headers
+        when 410
+          WNSExpiredError.new device_url, headers
+        when 412
+          WNSPreConditionError.new device_url, headers
+        when 500..599
+          WNSInternalError.new device_url
+        else
+          WNSResultError.new device_url
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "fcm-ruby-push-notifications"
+  spec.version       = "1.2.0"
+  spec.authors       = ['Santhu MS']
+  spec.email         = ['santhu.ms83@gmail.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/santhums/ruby-push-notifications'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'builder', '~> 3.0'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'factory_girl', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+end