racoon 0.3.1 → 0.3.2

data/README.mdown

@@ -34,14 +34,14 @@ You can see progress by looking at the [issue tracker](https://www.pivotaltracke
 ## Preparing Certificates
 
 Certificates must be prepared before they can be used with racoon. Unfortunately, Apple
-gives us @.p12@ files instead of @.pem@ files. As such, we need to convert them. This
+gives us *.p12* files instead of *.pem* files. As such, we need to convert them. This
 can be accomplished by dropping to the command line and running this command:
 
 <pre>
 $ openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
 </pre>
 
-This will generate a file suitable for use with this daemon, called @cert.pem@. If you're
+This will generate a file suitable for use with this daemon, called *cert.pem*. If you're
 using frac.as, this is the file you would upload to the web service.
 
 If you're not using frac.as, then the contents of this file are what you need to use as
@@ -80,7 +80,7 @@ the following method:
 def beanstalk
   return @beanstalk if @beanstalk
   @beanstalk = Beanstalk::Pool.new ["127.0.0.1:11300"]
-  @beanstalk.use "awesome-tube"
+  @beanstalk.use "racoon-apns"
   @beanstalk
 end
 ```
@@ -90,6 +90,9 @@ the appropriate tube whether the connection is open yet or not.
 
 We will also need two pieces of information: A project, and a notification.
 
+**Note that the tube should always be "racoon-apns". The server won't look on any other tube for
+push notifications.**
+
 ### Project
 
 A project os comprised of a few pieces of information at a minimum (you may supply more if you
@@ -105,8 +108,7 @@ A notification is a ruby hash containing the things to be sent along, including
 An example notification may look like this:
 
 ```ruby
-notification = { :device_token => "hex encoded device token",
-                 :aps => { :alert => "Some text",
+notification = { :aps => { :alert => "Some text",
                            :sound => "Audio_file",
                            :badge => 42,
                            :custom => { :field => "lala",
@@ -118,7 +120,11 @@ notification = { :device_token => "hex encoded device token",
 Finally within we can send a push notification using the following code:
 
 ```ruby
-beanstalk.yput({ :project => project, :notification => notification, :sandbox => true })
+beanstalk.yput({ :project => project,
+                 :notification => notification,
+                 :device_token => "binary encoded token",
+                 :sandbox => true
+})
 ```
 
 Note that the `sandbox` parameter is used to indicate whether or not we're using a development

data/bin/{apnsend → racoon-send}

@@ -4,16 +4,17 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'logger'
 require 'getoptlong'
 require 'rubygems'
-require 'apnserver'
+require 'racoon'
 require 'base64'
 require 'socket'
+require 'yajl'
+require 'csv'
+require 'beanstalk-client'
 
 def usage
-  puts "Usage: apnsend [switches] (--b64-token | --hex-token) <token>"
-  puts " --server <localhost>                 the apn server defaults to a locally running apnserverd"
-  puts " --port <2195>                        the port of the apn server"
+  puts "Usage: racoon-send [switches] (--b64-token | --hex-token) <token>"
+  puts " --beanstalk <127.0.0.1:11300>        csv of ip:port for beanstalk servers"
   puts " --pem <path>                         the path to the pem file, if a pem is supplied the server defaults to gateway.push.apple.com:2195"
-  puts " --pem-passphrase <passphrase>        the pem passphrase"
   puts " --alert <message>                    the message to send"
   puts " --sound <default>                    the sound to play, defaults to 'default'"
   puts " --badge <number>                     the badge number"
@@ -24,34 +25,30 @@ def usage
 end
 
 opts = GetoptLong.new(
-  ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT],
-  ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT],
+  ["--beanstalk", "-b", GetoptLong::REQUIRED_ARGUMENT],
   ["--pem", "-c", GetoptLong::REQUIRED_ARGUMENT],
-  ["--pem-passphrase", "-C", GetoptLong::REQUIRED_ARGUMENT],
   ["--alert", "-a", GetoptLong::REQUIRED_ARGUMENT],
   ["--sound", "-S", GetoptLong::REQUIRED_ARGUMENT],
-  ["--badge", "-b", GetoptLong::REQUIRED_ARGUMENT],
+  ["--badge", "-n", GetoptLong::REQUIRED_ARGUMENT],
   ["--custom", "-j", GetoptLong::REQUIRED_ARGUMENT],
   ["--b64-token", "-B", GetoptLong::REQUIRED_ARGUMENT],
   ["--hex-token", "-H", GetoptLong::REQUIRED_ARGUMENT],
   ["--help", "-h", GetoptLong::NO_ARGUMENT]
 )
 
-notification = ApnServer::Notification.new
+beanstalks = ["127.0.0.1:11300"]
+certificate = nil
+notification = Racoon::Notification.new
 
 opts.each do |opt, arg|
   case opt
   when '--help'
     usage
     exit
-  when '--server'
-    ApnServer::Config.host = arg
-  when '--port'
-    ApnServer::Config.port = arg.to_i
+  when '--beanstalk'
+    beanstalks = CSV.parse(arg)[0]
   when '--pem'
-    ApnServer::Config.pem = File.read(arg)
-  when '--pem-passphrase'
-    ApnServer::Config.password = arg
+    certificate = File.read(arg)
   when '--alert'
     notification.alert = arg
   when '--sound'
@@ -59,11 +56,11 @@ opts.each do |opt, arg|
   when '--badge'
     notification.badge = arg.to_i
   when '--custom'
-    notification.custom = ActiveSupport::JSON.decode(arg)
+    notification.custom = Yajl::Parser.parse(arg)
   when '--b64-token'
     notification.device_token = Base64::decode64(arg)
   when '--hex-token'
-    notification.device_token  = arg.scan(/[0-9a-f][0-9a-f]/).map {|s| s.hex.chr}.join
+    notification.device_token = arg.scan(/[0-9a-f][0-9a-f]/).map {|s| s.hex.chr}.join
   end
 end
 
@@ -71,5 +68,9 @@ if notification.device_token.nil?
   usage
   exit
 else
-  notification.push
+  bs = Beanstalk::Pool.new beanstalks
+  %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 })
 end

data/lib/racoon.rb

@@ -4,3 +4,7 @@ require 'racoon/payload'
 require 'racoon/notification'
 require 'racoon/client'
 require 'racoon/feedback_client'
+
+module Racoon
+  VERSION = "0.3.2"
+end

data/lib/racoon/client.rb

@@ -31,7 +31,9 @@ module Racoon
     end
 
     def write(notification)
-      Config.logger.debug "#{Time.now} [#{host}:#{port}] Device: #{notification.device_token.unpack('H*')} sending #{notification.json_payload}"
+      if host.include? "sandbox"
+        Config.logger.debug "#{Time.now} [#{host}:#{port}] Device: #{notification.device_token.unpack('H*')} sending #{notification.json_payload}"
+      end
       @ssl.write(notification.to_bytes)
     end
 
@@ -39,4 +41,4 @@ module Racoon
       @ssl
     end
   end
-end
+end

data/lib/racoon/server.rb

@@ -15,8 +15,6 @@ module Racoon
       tube = "racoon-#{arg}"
       return @beanstalks[tube] if @beanstalks[tube]
       @beanstalks[tube] = Beanstalk::Pool.new @beanstalkd_uris
-      %w{watch use}.each { |s| @beanstalks[tube].send(s, "racoon-#{tube}") }
-      @beanstalks[tube].ignore('default')
       @beanstalks[tube]
     end
 
@@ -24,8 +22,11 @@ module Racoon
       EventMachine::run do
         EventMachine::PeriodicTimer.new(3600) do
           begin
-            if beanstalk('feedback').peek_ready
-              item = beanstalk('feedback').reserve(1)
+            b = beanstalk('feedback')
+            %w{watch use}.each { |s| b.send(s, "racoon-feedback") }
+            b.ignore('default')
+            if b.peek_ready
+              item = b.reserve(1)
               handle_feedback(item)
             end
           rescue Beanstalk::TimedOut
@@ -33,21 +34,29 @@ module Racoon
           end
         end
 
+        # Every minute,poll all the clients, ensuring they've been inactive for 20+ minutes.
         EventMachine::PeriodicTimer.new(60) do
-          begin
-            if beanstalk('killer').peek_ready
-              item = beanstalk('killer').reserve(1)
-              purge_client(item)
+          remove_clients = []
+
+          @clients.each_pair do |project_name, packet|
+            if Time.now - packet[:timestamp] >= 1200 # 20 minutes
+              packet[:connection].disconnect!
+              remove_clients << project_name
             end
-          rescue Beanstalk::TimedOut
-            Config.logger.info "(Beanstalkd) Unable to secure a job, operation timed out."
+          end
+
+          remove_clients.each do |project_name|
+            @clients[project_name] = nil
           end
         end
 
         EventMachine::PeriodicTimer.new(1) do
           begin
-            if beanstalk('apns').peek_ready
-              item = beanstalk('apns').reserve(1)
+            b = beanstalk('apns')
+            %w{watch use}.each { |s| b.send(s, "racoon-apns") }
+            b.ignore('default')
+            if b.peek_ready
+              item = b.reserve(1)
               handle_job item
             end
           rescue Beanstalk::TimedOut
@@ -84,15 +93,17 @@ module Racoon
 
       if notification
         client = get_client(project[:name], project[:certificate], packet[:sandbox])
+        connection = client[:connection]
         begin
-          client.connect! unless client.connected?
-          client.write(notification)
+          connection.connect! unless connection.connected?
+          connection.write(notification)
+          @clients[project[:name]][:timestamp] = Time.now
 
           job.delete
         rescue Errno::EPIPE, OpenSSL::SSL::SSLError, Errno::ECONNRESET
           Config.logger.error "Caught Error, closing connecting and adding notification back to queue"
 
-          client.disconnect!
+          connection.disconnect!
 
           # Queue back up the notification
           job.release
@@ -127,22 +138,22 @@ module Racoon
       end
     end
 
+    # Returns a hash containing a timestamp referring to when the connection was opened.
+    # This timestamp will be updated to reflect when there was last activity over the socket.
     def get_client(project_name, certificate, sandbox = false)
       uri = "gateway.#{sandbox ? 'sandbox.' : ''}push.apple.com"
       unless @clients[project_name]
-        @clients[project_name] = Racoon::Client.new(certificate, uri)
-        # in 18 hours (64800 seconds) we need to schedule this socket to be killed. Long opened
-        # sockets don't work.
-        beanstalk('killer').yput({:certificate => certificate, :sandbox => sandbox}, 65536, 64800)
+        @clients[project_name] = { :timestamp => Time.now, :connection => Racoon::Client.new(certificate, uri) }
       end
-      @clients[project_name] ||= Racoon::Client.new(certificate, uri)
+      @clients[project_name] ||= { :timestamp => Time.now, :connection => Racoon::Client.new(certificate, uri) }
       client = @clients[project_name]
+      connection = client[:connection]
 
       # If the certificate has changed, but we still are connected using the old certificate,
       # disconnect and reconnect.
-      unless client.pem.eql?(certificate)
-        client.disconnect! if client.connected?
-        @clients[project_name] = Racoon::Client.new(certificate, uri)
+      unless connection.pem.eql?(certificate)
+        connection.disconnect! if connection.connected?
+        @clients[project_name] = { :timestamp => Time.now, :connection => Racoon::Client.new(certificate, uri) }
         client = @clients[project_name]
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: racoon
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-23 00:00:00.000000000 -04:00
+date: 2011-04-24 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70118651237540 !ruby/object:Gem::Requirement
+  requirement: &70102541072720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70118651237540
+  version_requirements: *70102541072720
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &70118651237080 !ruby/object:Gem::Requirement
+  requirement: &70102541072160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70118651237080
+  version_requirements: *70102541072160
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70118651236620 !ruby/object:Gem::Requirement
+  requirement: &70102541071700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70118651236620
+  version_requirements: *70102541071700
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70118651236160 !ruby/object:Gem::Requirement
+  requirement: &70102541071120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,19 +55,20 @@ dependencies:
         version: 0.12.8
   type: :development
   prerelease: false
-  version_requirements: *70118651236160
+  version_requirements: *70102541071120
 description: A toolkit for proxying and sending Apple Push Notifications prepared
   for a hosted environment
 email: jeremy.tregunna@me.com
 executables:
+- racoon-send
 - racoond
 extensions: []
 extra_rdoc_files:
 - README.mdown
 files:
-- bin/apnsend
 - bin/apnserverd.fedora.init
 - bin/apnserverd.ubuntu.init
+- bin/racoon-send
 - bin/racoond
 - lib/racoon/client.rb
 - lib/racoon/config.rb