activity_notification 2.0.0 → 2.1.4

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "2.0.0"
+  VERSION = "2.1.4"
 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

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

@@ -4,11 +4,16 @@ class <%= @target_prefix %>SubscriptionsController < ActivityNotification::Subsc
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions
+  # 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/:id
   # def show
   #   super
@@ -19,61 +24,33 @@ class <%= @target_prefix %>SubscriptionsController < ActivityNotification::Subsc
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
   # def subscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
   # def unsubscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
   # def subscribe_to_email
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
   # def unsubscribe_to_email
   #   super
   # end
 
-  # protected
-
-  # def set_target
-  #   super
-  # end
-
-  # def set_subscription
-  #   super
-  # end
-
-  # def subscription_params
-  #   super
-  # end
-
-  # def set_index_options
-  #   super
-  # end
-
-  # def load_index
-  #   super
-  # end
-
-  # def controller_path
-  #   super
-  # end
-
-  # def target_view_path
-  #   super
-  # end
-
-  # def set_view_prefixes
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
   #   super
   # end
 
-  # def return_back_or_ajax
+  # 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_with_devise_controller.rb

@@ -4,11 +4,16 @@ class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotificat
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions
+  # 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/:id
   # def show
   #   super
@@ -19,69 +24,33 @@ class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotificat
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
   # def subscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
   # def unsubscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
   # def subscribe_to_email
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
   # def unsubscribe_to_email
   #   super
   # end
 
-  # protected
-
-  # def set_target
-  #   super
-  # end
-
-  # def set_subscription
-  #   super
-  # end
-
-  # def subscription_params
-  #   super
-  # end
-
-  # def set_index_options
-  #   super
-  # end
-
-  # def load_index
-  #   super
-  # end
-
-  # def controller_path
-  #   super
-  # end
-
-  # def target_view_path
-  #   super
-  # end
-
-  # def set_view_prefixes
-  #   super
-  # end
-
-  # def return_back_or_ajax
-  #   super
-  # end
-
-  # def authenticate_devise_resource!
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
   #   super
   # end
 
-  # def authenticate_target!
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_optional_target
+  # def unsubscribe_to_optional_target
   #   super
   # end
 end