apn_sender 1.0.0 → 1.0.1

data/README.rdoc

@@ -30,7 +30,8 @@ where +token+ is the unique identifier of the iPhone to receive the notification
   # :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
-  # :custom #=> Hash of application-specific custom data to send along with the notification
+
+If any other keys are present they'll be be passed along as custom data to your application.
 
 === 2. Sending Queued Messages
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/apn_sender.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apn_sender}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kali Donovan"]
-  s.date = %q{2010-05-06}
+  s.date = %q{2010-05-16}
   s.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.}
   s.email = %q{kali.donovan@gmail.com}
   s.extra_rdoc_files = [
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
      "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",
@@ -45,7 +46,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/kdonovan/apple_push_notification}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Resque-based background worker to send Apple Push Notifications over a persistent TCP socket.}
   s.test_files = [
     "test/helper.rb",

data/contrib/apn_sender.monitrc

@@ -1,21 +1,21 @@
 # An example Monit configuration file for running the apn_sender background daemon
 #
-#   1. Replace #{app_name} with the path to your configuration
+#   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
+#   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 /tmp/redis.pid
+  with pidfile /var/run/redis.pid
   group apn_sender
-  start program = "/usr/bin/redis-server /etc/redis.conf"
+  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/apps/#{app_name}/shared/pids/apn_sender.pid
+  with pidfile /var/www/#{app_name}/shared/pids/apn_sender.pid
   group apn_sender
-  start program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/apn_sender --environment=production start"
-  stop program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/apn_sender --environment=production stop"
+  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"
   depends_on redis

data/generators/templates/script

@@ -4,7 +4,6 @@
 RAILS_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
 require 'rubygems'
-require 'apn'
 require 'apn/sender_daemon'
 
 APN::SenderDaemon.new(ARGV).daemonize

data/lib/apn.rb

@@ -3,18 +3,8 @@ require 'resque/plugins/access_worker_from_job'
 require 'resque/hooks/before_unregister_worker'
 require 'json'
 
+require 'apn/queue_name'
 require 'apn/queue_manager'
-
-module APN
-  # Change this to modify the queue notification jobs are pushed to and pulled from
-  QUEUE_NAME = :apple_push_notifications
-  
-  # 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 = {})
-    APN::QueueManager.enqueue(APN::NotificationJob, token, opts)
-  end  
-end
-
 require 'apn/notification'
 require 'apn/notification_job'
 require 'apn/connection/base'

data/lib/apn/connection/base.rb

@@ -52,6 +52,12 @@ module APN
         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
@@ -62,19 +68,20 @@ module APN
         @opts[:cert_path] ||= File.join(File.expand_path(RAILS_ROOT), "config", "certs") if defined?(RAILS_ROOT)
         @opts[:environment] ||= RAILS_ENV if defined?(RAILS_ENV)
         
-        raise "Missing certificate path. Please specify :cert_path when initializing class." unless @opts[:cert_path]
+        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
-        raise "Missing apple push notification certificate in #{cert_path}" unless @apn_cert
+        log_and_die("Missing apple push notification certificate in #{cert_path}") unless @apn_cert
       end
       
       # Open socket to Apple's servers
       def setup_connection
-        raise "Missing apple push notification certificate" unless @apn_cert
+        log_and_die("Missing apple push notification certificate") unless @apn_cert
         return true if @socket && @socket_tcp
-        raise "Trying to open half-open connection" 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)
@@ -85,8 +92,7 @@ module APN
         @socket.sync = true
         @socket.connect
       rescue SocketError => error
-        log(:error, "Error with connection to #{apn_host}: #{error}")
-        raise "Error with connection to #{apn_host}: #{error}"      
+        log_and_die("Error with connection to #{apn_host}: #{error}")
       end
 
       # Close open sockets

data/lib/apn/queue_manager.rb

@@ -3,6 +3,11 @@
 # 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 = {})
+    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

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

@@ -19,7 +19,7 @@ module APN
     # 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
-        raise "Error with connection to #{apn_host} (retried #{TIMES_TO_RETRY_SOCKET_ERROR} times): #{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 )
@@ -73,4 +73,5 @@ worker.work(5)
 args = ['--environment=production', '--cert-path=/Users/kali/Code/insurrection/certs/']
 APN::SenderDaemon.new(args).daemonize
 
-
+# To run daemonized version in Rails app
+./script/apn_sender --environment=production start

data/lib/apn/sender_daemon.rb

@@ -1,18 +1,24 @@
-# Modified slightly from delayed_job's delayed/command.rb
+# Based roughly on delayed_job's delayed/command.rb
 require 'rubygems'
 require 'daemons'
 require 'optparse'
+require 'logger'
+
+require 'apn/queue_name'
+require 'apn/connection/base'
+require 'apn/sender'
 
 module APN
   # A wrapper designed to daemonize an APN::Sender instance to keep in running in the background.
-  # Connects worker's output to the Rails logger, if available.  Creates a pid file suitable for
+  # 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.  To use in a Rails app, <code>script/generate apn_sender</code>.
+  # 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 = {:quiet => true, :worker_count => 1, :environment => :development, :delay => 5}
+      @options = {:worker_count => 1, :environment => :development, :delay => 5}
       
       optparse = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename($0)} [options] start|stop|restart|run"
@@ -24,16 +30,16 @@ module APN
         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', '--certificate-path=NAME', 'Path to directory containing apn .pem certificates.') do |path|
+        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|
+        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
+        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|
@@ -56,14 +62,7 @@ module APN
     end
     
     def run(worker_name = nil)
-      Dir.chdir(::RAILS_ROOT)
-      require File.join(::RAILS_ROOT, 'config', 'environment')
-      
-      # Replace the default logger
       logger = Logger.new(File.join(::RAILS_ROOT, 'log', 'apn_sender.log'))
-      logger.level = ActiveRecord::Base.logger.level
-      ActiveRecord::Base.logger = logger
-      ActiveRecord::Base.clear_active_connections!
       
       worker = APN::Sender.new(@options)
       worker.logger = logger
@@ -71,10 +70,10 @@ module APN
       worker.very_verbose = @options[:very_verbose]
       worker.work(@options[:delay])
     rescue => e
-      logger.fatal(e) if logger.respond_to?(:fatal)
       STDERR.puts e.message
+      logger.fatal(e) if logger && logger.respond_to?(:fatal)
       exit 1
     end
     
   end
-end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: apn_sender
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Kali Donovan
@@ -9,29 +14,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-06 00:00:00 -07:00
+date: 2010-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: resque
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: resque-access_worker_from_job
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  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: []
@@ -59,6 +68,7 @@ files:
 - 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
@@ -79,18 +89,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Resque-based background worker to send Apple Push Notifications over a persistent TCP socket.