Class: Pragma::Operation::Response::Forbidden

Inherits:
Pragma::Operation::Response show all
Defined in:
lib/pragma/operation/response/forbidden.rb

Overview

Represents the 403 Forbidden HTTP response.

Constant Summary

Constants inherited from Pragma::Operation::Response

STATUSES

Instance Attribute Summary

Attributes inherited from Pragma::Operation::Response

#entity, #headers, #status

Instance Method Summary collapse

Methods inherited from Pragma::Operation::Response

#decorate_with, #failure?, #success?

Constructor Details

#initialize(entity: Error.new( error_type: :forbidden, error_message: 'You are not authorized to access the requested resource.' ), headers: {}) ⇒ Forbidden

Initializes the response.

Parameters:

  • entity (Object) (defaults to: Error.new( error_type: :forbidden, error_message: 'You are not authorized to access the requested resource.' )) —

    the response’s entity

  • headers (Hash) (defaults to: {}) —

    the response’s headers



12
13
14
15
16
17
18
19
20
 
# File 'lib/pragma/operation/response/forbidden.rb', line 12

def initialize(
  entity: Error.new(
    error_type: :forbidden,
    error_message: 'You are not authorized to access the requested resource.'
  ),
  headers: {}
)
  super(status: 403, entity: entity, headers: headers)
end