gwong-apn_on_rails 0.4.2

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,150 @@
+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 and sent_at is null"
+      else 
+        conditions = ["app_id = ? and sent_at is null", app_id]
+      end
+      begin
+        APN::Connection.open_for_delivery({:cert => the_cert}) do |conn, sock|
+          notifications = APN::Notification.find(:all, :select => "apn_notifications.*", :conditions => conditions, :joins => " INNER JOIN apn_devices ON apn_devices.id = apn_notifications.device_id")
+          notifications.each do |noty|
+            conn.write(noty.message_for_sending)
+            noty.sent_at = Time.now
+            noty.save
+          end
+        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 log_connection_exception(ex)
+    puts ex.message
+  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

@@ -0,0 +1,49 @@
+# 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 < APN::Base
+  
+  belongs_to :app, :class_name => 'APN::App'
+  has_many :notifications, :class_name => 'APN::Notification'
+  has_many :unsent_notifications, :class_name => 'APN::Notification', :conditions => 'sent_at is null'
+  
+  validates_uniqueness_of :token, :scope => :app_id
+  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_create :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:
+  #  '<5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz>'
+  # Then the '<' and '>' will be stripped off.
+  def token=(token)
+    res = token.scan(/\<(.+)\>/).first
+    unless res.nil? || res.empty?
+      token = res.first
+    end
+    write_attribute('token', token)
+  end
+  
+  # Returns the hexadecimal representation of the device's token.
+  def to_hexa
+    [self.token.delete(' ')].pack('H*')
+  end
+  
+  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/device_grouping.rb

@@ -0,0 +1,16 @@
+class APN::DeviceGrouping < APN::Base
+  
+  belongs_to :group, :class_name => 'APN::Group'
+  belongs_to :device, :class_name => 'APN::Device'
+  
+  validates_presence_of :device_id, :group_id
+  validate :same_app_id
+  validates_uniqueness_of :device_id, :scope => :group_id
+  
+  def same_app_id
+    unless self.group and self.device and self.group.app_id == self.device.app_id
+       errors.add_to_base("device and group must belong to the same app")
+    end
+  end
+  
+end

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

@@ -0,0 +1,12 @@
+class APN::Group < APN::Base
+  
+  belongs_to :app, :class_name => 'APN::App'
+  has_many   :device_groupings, :class_name => "APN::DeviceGrouping", :dependent => :destroy
+  has_many   :devices, :class_name => 'APN::Device', :through => :device_groupings
+  has_many   :group_notifications, :class_name => 'APN::GroupNotification'
+  has_many   :unsent_group_notifications, :class_name => 'APN::GroupNotification', :conditions => 'sent_at is null'
+  
+  validates_presence_of :app_id
+  validates_uniqueness_of :name, :scope => :app_id
+    
+end

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

@@ -0,0 +1,79 @@
+class APN::GroupNotification < APN::Base
+  include ::ActionView::Helpers::TextHelper
+  extend ::ActionView::Helpers::TextHelper
+  serialize :custom_properties
+  
+  belongs_to :group, :class_name => 'APN::Group'
+  has_one    :app, :class_name => 'APN::App', :through => :group
+  has_many   :device_groupings, :through => :group
+  
+  validates_presence_of :group_id
+  
+  def devices
+    self.group.devices
+  end
+  
+  # Stores the text alert message you want to send to the device.
+  # 
+  # If the message is over 150 characters long it will get truncated
+  # to 150 characters with a <tt>...</tt>
+  def alert=(message)
+    if !message.blank? && message.size > 150
+      message = truncate(message, :length => 150)
+    end
+    write_attribute('alert', message)
+  end
+  
+  # Creates a Hash that will be the payload of an APN.
+  # 
+  # Example:
+  #   apn = APN::GroupNotification.new
+  #   apn.badge = 5
+  #   apn.sound = 'my_sound.aiff'
+  #   apn.alert = 'Hello!'
+  #   apn.apple_hash # => {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"}}
+  #
+  # Example 2: 
+  #   apn = APN::GroupNotification.new
+  #   apn.badge = 0
+  #   apn.sound = true
+  #   apn.custom_properties = {"typ" => 1}
+  #   apn.apple_hash # => {"aps" => {"badge" => 0, "sound" => 1.aiff},"typ" => "1"}
+  def apple_hash
+    result = {}
+    result['aps'] = {}
+    result['aps']['alert'] = self.alert if self.alert
+    result['aps']['badge'] = self.badge.to_i if self.badge
+    if self.sound
+      result['aps']['sound'] = self.sound if self.sound.is_a? String
+      result['aps']['sound'] = "1.aiff" if self.sound.is_a?(TrueClass)
+    end
+    if self.custom_properties
+      self.custom_properties.each do |key,value|
+        result["#{key}"] = "#{value}"
+      end
+    end
+    result
+  end
+  
+  # Creates the JSON string required for an APN message.
+  # 
+  # Example:
+  #   apn = APN::Notification.new
+  #   apn.badge = 5
+  #   apn.sound = 'my_sound.aiff'
+  #   apn.alert = 'Hello!'
+  #   apn.to_apple_json # => '{"aps":{"badge":5,"sound":"my_sound.aiff","alert":"Hello!"}}'
+  def to_apple_json
+    self.apple_hash.to_json
+  end
+  
+  # Creates the binary message needed to send to Apple.
+  def message_for_sending(device)
+    json = self.to_apple_json
+    message = "\0\0 #{device.to_hexa}\0#{json.length.chr}#{json}"
+    raise APN::Errors::ExceededMessageSizeError.new(message) if message.size.to_i > 256
+    message
+  end
+  
+end # APN::Notification

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

@@ -0,0 +1,93 @@
+# Represents the message you wish to send. 
+# An APN::Notification belongs to an APN::Device.
+# 
+# Example:
+#   apn = APN::Notification.new
+#   apn.badge = 5
+#   apn.sound = 'my_sound.aiff'
+#   apn.alert = 'Hello!'
+#   apn.device = APN::Device.find(1)
+#   apn.save
+# 
+# To deliver call the following method:
+#   APN::Notification.send_notifications
+# 
+# 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 < APN::Base
+  include ::ActionView::Helpers::TextHelper
+  extend ::ActionView::Helpers::TextHelper
+  serialize :custom_properties
+  
+  belongs_to :device, :class_name => 'APN::Device'
+  has_one    :app,    :class_name => 'APN::App', :through => :device
+  
+  # Stores the text alert message you want to send to the device.
+  # 
+  # If the message is over 150 characters long it will get truncated
+  # to 150 characters with a <tt>...</tt>
+  def alert=(message)
+    if !message.blank? && message.size > 150
+      message = truncate(message, :length => 150)
+    end
+    write_attribute('alert', message)
+  end
+  
+  # Creates a Hash that will be the payload of an APN.
+  # 
+  # Example:
+  #   apn = APN::Notification.new
+  #   apn.badge = 5
+  #   apn.sound = 'my_sound.aiff'
+  #   apn.alert = 'Hello!'
+  #   apn.apple_hash # => {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"}}
+  #
+  # Example 2: 
+  #   apn = APN::Notification.new
+  #   apn.badge = 0
+  #   apn.sound = true
+  #   apn.custom_properties = {"typ" => 1}
+  #   apn.apple_hash # => {"aps" => {"badge" => 0, "sound" => "1.aiff"}, "typ" => "1"}
+  def apple_hash
+    result = {}
+    result['aps'] = {}
+    result['aps']['alert'] = self.alert if self.alert
+    result['aps']['badge'] = self.badge.to_i if self.badge
+    if self.sound
+      result['aps']['sound'] = self.sound if self.sound.is_a? String
+      result['aps']['sound'] = "1.aiff" if self.sound.is_a?(TrueClass)
+    end
+    if self.custom_properties
+      self.custom_properties.each do |key,value|
+        result["#{key}"] = "#{value}"
+      end
+    end
+    result
+  end
+  
+  # Creates the JSON string required for an APN message.
+  # 
+  # Example:
+  #   apn = APN::Notification.new
+  #   apn.badge = 5
+  #   apn.sound = 'my_sound.aiff'
+  #   apn.alert = 'Hello!'
+  #   apn.to_apple_json # => '{"aps":{"badge":5,"sound":"my_sound.aiff","alert":"Hello!"}}'
+  def to_apple_json
+    self.apple_hash.to_json
+  end
+  
+  # Creates the binary message needed to send to Apple.
+  def message_for_sending
+    json = self.to_apple_json
+    message = "\0\0 #{self.device.to_hexa}\0#{json.length.chr}#{json}"
+    raise APN::Errors::ExceededMessageSizeError.new(message) if message.size.to_i > 256
+    message
+  end
+  
+  def self.send_notifications
+    ActiveSupport::Deprecation.warn("The method APN::Notification.send_notifications is deprecated.  Use APN::App.send_notifications instead.")
+    APN::App.send_notifications
+  end
+  
+end # APN::Notification