activity_notification 1.4.4 → 2.2.4

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

@@ -12,22 +12,24 @@ module ActivityNotification
       include Rails.application.routes.url_helpers
 
       # Has many notification instances for this notifiable.
-      # Dependency for these notifications can be overriden from acts_as_notifiable.
+      # Dependency for these notifications can be overridden from acts_as_notifiable.
       # @scope instance
       # @return [Array<Notificaion>, Mongoid::Criteria<Notificaion>] Array or database query of notifications for this notifiable
       has_many_records :generated_notifications_as_notifiable,
         class_name: "::ActivityNotification::Notification",
         as: :notifiable
 
-      class_attribute  :_notification_targets,
-                       :_notification_group,
-                       :_notification_group_expiry_delay,
-                       :_notifier,
-                       :_notification_parameters,
-                       :_notification_email_allowed,
-                       :_notifiable_path,
-                       :_printable_notifiable_name,
-                       :_optional_targets
+      class_attribute :_notification_targets,
+                      :_notification_group,
+                      :_notification_group_expiry_delay,
+                      :_notifier,
+                      :_notification_parameters,
+                      :_notification_email_allowed,
+                      :_notifiable_action_cable_allowed,
+                      :_notifiable_action_cable_api_allowed,
+                      :_notifiable_path,
+                      :_printable_notifiable_name,
+                      :_optional_targets
       set_notifiable_class_defaults
     end
 
@@ -47,21 +49,23 @@ module ActivityNotification
       # Sets default values to notifiable class fields.
       # @return [NilClass] nil
       def set_notifiable_class_defaults
-        self._notification_targets            = {}
-        self._notification_group              = {}
-        self._notification_group_expiry_delay = {}
-        self._notifier                        = {}
-        self._notification_parameters         = {}
-        self._notification_email_allowed      = {}
-        self._notifiable_path                 = {}
-        self._printable_notifiable_name       = {}
-        self._optional_targets                = {}
+        self._notification_targets                  = {}
+        self._notification_group                    = {}
+        self._notification_group_expiry_delay       = {}
+        self._notifier                              = {}
+        self._notification_parameters               = {}
+        self._notification_email_allowed            = {}
+        self._notifiable_action_cable_allowed       = {}
+        self._notifiable_action_cable_api_allowed   = {}
+        self._notifiable_path                       = {}
+        self._printable_notifiable_name             = {}
+        self._optional_targets                      = {}
         nil
       end
     end
 
-    # Returns notification targets from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns notification targets from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [Hash] options Options for notifications
@@ -82,8 +86,8 @@ module ActivityNotification
       resolved_parameter
     end
 
-    # Returns group unit of the notifications from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns group unit of the notifications from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -96,8 +100,8 @@ module ActivityNotification
         key)
     end
 
-    # Returns group expiry period of the notifications from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns group expiry period of the notifications from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -110,8 +114,8 @@ module ActivityNotification
         key)
     end
 
-    # Returns additional notification parameters from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns additional notification parameters from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -124,8 +128,8 @@ module ActivityNotification
         key)
     end
 
-    # Returns notifier of the notification from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns notifier of the notification from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -138,8 +142,8 @@ module ActivityNotification
         key)
     end
 
-    # Returns if sending notification email is allowed for the notifiable from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns if sending notification email is allowed for the notifiable from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [Object] target Target instance to notify
     # @param [String] key Key of the notification
@@ -152,8 +156,36 @@ module ActivityNotification
         target, key)
     end
 
-    # Returns notifiable_path to move after opening notification from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns if publishing WebSocket using ActionCable is allowed for the notifiable from configured field or overridden method.
+    # This method is able to be overridden.
+    #
+    # @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 notifiable_action_cable_allowed?(target, key = nil)
+      resolve_parameter(
+        "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
+
+    # Returns if publishing WebSocket API using ActionCable is allowed for the notifiable from configured field or overridden method.
+    # This method is able to be overridden.
+    #
+    # @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 notifiable_action_cable_api_allowed?(target, key = nil)
+      resolve_parameter(
+        "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
+
+    # Returns notifiable_path to move after opening notification from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -166,7 +198,7 @@ module ActivityNotification
         key)
       unless resolved_parameter
         begin
-          resolved_parameter = polymorphic_path(self)
+          resolved_parameter = defined?(super) ? super : polymorphic_path(self)
         rescue NoMethodError, ActionController::UrlGenerationError
           raise NotImplementedError, "You have to implement #{self.class}##{__method__}, "\
                                      "set :notifiable_path in acts_as_notifiable or "\
@@ -186,8 +218,8 @@ module ActivityNotification
         target, key)
     end
 
-    # Returns optional_targets of the notification from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns optional_targets of the notification from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -200,8 +232,8 @@ module ActivityNotification
         key)
     end
 
-    # Returns optional_target names of the notification from configured field or overriden method.
-    # This method is able to be overriden.
+    # Returns optional_target names of the notification from configured field or overridden method.
+    # This method is able to be overridden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
@@ -249,6 +281,27 @@ module ActivityNotification
       Notification.notify(target_type, self, options)
     end
 
+    # Generates notifications to configured targets with notifiable model later by ActiveJob queue.
+    # This method calls NotificationApi#notify_later internally with self notifiable instance.
+    # @see NotificationApi#notify_later
+    #
+    # @param [Symbol, String, Class] target_type Type of target
+    # @param [Hash] options Options for notifications
+    # @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group                    (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay       (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier                 (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email               (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later               (true)                                Whether it sends notification email asynchronously
+    # @option options [Boolean]                 :publish_optional_targets (true)                                Whether it publishes notification to optional targets
+    # @option options [Hash<String, Hash>]      :optional_targets         ({})                                  Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options
+    # @return [Array<Notificaion>] Array of generated notifications
+    def notify_later(target_type, options = {})
+      Notification.notify_later(target_type, self, options)
+    end
+    alias_method :notify_now, :notify
+
     # Generates notifications to one target.
     # This method calls NotificationApi#notify_all internally with self notifiable instance.
     # @see NotificationApi#notify_all
@@ -268,6 +321,27 @@ module ActivityNotification
     def notify_all(targets, options = {})
       Notification.notify_all(targets, self, options)
     end
+    alias_method :notify_all_now, :notify_all
+
+    # Generates notifications to one target later by ActiveJob queue.
+    # This method calls NotificationApi#notify_all_later internally with self notifiable instance.
+    # @see NotificationApi#notify_all_later
+    #
+    # @param [Array<Object>] targets Targets to send notifications
+    # @param [Hash] options Options for notifications
+    # @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group                    (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay       (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier                 (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email               (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later               (true)                                Whether it sends notification email asynchronously
+    # @option options [Boolean]                 :publish_optional_targets (true)                                Whether it publishes notification to optional targets
+    # @option options [Hash<String, Hash>]      :optional_targets         ({})                                  Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options
+    # @return [Array<Notificaion>] Array of generated notifications
+    def notify_all_later(targets, options = {})
+      Notification.notify_all_later(targets, self, options)
+    end
 
     # Generates notifications to one target.
     # This method calls NotificationApi#notify_to internally with self notifiable instance.
@@ -288,9 +362,30 @@ module ActivityNotification
     def notify_to(target, options = {})
       Notification.notify_to(target, self, options)
     end
+    alias_method :notify_now_to, :notify_to
+
+    # Generates notifications to one target later by ActiveJob queue.
+    # This method calls NotificationApi#notify_later_to internally with self notifiable instance.
+    # @see NotificationApi#notify_later_to
+    #
+    # @param [Object] target Target to send notifications
+    # @param [Hash] options Options for notifications
+    # @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group                    (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay       (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier                 (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email               (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later               (true)                                Whether it sends notification email asynchronously
+    # @option options [Boolean]                 :publish_optional_targets (true)                                Whether it publishes notification to optional targets
+    # @option options [Hash<String, Hash>]      :optional_targets         ({})                                  Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options
+    # @return [Notification] Generated notification instance
+    def notify_later_to(target, options = {})
+      Notification.notify_later_to(target, self, options)
+    end
 
     # Returns default key of the notification.
-    # This method is able to be overriden.
+    # This method is able to be overridden.
     # "#{to_resource_name}.default" is defined as default key.
     #
     # @return [String] Default key of the notification
@@ -299,7 +394,7 @@ module ActivityNotification
     end
 
     # Returns key of the notification for tracked notifiable creation.
-    # This method is able to be overriden.
+    # This method is able to be overridden.
     # "#{to_resource_name}.create" is defined as default creation key.
     #
     # @return [String] Key of the notification for tracked notifiable creation
@@ -308,7 +403,7 @@ module ActivityNotification
     end
 
     # Returns key of the notification for tracked notifiable update.
-    # This method is able to be overriden.
+    # This method is able to be overridden.
     # "#{to_resource_name}.update" is defined as default update key.
     #
     # @return [String] Key of the notification for tracked notifiable update
@@ -321,10 +416,10 @@ module ActivityNotification
       # Used to transform parameter value from configured field or defined method.
       # @api private
       #
-      # @param [String] target_typed_method_name Method name overriden for the target type
+      # @param [String] target_typed_method_name Method name overridden for the target type
       # @param [Object] parameter_field Parameter Configured field in this model
       # @param [Object] default_value Default parameter value
-      # @param [Array] args Arguments to pass to the method overriden or defined as parameter field
+      # @param [Array] args Arguments to pass to the method overridden or defined as parameter field
       # @return [Object] Resolved parameter value
       def resolve_parameter(target_typed_method_name, parameter_field, default_value, *args)
         if respond_to?(target_typed_method_name)
@@ -356,20 +451,12 @@ module ActivityNotification
         generated_notifications = generated_notifications_as_notifiable_for(target_type)
         case dependent
         when :restrict_with_exception
-          ActivityNotification::Notification.raise_delete_restriction_error("generated_notifications_as_notifiable_for_#{target_type.to_s.pluralize.underscore}") unless generated_notifications.empty?
+          ActivityNotification::Notification.raise_delete_restriction_error("generated_notifications_as_notifiable_for_#{target_type.to_s.pluralize.underscore}") unless generated_notifications.to_a.empty?
         when :restrict_with_error
-          unless generated_notifications.empty?
+          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)
-            # :skip-rails4:
-            if Rails::VERSION::MAJOR >= 5
-              throw(:abort)
-            # :skip-rails4:
-            # :skip-rails5:
-            else
-              false
-            end
-            # :skip-rails5:
+            throw(:abort)
           end
         when :destroy
           generated_notifications.each { |n| n.destroy }
@@ -395,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

@@ -46,33 +46,48 @@ module ActivityNotification
     # Creates new subscription of the target.
     #
     # @param [Hash] subscription_params Parameters to create subscription record
+    # @raise [ActivityNotification::RecordInvalidError] Failed to save subscription due to model validation
     # @return [Subscription] Created subscription instance
     def create_subscription(subscription_params = {})
+      subscription = build_subscription(subscription_params)
+      raise RecordInvalidError, subscription.errors.full_messages.first unless subscription.save
+      subscription
+    end
+
+    # Builds new subscription of the target.
+    #
+    # @param [Hash] subscription_params Parameters to build subscription record
+    # @return [Subscription] Built subscription instance
+    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 = subscriptions.new(subscription_params)
+      subscription = Subscription.new(subscription_params)
+      subscription.assign_attributes(target: self)
       subscription.subscribing? ?
         subscription.assign_attributes(subscribing: true, subscribed_at: created_at) :
         subscription.assign_attributes(subscribing: false, unsubscribed_at: created_at)
       subscription.subscribing_to_email? ?
         subscription.assign_attributes(subscribing_to_email: true, subscribed_to_email_at: created_at) :
         subscription.assign_attributes(subscribing_to_email: false, unsubscribed_to_email_at: created_at)
-      optional_targets = subscription.optional_targets
+      subscription.optional_targets = (subscription.optional_targets || {}).with_indifferent_access
+      optional_targets = {}.with_indifferent_access
       subscription.optional_target_names.each do |optional_target_name|
         optional_targets = subscription.subscribing_to_optional_target?(optional_target_name) ?
           optional_targets.merge(
             Subscription.to_optional_target_key(optional_target_name) => true,
-            Subscription.to_optional_target_subscribed_at_key(optional_target_name) => created_at
+            Subscription.to_optional_target_subscribed_at_key(optional_target_name) => Subscription.convert_time_as_hash(created_at)
           ) :
           optional_targets.merge(
             Subscription.to_optional_target_key(optional_target_name) => false,
-            Subscription.to_optional_target_unsubscribed_at_key(optional_target_name) => created_at
+            Subscription.to_optional_target_unsubscribed_at_key(optional_target_name) => Subscription.convert_time_as_hash(created_at)
           )
       end
       subscription.assign_attributes(optional_targets: optional_targets)
-      subscription.save ? subscription : nil
+      subscription
     end
 
     # Gets configured subscription index of the target.
@@ -127,7 +142,7 @@ module ActivityNotification
     protected
 
       # Returns if the target subscribes to the notification.
-      # This method can be overriden.
+      # This method can be overridden.
       # @api protected
       #
       # @param [String]  key                  Key of the notification
@@ -138,26 +153,26 @@ module ActivityNotification
       end
 
       # Returns if the target subscribes to the notification email.
-      # This method can be overriden.
+      # This method can be overridden.
       # @api protected
       #
       # @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?
 
       # Returns if the target subscribes to the specified optional target.
-      # This method can be overriden.
+      # This method can be overridden.
       # @api protected
       #
       # @param [String]         key                  Key of the notification
       # @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
@@ -172,8 +187,8 @@ module ActivityNotification
       # @param [Array]   args    Arguments of evaluating subscription method
       # @return [Boolean] If the target subscribes
       def evaluate_subscription(record, field, default, *args)
-        default ? record.blank? || record.send(field, *args) : record.present? && record.send(field)
+        default ? record.blank? || record.send(field, *args) : record.present? && record.send(field, *args)
       end
 
   end
-end
+end

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

@@ -0,0 +1,36 @@
+module ActivityNotification
+  module Swagger::ErrorSchema #:nodoc:
+    extend ActiveSupport::Concern
+    include ::Swagger::Blocks
+
+    included do
+      swagger_component do
+        schema :Error do
+          key :required, [:gem, :error]
+          property :gem do
+            key :type, :string
+            key :description, "Name of gem generating this error"
+            key :default, "activity_notification"
+            key :example, "activity_notification"
+          end
+          property :error do
+            key :type, :object
+            key :description, "Error information"
+            property :code do
+              key :type, :integer
+              key :description, "Error code: default value is HTTP status code"
+            end
+            property :message do
+              key :type, :string
+              key :description, "Error message"
+            end
+            property :type do
+              key :type, :string
+              key :description, "Error type describing error message"
+            end
+          end
+        end
+      end
+    end
+  end
+end