ios_push_notifications 0.5

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.5 (February 07, 2010)
+Tests green without 2 methods. Need to mock certificates.

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [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.rdoc

@@ -0,0 +1,60 @@
+IosPushNotifications
+====================
+
+== What is ios_push_notifications
+  Nicely documented Push Notification gem for rails 3 applications, has generators for migrations and an initializer with configuration. Well documented and tested.... compared to other shitty forks out there >_>
+== Install
+
+  gem install ios_push_notifications
+
+== Rails 3
+
+To use ios_push_notifications with Rails 3 you will need to include it in your Gemfile.
+
+group :development do
+  gem "ios_push_notifications"
+end
+
+== Usage
+  * rails g iospn  : Will name the migration files (iospn_devices and iospn_notifications) combined with the initializer
+  
+== Configuration
+  TODO
+
+== Usage
+  TODO
+   device = IOSPN::Device.find_or_create_by_token("params[:device_token]")
+    
+    notification = IOSPN::Notification.new
+    notification.device = device
+    notification.badge = 5
+    notification.sound = true
+    notification.alert = "text..."
+    notification.save
+    IOSPN::Notification.send_notifications
+== Rake Tasks
+  TODO
+  
+== Certificates
+  TODO
+  
+Copyright (c) 2011 [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/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ios_push_notifications 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 ios_push_notifications plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IosPushNotifications'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/ios_push_notifications_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/base'
+require 'rails/generators/migration'
+
+class IosPushNotificationsGenerator < Rails::Generators::Base #:nodoc:
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+      
+
+      def create_initializer
+        template 'initializer.rb', "config/initializers/ios_push_notification.rb"
+      end
+      
+      def create_migration
+        migration_template 'device_migration.rb', "db/migrate/create_iospn_devices.rb" 
+        migration_template 'notification_migration.rb', "db/migrate/create_iospn_notifications.rb" 
+      end
+
+                
+      # FIXME: Should be proxied to ActiveRecord::Generators::Base
+      # Implement the required interface for Rails::Generators::Migration.
+      
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M#{rand 60}")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+end

data/lib/generators/templates/device_migration.rb

@@ -0,0 +1,18 @@
+class CreateIospnDevices < ActiveRecord::Migration
+  def self.up
+    create_table :iospn_devices do |t|
+      t.text :token, :length => 100, :null => false
+      t.datetime :last_registered_at
+      t.timestamps
+    end
+     add_index :iospn_devices, :token, :unique => true
+  end
+
+  def self.down
+    drop_table :iospn_devices
+  end
+end
+
+
+
+   

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,3 @@
+IOSPN.configure do |c|
+    #c.notification[:cert] = File.join(Rails.root,"apple_push_notification_production.pem")
+end

data/lib/generators/templates/notification_migration.rb

@@ -0,0 +1,25 @@
+class CreateIospnNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+
+    create_table :iospn_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.text :custom_properties
+      t.datetime :sent_at
+      t.timestamps
+    end
+    
+    add_index :iospn_notifications, :device_id
+    add_index :iospn_notifications, :sent_at
+  end
+
+  def self.down
+    drop_table :iospn_notifications
+  end  
+end
+

data/lib/ios_push_notifications.rb

@@ -0,0 +1,43 @@
+require "active_record" unless defined?(ActiveRecord)
+require "action_view" unless defined?(ActionView)
+
+require "rails" unless defined?(Rails)
+  
+
+require 'socket'
+require 'openssl'
+require "ios_push_notifications/notification"
+require "ios_push_notifications/device"
+require "ios_push_notifications/configuration"
+module IOSPN
+  def open_for_delivery(options = {}, &block)
+        open(options, &block)
+  end
+  def open(options = {}, &block)
+        options = IOSPN.configuration.notification.merge(options)
+        cert = File.read(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?
+        ssl.close
+        sock.close
+      end
+
+      # Yields up an SSL socket to receive feedback from.
+      # The connections are close automatically.
+      # Configuration parameters are:
+      #       
+      def open_for_feedback(options = {}, &block)
+        options =  IOSPN.configuration.feedback.merge(options)
+        Notification.open(options, &block)
+      end
+      
+
+end

data/lib/ios_push_notifications/configuration.rb

@@ -0,0 +1,32 @@
+module IOSPN
+  class Configuration
+    attr_accessor :feedback,:notification
+    
+    def initialize
+      @feedback = {}
+      @notification = {}
+      @notification = {:passphrase => '', :port => 2195}
+      @feedback = {:passphrase => @notification[:passphrase], :port => 2196}
+      if Rails.env.production?
+        @notification[:host] = "gateway.push.apple.com"
+        @notification[:cert] = File.join(Rails.root, 'config', 'apple_push_notification_production.pem') if Rails.root
+        @feedback[:host] = "feedback.push.apple.com"
+        @feedback[:cert] = @notification[:cert]
+      else
+        @notification[:host] = "gateway.sandbox.push.apple.com"
+        @notification[:cert] = File.join(Rails.root, 'config', 'apple_push_notification_development.pem') if Rails.root
+        @feedback[:host] = "feedback.sandbox.push.apple.com"
+        @feedback[:cert] = @notification[:cert]
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end  
+end

data/lib/ios_push_notifications/device.rb

@@ -0,0 +1,33 @@
+module IOSPN
+  class Device < ActiveRecord::Base
+  set_table_name "iospn_devices"
+  has_many :notifications
+  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}$/
+  # before_save :set_last_registered_at  
+  # private
+  # def self.set_last_registered_at
+  #   self.last_registered_at = Time.now if self.last_registered_at.nil?
+  # end
+  
+  def save
+    self.last_registered_at = Time.now if self.last_registered_at.nil?
+    super()
+  end
+  
+  def token=(token)
+    res = token.scan(/\<(.+)\>/).first
+    unless res.nil? || res.empty?
+      token = res.first
+    end
+    write_attribute('token', token)
+  end
+
+
+  def to_hex
+      [self.token.delete(' ')].pack('H*')
+    end
+  end
+  
+  
+end

data/lib/ios_push_notifications/notification.rb

@@ -0,0 +1,60 @@
+module IOSPN
+  class Notification < ActiveRecord::Base
+    set_table_name "iospn_notifications"
+    class << self
+      include IOSPN
+    end
+    belongs_to :device
+    include ::ActionView::Helpers::TextHelper
+
+    def alert=(message)
+      if !message.blank? && message.size > 150
+        message = truncate(message, :length => 150)
+      end
+      write_attribute(:alert, message)
+    end
+
+    def build_hash_for_push_notification
+      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) && self.sound
+      end
+      if self.custom_properties
+        self.custom_properties.each do |key,value|
+          result["#{key}"] = "#{value}"
+        end
+      end
+      result
+    end
+
+    def build_hash_for_json
+      self.build_hash_for_push_notification.to_json
+    end
+    
+    def build_message_for_sending
+          json = self.build_hash_for_json
+    message = "\0\0 #{self.device.to_hex}\0#{json.length.chr}#{json}"
+    if message.size.to_i > 256
+      return false
+    else
+      message
+    end
+    end
+
+   def self.send_notifications(notifications =Notification.where(:sent_at => nil))
+      unless notifications.nil? || notifications.empty?
+       open_for_delivery do |conn, sock|
+          notifications.each do |noty|
+            conn.write(noty.build_message_for_sending)
+            noty.sent_at = Time.now
+            noty.save
+          end
+        end
+      end
+    end
+    
+  end
+end

data/test/apple_push_notification_development.pem

@@ -0,0 +1,11 @@
+-----BEGIN CERTIFICATE REQUEST-----
+MIIBqjCCARMCAQAwPDELMAkGA1UEBhMCU0UxCjAIBgNVBAgTAXMxITAfBgNVBAoT
+GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDCBnzANBgkqhkiG9w0BAQEFAAOBjQAw
+gYkCgYEA0C+d/EP3ra8y//u9C1+tatY1S2YBuTNofSvfEcvTs4KH8lGqt9Lvfd2S
+u7kqWzUFVHbhanG0gHkaF1vKowLImeVch6dvYWxRKahTfnSaw86nyKEYJuljrx2d
+dlzFPPEpp3/SY1h4HIsH4PWYwujGUiAPu1DUXrxhBLmdU5ntTA0CAwEAAaAuMBUG
+CSqGSIb3DQEJAjEIEwZhc2Rhc2QwFQYJKoZIhvcNAQkHMQgTBmFzZGFzZDANBgkq
+hkiG9w0BAQUFAAOBgQAx7EavEK0sf6XdiXRuwman2yLOpDHYWUIZu+2IfBMqUG+C
+I2K0JrMaQzT30giG4S7MQX1WzZLPN20aeiaNXqkNHIHwO4GtjWZCun4L8iNj47em
+EPXyHopUQEjHSW23uJa52wjQhlnwoyrFZ0I11gG18J5DbhSSrny2n2e3EltT5A==
+-----END CERTIFICATE REQUEST-----

data/test/database.yml

@@ -0,0 +1,22 @@
+# vendor/plugins/yaffle/test/database.yml
+sqlite:
+  :adapter: sqlite
+  :database: test/ios_push_notifications_plugin.sqlite.db
+ 
+sqlite3:
+  :adapter: sqlite3
+  :database: test/ios_push_notifications_plugin.sqlite3.db
+ 
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: ios_push_notifications_plugin_test
+  :min_messages: ERROR
+ 
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: password
+  :database: ios_push_notifications_plugin_test

data/test/debug.log

@@ -0,0 +1,92 @@
+  SQL (0.3ms)  DROP TABLE iospn_notifications
+SQLite3::SQLException: no such table: iospn_notifications: DROP TABLE iospn_notifications
+  SQL (0.3ms)  DROP TABLE iospn_notifications
+SQLite3::SQLException: no such table: iospn_notifications: DROP TABLE iospn_notifications
+  SQL (0.2ms)  select sqlite_version(*)
+  SQL (4.0ms)  CREATE TABLE "iospn_devices" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "token" text NOT NULL, "last_registered_at" datetime, "created_at" datetime, "updated_at" datetime) 
+  SQL (8.2ms)  CREATE TABLE "iospn_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "device_id" integer NOT NULL, "errors_nb" integer DEFAULT 0, "device_language" varchar(255), "sound" varchar(255), "alert" varchar(255), "badge" integer, "custom_properties" text, "sent_at" datetime, "created_at" datetime, "updated_at" datetime) 
+  SQL (0.3ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (1.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+  SQL (0.1ms)  PRAGMA index_list("schema_migrations")
+  SQL (1.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  SQL (0.2ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)  SELECT version FROM "schema_migrations"
+  SQL (1.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+  SQL (0.3ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.4ms)  INSERT INTO "iospn_devices" ("token", "last_registered_at", "created_at", "updated_at") VALUES ('5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz', '2011-02-07 21:26:19.764189', '2011-02-07 21:26:19.820338', '2011-02-07 21:26:19.820338')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:26:19.822051', '2011-02-07 21:26:19.822051')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:26:19.823923', '2011-02-07 21:26:19.823923')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:26:19.824817', '2011-02-07 21:26:19.824817')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:26:19.825738', '2011-02-07 21:26:19.825738')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:26:19.826643', '2011-02-07 21:26:19.826643')
+  SQL (0.2ms)  SELECT COUNT(*) FROM "iospn_notifications" WHERE ("iospn_notifications".device_id = 1)
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.3ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (1.3ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:26:19.885546', '2011-02-07 21:26:19.885546')
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.4ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (NULL, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:26:19.911904', '2011-02-07 21:26:19.911904')
+SQLite3::ConstraintException: iospn_notifications.device_id may not be NULL: INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (NULL, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:26:19.911904', '2011-02-07 21:26:19.911904')
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.3ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:26:19.914939', '2011-02-07 21:26:19.914939')
+  SQL (0.1ms)  SELECT COUNT(*) FROM "iospn_notifications" WHERE ("iospn_notifications"."sent_at" IS NULL)
+  SQL (3.5ms)  DROP TABLE iospn_notifications
+  SQL (1.4ms)  DROP TABLE iospn_devices
+  SQL (0.2ms)  select sqlite_version(*)
+  SQL (1.1ms)  CREATE TABLE "iospn_devices" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "token" text NOT NULL, "last_registered_at" datetime, "created_at" datetime, "updated_at" datetime) 
+  SQL (7.5ms)  CREATE TABLE "iospn_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "device_id" integer NOT NULL, "errors_nb" integer DEFAULT 0, "device_language" varchar(255), "sound" varchar(255), "alert" varchar(255), "badge" integer, "custom_properties" text, "sent_at" datetime, "created_at" datetime, "updated_at" datetime) 
+  SQL (0.3ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)  SELECT version FROM "schema_migrations"
+  SQL (0.2ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.3ms)  INSERT INTO "iospn_devices" ("token", "last_registered_at", "created_at", "updated_at") VALUES ('5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz', '2011-02-07 21:50:54.133692', '2011-02-07 21:50:54.188627', '2011-02-07 21:50:54.188627')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:50:54.190235', '2011-02-07 21:50:54.190235')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:50:54.191986', '2011-02-07 21:50:54.191986')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:50:54.192872', '2011-02-07 21:50:54.192872')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:50:54.193781', '2011-02-07 21:50:54.193781')
+  AREL (0.1ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, NULL, NULL, NULL, NULL, NULL, '2011-02-07 21:50:54.194667', '2011-02-07 21:50:54.194667')
+  SQL (0.1ms)  SELECT COUNT(*) FROM "iospn_notifications" WHERE ("iospn_notifications".device_id = 1)
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices"."id" FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  IOSPN::Device Load (0.1ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.7ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:50:54.250848', '2011-02-07 21:50:54.250848')
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.5ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (NULL, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:50:54.280836', '2011-02-07 21:50:54.280836')
+SQLite3::ConstraintException: iospn_notifications.device_id may not be NULL: INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (NULL, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:50:54.280836', '2011-02-07 21:50:54.280836')
+  IOSPN::Device Load (0.2ms)  SELECT "iospn_devices".* FROM "iospn_devices" WHERE ("iospn_devices"."token" = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz') LIMIT 1
+  AREL (0.3ms)  INSERT INTO "iospn_notifications" ("device_id", "errors_nb", "device_language", "sound", "alert", "badge", "custom_properties", "sent_at", "created_at", "updated_at") VALUES (1, 0, NULL, 'awesome.wav', 'Lorem Ipsum', 7, NULL, NULL, '2011-02-07 21:50:54.284408', '2011-02-07 21:50:54.284408')
+  SQL (0.1ms)  SELECT COUNT(*) FROM "iospn_notifications" WHERE ("iospn_notifications"."sent_at" IS NULL)

data/test/device_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+class Device < Test::Unit::TestCase
+  
+  def setup
+    @device = IOSPN::Device.new(:token => "5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz")
+  end
+  
+  def test_notification_instance
+    assert @device
+  end
+  
+  def test_notification_token
+    token = @device.token
+    @device.token = "<#{token}>"
+    assert_equal(token, @device.token)
+  end
+  
+  def test_registered_at_before_save
+    assert(@device.last_registered_at.nil?)
+    @device.save
+    assert(@device.last_registered_at)
+  end
+  
+  def test_has_many_notifications
+    5.times do 
+      @device.notifications << IOSPN::Notification.new
+    end
+    @device.save
+    assert_equal(@device.notifications.count, 5)
+  end
+  
+  def test_unique_token
+    @device.save
+    bad_device = IOSPN::Device.create(:token => @device.token)
+    assert bad_device.errors
+  end
+end

data/test/ios_push_notifications_test.rb

@@ -0,0 +1,3 @@
+require 'test_helper'
+class IosPushNotificationsTest < ActiveSupport::TestCase
+end

data/test/notification_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+class Notification < Test::Unit::TestCase
+  
+  def setup
+    @notif = IOSPN::Notification.new
+    @notif.alert = "Lorem Ipsum"
+    @notif.badge = 7
+    @notif.sound = "awesome.wav"
+    @device = IOSPN::Device.find_or_create_by_token("5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz")
+    @notif.device = @device
+  end
+  
+  def test_notification_instance
+    assert @notif
+  end
+  
+  
+  def test_notification_alert
+    message = "Hey man what's up?"
+    @notif.alert = message
+    assert_equal(@notif.alert, message)
+  end
+  
+  def test_existence_of_sound
+    assert_equal @notif.sound, "awesome.wav"
+    
+  end
+  
+  def test_notification_truncate_above_150_characters
+    long_message = ""
+    160.times { |n| long_message << n}
+    @notif.alert = long_message
+    assert_equal(150, @notif.alert.length)
+  end
+  
+  
+  def test_notification_badge
+    number = 5
+    @notif.badge = number
+    assert_equal(@notif.badge, number)
+  end
+  
+  def test_save_notification_without_device
+    @notif.device = nil
+    assert_raise(ActiveRecord::StatementInvalid) {@notif.save}
+    assert_not_nil @notif.errors
+  end
+  
+  def test_save_notification_with_device
+    assert(!@notif.device.new_record?)
+    assert @notif.save
+  end
+  
+  def test_hash_for_push_notification
+    hash = @notif.build_hash_for_push_notification
+    assert_instance_of(Hash, hash)
+    matcher = {'aps' => {'alert' => @notif.alert, 
+                         'badge' => @notif.badge, 
+                         'sound' => @notif.sound }}
+    assert_equal(matcher, hash)
+  end
+  
+  def test_build_hash_for_json
+    assert @notif.build_hash_for_json
+  end
+  
+  def test_build_message_for_sending
+    assert(@notif.device.to_hex, "device.to_hex returns false")
+    assert(@notif.build_hash_for_json, "notification.build_hash_to_json returns false")
+    json = @notif.build_hash_for_json
+    message = "\0\0 #{@notif.device.to_hex}\0#{json.length.chr}#{json}"
+    assert_equal(@notif.build_message_for_sending, message)
+  end
+  
+  def test_sending_notifications_for_sent_at_nil
+    @notif.save
+    IOSPN::Notification.send_notifications
+    assert(@notif.sent_at, "Notification timestamp was not, has not been sent")
+  end
+  
+  
+end

data/test/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do
+    create_table :iospn_devices do |t|
+      t.text :token, :length => 100, :null => false
+      t.datetime :last_registered_at
+      t.timestamps
+    end
+    create_table :iospn_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.text :custom_properties
+      t.datetime :sent_at
+      t.timestamps
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'test/unit'
+require "yaml"
+require "logger"
+
+require File.dirname(__FILE__) + '/../init'
+ENV['RAILS_ENV'] = 'test'
+ 
+
+def clean_database!
+  models = [IOSPN::Notification, IOSPN::Device]
+  begin
+    models.each do |model|
+      ActiveRecord::Base.connection.execute "DROP TABLE #{model.table_name}"
+    end
+  rescue ActiveRecord::StatementInvalid
+  end
+end
+
+ 
+def load_schema!
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ 
+  db_adapter = ENV['DB']
+ 
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+ 
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+ 
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+
+  IOSPN.configure do |c|
+    c.notification[:cert] = File.join(Dir.pwd,"test", "apple_push_notification_development.pem")
+end
+
+
+
+  clean_database!
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+load_schema!

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: ios_push_notifications
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.5"
+platform: ruby
+authors: 
+- Seivan Heidari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+  type: :development
+  version_requirements: *id002
+description: Nicely documented Push Notification gem for rails 3 applications, has generators for migrations and an initializer with configuration. It is well documented and tested.... compared to other shitty forks out there >_>
+email: seivan@kth.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/ios_push_notifications_generator.rb
+- lib/generators/templates/device_migration.rb
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/notification_migration.rb
+- lib/ios_push_notifications/configuration.rb
+- lib/ios_push_notifications/device.rb
+- lib/ios_push_notifications/notification.rb
+- lib/ios_push_notifications.rb
+- test/apple_push_notification_development.pem
+- test/database.yml
+- test/debug.log
+- test/device_test.rb
+- test/ios_push_notifications_plugin.sqlite3.db
+- test/ios_push_notifications_test.rb
+- test/notification_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- CHANGELOG
+- Gemfile
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/seivan/ios_push_notifications
+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: 1.3.4
+requirements: []
+
+rubyforge_project: ios_push_notifications
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Push Notification gem for Rails 3 with proper tests and documentation
+test_files: []
+