hackedunit-apn_sender 1.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kali Donovan
+
+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.rdoc

@@ -0,0 +1,131 @@
+== Synopsis
+
+Need to send background notifications to an iPhone application over a <em>persistent</em> connection in Ruby? Keep reading...
+
+== The Story
+
+So you're building the server component of an iPhone application in Ruby.  And you want to send background notifications through the Apple Push Notification servers, which doesn't seem too bad at first.  But then you read in the {Apple Documentation}[https://developer.apple.com/iphone/library/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/WhatAreRemoteNotif/WhatAreRemoteNotif.html#//apple_ref/doc/uid/TP40008194-CH102-SW7] that Apple's servers may treat non-persistent connections as a Denial of Service attack, and you realize that Rails has no easy way to maintain a persistent connection internally, and things started looking more complicated.
+
+The apn_sender gem includes a background daemon which processes background messages from your application and sends them along to Apple <em>over a single, persistent socket</em>.  It also includes the ability to query the Feedback service, helper methods for enqueueing your jobs, and a sample monit config to make sure the background worker is around when you need it.
+
+== Yet another ApplePushNotification interface?
+
+Yup.  There's some great code out there already, but we didn't like the idea of getting banned from the APN gateway for establishing a new connection each time we needed to send a batch of messages, and none of the libraries I found handled maintaining a persistent connection.
+
+== Current Status
+
+This gem has been in production use since early May, 2010.  There are no guarantees of complete functionality, of course, but it's working for us. :)
+
+
+== Usage
+
+=== 1. Queueing Messages From Your Application
+
+To queue a message for sending through Apple's Push Notification service from your Rails application:
+
+  APN.notify(token, opts_hash)
+  
+where +token+ is the unique identifier of the iPhone to receive the notification and +opts_hash+ can have any of the following keys:
+
+  # :alert  #=> The alert to send
+  # :badge  #=> The badge number to send
+  # :sound  #=> The sound file to play on receipt, or true to play the default sound installed with your app
+
+If any other keys are present they'll be be passed along as custom data to your application.
+
+=== 2. Sending Queued Messages
+
+Put your <code>apn_development.pem</code> and <code>apn_production.pem</code> certificates from Apple in your <code>RAILS_ROOT/config/certs</code> directory.
+
+Once this is done, you can fire off a background worker with
+
+  $ rake apn:sender
+  
+For production, you're probably better off running a dedicated daemon and setting up monit to watch over it for you.  Luckily, that's pretty easy:
+
+  # To generate daemon
+  ./script/generate apn_sender
+
+  # To run daemon. Pass --help to print all options
+  ./script/apn_sender --environment=production --verbose start
+
+Note the --environment must be explicitly set (separately from your <code>RAILS_ENV</code>) to production in order to send messages via the production APN servers.  Any other environment sends messages through Apple's sandbox servers at <code>gateway.sandbox.push.apple.com</code>.
+
+Check <code>RAILS_ROOT/logs/apn_sender.log</code> for debugging output.  In addition to logging any major errors there, apn_sender hooks into the Resque::Worker logging to display any verbose or very_verbose worker output in apn_sender.log file as well.
+
+
+=== 3. Checking Apple's Feedback Service
+  
+Since push notifications are a fire-and-forget sorta deal, where you get no indication if your message was received (or if the specified recipient even exists), Apple needed to come up with some other way to ensure their network isn't clogged with thousands of bogus messages (e.g. from developers sending messages to phones where their application <em>used</em> to be installed, but where the user has since removed it).  Hence, the Feedback Service.
+
+It's actually really simple - you connect to them periodically and they give you a big dump of tokens you shouldn't send to anymore.  The gem wraps this up nicely -- just call:
+
+  # APN::Feedback accepts the same optional :environment and :cert_path options as APN::Sender
+  feedback = APN::Feedback.new()
+
+  tokens = feedback.tokens # => Array of device tokens
+  tokens.each do |token|
+    # ... custom logic here to stop you app from
+    # sending further notifications to this token
+  end
+  
+If you're interested in knowing exactly <em>when</em> Apple determined each token was expired (which can be useful in determining if the application re-registered with your service since it first appeared in the expired queue):
+
+  items = feedback.data # => Array of APN::FeedbackItem elements
+  items.each do |item|
+    item.token
+    item.timestamp
+    # ... custom logic here
+  end
+
+The Feedback Service works as a big queue.  When you connect it pops off all its data and sends it over the wire at once, which means connecting a second time will return an empty array, so for ease of use a call to either +tokens+ or +data+ will connect once and cache the data.  If you call either one again it'll continue to use its cached version (rather than connecting to Apple a second time to retrieve an empty array, which is probably not what you want).
+
+Forcing a reconnect is as easy as calling either method with the single parameter +true+, but be sure you've already used the existing data because you'll never get it back.
+
+
+==== Warning: No really, check Apple's Feedback Service occasionally
+
+If you're sending notifications, you should definitely call one of the <code>receive</code> methods periodically, as Apple's policies require it and they apparently monitors providers for compliance.  I'd definitely recommend throwing together a quick rake task to take care of this for you (the {whenever library}[http://github.com/javan/whenever] provides a nice wrapper around scheduling tasks to run at certain times (for systems with cron enabled)).
+
+Just for the record, this is essentially what you want to have whenever run periodically for you:
+
+  def self.clear_uninstalled_applications
+    feedback_data = APN::Feedback.new(:environment => :production).data
+  
+    feedback_data.each do |item|
+      user = User.find_by_iphone_token( item.token )
+      
+      if user.iphone_token_updated_at && user.iphone_token_updated_at > item.timestamp
+        return true # App has been reregistered since Apple determined it'd been uninstalled
+      else
+        user.update_attributes(:iphone_token => nil, :iphone_token_updated_at => Time.now) 
+      end
+    end
+  end
+
+
+
+
+=== Keeping Your Workers Working
+
+There's also an included sample <code>apn_sender.monitrc</code> file in the <code>contrib/</code> folder to help monit handle server restarts and unexpected disasters.
+
+
+== Installation
+
+APN is built on top of {Resque}[http://github.com/defunkt/resque] (an awesome {Redis}[http://code.google.com/p/redis/]-based background runner similar to {delayed_job}[http://github.com/collectiveidea/delayed_job]). Read through the {Resque README}[http://github.com/defunkt/resque#readme] to get a feel for what's going on, follow the installation instructions there, and then run:
+
+  $ sudo gem install apn_sender
+
+In your Rails app, add
+
+  config.gem 'apn_sender', :lib => 'apn'
+  
+To add a few useful rake tasks for running workers, add the following line to your Rakefile:
+
+  require 'apn/tasks'
+
+
+== Copyright
+
+Copyright (c) 2010 Kali Donovan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+load 'lib/apn/tasks.rb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hackedunit-apn_sender"
+    gem.summary = %Q{Resque-based background worker to send Apple Push Notifications over a persistent TCP socket.}
+    gem.description = %Q{Resque-based background worker to send Apple Push Notifications over a persistent TCP socket. Includes Resque tweaks to allow persistent sockets between jobs, helper methods for enqueueing APN notifications, and a background daemon to send them.}
+    gem.email = "kali.donovan@gmail.com"
+    gem.homepage = "http://github.com/hackedunit/apn_sender"
+    gem.authors = ["Kali Donovan", "Tinu Cleatus"]
+    gem.add_dependency 'resque'
+    gem.add_dependency 'resque-access_worker_from_job'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apple_push_notification #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/contrib/apn_sender.monitrc

@@ -0,0 +1,22 @@
+# An example Monit configuration file for running the apn_sender background daemon
+#
+#   1. Replace #{app_name} with your application name
+#   2. Add any arguments between apn_sender the and start/stop command
+#   3. Install as a monitrc file (paste to bottom of /etc/monit/monitrc, or save as a .monitrc file and include in the main config)
+
+check process redis
+  with pidfile /var/run/redis.pid
+  group apn_sender
+  start program = "/usr/bin/redis-server /etc/redis/redis.conf"
+  stop program = "/bin/echo SHUTDOWN | nc localhost 6379"
+  if failed host 127.0.0.1 port 6379 then restart
+  if 5 restarts within 5 cycles then timeout
+
+
+check process apn_sender
+  with pidfile /var/www/#{app_name}/shared/pids/apn_sender.pid
+  group apn_sender
+  start program = "/var/www/#{app_name}/current/script/apn_sender --environment=production --verbose start"
+  stop program = "/var/www/{#app_name}/current/script/apn_sender --environment=production --verbose stop"
+  if 2 restarts within 3 cycles then timeout
+  depends_on redis

data/generators/apn_sender_generator.rb

@@ -0,0 +1,9 @@
+class ApnSenderGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.template 'script', 'script/apn_sender', :chmod => 0755
+    end
+  end
+
+end

data/generators/templates/script

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Daemons sets pwd to /, so we have to explicitly set RAILS_ROOT
+RAILS_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+require 'rubygems'
+require 'apn'
+require 'apn/sender_daemon'
+
+APN::SenderDaemon.new(ARGV).daemonize

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/apn.rb

@@ -0,0 +1,13 @@
+require 'resque'
+require 'resque/plugins/access_worker_from_job'
+require 'resque/hooks/before_unregister_worker'
+require 'json'
+require 'active_support'
+
+require 'apn/queue_name'
+require 'apn/queue_manager'
+require 'apn/notification'
+require 'apn/notification_job'
+require 'apn/connection/base'
+require 'apn/sender'
+require 'apn/feedback'

data/lib/apn/connection/base.rb

@@ -0,0 +1,117 @@
+require 'socket'
+require 'openssl'
+require 'resque'
+
+module APN
+  module Connection
+    # APN::Connection::Base takes care of all the boring certificate loading, socket creating, and logging
+    # responsibilities so APN::Sender and APN::Feedback and focus on their respective specialties.
+    module Base
+      attr_accessor :opts, :logger
+      
+      def initialize(opts = {})
+        @opts = opts
+
+        setup_logger
+        log(:info, "APN::Sender initializing. Establishing connections first...") if @opts[:verbose]
+        setup_paths
+
+        super( APN::QUEUE_NAME ) if self.class.ancestors.include?(Resque::Worker)
+      end
+      
+      # Lazy-connect the socket once we try to access it in some way
+      def socket
+        setup_connection unless @socket
+        return @socket
+      end
+            
+      protected
+      
+      # Default to Rails or Merg logger, if available
+      def setup_logger
+        @logger = if defined?(Merb::Logger)
+          Merb.logger
+        elsif defined?(RAILS_DEFAULT_LOGGER)
+          RAILS_DEFAULT_LOGGER
+        end
+      end
+      
+      # Log message to any logger provided by the user (e.g. the Rails logger).
+      # Accepts +log_level+, +message+, since that seems to make the most sense,
+      # and just +message+, to be compatible with Resque's log method and to enable
+      # sending verbose and very_verbose worker messages to e.g. the rails logger.#
+      #
+      # Perhaps a method definition of +message, +level+ would make more sense, but
+      # that's also the complete opposite of what anyone comming from rails would expect.
+      alias_method(:resque_log, :log) if defined?(log)
+      def log(level, message = nil)
+        level, message = 'info', level if message.nil? # Handle only one argument if called from Resque, which expects only message
+
+        resque_log(message) if defined?(resque_log)
+        return false unless self.logger && self.logger.respond_to?(level)
+        self.logger.send(level, "#{Time.now}: #{message}")
+      end
+      
+      # Log the message first, to ensure it reports what went wrong if in daemon mode. Then die, because something went horribly wrong.
+      def log_and_die(msg)
+        log(:fatal, msg)
+        raise msg
+      end
+      
+      def apn_production?
+        @opts[:environment] && @opts[:environment] != '' && :production == @opts[:environment].to_sym
+      end
+      
+      # Get a fix on the .pem certificate we'll be using for SSL
+      def setup_paths
+        # Set option defaults
+        @opts[:cert_path] ||= File.join(File.expand_path(RAILS_ROOT), "config", "certs") if defined?(RAILS_ROOT)
+        @opts[:environment] ||= RAILS_ENV if defined?(RAILS_ENV)
+        
+        log_and_die("Missing certificate path. Please specify :cert_path when initializing class.") unless @opts[:cert_path]
+        
+        cert_name = apn_production? ? "apn_production.pem" : "apn_development.pem"
+        cert_path = File.join(@opts[:cert_path], cert_name)
+
+        @apn_cert = File.exists?(cert_path) ? File.read(cert_path) : nil
+        log_and_die("Missing apple push notification certificate in #{cert_path}") unless @apn_cert
+      end
+      
+      # Open socket to Apple's servers
+      def setup_connection
+        log_and_die("Missing apple push notification certificate") unless @apn_cert
+        return true if @socket && @socket_tcp
+        log_and_die("Trying to open half-open connection") if @socket || @socket_tcp
+
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.cert = OpenSSL::X509::Certificate.new(@apn_cert)
+        ctx.key = OpenSSL::PKey::RSA.new(@apn_cert)
+
+        @socket_tcp = TCPSocket.new(apn_host, apn_port)
+        @socket = OpenSSL::SSL::SSLSocket.new(@socket_tcp, ctx)
+        @socket.sync = true
+        @socket.connect
+      rescue SocketError => error
+        log_and_die("Error with connection to #{apn_host}: #{error}")
+      end
+
+      # Close open sockets
+      def teardown_connection
+        log(:info, "Closing connections...") if @opts[:verbose]
+
+        begin
+          @socket.close if @socket
+        rescue Exception => e
+          log(:error, "Error closing SSL Socket: #{e}")
+        end
+
+        begin
+          @socket_tcp.close if @socket_tcp
+        rescue Exception => e
+          log(:error, "Error closing TCP Socket: #{e}")
+        end
+      end
+      
+    end
+  end
+end

data/lib/apn/feedback.rb

@@ -0,0 +1,92 @@
+require 'apn/connection/base'
+
+module APN
+  # Encapsulates data returned from the {APN Feedback Service}[http://developer.apple.com/iphone/library/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingWIthAPS/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW3].
+  # Possesses +timestamp+ and +token+ attributes.
+  class FeedbackItem
+    attr_accessor :timestamp, :token
+
+    def initialize(time, token)
+      @timestamp = time
+      @token = token
+    end
+
+    # For convenience, return the token on to_s
+    def to_s
+      token
+    end
+  end
+  
+  # When supplied with the certificate path and the desired environment, connects to the {APN Feedback Service}[http://developer.apple.com/iphone/library/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingWIthAPS/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW3]
+  # and returns any response as an array of APN::FeedbackItem elements.
+  # 
+  # See README for usage and details.
+  class Feedback
+    include APN::Connection::Base
+        
+    # Returns array of APN::FeedbackItem elements read from Apple. Connects to Apple once and caches the
+    # data, continues to returns cached data unless called with <code>data(true)</code>, which clears the
+    # existing feedback array.  Note that once you force resetting the cache you loose all previous feedback,
+    # so be sure you've already processed it.
+    def data(force = nil)
+      @feedback = nil if force
+      @feedback ||= receive
+    end
+    
+    # Wrapper around +data+ returning just an array of token strings.
+    def tokens(force = nil)
+      data(force).map(&:token)
+    end
+    
+    # Prettify to return meaningful status information when printed. Can't add these directly to connection/base, because Resque depends on decoding to_s
+    def inspect
+      "#<#{self.class.name}: #{to_s}>"
+    end
+    
+    # Prettify to return meaningful status information when printed. Can't add these directly to connection/base, because Resque depends on decoding to_s
+    def to_s
+      "#{@socket ? 'Connected' : 'Connection not currently established'} to #{apn_host} on #{apn_port}"
+    end
+    
+    protected
+        
+    # Connects to Apple's Feedback Service and checks if there's anything there for us.  
+    # Returns an array of APN::FeedbackItem pairs
+    def receive
+      feedback = []
+
+      # Hi Apple
+      setup_connection
+
+      # Unpacking code borrowed from http://github.com/jpoz/APNS/blob/master/lib/apns/core.rb
+      while line = socket.gets   # Read lines from the socket
+        line.strip!
+        f = line.unpack('N1n1H140')
+        feedback << APN::FeedbackItem.new(Time.at(f[0]), f[2])
+      end
+
+      # Bye Apple
+      teardown_connection
+
+      return feedback
+    end
+    
+    
+    def apn_host
+      @apn_host ||= apn_production? ? "feedback.push.apple.com" : "feedback.sandbox.push.apple.com"
+    end
+    
+    def apn_port
+      2196
+    end
+    
+  end
+end
+
+
+
+__END__
+# Testing from irb
+irb -r 'lib/apn/feedback'
+
+a=APN::Feedback.new(:cert_path => '/Users/kali/Code/insurrection/certs/', :environment => :production)

data/lib/apn/notification.rb

@@ -0,0 +1,86 @@
+module APN
+  # Encapsulates the logic necessary to convert an iPhone token and an array of options into a string of the format required
+  # by Apple's servers to send the notification.  Much of the processing code here copied with many thanks from
+  # http://github.com/samsoffes/apple_push_notification/blob/master/lib/apple_push_notification.rb
+  #
+  # APN::Notification.new's first argument is the token of the iPhone which should receive the notification.  The second argument
+  # is a hash with any of :alert, :badge, and :sound keys. All three accept string arguments, while :sound can also be set to +true+
+  # to play the default sound installed with the application. At least one of these keys must exist.  Any other keys are merged into
+  # the root of the hash payload ultimately sent to the iPhone:
+  #
+  #   APN::Notification.new(token, {:alert => 'Stuff', :custom => {:code => 23}})
+  #   # Writes this JSON to servers: {"aps" => {"alert" => "Stuff"}, "custom" => {"code" => 23}}
+  # 
+  # As a shortcut, APN::Notification.new also accepts a string as the second argument, which it converts into the alert to send.  The 
+  # following two lines are equivalent:
+  #
+  #   APN::Notification.new(token, 'Some Alert')
+  #   APN::Notification.new(token, {:alert => 'Some Alert'})
+  #
+  class Notification
+    # Available to help clients determine before they create the notification if their message will be too large.
+    # Each iPhone Notification payload must be 256 or fewer characters.  Encoding a null message has a 57 
+    # character overhead, so there are 199 characters available for the alert string.
+    MAX_ALERT_LENGTH = 199 
+    
+    attr_accessor :options, :token
+    def initialize(token, opts)
+      @options = hash_as_symbols(opts.is_a?(Hash) ? opts : {:alert => opts})
+      @token = token
+
+      raise "The maximum size allowed for a notification payload is 256 bytes." if packaged_notification.size.to_i > 256
+    end
+
+    def to_s
+      packaged_notification
+    end
+    
+    # Ensures at least one of <code>%w(alert badge sound)</code> is present
+    def valid?
+      return true if %w(alert badge sound).any?{|key| options.keys.include?(key.to_sym) }
+      false
+    end
+    
+    protected
+
+    # Completed encoded notification, ready to send down the wire to Apple
+    def packaged_notification
+      pt = packaged_token
+      pm = packaged_message
+      [0, 0, 32, pt, 0, pm.size, pm].pack("ccca*cca*") 
+    end
+
+    # Device token, compressed and hex-ified
+    def packaged_token
+      [@token.gsub(/[\s|<|>]/,'')].pack('H*')
+    end
+
+    # Converts the supplied options into the JSON needed for Apple's push notification servers.
+    # Extracts :alert, :badge, and :sound keys into the 'aps' hash, merges any other hash data
+    # into the root of the hash to encode and send to apple.
+    def packaged_message
+      opts = @options.clone # Don't destroy our pristine copy
+      hsh = {'aps' => {}}
+      hsh['aps']['alert'] = opts.delete(:alert).to_s if opts[:alert]
+      hsh['aps']['badge'] = opts.delete(:badge).to_i if opts[:badge]
+      if sound = opts.delete(:sound)
+        hsh['aps']['sound'] = sound.is_a?(TrueClass) ? 'default' : sound.to_s
+      end
+      hsh.merge!(opts)
+      ActiveSupport::JSON::encode(hsh)
+    end
+    
+    # Symbolize keys, using ActiveSupport if available
+    def hash_as_symbols(hash)
+      if hash.respond_to?(:symbolize_keys)
+        return hash.symbolize_keys
+      else
+       hash.inject({}) do |opt, (key, value)|
+         opt[(key.to_sym rescue key) || key] = value
+         opt
+       end
+     end
+   end
+   
+ end   
+end

data/lib/apn/notification_job.rb

@@ -0,0 +1,23 @@
+module APN
+  # This is the class that's actually enqueued via Resque when user calls +APN.notify+.
+  # It gets added to the +apple_server_notifications+ Resque queue, which should only be operated on by
+  # workers of the +APN::Sender+ class.
+  class NotificationJob
+    # Behind the scenes, this is the name of our Resque queue
+    @queue = APN::QUEUE_NAME
+
+    # Build a notification from arguments and send to Apple
+    def self.perform(token, opts)
+      msg = APN::Notification.new(token, opts)
+      raise "Invalid notification options (did you provide :alert, :badge, or :sound?): #{opts.inspect}" unless msg.valid?
+
+      worker.send_to_apple( msg )
+    end
+
+
+    # Only execute this job in specialized APN::Sender workers, since
+    # standard Resque workers don't maintain the persistent TCP connection.
+    extend Resque::Plugins::AccessWorkerFromJob
+    self.required_worker_class = 'APN::Sender'
+  end
+end

data/lib/apn/queue_manager.rb

@@ -0,0 +1,57 @@
+# Extending Resque to respond to the +before_unregister_worker+ hook. Note this requires a matching
+# monkeypatch in the Resque::Worker class. See +resque/hooks/before_unregister_worker.rb+ for an
+# example implementation
+
+module APN
+  # Enqueues a notification to be sent in the background via the persistent TCP socket, assuming apn_sender is running (or will be soon)
+  def self.notify(token, opts = {})
+    token = token.to_s.gsub(/\W/, '')
+    APN::QueueManager.enqueue(APN::NotificationJob, token, opts)
+  end  
+  
+  # Extends Resque, allowing us to add all the callbacks to Resque we desire without affecting the expected
+  # functionality in the parent app, if we're included in e.g. a Rails application.
+  class QueueManager
+    extend Resque
+
+    def self.before_unregister_worker(&block)
+      block ? (@before_unregister_worker = block) : @before_unregister_worker
+    end
+
+    def self.before_unregister_worker=(before_unregister_worker)
+      @before_unregister_worker = before_unregister_worker
+    end
+
+    def self.to_s
+      "APN::QueueManager (Resque Client) connected to #{redis.server}"
+    end
+  end
+  
+end
+
+# Ensures we close any open sockets when the worker exits
+APN::QueueManager.before_unregister_worker do |worker|
+  worker.send(:teardown_connection) if worker.respond_to?(:teardown_connection)
+end
+
+
+# # Run N jobs per fork, rather than creating a new fork for each notification
+# # By defunkt - http://gist.github.com/349376
+# APN::QueueManager.after_fork do |job|
+#   # How many jobs should we process in each fork?
+#   jobs_per_fork = 10
+# 
+#   # Set hook to nil to prevent running this hook over
+#   # and over while processing more jobs in this fork.
+#   Resque.after_fork = nil
+# 
+#   # Make sure we process jobs in the right order.
+#   job.worker.process(job)
+# 
+#   # One less than specified because the child will run a
+#   # final job after exiting this hook.
+#   (jobs_per_fork.to_i - 1).times do
+#     job.worker.process
+#   end
+# end
+

data/lib/apn/queue_name.rb

@@ -0,0 +1,4 @@
+module APN
+  # Change this to modify the queue from which notification jobs are pushed and pulled
+  QUEUE_NAME = :apple_push_notifications
+end

data/lib/apn/sender.rb

@@ -0,0 +1,47 @@
+module APN
+  # Subclass of Resque::Worker which initializes a single TCP socket on creation to communicate with Apple's Push Notification servers.
+  # Shares this socket with each child process forked off by Resque to complete a job. Socket is closed in the before_unregister_worker
+  # callback, which gets called on normal or exceptional exits.
+  #
+  # End result: single persistent TCP connection to Apple, so they don't ban you for frequently opening and closing connections,
+  # which they apparently view as a DOS attack.
+  #
+  # Accepts <code>:environment</code> (production vs anything else) and <code>:cert_path</code> options on initialization.  If called in a 
+  # Rails context, will default to RAILS_ENV and RAILS_ROOT/config/certs. :environment will default to development.  
+  # APN::Sender expects two files to exist in the specified <code>:cert_path</code> directory: 
+  # <code>apn_production.pem</code> and <code>apn_development.pem</code>.
+  #
+  # If a socket error is encountered, will teardown the connection and retry again twice before admitting defeat.
+  class Sender < ::Resque::Worker
+    include APN::Connection::Base
+    TIMES_TO_RETRY_SOCKET_ERROR = 2
+                                
+    # Send a raw string over the socket to Apple's servers (presumably already formatted by APN::Notification)
+    def send_to_apple( notification, attempt = 0 )
+      if attempt > TIMES_TO_RETRY_SOCKET_ERROR
+        log_and_die("Error with connection to #{apn_host} (retried #{TIMES_TO_RETRY_SOCKET_ERROR} times): #{error}")
+      end
+      
+      self.socket.write( notification.to_s )
+    rescue SocketError => error
+      log(:error, "Error with connection to #{apn_host} (attempt #{attempt}): #{error}")
+      
+      # Try reestablishing the connection
+      teardown_connection
+      setup_connection
+      send_to_apple(notification, attempt + 1)
+    end
+    
+    protected
+    
+    def apn_host
+      @apn_host ||= apn_production? ? "gateway.push.apple.com" : "gateway.sandbox.push.apple.com"
+    end
+    
+    def apn_port
+      2195
+    end
+
+  end
+
+end

data/lib/apn/sender_daemon.rb

@@ -0,0 +1,75 @@
+# Based roughly on delayed_job's delayed/command.rb
+require 'rubygems'
+require 'daemons'
+require 'optparse'
+require 'logger'
+
+module APN
+  # A wrapper designed to daemonize an APN::Sender instance to keep in running in the background.
+  # Connects worker's output to a custom logger, if available.  Creates a pid file suitable for
+  # monitoring with {monit}[http://mmonit.com/monit/].
+  #
+  # Based off delayed_job's great example, except we can be much lighter by not loading the entire
+  # Rails environment.  To use in a Rails app, <code>script/generate apn_sender</code>.
+  class SenderDaemon
+    
+    def initialize(args)
+      @options = {:worker_count => 1, :environment => :development, :delay => 5}
+      
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [options] start|stop|restart|run"
+
+        opts.on('-h', '--help', 'Show this message') do
+          puts opts
+          exit 1
+        end
+        opts.on('-e', '--environment=NAME', 'Specifies the environment to run this apn_sender under ([development]/production).') do |e|
+          @options[:environment] = e
+        end
+        opts.on('--cert-path=NAME', 'Path to directory containing apn .pem certificates.') do |path|
+          @options[:cert_path] = path
+        end
+        opts.on('-n', '--number-of-workers=WORKERS', "Number of unique workers to spawn") do |worker_count|
+          @options[:worker_count] = worker_count.to_i rescue 1
+        end
+        opts.on('-v', '--verbose', "Turn on verbose mode") do
+          @options[:verbose] = true
+        end
+        opts.on('-V', '--very-verbose', "Turn on very verbose mode") do
+          @options[:very_verbose] = true
+        end
+        opts.on('-d', '--delay=D', "Delay between rounds of work (seconds)") do |d|
+          @options[:delay] = d
+        end
+      end
+      
+      # If no arguments, give help screen
+      @args = optparse.parse!(args.empty? ? ['-h'] : args)
+      @options[:verbose] = true if @options[:very_verbose]
+    end
+  
+    def daemonize
+      @options[:worker_count].times do |worker_index|
+        process_name = @options[:worker_count] == 1 ? "apn_sender" : "apn_sender.#{worker_index}"
+        Daemons.run_proc(process_name, :dir => "#{::RAILS_ROOT}/tmp/pids", :dir_mode => :normal, :ARGV => @args) do |*args|
+          run process_name
+        end
+      end
+    end
+    
+    def run(worker_name = nil)
+      logger = Logger.new(File.join(::RAILS_ROOT, 'log', 'apn_sender.log'))
+      
+      worker = APN::Sender.new(@options)
+      worker.logger = logger
+      worker.verbose = @options[:verbose]
+      worker.very_verbose = @options[:very_verbose]
+      worker.work(@options[:delay])
+    rescue => e
+      STDERR.puts e.message
+      logger.fatal(e) if logger && logger.respond_to?(:fatal)
+      exit 1
+    end
+    
+  end
+end

data/lib/apn/tasks.rb

@@ -0,0 +1,39 @@
+# Slight modifications from the default Resque tasks
+namespace :apn do
+  task :setup
+  task :work => :sender
+  task :workers => :senders
+
+  desc "Start an APN worker"
+  task :sender => :setup do
+    require 'apn'
+
+    worker = nil
+
+    begin
+      worker = APN::Sender.new(:cert_path => ENV['CERT_PATH'], :environment => ENV['ENVIRONMENT'])
+      worker.verbose = ENV['LOGGING'] || ENV['VERBOSE']
+      worker.very_verbose = ENV['VVERBOSE']
+    rescue Exception => e
+      raise e
+      # abort "set QUEUE env var, e.g. $ QUEUE=critical,high rake resque:work"
+    end
+
+    puts "*** Starting worker to send apple notifications in the background from #{worker}"
+
+    worker.work(ENV['INTERVAL'] || 5) # interval, will block
+  end
+
+  desc "Start multiple APN workers. Should only be used in dev mode."
+  task :senders do
+    threads = []
+
+    ENV['COUNT'].to_i.times do
+      threads << Thread.new do
+        system "rake apn:work"
+      end
+    end
+
+    threads.each { |thread| thread.join }
+  end
+end

data/lib/resque/hooks/before_unregister_worker.rb

@@ -0,0 +1,30 @@
+# Adding a +before_unregister_worker+ hook Resque::Worker. To be used, must be matched by a similar monkeypatch
+# for Resque class itself, or else a class that extends Resque. See apple_push_notification/queue_manager.rb for 
+# an implementation.
+module Resque
+  class Worker
+    alias_method :unregister_worker_without_before_hook, :unregister_worker
+
+    # Wrapper for original unregister_worker method which adds a before hook +before_unregister_worker+
+    # to be executed if present.
+    def unregister_worker
+      run_hook(:before_unregister_worker, self) 
+      unregister_worker_without_before_hook
+    end
+    
+    
+    # Unforunately have to override Resque::Worker's +run_hook+ method to call hook on 
+    # APN::QueueManager rather on Resque directly. Any suggestions on
+    # how to make this more flexible are more than welcome.
+    def run_hook(name, *args)
+      # return unless hook = Resque.send(name)
+      return unless hook = APN::QueueManager.send(name)
+      msg = "Running #{name} hook"
+      msg << " with #{args.inspect}" if args.any?
+      log msg
+
+      args.any? ? hook.call(*args) : hook.call
+    end
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "apn"

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'apple_push_notification'
+
+class Test::Unit::TestCase
+end

data/test/test_apple_push_notification.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAPN < 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,102 @@
+--- !ruby/object:Gem::Specification 
+name: hackedunit-apn_sender
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Kali Donovan
+- Tinu Cleatus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-26 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-access_worker_from_job
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Resque-based background worker to send Apple Push Notifications over a persistent TCP socket. Includes Resque tweaks to allow persistent sockets between jobs, helper methods for enqueueing APN notifications, and a background daemon to send them.
+email: kali.donovan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- contrib/apn_sender.monitrc
+- generators/apn_sender_generator.rb
+- generators/templates/script
+- init.rb
+- lib/apn.rb
+- lib/apn/connection/base.rb
+- lib/apn/feedback.rb
+- lib/apn/notification.rb
+- lib/apn/notification_job.rb
+- lib/apn/queue_manager.rb
+- lib/apn/queue_name.rb
+- lib/apn/sender.rb
+- lib/apn/sender_daemon.rb
+- lib/apn/tasks.rb
+- lib/resque/hooks/before_unregister_worker.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_apple_push_notification.rb
+has_rdoc: true
+homepage: http://github.com/hackedunit/apn_sender
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Resque-based background worker to send Apple Push Notifications over a persistent TCP socket.
+test_files: 
+- test/helper.rb
+- test/test_apple_push_notification.rb