ruby-mpns 1.1.2 → 1.2.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Release 1.2.0
+
+* NEW: unit tests has been added
+* NEW: the raw notification supports multi-level hash
+
 ## Release 1.1.2
 
 * FIX: Fix the tile notification xml generation

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem 'htmlentities'
+gem 'builder'
 
 group :development do
   gem "shoulda", ">= 0"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    builder (3.0.4)
     git (1.2.5)
-    htmlentities (4.3.1)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -27,8 +27,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  builder
   bundler (>= 1.0.0)
-  htmlentities
   jeweler (~> 1.8.3)
   rdoc (~> 3.12)
   shoulda

data/README.md

@@ -14,7 +14,7 @@ Or in your gemfile:
 
 ## Usage
 
-To use it juste use the singleton `MicrosoftPushNotificationService` like the following:
+To use it just use the singleton `MicrosoftPushNotificationService` like the following:
 
 		uri = "http://my-uri.com/to/the-windows-phone-i-am-targetting"
 
@@ -73,10 +73,12 @@ For general information about Push Notification on Windows Phone check the [MSDN
 
 ### Missing features
 
-* Add unit tests
-* Add support for multi-level hash for raw notifications
 * Add an ActiveRecord extension (acts_as_microsoft_pushable)
 
+### Contributors
+
+* [Dmitry Medvinsky](https://github.com/dmedvinsky)
+
 ## License
 
 Copyright (c) 2012 [Nicolas VERINAUD](http://www.nverinaud.com). Released under the MIT license.

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/lib/ruby-mpns.rb

@@ -1,10 +1,10 @@
-require "htmlentities"
-require "net/http"
-require "uri"
+require 'builder'
+require 'net/http'
+require 'uri'
 
 module MicrosoftPushNotificationService
 
-	def self.extended(base)
+  def self.extended(base)
     unless base.respond_to?(:device_uri)
       base.class.class_eval do
         attr_accessor :device_uri
@@ -12,94 +12,51 @@ module MicrosoftPushNotificationService
     end
   end
 
-  def self.send_notification uri, type, options = {}
-  	device = Object.new
-  	device.extend MicrosoftPushNotificationService
-  	device.device_uri = uri
-  	device.send_notification type, options
+  def self.send_notification(uri, type, options = {})
+    device = Object.new
+    device.extend MicrosoftPushNotificationService
+    device.device_uri = uri
+    device.send_notification type, options
   end
 
-  def send_notification type, options = {}
-    type = safe_type_to_sym type
-    header = self.http_header_for_type type
-
-    notification = nil
-    notification_class = nil
-
-    if type == :tile
-      notification = tile_notification_with_options options
-      notification_class = "1"
-    elsif type == :toast
-      notification = toast_notification_with_options options
-      notification_class = "2"
-    else
-      notification = raw_notification_with_options options
-      notification_class = "3"
-    end
-
-    # HTTP connection
+  def send_notification(type, options = {})
+    type = safe_type_to_sym(type)
+    notification, notification_class = build_notification(type, options)
     uri = URI.parse(self.device_uri)
 
-    http = Net::HTTP.new(uri.host, uri.port)
     request = Net::HTTP::Post.new(uri.request_uri)
-    request.content_type = "text/xml"
-
-    if type.to_sym != :raw
-      request["X-WindowsPhone-Target"] = type.to_s
-    end
-    request["X-NotificationClass"] = notification_class
+    request.content_type = 'text/xml'
+    request['X-WindowsPhone-Target'] = type.to_s if type.to_sym != :raw
+    request['X-NotificationClass'] = notification_class
     request.body = notification
     request.content_length = notification.length
-    
-    response = Net::HTTP.start(uri.host, uri.port) do |http|
-      http.request(request)
-    end
 
-    return response
+    Net::HTTP.start(uri.host, uri.port) { |http| http.request request }
   end
 
 
 protected
 
-  def safe_type_to_sym type
-    sym = nil
-
-    unless type.nil?
-      sym = type.to_sym
-    else
-      sym = :raw
-    end
-
-    if sym != :tile && sym != :toast
-      sym = :raw
-    end
-
-    return sym
+  def safe_type_to_sym(type)
+    sym = type.to_sym unless type.nil?
+    sym = :raw unless [:tile, :toast].include?(sym)
+    sym
   end
 
-  def http_header_for_type type
-
-    if type == :toast || type == :tile
-      "X-WindowsPhone-Target:#{type.to_s}"
+  def notification_builder_for_type(type)
+    case type
+    when :tile
+      :tile_notification_with_options
+    when :toast
+      :toast_notification_with_options
+    else
+      :raw_notification_with_options
     end
   end
 
-  # Toast options :
-  #   - title : string
-  #   - content : string
-  #   - params : hash
-  def toast_notification_with_options options = {}
-    coder = HTMLEntities.new
-
-    notification = '<?xml version="1.0" encoding="utf-8"?>'
-    notification << '<wp:Notification xmlns:wp="WPNotification">'
-    notification <<   '<wp:Toast>'
-    notification <<     '<wp:Text1>' << coder.encode(options[:title]) << '</wp:Text1>'
-    notification <<     '<wp:Text2>' << coder.encode(options[:content]) << '</wp:Text2>'
-    notification <<     '<wp:Param>' << coder.encode(format_params(options[:params])) << '</wp:Param>'
-    notification <<   '</wp:Toast>'
-    notification << '</wp:Notification>'
-    return notification
+  def build_notification(type, options = {})
+    notification_builder = notification_builder_for_type(type)
+    send(notification_builder, options)
   end
 
   # Tile options :
@@ -110,54 +67,59 @@ protected
   #   - back_background_image : string, path to local image embedded in the app or accessible via HTTP (.jpg or .png, 173x137px, max 80kb)
   #   - back_content : string
   #   - (optional) navigation_uri : string, the exact navigation URI for the tile to update, only needed if you wish to update a secondary tile
-  def tile_notification_with_options options = {}
-    coder = HTMLEntities.new
-
-    navigation_uri = options[:navigation_uri]
-    tile_id = navigation_uri.nil? ? "" : 'Id="' + coder.encode(navigation_uri) + '"'
-
-    notification = '<?xml version="1.0" encoding="utf-8"?>'
-    notification << '<wp:Notification xmlns:wp="WPNotification">'
-    notification <<   '<wp:Tile' << tile_id << '>'
-    notification <<     '<wp:BackgroundImage>' << coder.encode(options[:background_image]) << '</wp:BackgroundImage>'
-    notification <<     '<wp:Count>' << coder.encode(options[:count]) << '</wp:Count>'
-    notification <<     '<wp:Title>' << coder.encode(options[:title]) << '</wp:Title>'
-    notification <<     '<wp:BackBackgroundImage>' << coder.encode(options[:back_background_image]) << '</wp:BackBackgroundImage>'
-    notification <<     '<wp:BackTitle>' << coder.encode(options[:back_title]) << '</wp:BackTitle>'
-    notification <<     '<wp:BackContent>' << coder.encode(options[:back_content]) << '</wp:BackContent>'
-    notification <<   '</wp:Tile>'
-    notification << '</wp:Notification>'
-    return notification
+  def tile_notification_with_options(options = {})
+    uri = options[:navigation_uri]
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.tag!('wp:Notification', 'xmlns:wp' => 'WPNotification') do
+      xml.tag!('wp:Tile', uri.nil? ? {} : {'Id' => uri}) do
+        xml.tag!('wp:BackgroundImage') { xml.text!(options[:background_image] || '') }
+        xml.tag!('wp:Count') { xml.text!(options[:count].to_s || '') }
+        xml.tag!('wp:Title') { xml.text!(options[:title] || '') }
+        xml.tag!('wp:BackBackgroundImage') { xml.text!(options[:back_background_image] || '') }
+        xml.tag!('wp:BackTitle') { xml.text!(options[:back_title] || '') }
+        xml.tag!('wp:BackContent') { xml.text!(options[:back_content] || '') }
+      end
+    end
+    [xml.target!, '1']
+  end
+
+  # Toast options :
+  #   - title : string
+  #   - content : string
+  #   - params : hash
+  def toast_notification_with_options(options = {})
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.tag!('wp:Notification', 'xmlns:wp' => 'WPNotification') do
+      xml.tag!('wp:Toast') do
+        xml.tag!('wp:Text1') { xml.text!(options[:title] || '') }
+        xml.tag!('wp:Text2') { xml.text!(options[:content] || '') }
+        xml.tag!('wp:Param') { xml.text!(format_params(options[:params])) }
+      end
+    end
+    [xml.target!, '2']
   end
 
   # Raw options :
   #   - raw values send like: <key>value</key>
-  def raw_notification_with_options options = {}
-    coder = HTMLEntities.new
+  def raw_notification_with_options(options = {})
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.root { build_hash(xml, options) }
+    [xml.target!, '3']
+  end
 
-    notification = '<?xml version="1.0" encoding="utf-8"?>'
-    notification << '<root>'
-    options.each do |key,value|
-      notification <<   '<' << coder.encode(key.to_s) << '>' << coder.encode(value.to_s) << '</' << coder.encode(key.to_s) << '>'
+  def build_hash(xml, 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
-    notification << '</root>'
-
-    puts notification
-    return notification
   end
 
-  def format_params params = {}
-    p = "?"
-    length = params.length
-    count = 0
-    params.each do |key,value|
-      p << key.to_s << "=" << value.to_s
-      count += 1
-      if count < length
-        p << "&"
-      end
-    end
-    return p
+  def format_params(params = {})
+    return '' if params.nil?
+    query = params.collect { |k, v| k.to_s + '=' + v.to_s } * '&'
+    '?' + query
   end
 
 end

data/ruby-mpns.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby-mpns"
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nicolas VERINAUD"]
-  s.date = "2012-09-29"
+  s.date = "2013-01-12"
   s.description = "This gem provides an easy way to send push notifications to Windows Phone devices using Microsoft Push Notification Service."
   s.email = "n.verinaud@gmail.com"
   s.extra_rdoc_files = [
@@ -43,14 +43,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<htmlentities>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
-      s.add_dependency(%q<htmlentities>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
@@ -58,7 +58,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<htmlentities>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])

data/test/test_ruby-mpns.rb

@@ -1,7 +1,103 @@
 require 'helper'
 
 class TestRubyMpns < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  should 'safely convert type to symbol' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    assert_equal :raw, mpns.send(:safe_type_to_sym, nil)
+    assert_equal :raw, mpns.send(:safe_type_to_sym, 'beer')
+    assert_equal :raw, mpns.send(:safe_type_to_sym, 'raw')
+    assert_equal :raw, mpns.send(:safe_type_to_sym, :raw)
+    assert_equal :tile, mpns.send(:safe_type_to_sym, 'tile')
+    assert_equal :tile, mpns.send(:safe_type_to_sym, :tile)
+    assert_equal :toast, mpns.send(:safe_type_to_sym, 'toast')
+    assert_equal :toast, mpns.send(:safe_type_to_sym, :toast)
+  end
+
+  should 'get correct notification builder based on type' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    assert_equal :tile_notification_with_options, mpns.send(:notification_builder_for_type, :tile)
+    assert_equal :toast_notification_with_options, mpns.send(:notification_builder_for_type, :toast)
+    assert_equal :raw_notification_with_options, mpns.send(:notification_builder_for_type, :raw)
+    assert_equal :raw_notification_with_options, mpns.send(:notification_builder_for_type, :beer)
+  end
+
+  should 'return correct notification_class' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    _, cls = mpns.send(:build_notification, :tile)
+    assert_equal cls, '1'
+    _, cls = mpns.send(:build_notification, :toast)
+    assert_equal cls, '2'
+    _, cls = mpns.send(:build_notification, :raw)
+    assert_equal cls, '3'
+  end
+
+  should 'format params like a boss' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    q = mpns.send(:format_params, { a: 1, b: 2 })
+    assert_equal q, '?a=1&b=2'
+    q = mpns.send(:format_params, { phone: '+0987 654321', email: 'luke@example.com' })
+    assert_equal q, '?phone=+0987 654321&email=luke@example.com'
+  end
+
+  should 'make tile XML' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    xml, _ = mpns.send(:tile_notification_with_options,
+                       { title: 'title', count: 1337,
+                         background_image: 'bg', back_title: 'bktitle',
+                         back_background_image: 'bkbg',
+                         back_content: 'bkcontent',
+                         navigation_uri: 'uri' })
+    assert_equal xml, '<?xml version="1.0" encoding="UTF-8"?>' +
+      '<wp:Notification xmlns:wp="WPNotification">' +
+        '<wp:Tile Id="uri">' +
+          '<wp:BackgroundImage>bg</wp:BackgroundImage>' +
+          '<wp:Count>1337</wp:Count>' +
+          '<wp:Title>title</wp:Title>' +
+          '<wp:BackBackgroundImage>bkbg</wp:BackBackgroundImage>' +
+          '<wp:BackTitle>bktitle</wp:BackTitle>' +
+          '<wp:BackContent>bkcontent</wp:BackContent>' +
+        '</wp:Tile>' +
+      '</wp:Notification>'
+  end
+
+  should 'make toast XML' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    xml, _ = mpns.send(:toast_notification_with_options,
+                       { title: 'title', content: 'content', params: {} })
+    assert_equal xml, '<?xml version="1.0" encoding="UTF-8"?>' +
+      '<wp:Notification xmlns:wp="WPNotification">' +
+        '<wp:Toast>' +
+          '<wp:Text1>title</wp:Text1>' +
+          '<wp:Text2>content</wp:Text2>' +
+          '<wp:Param>?</wp:Param>' +
+        '</wp:Toast>' +
+      '</wp:Notification>'
+  end
+
+  should 'make raw XML' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    xml, _ = mpns.send(:raw_notification_with_options,
+                       { key1: 'val1', key2: 'val2' })
+    assert_equal xml, '<?xml version="1.0" encoding="UTF-8"?>' +
+      '<root>' +
+        '<key1>val1</key1>' +
+        '<key2>val2</key2>' +
+      '</root>'
+  end
+
+  should 'make raw XML with nested tags' do
+    mpns = Object.new.extend MicrosoftPushNotificationService
+    xml, _ = mpns.send(:raw_notification_with_options,
+                       { key1: 'val1', key2: { subkey1: 'subval1', subkey2: { subsubkey1: 'subsubval1' } } })
+    assert_equal xml, '<?xml version="1.0" encoding="UTF-8"?>' +
+      '<root>' +
+        '<key1>val1</key1>' +
+        '<key2>' +
+          '<subkey1>subval1</subkey1>' +
+          '<subkey2>' +
+            '<subsubkey1>subsubval1</subsubkey1>' +
+          '</subkey2>' +
+        '</key2>' +
+      '</root>'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mpns
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: