activity_notification 2.0.0 → 2.1.0

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

@@ -0,0 +1,162 @@
+module ActivityNotification
+  module Swagger::SubscriptionSchema #:nodoc:
+    extend ActiveSupport::Concern
+    include ::Swagger::Blocks
+  
+    included do
+      swagger_component do
+        schema :SubscriptionAttributes do
+          key :type, :object
+          property :key do
+            key :type, :string
+            key :example, "comment.default"
+          end
+          property :subscribing do
+            key :type, :boolean
+            key :default, true
+            key :example, true
+          end
+          property :subscribing_to_email do
+            key :type, :boolean
+            key :default, true
+            key :example, true
+          end
+        end
+    
+        schema :Subscription do
+          key :type, :object
+          key :required, [ :id, :target_type, :target_id, :key, :subscribing, :subscribing_to_email, :created_at, :updated_at, :target ]
+          allOf do
+            schema do
+              key :type, :object
+              property :id do
+                key :oneOf, [
+                  { type: :integer },
+                  { type: :string }
+                ]
+                key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+                key :example, 321
+              end
+              property :target_type do
+                key :type, :string
+                key :example, "User"
+              end
+              property :target_id do
+                key :oneOf, [
+                  { type: :integer },
+                  { type: :string }
+                ]
+                key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+                key :example, 1
+              end
+            end
+            schema do
+              key :'$ref', :SubscriptionAttributes
+            end
+            schema do
+              key :type, :object
+              property :subscribed_at do
+                key :type, :string
+                key :format, :'date-time'
+                key :nullable, true
+              end
+              property :unsubscribed_at do
+                key :type, :string
+                key :format, :'date-time'
+                key :nullable, true
+              end
+              property :subscribed_to_email_at do
+                key :type, :string
+                key :format, :'date-time'
+                key :nullable, true
+              end
+              property :unsubscribed_to_email_at do
+                key :type, :string
+                key :format, :'date-time'
+                key :nullable, true
+              end
+              property :optional_targets do
+                key :type, :object
+                key :additionalProperties, {
+                  type: "object",
+                  properties: {
+                    subscribing: {
+                      type: "boolean"
+                    },
+                    subscribed_at: {
+                      type: "string",
+                      format: "date-time"
+                    }
+                  }
+                }
+                key :example, {
+                  "action_cable_channel": {
+                    "subscribing": true,
+                    "subscribed_at": Time.current,
+                    "unsubscribed_at": nil
+                  },
+                  "slack": {
+                    "subscribing": false,
+                    "subscribed_at": nil,
+                    "unsubscribed_at": Time.current
+                  }
+                }
+              end
+              property :created_at do
+                key :type, :string
+                key :format, :'date-time'
+              end
+              property :updated_at do
+                key :type, :string
+                key :format, :'date-time'
+              end
+              property :target do
+                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
+                }
+              end
+            end
+          end
+        end
+
+        schema :SubscriptionInput do
+          key :type, :object
+          key :required, [ :key ]
+          allOf do
+            schema do
+              key :'$ref', :SubscriptionAttributes
+            end
+            schema do
+              key :type, :object
+              property :optional_targets do
+                key :type, :object
+                key :additionalProperties, {
+                  type: "object",
+                  properties: {
+                    subscribing: {
+                      type: "boolean"
+                    }
+                  }
+                }
+                key :example, {
+                  "action_cable_channel": {
+                    "subscribing": true
+                  },
+                  "slack": {
+                    "subscribing": false
+                  }
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -41,7 +41,7 @@ module ActivityNotification
         self._notification_email_allowed            = ActivityNotification.config.email_enabled
         self._batch_notification_email_allowed      = ActivityNotification.config.email_enabled
         self._notification_subscription_allowed     = ActivityNotification.config.subscription_enabled
-        self._notification_action_cable_allowed     = ActivityNotification.config.action_cable_enabled
+        self._notification_action_cable_allowed     = ActivityNotification.config.action_cable_enabled || ActivityNotification.config.action_cable_api_enabled
         self._notification_action_cable_with_devise = ActivityNotification.config.action_cable_with_devise
         self._notification_devise_resource          = ->(model) { model }
         self._notification_current_devise_target    = ->(current_resource) { current_resource }
@@ -61,6 +61,8 @@ module ActivityNotification
       # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
       # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+      # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @return [Array<Notificaion>] All notifications for this target type
       def all_notifications(options = {})
@@ -101,6 +103,8 @@ module ActivityNotification
       # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
       # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+      # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @return [Hash<Target, Notificaion>] All notifications for this target type grouped by targets
       def notification_index_map(options = {})
@@ -123,6 +127,8 @@ module ActivityNotification
       # @option options [String]         :filtered_by_group_type (nil)            Group type for filter, valid with :filtered_by_group_id
       # @option options [String]         :filtered_by_group_id   (nil)            Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]         :filtered_by_key        (nil)            Key of the notification for filter
+      # @option options [String]         :later_than             (nil)            ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]         :earlier_than           (nil)            ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash]     :custom_filter          (nil)            Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @option options [Boolean]        :send_later             (false)          If it sends notification email asynchronously
       # @option options [String, Symbol] :fallback               (:batch_default) Fallback template to use when MissingTemplate is raised
@@ -207,10 +213,7 @@ module ActivityNotification
       resolve_value(_notification_action_cable_with_devise)
     end
 
-    # :only-rails5-plus#only-rails-with-callback-issue:
-    # :only-rails5-plus#only-rails-without-callback-issue:
-    # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-    # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+    # :nocov:
     if Rails::VERSION::MAJOR >= 5
       # Returns notification ActionCable channel class name from action_cable_with_devise? configuration.
       #
@@ -219,10 +222,7 @@ module ActivityNotification
         notification_action_cable_with_devise? ? "ActivityNotification::NotificationWithDeviseChannel" : "ActivityNotification::NotificationChannel"
       end
     end
-    # :only-rails5-plus#only-rails-with-callback-issue:
-    # :only-rails5-plus#only-rails-without-callback-issue:
-    # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-    # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+    # :nocov:
 
     # Returns Devise resource model associated with this target.
     #
@@ -263,6 +263,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Integer] Count of unopened notifications of the target
     def unopened_notification_count(options = {})
@@ -279,6 +281,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Boolean] If the target has unopened notifications
     def has_unopened_notifications?(options = {})
@@ -304,6 +308,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Array<Notificaion>] Notification index of the target
     def notification_index(options = {})
@@ -327,6 +333,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Array<Notificaion>] Unopened notification index of the target
     def unopened_notification_index(options = {})
@@ -348,6 +356,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Array<Notificaion>] Opened notification index of the target
     def opened_notification_index(options = {})
@@ -406,7 +416,9 @@ module ActivityNotification
     # @option options [String]   :filtered_by_group_type (nil)          Group type for filter, valid with :filtered_by_group_id
     # @option options [String]   :filtered_by_group_id   (nil)          Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]   :filtered_by_key        (nil)          Key of the notification for filter
-    # @return [Integer] Number of opened notification records
+    # @option options [String]   :later_than             (nil)          ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]   :earlier_than           (nil)          ISO 8601 format time to filter notifications earlier than specified time
+    # @return [Array<Notification>] Opened notification records
     def open_all_notifications(options = {})
       Notification.open_all_of(self, options)
     end
@@ -434,6 +446,8 @@ module ActivityNotification
     # @option options [String]         :filtered_by_group_type (nil)           Group type for filter, valid with :filtered_by_group_id
     # @option options [String]         :filtered_by_group_id   (nil)           Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]         :filtered_by_key        (nil)           Key of the notification for filter
+    # @option options [String]         :later_than             (nil)           ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]         :earlier_than           (nil)           ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash]     :custom_filter          (nil)           Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Array<Notificaion>] Notification index of the target with attributes
     def notification_index_with_attributes(options = {})
@@ -457,6 +471,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Array<Notificaion>] Unopened notification index of the target with attributes
     def unopened_notification_index_with_attributes(options = {})
@@ -478,6 +494,8 @@ module ActivityNotification
     # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
     # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+    # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+    # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
     # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [Array<Notificaion>] Opened notification index of the target with attributes
     def opened_notification_index_with_attributes(options = {})
@@ -557,6 +575,8 @@ module ActivityNotification
       # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
       # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+      # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @return [ActiveRecord_AssociationRelation<Notificaion>|Mongoid::Criteria<Notificaion>|Dynamoid::Criteria::Chain] Unopened notification index of the target
       def _unopened_notification_index(options = {})
@@ -577,6 +597,8 @@ module ActivityNotification
       # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
       # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+      # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @return [ActiveRecord_AssociationRelation<Notificaion>|Mongoid::Criteria<Notificaion>|Dynamoid::Criteria::Chain] Opened notification index of the target
       def _opened_notification_index(options = {})
@@ -617,6 +639,8 @@ module ActivityNotification
       # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
       # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+      # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @return [Array<Notificaion>] Notification index of the target
       def arrange_single_notification_index(loading_index_method, options = {})
@@ -644,6 +668,8 @@ module ActivityNotification
       # @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
       # @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
       # @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter
+      # @option options [String]     :later_than             (nil)   ISO 8601 format time to filter notifications later than specified time
+      # @option options [String]     :earlier_than           (nil)   ISO 8601 format time to filter notifications earlier than specified time
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
       # @return [Array<Notificaion>] Notification index of the target
       def arrange_notification_index(loading_unopened_index_method, loading_opened_index_method, options = {})

data/lib/activity_notification/models/notification.rb

@@ -1,5 +1,6 @@
 module ActivityNotification
   # Notification model implementation with ORM.
   class Notification < inherit_orm("Notification")
+    include Swagger::NotificationSchema
   end
 end

data/lib/activity_notification/models/subscription.rb

@@ -1,6 +1,7 @@
 module ActivityNotification
   # Subscription model implementation with ORM.
   class Subscription < inherit_orm("Subscription")
+    include Swagger::SubscriptionSchema
   end
 end
 

data/lib/activity_notification/optional_targets/action_cable_api_channel.rb

@@ -0,0 +1,69 @@
+module ActivityNotification
+  module OptionalTarget
+    # Optional target implementation to broadcast to Action Cable API channel
+    class ActionCableApiChannel < ActivityNotification::OptionalTarget::Base
+      # Initialize method to prepare Action Cable API channel
+      # @param [Hash] options Options for initializing
+      # @option options [String] :channel_prefix          (ActivityNotification.config.notification_api_channel_prefix) Channel name prefix to broadcast notifications
+      # @option options [String] :composite_key_delimiter (ActivityNotification.config.composite_key_delimiter)         Composite key delimiter for channel name
+      def initialize_target(options = {})
+        @channel_prefix = options.delete(:channel_prefix) || ActivityNotification.config.notification_api_channel_prefix
+        @composite_key_delimiter = options.delete(:composite_key_delimiter) || ActivityNotification.config.composite_key_delimiter
+      end
+
+      # Broadcast to ActionCable API subscribers
+      # @param [Notification] notification Notification instance
+      # @param [Hash] options Options for publishing
+      def notify(notification, options = {})
+        if notification_action_cable_api_allowed?(notification)
+          target_channel_name = "#{@channel_prefix}_#{notification.target_type}#{@composite_key_delimiter}#{notification.target_id}"
+          ActionCable.server.broadcast(target_channel_name, format_message(notification, options))
+        end
+      end
+
+      # Check if Action Cable notification API is allowed
+      # @param [Notification] notification Notification instance
+      # @return [Boolean] Whether Action Cable notification API is allowed
+      def notification_action_cable_api_allowed?(notification)
+        notification.target.notification_action_cable_allowed?(notification.notifiable, notification.key) &&
+          notification.notifiable.notification_action_cable_api_allowed?(notification.target, notification.key)
+      end
+
+      # Format message to broadcast
+      # @param [Notification] notification Notification instance
+      # @param [Hash] options Options for publishing
+      # @return [Hash] Formatted message to broadcast
+      def format_message(notification, options = {})
+        {
+          notification: notification.as_json(notification_json_options.merge(options)),
+          group_owner:  notification.group_owner? ? nil : notification.group_owner.as_json(notification_json_options.merge(options))
+        }
+      end
+
+      protected
+
+        # Returns options for notification JSON
+        # @api protected
+        def notification_json_options
+          {
+            include: {
+              target: { methods: [:printable_type, :printable_target_name] },
+              notifiable: { methods: [:printable_type] },
+              group: { methods: [:printable_type, :printable_group_name] },
+              notifier: { methods: [:printable_type, :printable_notifier_name] },
+              group_members: {}
+            },
+            methods: [:notifiable_path, :printable_notifiable_name, :group_member_notifier_count, :group_notification_count, :text]
+          }
+        end
+
+        # Overriden rendering notification message using format_message
+        # @param [Notification] notification Notification instance
+        # @param [Hash]         options      Options for rendering
+        # @return [String] Rendered json formatted message to broadcast
+        def render_notification_message(notification, options = {})
+          format_message(notification, options)
+        end
+    end
+  end
+end

data/lib/activity_notification/optional_targets/action_cable_channel.rb

@@ -0,0 +1,68 @@
+module ActivityNotification
+  module OptionalTarget
+    # Optional target implementation to broadcast to Action Cable channel
+    class ActionCableChannel < ActivityNotification::OptionalTarget::Base
+      # Initialize method to prepare Action Cable channel
+      # @param [Hash] options Options for initializing
+      # @option options [String] :channel_prefix          (ActivityNotification.config.notification_channel_prefix) Channel name prefix to broadcast notifications
+      # @option options [String] :composite_key_delimiter (ActivityNotification.config.composite_key_delimiter)     Composite key delimiter for channel name
+      def initialize_target(options = {})
+        @channel_prefix          = options.delete(:channel_prefix)          || ActivityNotification.config.notification_channel_prefix
+        @composite_key_delimiter = options.delete(:composite_key_delimiter) || ActivityNotification.config.composite_key_delimiter
+      end
+
+      # Broadcast to ActionCable subscribers
+      # @param [Notification] notification Notification instance
+      # @param [Hash] options Options for publishing
+      # @option options [String, Symbol] :target                 (nil)                     Target type name to find template or i18n text
+      # @option options [String]         :partial_root           ("activity_notification/notifications/#{target}", controller.target_view_path, 'activity_notification/notifications/default') Partial template name
+      # @option options [String]         :partial                (self.key.tr('.', '/'))   Root path of partial template
+      # @option options [String]         :layout                 (nil)                     Layout template name
+      # @option options [String]         :layout_root            ('layouts')               Root path of layout template
+      # @option options [String, Symbol] :fallback               (:default)                Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
+      # @option options [String]         :filter                 (nil)                     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+      # @option options [String]         :limit                  (nil)                     Limit to query for notifications
+      # @option options [String]         :without_grouping       ('false')                 If notification index will include group members
+      # @option options [String]         :with_group_members     ('false')                 If notification index will include group members
+      # @option options [String]         :filtered_by_type       (nil)                     Notifiable type for filter
+      # @option options [String]         :filtered_by_group_type (nil)                     Group type for filter, valid with :filtered_by_group_id
+      # @option options [String]         :filtered_by_group_id   (nil)                     Group instance id for filter, valid with :filtered_by_group_type
+      # @option options [String]         :filtered_by_key        (nil)                     Key of the notification for filter
+      # @option options [String]         :later_than             (nil)                     ISO 8601 format time to filter notification index later than specified time
+      # @option options [String]         :earlier_than           (nil)                     ISO 8601 format time to filter notification index earlier than specified time
+      # @option options [Hash]           others                                            Parameters to be set as locals
+      def notify(notification, options = {})
+        if notification_action_cable_allowed?(notification)
+          target_channel_name = "#{@channel_prefix}_#{notification.target_type}#{@composite_key_delimiter}#{notification.target_id}"
+          index_options = options.slice(:filter, :limit, :without_grouping, :with_group_members, :filtered_by_type, :filtered_by_group_type, :filtered_by_group_id, :filtered_by_key, :later_than, :earlier_than)
+          ActionCable.server.broadcast(target_channel_name, format_message(notification, options))
+        end
+      end
+
+      # Check if Action Cable notification is allowed
+      # @param [Notification] notification Notification instance
+      # @return [Boolean] Whether Action Cable notification is allowed
+      def notification_action_cable_allowed?(notification)
+        notification.target.notification_action_cable_allowed?(notification.notifiable, notification.key) &&
+          notification.notifiable.notification_action_cable_allowed?(notification.target, notification.key)
+      end
+
+      # Format message to broadcast
+      # @param [Notification] notification Notification instance
+      # @param [Hash] options Options for publishing
+      # @return [Hash] Formatted message to broadcast
+      def format_message(notification, options = {})
+        index_options = options.slice(:filter, :limit, :without_grouping, :with_group_members, :filtered_by_type, :filtered_by_group_type, :filtered_by_group_id, :filtered_by_key, :later_than, :earlier_than)
+        {
+          id:                          notification.id,
+          view:                        render_notification_message(notification, options),
+          text:                        notification.text(options),
+          notifiable_path:             notification.notifiable_path,
+          group_owner_id:              notification.group_owner_id,
+          group_owner_view:            notification.group_owner? ? nil : render_notification_message(notification.group_owner, options),
+          unopened_notification_count: notification.target.unopened_notification_count(index_options)
+        }
+      end
+    end
+  end
+end