apple_push_notification 0.1.0 → 0.2.0

data/.gitignore

@@ -1 +1,2 @@
 .DS_Store
+pkg

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+== 0.1.1 released 2009-11-10
+
+* Moved from model to "acts_as_pushable".
+* Updated readme for new interface.
+
+== 0.1.0 released 2009-11-10
+
+* Initial release.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Fabien Penso, Sam Soffes
+Copyright (c) 2009 Sam Soffes
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -30,7 +30,7 @@ begin
     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"]
+    gemspec.authors = ["Sam Soffes"]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/Readme.markdown

@@ -2,6 +2,24 @@
 
 This plugin helps you use the Apple Push Notification system.
 
+## 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 ApplePushNotification, run the following command:
+
+    $ rake apn:migrate
+
 ## Converting Your Certificate
 
 Once you have the certificate from Apple for your application, export your key
@@ -17,46 +35,67 @@ Now covert the p12 file to a pem file:
 
 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
+## Environment
 
-Install as a gem:
+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.
 
-    # Add to config/environment.rb:
-    config.gem "apple_push_notification", :source => "http://gemcutter.org/"
+    ApplePushNotification.enviroment = Rails.env.to_sym
 
-    # At command prompt:
-    $ sudo rake gems:install
+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.
 
-or as a plugin:
+## Usage
 
-    $ script/plugin install git://github.com/samsoffes/apple_push_notification.git
+You can use ApplePushNotification with an ActiveRecord model, standalone, or on any object.
 
-Once you have installed apple\_push\_notification, run the following command:
+### ActiveRecord
 
-    $ rake apn:migrate
+Just add `acts_as_pushable` to your model.
 
-## Environment
+    class Device < ActiveRecord::Base
+        acts_as_pushable
+    end
 
-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.
+You can then send a notification like this
 
-    ApplePushNotification.enviroment = Rails.env.to_sym
+    d.send_notification :alert => "I heart Rails"
 
-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.
+The `send_notification` method accepts a hash of options for the notification parameters. See the Parameters section for more information.
+
+Your model must have a `device_token` attribute. If you wish to change this to something else (like `device` for example), simply pass it like this `acts_as_pushable :device`.
+
+### Standalone
 
-## Example
+Simply call `ApplePushNotification.send_notification` and pass the device token as the first parameter and the hash of notification options as the second (see the Parameters section for more information).
 
-    $ ./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
+    $ script/console
+    >> token = "XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX"
+    >> ApplePushNotification.send_notification token, :alert => "Hello World!", :badge => 5, :sound => true
     => nil
 
+### Any Object
+
+You can extend ApplePushNotification with any class. It will look for the `device_token` method when sending the notification. When ApplePushNotification is extended, if `device_token=` isn't defined, getters and setters are generated.
+
+    $ script/console
+    >> token = "XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX"
+    >> d = Object.new
+    >> d.extend ApplePushNotification
+    >> d.device_token = token
+    >> d.send_notification :alert => "So flexible"
+    => nil
+
+See the Parameters section for more information on what `send_notification` accepts.
+
+## Parameters
+
+The following notification parameters can be defined in the options hash:
+
+* `alert` - text displayed to the use
+* `sound` - this can be the filename (i.e. `explosion.aiff`) or `true` which will play the default notification sound
+* `badge` - this must be an integer
+
 ### 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.
+* The spaces in `device_token` are optional and will be ignored. 
 
-Copyright (c) 2009 Fabien Penso. Released under the MIT license. Modified by [Sam Soffes](http://samsoff.es).
+Copyright (c) 2009 [Sam Soffes](http://samsoff.es). Released under the MIT license. Forked from Fabien Penso.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/apple_push_notification.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apple_push_notification}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Soffes"]
+  s.date = %q{2009-11-10}
+  s.description = %q{Rails plugin for Apple Push Notifications}
+  s.email = %q{sam@samsoff.es}
+  s.extra_rdoc_files = [
+    "LICENSE"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "Rakefile",
+     "Readme.markdown",
+     "VERSION",
+     "apple_push_notification.gemspec",
+     "init.rb",
+     "lib/apple_push_notification.rb",
+     "lib/apple_push_notification/acts_as_pushable.rb",
+     "rails/init.rb",
+     "test/apple_push_notification_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/samsoffes/apple_push_notification}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rails plugin for Apple Push Notifications}
+  s.test_files = [
+    "test/apple_push_notification_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/apple_push_notification.rb

@@ -1,9 +1,101 @@
-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 
+require 'socket'
+require 'openssl'
+
+module ApplePushNotification
+
+  def self.extended(base)
+    # Added device_token attribute if not included by acts_as_pushable
+    unless base.respond_to?(:acts_as_push_options)
+      base.class_eval do
+        attr_accessor :device_token
+      end
+    end
+  end
+
+  APN_PORT = 2195
+  @@apn_cert = nil
+  @@apn_host = nil
+  
+  def self.apn_enviroment
+    @@apn_enviroment
+  end
+  
+  def self.apn_development?
+    @@apn_enviroment != :production
+  end
+
+  def self.apn_production?
+    @@apn_enviroment == :production
+  end
+  
+  def self.apn_enviroment= enviroment
+    @@apn_enviroment = enviroment.to_sym
+    @@apn_host = self.apn_production? ? "gateway.push.apple.com" : "gateway.sandbox.push.apple.com"
+    cert = self.apn_production? ? "apn_production.pem" : "apn_development.pem"
+    path = File.join(File.expand_path(RAILS_ROOT), "config", "certs", cert)
+    @@apn_cert = File.exists?(path) ? File.read(path) : nil
+    raise "Missing apple push notification certificate in #{path}" unless @@apn_cert
+  end
+  
+  self.apn_enviroment = :development
+  
+  def send_notification options
+    raise "Missing apple push notification certificate" unless @@apn_cert
+
+    ctx = OpenSSL::SSL::SSLContext.new
+    ctx.key = OpenSSL::PKey::RSA.new(@@apn_cert)
+    ctx.cert = OpenSSL::X509::Certificate.new(@@apn_cert)
+
+    s = TCPSocket.new(@@apn_host, APN_PORT)
+    ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
+    ssl.sync = true
+    ssl.connect
+
+    ssl.write(self.apn_message_for_sending(options))
+    ssl.close
+    s.close
+  rescue SocketError => error
+    raise "Error while sending notifications: #{error}"
+  end
+  
+  def self.send_notification token, options = {}
+    d = Object.new
+    d.extend ApplePushNotification
+    d.device_token = token
+    d.send_notification options
+  end
+
+  protected
+
+  def apn_message_for_sending options
+    json = ApplePushNotification::apple_json_array options
+    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
+    # Use `device_token` as the method to get the token from
+    # unless it is overridde from acts_as_pushable
+    apn_token_field = "device_token"
+    if respond_to?(:acts_as_push_options)
+      apn_token_field = acts_as_push_options[:device_token_field]
+    end
+    token = send(apn_token_field.to_sym)
+    raise "Cannot send push notification without device token" if !token || token.empty?
+    [token.delete(' ')].pack('H*')
+  end
+
+  def self.apple_json_array options
+    result = {}
+    result['aps'] = {}
+    result['aps']['alert'] = options[:alert].to_s if options[:alert]
+    result['aps']['badge'] = options[:badge].to_i if options[:badge]
+    result['aps']['sound'] = options[:sound] if options[:sound] and options[:sound].is_a? String
+    result['aps']['sound'] = 'default' if options[:sound] and options[:sound].is_a? TrueClass
+    result.to_json
+  end
+    
+end
+
+require File.dirname(__FILE__) + "/apple_push_notification/acts_as_pushable"

data/lib/apple_push_notification/acts_as_pushable.rb

@@ -0,0 +1,14 @@
+module ApplePushNotification
+  module ActsAsPushable
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  def self.acts_as_pushable(device_token_field = :device_token)
+    class_inheritable_reader :acts_as_push_options
+    write_inheritable_attribute :acts_as_push_options, {
+      :device_token_field => device_token_field
+    }
+    include ApplePushNotification
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "apple_push_notification"

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification 
 name: apple_push_notification
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sam Soffes
-- Fabien Penso
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -24,19 +23,18 @@ extra_rdoc_files:
 - LICENSE
 files: 
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - Rakefile
 - Readme.markdown
 - VERSION
+- apple_push_notification.gemspec
 - 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
+- lib/apple_push_notification/acts_as_pushable.rb
+- rails/init.rb
 - test/apple_push_notification_test.rb
 - test/test_helper.rb
-- uninstall.rb
 has_rdoc: true
 homepage: http://github.com/samsoffes/apple_push_notification
 licenses: []

data/lib/app/models/apple_push_notification.rb

@@ -1,101 +0,0 @@
-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/db/migrate/20090406132059_create_apple_push_notifications.rb

@@ -1,18 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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/uninstall.rb

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