urbanairship_on_rails 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'aasm'
+gem 'json'

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aasm (2.2.0)
+    json (1.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aasm
+  json

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,188 @@
+===================
+URBAN AIRSHIP ON RAILS
+===================
+
+Borrowed Liberally from APN on Rails Gem but designed to interface with urbanairship for simplicity, ease of use, and speedy deployment of push notifications
+uses identical data schema to APN.. perhaps allowing future upgrade to APN
+
+=======
+DEPENDENCIES
+=======
+requires JSON gem
+AASM
+
+Note: If you use the aasm gem, you may need to install the gem before you 'config.gem "aasm"' in your environment.rb or include it in your Gemfile.
+
+=======
+HOW TO INSTALL
+=======
+ruby script/plugin install git://github.com/yonnage/urbanairship_on_rails
+
+=======
+HOW TO GENERATE MIGRATIONS
+=======
+ruby script/generate apn_migrations
+rake db:migrate
+
+=======
+HOW TO CONFIGURE
+=======
+
+  =====
+  Create an initializer named urbanairship.rb with the following content
+  require File.dirname(__FILE__) + '/../../vendor/plugins/urbanairship_on_rails/lib/urbanairship_on_rails/libs/config'
+  UA::Config::app_key      = 'YOUR_APP_KEY'
+  UA::Config::app_secret   = 'YOUR_APP_SECRET'
+  UA::Config::push_secret  = 'YOUR_PUSH_SECRET'  ### CURRENTLY KNOWN AS "Application Master Secret" on Urban Airship
+  UA::Config::push_host    = 'go.urbanairship.com'
+  UA::Config::push_port    = '443'
+
+  =====
+  Set up a daily cron job to set inactive devices to "inactive"
+    rake apn:feedback or
+    script/runner APN:Feedback.create().run
+
+  Set up a cron job to push and manage notifications
+    rake apn:push or
+    script/runner APN::Notification.process_pending
+
+  Set up a cron job to push and manage broadcast notifications
+    rake apn:broadcast_push or
+    script/runner APN::BroadcastNotification.process_pending
+
+
+=== Examples of Use
+
+  == Create and register a device:
+    
+    # Create device:
+    ## Requires a unique token. Token format should be: 5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz
+    
+    device = APN::Device.find_or_create_by_token(:token => token)
+
+
+    #Register the device with Urban Airship
+    
+    device.register
+
+    # Your device is now registered and ready to receive notifications.
+
+
+    # Your mobile application should try to register itself each time the application is launched, which is why it's important
+    # to do "find_or_create_by_token"
+  
+  
+  == Create and send a single simple Notification:
+    
+    # Basic Options for Notifications:
+    # alert - The message the device will receive.
+    # badge - The number of badges (red circle with number) on the device.
+    # sound - This is the sound heard on the device.  "default" is the standard device notification sound.
+    # device - The device to send the notification to.
+    
+    n = APN::Notification.create(:alert => "Hello, World", :badge => 1, :sound => "default", :device => device)
+    
+    # Now send the notification to the device:
+
+    n.push
+  
+
+  == Create and send a single Notification with more options:
+  
+    # Adding more options to a notification.
+    # sound - You can also use specific sounds for the alert which are already included as part of the mobile app.
+    # badge - Urban Airship supports auto increment / decrement of badges.  Pass "+1" or "-1".
+    # custom_properties - Extra information you need to pass to the device.
+    
+    n = APN::Notification.create(:alert => "Hello, World", :badge => "+1", :device => device, :sound => "alert1.wav", :custom_properties => {:name => "Bobby", :person_id => 7})
+
+
+    # Now send the notification to the device
+
+    n.push
+    
+
+  == Send all pending notifications:
+    
+    # Instead of sending each notification as it is created, you can send them all at once.
+        
+    APN::Notification.process_pending
+    
+
+    # Or setup a cron rake task:
+    
+    rake apn:push
+    
+    
+  == Broadcast Notifications
+  
+    # Send the same notification to all devices.
+    # Use this to avoid making multiple connections if you are sending the same message to all devices.
+  
+    APN::BroadcastNotification.create(:alert => "Hello, World", :badge => 1, :sound => "default")
+
+
+    # Push the BroadcastNotification
+
+    APN::BroadcastNotification.process_pending
+  
+
+    == Broadcast Notifications with Device exclusions.
+  
+    # You can exclude devices from receiving a broadcast notification.
+  
+    n = APN::BroadcastNotification.create(:alert => "Hello, World", :badge => 1, :sound => "default")
+  
+  
+    # Exclude any devices that should not receive the above notification.
+  
+    n.excluded_devices.create(:broadcast_notification => n, :device => APN::Device.find(1))
+    n.excluded_devices.create(:broadcast_notification => n, :device => APN::Device.find(2))
+    n.excluded_devices.create(:broadcast_notification => n, :device => APN::Device.find(3))
+
+
+    # Push the Broadcast Notification:
+    
+    n.push
+    
+    # -- OR -- Push all pending Broadcast Notifications:
+    
+    APN::BroadcastNotification.process_pending
+    
+
+  == Feedback for Devices
+  
+    # When a device no longer accepts notifications from your application because of reasons such as the application being removed,
+    # Urban Airship will stop trying to send notifications to those devices.  You should run the "feedback" task daily to find and
+    # mark all inactive devices as such.
+    
+    rake apn:feedback
+
+
+=======
+API CALLS and current support level
+=======
+
+REGISTRATION
+  
+  APN::Device.register              => HTTP PUT to /api/device_tokens/<device_token>
+  APN::Device.read                  => HTTP GET to /api/device_tokens/<device_token>
+  APN::Device.unregister            => HTTP DELETE to /api/device_tokens/<device_token>
+
+PUSH
+  APN::Notifcation.push             => HTTP POST to /api/push/
+
+BATCH PUSH
+  NOT YET SUPPORTED
+
+BROADCAST
+  APN::BroadcastNotifcation.push    => HTTP POST to /api/push/broadcast/
+
+FEEDBACK SERVICE
+  APN::Feedback.create().run        => HTTP GET to /api/device_tokens/feedback/?since=<timestamp> 
+
+STATISTICS
+  NOT YET SUPPORTED
+
+
+Copyright (c) 2009 [Russell Sherman(code-ronin@code-ronin.com)], released under the MIT license

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the urban_airship_on_rails plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the urban_airship_on_rails plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UrbanAirshipOnRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/apn_migrations/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/apn_migrations/templates/apn_migrations/001_create_apn_devices.rb

@@ -0,0 +1,15 @@
+class CreateApnDevices < ActiveRecord::Migration # :nodoc:
+  def self.up
+    create_table :apn_devices do |t|
+      t.string :token, :size => 100, :null => false
+      t.datetime :last_registered_at
+      t.timestamps
+    end
+    add_index :apn_devices, :token, :unique => true
+  end
+
+  def self.down
+    remove_index :apn_devices, :column => :token
+    drop_table :apn_devices
+  end
+end

data/generators/apn_migrations/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.string :state
+      t.timestamps
+    end
+    add_index :apn_notifications, :device_id
+  end
+
+  def self.down
+    remove_index :apn_notifications, :device_id
+    drop_table :apn_notifications
+  end
+  
+end

data/generators/apn_migrations/templates/apn_migrations/003_create_apn_feedbacks.rb

@@ -0,0 +1,17 @@
+class CreateApnFeedbacks < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+    create_table :apn_feedbacks do |t|
+      t.string :code
+      t.string :message
+      t.text :body
+      t.string :state
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :apn_feedbacks
+  end
+  
+end

data/generators/apn_migrations/templates/apn_migrations/004_create_apn_broadcast_notifications.rb

@@ -0,0 +1,20 @@
+class CreateApnBroadcastNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+    create_table :apn_broadcast_notifications do |t|
+      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.string :badge
+      t.datetime :sent_at
+      t.string :state
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :apn_broadcast_notifications
+  end
+  
+end

data/generators/apn_migrations/templates/apn_migrations/005_change_badge_to_string_on_notifications.rb

@@ -0,0 +1,11 @@
+class ChangeBadgeToStringOnNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+      change_column :apn_notifications, :badge, :string
+  end
+
+  def self.down
+      change_column :apn_notifications, :badge, :integer
+  end
+  
+end

data/generators/apn_migrations/templates/apn_migrations/006_rename_errors_nb_to_last_error_code_on_notifications.rb

@@ -0,0 +1,11 @@
+class RenameErrorsNbToLastErrorCodeOnNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+      rename_column :apn_notifications, :errors_nb, :last_response_code
+  end
+
+  def self.down
+      rename_column :apn_notifications, :last_response_code, :errors_nb
+  end
+  
+end

data/generators/apn_migrations/templates/apn_migrations/007_rename_errors_nb_to_last_error_code_on_broadcast_notifications.rb

@@ -0,0 +1,11 @@
+class RenameErrorsNbToLastErrorCodeOnBroadcastNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+      rename_column :apn_broadcast_notifications, :errors_nb, :last_response_code
+  end
+
+  def self.down
+      rename_column :apn_broadcast_notifications, :last_response_code, :errors_nb
+  end
+  
+end

data/generators/apn_migrations/templates/apn_migrations/008_add_custom_properties_on_notifications.rb

@@ -0,0 +1,9 @@
+class AddCustomPropertiesOnNotifications < ActiveRecord::Migration # :nodoc:
+  def self.up
+    add_column :apn_notifications, :custom_properties, :text, :after => :badge
+  end
+
+  def self.down
+    remove_column :apn_notifications, :custom_properties
+  end
+end

data/generators/apn_migrations/templates/apn_migrations/009_add_custom_properties_on_broadcast_notifications.rb

@@ -0,0 +1,9 @@
+class AddCustomPropertiesOnBroadcastNotifications < ActiveRecord::Migration # :nodoc:
+  def self.up
+    add_column :apn_broadcast_notifications, :custom_properties, :text, :after => :badge
+  end
+
+  def self.down
+    remove_column :apn_broadcast_notifications, :custom_properties
+  end
+end

data/generators/apn_migrations/templates/apn_migrations/010_create_apn_excluded_devices_for_notifications.rb

@@ -0,0 +1,17 @@
+class CreateApnExcludedDevicesForNotifications < ActiveRecord::Migration # :nodoc:
+  def self.up
+    create_table :apn_excluded_devices_for_notifications do |t|
+      t.integer :device_id
+      t.integer :notification_id
+      t.integer :broadcast_notification_id
+      t.timestamps
+    end
+    add_index(:apn_excluded_devices_for_notifications, [:device_id, :notification_id], :unique => true, :name => 'by_device_notfication')
+    add_index(:apn_excluded_devices_for_notifications, [:device_id, :broadcast_notification_id], :unique => true, :name => 'by_device_broadcast_notfication')
+  end
+
+  def self.down
+    remove_index :apn_excluded_devices_for_notifications, :device_id
+    drop_table :apn_excluded_devices_for_notifications
+  end
+end

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

@@ -0,0 +1,15 @@
+class AddLastInactiveAtToDevices < ActiveRecord::Migration # :nodoc:
+  def self.up
+    add_column :apn_devices, :state, :string, :default => 'created', :after => :token
+    add_column :apn_devices, :response_code, :string, :after => :state
+    add_column :apn_devices, :response_message, :string, :after => :response_code
+    add_column :apn_devices, :response_body, :text, :after => :response_message
+  end
+
+  def self.down
+    remove_column :apn_devices, :state
+    remove_column :apn_devices, :response_code
+    remove_column :apn_devices, :response_message
+    remove_column :apn_devices, :response_body
+  end
+end

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

@@ -0,0 +1,9 @@
+class AddLastInactiveAtToDevices < ActiveRecord::Migration # :nodoc:
+  def self.up
+    add_column :apn_devices, :last_inactive_at, :datetime, :after => :last_registered_at
+  end
+
+  def self.down
+    remove_column :apn_devices, :last_inactive_at
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.dirname(__FILE__) + '/lib/urbanairship_on_rails'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/urbanairship_on_rails.rb

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

data/lib/urbanairship_on_rails/libs/config.rb

@@ -0,0 +1,29 @@
+module UA
+  
+  module Config
+    
+    @@app_key = 'YOUR_APP_KEY'
+    @@app_secret = 'YOUR_APP_SECRET'
+    @@push_secret = 'YOUR_PUSH_SECRET'
+    @@push_host = 'go.urbanairship.com'
+    @@push_port = 443
+
+    [:app_key, :app_secret, :push_secret, :push_host, :push_port].each do |sym|
+      class_eval <<-EOS, __FILE__, __LINE__
+        def self.#{sym}
+          if defined?(#{sym.to_s.upcase})
+            #{sym.to_s.upcase}
+          else
+            @@#{sym}
+          end
+        end
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+     EOS
+
+    end
+    
+  end # Config
+   
+end # UA

data/lib/urbanairship_on_rails/models/apn/base.rb

@@ -0,0 +1,124 @@
+require 'net/http'
+require 'net/https'
+
+module APN
+
+  class ConnectionError < StandardError
+  end
+  
+  class RetriableConnectionError < ConnectionError
+  end
+
+  class Base < ActiveRecord::Base # :nodoc:
+
+    MAX_RETRIES = 3
+    OPEN_TIMEOUT = 60
+    READ_TIMEOUT = 60
+    
+    def self.table_name # :nodoc:
+      self.to_s.gsub("::", "_").tableize
+    end
+        
+    def http_get(url, data=nil, headers={}, push=false)
+      puts "APN::Base.http_get"
+      http_request(:get, url, data, headers, push)
+    end
+    
+    def http_post(url, data=nil, headers={}, push=false)
+      puts "APN::Base.http_post"
+      http_request(:post, url, data, headers, push)
+    end
+    
+    def http_put(url, data=nil, headers={}, push=false)
+      puts "APN::Base.http_put"
+      http_request(:put, url, data, headers, push)
+    end
+    
+    def http_delete(url, data=nil, headers={}, push=false)
+      puts "APN::Base.http_delete"
+      http_request(:delete, url, data, headers, push)
+    end
+
+    private
+
+    def self.open_timeout
+      OPEN_TIMEOUT
+    end
+    
+    def self.read_timeout
+      READ_TIMEOUT
+    end
+    
+    def retry_exceptions
+      retries = MAX_RETRIES
+      begin
+        yield
+      rescue RetriableConnectionError => e
+        puts e
+        retries -= 1
+        retry unless retries.zero?
+        raise ConnectionError, e.message
+      rescue ConnectionError
+        puts e
+        retries -= 1
+        retry if retry_safe && !retries.zero?
+        raise
+      end
+    end
+
+    def http_request(method, url, data=nil, headers={}, push=false)
+      headers['Content-Type'] = 'application/json'
+
+      puts "APN::Base.http_request(#{method.inspect}, #{url.inspect}, #{data.inspect}, #{push.inspect})"
+
+      case method
+      when :get
+        req = Net::HTTP::Get.new(url, headers)
+      when :put
+        req = Net::HTTP::Put.new(url, headers)
+      when :post
+        req = Net::HTTP::Post.new(url, headers)
+      when :delete
+        req = Net::HTTP::Delete.new(url, headers)
+      end
+      
+      if push
+        req.basic_auth(UA::Config::app_key, UA::Config::push_secret)
+      else
+        req.basic_auth(UA::Config::app_key, UA::Config::app_secret)
+      end
+      
+      puts "auth #{UA::Config::app_key}:#{UA::Config::app_secret}"
+
+      if data
+        req.body = data.to_json
+      else
+        req.body = "{}"
+      end
+      puts "body #{req.body}"
+      
+      puts "#{UA::Config::push_host}:#{UA::Config::push_port}"
+      http = Net::HTTP.new(UA::Config::push_host, UA::Config::push_port)
+      http.use_ssl = true
+
+      http.start {|it|
+        retry_exceptions do 
+          begin
+            response = it.request(req)
+            puts "\nResponse #{response.code} #{response.message}:#{response.body}"
+            response
+          rescue EOFError => e
+            raise ConnectionError, "The remote server dropped the connection"
+          rescue Errno::ECONNRESET => e
+            raise ConnectionError, "The remote server reset the connection"
+          rescue Errno::ECONNREFUSED => e
+            raise RetriableConnectionError, "The remote server refused the connection"
+          rescue Timeout::Error, Errno::ETIMEDOUT => e
+            raise ConnectionError, "The connection to the remote server timed out"
+          end
+        end
+      }
+    end
+
+  end
+end

data/lib/urbanairship_on_rails/models/apn/broadcast_notification.rb

@@ -0,0 +1,95 @@
+# Represents the message you wish to send. 
+# An APN::Notification belongs to an APN::Device.
+# 
+# Example:
+#   apn = APN::BroadcastNotification.new
+#   apn.badge = 5
+#   apn.sound = 'my_sound.aiff'
+#   apn.alert = 'Hello!'
+#   apn.custom_properties = {:email_id => "6", :link => "http://google.com"}
+#   apn.save
+# 
+# To deliver call the following method:
+#   APN::BroadcastNotification.process_pending
+# 
+# As each APN::BroadcastNotification is sent the <tt>sent_at</tt> column will be timestamped,
+# so as to not be sent again.
+class APN::BroadcastNotification < APN::Base
+  include AASM
+  include ::ActionView::Helpers::TextHelper
+  extend ::ActionView::Helpers::TextHelper
+  
+  has_many :excluded_devices, :class_name => 'APN::ExcludedDevicesForNotification'
+  
+  serialize :custom_properties
+    
+  #
+  # MODEL STATE MACHINE
+  #
+  aasm_initial_state :pending
+  aasm_column :state
+  
+  aasm_state :pending
+  aasm_state :processed, :enter => :update_sent_at
+
+  aasm_event :process do
+    transitions :from => :pending, :to => :processed, :guard => :check_response
+  end
+  
+  def apple_hash
+    result = {}
+    result['aps'] = {}
+    result['aps']['alert'] = self.alert if self.alert
+    result['aps']['badge'] = convert(self.badge) if self.badge
+    if self.sound
+      result['aps']['sound'] = self.sound if self.sound
+    end
+    if self.custom_properties
+      self.custom_properties.each do |key,value|
+        result["#{key}"] = "#{value}"
+      end
+    end
+    
+    result['exclude_tokens'] = []
+    self.excluded_devices.each do |excluded|
+      result['exclude_tokens'] << excluded.device.token_for_ua
+    end
+    
+    result
+  end
+  
+  def push
+    puts "process #{self.inspect}"
+    result = http_post("/api/push/broadcast/", apple_hash, {}, true)
+    self.last_response_code = result.code
+    self.save
+    self.process!
+  end
+  
+  def update_sent_at
+    self.sent_at = Time.now
+  end
+  
+  def self.process_pending
+    self.pending.each do |n|
+      n.push
+    end
+  end
+  
+  def check_response
+    self.last_response_code == 200 ? true : false
+  end
+  
+  def convert(input)
+    if input.to_i > 0 && input.to_i.to_s == input
+      return input.to_i
+    else
+      return input
+    end
+  end
+  
+  def check_response
+    self.last_response_code == 200 ? true : false
+  end
+
+end # APN::Notification

data/lib/urbanairship_on_rails/models/apn/device.rb

@@ -0,0 +1,129 @@
+# 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
+  include AASM
+
+  before_destroy :unregister, :destroy_undelivered_notifications, :destroy_undelivered_broadcast_exclusions
+  # before_save :set_last_registered_at
+
+  belongs_to :user, :dependent => :delete
+  has_many :notifications, :class_name => 'APN::Notification'
+  has_many :exclusions_from_notifications, :class_name => 'APN::ExcludedDevicesForNotification'
+
+  validates_presence_of :token
+  validates_uniqueness_of :token
+  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}$/
+
+  # 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
+  
+  aasm_initial_state :created
+  aasm_column :state
+  
+  aasm_state :created
+  aasm_state :activated, :enter => :set_last_registered_at
+  aasm_state :inactive, :enter => :set_last_inactive_at
+
+  aasm_event :activate do
+    transitions :from => [:created, :inactive, :activated], :to => :activated, :guard => :check_response
+  end
+  
+  aasm_event :deactivate do
+    transitions :from => [:created, :inactive, :activated], :to => :inactive
+  end  
+  
+  # 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
+
+  def register(options=nil)
+    puts "APN::Device.register"
+    # options = options.merge({:alias => self.user.id}) if self.user
+    result = http_put("/api/device_tokens/#{self.token_for_ua}", options)
+    self.response_code = result.code.to_s
+    self.response_message = result.message.to_s
+    self.response_body = result.body.to_s
+    self.save
+    self.activate!
+  end
+    
+  # You can read a device token’s alias with an HTTP GET to /api/device_tokens/<device_token>, which returns application/json:
+  # {"device_token": "some device token","alias": "your_user_id"}
+  def read
+    puts "APN::Device.read"
+    http_get("/api/device_tokens/#{self.token_for_ua}")
+  end
+  
+  # The DELETE returns HTTP 204 No Content, and needs no payload.
+  # When a token is DELETEd in this manner, any alias or tags will be cleared.
+  
+  def token_for_ua
+    self.token.gsub(' ', '').upcase
+  end
+  
+  def self.find_by_ua_token(ua_token)
+    find_by_token(ua_token.downcase.scan(/.{8}/).join(" "))
+  end
+
+  private
+  
+  def unregister
+    puts "APN::Device.unregister"
+    http_delete("/api/device_tokens/#{self.token_for_ua}")
+  end
+  
+  def destroy_undelivered_notifications
+    self.notifications.pending.each do |notification|
+      notification.excluded_devices.first.destroy unless notification.excluded_devices.first.nil?
+      notification.destroy
+    end
+  end
+
+  def destroy_undelivered_broadcast_exclusions
+    self.exclusions_from_notifications.broadcasts.each do |exclusion|
+      unless exclusion.broadcast_notification.nil?
+        exclusion.destroy unless exclusion.broadcast_notification.processed?
+      end
+    end
+  end
+
+  def set_last_registered_at
+    self.last_registered_at = Time.now
+  end
+
+  def set_last_inactive_at
+    self.last_inactive_at = Time.now
+    self.notifications.pending.each do |n|
+      n.set_to_inactive!
+    end
+  end
+
+  def check_response
+    if self.response_code == "200" || self.response_code == "201"
+      return true
+    else
+      self.deactivate!
+      return false
+    end
+  end
+end

data/lib/urbanairship_on_rails/models/apn/excluded_devices_for_notification.rb

@@ -0,0 +1,21 @@
+class APN::ExcludedDevicesForNotification < APN::Base
+
+  belongs_to :broadcast_notification, :class_name => 'APN::BroadcastNotification'
+  belongs_to :notification, :class_name => 'APN::Notification'
+  belongs_to :device, :class_name => 'APN::Device'
+  
+  validates_presence_of :device, :on => :create, :message => "is required"
+  validates_presence_of :notification, :on => :create, :message => "or BroadcastNotification is required", :unless => :has_broadcast_notification?
+
+  validates_uniqueness_of :notification_id, :scope => :device_id, :allow_nil => true
+  validates_uniqueness_of :broadcast_notification_id, :scope => :device_id, :allow_nil => true
+  
+  named_scope :broadcasts, lambda { 
+      { :conditions => "broadcast_notification_id IS NOT NULL" }
+    }  
+  
+  
+  def has_broadcast_notification?
+    broadcast_notification.nil? ? false : true
+  end
+end

data/lib/urbanairship_on_rails/models/apn/feedback.rb

@@ -0,0 +1,74 @@
+require 'json'
+# 
+# Apple notifies UA when a notification is sent to a device that has push notifications enabled (for at least one application) 
+# but has turned off or uninstalled your application. We immediate stop sending notifications through to avoid angering Apple.
+# 
+# To query what device tokens are now invalid, do an HTTP GET to /api/device_tokens/feedback/?since=<timestamp> with the push secret; 
+# the query argument since is required, and is a timestamp in ISO 8601 format, e.g. /api/device_tokens/feedback/?since=2009-06-01+13:00:00. 
+# The return value is application/json with the following structure:
+# 
+class APN::Feedback < APN::Base
+  include AASM
+
+  named_scope :last_feedback_request, lambda {
+      { :conditions => "state = 'processed'", :order => "id DESC" }
+  }
+  
+  #
+  # MODEL STATE MACHINE
+  #
+  aasm_initial_state :pending
+  aasm_column :state
+
+  aasm_state :pending
+  aasm_state :active
+  aasm_state :processed
+
+  aasm_event :pend do
+    transitions :from => [:active, :processed], :to => :pending
+  end
+  
+  aasm_event :activate  do
+    transitions :from => [:pending, :processed], :to => :active
+  end
+
+  aasm_event :process do
+    transitions :from => :active, :to => :processed
+  end
+    
+  def run
+    raise "save feedback record before running" if self.new_record?
+    get_feedback { |results|
+
+      puts results.inspect
+      if results.code.to_i == 200
+        result = JSON.parse(results.body) # parse json results
+        result.each do |item| # iterate results and delete devices that have been deactivated
+          d = APN::Device.find_by_ua_token(item['device_token'])
+          d.deactivate! if d
+        end
+        self.process!
+      end
+    }
+  end
+  
+  def get_feedback
+    self.activate!
+    # puts "APN::get_feedback"
+    # time = 1.day.ago.iso8601
+    time = last_feedback_time
+    # puts "    since #{time}"
+    result = http_get("/api/device_tokens/feedback/?since=#{time}", nil, {}, true)
+    self.code = result.code.to_s
+    self.message = result.message.to_s
+    self.body = result.body.to_s
+
+    yield result if block_given?
+  end
+  
+  def last_feedback_time
+    f = APN::Feedback.last_feedback_request.first
+    f.nil? ? Time.at(0).iso8601 : f.created_at.iso8601
+  end
+  
+end

data/lib/urbanairship_on_rails/models/apn/notification.rb

@@ -0,0 +1,101 @@
+# 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.custom_properties = {:email_id => "6", :link => "http://google.com"}
+#   apn.device = APN::Device.find(1)
+#   apn.save
+# 
+# To deliver call the following method:
+#   APN::Notification.process_pending
+# 
+
+class APN::Notification < APN::Base
+  include AASM
+  include ::ActionView::Helpers::TextHelper
+  extend ::ActionView::Helpers::TextHelper
+
+  serialize :custom_properties
+  
+  has_many :excluded_devices, :class_name => 'APN::ExcludedDevicesForNotification'
+  belongs_to :device, :class_name => 'APN::Device'
+  
+  validates_presence_of :device, :on => :create, :message => "can't be blank"
+  validate_on_create :device_state
+
+  #
+  # MODEL STATE MACHINE
+  #
+  aasm_initial_state :pending
+  aasm_column :state
+  
+  aasm_state :pending
+  aasm_state :processed, :enter => :update_sent_at
+  aasm_state :inactive_device
+
+  aasm_event :process do
+    transitions :from => :pending, :to => :processed, :guard => :check_response
+  end
+
+  aasm_event :set_to_inactive do
+    transitions :from => :pending, :to => :inactive_device
+  end
+
+  def apple_hash
+    result = {}
+    result['aps'] = {}
+    result['aps']['alert'] = self.alert if self.alert
+    result['aps']['badge'] = convert(self.badge) if self.badge
+    if self.sound
+      result['aps']['sound'] = self.sound if self.sound
+    end
+    if self.custom_properties
+      self.custom_properties.each do |key,value|
+        result["#{key}"] = "#{value}"
+      end
+    end
+    result['device_tokens'] = self.device.token_for_ua
+    result
+  end
+  
+  def push
+    puts "process #{self.inspect}"
+    result = http_post("/api/push/", apple_hash, {}, true)
+    self.last_response_code = result.code
+    self.save
+    self.process!
+  end
+  
+  def update_sent_at
+    self.sent_at = Time.now
+  end
+  
+  def self.process_pending
+    self.pending.each do |n|
+      unless n.device.inactive?
+        n.push
+      end
+    end
+  end
+    
+  def convert(input)
+    if input.to_i > 0 && input.to_i.to_s == input
+      return input.to_i
+    else
+      return input
+    end
+  end
+  
+  def check_response
+    self.last_response_code == 200 ? true : false
+  end
+  
+  def device_state
+    errors.add(:device, "must not be marked as inactive") if device.inactive?
+  end
+  
+end # APN::Notification

data/lib/urbanairship_on_rails/urbanairship_on_rails.rb

@@ -0,0 +1,21 @@
+
+
+# ############################# this belongs in initializer
+# require File.dirname(__FILE__) + '/libs/config'
+# UA::Config::app_key      = 'YOUR_APP_KEY'
+# UA::Config::app_secret   = 'YOUR_APP_SECRET'
+# UA::Config::push_secret  = 'YOUR_PUSH_SECRET' 
+# UA::Config::push_host    = 'https://go.urbanairship.com'
+# #############################
+
+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}"
+  ActiveSupport::Dependencies.load_paths << path 
+  ActiveSupport::Dependencies.load_once_paths.delete(path) 
+end

data/lib/urbanairship_on_rails/version.rb

@@ -0,0 +1,3 @@
+module UrbanairshipOnRails
+  VERSION = "0.0.1"
+end

data/tasks/urban_airship_on_rails_tasks.rake

@@ -0,0 +1,22 @@
+# desc "Explaining what the task does"
+# task :urban_airship_on_rails do
+#   # Task goes here
+# end
+
+namespace :apn do
+  desc "retreive and process list of inactive devices"
+  task :feedback => [:environment] do
+    APN::Feedback.create().run
+  end
+
+  desc "send all pending notifications to devices"
+  task :push => [:environment] do
+    APN::Notification.process_pending
+  end
+
+  desc "send all pending broadcast notifications to devices"
+  task :broadcast_push => [:environment] do
+    APN::BroadcastNotification.process_pending
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/test/urban_airship_on_rails_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class UrbanAirshipOnRailsTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

data/urbanairship_on_rails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "urbanairship_on_rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "urbanairship_on_rails"
+  s.version     = UrbanairshipOnRails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Kassimatis"]
+  s.email       = ["yonnage@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{URBAN AIRSHIP ON RAILS}
+  s.description = %q{push notifications}
+
+  s.rubyforge_project = "urbanairship_on_rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: urbanairship_on_rails
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Kassimatis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: push notifications
+email: 
+- yonnage@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- generators/apn_migrations/apn_migrations_generator.rb
+- generators/apn_migrations/templates/apn_migrations/001_create_apn_devices.rb
+- generators/apn_migrations/templates/apn_migrations/002_create_apn_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/003_create_apn_feedbacks.rb
+- generators/apn_migrations/templates/apn_migrations/004_create_apn_broadcast_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/005_change_badge_to_string_on_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/006_rename_errors_nb_to_last_error_code_on_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/007_rename_errors_nb_to_last_error_code_on_broadcast_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/008_add_custom_properties_on_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/009_add_custom_properties_on_broadcast_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/010_create_apn_excluded_devices_for_notifications.rb
+- generators/apn_migrations/templates/apn_migrations/011_add_response_code_message_and_body_to_devices.rb
+- generators/apn_migrations/templates/apn_migrations/012_add_last_inactive_at_to_devices.rb
+- init.rb
+- install.rb
+- lib/urbanairship_on_rails.rb
+- lib/urbanairship_on_rails/libs/config.rb
+- lib/urbanairship_on_rails/models/apn/base.rb
+- lib/urbanairship_on_rails/models/apn/broadcast_notification.rb
+- lib/urbanairship_on_rails/models/apn/device.rb
+- lib/urbanairship_on_rails/models/apn/excluded_devices_for_notification.rb
+- lib/urbanairship_on_rails/models/apn/feedback.rb
+- lib/urbanairship_on_rails/models/apn/notification.rb
+- lib/urbanairship_on_rails/urbanairship_on_rails.rb
+- lib/urbanairship_on_rails/version.rb
+- tasks/urban_airship_on_rails_tasks.rake
+- test/test_helper.rb
+- test/urban_airship_on_rails_test.rb
+- uninstall.rb
+- urbanairship_on_rails.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: urbanairship_on_rails
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: URBAN AIRSHIP ON RAILS
+test_files: 
+- test/test_helper.rb
+- test/urban_airship_on_rails_test.rb