apn_sender 1.0.3 → 1.0.4

data/README.rdoc

@@ -4,7 +4,7 @@ Need to send background notifications to an iPhone application over a <em>persis
 
 == 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.
+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 start 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.
 
@@ -15,7 +15,7 @@ Yup.  There's some great code out there already, but we didn't like the idea of
 == 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. :)
-
+** UPDATE: our site is now defunct (for completely-unrelated reasons), but the many forks and watchers make me think something's going right. **
 
 == Usage
 
@@ -85,7 +85,7 @@ Forcing a reconnect is as easy as calling either method with the single paramete
 
 ==== 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)).
+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 monitor 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:
 
@@ -115,12 +115,16 @@ There's also an included sample <code>apn_sender.monitrc</code> file in the <cod
 
 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
+  $ gem install apn_sender
 
-In your Rails app, add
+In your Rails app, add (2.3.x):
 
   config.gem 'apn_sender', :lib => 'apn'
   
+or (3.x) to your Gemfile:
+  
+  gem 'apn_sender', :require => 'apn'
+  
 To add a few useful rake tasks for running workers, add the following line to your Rakefile:
 
   require 'apn/tasks'

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.4

data/apn_sender.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apn_sender}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kali Donovan"]
-  s.date = %q{2011-04-22}
+  s.date = %q{2011-05-15}
   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 = [
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/kdonovan/apple_push_notification}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{Resque-based background worker to send Apple Push Notifications over a persistent TCP socket.}
   s.test_files = [
     "test/helper.rb",

data/lib/apn/connection/base.rb

@@ -29,17 +29,17 @@ module APN
       
       # 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
+        @logger = if defined?(::Merb::Logger)
+          ::Merb.logger
+        elsif defined?(::Rails.logger)
+          ::Rails.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.#
+      # 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.
@@ -52,7 +52,8 @@ 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.
+      # 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
@@ -64,9 +65,10 @@ module APN
       
       # 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)
+        # Set option defaults. RAILS_ROOT is still here not from Rails, but to handle passing in root from sender_daemon
+        @opts[:root_path] ||= defined?(::Rails.root) ? ::Rails.root.to_s : (defined?(RAILS_ROOT) ? RAILS_ROOT : '/')
+        @opts[:cert_path] ||= File.join(File.expand_path(@opts[:root_path]), "config", "certs")
+        @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]
         
@@ -114,4 +116,4 @@ module APN
       
     end
   end
-end
+end

data/lib/apn/sender.rb

@@ -7,11 +7,13 @@ module APN
   # 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.  
+  # Rails context, <code>:cert_path</code> will default to "#{Rails.root}/config/certs" and <code>:environment</code>'s default will be set
+  # from Rails.env (production if Rails.env is production, development for any other Rails.env value).
+  #
   # 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.
+  # If a socket error is encountered, it 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apn_sender
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Kali Donovan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-22 00:00:00 -06:00
+date: 2011-05-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Resque-based background worker to send Apple Push Notifications over a persistent TCP socket.