apn_on_rails 0.2.0 → 0.2.2

data/README

@@ -94,10 +94,15 @@ That's it, now you're ready to start creating notifications.
   >> notification.sound = true
   >> notification.alert = "foobar"
   >> notification.save
-  >> APN::Notification.send_notifications
 
-You can also run the following Rake task to send your notifications:
+You can use the following Rake task to deliver your notifications:
 
   $ rake apn:notifications:deliver
 
+The Rake task will find any unsent notifications in the database. If there aren't any notifications
+it will simply do nothing. If there are notifications waiting to be delivered it will open a single connection
+to Apple and push all the notifications through that one connection. Apple does not like people opening/closing
+connections constantly, so it's pretty important that you are careful about batching up your notifications so
+Apple doesn't shut you down.
+
 Released under the MIT license.

data/generators/apn_migrations_generator.rb

@@ -4,10 +4,22 @@ class ApnMigrationsGenerator < Rails::Generator::Base
   
   def manifest # :nodoc:
     record do |m|
-      [:create_apn_devices, :create_apn_notifications].each do |f|
-        m.migration_template(File.join('apn_migrations', "#{f}.rb"), "db/migrate", {:migration_file_name => f, :collision => :skip})
+      timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      db_migrate_path = File.join('db', 'migrate')
+      
+      m.directory(db_migrate_path)
+      
+      ['001_create_apn_devices', '002_create_apn_notifications'].each_with_index do |f, i|
+        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"), 
+                 {:collision => :skip})
+        end
       end
-    end
-  end
+      
+    end # record
+    
+  end # manifest
   
-end
+end # ApnMigrationsGenerator

data/lib/apn_on_rails/apn_on_rails.rb

@@ -14,12 +14,22 @@ end
 
 configatron.apn.set_default(:passphrase, '')
 configatron.apn.set_default(:port, 2195)
-configatron.apn.set_default(:host, 'gateway.sandbox.push.apple.com')
-configatron.apn.set_default(:cert, File.join(rails_root, 'config', 'apple_push_notification_development.pem'))
+
+configatron.apn.feedback.set_default(:passphrase, configatron.apn.passphrase)
+configatron.apn.feedback.set_default(:port, 2196)
 
 if rails_env == 'production'
   configatron.apn.set_default(:host, 'gateway.push.apple.com')
   configatron.apn.set_default(:cert, File.join(rails_root, 'config', 'apple_push_notification_production.pem'))
+  
+  configatron.apn.feedback.set_default(:host, 'feedback.push.apple.com')
+  configatron.apn.feedback.set_default(:cert, configatron.apn.cert)
+else
+  configatron.apn.set_default(:host, 'gateway.sandbox.push.apple.com')
+  configatron.apn.set_default(:cert, File.join(rails_root, 'config', 'apple_push_notification_development.pem'))
+  
+  configatron.apn.feedback.set_default(:host, 'feedback.sandbox.push.apple.com')
+  configatron.apn.feedback.set_default(:cert, configatron.apn.cert)
 end
 
 module APN # :nodoc:

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

@@ -0,0 +1,65 @@
+module APN
+  module Connection
+    
+    class << self
+      
+      # Yields up an SSL socket to write notifications to.
+      # The connections are close automatically.
+      # 
+      #  Example:
+      #   APN::Configuration.open_for_delivery do |conn|
+      #     conn.write('my cool notification')
+      #   end
+      # 
+      # Configuration parameters are:
+      # 
+      #   configatron.apn.passphrase = ''
+      #   configatron.apn.port = 2195
+      #   configatron.apn.host = 'gateway.sandbox.push.apple.com' # Development
+      #   configatron.apn.host = 'gateway.push.apple.com' # Production
+      #   configatron.apn.cert = File.join(rails_root, 'config', 'apple_push_notification_development.pem')) # Development
+      #   configatron.apn.cert = File.join(rails_root, 'config', 'apple_push_notification_production.pem')) # Production
+      def open_for_delivery(options = {}, &block)
+        open(options, &block)
+      end
+      
+      # Yields up an SSL socket to receive feedback from.
+      # The connections are close automatically.
+      # Configuration parameters are:
+      # 
+      #   configatron.apn.feedback.passphrase = ''
+      #   configatron.apn.feedback.port = 2196
+      #   configatron.apn.feedback.host = 'feedback.sandbox.push.apple.com' # Development
+      #   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:
+        
+      end
+      
+      private
+      def open(options = {}, &block) # :nodoc:
+        options = {:cert => configatron.apn.cert,
+                   :passphrase => configatron.apn.passphrase,
+                   :host => configatron.apn.host,
+                   :port => configatron.apn.port}.merge(options)
+        cert = File.read(options[:cert])
+        ctx = OpenSSL::SSL::SSLContext.new
+        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)
+        ssl.sync = true
+        ssl.connect
+  
+        yield ssl if block_given?
+  
+        ssl.close
+        s.close
+      end
+      
+    end
+    
+  end # Connection
+end # APN

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

@@ -86,25 +86,15 @@ class APN::Notification < ActiveRecord::Base
     # so as to not be sent again.
     def send_notifications(notifications = APN::Notification.all(:conditions => {:sent_at => nil}))
       unless notifications.nil? || notifications.empty?
-        logger.info "APN: Attempting to deliver #{pluralize(notifications.size, 'notification')}."
-        cert = File.read(configatron.apn.cert)
-        ctx = OpenSSL::SSL::SSLContext.new
-        ctx.key = OpenSSL::PKey::RSA.new(cert, configatron.apn.passphrase)
-        ctx.cert = OpenSSL::X509::Certificate.new(cert)
-  
-        s = TCPSocket.new(configatron.apn.host, configatron.apn.port)
-        ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
-        ssl.sync = true
-        ssl.connect
-  
-        notifications.each do |noty|
-          ssl.write(noty.message_for_sending)
-          noty.sent_at = Time.now
-          noty.save
+
+        APN::Connection.open_for_delivery do |conn|
+          notifications.each do |noty|
+            conn.write(noty.message_for_sending)
+            noty.sent_at = Time.now
+            noty.save
+          end
         end
-  
-        ssl.close
-        s.close
+
       end
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: apn_on_rails
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-26 00:00:00 -04:00
+date: 2009-07-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,7 @@ 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/device.rb
 - lib/apn_on_rails/app/models/apn/notification.rb
 - lib/apn_on_rails/tasks/apn.rake
@@ -42,8 +43,8 @@ files:
 - README
 - LICENSE
 - generators/apn_migrations_generator.rb
-- generators/templates/apn_migrations/create_apn_devices.rb
-- generators/templates/apn_migrations/create_apn_notifications.rb
+- generators/templates/apn_migrations/001_create_apn_devices.rb
+- generators/templates/apn_migrations/002_create_apn_notifications.rb
 has_rdoc: true
 homepage: http://www.metabates.com
 licenses: []