apn_on_rails 0.2.2 → 0.3.0

data/README

@@ -73,17 +73,36 @@ APN on Rails uses the Configatron gem, http://github.com/markbates/configatron/t
 to configure itself. APN on Rails has the following default configurations that you change as you
 see fit:
 
+  # development (delivery):
   configatron.apn.passphrase # => ''
   configatron.apn.port # => 2195
   configatron.apn.host # => 'gateway.sandbox.push.apple.com'
   configatron.apn.cert #=> File.join(RAILS_ROOT, 'config', 'apple_push_notification_development.pem')
   
-  # production:
+  # production (delivery):
   configatron.apn.host # => 'gateway.push.apple.com'
   configatron.apn.cert #=> File.join(RAILS_ROOT, 'config', 'apple_push_notification_production.pem')
+  
+  # development (feedback):
+  configatron.apn.feedback.passphrase # => ''
+  configatron.apn.feedback.port # => 2196
+  configatron.apn.feedback.host # => 'feedback.sandbox.push.apple.com'
+  configatron.apn.feedback.cert #=> File.join(RAILS_ROOT, 'config', 'apple_push_notification_development.pem')
+  
+  # production (feedback):
+  configatron.apn.feedback.host # => 'feedback.push.apple.com'
+  configatron.apn.feedback.cert #=> File.join(RAILS_ROOT, 'config', 'apple_push_notification_production.pem')
 
 That's it, now you're ready to start creating notifications.
 
+===Upgrade Notes:
+
+If you are upgrading to a new version of APN on Rails you should always run:
+
+  $ ruby script/generate apn_migrations
+
+That way you ensure you have the latest version of the database tables needed.
+
 ==Example:
 
   $ ./script/console

data/generators/apn_migrations_generator.rb

@@ -1,5 +1,9 @@
 require 'rails_generator'
-# Generates the migrations necessary for APN on Rails
+# Generates the migrations necessary for APN on Rails.
+# This should be run upon install and upgrade of the 
+# APN on Rails gem.
+# 
+#   $ ruby script/generate apn_migrations
 class ApnMigrationsGenerator < Rails::Generator::Base
   
   def manifest # :nodoc:
@@ -9,11 +13,13 @@ class ApnMigrationsGenerator < Rails::Generator::Base
       
       m.directory(db_migrate_path)
       
-      ['001_create_apn_devices', '002_create_apn_notifications'].each_with_index do |f, i|
+      Dir.glob(File.join(File.dirname(__FILE__), 'templates', 'apn_migrations', '*.rb')).sort.each_with_index do |f, i|
+        f = File.basename(f)
+        f.match(/\d+\_(.+)/)
         timestamp = timestamp.succ
-        if Dir.glob(File.join(db_migrate_path, "*_#{f}.rb")).empty?
-          m.file(File.join('apn_migrations', "#{f}.rb"), 
-                 File.join(db_migrate_path, "#{timestamp}_#{f}.rb"), 
+        if Dir.glob(File.join(db_migrate_path, "*_#{$1}")).empty?
+          m.file(File.join('apn_migrations', f), 
+                 File.join(db_migrate_path, "#{timestamp}_#{$1}"), 
                  {:collision => :skip})
         end
       end

data/generators/templates/apn_migrations/003_alter_apn_devices.rb

@@ -0,0 +1,25 @@
+class AlterApnDevices < ActiveRecord::Migration # :nodoc:
+  
+  module APN # :nodoc:
+    class Device < ActiveRecord::Base # :nodoc:
+      set_table_name 'apn_devices'
+    end
+  end
+  
+  def self.up
+    add_column :apn_devices, :last_registered_at, :datetime
+    
+    APN::Device.all.each do |device|
+      device.last_registered_at = device.created_at
+      device.save!
+    end
+    change_column :apn_devices, :token, :string, :size => 100, :null => false
+    add_index :apn_devices, :token, :unique => true
+  end
+
+  def self.down
+    change_column :apn_devices, :token, :string
+    remove_index :apn_devices, :column => :token
+    remove_column :apn_devices, :last_registered_at
+  end
+end

data/lib/apn_on_rails/app/models/apn/base.rb

@@ -0,0 +1,9 @@
+module APN
+  class Base < ActiveRecord::Base # :nodoc:
+    
+    def self.table_name # :nodoc:
+      self.to_s.gsub("::", "_").tableize
+    end
+    
+  end
+end

data/lib/apn_on_rails/app/models/apn/device.rb

@@ -1,16 +1,27 @@
 # Represents an iPhone (or other APN enabled device).
 # An APN::Device can have many APN::Notification.
 # 
+# In order for the APN::Feedback system to work properly you *MUST*
+# touch the <tt>last_registered_at</tt> column everytime someone opens
+# your application. If you do not, then it is possible, and probably likely,
+# that their device will be removed and will no longer receive notifications.
+# 
 # Example:
 #   Device.create(:token => '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz')
-class APN::Device < ActiveRecord::Base
-  set_table_name 'apn_devices'
+class APN::Device < APN::Base
   
   has_many :notifications, :class_name => 'APN::Notification'
   
   validates_uniqueness_of :token
   validates_format_of :token, :with => /^[a-z0-9]{8}\s[a-z0-9]{8}\s[a-z0-9]{8}\s[a-z0-9]{8}\s[a-z0-9]{8}\s[a-z0-9]{8}\s[a-z0-9]{8}\s[a-z0-9]{8}$/
   
+  before_save :set_last_registered_at
+  
+  # The <tt>feedback_at</tt> accessor is set when the 
+  # device is marked as potentially disconnected from your
+  # application by Apple.
+  attr_accessor :feedback_at
+  
   # Stores the token (Apple's device ID) of the iPhone (device).
   # 
   # If the token comes in like this:
@@ -29,4 +40,9 @@ class APN::Device < ActiveRecord::Base
     [self.token.delete(' ')].pack('H*')
   end
   
+  private
+  def set_last_registered_at
+    self.last_registered_at = Time.now if self.last_registered_at.nil?
+  end
+  
 end

data/lib/apn_on_rails/app/models/apn/notification.rb

@@ -14,12 +14,10 @@
 # 
 # As each APN::Notification is sent the <tt>sent_at</tt> column will be timestamped,
 # so as to not be sent again.
-class APN::Notification < ActiveRecord::Base
+class APN::Notification < APN::Base
   include ::ActionView::Helpers::TextHelper
   extend ::ActionView::Helpers::TextHelper
   
-  set_table_name 'apn_notifications'
-  
   belongs_to :device, :class_name => 'APN::Device'
   
   # Stores the text alert message you want to send to the device.
@@ -84,10 +82,13 @@ class APN::Notification < ActiveRecord::Base
     # 
     # As each APN::Notification is sent the <tt>sent_at</tt> column will be timestamped,
     # so as to not be sent again.
+    # 
+    # This can be run from the following Rake task:
+    #   $ rake apn:notifications:deliver
     def send_notifications(notifications = APN::Notification.all(:conditions => {:sent_at => nil}))
       unless notifications.nil? || notifications.empty?
 
-        APN::Connection.open_for_delivery do |conn|
+        APN::Connection.open_for_delivery do |conn, sock|
           notifications.each do |noty|
             conn.write(noty.message_for_sending)
             noty.sent_at = Time.now

data/lib/apn_on_rails/{app/models/apn → libs}/connection.rb

@@ -33,8 +33,12 @@ module APN
       #   configatron.apn.feedback.host = 'feedback.push.apple.com' # Production
       #   configatron.apn.feedback.cert = File.join(rails_root, 'config', 'apple_push_notification_development.pem')) # Development
       #   configatron.apn.feedback.cert = File.join(rails_root, 'config', 'apple_push_notification_production.pem')) # Production
-      def open_for_feedback(options = {}, &block) # :nodoc:
-        
+      def open_for_feedback(options = {}, &block)
+        options = {:cert => configatron.apn.feedback.cert,
+                   :passphrase => configatron.apn.feedback.passphrase,
+                   :host => configatron.apn.feedback.host,
+                   :port => configatron.apn.feedback.port}.merge(options)
+        open(options, &block)
       end
       
       private
@@ -48,15 +52,15 @@ module APN
         ctx.key = OpenSSL::PKey::RSA.new(cert, options[:passphrase])
         ctx.cert = OpenSSL::X509::Certificate.new(cert)
   
-        s = TCPSocket.new(options[:host], options[:port])
-        ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
+        sock = TCPSocket.new(options[:host], options[:port])
+        ssl = OpenSSL::SSL::SSLSocket.new(sock, ctx)
         ssl.sync = true
         ssl.connect
   
-        yield ssl if block_given?
+        yield ssl, sock if block_given?
   
         ssl.close
-        s.close
+        sock.close
       end
       
     end

data/lib/apn_on_rails/libs/feedback.rb

@@ -0,0 +1,52 @@
+module APN
+  # Module for talking to the Apple Feedback Service.
+  # The service is meant to let you know when a device is no longer
+  # registered to receive notifications for your application.
+  module Feedback
+    
+    class << self
+      
+      # Returns an Array of APN::Device objects that
+      # has received feedback from Apple. Each APN::Device will
+      # have it's <tt>feedback_at</tt> accessor marked with the time
+      # that Apple believes the device de-registered itself.
+      def devices(&block)
+        devices = []
+        APN::Connection.open_for_feedback do |conn, sock|
+          while line = sock.gets   # Read lines from the socket
+            line.strip!
+            feedback = line.unpack('N1n1H140')
+            token = feedback[2].scan(/.{0,8}/).join(' ').strip
+            device = APN::Device.find(:first, :conditions => {:token => token})
+            if device
+              device.feedback_at = Time.at(feedback[0])
+              devices << device
+            end
+          end
+        end
+        devices.each(&block) if block_given?
+        return devices
+      end # devices
+      
+      # Retrieves a list of APN::Device instnces from Apple using
+      # the <tt>devices</tt> method. It then checks to see if the
+      # <tt>last_registered_at</tt> date of each APN::Device is
+      # before the date that Apple says the device is no longer
+      # accepting notifications then the device is deleted. Otherwise
+      # it is assumed that the application has been re-installed
+      # and is available for notifications.
+      # 
+      # This can be run from the following Rake task:
+      #   $ rake apn:feedback:process
+      def process_devices
+        APN::Feedback.devices.each do |device|
+          if device.last_registered_at < device.feedback_at
+            device.destroy
+          end
+        end
+      end # process_devices
+      
+    end # class << self
+    
+  end # Feedback
+end # APN

data/lib/apn_on_rails/tasks/apn.rake

@@ -9,4 +9,13 @@ namespace :apn do
     
   end # notifications
   
+  namespace :feedback do
+    
+    desc "Process all devices that have feedback from APN."
+    task :process => [:environment] do
+      APN::Feedback.process_devices
+    end
+    
+  end
+  
 end # apn

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: apn_on_rails
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-30 00:00:00 -04:00
+date: 2009-08-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,9 +33,11 @@ extra_rdoc_files:
 - LICENSE
 files: 
 - lib/apn_on_rails/apn_on_rails.rb
-- lib/apn_on_rails/app/models/apn/connection.rb
+- lib/apn_on_rails/app/models/apn/base.rb
 - lib/apn_on_rails/app/models/apn/device.rb
 - lib/apn_on_rails/app/models/apn/notification.rb
+- lib/apn_on_rails/libs/connection.rb
+- lib/apn_on_rails/libs/feedback.rb
 - lib/apn_on_rails/tasks/apn.rake
 - lib/apn_on_rails/tasks/db.rake
 - lib/apn_on_rails.rb
@@ -45,6 +47,7 @@ files:
 - generators/apn_migrations_generator.rb
 - generators/templates/apn_migrations/001_create_apn_devices.rb
 - generators/templates/apn_migrations/002_create_apn_notifications.rb
+- generators/templates/apn_migrations/003_alter_apn_devices.rb
 has_rdoc: true
 homepage: http://www.metabates.com
 licenses: []