jirapong-apn_on_rails 0.4.4

data/lib/apn_on_rails/libs/connection.rb

@@ -0,0 +1,70 @@
+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)
+        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
+      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])
+        cert = options[:cert]
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.key = OpenSSL::PKey::RSA.new(cert, options[:passphrase])
+        ctx.cert = OpenSSL::X509::Certificate.new(cert)
+  
+        sock = TCPSocket.new(options[:host], options[:port])
+        ssl = OpenSSL::SSL::SSLSocket.new(sock, ctx)
+        ssl.sync = true
+        ssl.connect
+  
+        yield ssl, sock if block_given?
+  
+        ssl.close
+        sock.close
+      end
+      
+    end
+    
+  end # Connection
+end # APN

data/lib/apn_on_rails/libs/feedback.rb

@@ -0,0 +1,39 @@
+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(cert, &block)
+        devices = []
+        return if cert.nil? 
+        APN::Connection.open_for_feedback({:cert => cert}) do |conn, sock|          
+          while line = conn.read(38)   # Read 38 bytes from the SSL socket
+            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
+      
+      def process_devices
+        ActiveSupport::Deprecation.warn("The method APN::Feedback.process_devices is deprecated.  Use APN::App.process_devices instead.")
+        APN::App.process_devices
+      end
+      
+    end # class << self
+    
+  end # Feedback
+end # APN

data/lib/apn_on_rails/rails/railtie.rb

@@ -0,0 +1,15 @@
+if defined?(::Rails::Railtie) # backwards compatible
+
+module APN
+  module Rails
+    
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__),'..', 'tasks/*.rake')].each { |f| load f }
+      end
+    end
+    
+  end
+end
+
+end

data/lib/apn_on_rails/tasks/apn.rake

@@ -0,0 +1,30 @@
+namespace :apn do
+  
+  namespace :notifications do
+    
+    desc "Deliver all unsent APN notifications."
+    task :deliver => [:environment] do
+      APN::App.send_notifications
+    end
+
+  end # notifications
+
+  namespace :group_notifications do 
+    
+    desc "Deliver all unsent APN Group notifications."
+    task :deliver => [:environment] do
+      APN::App.send_group_notifications
+    end
+    
+  end # group_notifications
+  
+  namespace :feedback do
+    
+    desc "Process all devices that have feedback from APN."
+    task :process => [:environment] do
+      APN::App.process_devices
+    end
+    
+  end
+  
+end # apn

data/lib/apn_on_rails/tasks/db.rake

@@ -0,0 +1,23 @@
+namespace :apn do
+  
+  namespace :db do
+
+    task :migrate do
+      puts %{
+This task no longer exists. Please generate the migrations like this:
+
+$ ruby script/generate apn_migrations
+
+or
+
+$ rails g apn_on_rails:install
+
+Then just run the migrations like you would normally:
+
+$ rake db:migrate
+      }.strip
+    end
+    
+  end # db
+  
+end # apn

data/lib/apn_on_rails/version.rb

@@ -0,0 +1,3 @@
+module ApnOnRails
+  VERSION = "0.4.4"
+end

data/lib/apn_on_rails_tasks.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'apn_on_rails', 'tasks', '**/*.rake')).each do |f|
+  load File.expand_path(f)
+end

data/lib/generators/apn_on_rails/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates the migrations necessary for APN on Rails
+
+Usage:
+    rails g apn:apn_migrations
+  
+Examples:
+    rails g apn:apn_migrations

data/lib/generators/apn_on_rails/install/install_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+# Generates the migrations necessary for APN on Rails.
+# This should be run upon install and upgrade of the
+# APN on Rails gem.
+#
+#   $ rails generate apn:apn_migrations
+module ApnOnRails
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root(File.expand_path(File.join(File.dirname(__FILE__), 'templates')))
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+      
+      def create_migrations
+        Dir.glob(File.join(self.class.source_root, '*.rb')).sort.each_with_index do |f, i|
+          source = File.basename(f)
+          source.match(/\d+\_(.+)/)
+          destination = "db/migrate/#{$1}"
+          migration_template source, destination
+        end
+      end
+
+    end
+
+  end
+end

data/lib/generators/apn_on_rails/install/templates/001_create_apn_devices.rb

@@ -0,0 +1,13 @@
+class CreateApnDevices < ActiveRecord::Migration # :nodoc:
+  def self.up
+    create_table :apn_devices do |t|
+      t.text :token, :size => 71, :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :apn_devices
+  end
+end

data/lib/generators/apn_on_rails/install/templates/002_create_apn_notifications.rb

@@ -0,0 +1,23 @@
+class CreateApnNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+
+    create_table :apn_notifications do |t|
+      t.integer :device_id, :null => false
+      t.integer :errors_nb, :default => 0 # used for storing errors from apple feedbacks
+      t.string :device_language, :size => 5 # if you don't want to send localized strings
+      t.string :sound
+      t.string :alert, :size => 150
+      t.integer :badge
+      t.datetime :sent_at
+      t.timestamps
+    end
+    
+    add_index :apn_notifications, :device_id
+  end
+
+  def self.down
+    drop_table :apn_notifications
+  end
+  
+end

data/lib/generators/apn_on_rails/install/templates/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/generators/apn_on_rails/install/templates/004_create_apn_apps.rb

@@ -0,0 +1,18 @@
+class CreateApnApps < ActiveRecord::Migration # :nodoc:
+  def self.up
+    create_table :apn_apps do |t|
+      t.text :apn_dev_cert
+      t.text :apn_prod_cert
+
+      t.timestamps
+    end
+
+    add_column :apn_devices, :app_id, :integer
+    
+  end
+
+  def self.down
+    drop_table :apn_apps
+    remove_column :apn_devices, :app_id
+  end
+end

data/lib/generators/apn_on_rails/install/templates/005_create_groups.rb

@@ -0,0 +1,23 @@
+class CreateGroups < ActiveRecord::Migration # :nodoc:
+  def self.up
+    create_table :apn_groups do |t|
+      t.column :name, :string
+    
+      t.timestamps
+    end
+    
+    create_table :apn_devices_apn_groups, :id => false do |t|
+      t.column :group_id, :integer
+      t.column :device_id, :integer
+    end
+    
+    add_index :apn_devices_apn_groups, [:group_id, :device_id]
+    add_index :apn_devices_apn_groups, :device_id
+    add_index :apn_devices_apn_groups, :group_id
+  end 
+  
+  def self.down
+    drop_table :apn_groups
+    drop_table :apn_devices_apn_groups
+  end
+end

data/lib/generators/apn_on_rails/install/templates/006_alter_apn_groups.rb

@@ -0,0 +1,11 @@
+class AlterApnGroups < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+    add_column :apn_groups, :app_id, :integer
+  end
+
+  def self.down
+    remove_column :apn_groups, :app_id
+  end
+  
+end

data/lib/generators/apn_on_rails/install/templates/007_create_device_groups.rb

@@ -0,0 +1,27 @@
+class CreateDeviceGroups < ActiveRecord::Migration # :nodoc:
+  def self.up
+    drop_table :apn_devices_apn_groups
+    
+    create_table :apn_device_groupings do |t|
+      t.column :group_id, :integer
+      t.column :device_id, :integer
+    end
+    
+    add_index :apn_device_groupings, [:group_id, :device_id]
+    add_index :apn_device_groupings, :device_id
+    add_index :apn_device_groupings, :group_id
+  end 
+  
+  def self.down
+    drop_table :apn_device_groupings
+  
+    create_table :apn_devices_apn_groups, :id => false do |t|
+      t.column :group_id, :integer
+      t.column :device_id, :integer
+    end
+    
+    add_index :apn_devices_apn_groups, [:group_id, :device_id]
+    add_index :apn_devices_apn_groups, :device_id
+    add_index :apn_devices_apn_groups, :group_id
+  end
+end

data/lib/generators/apn_on_rails/install/templates/008_create_apn_group_notifications.rb

@@ -0,0 +1,23 @@
+class CreateApnGroupNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+
+    create_table :apn_group_notifications do |t|
+      t.integer :group_id, :null => false
+      t.string :device_language, :size => 5 # if you don't want to send localized strings
+      t.string :sound
+      t.string :alert, :size => 150
+      t.integer :badge
+      t.text :custom_properties
+      t.datetime :sent_at
+      t.timestamps
+    end
+    
+    add_index :apn_group_notifications, :group_id
+  end
+
+  def self.down
+    drop_table :apn_group_notifications
+  end
+  
+end

data/lib/generators/apn_on_rails/install/templates/009_create_pull_notifications.rb

@@ -0,0 +1,16 @@
+class CreatePullNotifications < ActiveRecord::Migration
+  def self.up
+    create_table :apn_pull_notifications do |t|
+      t.integer :app_id
+      t.string  :title
+      t.string  :content
+      t.string  :link
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :apn_pull_notifications
+  end
+end

data/lib/generators/apn_on_rails/install/templates/010_alter_apn_notifications.rb

@@ -0,0 +1,21 @@
+class AlterApnNotifications < ActiveRecord::Migration # :nodoc:
+  
+  module APN # :nodoc:
+    class Notification < ActiveRecord::Base # :nodoc:
+      set_table_name 'apn_notifications'
+    end
+  end
+  
+  def self.up
+    unless APN::Notification.column_names.include?("custom_properties")
+      add_column :apn_notifications, :custom_properties, :text
+    end
+  end
+
+  def self.down
+    if APN::Notification.column_names.include?("custom_properties")
+      remove_column :apn_notifications, :custom_properties
+    end
+  end
+  
+end