rpush 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6576c1456435dd596c992846892b840f204b4cf8956b13f0c06b9b336b6e0fd8
-  data.tar.gz: 57ba3957011570e259585b3528f0bd344411f22db72bf03cea01bfe049107ac2
+  metadata.gz: 2da7543fed0193b0dcd20169efb5abd8170f15bc5043ef4ce2cb4d0e56380b4f
+  data.tar.gz: d7ba0f5b1dc97d17a7d23bf623d900b6da26b428ddcf4a8a93fce7641ab20f2d
 SHA512:
-  metadata.gz: 1fcce116cbddf64aacbf00d2b7294056f3c502b59f108783b53a1c90807cd0816a68be2c43e543625d556ad7de484786edb2baad1dbdc2652cfc1c4f582539f9
-  data.tar.gz: 0e468a1f43d8c422db967946fdc8d867bfc8bce6eaea511bff04e34108f77b75e9b0f903a3c008594482fe159ee9b820cc65be81008d60e2261b26f61c6ca274
+  metadata.gz: 745e0799a2e66d4813b99c4a93eb5d172dcbbe4c1317bd945b1addf177720f489bbdb0d83d918b9ab0ba4b98c35d186c0522d39740541097e16e90d0687487d8
+  data.tar.gz: e6d249ad9c7366cc54267e4eaa6f3d1bb3670dc6211380aa8bced26b33053cc0fda328f33b72a1d843cdd794e44e0793cd579e49745c60e46aa83155a5d0acca

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v5.3.0](https://github.com/rpush/rpush/tree/v5.3.0) (2021-01-07)
+
+[Full Changelog](https://github.com/rpush/rpush/compare/v5.2.0...v5.3.0)
+
+**Implemented enhancements:**
+
+- support for Webpush with VAPID [\#574](https://github.com/rpush/rpush/pull/574) ([jkraemer](https://github.com/jkraemer))
+
+**Merged pull requests:**
+
+- Bug fix: APNS P8 Notifications Are Marked as Invalid When the Payload Exceeds 2kb \(2048 bytes\) [\#583](https://github.com/rpush/rpush/pull/583) ([gregblake](https://github.com/gregblake))
+- Fix more Rails 6.1 deprecation warnings [\#582](https://github.com/rpush/rpush/pull/582) ([jas14](https://github.com/jas14))
+- Feature/apns2 default headers [\#579](https://github.com/rpush/rpush/pull/579) ([jkraemer](https://github.com/jkraemer))
+- Fix APNS2 documentation in README [\#578](https://github.com/rpush/rpush/pull/578) ([jamestjw](https://github.com/jamestjw))
+- Fixed typo with misspell [\#575](https://github.com/rpush/rpush/pull/575) ([hsbt](https://github.com/hsbt))
+
 ## [v5.2.0](https://github.com/rpush/rpush/tree/v5.2.0) (2020-10-08)
 
 [Full Changelog](https://github.com/rpush/rpush/compare/v5.1.0...v5.2.0)

data/README.md

@@ -18,6 +18,7 @@ Rpush aims to be the *de facto* gem for sending push notifications in Ruby. Its
   * [**Amazon Device Messaging**](#amazon-device-messaging)
   * [**Windows Phone Push Notification Service**](#windows-phone-notification-service)
   * [**Pushy**](#pushy)
+  * [**Webpush**](#webpush)
 
 #### Feature Highlights
 
@@ -96,6 +97,7 @@ app.name = "ios_app"
 app.certificate = File.read("/path/to/sandbox.pem")
 app.environment = "development"
 app.password = "certificate password"
+app.bundle_id = "BUNDLE ID" # the unique bundle id of the app, like com.example.appname
 app.connections = 1
 app.save!
 ```
@@ -106,9 +108,9 @@ n.app = Rpush::Apns2::App.find_by_name("ios_app")
 n.device_token = "..." # hex string
 n.alert = "hi mom!"
 n.data = {
-  headers: { 'apns-topic': "BUNDLE ID", # the bundle id of the app, like com.example.appname
-  foo: :bar }
-  }
+  headers: { 'apns-topic': "BUNDLE ID" }, # the bundle id of the app, like com.example.appname. Not necessary if set on the app (see above)
+  foo: :bar
+}
 n.save!
 ```
 
@@ -249,7 +251,7 @@ n.save!
 
 #### Windows Raw Push Notifications
 
-Note: The data is passed as `.to_json` so only this format is supported, altough raw notifications are meant to support any kind of data.
+Note: The data is passed as `.to_json` so only this format is supported, although raw notifications are meant to support any kind of data.
 Current data structure enforces hashes and `.to_json` representation is natural presentation of it.
 
 ```ruby
@@ -297,6 +299,49 @@ n.save!
 
 For more documentation on [Pushy](https://pushy.me/docs).
 
+#### Webpush
+
+[Webpush](https://tools.ietf.org/html/draft-ietf-webpush-protocol-10) is a
+protocol for delivering push messages to desktop browsers. It's supported by
+all major browsers (except Safari, you have to use one of the Apns transports
+for that).
+
+Using [VAPID](https://tools.ietf.org/html/draft-ietf-webpush-vapid-01), there
+is no need for the sender of push notifications to register upfront with push
+services (as was the case with the now legacy Mozilla or Google desktop push
+providers).
+
+Instead, you generate a pair of keys and use the public key when subscribing
+users in your web app. The keys are stored along with an email address (which,
+according to the spec, can be used by push service providers to contact you in
+case of problems) in the `certificates` field of the Rpush Application record:
+
+```ruby
+vapid_keypair = Webpush.generate_key.to_hash
+app = Rpush::Webpush::App.new
+app.name = 'webpush'
+app.certificate = vapid_keypair.merge(subject: 'user@example.org').to_json
+app.connections = 1
+app.save!
+```
+
+The `subscription` object you obtain from a subscribed browser holds an
+endpoint URL and cryptographic keys. When sending a notification, simply pass
+the whole subscription as sole member of the `registration_ids` collection:
+
+```ruby
+n = Rpush::Webpush::Notification.new
+n.app = Rpush::App.find_by_name("webpush")
+n.registration_ids = [subscription]
+n.data = { message: "hi mom!" }
+n.save!
+```
+
+In order to send the same message to multiple devices, create one
+`Notification` per device, as passing multiple subscriptions at once as
+`registration_ids` is not supported.
+
+
 ### Running Rpush
 
 It is recommended to run Rpush as a separate process in most cases, though embedding and manual modes are provided for low-workload environments.

data/lib/rpush/client/active_model.rb

@@ -32,3 +32,6 @@ require 'rpush/client/active_model/wns/notification'
 require 'rpush/client/active_model/pushy/app'
 require 'rpush/client/active_model/pushy/notification'
 require 'rpush/client/active_model/pushy/time_to_live_validator'
+
+require 'rpush/client/active_model/webpush/app'
+require 'rpush/client/active_model/webpush/notification'

data/lib/rpush/client/active_model/adm/data_validator.rb

@@ -5,7 +5,7 @@ module Rpush
         class DataValidator < ::ActiveModel::Validator
           def validate(record)
             return unless record.collapse_key.nil? && record.data.nil?
-            record.errors[:data] << 'must be set unless collapse_key is specified'
+            record.errors.add :data, 'must be set unless collapse_key is specified'
           end
         end
       end

data/lib/rpush/client/active_model/apns/device_token_format_validator.rb

@@ -4,8 +4,8 @@ module Rpush
       module Apns
         class DeviceTokenFormatValidator < ::ActiveModel::Validator
           def validate(record)
-            return if record.device_token =~ /^[a-z0-9]\w+$/i
-            record.errors[:device_token] << "is invalid"
+            return if record.device_token =~ /\A[a-z0-9]\w+\z/i
+            record.errors.add :device_token, "is invalid"
           end
         end
       end

data/lib/rpush/client/active_model/apns/notification_payload_size_validator.rb

@@ -6,7 +6,7 @@ module Rpush
           def validate(record)
             limit = record.class.max_payload_bytesize
             return unless record.payload.bytesize > limit
-            record.errors[:base] << "APN notification cannot be larger than #{limit} bytes. Try condensing your alert and device attributes."
+            record.errors.add :base, "APN notification cannot be larger than #{limit} bytes. Try condensing your alert and device attributes."
           end
         end
       end

data/lib/rpush/client/active_model/gcm/expiry_collapse_key_mutual_inclusion_validator.rb

@@ -5,7 +5,7 @@ module Rpush
         class ExpiryCollapseKeyMutualInclusionValidator < ::ActiveModel::Validator
           def validate(record)
             return unless record.collapse_key && !record.expiry
-            record.errors[:expiry] << 'must be set when using a collapse_key'
+            record.errors.add :expiry, 'must be set when using a collapse_key'
           end
         end
       end

data/lib/rpush/client/active_model/payload_data_size_validator.rb

@@ -5,7 +5,7 @@ module Rpush
         def validate(record)
           limit = options[:limit] || 1024
           return unless record.data && record.payload_data_size > limit
-          record.errors[:base] << "Notification payload data cannot be larger than #{limit} bytes."
+          record.errors.add :base, "Notification payload data cannot be larger than #{limit} bytes."
         end
       end
     end

data/lib/rpush/client/active_model/registration_ids_count_validator.rb

@@ -5,7 +5,7 @@ module Rpush
         def validate(record)
           limit = options[:limit] || 100
           return unless record.registration_ids && record.registration_ids.size > limit
-          record.errors[:base] << "Number of registration_ids cannot be larger than #{limit}."
+          record.errors.add :base, "Number of registration_ids cannot be larger than #{limit}."
         end
       end
     end

data/lib/rpush/client/active_model/webpush/app.rb

@@ -0,0 +1,41 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Webpush
+        module App
+
+          class VapidKeypairValidator < ::ActiveModel::Validator
+            def validate(record)
+              return if record.vapid_keypair.blank?
+              keypair = record.vapid
+              %i[ subject public_key private_key ].each do |key|
+                unless keypair.key?(key)
+                  record.errors.add(:vapid_keypair, "must have a #{key} entry")
+                end
+              end
+            rescue
+              record.errors.add(:vapid_keypair, 'must be valid JSON')
+            end
+          end
+
+          def self.included(base)
+            base.class_eval do
+              alias_attribute :vapid_keypair, :certificate
+              validates :vapid_keypair, presence: true
+              validates_with VapidKeypairValidator
+            end
+          end
+
+          def service_name
+            'webpush'
+          end
+
+          def vapid
+            @vapid ||= JSON.parse(vapid_keypair).symbolize_keys
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/webpush/notification.rb

@@ -0,0 +1,66 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Webpush
+        module Notification
+
+          class RegistrationValidator < ::ActiveModel::Validator
+            KEYS = %i[ endpoint keys ].freeze
+            def validate(record)
+              return if record.registration_ids.blank?
+              return if record.registration_ids.size > 1
+              reg = record.registration_ids.first
+              unless reg.is_a?(Hash) &&
+                  reg.keys.sort == KEYS &&
+                  reg[:endpoint].is_a?(String) &&
+                  reg[:keys].is_a?(Hash)
+                record.errors.add(:base, 'Registration must have :endpoint (String) and :keys (Hash) keys')
+              end
+            end
+          end
+
+          def self.included(base)
+            base.instance_eval do
+              alias_attribute :time_to_live, :expiry
+
+              validates :registration_ids, presence: true
+              validates :data, presence: true
+              validates :time_to_live, numericality: { only_integer: true, greater_than: 0 }, allow_nil: true
+
+              validates_with Rpush::Client::ActiveModel::PayloadDataSizeValidator, limit: 4096
+              validates_with Rpush::Client::ActiveModel::RegistrationIdsCountValidator, limit: 1
+              validates_with RegistrationValidator
+            end
+          end
+
+          def data=(value)
+            value = value.stringify_keys if value.respond_to?(:stringify_keys)
+            super value
+          end
+
+          def subscription
+            @subscription ||= registration_ids.first.deep_symbolize_keys
+          end
+
+          def message
+            data['message'].presence if data
+          end
+
+          # https://webpush-wg.github.io/webpush-protocol/#urgency
+          def urgency
+            data['urgency'].presence if data
+          end
+
+          def as_json(_options = nil)
+            {
+              'data'             => data,
+              'time_to_live'     => time_to_live,
+              'registration_ids' => registration_ids
+            }
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record.rb

@@ -32,3 +32,6 @@ require 'rpush/client/active_record/adm/app'
 
 require 'rpush/client/active_record/pushy/notification'
 require 'rpush/client/active_record/pushy/app'
+
+require 'rpush/client/active_record/webpush/notification'
+require 'rpush/client/active_record/webpush/app'

data/lib/rpush/client/active_record/apnsp8/notification.rb

@@ -3,6 +3,7 @@ module Rpush
     module ActiveRecord
       module Apnsp8
         class Notification < Rpush::Client::ActiveRecord::Apns::Notification
+          include Rpush::Client::ActiveModel::Apns2::Notification
         end
       end
     end

data/lib/rpush/client/active_record/webpush/app.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Webpush
+        class App < Rpush::Client::ActiveRecord::App
+          include Rpush::Client::ActiveModel::Webpush::App
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record/webpush/notification.rb

@@ -0,0 +1,12 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Webpush
+        class Notification < Rpush::Client::ActiveRecord::Notification
+          include Rpush::Client::ActiveModel::Webpush::Notification
+        end
+      end
+    end
+  end
+end
+

data/lib/rpush/client/redis.rb

@@ -44,6 +44,9 @@ require 'rpush/client/redis/wns/badge_notification'
 require 'rpush/client/redis/pushy/app'
 require 'rpush/client/redis/pushy/notification'
 
+require 'rpush/client/redis/webpush/app'
+require 'rpush/client/redis/webpush/notification'
+
 Modis.configure do |config|
   config.namespace = :rpush
 end

data/lib/rpush/client/redis/apnsp8/notification.rb

@@ -3,6 +3,8 @@ module Rpush
     module Redis
       module Apnsp8
         class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
+          include Rpush::Client::ActiveModel::Apns2::Notification
           include Rpush::Client::ActiveModel::Apnsp8::Notification
         end
       end

data/lib/rpush/client/redis/webpush/app.rb

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module Redis
+      module Webpush
+        class App < Rpush::Client::Redis::App
+          include Rpush::Client::ActiveModel::Webpush::App
+
+          def vapid_keypair=(value)
+            self.certificate = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/redis/webpush/notification.rb

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module Redis
+      module Webpush
+        class Notification < Rpush::Client::Redis::Notification
+          include Rpush::Client::ActiveModel::Webpush::Notification
+
+          def time_to_live=(value)
+            self.expiry = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/configuration.rb

@@ -106,7 +106,7 @@ module Rpush
       client_module = Rpush::Client.const_get(client.to_s.camelize)
       Rpush.send(:include, client_module) unless Rpush.ancestors.include?(client_module)
 
-      [:Apns, :Gcm, :Wpns, :Wns, :Adm, :Pushy].each do |service|
+      [:Apns, :Gcm, :Wpns, :Wns, :Adm, :Pushy, :Webpush].each do |service|
         Rpush.const_set(service, client_module.const_get(service)) unless Rpush.const_defined?(service)
       end
 

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

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

@@ -107,7 +107,13 @@ module Rpush
         end
 
         def prepare_headers(notification)
-          notification_data(notification)[HTTP2_HEADERS_KEY] || {}
+          headers = {}
+
+          headers['apns-expiration'] = '0'
+          headers['apns-priority'] = '10'
+          headers['apns-topic'] = @app.bundle_id
+
+          headers.merge notification_data(notification)[HTTP2_HEADERS_KEY] || {}
         end
 
         def notification_data(notification)

data/lib/rpush/daemon/webpush.rb

@@ -0,0 +1,10 @@
+module Rpush
+  module Daemon
+    module Webpush
+      extend ServiceConfigMethods
+
+      dispatcher :http
+    end
+  end
+end
+

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "webpush"
+
+module Rpush
+  module Daemon
+    module Webpush
+
+      # Webpush::Request handles all the encryption / signing.
+      # We just override #perform to inject the http instance that is managed
+      # by Rpush.
+      #
+      class Request < ::Webpush::Request
+        def perform(http)
+          req = Net::HTTP::Post.new(uri.request_uri, headers)
+          req.body = body
+          http.request(uri, req)
+        end
+      end
+
+      class Delivery < Rpush::Daemon::Delivery
+
+        OK = [ 200, 201, 202 ].freeze
+        TEMPORARY_FAILURES = [ 429, 500, 502, 503, 504 ].freeze
+
+        def initialize(app, http, notification, batch)
+          @app = app
+          @http = http
+          @notification = notification
+          @batch = batch
+        end
+
+        def perform
+          response = send_request
+          process_response response
+        rescue SocketError, SystemCallError => error
+          mark_retryable(@notification, Time.now + 10.seconds, error)
+          raise
+        rescue StandardError => error
+          mark_failed(error)
+          raise
+        ensure
+          @batch.notification_processed
+        end
+
+        private
+
+        def send_request
+          # The initializer is inherited from Webpush::Request and looks like
+          # this:
+          #
+          # initialize(message: '', subscription:, vapid:, **options)
+          #
+          # where subscription is a hash of :endpoint and :keys, and vapid
+          # holds the vapid public and private keys and the :subject (which is
+          # an email address).
+          Request.new(
+            message: @notification.message,
+            subscription: @notification.subscription,
+            vapid: @app.vapid,
+            ttl: @notification.time_to_live,
+            urgency: @notification.urgency
+          ).perform(@http)
+        end
+
+        def process_response(response)
+          case response.code.to_i
+          when *OK
+            mark_delivered
+          when *TEMPORARY_FAILURES
+            retry_delivery(response)
+          else
+            fail_delivery(response)
+          end
+        end
+
+        def retry_delivery(response)
+          time = deliver_after_header(response)
+          if time
+            mark_retryable(@notification, time)
+          else
+            mark_retryable_exponential(@notification)
+          end
+          log_info("Webpush endpoint responded with a #{response.code} error. #{retry_message}")
+        end
+
+        def fail_delivery(response)
+          fail_message = fail_message(response)
+          log_error("#{@notification.id} failed: #{fail_message}")
+          fail Rpush::DeliveryError.new(response.code.to_i, @notification.id, fail_message)
+        end
+
+        def deliver_after_header(response)
+          Rpush::Daemon::RetryHeaderParser.parse(response.header['retry-after'])
+        end
+
+        def retry_message
+          deliver_after = @notification.deliver_after.strftime('%Y-%m-%d %H:%M:%S')
+          "Notification #{@notification.id} will be retried after #{deliver_after} (retry #{@notification.retries})."
+        end
+
+        def fail_message(response)
+          msg = Rpush::Daemon::HTTP_STATUS_CODES[response.code.to_i]
+          if explanation = response.body.to_s[0..200].presence
+            msg += ": #{explanation}"
+          end
+          msg
+        end
+
+      end
+    end
+  end
+end
+

data/lib/rpush/version.rb

@@ -1,7 +1,7 @@
 module Rpush
   module VERSION
     MAJOR = 5
-    MINOR = 2
+    MINOR = 3
     TINY = 0
     PRE = nil
 

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,12 @@ 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'
+          }
+        }
       )
       .and_return(fake_http2_request)
 
@@ -104,7 +110,11 @@ 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'
+            }
           }
         ).and_return(fake_http2_request)
 

data/spec/functional/webpush_spec.rb

@@ -0,0 +1,30 @@
+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',
+      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

@@ -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/unit/client/active_record/apnsp8/notification_spec.rb

@@ -0,0 +1,28 @@
+require "unit_spec_helper"
+
+describe Rpush::Client::ActiveRecord::Apnsp8::Notification do
+  subject(:notification) { described_class.new }
+
+  it_behaves_like 'Rpush::Client::Apns::Notification'
+  it_behaves_like 'Rpush::Client::ActiveRecord::Notification'
+
+  it "should validate the length of the binary conversion of the notification", :aggregate_failures do
+    notification = described_class.new
+    notification.app = Rpush::Apnsp8::App.create(apn_key: "1",
+                                                 apn_key_id: "2",
+                                                 name: 'test',
+                                                 environment: 'development',
+                                                 team_id: "3",
+                                                 bundle_id: "4")
+    notification.device_token = "a" * 108
+    notification.alert = ""
+
+    notification.alert << "a" until notification.payload.bytesize == 4096
+    expect(notification.valid?).to be_truthy
+    expect(notification.errors[:base]).to be_empty
+
+    notification.alert << "a"
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:base].include?("APN notification cannot be larger than 4096 bytes. Try condensing your alert and device attributes.")).to be_truthy
+  end
+end if active_record?

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

@@ -0,0 +1,6 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::ActiveRecord::Webpush::App do
+  it_behaves_like 'Rpush::Client::Webpush::App'
+  it_behaves_like 'Rpush::Client::ActiveRecord::App'
+end if active_record?

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

@@ -0,0 +1,6 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::ActiveRecord::Webpush::Notification do
+  it_behaves_like 'Rpush::Client::Webpush::Notification'
+  it_behaves_like 'Rpush::Client::ActiveRecord::Notification'
+end if active_record?

data/spec/unit/client/redis/apnsp8/notification_spec.rb

@@ -0,0 +1,29 @@
+require "unit_spec_helper"
+
+describe Rpush::Client::Redis::Apnsp8::Notification do
+  after do
+    Rpush::Apnsp8::App.all.select { |a| a.environment == "development" && a.apn_key == "1" }.each(&:destroy)
+  end
+
+  it_behaves_like "Rpush::Client::Apns::Notification"
+
+  it "should validate the length of the binary conversion of the notification", :aggregate_failures do
+    notification = described_class.new
+    notification.app = Rpush::Apnsp8::App.create(apn_key: "1",
+                                                 apn_key_id: "2",
+                                                 name: 'test',
+                                                 environment: 'development',
+                                                 team_id: "3",
+                                                 bundle_id: "4")
+    notification.device_token = "a" * 108
+    notification.alert = ""
+
+    notification.alert << "a" until notification.payload.bytesize == 4096
+    expect(notification.valid?).to be_truthy
+    expect(notification.errors[:base]).to be_empty
+
+    notification.alert << "a"
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:base].include?("APN notification cannot be larger than 4096 bytes. Try condensing your alert and device attributes.")).to be_truthy
+  end
+end if redis?

data/spec/unit/client/redis/webpush/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Webpush::App do
+  it_behaves_like 'Rpush::Client::Webpush::App'
+end if redis?

data/spec/unit/client/redis/webpush/notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Webpush::Notification do
+  it_behaves_like 'Rpush::Client::Webpush::Notification'
+end if redis?

data/spec/unit/client/shared/webpush/app.rb

@@ -0,0 +1,33 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Webpush::App' do
+  describe 'validates' do
+    subject { described_class.new }
+
+    it 'validates presence of name' do
+      is_expected.not_to be_valid
+      expect(subject.errors[:name]).to eq ["can't be blank"]
+    end
+
+    it 'validates presence of vapid_keypair' do
+      is_expected.not_to be_valid
+      expect(subject.errors[:vapid_keypair]).to eq ["can't be blank"]
+    end
+
+    it 'should require the vapid keypair to have subject, public and private key' do
+      subject.vapid_keypair = {}.to_json
+      is_expected.not_to be_valid
+      expect(subject.errors[:vapid_keypair].sort).to eq [
+        'must have a private_key entry',
+        'must have a public_key entry',
+        'must have a subject entry',
+      ]
+    end
+
+    it 'should require valid json for the keypair' do
+      subject.vapid_keypair = 'invalid'
+      is_expected.not_to be_valid
+      expect(subject.errors[:vapid_keypair].sort).to eq [ 'must be valid JSON' ]
+    end
+  end
+end

data/spec/unit/client/shared/webpush/notification.rb

@@ -0,0 +1,83 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Webpush::Notification' do
+  subject(:notification) { described_class.new }
+
+  describe 'notification attributes' do
+    describe 'data' do
+      subject { described_class.new(data: { message: 'test', urgency: 'normal' } ) }
+      it 'has a message' do
+        expect(subject.message).to eq "test"
+      end
+      it 'has an urgency' do
+        expect(subject.urgency).to eq "normal"
+      end
+    end
+
+    describe 'subscription' do
+      let(:subscription){ { endpoint: 'https://push.example.org/foo', keys: {'foo' => 'bar'}} }
+      subject { described_class.new(registration_ids: [subscription]) }
+
+      it "has a subscription" do
+        expect(subject.subscription).to eq({ endpoint: 'https://push.example.org/foo', keys: {foo: 'bar'} })
+      end
+    end
+  end
+
+
+  describe 'validates' do
+    let(:app) { Rpush::Webpush::App.create!(name: 'MyApp', vapid_keypair: VAPID_KEYPAIR) }
+
+    describe 'data' do
+      subject { described_class.new(app: app, registration_ids: [{endpoint: 'https://push.example.org/foo', keys: {'foo' => 'bar'}}]) }
+      it 'validates presence' do
+        is_expected.not_to be_valid
+        expect(subject.errors[:data]).to eq ["can't be blank"]
+      end
+
+      it "has a 'data' payload limit of 4096 bytes" do
+        subject.data = { message: 'a' * 4096 }
+        is_expected.not_to be_valid
+        expected_errors = ["Notification payload data cannot be larger than 4096 bytes."]
+        expect(subject.errors[:base]).to eq expected_errors
+      end
+    end
+
+    describe 'registration_ids' do
+      subject { described_class.new(app: app, data: { message: 'test' }) }
+      it 'validates presence' do
+        is_expected.not_to be_valid
+        expect(subject.errors[:registration_ids]).to eq ["can't be blank"]
+      end
+
+      it 'limits the number of registration ids to exactly 1' do
+        subject.registration_ids = [{endpoint: 'string', keys: { 'a' => 'hash' }}] * 2
+        is_expected.not_to be_valid
+        expected_errors = ["Number of registration_ids cannot be larger than 1."]
+        expect(subject.errors[:base]).to eq expected_errors
+      end
+
+      it 'validates the structure of the registration' do
+        subject.registration_ids = ['a']
+        is_expected.not_to be_valid
+        expect(subject.errors[:base]).to eq [
+          "Registration must have :endpoint (String) and :keys (Hash) keys"
+        ]
+
+        subject.registration_ids = [{endpoint: 'string', keys: { 'a' => 'hash' }}]
+        is_expected.to be_valid
+      end
+    end
+
+    describe 'time_to_live' do
+      subject { described_class.new(app: app, data: { message: 'test' }, registration_ids: [{endpoint: 'https://push.example.org/foo', keys: {'foo' => 'bar'}}]) }
+
+      it 'should be > 0' do
+        subject.time_to_live = -1
+        is_expected.not_to be_valid
+        expect(subject.errors[:time_to_live]).to eq ['must be greater than 0']
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,142 @@
+require 'unit_spec_helper'
+
+describe Rpush::Daemon::Webpush::Delivery do
+  let(:app) { Rpush::Webpush::App.create!(name: 'MyApp', vapid_keypair: VAPID_KEYPAIR) }
+
+  # Push subscription information as received from a client browser when the
+  # user subscribed to push notifications.
+  let(:device_reg) {
+    { endpoint: 'https://webpush-provider.example.org/push/some-id',
+      keys: {'auth' => 'DgN9EBia1o057BdhCOGURA', 'p256dh' => 'BAtxJ--7vHq9IVm8utUB3peJ4lpxRqk1rukCIkVJOomS83QkCnrQ4EyYQsSaCRgy_c8XPytgXxuyAvRJdnTPK4A'} }
+  }
+
+  let(:data) { { message: 'some message' } }
+  let(:notification) { Rpush::Webpush::Notification.create!(app: app, registration_ids: [device_reg], data: data) }
+  let(:batch) { instance_double('Rpush::Daemon::Batch', notification_processed: nil) }
+  let(:response) { instance_double('Net::HTTPResponse', code: response_code, header: response_header, body: response_body) }
+  let(:response_code) { 201 }
+  let(:response_header) { {} }
+  let(:response_body) { nil }
+  let(:http) { instance_double('Net::HTTP::Persistent', request: response) }
+  let(:logger) { instance_double('Rpush::Logger', error: nil, info: nil, warn: nil, internal_logger: nil) }
+  let(:now) { Time.parse('2020-10-13 00:00:00 UTC') }
+
+  before do
+    allow(Rpush).to receive_messages(logger: logger)
+    allow(Time).to receive_messages(now: now)
+  end
+
+  subject(:delivery) { described_class.new(app, http, notification, batch) }
+
+  describe '#perform' do
+    shared_examples 'process notification' do
+      it 'invoke batch.notification_processed' do
+        subject.perform rescue nil
+        expect(batch).to have_received(:notification_processed)
+      end
+    end
+
+    context 'when response code is 201' do
+      before do
+        allow(batch).to receive(:mark_delivered)
+        Rpush::Daemon.store = Rpush::Daemon::Store.const_get(Rpush.config.client.to_s.camelcase).new
+      end
+
+      it 'marks the notification as delivered' do
+        delivery.perform
+        expect(batch).to have_received(:mark_delivered).with(notification)
+      end
+
+      it_behaves_like 'process notification'
+    end
+
+    shared_examples 'retry delivery' do |response_code:|
+      let(:response_code) { response_code }
+
+      shared_examples 'logs' do |deliver_after:|
+        let(:expected_log_message) do
+          "[MyApp] Webpush endpoint responded with a #{response_code} error. Notification #{notification.id} will be retried after #{deliver_after} (retry 1)."
+        end
+
+        it 'logs that the notification will be retried' do
+          delivery.perform
+          expect(logger).to have_received(:info).with(expected_log_message)
+        end
+      end
+
+      context 'when Retry-After header is present' do
+        let(:response_header) { { 'retry-after' => 10 } }
+
+        before do
+          allow(delivery).to receive(:mark_retryable) do
+            notification.deliver_after = now + 10.seconds
+            notification.retries += 1
+          end
+        end
+
+        it 'retry the notification' do
+          delivery.perform
+          expect(delivery).to have_received(:mark_retryable).with(notification, now + 10.seconds)
+        end
+
+        it_behaves_like 'logs', deliver_after: '2020-10-13 00:00:10'
+        it_behaves_like 'process notification'
+      end
+
+      context 'when Retry-After header is not present' do
+        before do
+          allow(delivery).to receive(:mark_retryable_exponential) do
+            notification.deliver_after = now + 2.seconds
+            notification.retries = 1
+          end
+        end
+
+        it 'retry the notification' do
+          delivery.perform
+          expect(delivery).to have_received(:mark_retryable_exponential).with(notification)
+        end
+
+        it_behaves_like 'logs', deliver_after: '2020-10-13 00:00:02'
+        it_behaves_like 'process notification'
+      end
+    end
+
+    it_behaves_like 'retry delivery', response_code: 429
+    it_behaves_like 'retry delivery', response_code: 500
+    it_behaves_like 'retry delivery', response_code: 502
+    it_behaves_like 'retry delivery', response_code: 503
+    it_behaves_like 'retry delivery', response_code: 504
+
+    context 'when delivery failed' do
+      let(:response_code) { 400 }
+      let(:fail_message) { 'that was a bad request' }
+      before do
+        allow(response).to receive(:body) { fail_message }
+        allow(batch).to receive(:mark_failed)
+      end
+
+      it 'marks the notification as failed' do
+        expect { delivery.perform }.to raise_error(Rpush::DeliveryError)
+        expected_message = "Unable to deliver notification #{notification.id}, " \
+                           "received error 400 (Bad Request: #{fail_message})"
+        expect(batch).to have_received(:mark_failed).with(notification, 400, expected_message)
+      end
+
+      it_behaves_like 'process notification'
+    end
+
+    context 'when SocketError raised' do
+      before do
+        allow(http).to receive(:request) { raise SocketError }
+        allow(delivery).to receive(:mark_retryable)
+      end
+
+      it 'retry delivery after 10 seconds' do
+        expect { delivery.perform }.to raise_error(SocketError)
+        expect(delivery).to have_received(:mark_retryable).with(notification, now + 10.seconds, SocketError)
+      end
+
+      it_behaves_like 'process notification'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpush
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -134,6 +134,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webpush
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -423,6 +437,8 @@ files:
 - lib/rpush/client/active_model/pushy/notification.rb
 - lib/rpush/client/active_model/pushy/time_to_live_validator.rb
 - lib/rpush/client/active_model/registration_ids_count_validator.rb
+- lib/rpush/client/active_model/webpush/app.rb
+- lib/rpush/client/active_model/webpush/notification.rb
 - lib/rpush/client/active_model/wns/app.rb
 - lib/rpush/client/active_model/wns/notification.rb
 - lib/rpush/client/active_model/wpns/app.rb
@@ -444,6 +460,8 @@ files:
 - lib/rpush/client/active_record/notification.rb
 - lib/rpush/client/active_record/pushy/app.rb
 - lib/rpush/client/active_record/pushy/notification.rb
+- lib/rpush/client/active_record/webpush/app.rb
+- lib/rpush/client/active_record/webpush/notification.rb
 - lib/rpush/client/active_record/wns/app.rb
 - lib/rpush/client/active_record/wns/badge_notification.rb
 - lib/rpush/client/active_record/wns/notification.rb
@@ -466,6 +484,8 @@ files:
 - lib/rpush/client/redis/notification.rb
 - lib/rpush/client/redis/pushy/app.rb
 - lib/rpush/client/redis/pushy/notification.rb
+- lib/rpush/client/redis/webpush/app.rb
+- lib/rpush/client/redis/webpush/notification.rb
 - lib/rpush/client/redis/wns/app.rb
 - lib/rpush/client/redis/wns/badge_notification.rb
 - lib/rpush/client/redis/wns/notification.rb
@@ -520,6 +540,8 @@ files:
 - lib/rpush/daemon/string_helpers.rb
 - lib/rpush/daemon/synchronizer.rb
 - lib/rpush/daemon/tcp_connection.rb
+- lib/rpush/daemon/webpush.rb
+- lib/rpush/daemon/webpush/delivery.rb
 - lib/rpush/daemon/wns.rb
 - lib/rpush/daemon/wns/badge_request.rb
 - lib/rpush/daemon/wns/delivery.rb
@@ -552,6 +574,7 @@ files:
 - spec/functional/pushy_spec.rb
 - spec/functional/retry_spec.rb
 - spec/functional/synchronization_spec.rb
+- spec/functional/webpush_spec.rb
 - spec/functional/wpns_spec.rb
 - spec/functional_spec_helper.rb
 - spec/spec_helper.rb
@@ -570,6 +593,7 @@ files:
 - spec/unit/client/active_record/apns/notification_spec.rb
 - spec/unit/client/active_record/apns2/app_spec.rb
 - spec/unit/client/active_record/apns2/notification_spec.rb
+- spec/unit/client/active_record/apnsp8/notification_spec.rb
 - spec/unit/client/active_record/app_spec.rb
 - spec/unit/client/active_record/gcm/app_spec.rb
 - spec/unit/client/active_record/gcm/notification_spec.rb
@@ -578,6 +602,8 @@ files:
 - spec/unit/client/active_record/pushy/notification_spec.rb
 - spec/unit/client/active_record/shared/app.rb
 - spec/unit/client/active_record/shared/notification.rb
+- spec/unit/client/active_record/webpush/app_spec.rb
+- spec/unit/client/active_record/webpush/notification_spec.rb
 - spec/unit/client/active_record/wns/badge_notification_spec.rb
 - spec/unit/client/active_record/wns/raw_notification_spec.rb
 - spec/unit/client/active_record/wpns/app_spec.rb
@@ -589,12 +615,15 @@ files:
 - spec/unit/client/redis/apns/notification_spec.rb
 - spec/unit/client/redis/apns2/app_spec.rb
 - spec/unit/client/redis/apns2/notification_spec.rb
+- spec/unit/client/redis/apnsp8/notification_spec.rb
 - spec/unit/client/redis/app_spec.rb
 - spec/unit/client/redis/gcm/app_spec.rb
 - spec/unit/client/redis/gcm/notification_spec.rb
 - spec/unit/client/redis/notification_spec.rb
 - spec/unit/client/redis/pushy/app_spec.rb
 - spec/unit/client/redis/pushy/notification_spec.rb
+- spec/unit/client/redis/webpush/app_spec.rb
+- spec/unit/client/redis/webpush/notification_spec.rb
 - spec/unit/client/redis/wns/badge_notification_spec.rb
 - spec/unit/client/redis/wns/raw_notification_spec.rb
 - spec/unit/client/redis/wpns/app_spec.rb
@@ -610,6 +639,8 @@ files:
 - spec/unit/client/shared/notification.rb
 - spec/unit/client/shared/pushy/app.rb
 - spec/unit/client/shared/pushy/notification.rb
+- spec/unit/client/shared/webpush/app.rb
+- spec/unit/client/shared/webpush/notification.rb
 - spec/unit/client/shared/wns/badge_notification.rb
 - spec/unit/client/shared/wns/raw_notification.rb
 - spec/unit/client/shared/wpns/app.rb
@@ -638,6 +669,7 @@ files:
 - spec/unit/daemon/store/active_record_spec.rb
 - spec/unit/daemon/store/redis_spec.rb
 - spec/unit/daemon/tcp_connection_spec.rb
+- spec/unit/daemon/webpush/delivery_spec.rb
 - spec/unit/daemon/wns/delivery_spec.rb
 - spec/unit/daemon/wns/post_request_spec.rb
 - spec/unit/daemon/wpns/delivery_spec.rb
@@ -695,6 +727,7 @@ test_files:
 - spec/functional/pushy_spec.rb
 - spec/functional/retry_spec.rb
 - spec/functional/synchronization_spec.rb
+- spec/functional/webpush_spec.rb
 - spec/functional/wpns_spec.rb
 - spec/functional_spec_helper.rb
 - spec/spec_helper.rb
@@ -713,6 +746,7 @@ test_files:
 - spec/unit/client/active_record/apns/notification_spec.rb
 - spec/unit/client/active_record/apns2/app_spec.rb
 - spec/unit/client/active_record/apns2/notification_spec.rb
+- spec/unit/client/active_record/apnsp8/notification_spec.rb
 - spec/unit/client/active_record/app_spec.rb
 - spec/unit/client/active_record/gcm/app_spec.rb
 - spec/unit/client/active_record/gcm/notification_spec.rb
@@ -721,6 +755,8 @@ test_files:
 - spec/unit/client/active_record/pushy/notification_spec.rb
 - spec/unit/client/active_record/shared/app.rb
 - spec/unit/client/active_record/shared/notification.rb
+- spec/unit/client/active_record/webpush/app_spec.rb
+- spec/unit/client/active_record/webpush/notification_spec.rb
 - spec/unit/client/active_record/wns/badge_notification_spec.rb
 - spec/unit/client/active_record/wns/raw_notification_spec.rb
 - spec/unit/client/active_record/wpns/app_spec.rb
@@ -732,12 +768,15 @@ test_files:
 - spec/unit/client/redis/apns/notification_spec.rb
 - spec/unit/client/redis/apns2/app_spec.rb
 - spec/unit/client/redis/apns2/notification_spec.rb
+- spec/unit/client/redis/apnsp8/notification_spec.rb
 - spec/unit/client/redis/app_spec.rb
 - spec/unit/client/redis/gcm/app_spec.rb
 - spec/unit/client/redis/gcm/notification_spec.rb
 - spec/unit/client/redis/notification_spec.rb
 - spec/unit/client/redis/pushy/app_spec.rb
 - spec/unit/client/redis/pushy/notification_spec.rb
+- spec/unit/client/redis/webpush/app_spec.rb
+- spec/unit/client/redis/webpush/notification_spec.rb
 - spec/unit/client/redis/wns/badge_notification_spec.rb
 - spec/unit/client/redis/wns/raw_notification_spec.rb
 - spec/unit/client/redis/wpns/app_spec.rb
@@ -753,6 +792,8 @@ test_files:
 - spec/unit/client/shared/notification.rb
 - spec/unit/client/shared/pushy/app.rb
 - spec/unit/client/shared/pushy/notification.rb
+- spec/unit/client/shared/webpush/app.rb
+- spec/unit/client/shared/webpush/notification.rb
 - spec/unit/client/shared/wns/badge_notification.rb
 - spec/unit/client/shared/wns/raw_notification.rb
 - spec/unit/client/shared/wpns/app.rb
@@ -781,6 +822,7 @@ test_files:
 - spec/unit/daemon/store/active_record_spec.rb
 - spec/unit/daemon/store/redis_spec.rb
 - spec/unit/daemon/tcp_connection_spec.rb
+- spec/unit/daemon/webpush/delivery_spec.rb
 - spec/unit/daemon/wns/delivery_spec.rb
 - spec/unit/daemon/wns/post_request_spec.rb
 - spec/unit/daemon/wpns/delivery_spec.rb