racoon 0.3.2 → 0.4.0

data/README.mdown

@@ -28,8 +28,7 @@ persistent connection to Apple.
 
 ## Remaining Tasks & Issues
 
-You can see progress by looking at the [issue tracker](https://www.pivotaltracker.com/projects/251991) page for fracas. Any labels related to
-*apnserver* or *racoon* are related to this subproject.
+You can see progress by looking at the [issue tracker](https://www.pivotaltracker.com/projects/279053).
 
 ## Preparing Certificates
 
@@ -122,11 +121,16 @@ Finally within we can send a push notification using the following code:
 ```ruby
 beanstalk.yput({ :project => project,
                  :notification => notification,
+                 :send_at => Time.mktime(2012, 12, 21, 4, 15)
                  :device_token => "binary encoded token",
                  :sandbox => true
 })
 ```
 
+This will construct a notification which is to be scheduled to be delivered on December 21st,
+2012 at 4:15 AM localtime to the server. That is, if the server's timezone is UTC, you must
+account for that in your client application.
+
 Note that the `sandbox` parameter is used to indicate whether or not we're using a development
 certificate, and as such, should contact Apple's sandbox APN service instead of the production
 certificate. If left out, we assume production.

data/bin/racoon-send

@@ -72,5 +72,9 @@ else
   %w{use watch}.each { |s| bs.send(s, "racoon-apns") }
   bs.ignore("default")
   project = { :name => "test", :certificate => certificate }
-  bs.yput({ :project => project, :notification => notification.payload, :device_token => notification.device_token, :sandbox => true })
+  bs.yput({ :project => project,
+            :notification => notification.payload,
+            :device_token => notification.device_token,
+            :sandbox => true
+  })
 end

data/lib/racoon.rb

@@ -6,5 +6,5 @@ require 'racoon/client'
 require 'racoon/feedback_client'
 
 module Racoon
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/racoon/notification.rb

@@ -6,7 +6,12 @@ module Racoon
   class Notification
     include Racoon::Payload
 
-    attr_accessor :device_token, :alert, :badge, :sound, :custom
+    attr_accessor :identifier, :expiry, :device_token, :alert, :badge, :sound, :custom, :send_at, :expiry
+
+    def initialize
+      @expiry = 0
+      @send_at = Time.now
+    end
 
     def payload
       p = Hash.new
@@ -23,24 +28,9 @@ module Racoon
       j
     end
 
-=begin
-    def push
-      if Config.pem.nil?
-        socket = TCPSocket.new(Config.host || 'localhost', Config.port.to_i || 22195)
-        socket.write(to_bytes)
-        socket.close
-      else
-        client = Racoon::Client.new(Config.pem, Config.host || 'gateway.push.apple.com', Config.port.to_i || 2195)
-        client.connect!
-        client.write(self)
-        client.disconnect!
-      end
-    end
-=end
-
     def to_bytes
       j = json_payload
-      [0, 0, device_token.size, device_token, 0, j.size, j].pack("ccca*cca*")
+      [1, identifier, expiry.to_i, device_token.size, device_token, j.size, j].pack("cNNna*na*")
     end
 
     def self.valid?(p)
@@ -62,23 +52,25 @@ module Racoon
       buffer = p.dup
       notification = Notification.new
 
-      header = buffer.slice!(0, 3).unpack('ccc')
-      if header[0] != 0
-        raise RuntimeError.new("Header of notification is invalid: #{header.inspect}")
-      end
+      header = buffer.slice!(0, 11).unpack("cNNn")
+      raise RuntimeError.new("Header of notification is invalid: #{header.inspect}") if header[0] != 1
+
+      # identifier
+      notification.identifier = header[1]
+      notification.expiry = header[2]
 
-      # parse token
-      notification.device_token = buffer.slice!(0, 32).unpack('a*').first
+      # device token
+      notification.device_token = buffer.slice!(0, 32).unpack("a*").first
 
-      # parse json payload
-      payload_len = buffer.slice!(0, 2).unpack('CC')
+      # JSON payload
+      payload_len = buffer.slice!(0, 2).unpack("n")
       j = buffer.slice!(0, payload_len.last)
       result = Yajl::Parser.parse(j)
 
       ['alert', 'badge', 'sound'].each do |k|
         notification.send("#{k}=", result['aps'][k]) if result['aps'] && result['aps'][k]
       end
-      result.delete('aps')
+      result.delete("aps")
       notification.custom = result
 
       notification

data/lib/racoon/server.rb

@@ -50,15 +50,17 @@ module Racoon
           end
         end
 
-        EventMachine::PeriodicTimer.new(1) do
+        EventMachine::PeriodicTimer.new(2) do
           begin
             b = beanstalk('apns')
             %w{watch use}.each { |s| b.send(s, "racoon-apns") }
             b.ignore('default')
-            if b.peek_ready
+            jobs = []
+            until b.peek_ready.nil?
               item = b.reserve(1)
-              handle_job item
+              jobs << item
             end
+            handle_jobs jobs if jobs.count > 0
           rescue Beanstalk::TimedOut
             Config.logger.info "(Beanstalkd) Unable to secure a job, operation timed out."
           end
@@ -75,42 +77,47 @@ module Racoon
     #     :certificate => "contents of a certificate.pem"
     #   },
     #   :device_token => "0f21ab...def",
-    #   :notification => notification.json_payload,
+    #   :notification => notification.payload,
     #   :sandbox => true # Development environment?
     # }
-    def handle_job(job)
-      packet = job.ybody
-      project = packet[:project]
+    def handle_jobs(jobs)
+      connections = {}
+      jobs.each do |job|
+        packet = job.ybody
+        project = packet[:project]
 
-      aps = packet[:notification][:aps]
+        client = get_client(project[:name], project[:certificate], packet[:sandbox])
+        conn = client[:connection]
+        connections[conn] ||= []
 
-      notification = Notification.new
-      notification.device_token = packet[:device_token]
-      notification.badge = aps[:badge] if aps.has_key? :badge
-      notification.alert = aps[:alert] if aps.has_key? :alert
-      notification.sound = aps[:sound] if aps.has_key? :sound
-      notification.custom = aps[:custom] if aps.has_key? :custom
+        notification = create_notification_from_packet(packet)
 
-      if notification
-        client = get_client(project[:name], project[:certificate], packet[:sandbox])
-        connection = client[:connection]
-        begin
-          connection.connect! unless connection.connected?
-          connection.write(notification)
-          @clients[project[:name]][:timestamp] = Time.now
+        connections[conn] << { :job => job, :notification => notification }
+      end
+
+      connections.each_pair do |conn, tasks|
+        conn.connect! unless conn.connected?
+        tasks.each do |data|
+          job = data[:job]
+          notif = data[:notification]
 
-          job.delete
-        rescue Errno::EPIPE, OpenSSL::SSL::SSLError, Errno::ECONNRESET
-          Config.logger.error "Caught Error, closing connecting and adding notification back to queue"
+          begin
+            conn.write(notif)
+            @clients[project[:name]][:timestamp] = Time.now
 
-          connection.disconnect!
+            # TODO: Listen for error responses from Apple
+            job.delete
+          rescue Errno::EPIPE, OpenSSL::SSL::SSLError, Errno::ECONNRESET
+            Config.logger.error "Caught error, closing connection and adding notification back to queue"
 
-          # Queue back up the notification
-          job.release
-        rescue RuntimeError => e
-          Config.logger.error "Unable to handle: #{e}"
+            connection.disconnect!
 
-          job.delete
+            job.release
+          rescue RuntimeError => e
+            Config.logger.error "Unable to handle: #{e}"
+
+            job.delete
+          end
         end
       end
     end
@@ -167,5 +174,20 @@ module Racoon
       @clients[project_name] = nil
       job.delete
     end
+
+    def create_notification_from_packet(packet)
+      aps = packet[:notification][:aps]
+
+      notification = Notification.new
+      notification.identifier = packet[:identifier]
+      notification.expiry = packet[:expiry]
+      notification.device_token = packet[:device_token]
+      notification.badge = aps[:badge] if aps.has_key? :badge
+      notification.alert = aps[:alert] if aps.has_key? :alert
+      notification.sound = aps[:sound] if aps.has_key? :sound
+      notification.custom = aps[:custom] if aps.has_key? :custom
+
+      notification
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: racoon
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70102541072720 !ruby/object:Gem::Requirement
+  requirement: &70324876524860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70102541072720
+  version_requirements: *70324876524860
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &70102541072160 !ruby/object:Gem::Requirement
+  requirement: &70324876524360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70102541072160
+  version_requirements: *70324876524360
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70102541071700 !ruby/object:Gem::Requirement
+  requirement: &70324876523860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70102541071700
+  version_requirements: *70324876523860
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70102541071120 !ruby/object:Gem::Requirement
+  requirement: &70324876523360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 0.12.8
   type: :development
   prerelease: false
-  version_requirements: *70102541071120
+  version_requirements: *70324876523360
 description: A toolkit for proxying and sending Apple Push Notifications prepared
   for a hosted environment
 email: jeremy.tregunna@me.com