rpush 4.1.1 → 5.3.0

data/README.md

@@ -18,10 +18,11 @@ 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
 
-* Use [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord) or [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis) for storage. **Note:** Redis support for Rails 5.2 is not yet working if you're using Modis, see [this issue](https://github.com/ileitch/modis/issues/13).
+* Use [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord) or [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis) for storage.
 * Plugins for [**Bugsnag**](https://github.com/rpush/rpush-plugin-bugsnag),
 [**Sentry**](https://github.com/rpush/rpush-plugin-sentry), [**StatsD**](https://github.com/rpush/rpush-plugin-statsd) or [write your own](https://github.com/rpush/rpush/wiki/Writing-a-Plugin).
 * Seamless integration with your projects, including **Rails**.
@@ -52,56 +53,98 @@ $ bundle exec rpush init
 
 #### Apple Push Notification Service
 
+There is a choice of two modes (and one legacy mode) using certificates or using tokens:
 
-If this is your first time using the APNs, you will need to generate SSL certificates. See [Generating Certificates](https://github.com/rpush/rpush/wiki/Generating-Certificates) for instructions.
+* `Rpush::Apns2` This requires an annually renewable certificate. see https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns
+* `Rpush::Apnsp8` This uses encrypted tokens and requires an encryption key id and encryption key (provide as a p8 file). (see https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns)
+* `Rpush::Apns` There is also the original APNS (the original version using certificates with a binary underlying protocol over TCP directly rather than over Http/2).
+  Apple have [announced](https://developer.apple.com/news/?id=11042019a) that this is not supported after November 2020.
+
+If this is your first time using the APNs, you will need to generate either SSL certificates (for Apns2 or Apns) or an Encryption Key (p8) and an Encryption Key ID (for Apnsp8). See [Generating Certificates](https://github.com/rpush/rpush/wiki/Generating-Certificates) for instructions.
+
+##### Apnsp8
+
+To use the p8 APNs Api:
 
 ```ruby
-app = Rpush::Apns::App.new
+app = Rpush::Apnsp8::App.new
 app.name = "ios_app"
-app.certificate = File.read("/path/to/sandbox.pem")
+app.apn_key = File.read("/path/to/sandbox.p8")
 app.environment = "development" # APNs environment.
-app.password = "certificate password"
+app.apn_key_id = "APN KEY ID" # This is the Encryption Key ID provided by apple
+app.team_id = "TEAM ID" # the team id - e.g. ABCDE12345
+app.bundle_id = "BUNDLE ID" # the unique bundle id of the app, like com.example.appname
 app.connections = 1
 app.save!
 ```
 
 ```ruby
 n = Rpush::Apns::Notification.new
-n.app = Rpush::Apns::App.find_by_name("ios_app")
+n.app = Rpush::Apnsp8::App.find_by_name("ios_app")
 n.device_token = "..." # hex string
 n.alert = "hi mom!"
 n.data = { foo: :bar }
 n.save!
 ```
 
-The `url_args` attribute is available for Safari Push Notifications.
+##### Apns2
 
-You should also implement the [ssl_certificate_will_expire](https://github.com/rpush/rpush/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
+(NB this uses the same protocol as Apnsp8, but authenticates with a certificate rather than tokens)
+
+```ruby
+app = Rpush::Apns2::App.new
+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!
+```
+
+```ruby
+n = Rpush::Apns2::Notification.new
+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. Not necessary if set on the app (see above)
+  foo: :bar
+}
+n.save!
+```
 
-To use the newer APNs Api replace `Rpush::Apns::App` with `Rpush::Apns2::App`.
+You should also implement the [ssl_certificate_will_expire](https://github.com/rpush/rpush/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
 
-To use the p8 APNs Api replace `Rpush::Apns::App` with `Rpush::Apnsp8::App`.
+##### Apns (legacy protocol)
 
 ```ruby
-app = Rpush::Apnsp8::App.new
+app = Rpush::Apns::App.new
 app.name = "ios_app"
-app.apn_key = File.read("/path/to/sandbox.p8")
+app.certificate = File.read("/path/to/sandbox.pem")
 app.environment = "development" # APNs environment.
-app.apn_key_id = "APN KEY ID"
-app.team_id = "TEAM ID"
-app.bundle_id = "BUNDLE ID"
+app.password = "certificate password"
 app.connections = 1
 app.save!
 ```
 
 ```ruby
 n = Rpush::Apns::Notification.new
-n.app = Rpush::Apnsp8::App.find_by_name("ios_app")
+n.app = Rpush::Apns::App.find_by_name("ios_app")
 n.device_token = "..." # hex string
 n.alert = "hi mom!"
 n.data = { foo: :bar }
 n.save!
 ```
+
+##### Safari Push Notifications
+
+Using one of the notifications methods above, the `url_args` attribute is available for Safari Push Notifications.
+
+##### Environment
+
+The app `environment` for any Apns* option is "development" for XCode installs, and "production" for app store and TestFlight. Note that for Apns2 you can now use one (production + sandbox) certificate (you don't need a separate "sandbox" or development certificate), but if you do generate a development/sandbox certificate it can only be used for "development". With Apnsp8 tokens, you can target either "development" or "production" environments.
+
 #### Firebase Cloud Messaging
 
 FCM and GCM are – as of writing – compatible with each other. See also [this comment](https://github.com/rpush/rpush/issues/284#issuecomment-228330206) for further references.
@@ -208,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
@@ -256,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/generators/rpush_migration_generator.rb

@@ -52,6 +52,7 @@ class RpushMigrationGenerator < Rails::Generators::Base
     add_rpush_migration('rpush_3_3_1_updates')
     add_rpush_migration('rpush_4_1_0_updates')
     add_rpush_migration('rpush_4_1_1_updates')
+    add_rpush_migration('rpush_4_2_0_updates')
   end
 
   protected

data/lib/generators/templates/rpush.rb

@@ -26,6 +26,10 @@ Rpush.configure do |config|
   # Define a custom logger.
   # config.logger = MyLogger.new
 
+  # By default in foreground mode logs are directed both to the logger and to stdout.
+  # If the logger goes to stdout, you can disable foreground logging to avoid duplication.
+  # config.foreground_logging = false
+
   # config.apns.feedback_receiver.enabled = true
   # config.apns.feedback_receiver.frequency = 60
 

data/lib/generators/templates/rpush_4_2_0_updates.rb

@@ -0,0 +1,10 @@
+class Rpush420Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :sound_is_json, :boolean, null: true, default: false
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :sound_is_json
+  end
+end
+

data/lib/rpush/cli.rb

@@ -14,7 +14,7 @@ module Rpush
     end
 
     class_option :config, type: :string, aliases: '-c', default: default_config_path
-    class_option 'rails-env', type: :string, aliases: '-e', default: 'development'
+    class_option 'rails-env', type: :string, aliases: '-e', default: ENV.fetch('RAILS_ENV', 'development')
 
     option :foreground, type: :boolean, aliases: '-f', default: false
     option 'pid-file', type: :string, aliases: '-p'

data/lib/rpush/client/active_model.rb

@@ -4,10 +4,10 @@ require 'rpush/client/active_model/notification'
 require 'rpush/client/active_model/payload_data_size_validator'
 require 'rpush/client/active_model/registration_ids_count_validator'
 
-require 'rpush/client/active_model/apns/binary_notification_validator'
 require 'rpush/client/active_model/apns/device_token_format_validator'
 require 'rpush/client/active_model/apns/app'
 require 'rpush/client/active_model/apns/notification'
+require 'rpush/client/active_model/apns/notification_payload_size_validator'
 
 require 'rpush/client/active_model/apns2/app'
 require 'rpush/client/active_model/apns2/notification'
@@ -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.rb

@@ -7,15 +7,23 @@ module Rpush
           APNS_PRIORITY_IMMEDIATE = 10
           APNS_PRIORITY_CONSERVE_POWER = 5
           APNS_PRIORITIES = [APNS_PRIORITY_IMMEDIATE, APNS_PRIORITY_CONSERVE_POWER]
+          MAX_PAYLOAD_BYTESIZE = 2048
+
+          module ClassMethods
+            def max_payload_bytesize
+              MAX_PAYLOAD_BYTESIZE
+            end
+          end
 
           def self.included(base)
+            base.extend ClassMethods
             base.instance_eval do
               validates :device_token, presence: true
               validates :badge, numericality: true, allow_nil: true
               validates :priority, inclusion: { in: APNS_PRIORITIES }, allow_nil: true
 
               validates_with Rpush::Client::ActiveModel::Apns::DeviceTokenFormatValidator
-              validates_with Rpush::Client::ActiveModel::Apns::BinaryNotificationValidator
+              validates_with Rpush::Client::ActiveModel::Apns::NotificationPayloadSizeValidator
 
               base.const_set('APNS_DEFAULT_EXPIRY', APNS_DEFAULT_EXPIRY) unless base.const_defined?('APNS_DEFAULT_EXPIRY')
               base.const_set('APNS_PRIORITY_IMMEDIATE', APNS_PRIORITY_IMMEDIATE) unless base.const_defined?('APNS_PRIORITY_IMMEDIATE')

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

@@ -0,0 +1,15 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Apns
+        class NotificationPayloadSizeValidator < ::ActiveModel::Validator
+          def validate(record)
+            limit = record.class.max_payload_bytesize
+            return unless record.payload.bytesize > limit
+            record.errors.add :base, "APN notification cannot be larger than #{limit} bytes. Try condensing your alert and device attributes."
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,20 @@ module Rpush
     module ActiveModel
       module Apns2
         include Rpush::Client::ActiveModel::Apns
+
+        module Notification
+          MAX_PAYLOAD_BYTESIZE = 4096
+
+          module ClassMethods
+            def max_payload_bytesize
+              MAX_PAYLOAD_BYTESIZE
+            end
+          end
+
+          def self.included(base)
+            base.extend ClassMethods
+          end
+        end
       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/gcm/notification.rb

@@ -26,16 +26,16 @@ module Rpush
           # I'm not happy about it, but this will have to do until I can take a further look.
           def priority=(priority)
             case priority
-              when 'high'
+              when 'high', GCM_PRIORITY_HIGH
                 super(GCM_PRIORITY_HIGH)
-              when 'normal'
+              when 'normal', GCM_PRIORITY_NORMAL
                 super(GCM_PRIORITY_NORMAL)
               else
                 errors.add(:priority, 'must be one of either "normal" or "high"')
             end
           end
 
-          def as_json(options = nil)
+          def as_json(options = nil) # rubocop:disable Metrics/PerceivedComplexity
             json = {
                 'registration_ids' => registration_ids,
                 'delay_while_idle' => delay_while_idle,
@@ -43,6 +43,7 @@ module Rpush
             }
             json['collapse_key'] = collapse_key if collapse_key
             json['content_available'] = content_available if content_available
+            json['mutable_content'] = mutable_content if mutable_content
             json['dry_run'] = dry_run if dry_run
             json['notification'] = notification if notification
             json['priority'] = priority_for_notification if priority

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