jirapong-apn_on_rails 0.4.4

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler'
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/apn_on_rails.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "apn_on_rails/version"
+
+Gem::Specification.new do |s|
+  s.name          = %q{jirapong-apn_on_rails}
+  s.version       = ApnOnRails::VERSION
+  s.authors       = ["markbates", "Rebecca Nesson"]
+  s.email         = %q{tech-team@prx.org}
+  s.homepage      = %q{http://github.com/PRX/apn_on_rails}
+  s.summary       = %q{Apple Push Notifications on Rails}
+  s.description   = %q{APN on Rails is a Ruby on Rails gem that allows you to
+  easily add Apple Push Notification (iPhone) support to your Rails application.
+  }
+
+  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"]
+
+  s.add_runtime_dependency('configatron')
+  s.add_runtime_dependency('activerecord')
+  s.add_runtime_dependency('actionpack')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('autotest')
+  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rcov')
+end
+

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/generators/apn_migrations_generator.rb

@@ -0,0 +1,33 @@
+require 'rails_generator'
+require 'rails/generators/migration'
+# 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
+  desc "Generates the migrations necessary for APN on Rails."
+
+  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/templates/apn_migrations/001_create_apn_devices.rb

@@ -0,0 +1,13 @@
+class CreateApnDevices < ActiveRecord::Migration # :nodoc:
+  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/generators/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.timestamps
+    end
+    
+    add_index :apn_notifications, :device_id
+  end
+
+  def self.down
+    drop_table :apn_notifications
+  end
+  
+end

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

@@ -0,0 +1,23 @@
+class AlterApnDevices < ActiveRecord::Migration # :nodoc:
+  
+  module APN # :nodoc:
+    class Device < ActiveRecord::Base # :nodoc:
+      set_table_name 'apn_devices'
+    end
+  end
+  
+  def self.up
+    add_column :apn_devices, :last_registered_at, :datetime
+    
+    execute 'update apn_devices set last_registered_at = created_at'
+
+    change_column :apn_devices, :token, :string, :size => 100, :null => false
+    add_index :apn_devices, :token, :unique => true
+  end
+
+  def self.down
+    change_column :apn_devices, :token, :string
+    remove_index :apn_devices, :column => :token
+    remove_column :apn_devices, :last_registered_at
+  end
+end

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

@@ -0,0 +1,25 @@
+class CreateApnApps < ActiveRecord::Migration # :nodoc:
+
+  module APN # :nodoc:
+    class Device < ActiveRecord::Base # :nodoc:
+      set_table_name 'apn_devices'
+    end
+  end
+
+  def self.up
+    create_table :apn_apps do |t|
+      t.text :apn_dev_cert
+      t.text :apn_prod_cert
+
+      t.timestamps
+    end
+
+    add_column :apn_devices, :app_id, :integer
+    
+  end
+
+  def self.down
+    drop_table :apn_apps
+    remove_column :apn_devices, :app_id
+  end
+end

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

@@ -0,0 +1,23 @@
+class CreateGroups < ActiveRecord::Migration # :nodoc:
+  def self.up
+    create_table :apn_groups do |t|
+      t.column :name, :string
+    
+      t.timestamps
+    end
+    
+    create_table :apn_devices_apn_groups, :id => false do |t|
+      t.column :group_id, :integer
+      t.column :device_id, :integer
+    end
+    
+    add_index :apn_devices_apn_groups, [:group_id, :device_id]
+    add_index :apn_devices_apn_groups, :device_id
+    add_index :apn_devices_apn_groups, :group_id
+  end 
+  
+  def self.down
+    drop_table :apn_groups
+    drop_table :apn_devices_apn_groups
+  end
+end

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

@@ -0,0 +1,11 @@
+class AlterApnGroups < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+    add_column :apn_groups, :app_id, :integer
+  end
+
+  def self.down
+    remove_column :apn_groups, :app_id
+  end
+  
+end

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

@@ -0,0 +1,27 @@
+class CreateDeviceGroups < ActiveRecord::Migration # :nodoc:
+  def self.up
+    drop_table :apn_devices_apn_groups
+    
+    create_table :apn_device_groupings do |t|
+      t.column :group_id, :integer
+      t.column :device_id, :integer
+    end
+    
+    add_index :apn_device_groupings, [:group_id, :device_id]
+    add_index :apn_device_groupings, :device_id
+    add_index :apn_device_groupings, :group_id
+  end 
+  
+  def self.down
+    drop_table :apn_device_groupings
+  
+    create_table :apn_devices_apn_groups, :id => false do |t|
+      t.column :group_id, :integer
+      t.column :device_id, :integer
+    end
+    
+    add_index :apn_devices_apn_groups, [:group_id, :device_id]
+    add_index :apn_devices_apn_groups, :device_id
+    add_index :apn_devices_apn_groups, :group_id
+  end
+end

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

@@ -0,0 +1,23 @@
+class CreateApnGroupNotifications < ActiveRecord::Migration # :nodoc:
+  
+  def self.up
+
+    create_table :apn_group_notifications do |t|
+      t.integer :group_id, :null => false
+      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 :apn_group_notifications, :group_id
+  end
+
+  def self.down
+    drop_table :apn_group_notifications
+  end
+  
+end

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

@@ -0,0 +1,16 @@
+class CreatePullNotifications < ActiveRecord::Migration
+  def self.up
+    create_table :apn_pull_notifications do |t|
+      t.integer :app_id
+      t.string  :title
+      t.string  :content
+      t.string  :link
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :apn_pull_notifications
+  end
+end

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

@@ -0,0 +1,21 @@
+class AlterApnNotifications < ActiveRecord::Migration # :nodoc:
+  
+  module APN # :nodoc:
+    class Notification < ActiveRecord::Base # :nodoc:
+      set_table_name 'apn_notifications'
+    end
+  end
+  
+  def self.up
+    # unless APN::Notification.column_names.include?("custom_properties")
+      add_column(:apn_notifications, :custom_properties, :text) rescue nil
+    # end
+  end
+
+  def self.down
+    # if APN::Notification.column_names.include?("custom_properties")
+      remove_column(:apn_notifications, :custom_properties) rescue nil
+    # end
+  end
+  
+end

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

@@ -0,0 +1,11 @@
+class MakeDeviceTokenIndexNonunique < ActiveRecord::Migration
+  def self.up
+    remove_index :apn_devices, :column => :token
+    add_index :apn_devices, :token
+  end
+
+  def self.down
+    remove_index :apn_devices, :column => :token
+    add_index :apn_devices, :token, :unique => true
+  end
+end

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

@@ -0,0 +1,9 @@
+class AddLaunchNotificationToApnPullNotifications < ActiveRecord::Migration
+  def self.up
+    add_column :apn_pull_notifications, :launch_notification, :boolean
+  end
+
+  def self.down
+    remove_column :apn_pull_notifications, :launch_notification
+  end
+end

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/apn_on_rails.rb

@@ -0,0 +1,81 @@
+require 'socket'
+require 'openssl'
+require 'configatron'
+
+rails_root = File.join(FileUtils.pwd, 'rails_root')
+if defined?(Rails.root)
+  rails_root = Rails.root.to_s
+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.feedback.set_default(:passphrase, configatron.apn.passphrase)
+configatron.apn.feedback.set_default(:port, 2196)
+
+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'))
+
+  configatron.apn.feedback.set_default(:host, 'feedback.push.apple.com')
+  configatron.apn.feedback.set_default(:cert, configatron.apn.cert)
+else
+  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'))
+
+  configatron.apn.feedback.set_default(:host, 'feedback.sandbox.push.apple.com')
+  configatron.apn.feedback.set_default(:cert, configatron.apn.cert)
+end
+
+module APN # :nodoc:
+
+  module Errors # :nodoc:
+
+    # Raised when a notification message to Apple is longer than 256 bytes.
+    class ExceededMessageSizeError < StandardError
+
+      def initialize(message) # :nodoc:
+        super("The maximum size allowed for a notification payload is 256 bytes: '#{message}'")
+      end
+
+    end
+
+    class MissingCertificateError < StandardError
+      def initialize
+        super("This app has no certificate")
+      end
+    end
+
+  end # Errors
+
+end # APN
+
+base = File.join(File.dirname(__FILE__), 'app', 'models', 'apn', 'base.rb')
+require base
+
+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}"
+  begin
+    if ActiveSupport::Dependencies.respond_to? :autoload_paths
+      ActiveSupport::Dependencies.autoload_paths << path
+      ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+    else
+      ActiveSupport::Dependencies.load_paths << path
+      ActiveSupport::Dependencies.load_once_paths.delete(path)
+    end
+  rescue NameError
+    Dependencies.load_paths << path
+    Dependencies.load_once_paths.delete(path)
+  end
+end