activity_notification 1.4.4 → 2.2.4

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,15 +20,15 @@ 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
           @target = params[:target_id].present? ?
             target_class.find_by!(id: params[:target_id]) :
-            target_class.find_by!(id: params["#{target_type.to_resource_name}_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,12 +38,12 @@ 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
 
       # Sets options to load resource index from request parameters.
-      # This method is to be overriden.
+      # This method is to be overridden.
       # @api protected
       # @return [Hash] options to load resource index
       def set_index_options
@@ -50,7 +51,7 @@ module ActivityNotification
       end
 
       # Loads resource index with request parameters.
-      # This method is to be overriden.
+      # This method is to be overridden.
       # @api protected
       # @return [Array] Array of resource index
       def load_index
@@ -58,7 +59,7 @@ module ActivityNotification
       end
 
       # Returns controller path.
-      # This method is called from target_view_path method and can be overriden.
+      # This method is called from target_view_path method and can be overridden.
       # @api protected
       # @return [String] "activity_notification" as controller path
       def controller_path
@@ -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|
@@ -92,27 +130,9 @@ module ActivityNotification
             load_index if params[:reload].to_s.to_boolean(true)
             format.js
           else
-            compatibly_redirect_back(@index_options) and return
+            redirect_back(fallback_location: { action: :index }, **@index_options) and return
           end
         end
       end
-
-      # Redirect to back.
-      # @api protected
-      # @return [Boolean] True
-      def compatibly_redirect_back(request_params = {})
-        # :skip-rails4:
-        if Rails::VERSION::MAJOR >= 5
-          redirect_back fallback_location: { action: :index }, **request_params
-        # :skip-rails4:
-        # :skip-rails5:
-        elsif request.referer
-          redirect_to :back, **request_params
-        else
-          redirect_to action: :index, **request_params
-        end
-        # :skip-rails5:
-        true
-      end
   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

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

@@ -0,0 +1,92 @@
+module ActivityNotification
+  module Swagger::NotificationsParameters #:nodoc:
+    module TargetParameters #:nodoc:
+      def self.extended(base)
+        base.parameter do
+          key :name, :target_type
+          key :in, :path
+          key :description, "Target type of notifications: e.g. 'users'"
+          key :required, true
+          key :type, :string
+          key :example, "users"
+        end
+        base.parameter do
+          key :name, :target_id
+          key :in, :path
+          key :description, "Target ID of notifications. This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+          key :required, true
+          key :type, :string
+          key :example, 1
+        end
+      end
+    end
+
+    module IdParameter #:nodoc:
+      def self.extended(base)
+        base.parameter do
+          key :name, :id
+          key :in, :path
+          key :description, 'ID of notification record. This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs.'
+          key :required, true
+          key :type, :string
+          key :example, 123
+        end
+      end
+    end
+
+    module FilterByParameters #:nodoc:
+      def self.extended(base)
+        base.parameter do
+          key :name, :filtered_by_type
+          key :in, :query
+          key :description, "Notifiable type to filter notification index: e.g. 'Comment'"
+          key :required, false
+          key :type, :string
+          key :example, "Comment"
+        end
+        base.parameter do
+          key :name, :filtered_by_group_type
+          key :in, :query
+          key :description, "Group type to filter notification index, valid with 'filtered_by_group_id': e.g. 'Article'"
+          key :required, false
+          key :type, :string
+          key :example, "Article"
+        end
+        base.parameter do
+          key :name, :filtered_by_group_id
+          key :in, :query
+          key :description, "Group instance ID to filter notification index, valid with 'filtered_by_group_type'"
+          key :required, false
+          key :type, :string
+          key :example, 2
+        end
+        base.parameter do
+          key :name, :filtered_by_key
+          key :in, :query
+          key :description, "Key of notifications to filter notification index: e.g. 'comment.default'"
+          key :required, false
+          key :type, :string
+          key :example, "comment.default"
+        end
+        base.parameter do
+          key :name, :later_than
+          key :in, :query
+          key :description, "ISO 8601 format time to filter notification index later than specified time"
+          key :required, false
+          key :type, :string
+          key :format, :'date-time'
+          key :example, Time.current.ago(10.years).iso8601(3)
+        end
+        base.parameter do
+          key :name, :earlier_than
+          key :in, :query
+          key :description, "ISO 8601 format time to filter notification index earlier than specified time"
+          key :required, false
+          key :type, :string
+          key :format, :'date-time'
+          key :example, Time.current.since(10.years).iso8601(3)
+        end
+      end
+    end
+  end
+end