activity_notification 2.1.2 → 2.2.2

data/gemfiles/Gemfile.rails-5.0

@@ -11,13 +11,15 @@ group :development do
 end
 
 group :test do
+  gem 'rspec-rails', '< 4.0.0'
   gem 'rails-controller-testing'
   gem 'action-cable-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'committee'
   gem 'committee-rails'
-  gem 'coveralls', require: false
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
 end
 
 gem 'dotenv-rails', groups: [:development, :test]

data/gemfiles/Gemfile.rails-5.1

@@ -10,13 +10,15 @@ group :development do
 end
 
 group :test do
+  gem 'rspec-rails', '< 4.0.0'
   gem 'rails-controller-testing'
   gem 'action-cable-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'committee'
   gem 'committee-rails'
-  gem 'coveralls', require: false
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
 end
 
 gem 'dotenv-rails', groups: [:development, :test]

data/gemfiles/Gemfile.rails-5.2

@@ -10,13 +10,15 @@ group :development do
 end
 
 group :test do
+  gem 'rspec-rails', '< 4.0.0'
   gem 'rails-controller-testing'
   gem 'action-cable-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'committee'
   gem 'committee-rails'
-  gem 'coveralls', require: false
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
 end
 
 gem 'dotenv-rails', groups: [:development, :test]

data/gemfiles/Gemfile.rails-6.0

@@ -10,14 +10,13 @@ group :development do
 end
 
 group :test do
-  #TODO https://github.com/rails/rails/issues/35417
-  gem 'rspec-rails', '4.0.0.beta4'
   gem 'rails-controller-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'committee'
   gem 'committee-rails'
-  gem 'coveralls', require: false
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
 end
 
 gem 'dotenv-rails', groups: [:development, :test]

data/gemfiles/{Gemfile.rails-4.2 → Gemfile.rails-6.1}

@@ -2,10 +2,7 @@ source 'https://rubygems.org'
 
 gemspec path: '../'
 
-gem 'rails', '~> 4.2.0'
-gem 'sqlite3', '~> 1.3.13'
-gem 'mysql2', '~> 0.4.10'
-gem 'pg', '~> 0.21.0'
+gem 'rails', '~> 6.1.0'
 
 group :development do
   gem 'bullet'
@@ -13,11 +10,13 @@ group :development do
 end
 
 group :test do
+  gem 'rails-controller-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'committee'
   gem 'committee-rails'
-  gem 'coveralls', require: false
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
 end
 
 gem 'dotenv-rails', groups: [:development, :test]

data/lib/activity_notification/apis/notification_api.rb

@@ -495,16 +495,23 @@ module ActivityNotification
 
         notification = new({ target: target, notifiable: notifiable, key: key, group: group, parameters: parameters, notifier: notifier, group_owner: group_owner })
         notification.prepare_to_store.save
+        notification.after_store
         notification
       end
     end
 
+    # :nocov:
     # Returns prepared notification object to store
     # @return [Object] prepared notification object to store
     def prepare_to_store
       self
     end
 
+    # Call after store action with stored notification
+    def after_store
+    end
+    # :nocov:
+
     # Sends notification email to the target.
     #
     # @param [Hash] options Options for notification email

data/lib/activity_notification/apis/subscription_api.rb

@@ -21,7 +21,7 @@ module ActivityNotification
         #   @subscriptions = @user.subscriptions.filtered_by_options({ custom_filter: ["created_at >= ?", time.hour.ago] })
         # @scope class
         # @param [Hash] options Options for filter
-        # @option options [String]     :filtered_by_key        (nil) Key of the subscription for filter 
+        # @option options [String]     :filtered_by_key        (nil) Key of the subscription for filter
         # @option options [Array|Hash] :custom_filter          (nil) Custom subscription filter (e.g. ["created_at >= ?", time.hour.ago] or ['created_at.gt': time.hour.ago])
         # @return [ActiveRecord_AssociationRelation<Subscription>, Mongoid::Criteria<Notificaion>] Database query of filtered subscriptions
         scope :filtered_by_options, ->(options = {}) {
@@ -127,8 +127,8 @@ module ActivityNotification
     # @return [Boolean] If successfully updated subscription instance
     def subscribe(options = {})
       subscribed_at = options[:subscribed_at] || Time.current
-      with_email_subscription = options.has_key?(:with_email_subscription) ? options[:with_email_subscription] : true
-      with_optional_targets   = options.has_key?(:with_optional_targets) ? options[:with_optional_targets] : true
+      with_email_subscription = options.has_key?(:with_email_subscription) ? options[:with_email_subscription] : ActivityNotification.config.subscribe_to_email_as_default
+      with_optional_targets   = options.has_key?(:with_optional_targets) ? options[:with_optional_targets] : ActivityNotification.config.subscribe_to_optional_targets_as_default
       new_attributes = { subscribing: true, subscribed_at: subscribed_at, optional_targets: optional_targets }
       new_attributes = new_attributes.merge(subscribing_to_email: true, subscribed_to_email_at: subscribed_at) if with_email_subscription
       if with_optional_targets
@@ -184,7 +184,7 @@ module ActivityNotification
     # @param [Symbol]  optional_target_name Symbol class name of the optional target implementation (e.g. :amazon_sns, :slack)
     # @param [Boolean] subscribe_as_default Default subscription value to use when the subscription record does not configured
     # @return [Boolean] If the target subscribes to the specified optional target
-    def subscribing_to_optional_target?(optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_as_default)
+    def subscribing_to_optional_target?(optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_to_optional_targets_as_default)
       optional_target_key = Subscription.to_optional_target_key(optional_target_name)
       subscribe_as_default ?
         !optional_targets.has_key?(optional_target_key) || optional_targets[optional_target_key] :
@@ -244,4 +244,4 @@ module ActivityNotification
       end
 
   end
-end
+end

data/lib/activity_notification/common.rb

@@ -16,7 +16,11 @@ module ActivityNotification
     when Symbol
       symbol_method = context.method(thing)
       if symbol_method.arity > 1
-        symbol_method.call(ActivityNotification.get_controller, *args)
+        if args.last.kind_of?(Hash)
+          symbol_method.call(ActivityNotification.get_controller, *args[0...-1], **args[-1])
+        else
+          symbol_method.call(ActivityNotification.get_controller, *args)
+        end
       elsif symbol_method.arity > 0
         symbol_method.call(ActivityNotification.get_controller)
       else
@@ -74,7 +78,11 @@ module ActivityNotification
       when Symbol
         symbol_method = method(thing)
         if symbol_method.arity > 0
-          symbol_method.call(*args)
+          if args.last.kind_of?(Hash)
+            symbol_method.call(*args[0...-1], **args[-1])
+          else
+            symbol_method.call(*args)
+          end
         else
           symbol_method.call
         end
@@ -98,9 +106,12 @@ module ActivityNotification
     end
 
     # Convets to class name.
+    # This function returns base_class name for STI models if the class responds to base_class method.
+    # @see https://github.com/simukappu/activity_notification/issues/89
+    # @see https://github.com/simukappu/activity_notification/pull/139
     # @return [String] Class name
     def to_class_name
-      self.class.name
+      self.class.respond_to?(:base_class) ? self.class.base_class.name : self.class.name
     end
 
     # Convets to singularized model name (resource name).
@@ -128,4 +139,4 @@ module ActivityNotification
       "#{self.printable_type} (#{id})"
     end
   end
-end
+end

data/lib/activity_notification/config.rb

@@ -61,6 +61,18 @@ module ActivityNotification
     #   @return [Boolean] Default subscription value to use when the subscription record does not configured.
     attr_accessor :subscribe_as_default
 
+    # @overload subscribe_to_email_as_default=(value)
+    #   Sets default email subscription value to use when the subscription record does not configured
+    #   @param [Boolean] subscribe_to_email_as_default The new subscribe_to_email_as_default
+    #   @return [Boolean] Default email subscription value to use when the subscription record does not configured.
+    attr_writer :subscribe_to_email_as_default
+
+    # @overload subscribe_to_optional_targets_as_default=(value)
+    #   Sets default optional target subscription value to use when the subscription record does not configured
+    #   @param [Boolean] subscribe_to_optional_targets_as_default The new subscribe_to_optional_targets_as_default
+    #   @return [Boolean] Default optional target subscription value to use when the subscription record does not configured.
+    attr_writer :subscribe_to_optional_targets_as_default
+
     # @overload mailer_sender
     #   Returns email address as sender of notification email
     #   @return [String] Email address as sender of notification email.
@@ -205,29 +217,31 @@ module ActivityNotification
     # These configuration can be overridden in initializer.
     # @return [Config] A new instance of Config
     def initialize
-      @enabled                         = true
-      @orm                             = :active_record
-      @notification_table_name         = 'notifications'
-      @subscription_table_name         = 'subscriptions'
-      @email_enabled                   = false
-      @subscription_enabled            = false
-      @subscribe_as_default            = true
-      @mailer_sender                   = nil
-      @mailer                          = 'ActivityNotification::Mailer'
-      @parent_mailer                   = 'ActionMailer::Base'
-      @parent_job                      = 'ActiveJob::Base'
-      @parent_controller               = 'ApplicationController'
-      @parent_channel                  = 'ActionCable::Channel::Base'
-      @mailer_templates_dir            = 'activity_notification/mailer'
-      @opened_index_limit              = 10
-      @active_job_queue                = :activity_notification
-      @composite_key_delimiter         = '#'
-      @store_with_associated_records   = false
-      @action_cable_enabled            = false
-      @action_cable_api_enabled        = false
-      @action_cable_with_devise        = false
-      @notification_channel_prefix     = 'activity_notification_channel'
-      @notification_api_channel_prefix = 'activity_notification_api_channel'
+      @enabled                                  = true
+      @orm                                      = :active_record
+      @notification_table_name                  = 'notifications'
+      @subscription_table_name                  = 'subscriptions'
+      @email_enabled                            = false
+      @subscription_enabled                     = false
+      @subscribe_as_default                     = true
+      @subscribe_to_email_as_default            = nil
+      @subscribe_to_optional_targets_as_default = nil
+      @mailer_sender                            = nil
+      @mailer                                   = 'ActivityNotification::Mailer'
+      @parent_mailer                            = 'ActionMailer::Base'
+      @parent_job                               = 'ActiveJob::Base'
+      @parent_controller                        = 'ApplicationController'
+      @parent_channel                           = 'ActionCable::Channel::Base'
+      @mailer_templates_dir                     = 'activity_notification/mailer'
+      @opened_index_limit                       = 10
+      @active_job_queue                         = :activity_notification
+      @composite_key_delimiter                  = '#'
+      @store_with_associated_records            = false
+      @action_cable_enabled                     = false
+      @action_cable_api_enabled                 = false
+      @action_cable_with_devise                 = false
+      @notification_channel_prefix              = 'activity_notification_channel'
+      @notification_api_channel_prefix          = 'activity_notification_api_channel'
     end
 
     # Sets ORM name for ActivityNotification (:active_record, :mongoid or :dynamodb)
@@ -245,5 +259,21 @@ module ActivityNotification
       if store_with_associated_records && [:mongoid, :dynamoid].exclude?(@orm) then raise ActivityNotification::ConfigError, "config.store_with_associated_records can be set true only when you use mongoid or dynamoid ORM." end
       @store_with_associated_records = store_with_associated_records
     end
+
+    # Returns default email subscription value to use when the subscription record does not configured
+    # @return [Boolean] Default email subscription value to use when the subscription record does not configured.
+    def subscribe_to_email_as_default
+      return false unless @subscribe_as_default
+
+      @subscribe_to_email_as_default.nil? ? @subscribe_as_default : @subscribe_to_email_as_default
+    end
+
+    # Returns default optional target subscription value to use when the subscription record does not configured
+    # @return [Boolean] Default optinal target subscription value to use when the subscription record does not configured.
+    def subscribe_to_optional_targets_as_default
+      return false unless @subscribe_as_default
+
+      @subscribe_to_optional_targets_as_default.nil? ? @subscribe_as_default : @subscribe_to_optional_targets_as_default
+    end
   end
 end

data/lib/activity_notification/controllers/common_controller.rb

@@ -26,7 +26,7 @@ module ActivityNotification
           target_class = target_type.to_model_class
           @target = params[:target_id].present? ?
             target_class.find_by!(id: params[:target_id]) :
-            target_class.find_by!(id: params["#{target_type.to_resource_name}_id"])
+            target_class.find_by!(id: params["#{target_type.to_resource_name[/([^\/]+)$/]}_id"])
         else
           render status: 400, json: error_response(code: 400, message: "Invalid parameter", type: "Parameter is missing or the value is empty: target_type")
         end
@@ -130,25 +130,9 @@ module ActivityNotification
             load_index if params[:reload].to_s.to_boolean(true)
             format.js
           else
-            compatibly_redirect_back(@index_options) and return
+            redirect_back(fallback_location: { action: :index }, **@index_options) and return
           end
         end
       end
-
-      # Redirect to back.
-      # @api protected
-      # @return [Boolean] True
-      def compatibly_redirect_back(request_params = {})
-        # :nocov:
-        if Rails::VERSION::MAJOR >= 5
-          redirect_back fallback_location: { action: :index }, **request_params
-        elsif request.referer
-          redirect_to :back, **request_params
-        else
-          redirect_to action: :index, **request_params
-        end
-        # :nocov:
-        true
-      end
   end
 end

data/lib/activity_notification/models/concerns/notifiable.rb

@@ -25,8 +25,8 @@ module ActivityNotification
                       :_notifier,
                       :_notification_parameters,
                       :_notification_email_allowed,
-                      :_notification_action_cable_allowed,
-                      :_notification_action_cable_api_allowed,
+                      :_notifiable_action_cable_allowed,
+                      :_notifiable_action_cable_api_allowed,
                       :_notifiable_path,
                       :_printable_notifiable_name,
                       :_optional_targets
@@ -55,8 +55,8 @@ module ActivityNotification
         self._notifier                              = {}
         self._notification_parameters               = {}
         self._notification_email_allowed            = {}
-        self._notification_action_cable_allowed     = {}
-        self._notification_action_cable_api_allowed = {}
+        self._notifiable_action_cable_allowed       = {}
+        self._notifiable_action_cable_api_allowed   = {}
         self._notifiable_path                       = {}
         self._printable_notifiable_name             = {}
         self._optional_targets                      = {}
@@ -162,10 +162,10 @@ module ActivityNotification
     # @param [Object] target Target instance to notify
     # @param [String] key Key of the notification
     # @return [Boolean] If publishing WebSocket using ActionCable is allowed for the notifiable
-    def notification_action_cable_allowed?(target, key = nil)
+    def notifiable_action_cable_allowed?(target, key = nil)
       resolve_parameter(
-        "notification_action_cable_allowed_for_#{cast_to_resources_name(target.class)}?",
-        _notification_action_cable_allowed[cast_to_resources_sym(target.class)],
+        "notifiable_action_cable_allowed_for_#{cast_to_resources_name(target.class)}?",
+        _notifiable_action_cable_allowed[cast_to_resources_sym(target.class)],
         ActivityNotification.config.action_cable_enabled,
         target, key)
     end
@@ -176,10 +176,10 @@ module ActivityNotification
     # @param [Object] target Target instance to notify
     # @param [String] key Key of the notification
     # @return [Boolean] If publishing WebSocket API using ActionCable is allowed for the notifiable
-    def notification_action_cable_api_allowed?(target, key = nil)
+    def notifiable_action_cable_api_allowed?(target, key = nil)
       resolve_parameter(
-        "notification_action_cable_api_allowed_for_#{cast_to_resources_name(target.class)}?",
-        _notification_action_cable_api_allowed[cast_to_resources_sym(target.class)],
+        "notifiable_action_cable_api_allowed_for_#{cast_to_resources_name(target.class)}?",
+        _notifiable_action_cable_api_allowed[cast_to_resources_sym(target.class)],
         ActivityNotification.config.action_cable_api_enabled,
         target, key)
     end
@@ -456,7 +456,7 @@ module ActivityNotification
           unless generated_notifications.to_a.empty?
             record = self.class.human_attribute_name("generated_notifications_as_notifiable_for_#{target_type.to_s.pluralize.underscore}").downcase
             self.errors.add(:base, :'restrict_dependent_destroy.has_many', record: record)
-            if Rails::VERSION::MAJOR >= 5 then throw(:abort) else false end
+            throw(:abort)
           end
         when :destroy
           generated_notifications.each { |n| n.destroy }
@@ -482,7 +482,7 @@ module ActivityNotification
       # Casts to symbol of resources name.
       # @api private
       def cast_to_resources_sym(target_type)
-        target_type.to_s.to_resources_name.to_sym
+        cast_to_resources_name(target_type).to_sym
       end
   end
 end

data/lib/activity_notification/models/concerns/subscriber.rb

@@ -61,7 +61,9 @@ module ActivityNotification
     def build_subscription(subscription_params = {})
       created_at = Time.current
       if subscription_params[:subscribing] == false && subscription_params[:subscribing_to_email].nil?
-        subscription_params[:subscribing_to_email] = subscription_params[:subscribing] 
+        subscription_params[:subscribing_to_email] = subscription_params[:subscribing]
+      elsif subscription_params[:subscribing_to_email].nil?
+        subscription_params[:subscribing_to_email] = ActivityNotification.config.subscribe_to_email_as_default
       end
       subscription = Subscription.new(subscription_params)
       subscription.assign_attributes(target: self)
@@ -157,7 +159,7 @@ module ActivityNotification
       # @param [String]  key                  Key of the notification
       # @param [Boolean] subscribe_as_default Default subscription value to use when the subscription record does not configured
       # @return [Boolean] If the target subscribes to the notification
-      def _subscribes_to_notification_email?(key, subscribe_as_default = ActivityNotification.config.subscribe_as_default)
+      def _subscribes_to_notification_email?(key, subscribe_as_default = ActivityNotification.config.subscribe_to_email_as_default)
         evaluate_subscription(subscriptions.where(key: key).first, :subscribing_to_email?, subscribe_as_default)
       end
       alias_method :_subscribes_to_email?, :_subscribes_to_notification_email?
@@ -170,7 +172,7 @@ module ActivityNotification
       # @param [String, Symbol] optional_target_name Class name of the optional target implementation (e.g. :amazon_sns, :slack)
       # @param [Boolean]        subscribe_as_default Default subscription value to use when the subscription record does not configured
       # @return [Boolean] If the target subscribes to the specified optional target
-      def _subscribes_to_optional_target?(key, optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_as_default)
+      def _subscribes_to_optional_target?(key, optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_to_optional_targets_as_default)
         _subscribes_to_notification?(key, subscribe_as_default) &&
           evaluate_subscription(subscriptions.where(key: key).first, :subscribing_to_optional_target?, subscribe_as_default, optional_target_name, subscribe_as_default)
       end
@@ -189,4 +191,4 @@ module ActivityNotification
       end
 
   end
-end
+end

data/lib/activity_notification/models/concerns/swagger/notification_schema.rb

@@ -90,7 +90,7 @@ module ActivityNotification
               type: :string
             }
             key :example, {
-              "test_default_param": "1"
+              test_default_param: "1"
             }
           end
           property :opened_at do
@@ -139,28 +139,28 @@ module ActivityNotification
                 key :type, :object
                 key :description, "Associated target model in your application"
                 key :example, {
-                  "id": 1,
-                  "email": "ichiro@example.com",
-                  "name": "Ichiro",
-                  "created_at": Time.current,
-                  "updated_at": Time.current,
-                  "provider": "email",
-                  "uid": "",
-                  "printable_type": "User",
-                  "printable_target_name": "Ichiro"
+                  id: 1,
+                  email: "ichiro@example.com",
+                  name: "Ichiro",
+                  created_at: Time.current,
+                  updated_at: Time.current,
+                  provider: "email",
+                  uid: "",
+                  printable_type: "User",
+                  printable_target_name: "Ichiro"
                 }
               end
               property :notifiable do
                 key :type, :object
                 key :description, "Associated notifiable model in your application"
                 key :example, {
-                  "id": 22,
-                  "user_id": 2,
-                  "article_id": 11,
-                  "body": "This is the first Stephen's comment to Ichiro's article.",
-                  "created_at": Time.current,
-                  "updated_at": Time.current,
-                  "printable_type": "Comment"
+                  id: 22,
+                  user_id: 2,
+                  article_id: 11,
+                  body: "This is the first Stephen's comment to Ichiro's article.",
+                  created_at: Time.current,
+                  updated_at: Time.current,
+                  printable_type: "Comment"
               }
               end
               property :group do
@@ -168,14 +168,14 @@ module ActivityNotification
                 key :description, "Associated group model in your application"
                 key :nullable, true
                 key :example, {
-                  "id": 11,
-                  "user_id": 4,
-                  "title": "Ichiro's great article",
-                  "body": "This is Ichiro's great article. Please read it!",
-                  "created_at": Time.current,
-                  "updated_at": Time.current,
-                  "printable_type": "Article",
-                  "printable_group_name": "article \"Ichiro's great article\""
+                  id: 11,
+                  user_id: 4,
+                  title: "Ichiro's great article",
+                  body: "This is Ichiro's great article. Please read it!",
+                  created_at: Time.current,
+                  updated_at: Time.current,
+                  printable_type: "Article",
+                  printable_group_name: "article \"Ichiro's great article\""
                 }
               end
               property :notifier do
@@ -183,15 +183,15 @@ module ActivityNotification
                 key :description, "Associated notifier model in your application"
                 key :nullable, true
                 key :example, {
-                  "id": 2,
-                  "email": "stephen@example.com",
-                  "name": "Stephen",
-                  "created_at": Time.current,
-                  "updated_at": Time.current,
-                  "provider": "email",
-                  "uid": "",
-                  "printable_type": "User",
-                  "printable_notifier_name": "Stephen"
+                  id: 2,
+                  email: "stephen@example.com",
+                  name: "Stephen",
+                  created_at: Time.current,
+                  updated_at: Time.current,
+                  provider: "email",
+                  uid: "",
+                  printable_type: "User",
+                  printable_notifier_name: "Stephen"
                 }
               end
               property :group_members do