activity_notification 2.0.0 → 2.1.4

data/lib/activity_notification/orm/mongoid/subscription.rb

@@ -28,7 +28,7 @@ module ActivityNotification
         field :optional_targets,          type: Hash,    default: {}
 
         validates  :target,               presence: true
-        validates  :key,                  presence: true
+        validates  :key,                  presence: true, uniqueness: { scope: [:target_type, :target_id] }
         validates_inclusion_of :subscribing,          in: [true, false]
         validates_inclusion_of :subscribing_to_email, in: [true, false]
         validate   :subscribing_to_email_cannot_be_true_when_subscribing_is_false

data/lib/activity_notification/rails/routes.rb

@@ -23,7 +23,7 @@ module ActionDispatch::Routing
     #       { controller:"activity_notification/notifications", action:"open_all", target_type:"users" }
     #     move_user_notification      GET    /users/:user_id/notifications/:id/move(.:format)
     #       { controller:"activity_notification/notifications", action:"move", target_type:"users" }
-    #     open_user_notification      POST   /users/:user_id/notifications/:id/open(.:format)
+    #     open_user_notification      PUT    /users/:user_id/notifications/:id/open(.:format)
     #       { controller:"activity_notification/notifications", action:"open", target_type:"users" }
     #
     # You can also configure notification routes with scope like this:
@@ -42,7 +42,7 @@ module ActionDispatch::Routing
     #       { controller:"activity_notification/notifications", action:"open_all", target_type:"users", routing_scope: :myscope }
     #     move_myscope_user_notification      GET    /myscope/users/:user_id/notifications/:id/move(.:format)
     #       { controller:"activity_notification/notifications", action:"move", target_type:"users", routing_scope: :myscope }
-    #     open_myscope_user_notification      POST   /myscope/users/:user_id/notifications/:id/open(.:format)
+    #     open_myscope_user_notification      PUT    /myscope/users/:user_id/notifications/:id/open(.:format)
     #       { controller:"activity_notification/notifications", action:"open", target_type:"users", routing_scope: :myscope }
     #
     # When you use devise authentication and you want make notification targets assciated with devise,
@@ -60,7 +60,7 @@ module ActionDispatch::Routing
     #       { controller:"activity_notification/notifications_with_devise", action:"open_all", target_type:"users", devise_type:"users" }
     #     move_user_notification      GET    /users/:user_id/notifications/:id/move(.:format)
     #       { controller:"activity_notification/notifications_with_devise", action:"move", target_type:"users", devise_type:"users" }
-    #     open_user_notification      POST   /users/:user_id/notifications/:id/open(.:format)
+    #     open_user_notification      PUT    /users/:user_id/notifications/:id/open(.:format)
     #       { controller:"activity_notification/notifications_with_devise", action:"open", target_type:"users", devise_type:"users" }
     #
     # When you use with_devise option and you want to make simple default routes as follows, you can use devise_default_routes option:
@@ -77,9 +77,31 @@ module ActionDispatch::Routing
     #       { controller:"activity_notification/notifications_with_devise", action:"open_all", target_type:"users", devise_type:"users" }
     #     move_user_notification      GET    /notifications/:id/move(.:format)
     #       { controller:"activity_notification/notifications_with_devise", action:"move", target_type:"users", devise_type:"users" }
-    #     open_user_notification      POST   /notifications/:id/open(.:format)
+    #     open_user_notification      PUT    /notifications/:id/open(.:format)
     #       { controller:"activity_notification/notifications_with_devise", action:"open", target_type:"users", devise_type:"users" }
     #
+    # When you use activity_notification controllers as REST API mode,
+    # you can create as follows in your routes:
+    #   scope :api do
+    #     scope :"v2" do
+    #       notify_to :users, api_mode: true
+    #     end
+    #   end
+    # This api_mode option creates the needed routes as REST API:
+    #   # Notification as API mode routes
+    #     GET    /api/v2/users/:user_id/notifications(.:format)
+    #       { controller:"activity_notification/notifications_api", action:"index", target_type:"users" }
+    #     GET    /api/v2/users/:user_id/notifications/:id(.:format)
+    #       { controller:"activity_notification/notifications_api", action:"show", target_type:"users" }
+    #     DELETE /api/v2/users/:user_id/notifications/:id(.:format)
+    #       { controller:"activity_notification/notifications_api", action:"destroy", target_type:"users" }
+    #     POST   /api/v2/users/:user_id/notifications/open_all(.:format)
+    #       { controller:"activity_notification/notifications_api", action:"open_all", target_type:"users" }
+    #     GET    /api/v2/users/:user_id/notifications/:id/move(.:format)
+    #       { controller:"activity_notification/notifications_api", action:"move", target_type:"users" }
+    #     PUT    /api/v2/users/:user_id/notifications/:id/open(.:format)
+    #       { controller:"activity_notification/notifications_api", action:"open", target_type:"users" }
+    #
     # When you would like to define subscription management paths with notification paths,
     # you can create as follows in your routes:
     #   notify_to :users, with_subscription: true
@@ -102,12 +124,19 @@ module ActionDispatch::Routing
     #   scope :myscope, as: :myscope do
     #     notify_to :myscope, with_devise: :users, devise_default_routes: true, with_subscription: true, routing_scope: :myscope
     #   end
+    # @example Define notification paths as API mode including subscription paths
+    #   scope :api do
+    #     scope :"v2" do
+    #       notify_to :users, api_mode: true, with_subscription: true
+    #     end
+    #   end
     #
     # @overload notify_to(*resources, *options)
     #   @param          [Symbol]       resources Resources to notify
     #   @option options [String]       :routing_scope         (nil)            Routing scope for notification routes
     #   @option options [Symbol]       :with_devise           (false)          Devise resources name for devise integration. Devise integration will be enabled by this option.
     #   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes assciated with authenticated devise resource as the default target
+    #   @option options [Boolean]      :api_mode              (false)          Whether you will use activity_notification controllers as REST API mode
     #   @option options [Hash|Boolean] :with_subscription     (false)          Subscription path options to define subscription management paths with notification paths. Calls subscribed_by routing when truthy value is passed as this option.
     #   @option options [String]       :model                 (:notifications) Model name of notifications
     #   @option options [String]       :controller            ("activity_notification/notifications" | activity_notification/notifications_with_devise") :controller option as resources routing
@@ -120,7 +149,7 @@ module ActionDispatch::Routing
 
       resources.each do |target|
         options[:defaults] = { target_type: target.to_s }.merge(options[:devise_defaults])
-        resources_options = options.select { |key, _| [:with_devise, :devise_default_routes, :with_subscription, :subscription_option, :model, :devise_defaults].exclude? key }
+        resources_options = options.select { |key, _| [:api_mode, :with_devise, :devise_default_routes, :with_subscription, :subscription_option, :model, :devise_defaults].exclude? key }
         if options[:with_devise].present? && options[:devise_default_routes].present?
           create_notification_routes options, resources_options
         else
@@ -146,23 +175,25 @@ module ActionDispatch::Routing
     #   # Subscription routes
     #     user_subscriptions                                GET    /users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions", action:"index", target_type:"users" }
+    #     find_user_subscriptions                           GET    /users/:user_id/subscriptions/find(.:format)
+    #       { controller:"activity_notification/subscriptions", action:"find", target_type:"users" }
     #     user_subscription                                 GET    /users/:user_id/subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions", action:"show", target_type:"users" }
-    #     open_all_user_subscriptions                       POST   /users/:user_id/subscriptions(.:format)
+    #                                                       PUT    /users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions", action:"create", target_type:"users" }
-    #     user_subscription                                 DELETE /users/:user_id/subscriptions/:id(.:format)
+    #                                                       DELETE /users/:user_id/subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions", action:"destroy", target_type:"users" }
-    #     subscribe_user_subscription                       POST   /users/:user_id/subscriptions/:id/subscribe(.:format)
+    #     subscribe_user_subscription                       PUT    /users/:user_id/subscriptions/:id/subscribe(.:format)
     #       { controller:"activity_notification/subscriptions", action:"subscribe", target_type:"users" }
-    #     unsubscribe_user_subscription                     POST   /users/:user_id/subscriptions/:id/unsubscribe(.:format)
+    #     unsubscribe_user_subscription                     PUT    /users/:user_id/subscriptions/:id/unsubscribe(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe", target_type:"users" }
-    #     subscribe_to_email_user_subscription              POST   /users/:user_id/subscriptions/:id/subscribe_to_email(.:format)
+    #     subscribe_to_email_user_subscription              PUT    /users/:user_id/subscriptions/:id/subscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions", action:"subscribe_to_email", target_type:"users" }
-    #     unsubscribe_to_email_user_subscription            POST   /users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)
+    #     unsubscribe_to_email_user_subscription            PUT    /users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe_to_email", target_type:"users" }
-    #     subscribe_to_optional_target_user_subscription    POST   /users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)
+    #     subscribe_to_optional_target_user_subscription    PUT    /users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions", action:"subscribe_to_optional_target", target_type:"users" }
-    #     unsubscribe_to_optional_target_user_subscription  POST   /users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
+    #     unsubscribe_to_optional_target_user_subscription  PUT    /users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe_to_optional_target", target_type:"users" }
     #
     # You can also configure notification routes with scope like this:
@@ -173,23 +204,25 @@ module ActionDispatch::Routing
     #   # Subscription routes
     #     myscope_user_subscriptions                                GET    /myscope/users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions", action:"index", target_type:"users", routing_scope: :myscope }
+    #     find_myscope_user_subscriptions                           GET    /myscope/users/:user_id/subscriptions/find(.:format)
+    #       { controller:"activity_notification/subscriptions", action:"find", target_type:"users", routing_scope: :myscope }
     #     myscope_user_subscription                                 GET    /myscope/users/:user_id/subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions", action:"show", target_type:"users", routing_scope: :myscope }
-    #     open_all_myscope_user_subscriptions                       POST   /myscope/users/:user_id/subscriptions(.:format)
+    #                                                               PUT    /myscope/users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions", action:"create", target_type:"users", routing_scope: :myscope }
-    #     myscope_user_subscription                                 DELETE /myscope/users/:user_id/subscriptions/:id(.:format)
+    #                                                               DELETE /myscope/users/:user_id/subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions", action:"destroy", target_type:"users", routing_scope: :myscope }
-    #     subscribe_myscope_user_subscription                       POST   /myscope/users/:user_id/subscriptions/:id/subscribe(.:format)
+    #     subscribe_myscope_user_subscription                       PUT    /myscope/users/:user_id/subscriptions/:id/subscribe(.:format)
     #       { controller:"activity_notification/subscriptions", action:"subscribe", target_type:"users", routing_scope: :myscope }
-    #     unsubscribe_myscope_user_subscription                     POST   /myscope/users/:user_id/subscriptions/:id/unsubscribe(.:format)
+    #     unsubscribe_myscope_user_subscription                     PUT    /myscope/users/:user_id/subscriptions/:id/unsubscribe(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe", target_type:"users", routing_scope: :myscope }
-    #     subscribe_to_email_myscope_user_subscription              POST   /myscope/users/:user_id/subscriptions/:id/subscribe_to_email(.:format)
+    #     subscribe_to_email_myscope_user_subscription              PUT    /myscope/users/:user_id/subscriptions/:id/subscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions", action:"subscribe_to_email", target_type:"users", routing_scope: :myscope }
-    #     unsubscribe_to_email_myscope_user_subscription            POST   /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)
+    #     unsubscribe_to_email_myscope_user_subscription            PUT    /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe_to_email", target_type:"users", routing_scope: :myscope }
-    #     subscribe_to_optional_target_myscope_user_subscription    POST   /myscope/users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)
+    #     subscribe_to_optional_target_myscope_user_subscription    PUT    /myscope/users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions", action:"subscribe_to_optional_target", target_type:"users", routing_scope: :myscope }
-    #     unsubscribe_to_optional_target_myscope_user_subscription  POST   /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
+    #     unsubscribe_to_optional_target_myscope_user_subscription  PUT    /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe_to_optional_target", target_type:"users", routing_scope: :myscope }
     #
     # When you use devise authentication and you want make subscription targets assciated with devise,
@@ -199,23 +232,25 @@ module ActionDispatch::Routing
     #   # Subscription with devise routes
     #     user_subscriptions                                GET    /users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"index", target_type:"users", devise_type:"users" }
+    #     find_user_subscriptions                           GET    /users/:user_id/subscriptions/find(.:format)
+    #       { controller:"activity_notification/subscriptions_with_devise", action:"find", target_type:"users", devise_type:"users" }
     #     user_subscription                                 GET    /users/:user_id/subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"show", target_type:"users", devise_type:"users" }
-    #     open_all_user_subscriptions                       POST   /users/:user_id/subscriptions(.:format)
+    #                                                       PUT    /users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"create", target_type:"users", devise_type:"users" }
-    #     user_subscription                                 DELETE /users/:user_id/subscriptions/:id(.:format)
+    #                                                       DELETE /users/:user_id/subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"destroy", target_type:"users", devise_type:"users" }
-    #     subscribe_user_subscription                       POST   /users/:user_id/subscriptions/:id/subscribe(.:format)
+    #     subscribe_user_subscription                       PUT    /users/:user_id/subscriptions/:id/subscribe(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"subscribe", target_type:"users", devise_type:"users" }
-    #     unsubscribe_user_subscription                     POST   /users/:user_id/subscriptions/:id/unsubscribe(.:format)
+    #     unsubscribe_user_subscription                     PUT    /users/:user_id/subscriptions/:id/unsubscribe(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"unsubscribe", target_type:"users", devise_type:"users" }
-    #     subscribe_to_email_user_subscription              POST   /users/:user_id/subscriptions/:id/subscribe_to_email(.:format)
+    #     subscribe_to_email_user_subscription              PUT    /users/:user_id/subscriptions/:id/subscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"subscribe_to_email", target_type:"users", devise_type:"users" }
-    #     unsubscribe_to_email_user_subscription            POST   /users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)
+    #     unsubscribe_to_email_user_subscription            PUT    /users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"unsubscribe_to_email", target_type:"users", devise_type:"users" }
-    #     subscribe_to_optional_target_user_subscription    POST   /users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)
+    #     subscribe_to_optional_target_user_subscription    PUT    /users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"subscribe_to_optional_target", target_type:"users", devise_type:"users" }
-    #     unsubscribe_to_optional_target_user_subscription  POST   /users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
+    #     unsubscribe_to_optional_target_user_subscription  PUT    /users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"unsubscribe_to_optional_target", target_type:"users", devise_type:"users" }
     #
     # When you use with_devise option and you want to make simple default routes as follows, you can use devise_default_routes option:
@@ -224,37 +259,80 @@ module ActionDispatch::Routing
     #   # Subscription with devise routes
     #     user_subscriptions                                GET    /subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"index", target_type:"users", devise_type:"users" }
+    #     find_user_subscriptions                           GET    /subscriptions/find(.:format)
+    #       { controller:"activity_notification/subscriptions_with_devise", action:"find", target_type:"users", devise_type:"users" }
     #     user_subscription                                 GET    /subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"show", target_type:"users", devise_type:"users" }
-    #     open_all_user_subscriptions                       POST   /subscriptions(.:format)
+    #                                                       PUT    /subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"create", target_type:"users", devise_type:"users" }
-    #     user_subscription                                 DELETE /subscriptions/:id(.:format)
+    #                                                       DELETE /subscriptions/:id(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"destroy", target_type:"users", devise_type:"users" }
-    #     subscribe_user_subscription                       POST   /subscriptions/:id/subscribe(.:format)
+    #     subscribe_user_subscription                       PUT    /subscriptions/:id/subscribe(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"subscribe", target_type:"users", devise_type:"users" }
-    #     unsubscribe_user_subscription                     POST   /subscriptions/:id/unsubscribe(.:format)
+    #     unsubscribe_user_subscription                     PUT    /subscriptions/:id/unsubscribe(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"unsubscribe", target_type:"users", devise_type:"users" }
-    #     subscribe_to_email_user_subscription              POST   /subscriptions/:id/subscribe_to_email(.:format)
+    #     subscribe_to_email_user_subscription              PUT    /subscriptions/:id/subscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"subscribe_to_email", target_type:"users", devise_type:"users" }
-    #     unsubscribe_to_email_user_subscription            POST   /subscriptions/:id/unsubscribe_to_email(.:format)
+    #     unsubscribe_to_email_user_subscription            PUT    /subscriptions/:id/unsubscribe_to_email(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"unsubscribe_to_email", target_type:"users", devise_type:"users" }
-    #     subscribe_to_optional_target_user_subscription    POST   /subscriptions/:id/subscribe_to_optional_target(.:format)
+    #     subscribe_to_optional_target_user_subscription    PUT    /subscriptions/:id/subscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"subscribe_to_optional_target", target_type:"users", devise_type:"users" }
-    #     unsubscribe_to_optional_target_user_subscription  POST   /subscriptions/:id/unsubscribe_to_optional_target(.:format)
+    #     unsubscribe_to_optional_target_user_subscription  PUT    /subscriptions/:id/unsubscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"unsubscribe_to_optional_target", target_type:"users", devise_type:"users" }
     #
+    # When you use activity_notification controllers as REST API mode,
+    # you can create as follows in your routes:
+    #   scope :api do
+    #     scope :"v2" do
+    #       subscribed_by :users, api_mode: true
+    #     end
+    #   end
+    # This api_mode option creates the needed routes as REST API:
+    #   # Subscription as API mode routes
+    #     GET    /subscriptions(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"index", target_type:"users" }
+    #     GET    /subscriptions/find(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"find", target_type:"users" }
+    #     GET    /subscriptions/optional_target_names(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"optional_target_names", target_type:"users" }
+    #     GET    /subscriptions/:id(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"show", target_type:"users" }
+    #     PUT    /subscriptions(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"create", target_type:"users" }
+    #     DELETE /subscriptions/:id(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"destroy", target_type:"users" }
+    #     PUT    /subscriptions/:id/subscribe(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"subscribe", target_type:"users" }
+    #     PUT    /subscriptions/:id/unsubscribe(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"unsubscribe", target_type:"users" }
+    #     PUT    /subscriptions/:id/subscribe_to_email(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"subscribe_to_email", target_type:"users" }
+    #     PUT    /subscriptions/:id/unsubscribe_to_email(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"unsubscribe_to_email", target_type:"users" }
+    #     PUT    /subscriptions/:id/subscribe_to_optional_target(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"subscribe_to_optional_target", target_type:"users" }
+    #     PUT    /subscriptions/:id/unsubscribe_to_optional_target(.:format)
+    #       { controller:"activity_notification/subscriptions_api", action:"unsubscribe_to_optional_target", target_type:"users" }
+    #
     # @example Define subscribed_by in config/routes.rb
     #   subscribed_by :users
     # @example Define subscribed_by with options
     #   subscribed_by :users, except: [:index, :show]
     # @example Integrated with Devise authentication
     #   subscribed_by :users, with_devise: :users
+    # @example Define subscription paths as API mode
+    #   scope :api do
+    #     scope :"v2" do
+    #       subscribed_by :users, api_mode: true
+    #     end
+    #   end
     #
     # @overload subscribed_by(*resources, *options)
     #   @param          [Symbol]       resources Resources to notify
     #   @option options [String]       :routing_scope         (nil)            Routing scope for subscription routes
     #   @option options [Symbol]       :with_devise           (false)          Devise resources name for devise integration. Devise integration will be enabled by this option.
     #   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes assciated with authenticated devise resource as the default target
+    #   @option options [Boolean]      :api_mode              (false)          Whether you will use activity_notification controllers as REST API mode
     #   @option options [String]       :model                 (:subscriptions) Model name of subscriptions
     #   @option options [String]       :controller            ("activity_notification/subscriptions" | activity_notification/subscriptions_with_devise") :controller option as resources routing
     #   @option options [Symbol]       :as                    (nil)            :as option as resources routing
@@ -266,7 +344,7 @@ module ActionDispatch::Routing
 
       resources.each do |target|
         options[:defaults] = { target_type: target.to_s }.merge(options[:devise_defaults])
-        resources_options = options.select { |key, _| [:with_devise, :devise_default_routes, :model, :devise_defaults].exclude? key }
+        resources_options = options.select { |key, _| [:api_mode, :with_devise, :devise_default_routes, :model, :devise_defaults].exclude? key }
         if options[:with_devise].present? && options[:devise_default_routes].present?
           create_subscription_routes options, resources_options
         else
@@ -305,20 +383,22 @@ module ActionDispatch::Routing
         # Check resources if it includes target module
         resources_name = resource.to_s.pluralize.underscore
         options[:model] ||= resources_name.to_sym
+        controller_name = "activity_notification/#{resources_name}"
+        controller_name.concat("_api") if options[:api_mode]
         if options[:with_devise].present?
-          options[:controller] ||= "activity_notification/#{resources_name}_with_devise"
+          options[:controller] ||= "#{controller_name}_with_devise"
           options[:as]         ||= resources_name
           # Check devise configuration in model
           options[:devise_defaults] = { devise_type: options[:with_devise].to_s }
           options[:devise_defaults] = options[:devise_defaults].merge(options.slice(:devise_default_routes))
         else
-          options[:controller] ||= "activity_notification/#{resources_name}"
+          options[:controller] ||= controller_name
           options[:devise_defaults] = {}
         end
         (options[:except] ||= []).concat(except_actions)
         if options[:with_subscription].present?
           options[:subscription_option] = (options[:with_subscription].is_a?(Hash) ? options[:with_subscription] : {})
-                                            .merge(options.slice(:with_devise, :devise_default_routes, :routing_scope))
+                                            .merge(options.slice(:api_mode, :with_devise, :devise_default_routes, :routing_scope))
         end
         # Support other options like :as, :path_prefix, :path_names ...
         options
@@ -337,7 +417,7 @@ module ActionDispatch::Routing
           end
           member do
             get  :move     unless ignore_path?(:move, options)
-            post :open     unless ignore_path?(:open, options)
+            put  :open     unless ignore_path?(:open, options)
           end
         end
       end
@@ -350,13 +430,17 @@ module ActionDispatch::Routing
       # @param [Hash] resources_options Options to send resources method
       def create_subscription_routes(options = {}, resources_options = [])
         self.resources options[:model], resources_options do
+          collection do
+            get :find                           unless ignore_path?(:find, options)
+            get :optional_target_names          if options[:api_mode] && !ignore_path?(:optional_target_names, options)
+          end
           member do
-            post :subscribe                      unless ignore_path?(:subscribe, options)
-            post :unsubscribe                    unless ignore_path?(:unsubscribe, options)
-            post :subscribe_to_email             unless ignore_path?(:subscribe_to_email, options)
-            post :unsubscribe_to_email           unless ignore_path?(:unsubscribe_to_email, options)
-            post :subscribe_to_optional_target   unless ignore_path?(:subscribe_to_optional_target, options)
-            post :unsubscribe_to_optional_target unless ignore_path?(:unsubscribe_to_optional_target, options)
+            put :subscribe                      unless ignore_path?(:subscribe, options)
+            put :unsubscribe                    unless ignore_path?(:unsubscribe, options)
+            put :subscribe_to_email             unless ignore_path?(:subscribe_to_email, options)
+            put :unsubscribe_to_email           unless ignore_path?(:unsubscribe_to_email, options)
+            put :subscribe_to_optional_target   unless ignore_path?(:subscribe_to_optional_target, options)
+            put :unsubscribe_to_optional_target unless ignore_path?(:unsubscribe_to_optional_target, options)
           end
         end
       end

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,34 @@ 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], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:action_cable_allowed, :action_cable_api_allowed], options, "notifiable_")
           .merge set_acts_as_parameters_for_target(target_type, [:notifier, :notifiable_path, :printable_notifiable_name, :optional_targets], options)
       end
 
@@ -247,6 +280,7 @@ module ActivityNotification
           :parameters,
           :email_allowed,
           :action_cable_allowed,
+          :action_cable_api_allowed,
           :notifiable_path,
           :printable_notifiable_name, :printable_name,
           :dependent_notifications,
@@ -299,21 +333,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 +344,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.