rpush 4.0.1 → 5.1.0

data/README.md

@@ -21,7 +21,7 @@ Rpush aims to be the *de facto* gem for sending push notifications in Ruby. Its
 
 #### 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**.

data/lib/generators/rpush_migration_generator.rb

@@ -50,6 +50,9 @@ class RpushMigrationGenerator < Rails::Generators::Base
     add_rpush_migration('rpush_3_2_4_updates')
     add_rpush_migration('rpush_3_3_0_updates')
     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_4_1_0_updates.rb

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

data/lib/generators/templates/rpush_4_1_1_updates.rb

@@ -0,0 +1,9 @@
+class Rpush411Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_apps, :feedback_enabled, :boolean, default: true
+  end
+
+  def self.down
+    remove_column :rpush_apps, :feedback_enabled
+  end
+end

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/apns_feedback.rb

@@ -7,6 +7,7 @@ module Rpush
       # Redis stores every App type on the same namespace, hence the
       # additional filtering
       next unless app.service_name == 'apns'
+      next unless app.feedback_enabled
 
       receiver = Rpush::Daemon::Apns::FeedbackReceiver.new(app)
       receiver.check_for_feedback

data/lib/rpush/cli.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 require 'thor'
-require 'ansi/code'
+require 'rainbow'
 
 module Rpush
   class CLI < Thor
@@ -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'
@@ -46,37 +46,29 @@ module Rpush
         end
       end
 
-      puts ANSI.green { '✔' }
+      puts Rainbow('✔').green
     end
 
     desc 'init', 'Initialize Rpush into the current directory'
     option 'active-record', type: :boolean, desc: 'Install ActiveRecord migrations'
     def init
       underscore_option_names
-      check_ruby_version
       require 'rails/generators'
 
-      puts "* " + ANSI.green { 'Installing config...' }
+      puts "* " + Rainbow('Installing config...').green
       $RPUSH_CONFIG_PATH = default_config_path # rubocop:disable Style/GlobalVars
       Rails::Generators.invoke('rpush_config')
 
       install_migrations = options['active_record']
 
       unless options.key?('active_record')
-        has_answer = false
-        until has_answer
-          STDOUT.write "\n* #{ANSI.green { 'Install ActiveRecord migrations?' }} [y/n]: "
-          STDOUT.flush
-          answer = STDIN.gets.chomp.downcase
-          has_answer = %w(y n).include?(answer)
-        end
-
+        answer = ask("\n* #{Rainbow('Install ActiveRecord migrations?').green}", limited_to: %w[y n])
         install_migrations = answer == 'y'
       end
 
       Rails::Generators.invoke('rpush_migration', ['--force']) if install_migrations
 
-      puts "\n* #{ANSI.green { 'Next steps:' }}"
+      puts "\n* #{Rainbow('Next steps:').green}"
       puts "  - Run 'bundle exec rake db:migrate'." if install_migrations
       puts "  - Review and update your configuration in #{default_config_path}."
       puts "  - Create your first app, see https://github.com/rpush/rpush for examples."
@@ -111,7 +103,6 @@ module Rpush
 
     def config_setup
       underscore_option_names
-      check_ruby_version
       configure_rpush
     end
 
@@ -126,7 +117,7 @@ module Rpush
         ENV['RAILS_ENV'] = options['rails_env']
         load 'config/environment.rb'
         Rpush.config.update(options)
-        puts ANSI.green { '✔' }
+        puts Rainbow('✔').green
 
         return true
       end
@@ -136,7 +127,7 @@ module Rpush
 
     def load_standalone
       if !File.exist?(options[:config])
-        STDERR.puts(ANSI.red { 'ERROR: ' } + "#{options[:config]} does not exist. Please run 'rpush init' to generate it or specify the --config option.")
+        STDERR.puts(Rainbow('ERROR: ').red + "#{options[:config]} does not exist. Please run 'rpush init' to generate it or specify the --config option.")
         exit 1
       else
         load options[:config]
@@ -152,10 +143,6 @@ module Rpush
       self.class.default_config_path
     end
 
-    def check_ruby_version
-      STDERR.puts(ANSI.yellow { 'WARNING: ' } + "You are using an old and unsupported version of Ruby.") if RUBY_VERSION < '2.3.0' && RUBY_ENGINE == 'ruby'
-    end
-
     def underscore_option_names
       # Underscore option names so that they map directly to Configuration options.
       new_options = options.dup
@@ -175,7 +162,7 @@ module Rpush
 
     def rpush_process_pid
       if Rpush.config.pid_file.blank?
-        STDERR.puts(ANSI.red { 'ERROR: ' } + 'config.pid_file is not set.')
+        STDERR.puts(Rainbow('ERROR: ').red + 'config.pid_file is not set.')
         exit 1
       end
 

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'

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[: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/notification.rb

@@ -11,6 +11,7 @@ module Rpush
             base.instance_eval do
               validates :registration_ids, presence: true
               validates :priority, inclusion: { in: GCM_PRIORITIES }, allow_nil: true
+              validates :dry_run, inclusion: { in: [true, false] }
 
               validates_with Rpush::Client::ActiveModel::PayloadDataSizeValidator, limit: 4096
               validates_with Rpush::Client::ActiveModel::RegistrationIdsCountValidator, limit: 1000
@@ -25,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,
@@ -42,6 +43,8 @@ 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
             json['time_to_live'] = expiry if expiry

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

@@ -3,6 +3,13 @@ module Rpush
     module ActiveModel
       module Wns
         module Notification
+          WNS_PRIORITY_HIGH = 1
+          WNS_PRIORITY_MEDIUM = 2
+          WNS_PRIORITY_LOW = 3
+          WNS_PRIORITY_VERY_LOW = 4
+
+          WNS_PRIORITIES = [WNS_PRIORITY_HIGH, WNS_PRIORITY_MEDIUM, WNS_PRIORITY_LOW, WNS_PRIORITY_VERY_LOW]
+
           module InstanceMethods
             def alert=(value)
               return unless value
@@ -23,6 +30,7 @@ module Rpush
               validates :uri, presence: true
               validates :uri, format: { with: %r{https?://[\S]+} }
               validates :data, presence: true, unless: :skip_data_validation?
+              validates :priority, inclusion: { in: WNS_PRIORITIES }, allow_nil: true
             end
           end
         end

data/lib/rpush/client/active_record.rb

@@ -5,6 +5,7 @@ require 'rpush/client/active_model'
 require 'rpush/client/active_record/notification'
 require 'rpush/client/active_record/app'
 
+require 'rpush/client/active_record/apns/active_record_serializable_notification'
 require 'rpush/client/active_record/apns/notification'
 require 'rpush/client/active_record/apns/feedback'
 require 'rpush/client/active_record/apns/app'

data/lib/rpush/client/active_record/apns/active_record_serializable_notification.rb

@@ -0,0 +1,65 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Apns
+        module ActiveRecordSerializableNotification
+          def alert=(alert)
+            if alert.is_a?(Hash)
+              write_attribute(:alert, multi_json_dump(alert))
+              self.alert_is_json = true if has_attribute?(:alert_is_json)
+            else
+              write_attribute(:alert, alert)
+              self.alert_is_json = false if has_attribute?(:alert_is_json)
+            end
+          end
+
+          def alert
+            string_or_json = read_attribute(:alert)
+
+            if has_attribute?(:alert_is_json)
+              if alert_is_json?
+                multi_json_load(string_or_json)
+              else
+                string_or_json
+              end
+            else
+              begin
+                multi_json_load(string_or_json)
+              rescue StandardError
+                string_or_json
+              end
+            end
+          end
+
+          def sound=(sound)
+            if sound.is_a?(Hash)
+              write_attribute(:sound, multi_json_dump(sound))
+              self.sound_is_json = true if has_attribute?(:sound_is_json)
+            else
+              write_attribute(:sound, sound)
+              self.sound_is_json = false if has_attribute?(:sound_is_json)
+            end
+          end
+
+          def sound
+            string_or_json = read_attribute(:sound)
+
+            if has_attribute?(:sound_is_json)
+              if sound_is_json?
+                multi_json_load(string_or_json)
+              else
+                string_or_json
+              end
+            else
+              begin
+                multi_json_load(string_or_json)
+              rescue StandardError
+                string_or_json
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,36 +3,8 @@ module Rpush
     module ActiveRecord
       module Apns
         class Notification < Rpush::Client::ActiveRecord::Notification
-          include Deprecatable
           include Rpush::Client::ActiveModel::Apns::Notification
-
-          def alert=(alert)
-            if alert.is_a?(Hash)
-              write_attribute(:alert, multi_json_dump(alert))
-              self.alert_is_json = true if has_attribute?(:alert_is_json)
-            else
-              write_attribute(:alert, alert)
-              self.alert_is_json = false if has_attribute?(:alert_is_json)
-            end
-          end
-
-          def alert
-            string_or_json = read_attribute(:alert)
-
-            if has_attribute?(:alert_is_json)
-              if alert_is_json?
-                multi_json_load(string_or_json)
-              else
-                string_or_json
-              end
-            else
-              begin
-                multi_json_load(string_or_json)
-              rescue StandardError
-                string_or_json
-              end
-            end
-          end
+          include ActiveRecordSerializableNotification
         end
       end
     end

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

@@ -2,7 +2,10 @@ module Rpush
   module Client
     module ActiveRecord
       module Apns2
-        class Notification < Rpush::Client::ActiveRecord::Apns::Notification
+        class Notification < Rpush::Client::ActiveRecord::Notification
+          include Rpush::Client::ActiveModel::Apns::Notification
+          include Rpush::Client::ActiveModel::Apns2::Notification
+          include Rpush::Client::ActiveRecord::Apns::ActiveRecordSerializableNotification
         end
       end
     end

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

@@ -6,7 +6,7 @@ module Rpush
 
         has_many :notifications, class_name: 'Rpush::Client::ActiveRecord::Notification', dependent: :destroy
 
-        validates :name, presence: true, uniqueness: { scope: [:type, :environment] }
+        validates :name, presence: true, uniqueness: { scope: [:type, :environment], case_sensitive: true }
       end
     end
   end

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

@@ -21,7 +21,7 @@ module Rpush
         def notification=(attrs)
           return unless attrs
           fail ArgumentError, 'must be a Hash' unless attrs.is_a?(Hash)
-          write_attribute(:notification, multi_json_dump(attrs.merge(data || {})))
+          write_attribute(:notification, multi_json_dump(attrs.merge(notification || {})))
         end
 
         def registration_ids=(ids)