rpush 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62fa8d44a553579e32d0859ed2467d3936f6df0e
-  data.tar.gz: 8d33b51e1793599eca5cc4c0f827c471325e6a12
+SHA256:
+  metadata.gz: 034d8de0f4696f840692ef88e5646af49cd424603ef0417be06312a58a61a640
+  data.tar.gz: 3bcadf28d715b047c1f1b0f6b60326b58d365eded8ddaf1e1d78c5b5f81c39a8
 SHA512:
-  metadata.gz: 691dac9abba2c447b4246aee2bdac9e06eb43d7d233755c6867580c35043cef48854c010eeb30d25630ddae4caa1368983e173ac6db84bc6f1e1356eae05b820
-  data.tar.gz: 9b19217c52856b769fb5d326b9468cdfdc7faea297433fea4c4d499e1578b21eb4df01c88e9afe0c6fd7cc7db53057444e5ec6fff0b063ee5ea1bdfad5bc015f
+  metadata.gz: 937b1b6b68cc949bf6b28f10ca4c3ca78ec0811a87f4ff3bd926a6318d26042bea787ab067cb4c04801b35c7183180dafc474e1df22d64636035f8c0d7e8d047
+  data.tar.gz: 971f4544764419a4a08b8cdea97d58126d759deb145cc76567c4465bbf4db1154ef6bc46da04c729cc5bd3cedf709c71b93ee6269311179f32c4034780ab2f5a

data/CHANGELOG.md

@@ -12,6 +12,23 @@
 
 - None
 
+## 3.2.4 (2018-10-25)
+
+When upgrading, don't forget to run `bundle exec rpush init` to get all the latest migrations.
+
+### Changes
+
+- Relaxed JWT dependency version [#447](https://github.com/rpush/rpush/pull/447) (by [@sposin](https://github.com/sposin)).
+
+### Docs
+
+- Better documentation for running tests when developing Rpush [#458](https://github.com/rpush/rpush/pull/458) (by [@jsantos](https://github.com/jsantos)).
+
+### Fixed
+
+- Change `apn_key` column type from string to text [#455](https://github.com/rpush/rpush/pull/455) (by [sonxurxo](https://github.com/sonxurxo)).
+- Retry all GCM 5xx errors [#456](https://github.com/rpush/rpush/pull/456) (by [@rofreg](https://github.com/rofreg)).
+
 ## 3.2.3 (2018-07-12)
 
 ### Changes

data/README.md

@@ -347,6 +347,41 @@ You should run `rpush init` after upgrading Rpush to check for configuration and
 
 ### Contributing
 
+#### Running Tests
+
+Rpush uses [Appraisal](https://github.com/thoughtbot/appraisal) to run tests against multiple versions of Ruby on Rails. This helps making sure that Rpush performs correctly with multiple Rails versions.
+
+Rpush also uses RSpec for its tests.
+
+##### Bootstrapping your test suite:
+
+First, we need to setup a test database, `rpush_test`.
+
+E.g. (postgres): `psql -c 'create database rpush_test;' -U postgres >/dev/null`
+
+```
+bundle install
+bundle exec appraisal install
+```
+This will install all the required gems that requires to test against each version of Rails, which defined in `gemfiles/*.gemfile`.
+
+##### To run a full test suite:
+
+```
+bundle exec appraisal rake
+```
+This will run RSpec against all versions of Rails.
+
+##### To run a single test
+
+You need to specify a `BUNDLE_GEMFILE` pointing to the gemfile before running the normal test command:
+
+```
+BUNDLE_GEMFILE=gemfiles/rails_5.2.gemfile rspec spec/unit/apns_feedback_spec.rb
+```
+
+##### Multiple database adapter support
+
 When running specs, please note that the ActiveRecord adapter can be changed by setting the `ADAPTER` environment variable. For example: `ADAPTER=postgresql rake`.
 
 Available adapters for testing are `postgresql`, `jdbcpostgresql`, `mysql2`, `jdbcmysql`, `jdbch2`, and `sqlite3`.

data/lib/generators/rpush_migration_generator.rb

@@ -47,6 +47,7 @@ class RpushMigrationGenerator < Rails::Generators::Base
     add_rpush_migration('rpush_3_1_0_add_pushy')
     add_rpush_migration('rpush_3_1_1_updates')
     add_rpush_migration('rpush_3_2_0_add_apns_p8')
+    add_rpush_migration('rpush_3_2_4_updates')
   end
 
   protected

data/lib/generators/templates/rpush_3_2_4_updates.rb

@@ -0,0 +1,9 @@
+class Rpush324Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    change_column :rpush_apps, :apn_key, :text, null: true
+  end
+
+  def self.down
+    change_column :rpush_apps, :apn_key, :string, null: true
+  end
+end

data/lib/rpush/daemon/gcm/delivery.rb

@@ -7,7 +7,7 @@ module Rpush
 
         host = 'https://fcm.googleapis.com'
         FCM_URI = URI.parse("#{host}/fcm/send")
-        UNAVAILABLE_STATES = %w(Unavailable InternalServerError)
+        UNAVAILABLE_STATES = %w(Unavailable BadGateway InternalServerError)
         INVALID_REGISTRATION_ID_STATES = %w(InvalidRegistration MismatchSenderId NotRegistered InvalidPackageName)
 
         def initialize(app, http, notification, batch)
@@ -41,8 +41,12 @@ module Rpush
             unauthorized
           when 500
             internal_server_error(response)
+          when 502
+            bad_gateway(response)
           when 503
             service_unavailable(response)
+          when 500..599
+            other_5xx_error(response)
           else
             fail Rpush::DeliveryError.new(response.code.to_i, @notification.id, Rpush::Daemon::HTTP_STATUS_CODES[response.code.to_i])
           end
@@ -119,11 +123,21 @@ module Rpush
           log_warn("GCM responded with an Internal Error. " + retry_message)
         end
 
+        def bad_gateway(response)
+          retry_delivery(@notification, response)
+          log_warn("GCM responded with a Bad Gateway Error. " + retry_message)
+        end
+
         def service_unavailable(response)
           retry_delivery(@notification, response)
           log_warn("GCM responded with an Service Unavailable Error. " + retry_message)
         end
 
+        def other_5xx_error(response)
+          retry_delivery(@notification, response)
+          log_warn("GCM responded with a 5xx Error. " + retry_message)
+        end
+
         def deliver_after_header(response)
           Rpush::Daemon::RetryHeaderParser.parse(response.header['retry-after'])
         end

data/lib/rpush/version.rb

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

data/spec/support/active_record_setup.rb

@@ -36,6 +36,7 @@ require 'generators/templates/rpush_3_0_1_updates'
 require 'generators/templates/rpush_3_1_0_add_pushy'
 require 'generators/templates/rpush_3_1_1_updates'
 require 'generators/templates/rpush_3_2_0_add_apns_p8'
+require 'generators/templates/rpush_3_2_4_updates'
 
 migrations = [
   AddRpush,
@@ -47,7 +48,8 @@ migrations = [
   Rpush301Updates,
   Rpush310AddPushy,
   Rpush311Updates,
-  Rpush320AddApnsP8
+  Rpush320AddApnsP8,
+  Rpush324Updates
 ]
 
 unless ENV['TRAVIS']

data/spec/unit/daemon/gcm/delivery_spec.rb

@@ -282,6 +282,34 @@ describe Rpush::Daemon::Gcm::Delivery do
     end
   end
 
+  describe 'a 502 response' do
+    before { allow(response).to receive_messages(code: 502) }
+
+    it 'logs a warning that the notification will be retried.' do
+      notification.retries = 1
+      notification.deliver_after = now + 2
+      expect(logger).to receive(:warn).with("[MyApp] GCM responded with a Bad Gateway Error. Notification #{notification.id} will be retried after 2012-10-14 00:00:02 (retry 1).")
+      perform
+    end
+
+    it 'respects an integer Retry-After header' do
+      allow(response).to receive_messages(header: { 'retry-after' => 10 })
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 10.seconds)
+      perform
+    end
+
+    it 'respects a HTTP-date Retry-After header' do
+      allow(response).to receive_messages(header: { 'retry-after' => 'Wed, 03 Oct 2012 20:55:11 GMT' })
+      expect(delivery).to receive(:mark_retryable).with(notification, Time.parse('Wed, 03 Oct 2012 20:55:11 GMT'))
+      perform
+    end
+
+    it 'defaults to exponential back-off if the Retry-After header is not present' do
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 2**1)
+      perform
+    end
+  end
+
   describe 'a 500 response' do
     before do
       notification.update_attribute(:retries, 2)
@@ -301,6 +329,34 @@ describe Rpush::Daemon::Gcm::Delivery do
     end
   end
 
+  describe 'a 5xx response' do
+    before { allow(response).to receive_messages(code: 555) }
+
+    it 'logs a warning that the notification will be retried.' do
+      notification.retries = 1
+      notification.deliver_after = now + 2
+      expect(logger).to receive(:warn).with("[MyApp] GCM responded with a 5xx Error. Notification #{notification.id} will be retried after 2012-10-14 00:00:02 (retry 1).")
+      perform
+    end
+
+    it 'respects an integer Retry-After header' do
+      allow(response).to receive_messages(header: { 'retry-after' => 10 })
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 10.seconds)
+      perform
+    end
+
+    it 'respects a HTTP-date Retry-After header' do
+      allow(response).to receive_messages(header: { 'retry-after' => 'Wed, 03 Oct 2012 20:55:11 GMT' })
+      expect(delivery).to receive(:mark_retryable).with(notification, Time.parse('Wed, 03 Oct 2012 20:55:11 GMT'))
+      perform
+    end
+
+    it 'defaults to exponential back-off if the Retry-After header is not present' do
+      expect(delivery).to receive(:mark_retryable).with(notification, now + 2**1)
+      perform
+    end
+  end
+
   describe 'a 401 response' do
     before { allow(response).to receive_messages(code: 401) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors:
 - Ian Leitch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -56,16 +56,16 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -387,6 +387,7 @@ files:
 - lib/generators/templates/rpush_3_1_0_add_pushy.rb
 - lib/generators/templates/rpush_3_1_1_updates.rb
 - lib/generators/templates/rpush_3_2_0_add_apns_p8.rb
+- lib/generators/templates/rpush_3_2_4_updates.rb
 - lib/rpush.rb
 - lib/rpush/apns_feedback.rb
 - lib/rpush/cli.rb
@@ -623,7 +624,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The push notification service for Ruby.