apn_sender 1.0.5 → 1.0.6

data/CHANGELOG

@@ -0,0 +1,5 @@
+* 1.0.6
+- Added support for password-protected .pem files
+- Read feedback data in 38-byte chunks
+- Support passing dictionary as :alert key
+- Logging to STDOUT if no other loggers present

data/README.md

@@ -0,0 +1,158 @@
+## UPDATE May 3, 2013: current status
+
+This project was not supported for a while, but we are going to support it again. 
+
+-----
+
+## 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/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Introduction.html) 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.
+
+## 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 on 500px,sending million of notifications.
+
+## 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:
+
+Options:
+
+* :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 ```apn_development.pem``` and ```apn_production.pem``` certificates from Apple in your ```RAILS_ROOT/config/certs``` 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>.
+
+Also, there are two similar options: ```:cert_path``` and ```:full_cert_path```.  The former specifies the directory in which to find the .pem file (either apn_production.pem or apn_development.pem, depending on the environment). The latter specifies a .pem file explicitly, allowing customized certificate names if needed.
+
+Check ```logs/apn_sender.log``` 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 / :full_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 ```receive``` 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:
+```
+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 ```apn_sender.monitrc``` file in the ```contrib/``` 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:
+
+```
+  $ gem install apn_sender
+```
+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'
+```
+
+## Copyright
+
+Copyright (c) 2010 Kali Donovan. See LICENSE for details.

data/Rakefile

@@ -1,56 +1,35 @@
-require 'rubygems'
-require 'rake'
-
-load 'lib/apn/tasks.rb'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "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/kdonovan/apple_push_notification"
-    gem.authors = ["Kali Donovan"]
-    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 "bundler"
+Bundler.setup
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+require "rake"
+require "rspec/core/rake_task"
 
-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
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "apn/version"
+
+task :gem => :build
+task :build do
+  system "gem build apn_sender.gemspec"
 end
 
-task :test => :check_dependencies
+task :install => :build do
+  system "gem install apn_sender-#{APN::VERSION}.gem"
+end
 
-task :default => :test
+task :release => :build do
+  system "git tag -a v#{APN::VERSION} -m 'Tagging #{APN::VERSION}'"
+  system "git push --tags"
+  system "gem push apn_sender-#{APN::VERSION}.gem"
+  system "rm apn_sender-#{APN::VERSION}.gem"
+end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "apple_push_notification #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
 end
+
+task :default => :spec

data/lib/apn/connection/base.rb

@@ -29,11 +29,12 @@ module APN
       
       # Default to Rails or Merg logger, if available
       def setup_logger
-        @logger = if defined?(::Merb::Logger)
-          ::Merb.logger
+        @logger = if defined?(Merb::Logger)
+          Merb.logger
         elsif defined?(::Rails.logger)
           ::Rails.logger
         end
+        @logger ||= Logger.new(STDOUT)
       end
       
       # Log message to any logger provided by the user (e.g. the Rails logger).
@@ -89,7 +90,12 @@ module APN
 
         ctx = OpenSSL::SSL::SSLContext.new
         ctx.cert = OpenSSL::X509::Certificate.new(@apn_cert)
-        ctx.key = OpenSSL::PKey::RSA.new(@apn_cert)
+        
+        if @opts[:cert_pass]
+          ctx.key = OpenSSL::PKey::RSA.new(@apn_cert, @opts[:cert_pass])
+        else
+          ctx.key = OpenSSL::PKey::RSA.new(@apn_cert)
+        end
 
         @socket_tcp = TCPSocket.new(apn_host, apn_port)
         @socket = OpenSSL::SSL::SSLSocket.new(@socket_tcp, ctx)

data/lib/apn/feedback.rb

@@ -16,14 +16,14 @@ module APN
       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,
@@ -32,25 +32,25 @@ module APN
       @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.  
+
+    # 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 = []
@@ -59,9 +59,8 @@ module APN
       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')
+      while bunch = socket.read(38)   # Read data from the socket
+        f = bunch.strip.unpack('N1n1H140')
         feedback << APN::FeedbackItem.new(Time.at(f[0]), f[2])
       end
 
@@ -70,23 +69,15 @@ module APN
 
       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

@@ -10,8 +10,8 @@ module APN
   #
   #   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 
+  #
+  # 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')
@@ -19,13 +19,13 @@ module APN
   #
   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 
+    # 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 
-    
+    MAX_ALERT_LENGTH = 199
+
     attr_accessor :options, :token
     def initialize(token, opts)
-      @options = hash_as_symbols(opts.is_a?(Hash) ? opts : {:alert => opts})
+      @options = opts.is_a?(Hash) ? opts.symbolize_keys : {:alert => opts}
       @token = token
 
       raise "The maximum size allowed for a notification payload is 256 bytes." if packaged_notification.size.to_i > 256
@@ -34,20 +34,20 @@ module APN
     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) }
+      return true if [:alert, :badge, :sound].any?{|key| options.keys.include?(key) }
       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*") 
+      [0, 0, 32, pt, 0, pm.size, pm].pack("ccca*cca*")
     end
 
     # Device token, compressed and hex-ified
@@ -61,7 +61,10 @@ module APN
     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]
+      if alert = opts.delete(:alert)
+        alert = alert.to_s unless alert.is_a?(Hash)
+        hsh['aps']['alert'] = alert
+      end
       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
@@ -69,18 +72,6 @@ module APN
       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
+
+  end
+end

data/lib/apn/notification_job.rb

@@ -11,7 +11,8 @@ module APN
       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 )
+      raise "APN::NotificationJob was picked up by a non-APN:Sender resque worker. Aborting." unless worker
+      worker.send_to_apple(msg)
     end
 
 

data/lib/apn/sender.rb

@@ -6,14 +6,14 @@ module APN
   # 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, <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).
-  #
+  # Accepts <code>:environment</code> (production vs anything else), <code>:cert_pass</code> 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, it will teardown the connection and retry again twice before admitting defeat.
+  # Use the <code>:cert_pass</code> option if your certificates require a password
+  #
+  # 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

data/lib/apn/sender_daemon.rb

@@ -32,6 +32,9 @@ module APN
         opts.on('c', '--full-cert-path=NAME', 'Full path to desired .pem certificate (overrides environment selector).') do |path|
           @options[:full_cert_path] = path
         end
+        opts.on('--cert-pass=PASSWORD', 'Password for the apn .pem certificates.') do |pass|
+          @options[:cert_pass] = pass
+        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

data/lib/apn/tasks.rb

@@ -8,16 +8,9 @@ namespace :apn do
   task :sender => :setup do
     require 'apn'
 
-    worker = nil
-
-    begin
-      worker = APN::Sender.new(:full_cert_path => ENV['FULL_CERT_PATH'], :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
+    worker = APN::Sender.new(:full_cert_path => ENV['FULL_CERT_PATH'], :cert_path => ENV['CERT_PATH'], :environment => ENV['ENVIRONMENT'], :cert_pass => ENV['CERT_PASS'])
+    worker.verbose = ENV['LOGGING'] || ENV['VERBOSE']
+    worker.very_verbose = ENV['VVERBOSE']
 
     puts "*** Starting worker to send apple notifications in the background from #{worker}"
 

data/lib/apn/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module APN
+  VERSION = "1.0.6"
+end

metadata

@@ -1,72 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: apn_sender
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 1.0.6
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 5
-  version: 1.0.5
 platform: ruby
-authors: 
+authors:
 - Kali Donovan
+- Arthur Neves
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-15 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: resque
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: resque-access_worker_from_job
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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: arthurnn@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- apn_sender.gemspec
-- contrib/apn_sender.monitrc
-- generators/apn_sender_generator.rb
-- generators/templates/script
-- init.rb
-- lib/apn.rb
+extra_rdoc_files: []
+files:
 - lib/apn/connection/base.rb
 - lib/apn/feedback.rb
 - lib/apn/notification.rb
@@ -76,44 +78,37 @@ files:
 - lib/apn/sender.rb
 - lib/apn/sender_daemon.rb
 - lib/apn/tasks.rb
+- lib/apn/version.rb
+- lib/apn.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/kdonovan/apple_push_notification
-licenses: []
-
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+homepage: http://github.com/arthurnn/apn_sender
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.24
 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
+summary: Resque-based background worker to send Apple Push Notifications over a persistent
+  TCP socket.
+test_files: []

data/.document

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

data/README.rdoc

@@ -1,137 +0,0 @@
-== 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 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.
-
-== 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. :)
-** UPDATE: our site is now defunct (for completely-unrelated reasons), but the many forks and watchers make me think something's going right. **
-
-== 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>.
-
-Also, there are two similar options <code>:cert_path</code> and <code>:full_cert_path</code>.  The former specifies the directory in which to file the .pem file (either apn_production.pem or apn_development.pem, depending on the environment). The latter specifies a .pem file explicitly, allowing customized certificate names for those that need them.
-
-Check <code>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 / :full_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 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:
-
-  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:
-
-  $ gem install apn_sender
-
-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'
-
-
-== Copyright
-
-Copyright (c) 2010 Kali Donovan. See LICENSE for details.

data/VERSION

@@ -1 +0,0 @@
-1.0.5

data/apn_sender.gemspec

@@ -1,69 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{apn_sender}
-  s.version = "1.0.5"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kali Donovan"]
-  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 = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "apn_sender.gemspec",
-    "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"
-  ]
-  s.homepage = %q{http://github.com/kdonovan/apple_push_notification}
-  s.require_paths = ["lib"]
-  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",
-    "test/test_apple_push_notification.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<resque>, [">= 0"])
-      s.add_runtime_dependency(%q<resque-access_worker_from_job>, [">= 0"])
-    else
-      s.add_dependency(%q<resque>, [">= 0"])
-      s.add_dependency(%q<resque-access_worker_from_job>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<resque>, [">= 0"])
-    s.add_dependency(%q<resque-access_worker_from_job>, [">= 0"])
-  end
-end
-

data/contrib/apn_sender.monitrc

@@ -1,22 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-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

@@ -1,10 +0,0 @@
-#!/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

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

data/rails/init.rb

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

data/test/helper.rb

@@ -1,10 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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