presskit-apn_on_rails 0.1

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fireinc-apn_on_rails"
+  gem.summary = %Q{Apple Push Notifications on Rails}
+  
+  gem.description = %Q{APN on Rails is a Ruby on Rails gem that allows you to
+easily add Apple Push Notification (iPhone) support to your Rails application.
+This version includes an association between an assumed User model and APN::Device
+}
+
+  gem.email = "caleb@fire.coop"
+  gem.homepage = "http://github.com/calebhaye/apn_on_rails"
+  gem.authors = ["markbates", "Rebecca Nesson", "Caleb Adam Haye"]
+end
+#Jeweler::RubygemsDotOrgsTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.2.5

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/generators/apn_migrations_generator.rb

@@ -0,0 +1,31 @@
+require 'rails_generator'
+# 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:
+    record do |m|
+      timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      db_migrate_path = File.join('db', 'migrate')
+      
+      m.directory(db_migrate_path)
+      
+      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, "*_#{$1}")).empty?
+          m.file(File.join('apn_migrations', f), 
+                 File.join(db_migrate_path, "#{timestamp}_#{$1}"), 
+                 {:collision => :skip})
+        end
+      end
+      
+    end # record
+    
+  end # manifest
+  
+end # ApnMigrationsGenerator

data/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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/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/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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/generators/templates/apn_migrations/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

data/generators/templates/apn_migrations/011_make_device_token_index_nonunique.rb

@@ -0,0 +1,11 @@
+class MakeDeviceTokenIndexNonunique < ActiveRecord::Migration
+  def self.up
+    remove_index :apn_devices, :column => :token
+    add_index :apn_devices, :token
+  end
+
+  def self.down
+    remove_index :apn_devices, :column => :token
+    add_index :apn_devices, :token, :unique => true
+  end
+end

data/generators/templates/apn_migrations/012_add_launch_notification_to_apn_pull_notifications.rb

@@ -0,0 +1,9 @@
+class AddLaunchNotificationToApnPullNotifications < ActiveRecord::Migration
+  def self.up
+    add_column :apn_pull_notifications, :launch_notification, :boolean
+  end
+
+  def self.down
+    remove_column :apn_pull_notifications, :launch_notification
+  end
+end

data/lib/apn_on_rails.rb

@@ -0,0 +1,4 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'apn_on_rails', '**/*.rb')).sort.each do |f|
+  require File.expand_path(f)
+end
+

data/lib/apn_on_rails/apn_on_rails.rb

@@ -0,0 +1,81 @@
+require 'socket'
+require 'openssl'
+require 'configatron'
+
+rails_root = File.join(FileUtils.pwd, 'rails_root')
+if defined?(RAILS_ROOT)
+  rails_root = RAILS_ROOT
+end
+
+rails_env = 'development'
+if defined?(RAILS_ENV)
+  rails_env = RAILS_ENV
+end
+
+configatron.apn.set_default(:passphrase, '')
+configatron.apn.set_default(:port, 2195)
+
+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:
+  
+  module Errors # :nodoc:
+    
+    # Raised when a notification message to Apple is longer than 256 bytes.
+    class ExceededMessageSizeError < StandardError
+      
+      def initialize(message) # :nodoc:
+        super("The maximum size allowed for a notification payload is 256 bytes: '#{message}'")
+      end
+      
+    end
+    
+    class MissingCertificateError < StandardError
+      def initialize
+        super("This app has no certificate")
+      end
+    end
+    
+  end # Errors
+  
+end # APN
+
+base = File.join(File.dirname(__FILE__), 'app', 'models', 'apn', 'base.rb')
+require base
+
+Dir.glob(File.join(File.dirname(__FILE__), 'app', 'models', 'apn', '*.rb')).sort.each do |f|
+  require f
+end
+
+%w{ models controllers helpers }.each do |dir| 
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path 
+  # puts "Adding #{path}"
+  begin
+    if ActiveSupport::Dependencies.respond_to? :autoload_paths
+      ActiveSupport::Dependencies.autoload_paths << path
+      ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+    else
+      ActiveSupport::Dependencies.load_paths << path 
+      ActiveSupport::Dependencies.load_once_paths.delete(path) 
+    end
+  rescue NameError
+    Dependencies.load_paths << path 
+    Dependencies.load_once_paths.delete(path) 
+  end
+end

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

@@ -0,0 +1,152 @@
+class APN::App < APN::Base
+  
+  has_many :groups, :class_name => 'APN::Group', :dependent => :destroy
+  has_many :devices, :class_name => 'APN::Device', :dependent => :destroy
+  has_many :notifications, :through => :devices, :dependent => :destroy
+  has_many :unsent_notifications, :through => :devices
+  has_many :group_notifications, :through => :groups
+  has_many :unsent_group_notifications, :through => :groups
+    
+  def cert
+    (RAILS_ENV == 'production' ? apn_prod_cert : apn_dev_cert)
+  end
+  
+  # Opens a connection to the Apple APN server and attempts to batch deliver
+  # an Array of group notifications.
+  # 
+  # 
+  # As each APN::GroupNotification is sent the <tt>sent_at</tt> column will be timestamped,
+  # so as to not be sent again.
+  # 
+  def send_notifications
+    if self.cert.nil?
+      raise APN::Errors::MissingCertificateError.new
+      return
+    end
+    APN::App.send_notifications_for_cert(self.cert, self.id)
+  end
+  
+  def self.send_notifications
+    apps = APN::App.all 
+    apps.each do |app|
+      app.send_notifications
+    end
+    if !configatron.apn.cert.blank?
+      global_cert = File.read(configatron.apn.cert)
+      send_notifications_for_cert(global_cert, nil)
+    end
+  end
+  
+  def self.send_notifications_for_cert(the_cert, app_id)
+    # unless self.unsent_notifications.nil? || self.unsent_notifications.empty?
+      if (app_id == nil)
+        conditions = "app_id is null"
+      else 
+        conditions = ["app_id = ?", app_id]
+      end
+      begin
+        APN::Device.find_each(:conditions => conditions) do |dev|
+          APN::Connection.open_for_delivery({:cert => the_cert}) do |conn, sock|
+            dev.unsent_notifications.each do |noty|
+              conn.write(noty.message_for_sending)
+              noty.sent_at = Time.now
+              noty.save
+            end
+          end
+          sleep(1)
+        end
+      rescue Exception => e
+        log_connection_exception(e)
+      end
+    # end   
+  end
+  
+  def send_group_notifications
+    if self.cert.nil? 
+      raise APN::Errors::MissingCertificateError.new
+      return
+    end
+    unless self.unsent_group_notifications.nil? || self.unsent_group_notifications.empty? 
+      APN::Connection.open_for_delivery({:cert => self.cert}) do |conn, sock|
+        unsent_group_notifications.each do |gnoty|
+          gnoty.devices.find_each do |device|
+            conn.write(gnoty.message_for_sending(device))
+          end
+          gnoty.sent_at = Time.now
+          gnoty.save
+        end
+      end
+    end
+  end
+  
+  def send_group_notification(gnoty)
+    if self.cert.nil? 
+      raise APN::Errors::MissingCertificateError.new
+      return
+    end
+    unless gnoty.nil?
+      APN::Connection.open_for_delivery({:cert => self.cert}) do |conn, sock|
+        gnoty.devices.find_each do |device|
+          conn.write(gnoty.message_for_sending(device))
+        end
+        gnoty.sent_at = Time.now
+        gnoty.save
+      end
+    end
+  end
+  
+  def self.send_group_notifications
+    apps = APN::App.all
+    apps.each do |app|
+      app.send_group_notifications
+    end
+  end          
+  
+  # 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
+    if self.cert.nil?
+      raise APN::Errors::MissingCertificateError.new
+      return
+    end
+    APN::App.process_devices_for_cert(self.cert)
+  end # process_devices
+  
+  def self.process_devices
+    apps = APN::App.all
+    apps.each do |app|
+      app.process_devices
+    end
+    if !configatron.apn.cert.blank?
+      global_cert = File.read(configatron.apn.cert)
+      APN::App.process_devices_for_cert(global_cert)
+    end
+  end
+  
+  def self.process_devices_for_cert(the_cert)
+    puts "in APN::App.process_devices_for_cert"
+    APN::Feedback.devices(the_cert).each do |device|
+      if device.last_registered_at < device.feedback_at
+        puts "device #{device.id} -> #{device.last_registered_at} < #{device.feedback_at}"
+        device.destroy
+      else 
+        puts "device #{device.id} -> #{device.last_registered_at} not < #{device.feedback_at}"
+      end
+    end 
+  end
+  
+  
+  protected
+  def self.log_connection_exception(ex)
+    puts ex.message
+  end
+    
+end