ruby-mpns 1.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'htmlentities'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    htmlentities (4.3.1)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  htmlentities
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Nicolas VERINAUD
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# ruby-mpns
+
+A ruby gem to communicate with Microsoft Push Notification Service.
+
+## Installing
+
+From the commande line:
+
+`gem install ruby-mpns`
+
+Or in your gemfile:
+
+`gem 'ruby-mpns'`
+
+## Usage
+
+To use it juste use the singleton `MicrosoftPushNotificationService` like the following:
+
+		uri = "http://my-uri.com/to/the-windows-phone-i-am-targetting"
+
+		options = {
+			title: "Hello !",
+			content: "Hello Push Notification.",
+			params: {
+				any_data: 2,
+				another_key: "Hum..."
+			}
+		}
+
+		# response is an Net::HTTP object
+		reponse = MicrosoftPushNotificationService.send_notification uri, :toast, options
+
+See `sample/sample_usage.rb` for more samples.
+
+## Parameters
+
+### Toast notification
+
+The following notification parameters can be defined in the options hash for `:toast`:
+
+* `title` - the title
+* `content` - the content
+* `params` - a hash that will be transformed into `key1=value1&key2=value2...`
+
+### Raw notification
+
+You can pass whatever hash you want and an XML will be generated, like the following:
+
+		<root>
+				<key1>value1</key1>
+				<key2>value2</key2>
+		</root>
+
+**Warning** Currently limited to one level, the hash must not contain another hash.
+
+### Tile notification
+
+The following notification parameters can be defined in the options hash for `:tile`:
+
+* `title` - the title
+* `count` - the badge to display on the app tile
+* `background_image` - the path to a local image embedded in the app or an image accessible via HTTP (.jpg or .png, 173x137px, max 80kb)
+* `back_title` - the title when the tile is flipped
+* `back_background_image` - the path to a local image embedded in the app or an image accessible via HTTP (.jpg or .png, 173x137px, max 80kb)
+* `back_content` - the content when the tile is flipped
+
+## Reference
+
+For general information about Push Notification on Windows Phone check the [MSDN](http://msdn.microsoft.com/en-us/library/hh202945\(v=vs.92\).aspx).
+
+## Todo
+
+* Add unit tests
+* Add support for multi-level hash for raw notifications
+* Make the future gem rails compatible and add an ActiveRecord extension (acts_as_microsoft_pushable)
+
+## License
+
+Copyright (c) 2012 [Nicolas VERINAUD](http://www.nverinaud.com). Released under the MIT license.
+
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "ruby-mpns"
+  gem.homepage = "http://github.com/nverinaud/ruby-mpns"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby gem to communicate with Microsoft Push Notification Service.}
+  gem.description = %Q{This gem provides an easy way to send push notifications to Windows Phone devices using Microsoft Push Notification Service.}
+  gem.email = "n.verinaud@gmail.com"
+  gem.authors = ["Nicolas VERINAUD"]
+  gem.add_dependency 'htmlentities'
+  gem.required_ruby_version = '>= 1.9.2'
+  gem.files.exclude 'sample' # exclude sample directory
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-mpns #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/ruby-mpns.rb

@@ -0,0 +1,159 @@
+require "htmlentities"
+require "net/http"
+require "uri"
+
+module MicrosoftPushNotificationService
+
+	def self.extended(base)
+    unless base.respond_to?(:device_uri)
+      base.class.class_eval do
+        attr_accessor :device_uri
+      end
+    end
+  end
+
+  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
+    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.body = notification
+    request.content_length = notification.length
+    
+    response = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.request(request)
+    end
+
+    return response
+  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
+  end
+
+  def http_header_for_type type
+
+    if type == :toast || type == :tile
+      "X-WindowsPhone-Target:#{type.to_s}"
+    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
+  end
+
+  # Tile options :
+  #   - title : string
+  #   - background_image : string, path to local image embedded in the app or accessible via HTTP (.jpg or .png, 173x137px, max 80kb)
+  #   - count : integer
+  #   - back_title : string
+  #   - 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
+  def tile_notification_with_options options = {}
+    coder = HTMLEntities.new
+
+    notification = '<?xml version="1.0" encoding="utf-8"?>'
+    notification << '<wp:Notification xmlns:wp="WPNotification">'
+    notification <<   '<wp:Tile '
+    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
+  end
+
+  # Raw options :
+  #   - raw values send like: <key>value</key>
+  def raw_notification_with_options options = {}
+    coder = HTMLEntities.new
+
+    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) << '>'
+    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
+  end
+
+end

data/sample/sample_usage.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/lib/microsoft_push_notification_service'
+
+puts "=== Test ==="
+
+uri = "<# Your Microsoft Push URI here #>"
+
+#
+# => TOAST
+#
+options = {
+	title: "Hi there",
+	content: "Testing <correct> encoding of special &éà chars.",
+	params: {
+		invoice_id: 2,
+		state: 10.5,
+		another: '"hey hey"'
+	}
+}
+
+response = MicrosoftPushNotificationService.send_notification uri, :toast, options
+puts response
+
+
+#
+# => RAW
+#
+options = { # Only on level is currently supported for raw notification, feel free to improve !
+	anykey: "anyvalue",
+	otherkey: "whynot"
+}
+
+response = MicrosoftPushNotificationService.send_notification uri, :raw, options
+puts response
+
+
+#
+# => TILE
+#
+options = {
+	title: "Hello World !",
+	background_image: "local/hello.png",
+	count: 12,
+	back_title: "! dlroW olleH",
+	back_background_image: "local/olleh.png",
+	back_content: "! hcuoA"
+}
+
+response = MicrosoftPushNotificationService.send_notification uri, :tile, options
+puts response

data/test/helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ruby-mpns'
+
+class Test::Unit::TestCase
+end

data/test/test_ruby-mpns.rb

@@ -0,0 +1,7 @@
+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"
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: ruby-mpns
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nicolas VERINAUD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides an easy way to send push notifications to Windows Phone
+  devices using Microsoft Push Notification Service.
+email: n.verinaud@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/ruby-mpns.rb
+- sample/sample_usage.rb
+- test/helper.rb
+- test/test_ruby-mpns.rb
+homepage: http://github.com/nverinaud/ruby-mpns
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby gem to communicate with Microsoft Push Notification Service.
+test_files: []