apple_push_notification 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Fabien Penso, Sam Soffes
+
+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/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the apple_push_notification 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 apple_push_notification plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ApplePushNotification'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "apple_push_notification"
+    gemspec.summary = "Rails plugin for Apple Push Notifications"
+    gemspec.description = "Rails plugin for Apple Push Notifications"
+    gemspec.email = "sam@samsoff.es"
+    gemspec.homepage = "http://github.com/samsoffes/apple_push_notification"
+    gemspec.authors = ["Sam Soffes", "Fabien Penso"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/Readme.markdown

@@ -0,0 +1,62 @@
+# Apple Push Notification
+
+This plugin helps you use the Apple Push Notification system.
+
+## Converting Your Certificate
+
+Once you have the certificate from Apple for your application, export your key
+and the apple certificate as p12 files. Here's how:
+
+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 apn_development.pem -nodes -clcerts && rm -f cert.p12
+
+Put `apn_development.pem` in `config/certs` in your rails app. For production, name your certificate `apn_production.pem` and put it in the same directory. See the environment section for more about environments.
+
+## Installing
+
+Install as a gem:
+
+    # Add to config/environment.rb:
+    config.gem "apple_push_notification", :source => "http://gemcutter.org/"
+
+    # At command prompt:
+    $ sudo rake gems:install
+
+or as a plugin:
+
+    $ script/plugin install git://github.com/samsoffes/apple_push_notification.git
+
+Once you have installed apple\_push\_notification, run the following command:
+
+    $ rake apn:migrate
+
+## Environment
+
+By default, the development environment will always be used. This makes it easy to test your app in production before your iPhone application is approved and your production certificate is active. You can easily override this by adding this line in an initializer or environment file.
+
+    ApplePushNotification.enviroment = Rails.env.to_sym
+
+You can also simply set `ApplePushNotification.enviroment` to `:development` or `:production`. Setting the `ApplePushNotification.enviroment` chooses the appropriate certificate in your `certs` folder and Apple push notification server.
+
+## Example
+
+    $ ./script/console
+    >> a = ApplePushNotification.new
+    >> a.device_token = "XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX"
+    >> a.badge = 5
+    >> a.sound = true
+    >> a.alert = "Hello world"
+    >> a.send_notification
+    => nil
+
+### Notes
+
+* The spaces in `device_token` are optional. 
+* The `sound` can be the filename (i.e. `explosion.aiff`) or `true` which will play the default notification sound.
+
+Copyright (c) 2009 Fabien Penso. Released under the MIT license. Modified by [Sam Soffes](http://samsoff.es).

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/app/models/apple_push_notification.rb

@@ -0,0 +1,101 @@
+require 'socket'
+require 'openssl'
+
+class ApplePushNotification < ActiveRecord::Base
+
+	attr_accessor :paylod, :sound, :badge, :alert
+	attr_accessible :device_token
+	
+	PORT = 2195
+	
+	cattr_accessor :enviroment
+	self.enviroment = :development
+
+	validates_uniqueness_of :device_token
+
+	def send_notification
+    raise "Missing cert: #{_path}" unless @@cert
+
+		ctx = OpenSSL::SSL::SSLContext.new
+		ctx.key = OpenSSL::PKey::RSA.new(@@cert)
+		ctx.cert = OpenSSL::X509::Certificate.new(@@cert)
+
+		s = TCPSocket.new(@@host, PORT)
+		ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
+		ssl.sync = true
+		ssl.connect
+
+		ssl.write(self.apn_message_for_sending)
+
+		ssl.close
+		s.close
+
+	rescue SocketError => error
+		raise "Error while sending notifications: #{error}"
+	end
+	
+	def self.enviroment= enviroment
+	  @@enviroment = enviroment.to_sym
+    @@host = self.production? ? "gateway.push.apple.com" : "gateway.sandbox.push.apple.com"
+  	cert = self.production? ? "apn_production.pem" : "apn_development.pem"
+  	path = File.join(File.expand_path(RAILS_ROOT), "config", "certs", cert)
+    @@cert = File.exists?(path) ? File.read(path) : nil
+  end
+	
+	def self.development?
+	  @@enviroment != :production
+  end
+	
+	def self.production?
+	  @@enviroment == :production
+  end
+
+	def self.send_notifications(notifications)	  
+		ctx = OpenSSL::SSL::SSLContext.new
+		ctx.key = OpenSSL::PKey::RSA.new(@@cert)
+		ctx.cert = OpenSSL::X509::Certificate.new(@@cert)
+
+		s = TCPSocket.new(@@host, PORT)
+		ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
+		ssl.sync = true
+		ssl.connect
+
+		for notif in notifications do
+			ssl.write(notif.apn_message_for_sending)
+		end
+
+		ssl.close
+		s.close
+	rescue SocketError => error
+		raise "Error while sending notifications: #{error}"
+	end
+
+	protected
+
+	def to_apple_json
+	  json = self.apple_array.to_json
+		logger.debug "Sending #{json}"
+		json
+	end
+
+	def apn_message_for_sending
+		json = self.to_apple_json
+		message = "\0\0 #{self.device_token_hexa}\0#{json.length.chr}#{json}"
+		raise "The maximum size allowed for a notification payload is 256 bytes." if message.size.to_i > 256
+		message
+	end
+
+	def device_token_hexa
+		[self.device_token.delete(' ')].pack('H*')
+	end
+
+	def apple_array
+		result = {}
+		result['aps'] = {}
+		result['aps']['alert'] = alert if alert
+		result['aps']['badge'] = badge.to_i if badge
+		result['aps']['sound'] = sound if sound and sound.is_a? String
+		result['aps']['sound'] = 'default' if sound and sound.is_a? TrueClass
+		result
+	end
+end

data/lib/apple_push_notification.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), "app", "models", "apple_push_notification.rb")
+
+%w{ models }.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/db/migrate/20090406132059_create_apple_push_notifications.rb

@@ -0,0 +1,18 @@
+class CreateApplePushNotifications < ActiveRecord::Migration
+  def self.up
+		# This is used to store the device UID informations
+    create_table :apple_push_notifications do |t|
+			t.string :device_token, :size => 71
+			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.timestamps
+    end
+		
+		add_index :apple_push_notifications, :device_token
+  end
+
+  def self.down
+    drop_table :apple_push_notifications
+  end
+end

data/tasks/apple_push_notification_tasks.rake

@@ -0,0 +1,10 @@
+namespace :apn do
+  desc "migrates ugin's migration files into the database."
+  task :migrate => :environment do
+
+			 ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true 
+			 ActiveRecord::Migrator.migrate(File.expand_path(File.dirname(__FILE__) + "/../lib/db/migrate"), ENV["VERSION"] ? ENV["VERSION"].to_i : nil)  
+			 
+			 Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby 
+  end
+end

data/test/apple_push_notification_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ApplePushNotificationTest < ActiveSupport::TestCase
+  # Someone could be awesome and write a test
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

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

data/uninstall.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: apple_push_notification
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sam Soffes
+- Fabien Penso
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-10 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Rails plugin for Apple Push Notifications
+email: sam@samsoff.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- .gitignore
+- LICENSE
+- Rakefile
+- Readme.markdown
+- VERSION
+- init.rb
+- install.rb
+- lib/app/models/apple_push_notification.rb
+- lib/apple_push_notification.rb
+- lib/db/migrate/20090406132059_create_apple_push_notifications.rb
+- tasks/apple_push_notification_tasks.rake
+- test/apple_push_notification_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/samsoffes/apple_push_notification
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails plugin for Apple Push Notifications
+test_files: 
+- test/apple_push_notification_test.rb
+- test/test_helper.rb