suj-pusher 0.1.5 → 0.2.0

data/README.md

@@ -40,24 +40,36 @@ pusher start|stop|restart|status  <options>
 ```
 
 options:
-  - -r <REDIS>: The redis server used to receive push notification messages. The default is localhost:6379.
+  - -H <redis host>: The redis server host or IP address where push messages are stored. Defaults to localhost.
+  - -P <redis port>: Port number of the redis server where push messages are stored. Defaults to 6379.
+  - -b <redis db>: The database number on the redis server to connect to. Defaults to 0.
+  - -n <redis namespace>: A namespace separate pusher queues from others in redis. Defaults to pusher.
+  - -l <logdir>: The directory where logfiles are stored. Defaults to $PWD/logs.
+  - -p <piddir>: The directory where pid files are stored. Defaults to $PWD/pids.
+  - -c <certs>: The directory where we temporarily store APN certs. Defaults to $PWD/certs.
 
-Note that the daemon will run on your current folder and under the current user. Make sure you cd to a folder (e.g. /var/run/pusher) and that your current user has permissions to create folders/files inside that directory:
+The pusher daemon runs under the current user and current folder. If you specify the logid, piddir and certs folders make sure these exists and that the current user can create/write files inside those folder.
+
+To start the server run:
+
+```
+/path/to/bin/pusher start -H localhost -P 6379 -b 0 -n pusher -p /var/run/pids
+```
+
+To stop the server run:
 
 ```
-mkdir /var/run/pusher
-chown pusher_user:pusher_group /var/run/pusher
-cd /var/run/pusher
-/usr/bin/pusher start -r redis://192.168.x.x:6379/namespace
+/path/to/bin/pusher start -H localhost -P 6379 -b 0 -n pusher -p /var/run/pids
 ```
 
-The pusher daemon creates a logs, tmp and certs directory in the current path. To check the state of the daemon you may check the logs. We store the APN certs inside the certs directory temporarily during the connection to APN and delete them when the connection is closed. Still make sure this folder is only readable/writeable by the user under which the pusher process is running.
+If you set a piddir (using -p option) when starting the server then you must supply the same option when stopping or restarting the server.
+
+The certs option (-c) is to temporarily store APN certificates. These are deleted when the APN connection is closed.
 
 ## Sending Notifications
 
 Once the pusher daemon is running and connected to your redis server you can push notifications by publishing messages to redis. The message format is a simple JSON string.
 
-
 ### JSON string format
 
 Example JSON message:
@@ -107,6 +119,39 @@ Normally you would send messages to either Android or iOS indenpendently. But th
 
 If your data hash is compatible with the APN standard as described above and you specify a APN cert, a GCM api_key, a list of apn_ids and a list of gcm_ids then the message will be delivered via push notification to all the devices in those lists. Apple will display the notifications using their own mechanisms and for Android you will receive the data hash in a Bundle object as usual. Is your responsibility to extract the data from that bundle and display/use it as you please.
 
+
+
+#### Sending one message to WNS
+message hash: { 
+		wnstype: "type" ,
+		 wnsrequeststatus: true,
+		 wnsids: ["xxx"],
+		 secret: "app-secret",
+		 development: false,
+		 sid: "secret-id",
+		  data: "notif"}
+wnstype: type of the notification to send, posibles values are: "wns/badge", "wns/tile", "wns/toast", "wns/raw"
+data: a string with de notifiaction to send, please use the xml templates provided by Microsoft(http://msdn.microsoft.com/en-us/library/windows/apps/hh779725.aspx) for each wnstype listed above. 
+secret and sid: App identification credentials provided by microsoft when registering a new application to use wns services.
+wnsrequeststatus: boolean, if true, the response from wns server will have aditional information
+wnsids: jsonArray of target devices.
+
+
+#### Sending one message to WPNS
+message hash: {  wptype: "type",
+	  	 wpids: ["xxx"],
+		 secret: "unicId",
+		 development: false,
+		 wpnotificationclass: number,
+		 data: notif}
+
+wptype: ype of the notification to send, posible values are: "toast" or  "badge", if this parameter is not present, a "raw" type notifications will be sent.
+secret: a unic hash to identify a conection, internal use, each notification sent must have a diferent id
+wpids: jsonArray of ids for target devices  
+data: notification data to send, please use de xsml template provided by Microsoft(http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202945(v=vs.105).aspx) for each wptype listed above
+
+
+
 ## Examples
 
 A simple example using ruby code to send a push notification to iOS devices.
@@ -134,20 +179,26 @@ msg_json = MultiJson.dump(msg)
 redis = Redis.new({ host: "localhost", port: 6379})
 
 # Push the message to the *suj_pusher_queue* in the redis server:
-redis.lpush "suj_pusher_msgs", msg_json
+redis.lpush "pusher:suj_pusher_msgs", msg_json
 
 # Notify workers there is a new message
-redis.publish "suj_pusher_queue", "PUSH_MSG"
+redis.publish "pusher:suj_pusher_queue", "PUSH_MSG"
 ```
 
-You must push the messages to the *suj_pusher_queue* queue that is the one the Pusher daemon is listening to. Also make sure your message follows the format described on the previous sections.
+First you must push your messages to the *suj_pusher_msgs* queue and then publish a *PUSH_MSG* to the *suj_pusher_queue*. The first is a simple queue that stores the messages and the second is a PUB/SUB queue that tells the push daemons that a new message is available. Also make sure to set the same namespace (e.g. pusher) to the queue names that you set on the pusher daemons.
 
 ## Issues
 
 - We have no feedback mechanism. This is a fire and forget daemon that does not tell us if the message was sent or not.
 - This daemon has no security at all. Anyone that can push to your redis server can use this daemon to spam your users. Make sure your redis server is only accessible to you and the pusher daemon.
 
+## Troubleshooting
+
+- You get errors like "Encryption not available on this event-machine", ensure that the eventmachine gem was installed with ssl support. If you are not sure uninstall the gem, install libssl-dev package and re-install the gem again.
+- If you get 401 Unauthorized error on the log when sending notifications via GCM, ensure the key you use has configured the global IP addresses of the pusher daemons as allowed.
+
 ## TODO
 
 - Implement a feedback mechanism that exposes a simple API to allow users check if some tokens, ids, certs, or api_keys are no longer valid so they can take proper action.
 - Find a way to register certificates and api_key only once so we do not need to send them for every request. Maybe add a cert/key registration api.
+- For MPNS add ssl service authentification for unlimited push notifications.

data/bin/pusher

@@ -37,7 +37,7 @@ ARGV.options do |opts|
   opts.on('-l LOGS', '--logdir LOGS', String, 'Logs destination directory') { |l| logdir = l }
   opts.on('-p PIDS', '--piddir PIDS', String, 'Pids destination diercoty') { |pid| piddir = pid }
   opts.on('-c CERTS', '--cerdir CERTS', String, 'Directory to store certificates') { |cert| cerdir = cert }
-  opts.on('-v', '--version', 'Print this version of pusher daemon.') { puts "rapns #{Suj::Pusher::VERSION}"; exit }
+  opts.on('-v', '--version', 'Print this version of pusher daemon.') { puts "Pusher #{Suj::Pusher::VERSION}"; exit }
   opts.on('-h', '--help', 'You\'re looking at it.') { puts opts; exit }
   opts.parse!
 end

data/lib/suj/pusher.rb

@@ -7,6 +7,10 @@ require 'suj/pusher/apn_feedback_connection'
 require 'suj/pusher/apn_connection'
 require 'suj/pusher/gcm_connection'
 require 'suj/pusher/apn_notification'
+require 'suj/pusher/wns_connection'
+require 'suj/pusher/wns_notification'
+require 'suj/pusher/wpns_connection'
+require 'suj/pusher/wpns_notification'
 require 'suj/pusher/daemon'
 
 require 'logger'

data/lib/suj/pusher/connection_pool.rb

@@ -48,6 +48,30 @@ module Suj
         @pool[api_key] ||= Suj::Pusher::GCMConnection.new(self, api_key, options)
       end
 
+      def apn_connection(options = {})
+        cert = Digest::SHA1.hexdigest options[:cert]
+        info "APN connection #{cert}"
+        @pool[cert] ||= EM.connect(APN_GATEWAY, APN_PORT, APNConnection, self, options)
+      end
+
+      def wns_connection(options = {})
+        cert = Digest::SHA1.hexdigest options[:secret]
+        info "WNS connection #{cert}"
+        info "WNS Options #{options}"
+        @pool[cert] ||= Suj::Pusher::WNSConnection.new(self,options)
+      end
+
+      def wpns_connection(options = {})
+        cert = Digest::SHA1.hexdigest options[:secret]
+        info "WPNS connection #{cert}"
+        info "WPNS Options #{options}"
+        @pool[cert] ||= Suj::Pusher::WPNSConnection.new(self,options)
+        return @pool[cert]
+      end
+
+
+
+
       def remove_connection(key)
         info "Removing connection #{key}"
         info "Connection not found" unless @pool.delete(key)

data/lib/suj/pusher/daemon.rb

@@ -81,6 +81,12 @@ module Suj
           end
         elsif msg.has_key?(:api_key)
           send_gcm_notification(msg)
+        elsif msg.has_key?(:secret) && msg.has_key?(:sid)
+          #wns push notification
+          send_wns_notification(msg)
+        elsif  msg.has_key?(:wpnotificationclass)
+          #send wpns push notification
+          send_wpns_notification(msg)
         else
           warn "Could not determine push notification service."
         end
@@ -132,6 +138,20 @@ module Suj
         conn.deliver(msg)
       end
 
+      def send_wns_notification(msg)
+        info "Sending WNS notification via connection #{Digest::SHA1.hexdigest(msg[:secret])}"
+        conn = pool.wns_connection(msg)
+        conn.deliver(msg)
+      end
+
+      def send_wpns_notification(msg)
+        info "Sending WPNS notification via connection #{Digest::SHA1.hexdigest(msg[:secret])}"
+        conn = pool.wpns_connection(msg)
+        conn.deliver(msg)
+      end
+
+
+
       def redis_url
         @redis_url ||= "redis://#{Suj::Pusher.config.redis_host}:#{Suj::Pusher.config.redis_port}/#{Suj::Pusher.config.redis_db}"
       end

data/lib/suj/pusher/version.rb

@@ -1,5 +1,5 @@
 module Suj
   module Pusher
-    VERSION = '0.1.5'
+    VERSION = '0.2.0'
   end
 end

data/lib/suj/pusher/wns_connection.rb

@@ -0,0 +1,142 @@
+require "eventmachine"
+require "em-http"
+require "base64"
+require 'uri'
+module Suj
+  module Pusher
+    class WNSConnection
+      include Suj::Pusher::Logger
+
+      WPN_OAUTH_SERVER =  "https://login.live.com/accesstoken.srf"
+
+      ERRORS = {
+        0 => "No errors encountered",
+        1 => "Processing error",
+        2 => "Missing device token",
+        3 => "Missing topic",
+        4 => "Missing payload",
+        5 => "Invalid token size",
+        6 => "Invalid topic size",
+        7 => "Invalid payload size",
+        8 => "Invalid token",
+        255 => "Unknown error"
+      }
+      
+      def initialize(pool,options = {})
+        @pool = pool 
+        @options = options
+        #info "options #{options}"
+        @cert_key = Digest::SHA1.hexdigest(@options[:secret])
+        @cert_file = File.join(Suj::Pusher.config.certs_path, @cert_key)
+      end
+
+   
+
+      def deliver(options)
+
+       begin
+       @body = "grant_type=client_credentials&client_id=#{CGI.escape(@options[:sid])}&client_secret=#{CGI.escape(@options[:secret])}&scope=notify.windows.com"
+       @header = {"Content-Type" => "application/x-www-form-urlencoded"}
+       http = EventMachine::HttpRequest.new(WPN_OAUTH_SERVER).post( :head => @header, :body =>@body )
+       info http.inspect
+       http.errback do
+       	error "WNS network error"
+        @pool.remove_connection(@cert_key)
+       end
+       http.callback do
+          if http.response_header.status != 200
+            error "WNS push error #{http.response_header.status}"
+            error http.response
+       else
+
+
+         
+        token = JSON.parse(http.response) 
+            @options = options
+          @notification = Suj::Pusher::WnsNotification.new(@options)
+            info "WNS delivering data"
+	    @Authorization  = "Bearer #{token["access_token"]}"
+            
+	    @Content_type = ""
+            if(@options[:wnstype].eql?("wns/raw"))
+            
+                @Content_type = "application/octet-stream"
+            else
+            
+              @Content_type = "text/xml"
+            end
+            @Content_length = @notification.data.size
+            @X_WNS_Type = @options[:wnstype]
+            @X_WNS_Cache_Policy = "no-cache"
+           if(@options.has_key?("wnscache"))
+            
+              @X_WNS_Cache_Policy = @options[:wnscache]
+            end
+            @X_WNS_RequestForStatus = true
+            if(@options.has_key?("wnsrequeststatus"))
+            
+              @X_WNS_RequestForStatus = @options[:wnsrequeststatus]
+            end
+            @X_WNS_Tag = nil
+            if(@options.has_key?("wnstag"))
+            
+              @X_WNS_Tag = @options[:wnstag]
+            end
+            @X_WNS_TTL = nil
+            if(@options.has_key?("time_to_live"))
+            
+              @X_WNS_Cache_Policy = @options[:time_to_live]
+            end
+	    @options[:wnsids].each do |id|
+		info "atempting send notification to Id: #{id}"
+		@header = Hash.new
+		@header['Authorization'] = @Authorization
+		@header['Content-Type'] = @Content_type 
+		@header['Content-Length'] = @Content_length 
+		@header['X-WNS-Type'] = @X_WNS_Type 
+		@header['X-WNS-Cache-Policy'] = @X_WNS_Cache_Policy 
+		@header['X-WNS-RequestForStatus'] = @X_WNS_RequestForStatus 
+		if(@X_WNS_Tag!= nil)
+  			@header['X-WNS-Tag'] = @X_WNS_Tag 
+		end
+		if(@X_WNS_TTL!= nil)
+			@header['X-WNS-TTL'] = @X_WNS_TTL 
+		end
+		http2 = EventMachine::HttpRequest.new(id).post( :head => @header, :body =>@options[:data]) #@notification.data )
+        	http2.errback do
+          		error "WNS-sending network error"
+        	end
+        	http2.callback do
+          		if http2.response_header.status != 200
+            			error "WNS-sending push error #{http2.response_header.status}"
+           			 error http.response
+          		else
+            			info "WNS-push notification sent"
+            			info http2.response_header
+          		end
+        	end
+            
+            end
+        end #nbersano
+       end #nbersano
+            @notification = nil
+            info "WNS delivered data"
+        rescue => ex
+          unbind
+          error "WNS notification error : #{ex}"
+        end
+       unbind
+      end
+
+
+
+
+      def unbind
+        info "WNS Connection closed..."
+        @disconnected = true
+        FileUtils.rm_f(@cert_file)
+        @pool.remove_connection(@cert_key)
+      end
+    end
+  end
+end

data/lib/suj/pusher/wns_notification.rb

@@ -0,0 +1,34 @@
+module Suj
+  module Pusher
+    class WnsNotification
+      include Suj::Pusher::Logger
+
+
+      def initialize(options = {})
+	@options = options
+      end
+
+      def payload
+        @payload ||= MultiJson.dump(@options[:data] || {})
+      end
+
+      def data
+        @data ||= encode_data
+      end
+
+      private
+
+      def get_expiry
+        if @ttl.to_i == 0
+          return 0
+        else
+          return Time.now.to_i + @ttl.to_i
+        end
+      end
+
+      def encode_data
+      Base64.encode64(payload)
+      end
+    end
+  end
+end

data/lib/suj/pusher/wpns_connection.rb

@@ -0,0 +1,98 @@
+require "eventmachine"
+require "em-http"
+require "base64"
+require 'uri'
+module Suj
+  module Pusher
+    class WPNSConnection
+      include Suj::Pusher::Logger
+
+
+      ERRORS = {
+        0 => "No errors encountered",
+        1 => "Processing error",
+        2 => "Missing device token",
+        3 => "Missing topic",
+        4 => "Missing payload",
+        5 => "Invalid token size",
+        6 => "Invalid topic size",
+        7 => "Invalid payload size",
+        8 => "Invalid token",
+        255 => "Unknown error"
+      }
+
+      def initialize(pool,options = {})
+        @pool = pool 
+        @options = options
+        @cert_key = Digest::SHA1.hexdigest(@options[:secret])
+        @cert_file = File.join(Suj::Pusher.config.certs_path, @cert_key)
+        info "initialazing wns connection"
+      end
+
+
+      def deliver(options)
+        begin
+            @options = options
+          @notification = Suj::Pusher::WnsNotification.new(@options)
+            info "WPNS delivering data"
+#	    @Authorization  = "Bearer #{token["access_token"]}"
+            @Content_type = "text/xml; charset=utf-8"
+            @Content_length = @options[:data].size #@notification.data.size
+            @X_MessageID = nil
+            @X_MessageID = @options[:wpmid]
+	    @X_WindowsPhone_Target = nil
+            @X_WindowsPhone_Target = @options[:wptype]
+            @X_NotificationClass = @options[:wpnotificationclass]
+	    @options[:wpids].each do |id|
+		info "atempting send notification to Id: #{id}"
+		@header = Hash.new
+		@header['Content-Type'] = @Content_type 
+		@header['Accept'] = "application/*" 
+	#	@header['Content-Length'] = @Content_length 
+		@header['X-NotificationClass'] =  @X_NotificationClass
+		if (@X_WindowsPhone_Target != nil)
+        		@header['X-WindowsPhone-Target'] = @X_WindowsPhone_Target
+		else
+                end 
+		if( @X_MessageID  != nil)
+  			@header['X-MessageID'] = @X_MessageID 
+		else
+		end
+		http = EventMachine::HttpRequest.new(id).post( :head => @header, :body => @options[:data])# @notification.data )
+        	info http.inspect
+        	http.errback do
+          		error "WPNS-sending network error"
+        	end
+        	http.callback do
+			if http.response_header.status != 200
+            			error "WPNS-sending push error #{http.response_header.status}"
+           			 error http.response
+           			 error http.response_header
+          		else
+            			info "WPNS-push notification sent"
+            			info http.response_header
+          		end
+        	end
+            
+            end
+
+            @notification = nil
+            info "WPNS delivered data"
+        rescue => ex
+          unbind
+          error "WPNS notification error : #{ex}"
+        end
+	unbind 
+      end
+
+
+
+
+      def unbind
+        info "WPNS Connection closed..."
+        FileUtils.rm_f(@cert_file)
+        @pool.remove_connection(@cert_key)
+      end
+    end
+  end
+end

data/lib/suj/pusher/wpns_notification.rb

@@ -0,0 +1,34 @@
+module Suj
+  module Pusher
+    class WnpsNotification
+      include Suj::Pusher::Logger
+
+
+      def initialize(options = {})
+	@options = options
+      end
+
+      def payload
+        @payload ||= MultiJson.dump(@options[:data] || {})
+      end
+
+      def data
+        @data ||= encode_data
+      end
+
+      private
+
+      def get_expiry
+        if @ttl.to_i == 0
+          return 0
+        else
+          return Time.now.to_i + @ttl.to_i
+        end
+      end
+
+      def encode_data
+      Base64.encode64(payload)
+      end
+    end
+  end
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: suj-pusher
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
-- Horacio Sanson
+- Horacio Sanson / Fernando Wong / Nicolas Bersano(WNS and MPNS support)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &18258240 !ruby/object:Gem::Requirement
+  requirement: &16244860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18258240
+  version_requirements: *16244860
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &18257120 !ruby/object:Gem::Requirement
+  requirement: &16244440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18257120
+  version_requirements: *16244440
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &18255620 !ruby/object:Gem::Requirement
+  requirement: &16244020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18255620
+  version_requirements: *16244020
 - !ruby/object:Gem::Dependency
   name: daemon-spawn
-  requirement: &18254140 !ruby/object:Gem::Requirement
+  requirement: &16243600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18254140
-description: Stand alone push notification server for APN and GCM.
+  version_requirements: *16243600
+description: Stand alone push notification server for APN, GCM, WNS and MPNS.
 email:
-- rd@skillupjapan.co.jp
+- rd@skillupjapan.co.jp, n.bersano@skillupchile.cl
 executables:
 - pusher
 extensions: []
@@ -76,6 +76,10 @@ files:
 - lib/suj/pusher/logger.rb
 - lib/suj/pusher/monkey/hash.rb
 - lib/suj/pusher/version.rb
+- lib/suj/pusher/wns_connection.rb
+- lib/suj/pusher/wns_notification.rb
+- lib/suj/pusher/wpns_connection.rb
+- lib/suj/pusher/wpns_notification.rb
 - bin/pusher
 homepage: https://github.com/sujrd/suj-pusher
 licenses: []