apn_on_rails 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 markbates
+
+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,88 @@
+APN on Rails
+(Apple Push Notifications on Rails)
+=====================
+
+Acknowledgements
+----------------
+This gem is a re-write of a plugin that was written by Fabien Penso and Sam Soffes.
+Their plugin was a great start, but it just didn't quite reach the level I hoped it would.
+I've re-written, as a gem, added a ton of tests, and I would like to think that I made it
+a little nicer and easier to use.
+
+Converting Your Certificate
+---------------------------
+Once you have the certificate from Apple for your application, export your key
+and the apple certificate as p12 files. Here is a quick walkthrough on how to do this:
+
+1. Click the disclosure arrow next to your certificate in Keychain Access and select the certificate and the key. 
+2. Right click and choose `Export 2 items...`. 
+3. Choose the p12 format from the drop down and name it `cert.p12`. 
+
+Now covert the p12 file to a pem file:
+
+  $ openssl pkcs12 -in cert.p12 -out apple_push_notification_production.pem -nodes -clcerts
+
+Put 'apple_push_notification_production.pem' in config/
+
+If you are using a development certificate, then change the name to apple_push_notification_development.pem instead.
+
+Installing
+----------
+
+From RubyForge:
+  $ sudo gem install apn_on_rails
+
+Or, if you like to live on the edge:
+  $ sudo gem install markbates-apn_on_rails --source=http://gems.github.com
+  
+Then you just add the following require, wherever it makes sense to you:
+  require 'apn_on_rails'
+
+If you like to use the built in Rails gem management:
+  config.gem 'apn_on_rails'
+
+Or, if you like to live on the edge:
+  config.gem 'markbates-apn_on_rails', :lib => 'apn_on_rails', :source => 'http://gems.github.com'
+  
+Setup and Configuration
+-----------------------
+Once you have the gem installed you need to add the following to your Rakefile so you can use the
+Rake tasks that ship with APN on Rails:
+  begin
+    require 'apn_on_rails_tasks'
+  rescue MissingSourceFile => e
+    puts e.message
+  end
+
+Now, to create the tables you need for APN on Rails, run the following task:
+  $ rake apn:db:migrate
+
+APN on Rails uses the Configatron gem, http://github.com/markbates/configatron/tree/master, 
+to configure itself. APN on Rails has the following default configurations that you change as you
+see fit:
+
+  configatron.apn.passphrase # => ''
+  configatron.apn.port # => 2195
+  configatron.apn.host # => 'gateway.sandbox.push.apple.com'
+  configatron.apn.cert #=> File.join(RAILS_ROOT, 'config', 'apple_push_notification_development.pem')
+  
+  # production:
+  configatron.apn.host # => 'gateway.push.apple.com'
+  configatron.apn.cert #=> File.join(RAILS_ROOT, 'config', 'apple_push_notification_production.pem')
+
+That's it, now you're ready to start creating notifications.
+
+Example
+-------
+
+    $ ./script/console
+    >> device = APN::Device.create(:token => "XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX")
+    >> notification = APN::Notification.new
+    >> notification.device = device
+    >> notification.badge = 5
+    >> notification.sound = true
+    >> notification.alert = "foobar"
+    >> notification.save
+    >> APN::Notification.send_notifications
+
+Released under the MIT license.

data/lib/apn_on_rails/apn_on_rails.rb

@@ -0,0 +1,51 @@
+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.set_default(:host, 'gateway.sandbox.push.apple.com')
+configatron.apn.set_default(:cert, File.join(rails_root, 'config', 'apple_push_notification_development.pem'))
+
+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'))
+end
+
+module APN
+  
+  module Errors
+    
+    class ExceededMessageSizeError < StandardError
+      
+      def initialize(message)
+        super("The maximum size allowed for a notification payload is 256 bytes: '#{message}'")
+      end
+      
+    end
+    
+  end # Errors
+  
+end # APN
+
+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/apn_on_rails/app/models/apn/device.rb

@@ -0,0 +1,25 @@
+class APN::Device < ActiveRecord::Base
+  set_table_name 'apn_devices'
+  
+  has_many :notifications, :class_name => 'APN::Notification'
+  
+  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}$/
+  
+  # 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
+  
+end

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

@@ -0,0 +1,84 @@
+class APN::Notification < ActiveRecord::Base
+  include ::ActionView::Helpers::TextHelper
+  extend ::ActionView::Helpers::TextHelper
+  
+  set_table_name 'apn_notifications'
+  
+  belongs_to :device, :class_name => 'APN::Device'
+  
+  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!"}}
+  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
+    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
+  
+  class << self
+    
+    def send_notifications(notifications = APN::Notification.all(:conditions => {:sent_at => nil}))
+      unless notifications.nil? || notifications.empty?
+        logger.info "APN: Attempting to deliver #{pluralize(notifications.size, 'notification')}."
+        cert = File.read(configatron.apn.cert)
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.key = OpenSSL::PKey::RSA.new(cert, configatron.apn.passphrase)
+        ctx.cert = OpenSSL::X509::Certificate.new(cert)
+  
+        s = TCPSocket.new(configatron.apn.host, configatron.apn.port)
+        ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
+        ssl.sync = true
+        ssl.connect
+  
+        notifications.each do |noty|
+          ssl.write(noty.message_for_sending)
+          noty.sent_at = Time.now
+          noty.save
+        end
+  
+        ssl.close
+        s.close
+      end
+    end
+    
+  end # class << self
+  
+end # APN::Notification

data/lib/apn_on_rails/db/migrate/20090723132058_create_apn_devices.rb

@@ -0,0 +1,13 @@
+class CreateApnDevices < ActiveRecord::Migration
+  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/lib/apn_on_rails/db/migrate/20090723132059_create_apn_notifications.rb

@@ -0,0 +1,23 @@
+class CreateApnNotifications < ActiveRecord::Migration
+  
+  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/lib/apn_on_rails/tasks/apn.rake

@@ -0,0 +1,12 @@
+namespace :apn do
+  
+  namespace :notifications do
+    
+    desc "Deliver all unsent APN notifications."
+    task :deliver => [:environment] do
+      APN::Notification.send_notifications
+    end
+    
+  end # notifications
+  
+end # apn

data/lib/apn_on_rails/tasks/db.rake

@@ -0,0 +1,13 @@
+namespace :apn do
+  
+  namespace :db do
+    
+    desc 'Runs the migrations for apn_on_rails.'
+    task :migrate => [:environment] do
+      puts File.join(File.dirname(__FILE__), '..', '..', 'apn_on_rails', 'db', 'migrate')
+      ActiveRecord::Migrator.up(File.join(File.dirname(__FILE__), '..', '..', 'apn_on_rails', 'db', 'migrate'))
+    end
+    
+  end # db
+  
+end # apn

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_tasks.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'apn_on_rails', 'tasks', '**/*.rake')).each do |f|
+  load File.expand_path(f)
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: apn_on_rails
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- markbates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "apn_on_rails was developed by: markbates"
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- lib/apn_on_rails/apn_on_rails.rb
+- lib/apn_on_rails/app/models/apn/device.rb
+- lib/apn_on_rails/app/models/apn/notification.rb
+- lib/apn_on_rails/db/migrate/20090723132058_create_apn_devices.rb
+- lib/apn_on_rails/db/migrate/20090723132059_create_apn_notifications.rb
+- lib/apn_on_rails/tasks/apn.rake
+- lib/apn_on_rails/tasks/db.rake
+- lib/apn_on_rails.rb
+- lib/apn_on_rails_tasks.rb
+- README
+- LICENSE
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: magrathea
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: apn_on_rails
+test_files: []
+