activity_notification 2.0.0 → 2.1.0

data/lib/activity_notification/apis/subscription_api.rb

@@ -4,10 +4,7 @@ module ActivityNotification
     extend ActiveSupport::Concern
 
     included do
-      # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-      # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
-      # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-      # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+      # :nocov:
       unless ActivityNotification.config.orm == :dynamoid
         # Selects filtered subscriptions by key.
         # @example Get filtered subscriptions of the @user with key 'comment.reply'
@@ -77,10 +74,7 @@ module ActivityNotification
           time
         end
       end
-      # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-      # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
-      # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-      # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+      # :nocov:
     end
 
     class_methods do
@@ -106,6 +100,24 @@ module ActivityNotification
       end
     end
 
+    # Override as_json method for optional_targets representation
+    #
+    # @param [Hash] options Options for as_json method
+    # @return [Hash] Hash representing the subscription model
+    def as_json(options = {})
+      json = super(options).with_indifferent_access
+      optional_targets_json = {}
+      optional_target_names.each do |optional_target_name|
+        optional_targets_json[optional_target_name] = {
+          subscribing:   json[:optional_targets][Subscription.to_optional_target_key(optional_target_name)],
+          subscribed_at: json[:optional_targets][Subscription.to_optional_target_subscribed_at_key(optional_target_name)],
+          unsubscribed_at: json[:optional_targets][Subscription.to_optional_target_unsubscribed_at_key(optional_target_name)]
+        }
+      end
+      json[:optional_targets] = optional_targets_json
+      json
+    end
+
     # Subscribes to the notification and notification email.
     #
     # @param [Hash] options Options for subscribing to the notification

data/lib/activity_notification/apis/swagger.rb

@@ -0,0 +1,6 @@
+require 'swagger/blocks'
+
+module ActivityNotification #:nodoc:
+  module Swagger #:nodoc:
+  end
+end

data/lib/activity_notification/config.rb

@@ -165,6 +165,15 @@ module ActivityNotification
     #   @return [Boolean] Whether WebSocket subscription using ActionCable is enabled.
     attr_accessor :action_cable_enabled
 
+    # @overload action_cable_api_enabled
+    #   Returns whether WebSocket API subscription using ActionCable is enabled
+    #   @return [Boolean] Whether WebSocket API subscription using ActionCable is enabled.
+    # @overload action_cable_api_enabled=(value)
+    #   Sets whether WebSocket API subscription using ActionCable is enabled
+    #   @param [Boolean] action_cable_enabled The new action_cable_api_enabled
+    #   @return [Boolean] Whether WebSocket API subscription using ActionCable is enabled.
+    attr_accessor :action_cable_api_enabled
+
     # @overload action_cable_with_devise
     #   Returns whether activity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise
     #   @return [Boolean] Whether activity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise.
@@ -183,31 +192,42 @@ module ActivityNotification
     #   @return [String] Notification channel prefix for ActionCable.
     attr_accessor :notification_channel_prefix
 
+    # @overload notification_api_channel_prefix
+    #   Returns notification API channel prefix for ActionCable
+    #   @return [String] Notification API channel prefix for ActionCable.
+    # @overload notification_api_channel_prefix=(value)
+    #   Sets notification API channel prefix for ActionCable
+    #   @param [String] notification_api_channel_prefix The new notification_api_channel_prefix
+    #   @return [String] Notification API channel prefix for ActionCable.
+    attr_accessor :notification_api_channel_prefix
+
     # Initialize configuration for ActivityNotification.
     # These configuration can be overridden in initializer.
     # @return [Config] A new instance of Config
     def initialize
-      @enabled                       = true
-      @orm                           = :active_record
-      @notification_table_name       = 'notifications'
-      @subscription_table_name       = 'subscriptions'
-      @email_enabled                 = false
-      @subscription_enabled          = false
-      @subscribe_as_default          = true
-      @mailer_sender                 = nil
-      @mailer                        = 'ActivityNotification::Mailer'
-      @parent_mailer                 = 'ActionMailer::Base'
-      @parent_job                    = 'ActiveJob::Base'
-      @parent_controller             = 'ApplicationController'
-      @parent_channel                = 'ActionCable::Channel::Base'
-      @mailer_templates_dir          = 'activity_notification/mailer'
-      @opened_index_limit            = 10
-      @active_job_queue              = :activity_notification
-      @composite_key_delimiter       = '#'
-      @store_with_associated_records = false
-      @action_cable_enabled          = false
-      @action_cable_with_devise      = false
-      @notification_channel_prefix   = 'activity_notification_channel'
+      @enabled                         = true
+      @orm                             = :active_record
+      @notification_table_name         = 'notifications'
+      @subscription_table_name         = 'subscriptions'
+      @email_enabled                   = false
+      @subscription_enabled            = false
+      @subscribe_as_default            = true
+      @mailer_sender                   = nil
+      @mailer                          = 'ActivityNotification::Mailer'
+      @parent_mailer                   = 'ActionMailer::Base'
+      @parent_job                      = 'ActiveJob::Base'
+      @parent_controller               = 'ApplicationController'
+      @parent_channel                  = 'ActionCable::Channel::Base'
+      @mailer_templates_dir            = 'activity_notification/mailer'
+      @opened_index_limit              = 10
+      @active_job_queue                = :activity_notification
+      @composite_key_delimiter         = '#'
+      @store_with_associated_records   = false
+      @action_cable_enabled            = false
+      @action_cable_api_enabled        = false
+      @action_cable_with_devise        = false
+      @notification_channel_prefix     = 'activity_notification_channel'
+      @notification_api_channel_prefix = 'activity_notification_api_channel'
     end
 
     # Sets ORM name for ActivityNotification (:active_record, :mongoid or :dynamodb)

data/lib/activity_notification/controllers/common_api_controller.rb

@@ -0,0 +1,30 @@
+module ActivityNotification
+  # Module included in api controllers to select target
+  module CommonApiController
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from ActiveRecord::RecordNotFound,      with: :render_resource_not_found if defined?(ActiveRecord)
+      rescue_from Mongoid::Errors::DocumentNotFound, with: :render_resource_not_found if ActivityNotification.config.orm == :mongoid
+      rescue_from Dynamoid::Errors::RecordNotFound,  with: :render_resource_not_found if ActivityNotification.config.orm == :dynamoid
+    end
+
+    protected
+
+      # Override to do nothing instead of JavaScript view for ajax request or redirects to back.
+      # @api protected
+      def return_back_or_ajax
+      end
+
+      # Override to do nothing instead of redirecting to notifiable_path
+      # @api protected
+      def redirect_to_notifiable_path
+      end
+
+      # Override to do nothing instead of redirecting to subscription path
+      # @api protected
+      def redirect_to_subscription_path
+      end
+
+  end
+end

data/lib/activity_notification/controllers/common_controller.rb

@@ -11,6 +11,7 @@ module ActivityNotification
 
       prepend_before_action :set_target
       before_action :set_view_prefixes
+      rescue_from ActivityNotification::RecordInvalidError, with: ->(e){ render_unprocessable_entity(e.message) }
     end
 
     DEFAULT_VIEW_DIRECTORY = "default"
@@ -19,7 +20,7 @@ module ActivityNotification
 
       # Sets @target instance variable from request parameters.
       # @api protected
-      # @return [Object] Target instance (Returns HTTP 400 when request parameters are not enough)
+      # @return [Object] Target instance (Returns HTTP 400 when request parameters are invalid)
       def set_target
         if (target_type = params[:target_type]).present?
           target_class = target_type.to_model_class
@@ -27,7 +28,7 @@ module ActivityNotification
             target_class.find_by!(id: params[:target_id]) :
             target_class.find_by!(id: params["#{target_type.to_resource_name}_id"])
         else
-          render plain: "400 Bad Request: Missing parameter", status: 400
+          render status: 400, json: error_response(code: 400, message: "Invalid parameter", type: "Parameter is missing or the value is empty: target_type")
         end
       end
 
@@ -37,7 +38,7 @@ module ActivityNotification
       # @return Nil or render HTTP 403 status
       def validate_target(belonging_model)
         if @target.present? && belonging_model.target != @target
-          render plain: "403 Forbidden: Wrong target", status: 403
+          render status: 403, json: error_response(code: 403, message: "Forbidden because of invalid parameter", type: "Wrong target is specified")
         end
       end
 
@@ -82,9 +83,46 @@ module ActivityNotification
         lookup_context.prefixes.prepend(target_view_path)
       end
 
+      # Returns error response as Hash
+      # @api protected
+      # @return [Hash] Error message
+      def error_response(error_info = {})
+        { gem: "activity_notification", error: error_info }
+      end
+
+      # Render Resource Not Found error with 404 status
+      # @api protected
+      # @return [void]
+      def render_resource_not_found(error = nil)
+        message_type = error.respond_to?(:message) ? error.message : error
+        render status: 404, json: error_response(code: 404, message: "Resource not found", type: message_type)
+      end
+
+      # Render Invalid Parameter error with 400 status
+      # @api protected
+      # @return [void]
+      def render_invalid_parameter(message)
+        render status: 400, json: error_response(code: 400, message: "Invalid parameter", type: message)
+      end
+
+      # Validate param and return HTTP 400 unless it presents.
+      # @api protected
+      # @param [String, Symbol] param_name Parameter name to validate
+      # @return [void]
+      def validate_param(param_name)
+        render_invalid_parameter("Parameter is missing: #{param_name}") if params[param_name].blank?
+      end
+
+      # Render Invalid Parameter error with 400 status
+      # @api protected
+      # @return [void]
+      def render_unprocessable_entity(message)
+        render status: 422, json: error_response(code: 422, message: "Unprocessable entity", type: message)
+      end
+
       # Returns JavaScript view for ajax request or redirects to back as default.
       # @api protected
-      # @return [Responce] JavaScript view for ajax request or redirects to back as default
+      # @return [Response] JavaScript view for ajax request or redirects to back as default
       def return_back_or_ajax
         set_index_options
         respond_to do |format|
@@ -101,29 +139,15 @@ module ActivityNotification
       # @api protected
       # @return [Boolean] True
       def compatibly_redirect_back(request_params = {})
-        # :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
           redirect_back fallback_location: { action: :index }, **request_params
-        # :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:
-        # :except-rails5-plus#only-rails-with-callback-issue:
-        # :except-rails5-plus#only-rails-without-callback-issue:
-        # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-        # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
         elsif request.referer
           redirect_to :back, **request_params
         else
           redirect_to action: :index, **request_params
         end
-        # :except-rails5-plus#only-rails-with-callback-issue:
-        # :except-rails5-plus#only-rails-without-callback-issue:
-        # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
-        # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+        # :nocov:
         true
       end
   end

data/lib/activity_notification/controllers/concerns/swagger/error_responses.rb

@@ -0,0 +1,55 @@
+module ActivityNotification
+  module Swagger::ErrorResponses #:nodoc:
+    module InvalidParameterError #:nodoc:
+      def self.extended(base)
+        base.response 400 do
+          key :description, "Invalid parameter"
+          content 'application/json' do
+            schema do
+              key :'$ref', :Error
+            end
+          end
+        end
+      end
+    end
+
+    module ForbiddenError #:nodoc:
+      def self.extended(base)
+        base.response 403 do
+          key :description, "Forbidden because of invalid parameter"
+          content 'application/json' do
+            schema do
+              key :'$ref', :Error
+            end
+          end
+        end
+      end
+    end
+
+    module ResourceNotFoundError #:nodoc:
+      def self.extended(base)
+        base.response 404 do
+          key :description, "Resource not found"
+          content 'application/json' do
+            schema do
+              key :'$ref', :Error
+            end
+          end
+        end
+      end
+    end
+
+    module UnprocessableEntityError #:nodoc:
+      def self.extended(base)
+        base.response 422 do
+          key :description, "Unprocessable entity"
+          content 'application/json' do
+            schema do
+              key :'$ref', :Error
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activity_notification/controllers/concerns/swagger/notifications_api.rb

@@ -0,0 +1,273 @@
+module ActivityNotification
+  module Swagger::NotificationsApi #:nodoc:
+    extend ActiveSupport::Concern
+    include ::Swagger::Blocks
+
+    included do
+      include Swagger::ErrorSchema
+
+      swagger_path '/{target_type}/{target_id}/notifications' do
+        operation :get do
+          key :summary, 'Get notifications'
+          key :description, 'Returns notification index of the target.'
+          key :operationId, 'getNotifications'
+          key :tags, ['notifications']
+
+          extend Swagger::NotificationsParameters::TargetParameters
+          parameter do
+            key :name, :filter
+            key :in, :query
+            key :description, "Filter option to load notification index by their status"
+            key :required, false
+            key :type, :string
+            key :enum, ['auto', 'opened', 'unopened']
+            key :default, 'auto'
+          end
+          parameter do
+            key :name, :limit
+            key :in, :query
+            key :description, "Maximum number of notifications to return"
+            key :required, false
+            key :type, :integer
+          end
+          parameter do
+            key :name, :reverse
+            key :in, :query
+            key :description, "Whether notification index will be ordered as earliest first"
+            key :required, false
+            key :type, :boolean
+            key :default, false
+          end
+          parameter do
+            key :name, :without_grouping
+            key :in, :query
+            key :description, "Whether notification index will include group members, same as 'with_group_members'"
+            key :required, false
+            key :type, :boolean
+            key :default, false
+            key :example, true
+          end
+          parameter do
+            key :name, :with_group_members
+            key :in, :query
+            key :description, "Whether notification index will include group members, same as 'without_grouping'"
+            key :required, false
+            key :type, :boolean
+            key :default, false
+          end
+          extend Swagger::NotificationsParameters::FilterByParameters
+
+          response 200 do
+            key :description, "Notification index of the target"
+            content 'application/json' do
+              schema do
+                key :type, :object
+                property :count do
+                  key :type, :integer
+                  key :description, "Number of notification index records"
+                  key :example, 1
+                end
+                property :notifications do
+                  key :type, :array
+                  items do
+                    key :'$ref', :Notification
+                  end
+                  key :description, "Notification index, which means array of notifications of the target"
+                end
+              end
+            end
+          end
+          extend Swagger::ErrorResponses::InvalidParameterError
+          extend Swagger::ErrorResponses::ResourceNotFoundError
+        end
+      end
+
+      swagger_path '/{target_type}/{target_id}/notifications/open_all' do
+        operation :post do
+          key :summary, 'Open all notifications'
+          key :description, 'Opens all notifications of the target.'
+          key :operationId, 'openAllNotifications'
+          key :tags, ['notifications']
+
+          extend Swagger::NotificationsParameters::TargetParameters
+          extend Swagger::NotificationsParameters::FilterByParameters
+
+          response 200 do
+            key :description, "Opened notifications"
+            content 'application/json' do
+              schema do
+                key :type, :object
+                property :count do
+                  key :type, :integer
+                  key :description, "Number of opened notification records"
+                  key :example, 1
+                end
+                property :notifications do
+                  key :type, :array
+                  items do
+                    key :'$ref', :Notification
+                  end
+                  key :description, "Opened notifications"
+                end
+              end
+            end
+          end
+          extend Swagger::ErrorResponses::InvalidParameterError
+          extend Swagger::ErrorResponses::ResourceNotFoundError
+        end
+      end
+
+      swagger_path '/{target_type}/{target_id}/notifications/{id}' do
+        operation :get do
+          key :summary, 'Get notification'
+          key :description, 'Returns a single notification.'
+          key :operationId, 'getNotification'
+          key :tags, ['notifications']
+
+          extend Swagger::NotificationsParameters::TargetParameters
+          extend Swagger::NotificationsParameters::IdParameter
+
+          response 200 do
+            key :description, "Found single notification"
+            content 'application/json' do
+              schema do
+                key :'$ref', :Notification
+              end
+            end
+          end
+          extend Swagger::ErrorResponses::InvalidParameterError
+          extend Swagger::ErrorResponses::ForbiddenError
+          extend Swagger::ErrorResponses::ResourceNotFoundError
+        end
+
+        operation :delete do
+          key :summary, 'Delete notification'
+          key :description, 'Deletes a notification.'
+          key :operationId, 'deleteNotification'
+          key :tags, ['notifications']
+
+          extend Swagger::NotificationsParameters::TargetParameters
+          extend Swagger::NotificationsParameters::IdParameter
+
+          response 204 do
+            key :description, "No content as successfully deleted"
+          end
+          extend Swagger::ErrorResponses::InvalidParameterError
+          extend Swagger::ErrorResponses::ForbiddenError
+          extend Swagger::ErrorResponses::ResourceNotFoundError
+        end
+      end
+
+      swagger_path '/{target_type}/{target_id}/notifications/{id}/open' do
+        operation :put do
+          key :summary, 'Open notification'
+          key :description, 'Opens a notification.'
+          key :operationId, 'openNotification'
+          key :tags, ['notifications']
+
+          extend Swagger::NotificationsParameters::TargetParameters
+          extend Swagger::NotificationsParameters::IdParameter
+          parameter do
+            key :name, :move
+            key :in, :query
+            key :description, "Whether it redirects to notifiable_path after the notification is opened"
+            key :required, false
+            key :type, :boolean
+            key :default, false
+          end
+
+          response 200 do
+            key :description, "Opened notification"
+            content 'application/json' do
+              schema do
+                key :type, :object
+                property :count do
+                  key :type, :integer
+                  key :description, "Number of opened notification records"
+                  key :example, 2
+                end
+                property :notification do
+                  key :type, :object
+                  key :'$ref', :Notification
+                  key :description, "Opened notification"
+                end
+              end
+            end
+          end
+          response 302 do
+            key :description, "Opened notification and redirection to notifiable_path"
+            content 'application/json' do
+              schema do
+                key :type, :object
+                property :location do
+                  key :type, :string
+                  key :format, :uri
+                  key :description, "notifiable_path for redirection"
+                end
+                property :count do
+                  key :type, :integer
+                  key :description, "Number of opened notification records"
+                  key :example, 2
+                end
+                property :notification do
+                  key :type, :object
+                  key :'$ref', :Notification
+                  key :description, "Opened notification"
+                end
+              end
+            end
+          end
+          extend Swagger::ErrorResponses::InvalidParameterError
+          extend Swagger::ErrorResponses::ForbiddenError
+          extend Swagger::ErrorResponses::ResourceNotFoundError
+        end
+      end
+
+      swagger_path '/{target_type}/{target_id}/notifications/{id}/move' do
+        operation :get do
+          key :summary, 'Move to notifiable_path'
+          key :description, 'Moves to notifiable_path of the notification.'
+          key :operationId, 'moveNotification'
+          key :tags, ['notifications']
+
+          extend Swagger::NotificationsParameters::TargetParameters
+          extend Swagger::NotificationsParameters::IdParameter
+          parameter do
+            key :name, :open
+            key :in, :query
+            key :description, "Whether the notification will be opened"
+            key :required, false
+            key :type, :boolean
+            key :default, false
+          end
+
+          response 302 do
+            key :description, "Redirection to notifiable path"
+            content 'application/json' do
+              schema do
+                property :location do
+                  key :type, :string
+                  key :format, :uri
+                  key :description, "Notifiable path for redirection"
+                end
+                property :count do
+                  key :type, :integer
+                  key :description, "Number of opened notification records"
+                  key :example, 2
+                end
+                property :notification do
+                  key :type, :object
+                  key :'$ref', :Notification
+                  key :description, "Found notification to move"
+                end
+              end
+            end
+          end
+          extend Swagger::ErrorResponses::InvalidParameterError
+          extend Swagger::ErrorResponses::ForbiddenError
+          extend Swagger::ErrorResponses::ResourceNotFoundError
+        end
+      end
+    end
+  end
+end