rapns 3.0.0-java

data/lib/rapns/gcm/notification.rb

@@ -0,0 +1,31 @@
+module Rapns
+  module Gcm
+    class Notification < Rapns::Notification
+      validates :registration_ids, :presence => true
+      validates_with Rapns::Gcm::ExpiryCollapseKeyMutualInclusionValidator
+      validates_with Rapns::Gcm::PayloadSizeValidator
+
+      def registration_ids=(ids)
+        ids = [ids] if ids && !ids.is_a?(Array)
+        super
+      end
+
+      def as_json
+        json = {
+          'registration_ids' => registration_ids,
+          'delay_while_idle' => delay_while_idle,
+          'data' => data
+        }
+
+        if collapse_key
+          json.merge!({
+            'collapse_key' => collapse_key,
+            'time_to_live' => expiry
+          })
+        end
+
+        json
+      end
+    end
+  end
+end

data/lib/rapns/gcm/payload_size_validator.rb

@@ -0,0 +1,13 @@
+module Rapns
+  module Gcm
+    class PayloadSizeValidator < ActiveModel::Validator
+      LIMIT = 4096
+
+      def validate(record)
+        if record.payload_size > LIMIT
+          record.errors[:base] << "GCM notification payload cannot be larger than #{LIMIT} bytes."
+        end
+      end
+    end
+  end
+end

data/lib/rapns/multi_json_helper.rb

@@ -0,0 +1,16 @@
+module Rapns
+  module MultiJsonHelper
+    def multi_json_load(string, options = {})
+      # Calling load on multi_json less than v1.3.0 attempts to load a file from disk.
+      if Gem.loaded_specs['multi_json'].version >= Gem::Version.create('1.3.0')
+        MultiJson.load(string, options)
+      else
+        MultiJson.decode(string, options)
+      end
+    end
+
+    def multi_json_dump(string, options = {})
+      MultiJson.respond_to?(:dump) ? MultiJson.dump(string, options) : MultiJson.encode(string, options)
+    end
+  end
+end

data/lib/rapns/notification.rb

@@ -0,0 +1,54 @@
+module Rapns
+  class Notification < ActiveRecord::Base
+    include Rapns::MultiJsonHelper
+
+    self.table_name = 'rapns_notifications'
+
+    # TODO: Dump using multi json.
+    serialize :registration_ids
+
+    belongs_to :app, :class_name => 'Rapns::App'
+
+    attr_accessible :badge, :device_token, :sound, :alert, :data, :expiry,:delivered,
+      :delivered_at, :failed, :failed_at, :error_code, :error_description, :deliver_after,
+      :alert_is_json, :app, :app_id, :collapse_key, :delay_while_idle, :registration_ids
+
+    validates :expiry, :numericality => true, :allow_nil => true
+    validates :app, :presence => true
+
+    scope :ready_for_delivery, lambda {
+      where('delivered = ? AND failed = ? AND (deliver_after IS NULL OR deliver_after < ?)',
+            false, false, Time.now)
+    }
+
+    scope :for_apps, lambda { |apps|
+      where(:app_id => apps.map(&:id))
+    }
+
+    def initialize(attributes = nil, options = {})
+      if attributes.is_a?(Hash) && attributes.keys.include?(:attributes_for_device)
+        msg = ":attributes_for_device via mass-assignment is deprecated. Use :data or the attributes_for_device= instance method."
+        ActiveSupport::Deprecation.warn(msg, caller(1))
+      end
+      super
+    end
+
+    def data=(attrs)
+      return unless attrs
+      raise ArgumentError, "must be a Hash" if !attrs.is_a?(Hash)
+      write_attribute(:data, multi_json_dump(attrs))
+    end
+
+    def data
+      multi_json_load(read_attribute(:data)) if read_attribute(:data)
+    end
+
+    def payload
+      multi_json_dump(as_json)
+    end
+
+    def payload_size
+      payload.bytesize
+    end
+  end
+end

data/lib/rapns/patches/rails/3.1.0/postgresql_adapter.rb

@@ -0,0 +1,12 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+      def clear_cache!
+        @statements.each_value do |value|
+          @connection.query "DEALLOCATE #{value}" if active?
+        end
+        @statements.clear
+      end
+    end
+  end
+end

data/lib/rapns/patches/rails/3.1.1/postgresql_adapter.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+      class StatementPool < ConnectionAdapters::StatementPool
+        def dealloc(key)
+          @connection.query "DEALLOCATE #{key}" if connection_active?
+        end
+
+        def connection_active?
+          @connection.status == PGconn::CONNECTION_OK
+        rescue PGError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rapns/patches.rb

@@ -0,0 +1,6 @@
+if Rails::VERSION::STRING == '3.1.0' || Rails::VERSION::STRING == '3.1.1'
+  if ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+    STDERR.puts "[WARNING] Detected Rails #{Rails::VERSION::STRING}, patching PostgreSQLAdapter to fix reconnection bug: https://github.com/rails/rails/issues/3160"
+    require "rapns/patches/rails/#{Rails::VERSION::STRING}/postgresql_adapter.rb"
+  end
+end

data/lib/rapns/version.rb

@@ -0,0 +1,3 @@
+module Rapns
+  VERSION = '3.0.0'
+end

data/lib/rapns.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'multi_json'
+
+require 'rapns/version'
+require 'rapns/multi_json_helper'
+require 'rapns/notification'
+require 'rapns/app'
+require 'rapns/configuration'
+
+require 'rapns/apns/binary_notification_validator'
+require 'rapns/apns/device_token_format_validator'
+require 'rapns/apns/required_fields_validator'
+require 'rapns/apns/notification'
+require 'rapns/apns/feedback'
+require 'rapns/apns/app'
+
+require 'rapns/gcm/expiry_collapse_key_mutual_inclusion_validator'
+require 'rapns/gcm/payload_size_validator'
+require 'rapns/gcm/notification'
+require 'rapns/gcm/app'
+

data/lib/tasks/cane.rake

@@ -0,0 +1,18 @@
+begin
+  require 'cane/rake_task'
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.add_threshold 'coverage/covered_percent', :>=, 99
+    cane.no_style = false
+    cane.style_measure = 1000
+    cane.no_doc = true
+    cane.abc_max = 20
+  end
+
+  namespace :spec do
+    task :cane => ['spec', 'quality']
+  end
+rescue LoadError
+  warn "cane not available, quality task not provided."
+end

data/lib/tasks/test.rake

@@ -0,0 +1,33 @@
+namespace :test do
+  task :build_rails do
+    require 'fileutils'
+
+    def cmd(str)
+      puts "* #{str}"
+      retval = Bundler.with_clean_env { `#{str}` }
+      puts retval.strip
+      retval
+    end
+
+    rapns_root = Dir.pwd
+    path = '/tmp/rails_test'
+    cmd("rm -rf #{path}")
+    FileUtils.mkdir_p(path)
+    pwd = Dir.pwd
+
+    cmd("bundle exec rails new #{path} --skip-bundle")
+
+    begin
+      Dir.chdir(path)
+      cmd('echo "gem \'rake\'" >> Gemfile')
+      cmd("echo \"gem 'rapns', :path => '#{rapns_root}'\" >> Gemfile")
+      cmd('bundle install')
+      cmd('bundle exec rails g rapns')
+      cmd('bundle exec rake db:migrate')
+    ensure
+      Dir.chdir(pwd)
+    end
+
+    puts "Built into #{path}"
+  end
+end

data/spec/acceptance/gcm_upgrade_spec.rb

@@ -0,0 +1,34 @@
+require 'acceptance_spec_helper'
+
+describe 'GCM upgrade' do
+  before do
+    setup_rails
+    generate
+    migrate('create_rapns_notifications', 'create_rapns_feedback',
+      'add_alert_is_json_to_rapns_notifications', 'add_app_to_rapns',
+      'create_rapns_apps')
+
+    as_test_rails_db do
+      now = Time.now.to_s(:db)
+      ActiveRecord::Base.connection.execute <<-SQL
+        INSERT INTO rapns_apps (key, environment, certificate, created_at, updated_at)
+          VALUES ('test', 'development', 'c3rt', '#{now}', '#{now}')
+      SQL
+
+      ActiveRecord::Base.connection.execute <<-SQL
+        INSERT INTO rapns_notifications (app, device_token, created_at, updated_at)
+          VALUES ('test', 't0k3n', '#{now}', '#{now}')
+      SQL
+    end
+
+    migrate('add_gcm')
+  end
+
+  it 'associates apps and notifications' do
+    as_test_rails_db do
+      app = Rapns::Apns::App.first
+      app.name.should == 'test'
+      app.notifications.count.should == 1
+    end
+  end
+end

data/spec/acceptance_spec_helper.rb

@@ -0,0 +1,85 @@
+require 'unit_spec_helper'
+require 'fileutils'
+
+ENV['RAILS_ENV'] = 'test'
+require 'bundler'
+Bundler.require(:default)
+
+TMP_DIR = '/tmp'
+RAILS_DIR = File.join(TMP_DIR, 'rapns_test')
+if ENV['TRAVIS']
+  TRAVIS_BRANCH = 'gcm'
+  RAPNS_ROOT = 'git://github.com/ileitch/rapns.git'
+else
+  RAPNS_ROOT = File.expand_path(__FILE__ + '/../../')
+end
+
+def setup_rails
+  return if $rails_is_setup
+  `rm -rf #{RAILS_DIR}`
+  FileUtils.mkdir_p(RAILS_DIR)
+  cmd("bundle exec rails new #{RAILS_DIR} --skip-bundle")
+  branch = `git branch | grep '\*'`.split(' ').last
+  in_test_rails do
+    cmd('echo "gem \'rake\'" >> Gemfile')
+    if ENV['TRAVIS']
+      cmd("echo \"gem 'rapns', :git => '#{RAPNS_ROOT}', :branch => '#{TRAVIS_BRANCH}'\" >> Gemfile")
+    else
+      cmd("echo \"gem 'rapns', :git => '#{RAPNS_ROOT}', :branch => '#{branch}'\" >> Gemfile")
+    end
+
+    cmd("bundle install")
+  end
+end
+
+def as_test_rails_db(env='development')
+  orig_config = ActiveRecord::Base.connection_config
+  begin
+    in_test_rails do
+      config = YAML.load_file('config/database.yml')
+      ActiveRecord::Base.establish_connection(config[env])
+      yield
+    end
+  ensure
+    ActiveRecord::Base.establish_connection(orig_config)
+  end
+end
+
+def cmd(str, echo = true)
+  puts "* #{str.strip}" if echo
+  retval = Bundler.with_clean_env { `#{str}` }
+  puts retval.strip if echo
+  retval
+end
+
+def generate
+  in_test_rails { cmd('bundle exec rails g rapns') }
+end
+
+def migrate(*migrations)
+  in_test_rails do
+    if migrations.present?
+      migrations.each do |name|
+        migration = Dir.entries('db/migrate').find { |entry| entry =~ /#{name}/ }
+        version = migration.split('_').first
+        cmd("bundle exec rake db:migrate VERSION=#{version} RAILS_ENV=development")
+      end
+    else
+      cmd('bundle exec rake db:migrate RAILS_ENV=development')
+    end
+  end
+end
+
+def in_test_rails
+  pwd = Dir.pwd
+  begin
+    Dir.chdir(RAILS_DIR)
+    yield
+  ensure
+    Dir.chdir(pwd)
+  end
+end
+
+def runner(str)
+  in_test_rails { cmd("rails runner -e test '#{str}'").strip }
+end

data/spec/support/simplecov_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+require './spec/support/simplecov_quality_formatter'
+
+module SimpleCovHelper
+  def start_simple_cov(name)
+    SimpleCov.start do
+      add_filter '/spec/'
+      add_filter '/lib/generators'
+      command_name name
+      formatter SimpleCov::Formatter::QualityFormatter
+    end
+  end
+end

data/spec/support/simplecov_quality_formatter.rb

@@ -0,0 +1,8 @@
+class SimpleCov::Formatter::QualityFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    File.open("coverage/covered_percent", "w") do |f|
+      f.puts result.source_files.covered_percent.to_f
+    end
+  end
+end

data/spec/unit/apns/app_spec.rb

@@ -0,0 +1,15 @@
+require 'unit_spec_helper'
+
+describe Rapns::App do
+  it 'does not validate an app with an invalid certificate' do
+    app = Rapns::Apns::App.new(:key => 'test', :environment => 'development', :certificate => 'foo')
+    app.valid?
+    app.errors[:certificate].should == ['Certificate value must contain a certificate and a private key.']
+  end
+
+  it 'validates a real certificate' do
+    app = Rapns::Apns::App.new :key => 'test', :environment => 'development', :certificate => TEST_CERT
+    app.valid?
+    app.errors[:certificate].should == []
+  end
+end

data/spec/unit/apns/feedback_spec.rb

@@ -0,0 +1,12 @@
+require "unit_spec_helper"
+
+describe Rapns::Apns::Feedback do
+  it { should validate_presence_of(:device_token) }
+  it { should validate_presence_of(:failed_at) }
+
+  it "should validate the format of the device_token" do
+    notification = Rapns::Apns::Feedback.new(:device_token => "{$%^&*()}")
+    notification.valid?.should be_false
+    notification.errors[:device_token].include?("is invalid").should be_true
+  end
+end

data/spec/unit/apns/notification_spec.rb

@@ -0,0 +1,198 @@
+require "unit_spec_helper"
+require 'unit/notification_shared.rb'
+
+describe Rapns::Apns::Notification do
+  it_should_behave_like 'an Notification subclass'
+
+  it { should validate_presence_of(:device_token) }
+  it { should validate_numericality_of(:badge) }
+
+  let(:notification_class) { Rapns::Apns::Notification }
+  let(:notification) { notification_class.new }
+  let(:data_setter) { 'attributes_for_device=' }
+  let(:data_getter) { 'attributes_for_device' }
+
+  it "should validate the format of the device_token" do
+    notification = Rapns::Apns::Notification.new(:device_token => "{$%^&*()}")
+    notification.valid?.should be_false
+    notification.errors[:device_token].include?("is invalid").should be_true
+  end
+
+  it "should validate the length of the binary conversion of the notification" do
+    notification.device_token = "a" * 64
+    notification.alert = "way too long!" * 100
+    notification.valid?.should be_false
+    notification.errors[:base].include?("APN notification cannot be larger than 256 bytes. Try condensing your alert and device attributes.").should be_true
+  end
+
+  it "should default the sound to 'default'" do
+    notification.sound.should eq('default')
+  end
+
+  it "should default the expiry to 1 day" do
+    notification.expiry.should == 1.day.to_i
+  end
+
+  # The notification must contain one of alert, sound or badge.
+  # @see https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html
+  it "should not be valid if there is none of alert,sound,badge present" do
+    notification.alert = nil
+    notification.sound = nil
+    notification.badge = nil
+    notification.valid?.should be_false
+    notification.errors[:base].should include("APN Notification must contain one of alert, badge, or sound")
+  end
+end
+
+describe Rapns::Apns::Notification, "when assigning the device token" do
+  it "should strip spaces from the given string" do
+    notification = Rapns::Apns::Notification.new(:device_token => "o m g")
+    notification.device_token.should == "omg"
+  end
+
+  it "should strip chevrons from the given string" do
+    notification = Rapns::Apns::Notification.new(:device_token => "<omg>")
+    notification.device_token.should == "omg"
+  end
+end
+
+describe Rapns::Apns::Notification, "as_json" do
+  it "should include the alert if present" do
+    notification = Rapns::Apns::Notification.new(:alert => "hi mom")
+    notification.as_json["aps"]["alert"].should == "hi mom"
+  end
+
+  it "should not include the alert key if the alert is not present" do
+    notification = Rapns::Apns::Notification.new(:alert => nil)
+    notification.as_json["aps"].key?("alert").should be_false
+  end
+
+  it "should encode the alert as JSON if it is a Hash" do
+    notification = Rapns::Apns::Notification.new(:alert => { 'body' => "hi mom", 'alert-loc-key' => "View" })
+    notification.as_json["aps"]["alert"].should == { 'body' => "hi mom", 'alert-loc-key' => "View" }
+  end
+
+  it "should include the badge if present" do
+    notification = Rapns::Apns::Notification.new(:badge => 6)
+    notification.as_json["aps"]["badge"].should == 6
+  end
+
+  it "should not include the badge key if the badge is not present" do
+    notification = Rapns::Apns::Notification.new(:badge => nil)
+    notification.as_json["aps"].key?("badge").should be_false
+  end
+
+  it "should include the sound if present" do
+    notification = Rapns::Apns::Notification.new(:alert => "my_sound.aiff")
+    notification.as_json["aps"]["alert"].should == "my_sound.aiff"
+  end
+
+  it "should not include the sound key if the sound is not present" do
+    notification = Rapns::Apns::Notification.new(:sound => false)
+    notification.as_json["aps"].key?("sound").should be_false
+  end
+
+  it "should include attributes for the device" do
+    notification = Rapns::Apns::Notification.new
+    notification.attributes_for_device = {:omg => :lol, :wtf => :dunno}
+    notification.as_json["omg"].should == "lol"
+    notification.as_json["wtf"].should == "dunno"
+  end
+end
+
+describe Rapns::Apns::Notification, 'MDM' do
+  let(:magic) { 'abc123' }
+  let(:notification) { Rapns::Apns::Notification.new }
+
+  it 'includes the mdm magic in the payload' do
+    notification.mdm = magic
+    notification.as_json.should == {'mdm' => magic}
+  end
+
+  it 'does not include aps attribute' do
+    notification.alert = "i'm doomed"
+    notification.mdm = magic
+    notification.as_json.key?('aps').should be_false
+  end
+end
+
+describe Rapns::Apns::Notification, 'content-available' do
+  let(:notification) { Rapns::Apns::Notification.new }
+
+  it 'includes content-available in the payload' do
+    notification.content_available = true
+    notification.as_json['aps']['content-available'].should == 1
+  end
+
+  it 'does not include content-available in the payload if not set' do
+    notification.as_json['aps'].key?('content-available').should be_false
+  end
+
+  it 'does not include convert-available as a non-aps attribute' do
+    notification.content_available = true
+    notification.as_json.key?('content-available').should be_false
+  end
+end
+
+describe Rapns::Apns::Notification, "to_binary" do
+  it "should correctly convert the notification to binary" do
+    notification = Rapns::Apns::Notification.new
+    notification.device_token = "a" * 64
+    notification.sound = "1.aiff"
+    notification.badge = 3
+    notification.alert = "Don't panic Mr Mainwaring, don't panic!"
+    notification.attributes_for_device = {:hi => :mom}
+    notification.expiry = 86400 # 1 day, \x00\x01Q\x80
+    notification.app = Rapns::Apns::App.create!(:name => 'my_app', :environment => 'development', :certificate => TEST_CERT)
+    notification.save!
+    notification.stub(:id).and_return(1234)
+    notification.to_binary.should == "\x01\x00\x00\x04\xD2\x00\x01Q\x80\x00 \xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\x00a{\"aps\":{\"alert\":\"Don't panic Mr Mainwaring, don't panic!\",\"badge\":3,\"sound\":\"1.aiff\"},\"hi\":\"mom\"}"
+  end
+end
+
+describe Rapns::Apns::Notification, "bug #31" do
+  it 'does not confuse a JSON looking string as JSON' do
+    notification = Rapns::Apns::Notification.new
+    notification.alert = "{\"one\":2}"
+    notification.alert.should == "{\"one\":2}"
+  end
+
+  it 'does confuse a JSON looking string as JSON if the alert_is_json attribute is not present' do
+    notification = Rapns::Apns::Notification.new
+    notification.stub(:has_attribute? => false)
+    notification.alert = "{\"one\":2}"
+    notification.alert.should == {"one" => 2}
+  end
+end
+
+describe Rapns::Apns::Notification, "bug #35" do
+  it "should limit payload size to 256 bytes but not the entire packet" do
+    notification = Rapns::Apns::Notification.new do |n|
+      n.device_token = "a" * 64
+      n.alert = "a" * 210
+      n.app = Rapns::Apns::App.create!(:name => 'my_app', :environment => 'development', :certificate => TEST_CERT)
+    end
+
+    notification.to_binary(:for_validation => true).bytesize.should > 256
+    notification.payload_size.should < 256
+    notification.should be_valid
+  end
+end
+
+describe Rapns::Apns::Notification, "multi_json usage" do
+  describe Rapns::Apns::Notification, "alert" do
+    it "should call MultiJson.load when multi_json version is 1.3.0" do
+      notification = Rapns::Apns::Notification.new(:alert => { :a => 1 }, :alert_is_json => true)
+      Gem.stub(:loaded_specs).and_return( { 'multi_json' => Gem::Specification.new('multi_json', '1.3.0') } )
+      MultiJson.should_receive(:load).with(any_args())
+      notification.alert
+    end
+
+    it "should call MultiJson.decode when multi_json version is 1.2.9" do
+      notification = Rapns::Apns::Notification.new(:alert => { :a => 1 }, :alert_is_json => true)
+      Gem.stub(:loaded_specs).and_return( { 'multi_json' => Gem::Specification.new('multi_json', '1.2.9') } )
+      MultiJson.should_receive(:decode).with(any_args())
+      notification.alert
+    end
+  end
+end

data/spec/unit/app_spec.rb

@@ -0,0 +1,18 @@
+require "unit_spec_helper"
+
+describe Rapns::App do
+  it { should validate_numericality_of(:connections) }
+
+  it 'validates the uniqueness of name within type and environment' do
+    Rapns::Apns::App.create!(:name => 'test', :environment => 'production', :certificate => TEST_CERT)
+    app = Rapns::Apns::App.new(:name => 'test', :environment => 'production', :certificate => TEST_CERT)
+    app.valid?.should be_false
+    app.errors[:name].should == ['has already been taken']
+
+    app = Rapns::Apns::App.new(:name => 'test', :environment => 'development', :certificate => TEST_CERT)
+    app.valid?.should be_true
+
+    app = Rapns::Gcm::App.new(:name => 'test', :environment => 'production', :auth_key => TEST_CERT)
+    app.valid?.should be_true
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,38 @@
+require 'unit_spec_helper'
+
+describe Rapns do
+  let(:config) { stub }
+
+  before { Rapns.stub(:config => config) }
+
+  it 'can yields a config block' do
+    expect { |b| Rapns.configure(&b) }.to yield_with_args(config)
+  end
+end
+
+describe Rapns::Configuration do
+  let(:config) { Rapns::Configuration.new }
+
+  it 'configures a feedback callback' do
+    b = Proc.new {}
+    config.on_apns_feedback(&b)
+    config.apns_feedback_callback.should == b
+  end
+
+  it 'can be updated' do
+    new_config = Rapns::Configuration.new
+    new_config.batch_size = 100
+    expect { config.update(new_config) }.to change(config, :batch_size).to(100)
+  end
+
+  it 'sets the pid_file relative if not absolute' do
+    Rails.stub(:root => '/rails')
+    config.pid_file = 'tmp/rapns.pid'
+    config.pid_file.should == '/rails/tmp/rapns.pid'
+  end
+
+  it 'does not alter an absolute pid_file path' do
+    config.pid_file = '/tmp/rapns.pid'
+    config.pid_file.should == '/tmp/rapns.pid'
+  end
+end