rpush_extended 3.2.5

data/lib/generators/templates/rpush.rb

@@ -0,0 +1,135 @@
+Rpush.configure do |config|
+
+  # Supported clients are :active_record and :redis
+  config.client = :active_record
+
+  # Options passed to Redis.new
+  # config.redis_options = {}
+
+  # Frequency in seconds to check for new notifications.
+  config.push_poll = 2
+
+  # The maximum number of notifications to load from the store every `push_poll` seconds.
+  # If some notifications are still enqueued internally, Rpush will load the batch_size less
+  # the number enqueued. An exception to this is if the service is able to receive multiple
+  # notification payloads over the connection with a single write, such as APNs.
+  config.batch_size = 100
+
+  # Path to write PID file. Relative to current directory unless absolute.
+  config.pid_file = 'tmp/rpush.pid'
+
+  # Path to log file. Relative to current directory unless absolute.
+  config.log_file = 'log/rpush.log'
+
+  config.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::INFO
+
+  # Define a custom logger.
+  # config.logger = MyLogger.new
+
+  # config.apns.feedback_receiver.enabled = true
+  # config.apns.feedback_receiver.frequency = 60
+
+end
+
+Rpush.reflect do |on|
+
+  # Called with a Rpush::Apns::Feedback instance when feedback is received
+  # from the APNs that a notification has failed to be delivered.
+  # Further notifications should not be sent to the device.
+  # on.apns_feedback do |feedback|
+  # end
+
+  # Called when a notification is queued internally for delivery.
+  # The internal queue for each app runner can be inspected:
+  #
+  # Rpush::Daemon::AppRunner.runners.each do |app_id, runner|
+  #   runner.app
+  #   runner.queue_size
+  # end
+  #
+  # on.notification_enqueued do |notification|
+  # end
+
+  # Called when a notification is successfully delivered.
+  # on.notification_delivered do |notification|
+  # end
+
+  # Called when notification delivery failed.
+  # Call 'error_code' and 'error_description' on the notification for the cause.
+  # on.notification_failed do |notification|
+  # end
+
+  # Called when the notification delivery failed and only the notification ID
+  # is present in memory.
+  # on.notification_id_failed do |app, notification_id, error_code, error_description|
+  # end
+
+  # Called when a notification will be retried at a later date.
+  # Call 'deliver_after' on the notification for the next delivery date
+  # and 'retries' for the number of times this notification has been retried.
+  # on.notification_will_retry do |notification|
+  # end
+
+  # Called when a notification will be retried and only the notification ID
+  # is present in memory.
+  # on.notification_id_will_retry do |app, notification_id, retry_after|
+  # end
+
+  # Called when a TCP connection is lost and will be reconnected.
+  # on.tcp_connection_lost do |app, error|
+  # end
+
+  # Called for each recipient which successfully receives a notification. This
+  # can occur more than once for the same notification when there are multiple
+  # recipients.
+  # on.gcm_delivered_to_recipient do |notification, registration_id|
+  # end
+
+  # Called for each recipient which fails to receive a notification. This
+  # can occur more than once for the same notification when there are multiple
+  # recipients. (do not handle invalid registration IDs here)
+  # on.gcm_failed_to_recipient do |notification, error, registration_id|
+  # end
+
+  # Called when the GCM returns a canonical registration ID.
+  # You will need to replace old_id with canonical_id in your records.
+  # on.gcm_canonical_id do |old_id, canonical_id|
+  # end
+
+  # Called when the GCM returns a failure that indicates an invalid registration id.
+  # You will need to delete the registration_id from your records.
+  # on.gcm_invalid_registration_id do |app, error, registration_id|
+  # end
+
+  # Called when an SSL certificate will expire within 1 month.
+  # Implement on.error to catch errors raised when the certificate expires.
+  # on.ssl_certificate_will_expire do |app, expiration_time|
+  # end
+
+  # Called when an SSL certificate has been revoked.
+  # on.ssl_certificate_revoked do |app, error|
+  # end
+
+  # Called when the ADM returns a canonical registration ID.
+  # You will need to replace old_id with canonical_id in your records.
+  # on.adm_canonical_id do |old_id, canonical_id|
+  # end
+
+  # Called when Failed to deliver to ADM. Check the 'reason' string for further
+  # explanations.
+  #
+  # If the reason is the string 'Unregistered', you should remove
+  # this registration id from your records.
+  # on.adm_failed_to_recipient do |notification, registration_id, reason|
+  # end
+
+  # Called when Failed to deliver to WNS. Check the 'reason' string for further
+  # explanations.
+  # You should remove this uri from your records
+  # on.wns_invalid_channel do |notification, uri, reason|
+  # end
+
+  # Called when an exception is raised.
+  # on.error do |error|
+  # end
+end

data/lib/generators/templates/rpush_2_0_0_updates.rb

@@ -0,0 +1,79 @@
+class Rpush200Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  module Rpush
+    class App < ActiveRecord::Base
+      self.table_name = 'rpush_apps'
+    end
+
+    class Notification < ActiveRecord::Base
+      self.table_name = 'rpush_notifications'
+    end
+  end
+
+  def self.update_type(model, from, to)
+    model.where(type: from).update_all(type: to)
+  end
+
+  def self.up
+    add_column :rpush_notifications, :processing, :boolean, null: false, default: false
+    add_column :rpush_notifications, :priority, :integer, null: true
+
+    if ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1
+      if index_name_exists?(:rpush_notifications, :index_rpush_notifications_multi)
+        remove_index :rpush_notifications, name: :index_rpush_notifications_multi
+      end
+    else
+      if index_name_exists?(:rpush_notifications, :index_rpush_notifications_multi, true)
+        remove_index :rpush_notifications, name: :index_rpush_notifications_multi
+      end
+    end
+
+    add_index :rpush_notifications, [:delivered, :failed], name: 'index_rpush_notifications_multi', where: 'NOT delivered AND NOT failed'
+
+    rename_column :rpush_feedback, :app, :app_id
+
+    if postgresql?
+      execute('ALTER TABLE rpush_feedback ALTER COLUMN app_id TYPE integer USING (trim(app_id)::integer)')
+    else
+      change_column :rpush_feedback, :app_id, :integer
+    end
+
+    [:Apns, :Gcm, :Wpns, :Adm].each do |service|
+      update_type(Rpush200Updates::Rpush::App, "Rpush::#{service}::App", "Rpush::Client::ActiveRecord::#{service}::App")
+      update_type(Rpush200Updates::Rpush::Notification, "Rpush::#{service}::Notification", "Rpush::Client::ActiveRecord::#{service}::Notification")
+    end
+  end
+
+  def self.down
+    [:Apns, :Gcm, :Wpns, :Adm].each do |service|
+      update_type(Rpush200Updates::Rpush::App, "Rpush::Client::ActiveRecord::#{service}::App", "Rpush::#{service}::App")
+      update_type(Rpush200Updates::Rpush::Notification, "Rpush::Client::ActiveRecord::#{service}::Notification", "Rpush::#{service}::Notification")
+    end
+
+    change_column :rpush_feedback, :app_id, :string
+    rename_column :rpush_feedback, :app_id, :app
+
+    if ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1
+      if index_name_exists?(:rpush_notifications, :index_rpush_notifications_multi)
+        remove_index :rpush_notifications, name: :index_rpush_notifications_multi
+      end
+    else
+      if index_name_exists?(:rpush_notifications, :index_rpush_notifications_multi, true)
+        remove_index :rpush_notifications, name: :index_rpush_notifications_multi
+      end
+    end
+
+    add_index :rpush_notifications, [:app_id, :delivered, :failed, :deliver_after], name: 'index_rpush_notifications_multi'
+
+    remove_column :rpush_notifications, :priority
+    remove_column :rpush_notifications, :processing
+  end
+
+  def self.adapter_name
+    env = (defined?(Rails) && Rails.env) ? Rails.env : 'development'
+    Hash[ActiveRecord::Base.configurations[env].map { |k,v| [k.to_sym,v] }][:adapter]
+  end
+
+  def self.postgresql?
+    adapter_name =~ /postgresql|postgis/
+  end
+end

data/lib/generators/templates/rpush_2_1_0_updates.rb

@@ -0,0 +1,11 @@
+class Rpush210Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :url_args, :text, null: true
+    add_column :rpush_notifications, :category, :string, null: true
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :url_args
+    remove_column :rpush_notifications, :category
+  end
+end

data/lib/generators/templates/rpush_2_6_0_updates.rb

@@ -0,0 +1,10 @@
+class Rpush260Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :content_available, :boolean, default: false
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :content_available
+  end
+end
+

data/lib/generators/templates/rpush_2_7_0_updates.rb

@@ -0,0 +1,12 @@
+class Rpush270Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    change_column :rpush_notifications, :alert, :text
+    add_column :rpush_notifications, :notification, :text
+  end
+
+  def self.down
+    change_column :rpush_notifications, :alert, :string
+    remove_column :rpush_notifications, :notification
+  end
+end
+

data/lib/generators/templates/rpush_3_0_0_updates.rb

@@ -0,0 +1,11 @@
+class Rpush300Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :mutable_content, :boolean, default: false
+    change_column :rpush_notifications, :sound, :string, default: nil
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :mutable_content
+    change_column :rpush_notifications, :sound, :string, default: 'default'
+  end
+end

data/lib/generators/templates/rpush_3_0_1_updates.rb

@@ -0,0 +1,13 @@
+class Rpush301Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    change_column_null :rpush_notifications, :mutable_content, false
+    change_column_null :rpush_notifications, :content_available, false
+    change_column_null :rpush_notifications, :alert_is_json, false
+  end
+
+  def self.down
+    change_column_null :rpush_notifications, :mutable_content, true
+    change_column_null :rpush_notifications, :content_available, true
+    change_column_null :rpush_notifications, :alert_is_json, true
+  end
+end

data/lib/generators/templates/rpush_3_1_0_add_pushy.rb

@@ -0,0 +1,9 @@
+class Rpush310AddPushy < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :external_device_id, :string, null: true
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :external_device_id
+  end
+end

data/lib/generators/templates/rpush_3_1_1_updates.rb

@@ -0,0 +1,15 @@
+class Rpush311Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    change_table :rpush_notifications do |t|
+      t.remove_index name: 'index_rpush_notifications_multi'
+      t.index [:delivered, :failed, :processing, :deliver_after, :created_at], name: 'index_rpush_notifications_multi', where: 'NOT delivered AND NOT failed'
+    end
+  end
+
+  def self.down
+    change_table :rpush_notifications do |t|
+      t.remove_index name: 'index_rpush_notifications_multi'
+      t.index [:delivered, :failed], name: 'index_rpush_notifications_multi', where: 'NOT delivered AND NOT failed'
+    end
+  end
+end

data/lib/generators/templates/rpush_3_2_0_add_apns_p8.rb

@@ -0,0 +1,15 @@
+class Rpush320AddApnsP8 < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_apps, :apn_key, :string, null: true
+    add_column :rpush_apps, :apn_key_id, :string, null: true
+    add_column :rpush_apps, :team_id, :string, null: true
+    add_column :rpush_apps, :bundle_id, :string, null: true
+  end
+
+  def self.down
+    remove_column :rpush_apps, :apn_key
+    remove_column :rpush_apps, :apn_key_id
+    remove_column :rpush_apps, :team_id
+    remove_column :rpush_apps, :bundle_id
+  end
+end

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/generators/templates/rpush_3_3_0_updates.rb

@@ -0,0 +1,9 @@
+class Rpush330Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :thread_id, :string, null: true
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :thread_id
+  end
+end

data/lib/generators/templates/rpush_3_3_1_updates.rb

@@ -0,0 +1,11 @@
+class Rpush331Updates < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+  def self.up
+    change_column :rpush_notifications, :device_token, :text, null: true
+    change_column :rpush_feedback, :device_token, :text, null: true
+  end
+
+  def self.down
+    change_column :rpush_notifications, :device_token, :string, { null: true, limit: 64 }
+    change_column :rpush_feedback, :device_token, :string, { null: true, limit: 64 }
+  end
+end

data/lib/rpush/apns_feedback.rb

@@ -0,0 +1,17 @@
+module Rpush
+  def self.apns_feedback
+    require 'rpush/daemon'
+    Rpush::Daemon.common_init
+
+    Rpush::Apns::App.all.each do |app|
+      # Redis stores every App type on the same namespace, hence the
+      # additional filtering
+      next unless app.service_name == 'apns'
+
+      receiver = Rpush::Daemon::Apns::FeedbackReceiver.new(app)
+      receiver.check_for_feedback
+    end
+
+    nil
+  end
+end

data/lib/rpush/cli.rb

@@ -0,0 +1,213 @@
+# encoding: UTF-8
+
+require 'thor'
+require 'ansi/code'
+
+module Rpush
+  class CLI < Thor
+    def self.detect_rails?
+      ['bin/rails', 'script/rails'].any? { |path| File.exist?(path) }
+    end
+
+    def self.default_config_path
+      detect_rails? ? 'config/initializers/rpush.rb' : 'config/rpush.rb'
+    end
+
+    class_option :config, type: :string, aliases: '-c', default: default_config_path
+    class_option 'rails-env', type: :string, aliases: '-e', default: 'development'
+
+    option :foreground, type: :boolean, aliases: '-f', default: false
+    option 'pid-file', type: :string, aliases: '-p'
+    desc 'start', 'Start Rpush'
+    def start
+      config_setup
+
+      require 'rpush/daemon'
+      Rpush::Daemon.start
+    end
+
+    desc 'stop', 'Stop Rpush'
+    option 'pid-file', type: :string, aliases: '-p'
+    def stop
+      config_setup
+      pid = rpush_process_pid
+      return unless pid
+
+      STDOUT.write "* Stopping Rpush (pid #{pid})... "
+      STDOUT.flush
+      Process.kill('TERM', pid)
+
+      loop do
+        begin
+          Process.getpgid(pid)
+          sleep 0.05
+        rescue Errno::ESRCH
+          break
+        end
+      end
+
+      puts ANSI.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...' }
+      $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
+
+        install_migrations = answer == 'y'
+      end
+
+      Rails::Generators.invoke('rpush_migration', ['--force']) if install_migrations
+
+      puts "\n* #{ANSI.green { 'Next steps:' }}"
+      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."
+      puts "  - Run 'rpush help' for commands and options."
+    end
+
+    desc 'push', 'Deliver all pending notifications and then exit'
+    def push
+      config_setup
+      Rpush.config.foreground = true
+
+      Rpush.push
+    end
+
+    desc 'status', 'Show the internal status of the running Rpush instance.'
+    def status
+      config_setup
+
+      require 'rpush/daemon'
+      rpc = Rpush::Daemon::Rpc::Client.new(rpush_process_pid)
+      status = rpc.status
+      rpc.close
+      puts humanize_json(status)
+    end
+
+    desc 'version', 'Print Rpush version'
+    def version
+      puts Rpush::VERSION
+    end
+
+    private
+
+    def config_setup
+      underscore_option_names
+      check_ruby_version
+      configure_rpush
+    end
+
+    def configure_rpush
+      load_rails_environment || load_standalone
+    end
+
+    def load_rails_environment
+      if detect_rails? && options['rails_env']
+        STDOUT.write "* Booting Rails '#{options[:rails_env]}' environment... "
+        STDOUT.flush
+        ENV['RAILS_ENV'] = options['rails_env']
+        load 'config/environment.rb'
+        Rpush.config.update(options)
+        puts ANSI.green { '✔' }
+
+        return true
+      end
+
+      false
+    end
+
+    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.")
+        exit 1
+      else
+        load options[:config]
+        Rpush.config.update(options)
+      end
+    end
+
+    def detect_rails?
+      self.class.detect_rails?
+    end
+
+    def default_config_path
+      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.2.2' && RUBY_ENGINE == 'ruby'
+    end
+
+    def underscore_option_names
+      # Underscore option names so that they map directly to Configuration options.
+      new_options = options.dup
+
+      options.each do |k, v|
+        new_k = k.to_s.tr('-', '_')
+
+        if k != new_k
+          new_options.delete(k)
+          new_options[new_k] = v
+        end
+      end
+
+      new_options.freeze
+      self.options = new_options
+    end
+
+    def rpush_process_pid
+      if Rpush.config.pid_file.blank?
+        STDERR.puts(ANSI.red { 'ERROR: ' } + 'config.pid_file is not set.')
+        exit 1
+      end
+
+      unless File.exist?(Rpush.config.pid_file)
+        STDERR.puts("* Rpush isn't running? #{Rpush.config.pid_file} does not exist.")
+        exit 1
+      end
+
+      File.read(Rpush.config.pid_file).strip.to_i
+    end
+
+    def humanize_json(node, str = '', depth = 0) # rubocop:disable Metrics/PerceivedComplexity
+      if node.is_a?(Hash)
+        node = node.sort_by { |_, v| [Array, Hash].include?(v.class) ? 1 : 0 }
+        node.each do |k, v|
+          if [Array, Hash].include?(v.class)
+            str << "\n#{'  ' * depth}#{k}:\n"
+            humanize_json(v, str, depth + 1)
+          else
+            str << "#{'  ' * depth}#{k}: #{v}\n"
+          end
+        end
+      elsif node.is_a?(Array)
+        node.each do |v|
+          str << "\n" if v.is_a?(Hash)
+          humanize_json(v, str, depth)
+        end
+      else
+        str << "#{'  ' * depth}#{node}\n"
+      end
+
+      str
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Adm
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :client_id, :client_secret, presence: true
+            end
+          end
+
+          def access_token_expired?
+            access_token_expiration.nil? || access_token_expiration < Time.now
+          end
+
+          def service_name
+            'adm'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Adm
+        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'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Adm
+        module Notification
+          def self.included(base)
+            base.instance_eval do
+              validates :registration_ids, presence: true
+
+              validates_with Rpush::Client::ActiveModel::PayloadDataSizeValidator, limit: 6144
+              validates_with Rpush::Client::ActiveModel::RegistrationIdsCountValidator, limit: 100
+
+              validates_with Rpush::Client::ActiveModel::Adm::DataValidator
+            end
+          end
+
+          def as_json(options = nil)
+            json = { 'data' => data }
+            json['consolidationKey'] = collapse_key if collapse_key
+            # number of seconds before message is expired
+            json['expiresAfter'] = expiry if expiry
+            json
+          end
+        end
+      end
+    end
+  end
+end