suj-pusher 0.0.1 → 0.1.0

data/README.md

@@ -62,13 +62,14 @@ Once the pusher daemon is running and connected to your redis server you can pus
 
 Example JSON message:
 
-```json
+```
 {
   'apn_ids': ["xxxxx"],
   'gcm_ids': ["xxxxx", "yyyyyy"],
   'development': true,
   'cert': "cert string",
   'api_key': "secret key",
+  'time_to_live': 0,
   'data': {
     'aps': {
       'alert': "This is a message"
@@ -82,6 +83,7 @@ Example JSON message:
 - development: This can be true or false and indicates if the push notification is to be sent using the APN sandbox gateway (yes) or the APN production gateway (no). This option only affects push notifications to iOS devices and is assumed yes if not provided.
 - cert: This is a string representation of the certificate used to send push notifications via the APN network. Simply read the cert.pem file as string and plug it in this field.
 - api_key: This is the secret api_key used to send push notifications via the GCM network. This is the key you get from the Google API console.
+- time_to_live: Time in seconds the message would be stored on the cloud in case the destination device is not available at the moment. The default value is zero that means the message is discarded if the destination is not reachable at the moment the notification is sent. Note that even if you set this value larger than zero there are limitations that may prevent the message from arriving. For example Google allows to store up to 4 sync messages or 100 payload messages for up to time_to_live messages or max 4 weeks while Apple only stores the last message up to to time_to_live seconds.
 - data: This is a custom hash that is sent as push notification to the devices. For GCM this hash may contain anything you want as long as its size do not exceed 4096. For APN this data hash MUST contain an *aps* hash that follows Apple push notification format.
 
 #### Apple *aps* hash

data/lib/suj/pusher/apn_connection.rb

@@ -41,11 +41,21 @@ module Suj
       end
 
       def deliver(data)
-        @notification = Suj::Pusher::ApnNotification.new(data)
-        if ! disconnected?
-          info "APN delivering data"
-          send_data(@notification.data)
-          @notification = nil
+        begin
+          @notification = Suj::Pusher::ApnNotification.new(data)
+          if ! disconnected?
+            info "APN delivering data"
+            send_data(@notification.data)
+            @notification = nil
+            info "APN delivered data"
+          else
+            info "APN connection unavailable"
+          end
+        rescue Suj::Pusher::ApnNotification::PayloadTooLarge => e
+          error "APN notification payload too large."
+          debug @notification.data.inspect
+        rescue => ex
+          error "APN notification error : #{ex}"
         end
       end
 
@@ -67,9 +77,10 @@ module Suj
         info "APN Connection established..."
         @disconnected = false
         if ! @notification.nil?
-          info "APN delivering data"
+          info "EST - APN delivering data"
           send_data(@notification.data)
           @notification = nil
+          info "EST - APN delivered data"
         end
       end
 
@@ -77,7 +88,7 @@ module Suj
         info "APN Connection closed..."
         @disconnected = true
         FileUtils.rm_f(@cert_file)
-        @pool.remove_connection(@cert)
+        @pool.remove_connection(@cert_key)
       end
     end
   end

data/lib/suj/pusher/apn_feedback_connection.rb

@@ -0,0 +1,50 @@
+require "eventmachine"
+
+require "base64"
+module Suj
+  module Pusher
+    class APNFeedbackConnection < EM::Connection
+      include Suj::Pusher::Logger
+
+      def initialize(options = {})
+        super
+        @disconnected = true
+        @options = options
+        @cert_key = Digest::SHA1.hexdigest(@options[:cert])
+        @cert_file = File.join(Suj::Pusher.config.certs_path, @cert_key)
+        File.open(@cert_file, "w") do |f|
+          f.write @options[:cert]
+        end
+        @ssl_options = {
+          private_key_file: @cert_file,
+          cert_chain_file: @cert_file,
+          verify_peer: false
+        }
+      end
+
+      def disconnected?
+        @disconnected
+      end
+
+      def post_init
+        info "APN Feedback Connection init "
+        start_tls(@ssl_options)
+      end
+
+      def receive_data(data)
+        timestamp, size, token = data.unpack("QnN")
+        info "APN Feedback invalid token #{token}"
+      end
+
+      def connection_completed
+        info "APN Feedback Connection established..."
+        @disconnected = false
+      end
+
+      def unbind
+        info "APN Feedback Connection closed..."
+        @disconnected = true
+      end
+    end
+  end
+end

data/lib/suj/pusher/apn_notification.rb

@@ -9,6 +9,7 @@ module Suj
 
       def initialize(options = {})
         @token = options[:token]
+        @ttl = options[:time_to_live] || 0
         @options = options
         raise InvalidToken if @token.nil? || (@token.length != 64)
         raise PayloadTooLarge if data.size > MAX_SIZE
@@ -24,15 +25,22 @@ module Suj
 
       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
         identifier = 0
-        expiry = 0
+        expiry = get_expiry
         size = [payload].pack("a*").size
         data_array = [1, identifier, expiry, 32, @token, size, payload]
         info("PAYLOAD: #{data_array}")
         data_array.pack("cNNnH*na*")
       end
-
     end
   end
 end

data/lib/suj/pusher/connection_pool.rb

@@ -9,7 +9,10 @@ module Suj
 
       APN_SANDBOX = "gateway.sandbox.push.apple.com"
       APN_GATEWAY = "gateway.push.apple.com"
+      FEEDBACK_SANDBOX = "feedback.sandbox.push.apple.com"
+      FEEDBACK_GATEWAY = "feedback.push.apple.com"
       APN_PORT = 2195
+      FEEDBACK_PORT = 2196
 
       def initialize(daemon)
         @pool = {}
@@ -28,6 +31,16 @@ module Suj
         @pool[cert] ||= EM.connect(APN_SANDBOX, APN_PORT, APNConnection, self, options)
       end
 
+      def feedback_connection(options = {})
+        info "Feedback connection"
+        EM.connect(FEEDBACK_GATEWAY, FEEDBACK_PORT, APNFeedbackConnection, options)
+      end
+
+      def feedback_sandbox_connection(options = {})
+        info "Feedback sandbox connection"
+        EM.connect(FEEDBACK_SANDBOX, FEEDBACK_PORT, APNFeedbackConnection, options)
+      end
+
       def gcm_connection(options = {})
         # All GCM connections are unique, even if they are to the same app.
         api_key = "#{options[:api_key]}#{rand * 100}"
@@ -37,7 +50,7 @@ module Suj
 
       def remove_connection(key)
         info "Removing connection #{key}"
-        @pool.delete(key)
+        info "Connection not found" unless @pool.delete(key)
       end
 
     end

data/lib/suj/pusher/daemon.rb

@@ -11,15 +11,24 @@ module Suj
     class Daemon
       include Suj::Pusher::Logger
 
+      FEEDBACK_TIME = 43200  # 12H
+
       def start
         info "Starting pusher daemon"
         EM.run do
           wait_msg do |msg|
             begin
+              info "RECEIVED MESSAGE"
               data = Hash.symbolize_keys(MultiJson.load(msg))
               send_notification(data)
+              info "SENT MESSAGE"
+              retrieve_feedback(data)
+              info "FINISHED FEEDBACK RETRIEVAL"
             rescue MultiJson::LoadError
               warn("Received invalid json data, discarding msg")
+            rescue => e
+              error("Error sending notification : #{e}")
+              error e.backtrace
             end
           end
         end
@@ -37,8 +46,28 @@ module Suj
       private
 
       def wait_msg
+        redis.on(:connected) { info "REDIS - Connected to Redis server" }
+        redis.on(:closed) { info "REDIS - Closed connection to Redis server" }
+        redis.on(:failed) { info "REDIS - redis connection FAILED" }
+        redis.on(:reconnected) { info "REDIS - Reconnected to Redis server" }
+        redis.on(:disconnected) { info "REDIS - Disconnected from Redis server" }
+        redis.on(:reconnect_failed) { info "REDIS - Reconnection attempt to Redis server FAILED" }
+        # EM.add_periodic_timer(30) { redis.publish Suj::Pusher::QUEUE, "ECHO" }
         redis.pubsub.subscribe(Suj::Pusher::QUEUE) do |msg|
-          yield msg
+          if msg == "ECHO"
+            info "REDIS - ECHO Received"
+          elsif msg == "PUSH_MSG"
+            info "REDIS - PUSH_MSG Received"
+            get_message.callback do |message|
+              if message
+                yield message
+              else
+                info "REDIS - PUSH_MSG Queue was empty"
+              end
+            end
+          else
+            yield msg
+          end
         end
       end
 
@@ -56,6 +85,16 @@ module Suj
         end
       end
 
+      def retrieve_feedback(msg)
+        if msg.has_key?(:cert)
+          if msg.has_key?(:development) && msg[:development]
+            feedback_sandbox_connection(msg)
+          else
+            feedback_connection(msg)
+          end
+        end
+      end
+
       def send_apn_notification(msg)
         info "Sending APN notification via connection #{Digest::SHA1.hexdigest(msg[:cert])}"
         conn = pool.apn_connection(msg)
@@ -72,6 +111,20 @@ module Suj
         end
       end
 
+      def feedback_connection(msg)
+        return if @last_feedback and (Time.now - @last_feedback < FEEDBACK_TIME)
+        info "Get feedback information"
+        conn = pool.feedback_connection(msg)
+        @last_feedback = Time.now
+      end
+
+      def feedback_sandbox_connection(msg)
+        return if @last_sandbox_feedback and (Time.now - @last_sandbox_feedback < FEEDBACK_TIME)
+        info "Get feedback sandbox information"
+        conn = pool.feedback_sandbox_connection(msg)
+        @last_sandbox_feedback = Time.now
+      end
+
       def send_gcm_notification(msg)
         info "Sending GCM notification via connection #{msg[:api_key]}"
         conn = pool.gcm_connection(msg)
@@ -79,7 +132,12 @@ module Suj
       end
 
       def redis
-        @redis || EM::Hiredis.connect(Suj::Pusher.config.redis)
+        @redis ||= EM::Hiredis.connect(Suj::Pusher.config.redis)
+      end
+
+      def get_message
+        @redis_connection ||= EM::Hiredis.connect(Suj::Pusher.config.redis)
+        @redis_connection.rpop MSG_QUEUE
       end
 
       def pool

data/lib/suj/pusher/gcm_connection.rb

@@ -23,10 +23,10 @@ module Suj
 
         body = MultiJson.dump({
           registration_ids: msg[:gcm_ids],
+          time_to_live: msg[:time_to_live] || 0,
           data: msg[:data] || {}
         })
 
-
         http = EventMachine::HttpRequest.new(GATEWAY).post( head: @headers, body: body )
 
         http.errback do

data/lib/suj/pusher/version.rb

@@ -1,5 +1,5 @@
 module Suj
   module Pusher
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end

data/lib/suj/pusher.rb

@@ -3,6 +3,7 @@ require 'suj/pusher/version'
 require 'suj/pusher/configuration'
 require 'suj/pusher/logger'
 require 'suj/pusher/connection_pool'
+require 'suj/pusher/apn_feedback_connection'
 require 'suj/pusher/apn_connection'
 require 'suj/pusher/gcm_connection'
 require 'suj/pusher/apn_notification'
@@ -13,7 +14,7 @@ require 'logger'
 module Suj
   module Pusher
 
-    QUEUE = "suj_pusher_queue"
-
+    QUEUE     = "suj_pusher_queue"
+    MSG_QUEUE = "suj_pusher_msgs"
   end
 end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: suj-pusher
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
 - Horacio Sanson
+- Fernando Wong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &19868920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19868920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &19868320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19868320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &19867580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19867580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: daemon-spawn
-  requirement: &19866460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +70,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19866460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Stand alone push notification server for APN and GCM.
 email:
 - rd@skillupjapan.co.jp
@@ -67,6 +88,7 @@ files:
 - README.md
 - lib/suj/pusher.rb
 - lib/suj/pusher/apn_connection.rb
+- lib/suj/pusher/apn_feedback_connection.rb
 - lib/suj/pusher/apn_notification.rb
 - lib/suj/pusher/configuration.rb
 - lib/suj/pusher/connection_pool.rb
@@ -96,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Stand alone push notification server.