Module: ActionFigure::Formatters::Wrapped

Includes:
ActionFigure::Formatter
Defined in:
lib/action_figure/formatters/wrapped.rb,
sig/action_figure.rbs

Overview

Uniform { data:, errors:, status: } envelope

Constant Summary

Constants included from ActionFigure::Formatter

ActionFigure::Formatter::REQUIRED_METHODS

Instance Method Summary collapse

Methods included from ActionFigure::Formatter

#NoContent

Methods included from ErrorRegistry::Helpers

#Conflict, #Forbidden, #Gone, #Locked, #NotFound, #PaymentRequired, #UnavailableForLegalReasons, #UnprocessableContent

Instance Method Details

#Accepted(resource: nil, meta: nil) ⇒ ActionFigure::response

Parameters:

  • resource: (Object, nil) (defaults to: nil)
  • meta: (Object, nil) (defaults to: nil)

Returns:

  • (ActionFigure::response) 


22
23
24
25
26
 
# File 'lib/action_figure/formatters/wrapped.rb', line 22

def Accepted(resource: nil, meta: nil)
  body = { data: resource, errors: nil, status: "success" }
  body[:meta] = meta if meta
  { json: body, status: :accepted }
end

#Created(resource:, meta: nil) ⇒ ActionFigure::response

Parameters:

  • resource: (Object)
  • meta: (Object, nil) (defaults to: nil)

Returns:

  • (ActionFigure::response) 


16
17
18
19
20
 
# File 'lib/action_figure/formatters/wrapped.rb', line 16

def Created(resource:, meta: nil)
  body = { data: resource, errors: nil, status: "success" }
  body[:meta] = meta if meta
  { json: body, status: :created }
end

#error_response(errors:, status:) ⇒ ActionFigure::response

Parameters:

  • errors: (ActionFigure::error_hash)
  • status: (Symbol)

Returns:

  • (ActionFigure::response) 


28
29
30
 
# File 'lib/action_figure/formatters/wrapped.rb', line 28

def error_response(errors:, status:)
  { json: { data: nil, errors: errors, status: "error" }, status: status }
end

#Ok(resource:, meta: nil) ⇒ ActionFigure::response

Parameters:

  • resource: (Object)
  • meta: (Object, nil) (defaults to: nil)

Returns:

  • (ActionFigure::response) 


10
11
12
13
14
 
# File 'lib/action_figure/formatters/wrapped.rb', line 10

def Ok(resource:, meta: nil)
  body = { data: resource, errors: nil, status: "success" }
  body[:meta] = meta if meta
  { json: body, status: :ok }
end