activity_notification 2.0.0 → 2.1.0

data/lib/activity_notification/renderable.rb

@@ -143,6 +143,8 @@ module ActivityNotification
     # @option params [String]         :layout       (nil)                     Layout template name
     # @option params [String]         :layout_root  ('layouts')               Root path of layout template
     # @option params [String, Symbol] :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
+    # @option params [Hash]           :assigns                                Parameters to be set as assigns
+    # @option params [Hash]           :locals                                 Parameters to be set as locals
     # @option params [Hash]           others                                  Parameters to be set as locals
     # @return [String] Rendered view or text as string
     def render(context, params = {})
@@ -150,16 +152,17 @@ module ActivityNotification
 
       partial = partial_path(*params.values_at(:partial, :partial_root, :target))
       layout  = layout_path(*params.values_at(:layout, :layout_root))
+      assigns = prepare_assigns(params)
       locals  = prepare_locals(params)
 
       begin
-        context.render params.merge(partial: partial, layout: layout, locals: locals)
+        context.render params.merge(partial: partial, layout: layout, assigns: assigns, locals: locals)
       rescue ActionView::MissingTemplate => e
         if params[:fallback] == :text
           context.render plain: self.text(params)
         elsif params[:fallback].present?
           partial = partial_path(*params.values_at(:fallback, :partial_root, :target))
-          context.render params.merge(partial: partial, layout: layout, locals: locals)
+          context.render params.merge(partial: partial, layout: layout, assigns: assigns, locals: locals)
         else
           raise e
         end
@@ -196,6 +199,14 @@ module ActivityNotification
       select_path(path, root)
     end
 
+    # Returns assigns parameter for view
+    #
+    # @param [Hash] params Parameters to add parameters at assigns
+    # @return [Hash] assigns parameter
+    def prepare_assigns(params)
+      params.delete(:assigns) || {}
+    end
+
     # Returns locals parameter for view
     # There are three variables to be add by method:
     # * notification

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -99,14 +99,26 @@ module ActivityNotification
       #   * Whether activity_notification publishes notifications to ActionCable channel.
       #     Specified method or symbol is expected to return true (not nil) or false (nil).
       #     This parameter is a optional since default value is false.
-      #     To use ActionCable for notifications, action_cable_allowed option must return true (not nil) in both of notifiable and target model.
-      #     This can be also configured default option in initializer.
+      #     To use ActionCable for notifications, action_cable_allowed option of target model must also return true (not nil).
+      #     This can be also configured default option in initializer as action_cable_enabled.
       # @example Enable notification ActionCable for this notifiable model
       #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     acts_as_notifiable :users, targets: User.all, action_cable_allowed: true
       #   end
       #
+      # * :action_cable_api_allowed
+      #   * Whether activity_notification publishes notifications to ActionCable API channel.
+      #     Specified method or symbol is expected to return true (not nil) or false (nil).
+      #     This parameter is a optional since default value is false.
+      #     To use ActionCable for notifications, action_cable_allowed option of target model must also return true (not nil).
+      #     This can be also configured default option in initializer as action_cable_api_enabled.
+      # @example Enable notification ActionCable for this notifiable model
+      #   # app/models/comment.rb
+      #   class Comment < ActiveRecord::Base
+      #     acts_as_notifiable :users, targets: User.all, action_cable_api_allowed: true
+      #   end
+      #
       # * :notifiable_path
       #   * Path to redirect from open or move action of notification controller.
       #     You can also use this notifiable_path as notifiable link in notification view.
@@ -227,13 +239,33 @@ module ActivityNotification
           configured_params.update(add_destroy_dependency(target_type, options[:dependent_notifications]))
         end
 
+        # :nocov:
+        if Rails::VERSION::MAJOR >= 5
+          if options[:action_cable_allowed] || (ActivityNotification.config.action_cable_enabled && options[:action_cable_allowed] != false)
+            options[:optional_targets] ||= {}
+            require 'activity_notification/optional_targets/action_cable_channel'
+            unless options[:optional_targets].has_key?(ActivityNotification::OptionalTarget::ActionCableChannel)
+              options[:optional_targets][ActivityNotification::OptionalTarget::ActionCableChannel] = {}
+            end
+          end
+
+          if options[:action_cable_api_allowed] || (ActivityNotification.config.action_cable_api_enabled && options[:action_cable_api_allowed] != false)
+            options[:optional_targets] ||= {}
+            require 'activity_notification/optional_targets/action_cable_api_channel'
+            unless options[:optional_targets].has_key?(ActivityNotification::OptionalTarget::ActionCableApiChannel)
+              options[:optional_targets][ActivityNotification::OptionalTarget::ActionCableApiChannel] = {}
+            end
+          end
+        end
+        # :nocov:
+
         if options[:optional_targets].is_a?(Hash)
           options[:optional_targets] = arrange_optional_targets_option(options[:optional_targets])
         end
 
         options[:printable_notifiable_name] ||= options.delete(:printable_name)
         configured_params
-          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed, :action_cable_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed, :action_cable_allowed, :action_cable_api_allowed], options, "notification_")
           .merge set_acts_as_parameters_for_target(target_type, [:notifier, :notifiable_path, :printable_notifiable_name, :optional_targets], options)
       end
 
@@ -247,6 +279,7 @@ module ActivityNotification
           :parameters,
           :email_allowed,
           :action_cable_allowed,
+          :action_cable_api_allowed,
           :notifiable_path,
           :printable_notifiable_name, :printable_name,
           :dependent_notifications,
@@ -299,21 +332,9 @@ module ActivityNotification
         #   https://github.com/rails/rails/issues/30779
         #   https://github.com/rails/rails/pull/32167
 
-        # :only-rails5-plus#only-rails-without-callback-issue:
-        # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
-        # :except-rails5-plus#only-rails-without-callback-issue:
-        # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+        # :nocov:
         if !(Gem::Version.new("5.1.6") <= Rails.gem_version && Rails.gem_version < Gem::Version.new("5.2.2")) && respond_to?(:after_commit)
           after_commit tracked_proc, on: tracked_action
-        # :only-rails5-plus#only-rails-without-callback-issue:
-        # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
-        # :except-rails5-plus#only-rails-without-callback-issue:
-        # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
-
-        # :only-rails5-plus#only-rails-with-callback-issue:
-        # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-        # :except-rails5-plus#only-rails-with-callback-issue:
-        # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
         else
           case tracked_action
           when :create
@@ -322,10 +343,7 @@ module ActivityNotification
             after_update tracked_proc
           end
         end
-        # :only-rails5-plus#only-rails-with-callback-issue:
-        # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-        # :except-rails5-plus#only-rails-with-callback-issue:
-        # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
+        # :nocov:
       end
 
       # Adds destroy dependency.

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/generators/activity_notification/controllers_generator.rb

@@ -6,7 +6,8 @@ module ActivityNotification
     # @example Run controller generator for users as target
     #   rails generate activity_notification:controllers users
     class ControllersGenerator < Rails::Generators::Base
-      CONTROLLERS = ['notifications', 'notifications_with_devise', 'subscriptions', 'subscriptions_with_devise'].freeze
+      CONTROLLERS = ['notifications', 'notifications_with_devise', 'notifications_api', 'notifications_api_with_devise',
+                     'subscriptions', 'subscriptions_with_devise', 'subscriptions_api', 'subscriptions_api_with_devise'].freeze
 
       desc <<-DESC.strip_heredoc
         Create inherited ActivityNotification controllers in your app/controllers folder.

data/lib/generators/templates/activity_notification.rb

@@ -71,6 +71,11 @@ ActivityNotification.configure do |config|
   # Set true when you want to turn on WebSocket subscription using ActionCable as default.
   config.action_cable_enabled = false
 
+  # Configure if WebSocket API subscription using ActionCable is enabled.
+  # Note that you can configure them for each model by acts_as roles.
+  # Set true when you want to turn on WebSocket API subscription using ActionCable as default.
+  config.action_cable_api_enabled = false
+
   # Configure if ctivity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise.
   # Note that you can configure them for each model by acts_as roles.
   # Set true when you want to use Device integration with WebSocket subscription using ActionCable as default.
@@ -79,4 +84,7 @@ ActivityNotification.configure do |config|
   # Configure notification channel prefix for ActionCable.
   config.notification_channel_prefix = 'activity_notification_channel'
 
+  # Configure notification API channel prefix for ActionCable.
+  config.notification_api_channel_prefix = 'activity_notification_api_channel'
+
 end

data/lib/generators/templates/controllers/notifications_api_controller.rb

@@ -0,0 +1,31 @@
+class <%= @target_prefix %>NotificationsController < ActivityNotification::NotificationsController
+  # GET /:target_type/:target_id/notifications
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/notifications/open_all
+  # def open_all
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifications/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/notifications/:id
+  # def destroy
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/notifications/:id/open
+  # def open
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifications/:id/move
+  # def move
+  #   super
+  # end
+end

data/lib/generators/templates/controllers/notifications_api_with_devise_controller.rb

@@ -0,0 +1,31 @@
+class <%= @target_prefix %>NotificationsWithDeviseController < ActivityNotification::NotificationsWithDeviseController
+  # GET /:target_type/:target_id/notifications
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/notifications/open_all
+  # def open_all
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifications/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/notifications/:id
+  # def destroy
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/notifications/:id/open
+  # def open
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifications/:id/move
+  # def move
+  #   super
+  # end
+end

data/lib/generators/templates/controllers/notifications_controller.rb

@@ -19,7 +19,7 @@ class <%= @target_prefix %>NotificationsController < ActivityNotification::Notif
   #   super
   # end
 
-  # POST /:target_type/:target_id/notifications/:id/open
+  # PUT /:target_type/:target_id/notifications/:id/open
   # def open
   #   super
   # end
@@ -28,40 +28,4 @@ class <%= @target_prefix %>NotificationsController < ActivityNotification::Notif
   # def move
   #   super
   # end
-
-  # No action routing
-  # This method needs to be public since it is called from view helper
-  # def target_view_path
-  #   super
-  # end
-
-  # protected
-
-  # def set_target
-  #   super
-  # end
-
-  # def set_notification
-  #   super
-  # end
-
-  # def set_index_options
-  #   super
-  # end
-
-  # def load_index
-  #   super
-  # end
-
-  # def controller_path
-  #   super
-  # end
-
-  # def set_view_prefixes
-  #   super
-  # end
-
-  # def return_back_or_ajax
-  #   super
-  # end
 end

data/lib/generators/templates/controllers/notifications_with_devise_controller.rb

@@ -19,7 +19,7 @@ class <%= @target_prefix %>NotificationsWithDeviseController < ActivityNotificat
   #   super
   # end
 
-  # POST /:target_type/:target_id/notifications/:id/open
+  # PUT /:target_type/:target_id/notifications/:id/open
   # def open
   #   super
   # end
@@ -28,48 +28,4 @@ class <%= @target_prefix %>NotificationsWithDeviseController < ActivityNotificat
   # def move
   #   super
   # end
-
-  # No action routing
-  # This method needs to be public since it is called from view helper
-  # def target_view_path
-  #   super
-  # end
-
-  # protected
-
-  # def set_target
-  #   super
-  # end
-
-  # def set_notification
-  #   super
-  # end
-
-  # def set_index_options
-  #   super
-  # end
-
-  # def load_index
-  #   super
-  # end
-
-  # def controller_path
-  #   super
-  # end
-
-  # def set_view_prefixes
-  #   super
-  # end
-
-  # def return_back_or_ajax
-  #   super
-  # end
-
-  # def authenticate_devise_resource!
-  #   super
-  # end
-
-  # def authenticate_target!
-  #   super
-  # end
 end

data/lib/generators/templates/controllers/subscriptions_api_controller.rb

@@ -0,0 +1,61 @@
+class <%= @target_prefix %>SubscriptionsController < ActivityNotification::SubscriptionsController
+  # GET /:target_type/:target_id/subscriptions
+  # def index
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions
+  # def create
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/subscriptions/find
+  def find
+    super
+  end
+
+  # GET /:target_type/:target_id/subscriptions/optional_target_names
+  def optional_target_names
+    super
+  end
+
+  # GET /:target_type/:target_id/subscriptions/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/subscriptions/:id
+  # def destroy
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
+  # def subscribe
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # def unsubscribe
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # def subscribe_to_email
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # def unsubscribe_to_email
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_optional_target
+  # def unsubscribe_to_optional_target
+  #   super
+  # end
+end

data/lib/generators/templates/controllers/subscriptions_api_with_devise_controller.rb

@@ -0,0 +1,61 @@
+class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotification::SubscriptionsWithDeviseController
+  # GET /:target_type/:target_id/subscriptions
+  # def index
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions
+  # def create
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/subscriptions/find
+  def find
+    super
+  end
+
+  # GET /:target_type/:target_id/subscriptions/optional_target_names
+  def optional_target_names
+    super
+  end
+
+  # GET /:target_type/:target_id/subscriptions/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/subscriptions/:id
+  # def destroy
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
+  # def subscribe
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # def unsubscribe
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # def subscribe_to_email
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # def unsubscribe_to_email
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_optional_target
+  # def unsubscribe_to_optional_target
+  #   super
+  # end
+end