module LatoCore::Interface::Apihelpers

This module contains a list of functions used to write application or modules api. They permit to have a nice standard on api structure.

Public Instance Methods

core__send_bad_request_error(error) click to toggle source

This function render an error for a bad request with an error message.

# File lib/lato_core/interfaces/apihelpers.rb, line 28
def core__send_bad_request_error(error)
  render json: { result: false, error_message: error }, status: 400
end
core__send_entity_error(entity) click to toggle source

This function render an error message with the errors contained on an entity.

# File lib/lato_core/interfaces/apihelpers.rb, line 23
def core__send_entity_error(entity)
  render_request_fail(entity.errors.full_messages.to_sentence)
end
core__send_request_fail(error, payload: nil) click to toggle source

This function render an error message with a possible custom payload.

# File lib/lato_core/interfaces/apihelpers.rb, line 15
def core__send_request_fail(error, payload: nil)
  response = { result: false, error_message: error }
  response[:payload] = payload if payload
  render json: response
end
core__send_request_success(payload) click to toggle source

This function render a normal success response with a custom payload.

# File lib/lato_core/interfaces/apihelpers.rb, line 8
def core__send_request_success(payload)
  response = { result: true, error_message: nil }
  response[:payload] = payload if payload
  render json: response
end
core__send_unauthorized_request_error(error) click to toggle source

Tis function render an error for an unauthorized request with an error message.

# File lib/lato_core/interfaces/apihelpers.rb, line 34
def core__send_unauthorized_request_error(error)
  render json: { result: false, error_message: error }, status: 401
end