Class: Railsmith::Errors::ErrorPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/railsmith/errors.rb

Overview

A structured error payload used in failure results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code:, message:, details: nil) ⇒ ErrorPayload

Returns a new instance of ErrorPayload.



10
11
12
13
14
15
 
# File 'lib/railsmith/errors.rb', line 10

def initialize(code:, message:, details: nil)
  @code = code.to_s
  @message = message.to_s
  @details = details
  freeze
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



8
9
10
 
# File 'lib/railsmith/errors.rb', line 8

def code
  @code
end

#details ⇒ Object (readonly)

Returns the value of attribute details.



8
9
10
 
# File 'lib/railsmith/errors.rb', line 8

def details
  @details
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



8
9
10
 
# File 'lib/railsmith/errors.rb', line 8

def message
  @message
end

Instance Method Details

#as_json ⇒ Object 



23
24
25
 
# File 'lib/railsmith/errors.rb', line 23

def as_json(*)
  to_h
end

#to_h ⇒ Object 



17
18
19
20
21
 
# File 'lib/railsmith/errors.rb', line 17

def to_h
  payload = { code:, message: }
  payload[:details] = details unless details.nil?
  payload
end