Module: ActionFigure::Formatters::Jsend

Includes:
ActionFigure::Formatter
Defined in:
lib/action_figure/formatters/jsend.rb

Overview

Implements JSend response helpers for use in action classes.

Constant Summary

Constants included from ActionFigure::Formatter

ActionFigure::Formatter::REQUIRED_METHODS

Instance Method Summary collapse

Methods included from ActionFigure::Formatter

#NoContent

Instance Method Details

#Accepted(resource: nil, meta: nil) ⇒ Object 



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

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

#Conflict(errors:) ⇒ Object 



40
41
42
 
# File 'lib/action_figure/formatters/jsend.rb', line 40

def Conflict(errors:)
  { json: { status: "fail", data: errors }, status: :conflict }
end

#Created(resource:, meta: nil) ⇒ Object 



15
16
17
18
19
 
# File 'lib/action_figure/formatters/jsend.rb', line 15

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

#Forbidden(errors:) ⇒ Object 



36
37
38
 
# File 'lib/action_figure/formatters/jsend.rb', line 36

def Forbidden(errors:)
  { json: { status: "fail", data: errors }, status: :forbidden }
end

#NotFound(errors:) ⇒ Object 



32
33
34
 
# File 'lib/action_figure/formatters/jsend.rb', line 32

def NotFound(errors:)
  { json: { status: "fail", data: errors }, status: :not_found }
end

#Ok(resource:, meta: nil) ⇒ Object 



9
10
11
12
13
 
# File 'lib/action_figure/formatters/jsend.rb', line 9

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

#PaymentRequired(errors:) ⇒ Object 



44
45
46
 
# File 'lib/action_figure/formatters/jsend.rb', line 44

def PaymentRequired(errors:)
  { json: { status: "fail", data: errors }, status: :payment_required }
end

#UnprocessableContent(errors:) ⇒ Object 



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

def UnprocessableContent(errors:)
  { json: { status: "fail", data: errors }, status: :unprocessable_content }
end