rpush 2.3.2 → 2.4.0

data/lib/rpush/push.rb

@@ -2,6 +2,11 @@ module Rpush
   def self.push(options = {})
     require 'rpush/daemon'
 
+    unless options.empty?
+      warning = "Passing configuration options directly to Rpush.push is deprecated and will be removed from Rpush 2.5.0. Please setup configuration using Rpush.configure { |config| ... } before calling push."
+      Rpush::Deprecation.warn_with_backtrace(warning)
+    end
+
     config = Rpush::ConfigurationWithoutDefaults.new
     options.each { |k, v| config.send("#{k}=", v) }
     config.push = true

data/lib/rpush/version.rb

@@ -1,3 +1,3 @@
 module Rpush
-  VERSION = '2.3.2'
+  VERSION = '2.4.0'
 end

data/lib/tasks/quality.rake

@@ -3,7 +3,7 @@ begin
 
   desc 'Run cane to check quality metrics'
   Cane::RakeTask.new(:cane_quality) do |cane|
-    cane.add_threshold 'coverage/covered_percent', :>=, 95
+    cane.add_threshold 'coverage/covered_percent', :>=, 80
     cane.no_style = false
     cane.style_measure = 1000
     cane.no_doc = true

data/lib/tasks/test.rake

@@ -7,6 +7,11 @@ def cmd(str, clean_env = true)
   retval
 end
 
+def add_ruby_dot_files
+  cmd("echo '#{RUBY_ENGINE}-#{RUBY_VERSION}' > .ruby-version")
+  cmd("echo 'rpush_test' > .ruby-gemset")
+end
+
 desc 'Build Rails app bundled with Rpush'
 task :build_rails do
   rpush_root = Dir.pwd
@@ -20,10 +25,10 @@ task :build_rails do
 
   begin
     Dir.chdir(path)
+    add_ruby_dot_files
     cmd('echo "gem \'rake\'" >> Gemfile')
     cmd('echo "gem \'pg\'" >> Gemfile')
-    cmd("echo \"gem 'rpush', :path => '#{rpush_root}'\" >> Gemfile")
-    cmd('bundle install')
+    cmd("echo \"gem 'rpush', path: '#{rpush_root}'\" >> Gemfile")
 
     File.open('config/database.yml', 'w') do |fd|
       fd.write(<<-YML)
@@ -51,11 +56,11 @@ task :build_standalone do
 
   begin
     Dir.chdir(path)
+    add_ruby_dot_files
     cmd('echo "source \'https://rubygems.org\'" >> Gemfile')
     cmd('echo "gem \'rake\'" >> Gemfile')
     cmd('echo "gem \'rpush-redis\'" >> Gemfile')
-    cmd("echo \"gem 'rpush', :path => '#{rpush_root}'\" >> Gemfile")
-    cmd('bundle install')
+    cmd("echo \"gem 'rpush', path: '#{rpush_root}'\" >> Gemfile")
   ensure
     Dir.chdir(pwd)
   end

data/spec/functional/apns_spec.rb

@@ -55,7 +55,8 @@ describe 'APNs' do
   end
 
   def fail_notification(notification)
-    allow(ssl_socket).to receive_messages(read: [8, 4, notification.id].pack('ccN'))
+    id = (defined?(Mongoid) && notification.is_a?(Mongoid::Document)) ? notification.integer_id : notification.id
+    allow(ssl_socket).to receive_messages(read: [8, 4, id].pack('ccN'))
     enable_io_select
   end
 

data/spec/functional_spec_helper.rb

@@ -11,12 +11,12 @@ RSpec.configure do |config|
   config.before(:each) do
     Modis.with_connection do |redis|
       redis.keys('rpush:*').each { |key| redis.del(key) }
-    end
+    end if redis?
 
     Rpush.config.logger = ::Logger.new(STDOUT) if functional_example?(self.class.metadata)
   end
 
   config.after(:each) do
-    DatabaseCleaner.clean if functional_example?(self.class.metadata)
+    DatabaseCleaner.clean if active_record? && functional_example?(self.class.metadata)
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 ENV['RAILS_ENV'] = 'test'
-client = (ENV['CLIENT'] || :active_record).to_sym
+def client
+  (ENV['CLIENT'] || :active_record).to_sym
+end
 
 require 'bundler/setup'
 Bundler.require(:default)
@@ -21,7 +23,20 @@ require 'rpush/client/active_record'
 require 'rpush/daemon/store/active_record'
 require 'rpush/daemon/store/redis'
 
-require 'support/active_record_setup'
+def active_record?
+  client == :active_record
+end
+
+def redis?
+  client == :redis
+end
+
+def mongoid?
+  client == :mongoid
+end
+
+require 'support/mongoid_setup' if mongoid?
+require 'support/active_record_setup' if active_record?
 
 RPUSH_ROOT = '/tmp/rails_root'
 
@@ -31,10 +46,6 @@ end
 
 RPUSH_CLIENT = Rpush.config.client
 
-def active_record?
-  Rpush.config.client == :active_record
-end
-
 path = File.join(File.dirname(__FILE__), 'support')
 TEST_CERT = File.read(File.join(path, 'cert_without_password.pem'))
 TEST_CERT_WITH_PASSWORD = File.read(File.join(path, 'cert_with_password.pem'))
@@ -43,7 +54,7 @@ def after_example_cleanup
   Rpush.logger = nil
   Rpush::Daemon.store = nil
   Rpush::Deprecation.muted do
-    Rpush.config.set_defaults if Rpush.config.is_a?(Rpush::Configuration)
+    Rpush.config = nil
     Rpush.config.client = RPUSH_CLIENT
   end
   Rpush.plugins.values.each(&:unload)

data/spec/support/config/mongoid.yml

@@ -0,0 +1,69 @@
+development:
+  # Configure available database sessions. (required)
+  sessions:
+    # Defines the default session. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: rpush_development
+      # Provides the hosts the default session can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # Change the default write concern. (default = { w: 1 })
+        # write:
+        # w: 1
+
+        # Change the default consistency model to primary, secondary.
+        # 'secondary' will send reads to secondaries, 'primary' sends everything
+        # to master. (default: primary)
+        # read: secondary_preferred
+
+        # How many times Moped should attempt to retry an operation after
+        # failure. (default: The number of nodes in the cluster)
+        # max_retries: 20
+
+        # The time in seconds that Moped should wait before retrying an
+        # operation on failure. (default: 0.25)
+        # retry_interval: 0.25
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serialization. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    # preload_models: false
+
+    # Protect id and type from mass assignment. (default: true)
+    # protect_sensitive_fields: true
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    # raise_not_found_error: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Use Active Support's time zone in conversions. (default: true)
+    # use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    # use_utc: false
+test:
+  sessions:
+    default:
+      database: rpush_test
+      hosts:
+        - localhost:27017
+      options:
+        read: primary
+        # In the test environment we lower the retries and retry interval to
+        # low amounts for fast failures.
+        max_retries: 1
+        retry_interval: 0

data/spec/support/mongoid_setup.rb

@@ -0,0 +1,10 @@
+require 'mongoid'
+
+mongoid_yml = File.expand_path("config/mongoid.yml", File.dirname(__FILE__))
+Mongoid.load!(mongoid_yml)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Mongoid.purge!
+  end
+end

data/spec/unit/client/active_record/adm/app_spec.rb

@@ -55,4 +55,4 @@ describe Rpush::Client::ActiveRecord::Adm::App do
       expect(subject.access_token_expired?).to eq(false)
     end
   end
-end
+end if active_record?

data/spec/unit/client/active_record/adm/notification_spec.rb

@@ -40,4 +40,4 @@ describe Rpush::Client::ActiveRecord::Adm::Notification do
     notification.expiry = 100
     expect(notification.as_json['expiresAfter']).to eq 100
   end
-end
+end if active_record?

data/spec/unit/client/active_record/apns/app_spec.rb

@@ -26,4 +26,4 @@ describe Rpush::Client::ActiveRecord::App do
     app.valid?
     expect(app.errors[:certificate]).to eq ['value must contain a certificate and a private key.']
   end
-end
+end if active_record?

data/spec/unit/client/active_record/apns/feedback_spec.rb

@@ -6,4 +6,4 @@ describe Rpush::Client::ActiveRecord::Apns::Feedback do
     expect(notification.valid?).to be_falsey
     expect(notification.errors[:device_token]).to include('is invalid')
   end
-end
+end if active_record?

data/spec/unit/client/active_record/apns/notification_spec.rb

@@ -30,7 +30,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification do
   it "should default the expiry to 1 day" do
     expect(notification.expiry).to eq 1.day.to_i
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, "when assigning the device token" do
   it "should strip spaces from the given string" do
@@ -42,7 +42,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, "when assigning the de
     notification = Rpush::Client::ActiveRecord::Apns::Notification.new(device_token: "<omg>")
     expect(notification.device_token).to eq "omg"
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, "as_json" do
   it "should include the alert if present" do
@@ -92,7 +92,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, "as_json" do
     notification.data = { omg: { ilike: :hashes } }
     expect(notification.as_json["omg"]["ilike"]).to eq "hashes"
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, 'MDM' do
   let(:magic) { 'abc123' }
@@ -108,7 +108,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, 'MDM' do
     notification.mdm = magic
     expect(notification.as_json.key?('aps')).to be_falsey
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, 'content-available' do
   let(:notification) { Rpush::Client::ActiveRecord::Apns::Notification.new }
@@ -140,7 +140,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, 'content-available' do
     expect(notification.as_json['aps']['content-available']).to eq 1
     expect(notification.as_json['hi']).to eq 'mom'
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, 'url-args' do
   let(:notification) { Rpush::Client::ActiveRecord::Apns::Notification.new }
@@ -153,7 +153,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, 'url-args' do
   it 'does not include url-args in the payload if not set' do
     expect(notification.as_json['aps'].key?('url-args')).to be_falsey
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, 'category' do
   let(:notification) { Rpush::Client::ActiveRecord::Apns::Notification.new }
@@ -166,7 +166,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, 'category' do
   it 'does not include category in the payload if not set' do
     expect(notification.as_json['aps'].key?('category')).to be_falsey
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, 'to_binary' do
   let(:notification) { Rpush::Client::ActiveRecord::Apns::Notification.new }
@@ -206,7 +206,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, 'to_binary' do
     notification.app = Rpush::Client::ActiveRecord::Apns::App.new(name: 'my_app', environment: 'development', certificate: TEST_CERT)
     expect(notification.to_binary).to eq "\x02\x00\x00\x00\x99\x01\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\x02\x00a{\"aps\":{\"alert\":\"Don't panic Mr Mainwaring, don't panic!\",\"badge\":3,\"sound\":\"1.aiff\"},\"hi\":\"mom\"}\x03\x00\x04\x00\x00\x04\xD2\x04\x00\x04\x00\x01Q\x80\x05\x00\x01\n"
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, "bug #31" do
   it 'does not confuse a JSON looking string as JSON' do
@@ -221,7 +221,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, "bug #31" do
     notification.alert = "{\"one\":2}"
     expect(notification.alert).to eq('one' => 2)
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, "bug #35" do
   it "should limit payload size to 256 bytes but not the entire packet" do
@@ -235,7 +235,7 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, "bug #35" do
     expect(notification.payload.bytesize).to be < 256
     expect(notification).to be_valid
   end
-end
+end if active_record?
 
 describe Rpush::Client::ActiveRecord::Apns::Notification, "multi_json usage" do
   describe Rpush::Client::ActiveRecord::Apns::Notification, "alert" do
@@ -253,4 +253,4 @@ describe Rpush::Client::ActiveRecord::Apns::Notification, "multi_json usage" do
       notification.alert
     end
   end
-end
+end if active_record?

data/spec/unit/client/active_record/app_spec.rb

@@ -27,4 +27,4 @@ describe Rpush::Client::ActiveRecord::App do
       expect { app.valid? }.to raise_error(NameError)
     end
   end
-end
+end if active_record?

data/spec/unit/client/active_record/gcm/notification_spec.rb

@@ -31,4 +31,4 @@ describe Rpush::Client::ActiveRecord::Gcm::Notification do
     notification.expiry = 100
     expect(notification.as_json['time_to_live']).to eq 100
   end
-end
+end if active_record?

data/spec/unit/client/active_record/notification_spec.rb

@@ -18,4 +18,4 @@ describe Rpush::Client::ActiveRecord::Notification do
     expect(notification.app).to be_valid
     expect(notification).to be_valid
   end
-end
+end if active_record?

data/spec/unit/client/active_record/wpns/notification_spec.rb

@@ -18,4 +18,4 @@ describe Rpush::Client::ActiveRecord::Wpns::Notification do
     notification.valid?
     expect(notification.errors[:data]).to include("can't be blank")
   end
-end
+end if active_record?

data/spec/unit/configuration_spec.rb

@@ -43,4 +43,11 @@ describe Rpush::Configuration do
     Rpush.config.redis_options = { hi: :mom }
     expect(Modis.redis_options).to eq(hi: :mom)
   end
+
+  it 'deprecates feedback_poll=' do
+    expect(Rpush::Deprecation).to receive(:warn).with(/feedback_poll= is deprecated/)
+    expect do
+      Rpush.config.feedback_poll = 123
+    end.to change { Rpush.config.apns.feedback_receiver.frequency }.to(123)
+  end
 end

data/spec/unit/daemon/apns/feedback_receiver_spec.rb

@@ -4,7 +4,7 @@ require 'rpush/daemon/store/active_record'
 describe Rpush::Daemon::Apns::FeedbackReceiver, 'check_for_feedback' do
   let(:host) { 'feedback.push.apple.com' }
   let(:port) { 2196 }
-  let(:poll) { 60 }
+  let(:frequency) { 60 }
   let(:certificate) { double }
   let(:password) { double }
   let(:app) { double(name: 'my_app', password: password, certificate: certificate, environment: 'production') }
@@ -12,11 +12,11 @@ describe Rpush::Daemon::Apns::FeedbackReceiver, 'check_for_feedback' do
   let(:logger) { double(error: nil, info: nil) }
   let(:receiver) { Rpush::Daemon::Apns::FeedbackReceiver.new(app) }
   let(:feedback) { double }
-  let(:sleeper) { double(Rpush::Daemon::InterruptibleSleep, sleep: nil, start: nil, stop: nil) }
+  let(:sleeper) { double(Rpush::Daemon::InterruptibleSleep, sleep: nil, stop: nil) }
   let(:store) { double(Rpush::Daemon::Store::ActiveRecord, create_apns_feedback: feedback, release_connection: nil) }
 
   before do
-    Rpush.config.feedback_poll = poll
+    Rpush.config.apns.feedback_receiver.frequency = frequency
     allow(Rpush::Daemon::InterruptibleSleep).to receive_messages(new: sleeper)
     allow(Rpush).to receive_messages(logger: logger)
     allow(Rpush::Daemon::TcpConnection).to receive_messages(new: connection)
@@ -33,8 +33,8 @@ describe Rpush::Daemon::Apns::FeedbackReceiver, 'check_for_feedback' do
     end
   end
 
-  it 'initializes the sleeper with the feedback polling duration' do
-    expect(Rpush::Daemon::InterruptibleSleep).to receive(:new).with(poll).and_return(sleeper)
+  it 'initializes the sleeper with the feedback polling frequency' do
+    expect(Rpush::Daemon::InterruptibleSleep).to receive_messages(new: sleeper)
     Rpush::Daemon::Apns::FeedbackReceiver.new(app)
   end
 

data/spec/unit/daemon/feeder_spec.rb

@@ -4,7 +4,7 @@ describe Rpush::Daemon::Feeder do
   let!(:app) { Rpush::Apns::App.create!(name: 'my_app', environment: 'development', certificate: TEST_CERT) }
   let(:notification) { Rpush::Apns::Notification.create!(device_token: "a" * 64, app: app) }
   let(:logger) { double }
-  let(:interruptible_sleeper) { double(sleep: nil, stop: nil, start: nil) }
+  let(:interruptible_sleeper) { double(sleep: nil, stop: nil) }
   let(:store) { double(Rpush::Daemon::Store::ActiveRecord, deliverable_notifications: [notification], release_connection: nil) }
 
   before do
@@ -86,7 +86,7 @@ describe Rpush::Daemon::Feeder do
 
   describe 'wakeup' do
     it 'interrupts sleep' do
-      expect(interruptible_sleeper).to receive(:wakeup)
+      expect(interruptible_sleeper).to receive(:stop)
       Rpush::Daemon::Feeder.start
       Rpush::Daemon::Feeder.wakeup
     end

data/spec/unit/daemon/proc_title_spec.rb

@@ -0,0 +1,11 @@
+require 'unit_spec_helper'
+
+describe Rpush::Daemon::ProcTitle do
+  it 'sets the process title' do
+    Rpush.config.embedded = false
+    Rpush.config.push = false
+    allow(Rpush::Daemon::AppRunner).to receive_messages(total_dispatchers: 2, total_queued: 10)
+    expect(Process).to receive(:setproctitle).with('rpush | 10 queued | 2 dispatchers')
+    Rpush::Daemon::ProcTitle.update
+  end
+end