ruby-push-notifications 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 233dc6f0f402cb52394547c792773699f75c920a
-  data.tar.gz: 375783019646d00e93261ef0b032fa59547a4ab6
+  metadata.gz: d47dcca6cd9dfae155c566c9b2b90ba334e5e3f5
+  data.tar.gz: 957bc60afb47661d910e50f771c46ea108dbe7df
 SHA512:
-  metadata.gz: f5bbf5568795d0026087b4e84a6856cf1de77738c1cac3daae2f136f9e16f221734b1becf2304d5ea24104cece5820926407b152a5b1a02290595dd4c4b163fe
-  data.tar.gz: 2f5a20d5a059bbf43c9116d3eb8af2cd4d5b5f00435cc6c674de1bf215746f7926742f6a92b30ac8863ed1a8769c0597e13e882de464cb1947d66f526ab410a0
+  metadata.gz: e0c21ac5060259358f3a304934cc562e7d959b7dd3894ce8aaaf87843a49cbf3a5764e450d48f606db1469bafb6f01a423cacabf4d20300e34433f15db550190
+  data.tar.gz: a012744bfd5eab89450238c778786a84a6bde7df4a7ccd406d0a0fc0bb3f7b53443c8e41708d05b52621b5678b93a136a99d741e8c1a8accaf7b36413969f51b

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unrealeased] - [unrealease date]
+
+## 1.2.0 - 2017-09-20
+- **Added**: Add support Windows Push Notification Services (WNS)
+
+## 1.1.0 - 2017-03-14
 - **Added**: Option (`url`) to set custom GCM endpoint (Android)
 - **Added**: Option (`host`) to set custom APNS environment (iOS)
 

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/calonso/ruby-push-notifications.svg)](https://travis-ci.org/calonso/ruby-push-notifications) [![Dependency Status](https://gemnasium.com/calonso/ruby-push-notifications.svg)](https://gemnasium.com/calonso/ruby-push-notifications) [![Code Climate](https://codeclimate.com/github/calonso/ruby-push-notifications/badges/gpa.svg)](https://codeclimate.com/github/calonso/ruby-push-notifications) [![Test Coverage](https://codeclimate.com/github/calonso/ruby-push-notifications/badges/coverage.svg)](https://codeclimate.com/github/calonso/ruby-push-notifications) [![Gem Version](https://badge.fury.io/rb/ruby-push-notifications.svg)](http://badge.fury.io/rb/ruby-push-notifications) [![Join the chat at https://gitter.im/calonso/ruby-push-notifications](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/calonso/ruby-push-notifications?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-###iOS, Android and Windows Phone Push Notifications made easy!
+### iOS, Android and Windows Phone Push Notifications made easy!
 
 ## Features
 
@@ -38,7 +38,8 @@ 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 example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/mpns.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)
 
 ## Pending tasks
 

data/examples/wns.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+sid = "ms-app://...."
+secret = "..."
+
+wns_access = RubyPushNotifications::WNS::WNSAccess.new(sid, secret).get_token
+access_token = wns_access.response.access_token
+
+device_urls = ["https://hk2.notify.windows.com/?token=AwYAAACEIPGNfZtVWJMvU%2fJ67TTdLQNdFl2345SbaCP7dmkvUmy6Cv9Y7hM4UT5uA%2b3obnZlIIhQcse9Hs6RPW0MPFVjf3MugnfD8qjIHMtRKIsKENIFveN1xQ6S38m90%2fgaBsE%3d"]
+
+notification = RubyPushNotifications::WNS::WNSNotification.new(device_urls, { type: :toast, title: 'This is a special title', message: 'this is a special message'})
+# notification = RubyPushNotifications::WNS::WNSNotification.new(device_urls, { type: :tile, image: 'https://res-5.cloudinary.com/prepathon/image/fetch/w_21,h_21,c_fill,g_face/http://assets-cdn.github.com/images/icons/emoji/unicode/1f604.png?v6', message: 'this is a special message'})
+# notification = RubyPushNotifications::WNS::WNSNotification.new(device_urls, { type: :badge, value: 'activity'})
+
+pusher = RubyPushNotifications::WNS::WNSPusher.new(access_token)
+
+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

@@ -3,3 +3,4 @@ require 'ruby-push-notifications/notification_results_manager'
 require 'ruby-push-notifications/apns'
 require 'ruby-push-notifications/gcm'
 require 'ruby-push-notifications/mpns'
+require 'ruby-push-notifications/wns'

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

@@ -0,0 +1,6 @@
+require 'ruby-push-notifications/wns/wns_access'
+require 'ruby-push-notifications/wns/wns_connection'
+require 'ruby-push-notifications/wns/wns_notification'
+require 'ruby-push-notifications/wns/wns_pusher'
+require 'ruby-push-notifications/wns/wns_result'
+require 'ruby-push-notifications/wns/wns_response'

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

@@ -0,0 +1,82 @@
+require 'uri'
+require 'net/https'
+require 'json'
+require 'ostruct'
+
+module RubyPushNotifications
+  module WNS
+    # This class is responsible for get access auth token for sending pushes
+    #
+    class WNSAccess
+
+      # This class is responsible for structurize response from login WNS service
+      #
+      class Response
+        # @return [OpenStruct]. Return structurized response
+        attr_reader :response
+
+        def initialize(response)
+          @response = structurize(response)
+        end
+
+        private
+
+        def structurize(response)
+          body = response.body.to_s.empty? ? {} : JSON.parse(response.body)
+          OpenStruct.new(
+            status_code: response.code.to_i,
+            status: response.message,
+            error: body['error'],
+            error_description: body['error_description'],
+            access_token: body['access_token'],
+            token_ttl: body['expires_in']
+          )
+        end
+      end
+
+      # @private Grant type for getting access token
+      GRANT_TYPE = 'client_credentials'.freeze
+
+      # @private Scope for getting access token
+      SCOPE = 'notify.windows.com'.freeze
+
+      # @private Url for getting access token
+      ACCESS_TOKEN_URL = 'https://login.live.com/accesstoken.srf'.freeze
+
+      # @return [String]. Sid
+      attr_reader :sid
+
+      # @return [String]. Secret token
+      attr_reader :secret
+
+      # @param type [String]. Sid
+      # @param type [String]. Secret
+      #
+      # You can get it on https://account.live.com/developers/applications/index
+      def initialize(sid, secret)
+        @sid = sid
+        @secret = secret
+      end
+
+      # Get access auth token for sending pushes
+      #
+      # https://docs.microsoft.com/en-us/windows/uwp/controls-and-patterns/tiles-and-notifications-windows-push-notification-services--wns--overview
+      def get_token
+        body = {
+          grant_type: GRANT_TYPE,
+          client_id: sid,
+          client_secret: secret,
+          scope: SCOPE
+        }
+
+        url = URI.parse ACCESS_TOKEN_URL
+        http = Net::HTTP.new url.host, url.port
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        response = http.post url.request_uri, URI.encode_www_form(body)
+
+        Response.new response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+require 'uri'
+require 'net/https'
+
+module RubyPushNotifications
+  module WNS
+    # Encapsulates a connection to the WNS service
+    # Responsible for final connection with the service.
+    #
+    class WNSConnection
+      # @private Content-Type HTTP Header type string
+      CONTENT_TYPE_HEADER  = 'Content-Type'.freeze
+
+      # @private Content-Length HTTP Header type string
+      CONTENT_LENGTH_HEADER  = 'Content-Length'.freeze
+
+      # @private WNS type string
+      X_WNS_TYPE_HEADER = 'X-WNS-Type'.freeze
+
+      # @private Authorization string
+      AUTHORIZATION_HEADER = 'Authorization'.freeze
+
+      # @private Request for status type boolean
+      REQUEST_FOR_STATUS_HEADER = 'X-WNS-RequestForStatus'.freeze
+
+      # @private Content-Type type string
+      CONTENT_TYPE = {
+        badge: 'text/xml',
+        toast: 'text/xml',
+        tile: 'text/xml',
+        raw: 'application/octet-stream'
+      }.freeze
+
+      # @private Windows Phone Target Types
+      WP_TARGETS = {
+        badge: 'wns/badge',
+        toast: 'wns/toast',
+        tile: 'wns/tile',
+        raw: 'wns/raw'
+      }.freeze
+
+      # Issues a POST request to the WNS send endpoint to
+      # submit the given notifications.
+      #
+      # @param notifications [WNSNotification]. The notifications object to POST
+      # @param access_token [String] required. Access token for send push
+      # @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.
+      # @return [Array]. The response of post
+      # (http://msdn.microsoft.com/pt-br/library/windows/apps/ff941099)
+      def self.post(notifications, access_token, options = {})
+        body = notifications.as_wns_xml
+        headers = build_headers(access_token, notifications.data[:type], body.length.to_s)
+        responses = []
+        notifications.each_device do |url|
+          http = Net::HTTP.new url.host, url.port
+          http.open_timeout = options.fetch(:open_timeout, 30)
+          http.read_timeout = options.fetch(:read_timeout, 30)
+          if url.scheme == 'https'
+            http.use_ssl = true
+            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          end
+          response = http.post url.request_uri, body, headers
+          responses << { device_url: url.to_s, headers: capitalize_headers(response), code: response.code.to_i }
+        end
+        WNSResponse.new responses
+      end
+
+      # Build Header based on type and delay
+      #
+      # @param type [String]. Access token
+      # @param type [Symbol]. The type of notification
+      # @param type [String]. Content length of body
+      # @return [Hash]. Correct delay based on notification type
+      # https://msdn.microsoft.com/en-us/library/windows/apps/hh465435.aspx#send_notification_request
+      def self.build_headers(access_token, type, body_length)
+        {
+          CONTENT_TYPE_HEADER => CONTENT_TYPE[type],
+          X_WNS_TYPE_HEADER => WP_TARGETS[type],
+          CONTENT_LENGTH_HEADER => body_length,
+          AUTHORIZATION_HEADER => "Bearer #{access_token}",
+          REQUEST_FOR_STATUS_HEADER => 'true'
+        }
+      end
+
+      # Extract headers from response
+      # @param response [Net::HTTPResponse]. HTTP response for request
+      #
+      # @return [Hash]. Hash with headers with case-insensitive keys and capitalized string values
+      def self.capitalize_headers(response)
+        headers = {}
+        response.each_header { |k, v| headers[k] = v.capitalize }
+        headers
+      end
+    end
+  end
+end

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