apn_on_rails 0.3.1 → 0.4.0

data/Rakefile

@@ -0,0 +1,49 @@
+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 = "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.
+}
+
+  gem.email = "tech-team@prx.org"
+  gem.homepage = "http://github.com/PRX/apn_on_rails"
+  gem.authors = ["markbates", "Rebecca Nesson"]
+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.0

data/apn_on_rails.gemspec

@@ -0,0 +1,110 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apn_on_rails}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["markbates", "Rebecca Nesson"]
+  s.date = %q{2010-10-06}
+  s.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.
+}
+  s.email = %q{tech-team@prx.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README",
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "apn_on_rails.gemspec",
+    "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",
+    "lib/apn_on_rails.rb",
+    "lib/apn_on_rails/apn_on_rails.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_tasks.rb",
+    "spec/active_record/setup_ar.rb",
+    "spec/apn_on_rails/app/models/apn/device_spec.rb",
+    "spec/apn_on_rails/app/models/apn/notification_spec.rb",
+    "spec/apn_on_rails/libs/connection_spec.rb",
+    "spec/apn_on_rails/libs/feedback_spec.rb",
+    "spec/extensions/string.rb",
+    "spec/factories/device_factory.rb",
+    "spec/factories/notification_factory.rb",
+    "spec/fixtures/hexa.bin",
+    "spec/fixtures/message_for_sending.bin",
+    "spec/rails_root/config/apple_push_notification_development.pem",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/PRX/apn_on_rails}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Apple Push Notifications on Rails}
+  s.test_files = [
+    "spec/active_record/setup_ar.rb",
+    "spec/apn_on_rails/app/models/apn/device_spec.rb",
+    "spec/apn_on_rails/app/models/apn/notification_spec.rb",
+    "spec/apn_on_rails/libs/connection_spec.rb",
+    "spec/apn_on_rails/libs/feedback_spec.rb",
+    "spec/extensions/string.rb",
+    "spec/factories/device_factory.rb",
+    "spec/factories/notification_factory.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<configatron>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0.rc.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<actionpack>, ["~> 2.3.8"])
+      s.add_development_dependency(%q<activerecord>, ["~> 2.3.8"])
+    else
+      s.add_dependency(%q<configatron>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0.rc.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<actionpack>, ["~> 2.3.8"])
+      s.add_dependency(%q<activerecord>, ["~> 2.3.8"])
+    end
+  else
+    s.add_dependency(%q<configatron>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0.rc.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<actionpack>, ["~> 2.3.8"])
+    s.add_dependency(%q<activerecord>, ["~> 2.3.8"])
+  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 :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/lib/apn_on_rails/apn_on_rails.rb

@@ -45,10 +45,19 @@ module APN # :nodoc:
       
     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
@@ -57,6 +66,16 @@ end
   path = File.join(File.dirname(__FILE__), 'app', dir)
   $LOAD_PATH << path 
   # puts "Adding #{path}"
-  ActiveSupport::Dependencies.load_paths << path 
-  ActiveSupport::Dependencies.load_once_paths.delete(path) 
-end
+  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,115 @@
+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
+    unless self.unsent_notifications.nil? || self.unsent_notifications.empty?
+      APN::Connection.open_for_delivery({:cert => self.cert}) do |conn, sock|
+        unsent_notifications.each do |noty|
+          conn.write(noty.message_for_sending)
+          noty.sent_at = Time.now
+          noty.save
+        end
+      end
+    end
+  end
+  
+  def self.send_notifications
+    apps = APN::App.all 
+    apps.each do |app|
+      app.send_notifications
+    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|
+          puts "number of devices is #{gnoty.devices.size}"
+          gnoty.devices.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.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::Feedback.devices(self.cert).each do |device|
+      if device.last_registered_at < device.feedback_at
+        device.destroy
+      end
+    end
+  end # process_devices
+  
+  def self.process_devices
+    apps = APN::App.all
+    apps.each do |app|
+      app.process_devices
+    end
+  end
+    
+end