presskit-apn_on_rails 0.1

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,50 @@
+# 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'
+  belongs_to :user
+  
+  validates_uniqueness_of :token, :scope => :artist_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

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

@@ -0,0 +1,28 @@
+class APN::PullNotification < APN::Base
+  belongs_to :app, :class_name => 'APN::App'
+  
+  validates_presence_of :app_id
+
+  def self.latest_since(app_id, since_date=nil)
+    if since_date
+      res = first(:order => "created_at DESC", 
+                  :conditions => ["app_id = ? AND created_at > ? AND launch_notification = ?", app_id, since_date, false])
+    else
+      res = first(:order => "created_at DESC", 
+                  :conditions => ["app_id = ? AND launch_notification = ?", app_id, true])
+      res = first(:order => "created_at DESC", 
+                  :conditions => ["app_id = ? AND launch_notification = ?", app_id, false]) unless res
+    end
+    res
+  end
+  
+  def self.all_since(app_id, since_date=nil)
+    if since_date
+      res = all(:order => "created_at DESC", 
+                :conditions => ["app_id = ? AND created_at > ? AND launch_notification = ?", app_id, since_date, false])
+    else 
+      res = all(:order => "created_at DESC", 
+                :conditions => ["app_id = ? AND launch_notification = ?", app_id, false])
+    end
+  end
+end

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?
+      ensure
+        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/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,19 @@
+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
+
+Then just run the migrations like you would normally:
+
+$ rake db:migrate
+      }.strip
+    end
+    
+  end # db
+  
+end # apn