rpush 4.2.0 → 7.0.1

data/lib/rpush/daemon.rb

@@ -68,6 +68,9 @@ require 'rpush/daemon/adm'
 require 'rpush/daemon/pushy'
 require 'rpush/daemon/pushy/delivery'
 
+require 'rpush/daemon/webpush/delivery'
+require 'rpush/daemon/webpush'
+
 module Rpush
   module Daemon
     class << self
@@ -109,7 +112,7 @@ module Rpush
         Feeder.stop
         AppRunner.stop
         delete_pid_file
-        puts Rainbow('✔').red if Rpush.config.foreground
+        puts Rainbow('✔').red if Rpush.config.foreground && Rpush.config.foreground_logging
       end
     end
 

data/lib/rpush/logger.rb

@@ -69,7 +69,7 @@ module Rpush
         msg = "#{msg.class.name}, #{msg.message}\n#{formatted_backtrace}"
       end
 
-      formatted_msg = "[#{Time.now.to_s(:db)}] "
+      formatted_msg = "[#{Time.now.to_formatted_s(:db)}]"
       formatted_msg << '[rpush] ' if Rpush.config.embedded
       formatted_msg << "[#{prefix}] " if prefix
       formatted_msg << msg
@@ -79,6 +79,7 @@ module Rpush
     end
 
     def log_foreground(io, formatted_msg, inline)
+      return unless Rpush.config.foreground_logging
       return unless io == STDERR || Rpush.config.foreground
 
       if inline

data/lib/rpush/version.rb

@@ -1,8 +1,8 @@
 module Rpush
   module VERSION
-    MAJOR = 4
-    MINOR = 2
-    TINY = 0
+    MAJOR = 7
+    MINOR = 0
+    TINY = 1
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/spec/functional/apns2_spec.rb

@@ -42,6 +42,7 @@ describe 'APNs http2 adapter' do
     app.certificate = TEST_CERT
     app.name = 'test'
     app.environment = 'development'
+    app.bundle_id = 'com.example.app'
     app.save!
     app
   end
@@ -75,7 +76,13 @@ describe 'APNs http2 adapter' do
         :post,
         "/3/device/#{fake_device_token}",
         { body: "{\"aps\":{\"alert\":\"test\",\"sound\":\"default\",\"content-available\":1}}",
-          headers: {} }
+          headers: {
+            'apns-expiration' => '0',
+            'apns-priority' => '10',
+            'apns-topic' => 'com.example.app',
+            'apns-push-type' => 'background'
+          }
+        }
       )
       .and_return(fake_http2_request)
 
@@ -104,7 +111,12 @@ describe 'APNs http2 adapter' do
           "/3/device/#{fake_device_token}",
           { body: "{\"aps\":{\"alert\":\"test\",\"sound\":\"default\","\
                   "\"content-available\":1},\"some_field\":\"some value\"}",
-            headers: { 'apns-topic' => bundle_id }
+            headers: {
+              'apns-topic' => bundle_id,
+              'apns-expiration' => '0',
+              'apns-priority' => '10',
+              'apns-push-type' => 'background'
+            }
           }
         ).and_return(fake_http2_request)
 
@@ -177,6 +189,13 @@ describe 'APNs http2 adapter' do
     end
 
     context 'when there is SocketError' do
+      let(:fake_http_resp_headers) {
+        {
+          ":status" => "500",
+          "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+        }
+      }
+
       before(:each) do
         expect(fake_client).to receive(:call_async) { raise(SocketError) }
       end
@@ -201,6 +220,24 @@ describe 'APNs http2 adapter' do
         notification = create_notification
         Rpush.push
       end
+
+      context 'when specific notification was delivered before request failed' do
+        let(:fake_http_resp_headers) {
+          {
+            ":status" => "200",
+            "apns-id"=>"C6D65840-5E3F-785A-4D91-B97D305C12F6"
+          }
+        }
+
+        it 'fails but will not retry this notification' do
+          notification = create_notification
+          expect do
+            Rpush.push
+            notification.reload
+          end.to change(notification, :retries).by(0)
+             .and change(notification, :delivered).to(true)
+        end
+      end
     end
 
     context 'when any StandardError occurs' do
@@ -228,5 +265,65 @@ describe 'APNs http2 adapter' do
         Rpush.push
       end
     end
+
+    context 'when waiting for requests to complete times out' do
+      let(:on_close) do
+        proc { |&block| @thread = Thread.new { sleep(0.01) } }
+      end
+
+      before(:each) do
+        @thread = nil
+
+        expect(fake_http2_request).
+          to receive(:on).with(:close), &on_close
+
+        expect(fake_client).to receive(:join) { @thread.join; raise(NetHttp2::AsyncRequestTimeout) }
+      end
+
+      it 'closes the client' do
+        create_notification
+        expect(fake_client).to receive(:close)
+        Rpush.push
+      end
+
+      it 'reflects :error' do
+        reflected_error = false
+        Rpush.reflect do |on|
+          on.error do |error|
+            reflected_error = true
+            expect(error).to be_kind_of(StandardError)
+            reflector.accept
+          end
+        end
+
+        notification = create_notification
+        Rpush.push
+
+        expect(reflected_error).to be true
+      end
+
+      it 'fails but retries delivery several times' do
+        notification = create_notification
+        expect do
+          Rpush.push
+          notification.reload
+        end.to change(notification, :retries)
+      end
+
+      context 'when specific notification was delivered before another async call failed' do
+        let(:on_close) do
+          proc { |&block| @thread = Thread.new { sleep(0.01); block.call } }
+        end
+
+        it 'fails but retries delivery several times' do
+          notification = create_notification
+          expect do
+            Rpush.push
+            notification.reload
+          end.to change(notification, :retries).by(0)
+             .and change(notification, :delivered).to(true)
+        end
+      end
+    end
   end
 end

data/spec/functional/gcm_priority_spec.rb

@@ -0,0 +1,40 @@
+require 'functional_spec_helper'
+
+describe 'GCM priority' do
+  let(:app) { Rpush::Gcm::App.new }
+  let(:notification) { Rpush::Gcm::Notification.new }
+  let(:hydrated_notification) { Rpush::Gcm::Notification.find(notification.id) }
+  let(:response) { double(Net::HTTPResponse, code: 200) }
+  let(:http) { double(Net::HTTP::Persistent, request: response, shutdown: nil) }
+  let(:priority) { 'normal' }
+
+  before do
+    app.name = 'test'
+    app.auth_key = 'abc123'
+    app.save!
+
+    notification.app_id = app.id
+    notification.registration_ids = ['foo']
+    notification.data = { message: 'test' }
+    notification.priority = priority
+    notification.save!
+
+    allow(Net::HTTP::Persistent).to receive_messages(new: http)
+  end
+
+  it 'supports normal priority' do
+    expect(hydrated_notification.as_json['priority']).to eq('normal')
+  end
+
+  context 'high priority' do
+    let(:priority) { 'high' }
+
+    it 'supports high priority' do
+      expect(hydrated_notification.as_json['priority']).to eq('high')
+    end
+  end
+
+  it 'does not add an error when receiving expected priority' do
+    expect(hydrated_notification.errors.messages[:priority]).to be_empty
+  end
+end

data/spec/functional/retry_spec.rb

@@ -39,4 +39,4 @@ describe 'Retries' do
     notification.reload
     expect(notification.delivered).to eq(false)
   end
-end
+end if redis?

data/spec/functional/webpush_spec.rb

@@ -0,0 +1,31 @@
+require 'functional_spec_helper'
+
+describe 'Webpush' do
+  let(:code) { 201 }
+  let(:response) { instance_double('Net::HTTPResponse', code: code, body: '') }
+  let(:http) { instance_double('Net::HTTP::Persistent', request: response, shutdown: nil) }
+  let(:app) { Rpush::Webpush::App.create!(name: 'MyApp', vapid_keypair: VAPID_KEYPAIR) }
+
+  let(:device_reg) {
+    { endpoint: 'https://webpush-provider.example.org/push/some-id',
+      expirationTime: nil,
+      keys: {'auth' => 'DgN9EBia1o057BdhCOGURA', 'p256dh' => 'BAtxJ--7vHq9IVm8utUB3peJ4lpxRqk1rukCIkVJOomS83QkCnrQ4EyYQsSaCRgy_c8XPytgXxuyAvRJdnTPK4A'} }
+  }
+  let(:notification) { Rpush::Webpush::Notification.create!(app: app, registration_ids: [device_reg], data: { message: 'test' }) }
+
+  before do
+    allow(Net::HTTP::Persistent).to receive_messages(new: http)
+  end
+
+  it 'deliveres a notification successfully' do
+    expect { Rpush.push }.to change { notification.reload.delivered }.to(true)
+  end
+
+  context 'when delivery failed' do
+    let(:code) { 404 }
+    it 'marks a notification as failed' do
+      expect { Rpush.push }.to change { notification.reload.failed }.to(true)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ def client
   (ENV['CLIENT'] || :active_record).to_sym
 end
 
-if !ENV['TRAVIS'] || (ENV['TRAVIS'] && ENV['QUALITY'] == 'true')
+if !ENV['CI'] || (ENV['CI'] && ENV['QUALITY'] == 'true')
   begin
     require './spec/support/simplecov_helper'
     include SimpleCovHelper
@@ -46,6 +46,8 @@ 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'))
 
+VAPID_KEYPAIR = Webpush.generate_key.to_hash.merge(subject: 'rpush-test@example.org').to_json
+
 def after_example_cleanup
   Rpush.logger = nil
   Rpush::Daemon.store = nil

data/spec/support/active_record_setup.rb

@@ -6,14 +6,15 @@ SPEC_ADAPTER = ENV['ADAPTER'] || 'postgresql'
 SPEC_ADAPTER = 'jdbc' + SPEC_ADAPTER if jruby
 
 require 'yaml'
-db_config = YAML.load_file(File.expand_path("config/database.yml", File.dirname(__FILE__)))
+db_config_path = File.expand_path("config/database.yml", File.dirname(__FILE__))
+db_config = YAML.load(ERB.new(File.read(db_config_path)).result)
 
 if db_config[SPEC_ADAPTER].nil?
   puts "No such adapter '#{SPEC_ADAPTER}'. Valid adapters are #{db_config.keys.join(', ')}."
   exit 1
 end
 
-if ENV['TRAVIS']
+if ENV['CI']
   db_config[SPEC_ADAPTER]['username'] = 'postgres'
 else
   require 'etc'
@@ -62,7 +63,7 @@ migrations = [
   Rpush420Updates
 ]
 
-unless ENV['TRAVIS']
+unless ENV['CI']
   migrations.reverse_each do |m|
     begin
       m.down

data/spec/support/config/database.yml

@@ -2,10 +2,10 @@
 
 postgresql:
   adapter: postgresql
-  database: rpush_test
-  host: localhost
-  username: postgres
-  password: ""
+  database: <%= ENV.fetch('POSTGRES_DB', 'rpush_test') %>
+  host: <%= ENV.fetch('POSTGRES_HOST', 'localhost') %>
+  username: <%= ENV.fetch('POSTGRES_USER', 'postgres') %>
+  password: <%= ENV.fetch('PGPASSWORD', '') %>
 
 jdbcpostgresql:
   adapter: jdbcpostgresql

data/spec/support/simplecov_helper.rb

@@ -10,7 +10,7 @@ module SimpleCovHelper
 
       formatters = [SimpleCov::Formatter::QualityFormatter]
 
-      if ENV['TRAVIS']
+      if ENV['CI']
         require 'codeclimate-test-reporter'
 
         if CodeClimate::TestReporter.run?
@@ -18,7 +18,7 @@ module SimpleCovHelper
         end
       end
 
-      formatter SimpleCov::Formatter::MultiFormatter[*formatters]
+      formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
     end
   end
 end

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

@@ -1,58 +1,6 @@
 require 'unit_spec_helper'
 
 describe Rpush::Client::ActiveRecord::Adm::App do
-  subject { Rpush::Client::ActiveRecord::Adm::App.new(name: 'test', environment: 'development', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
-  let(:existing_app) { Rpush::Client::ActiveRecord::Adm::App.create!(name: 'existing', environment: 'development', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
-
-  it 'should be valid if properly instantiated' do
-    expect(subject).to be_valid
-  end
-
-  it 'should be invalid if name' do
-    subject.name = nil
-    expect(subject).not_to be_valid
-    expect(subject.errors[:name]).to eq ["can't be blank"]
-  end
-
-  it 'should be invalid if name is not unique within scope' do
-    subject.name = existing_app.name
-    expect(subject).not_to be_valid
-    expect(subject.errors[:name]).to eq ["has already been taken"]
-  end
-
-  it 'should be invalid if missing client_id' do
-    subject.client_id = nil
-    expect(subject).not_to be_valid
-    expect(subject.errors[:client_id]).to eq ["can't be blank"]
-  end
-
-  it 'should be invalid if missing client_secret' do
-    subject.client_secret = nil
-    expect(subject).not_to be_valid
-    expect(subject.errors[:client_secret]).to eq ["can't be blank"]
-  end
-
-  describe '#access_token_expired?' do
-    before(:each) do
-      Timecop.freeze(Time.now)
-    end
-
-    after do
-      Timecop.return
-    end
-
-    it 'should return true if access_token_expiration is nil' do
-      expect(subject.access_token_expired?).to eq(true)
-    end
-
-    it 'should return true if expired' do
-      subject.access_token_expiration = Time.now - 5.minutes
-      expect(subject.access_token_expired?).to eq(true)
-    end
-
-    it 'should return false if not expired' do
-      subject.access_token_expiration = Time.now + 5.minutes
-      expect(subject.access_token_expired?).to eq(false)
-    end
-  end
+  it_behaves_like 'Rpush::Client::Adm::App'
+  it_behaves_like 'Rpush::Client::ActiveRecord::App'
 end if active_record?

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

@@ -1,43 +1,6 @@
 require 'unit_spec_helper'
-require 'unit/notification_shared.rb'
 
 describe Rpush::Client::ActiveRecord::Adm::Notification do
-  it_should_behave_like 'an Notification subclass'
-
-  let(:app) { Rpush::Client::ActiveRecord::Adm::App.create!(name: 'test', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
-  let(:notification_class) { Rpush::Client::ActiveRecord::Adm::Notification }
-  let(:notification) { notification_class.new }
-
-  it "has a 'data' payload limit of 6144 bytes" do
-    notification.data = { key: "a" * 6144 }
-    expect(notification.valid?).to eq(false)
-    expect(notification.errors[:base]).to eq ["Notification payload data cannot be larger than 6144 bytes."]
-  end
-
-  it 'limits the number of registration ids to 100' do
-    notification.registration_ids = ['a'] * (100 + 1)
-    expect(notification.valid?).to eq(false)
-    expect(notification.errors[:base]).to eq ["Number of registration_ids cannot be larger than 100."]
-  end
-
-  it 'validates data can be blank if collapse_key is set' do
-    notification.app = app
-    notification.registration_ids = 'a'
-    notification.collapse_key = 'test'
-    notification.data = nil
-    expect(notification.valid?).to eq(true)
-    expect(notification.errors[:data]).to be_empty
-  end
-
-  it 'validates data is present if collapse_key is not set' do
-    notification.collapse_key = nil
-    notification.data = nil
-    expect(notification.valid?).to eq(false)
-    expect(notification.errors[:data]).to eq ['must be set unless collapse_key is specified']
-  end
-
-  it 'includes expiresAfter in the payload' do
-    notification.expiry = 100
-    expect(notification.as_json['expiresAfter']).to eq 100
-  end
+  it_behaves_like 'Rpush::Client::Adm::Notification'
+  it_behaves_like 'Rpush::Client::ActiveRecord::Notification'
 end if active_record?

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

@@ -1,29 +1,6 @@
 require 'unit_spec_helper'
 
-describe Rpush::Client::ActiveRecord::App do
-  it 'does not validate an app with an invalid certificate' do
-    app = Rpush::Client::ActiveRecord::Apns::App.new(name: 'test', environment: 'development', certificate: 'foo')
-    app.valid?
-    expect(app.errors[:certificate]).to eq ['value must contain a certificate and a private key.']
-  end
-
-  it 'validates a certificate without a password' do
-    app = Rpush::Client::ActiveRecord::Apns::App.new name: 'test', environment: 'development', certificate: TEST_CERT
-    app.valid?
-    expect(app.errors[:certificate]).to eq []
-  end
-
-  it 'validates a certificate with a password' do
-    app = Rpush::Client::ActiveRecord::Apns::App.new name: 'test', environment: 'development',
-                                                     certificate: TEST_CERT_WITH_PASSWORD, password: 'fubar'
-    app.valid?
-    expect(app.errors[:certificate]).to eq []
-  end
-
-  it 'validates a certificate with an incorrect password' do
-    app = Rpush::Client::ActiveRecord::Apns::App.new name: 'test', environment: 'development',
-                                                     certificate: TEST_CERT_WITH_PASSWORD, password: 'incorrect'
-    app.valid?
-    expect(app.errors[:certificate]).to eq ['value must contain a certificate and a private key.']
-  end
+describe Rpush::Client::ActiveRecord::Apns::App do
+  it_behaves_like 'Rpush::Client::Apns::App'
+  it_behaves_like 'Rpush::Client::ActiveRecord::App'
 end if active_record?

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

@@ -1,9 +1,5 @@
 require 'unit_spec_helper'
 
 describe Rpush::Client::ActiveRecord::Apns::Feedback do
-  it 'validates the format of the device_token' do
-    notification = Rpush::Client::ActiveRecord::Apns::Feedback.new(device_token: "{$%^&*()}")
-    expect(notification.valid?).to be_falsey
-    expect(notification.errors[:device_token]).to include('is invalid')
-  end
+  it_behaves_like 'Rpush::Client::Apns::Feedback'
 end if active_record?