Module: ActivityNotification::Notifiable

Extended by:
ActiveSupport::Concern
Includes:
ActionDispatch::Routing::PolymorphicRoutes, Association, Common, PolymorphicHelpers
Defined in:
lib/activity_notification/models/concerns/notifiable.rb

Overview

Notifiable implementation included in notifiable model to be notified, like comments or any other user activities.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Association

belongs_to_composite_xdb_record, belongs_to_polymorphic_xdb_record, filtered_by_association, has_many_composite_xdb_records, has_many_polymorphic_xdb_records, has_many_records, #update

Methods included from Common

#printable_name, #printable_type, #resolve_value, #to_class_name, #to_resource_name, #to_resources_name

Class Method Details

.available_as_notifiable? ⇒ Boolean

Checks if the model includes notifiable and notifiable methods are available.

Returns:

  • (Boolean) —

    Always true



44
45
46
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 44

def available_as_notifiable?
  true
end

.set_notifiable_class_defaults ⇒ NilClass

Sets default values to notifiable class fields.

Returns:

  • (NilClass) —

    nil



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 50

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._notification_action_cable_allowed = {}
  self._notifiable_path                   = {}
  self._printable_notifiable_name         = {}
  self._optional_targets                  = {}
  nil
end

Instance Method Details

#default_notification_key ⇒ String

Returns default key of the notification. This method is able to be overridden. "#Common#to_resource_name.default" is defined as default key.

Returns:

  • (String) —

    Default key of the notification



376
377
378
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 376

def default_notification_key
  "#{to_resource_name}.default"
end

#default_url_options ⇒ Hash

Returns default_url_options for polymorphic_path.

Returns:

  • (Hash) —

    Rails.application.routes.default_url_options



37
38
39
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 37

def default_url_options
  Rails.application.routes.default_url_options
end

#generated_notifications_as_notifiable ⇒ Array<Notificaion>, Mongoid::Criteria<Notificaion>

Has many notification instances for this notifiable. Dependency for these notifications can be overridden from acts_as_notifiable.

Returns:

  • (Array<Notificaion>, Mongoid::Criteria<Notificaion>) —

    Array or database query of notifications for this notifiable



18
19
20
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 18

has_many_records :generated_notifications_as_notifiable,
class_name: "::ActivityNotification::Notification",
as: :notifiable

#notifiable_path(target_type, key = nil) ⇒ String

Returns notifiable_path to move after opening notification from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (String) —

    Notifiable path URL to move after opening notification



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 177

def notifiable_path(target_type, key = nil)
  resolved_parameter = resolve_parameter(
    "notifiable_path_for_#{cast_to_resources_name(target_type)}",
    _notifiable_path[cast_to_resources_sym(target_type)],
    nil,
    key)
  unless resolved_parameter
    begin
      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 "\
                                 "set polymorphic_path routing for #{self.class}"
    end
  end
  resolved_parameter
end

#notification_action_cable_allowed?(target, key = nil) ⇒ Boolean

Returns if publishing WebSocket using ActionCable is allowed for the notifiable from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target (Object) —

    Target instance to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Boolean) —

    If publishing WebSocket using ActionCable is allowed for the notifiable



163
164
165
166
167
168
169
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 163

def notification_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)],
    ActivityNotification.config.action_cable_enabled,
    target, key)
end

#notification_email_allowed?(target, key = nil) ⇒ Boolean

Returns if sending notification email is allowed for the notifiable from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target (Object) —

    Target instance to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Boolean) —

    If sending notification email is allowed for the notifiable



149
150
151
152
153
154
155
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 149

def notification_email_allowed?(target, key = nil)
  resolve_parameter(
    "notification_email_allowed_for_#{cast_to_resources_name(target.class)}?",
    _notification_email_allowed[cast_to_resources_sym(target.class)],
    ActivityNotification.config.email_enabled,
    target, key)
end

#notification_group(target_type, key = nil) ⇒ Object

Returns group unit of the notifications from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Object) —

    Group unit of the notifications



93
94
95
96
97
98
99
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 93

def notification_group(target_type, key = nil)
  resolve_parameter(
    "notification_group_for_#{cast_to_resources_name(target_type)}",
    _notification_group[cast_to_resources_sym(target_type)],
    nil,
    key)
end

#notification_group_expiry_delay(target_type, key = nil) ⇒ Object

Returns group expiry period of the notifications from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Object) —

    Group expiry period of the notifications



107
108
109
110
111
112
113
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 107

def notification_group_expiry_delay(target_type, key = nil)
  resolve_parameter(
    "notification_group_expiry_delay_for_#{cast_to_resources_name(target_type)}",
    _notification_group_expiry_delay[cast_to_resources_sym(target_type)],
    nil,
    key)
end

#notification_key_for_tracked_creation ⇒ String

Returns key of the notification for tracked notifiable creation. This method is able to be overridden. "#Common#to_resource_name.create" is defined as default creation key.

Returns:

  • (String) —

    Key of the notification for tracked notifiable creation



385
386
387
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 385

def notification_key_for_tracked_creation
  "#{to_resource_name}.create"
end

#notification_key_for_tracked_update ⇒ String

Returns key of the notification for tracked notifiable update. This method is able to be overridden. "#Common#to_resource_name.update" is defined as default update key.

Returns:

  • (String) —

    Key of the notification for tracked notifiable update



394
395
396
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 394

def notification_key_for_tracked_update
  "#{to_resource_name}.update"
end

#notification_parameters(target_type, key = nil) ⇒ Hash

Returns additional notification parameters from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Hash) —

    Additional notification parameters



121
122
123
124
125
126
127
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 121

def notification_parameters(target_type, key = nil)
  resolve_parameter(
    "notification_parameters_for_#{cast_to_resources_name(target_type)}",
    _notification_parameters[cast_to_resources_sym(target_type)],
    {},
    key)
end

#notification_targets(target_type, options = {}) ⇒ Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>

Returns notification targets from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

Returns:

  • (Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>) —

    Array or database query of the notification targets



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 73

def notification_targets(target_type, options = {})
  target_typed_method_name = "notification_#{cast_to_resources_name(target_type)}"
  resolved_parameter = resolve_parameter(
    target_typed_method_name,
    _notification_targets[cast_to_resources_sym(target_type)],
    nil,
    options)
  unless resolved_parameter
    raise NotImplementedError, "You have to implement #{self.class}##{target_typed_method_name} "\
                               "or set :targets in acts_as_notifiable"
  end
  resolved_parameter
end

#notifier(target_type, key = nil) ⇒ Object

Returns notifier of the notification from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Object) —

    Notifier of the notification



135
136
137
138
139
140
141
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 135

def notifier(target_type, key = nil)
  resolve_parameter(
    "notifier_for_#{cast_to_resources_name(target_type)}",
    _notifier[cast_to_resources_sym(target_type)],
    nil,
    key)
end

#notify(target_type, options = {}) ⇒ Array<Notificaion> Also known as: notify_now

Generates notifications to configured targets with notifiable model. This method calls NotificationApi#notify internally with self notifiable instance.

Parameters:

  • target_type (Symbol, String, Class) —

    Type of target

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :group (Object) — default: nil —

    Group unit of the notifications

  • :group_expiry_delay (ActiveSupport::Duration) — default: nil —

    Expiry period of a notification group

  • :notifier (Object) — default: nil —

    Notifier of the notifications

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

  • :send_email (Boolean) — default: true —

    Whether it sends notification email

  • :send_later (Boolean) — default: true —

    Whether it sends notification email asynchronously

  • :publish_optional_targets (Boolean) — default: true —

    Whether it publishes notification to optional targets

  • :optional_targets (Hash<String, Hash>) — default: {} —

    Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options

Returns:

  • (Array<Notificaion>) —

    Array of generated notifications

See Also:



264
265
266
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 264

def notify(target_type, options = {})
  Notification.notify(target_type, self, options)
end

#notify_all(targets, options = {}) ⇒ Array<Notificaion> Also known as: notify_all_now

Generates notifications to one target. This method calls NotificationApi#notify_all internally with self notifiable instance.

Parameters:

  • targets (Array<Object>) —

    Targets to send notifications

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :group (Object) — default: nil —

    Group unit of the notifications

  • :group_expiry_delay (ActiveSupport::Duration) — default: nil —

    Expiry period of a notification group

  • :notifier (Object) — default: nil —

    Notifier of the notifications

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

  • :send_email (Boolean) — default: true —

    Whether it sends notification email

  • :send_later (Boolean) — default: true —

    Whether it sends notification email asynchronously

  • :publish_optional_targets (Boolean) — default: true —

    Whether it publishes notification to optional targets

  • :optional_targets (Hash<String, Hash>) — default: {} —

    Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options

Returns:

  • (Array<Notificaion>) —

    Array of generated notifications

See Also:



305
306
307
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 305

def notify_all(targets, options = {})
  Notification.notify_all(targets, self, options)
end

#notify_all_later(targets, options = {}) ⇒ Array<Notificaion>

Generates notifications to one target later by ActiveJob queue. This method calls NotificationApi#notify_all_later internally with self notifiable instance.

Parameters:

  • targets (Array<Object>) —

    Targets to send notifications

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :group (Object) — default: nil —

    Group unit of the notifications

  • :group_expiry_delay (ActiveSupport::Duration) — default: nil —

    Expiry period of a notification group

  • :notifier (Object) — default: nil —

    Notifier of the notifications

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

  • :send_email (Boolean) — default: true —

    Whether it sends notification email

  • :send_later (Boolean) — default: true —

    Whether it sends notification email asynchronously

  • :publish_optional_targets (Boolean) — default: true —

    Whether it publishes notification to optional targets

  • :optional_targets (Hash<String, Hash>) — default: {} —

    Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options

Returns:

  • (Array<Notificaion>) —

    Array of generated notifications

See Also:



326
327
328
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 326

def notify_all_later(targets, options = {})
  Notification.notify_all_later(targets, self, options)
end

#notify_later(target_type, options = {}) ⇒ Array<Notificaion>

Generates notifications to configured targets with notifiable model later by ActiveJob queue. This method calls NotificationApi#notify_later internally with self notifiable instance.

Parameters:

  • target_type (Symbol, String, Class) —

    Type of target

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :group (Object) — default: nil —

    Group unit of the notifications

  • :group_expiry_delay (ActiveSupport::Duration) — default: nil —

    Expiry period of a notification group

  • :notifier (Object) — default: nil —

    Notifier of the notifications

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

  • :send_email (Boolean) — default: true —

    Whether it sends notification email

  • :send_later (Boolean) — default: true —

    Whether it sends notification email asynchronously

  • :publish_optional_targets (Boolean) — default: true —

    Whether it publishes notification to optional targets

  • :optional_targets (Hash<String, Hash>) — default: {} —

    Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options

Returns:

  • (Array<Notificaion>) —

    Array of generated notifications

See Also:



284
285
286
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 284

def notify_later(target_type, options = {})
  Notification.notify_later(target_type, self, options)
end

#notify_later_to(target, options = {}) ⇒ Notification

Generates notifications to one target later by ActiveJob queue. This method calls NotificationApi#notify_later_to internally with self notifiable instance.

Parameters:

  • target (Object) —

    Target to send notifications

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :group (Object) — default: nil —

    Group unit of the notifications

  • :group_expiry_delay (ActiveSupport::Duration) — default: nil —

    Expiry period of a notification group

  • :notifier (Object) — default: nil —

    Notifier of the notifications

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

  • :send_email (Boolean) — default: true —

    Whether it sends notification email

  • :send_later (Boolean) — default: true —

    Whether it sends notification email asynchronously

  • :publish_optional_targets (Boolean) — default: true —

    Whether it publishes notification to optional targets

  • :optional_targets (Hash<String, Hash>) — default: {} —

    Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options

Returns:

See Also:



367
368
369
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 367

def notify_later_to(target, options = {})
  Notification.notify_later_to(target, self, options)
end

#notify_to(target, options = {}) ⇒ Notification Also known as: notify_now_to

Generates notifications to one target. This method calls NotificationApi#notify_to internally with self notifiable instance.

Parameters:

  • target (Object) —

    Target to send notifications

  • options (Hash) (defaults to: {}) —

    Options for notifications

Options Hash (options):

  • :key (String) — default: notifiable.default_notification_key —

    Key of the notification

  • :group (Object) — default: nil —

    Group unit of the notifications

  • :group_expiry_delay (ActiveSupport::Duration) — default: nil —

    Expiry period of a notification group

  • :notifier (Object) — default: nil —

    Notifier of the notifications

  • :parameters (Hash) — default: {} —

    Additional parameters of the notifications

  • :send_email (Boolean) — default: true —

    Whether it sends notification email

  • :send_later (Boolean) — default: true —

    Whether it sends notification email asynchronously

  • :publish_optional_targets (Boolean) — default: true —

    Whether it publishes notification to optional targets

  • :optional_targets (Hash<String, Hash>) — default: {} —

    Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options

Returns:

See Also:



346
347
348
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 346

def notify_to(target, options = {})
  Notification.notify_to(target, self, options)
end

#optional_target_names(target_type, key = nil) ⇒ Array<Symbol>

Returns optional_target names of the notification from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:

  • (Array<Symbol>) —

    Array of optional target names



225
226
227
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 225

def optional_target_names(target_type, key = nil)
  optional_targets(target_type, key).map { |optional_target| optional_target.to_optional_target_name }
end

#optional_targets(target_type, key = nil) ⇒ Array<ActivityNotification::OptionalTarget::Base>

Returns optional_targets of the notification from configured field or overridden method. This method is able to be overridden.

Parameters:

  • target_type (String) —

    Target type to notify

  • key (String) (defaults to: nil) —

    Key of the notification

Returns:



211
212
213
214
215
216
217
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 211

def optional_targets(target_type, key = nil)
  resolve_parameter(
    "optional_targets_for_#{cast_to_resources_name(target_type)}",
    _optional_targets[cast_to_resources_sym(target_type)],
    [],
    key)
end

#printable_notifiable_name(target, key = nil) ⇒ String

Returns printable notifiable model name to show in view or email.

Returns:

  • (String) —

    Printable notifiable model name



197
198
199
200
201
202
203
 
# File 'lib/activity_notification/models/concerns/notifiable.rb', line 197

def printable_notifiable_name(target, key = nil)
  resolve_parameter(
    "printable_notifiable_name_for_#{cast_to_resources_name(target.class)}?",
    _printable_notifiable_name[cast_to_resources_sym(target.class)],
    printable_name,
    target, key)
end