Module: JSend

Defined in:

lib/jsend.rb,
lib/jsend/version.rb,
lib/jsend/hash_utils.rb,
lib/jsend/parser/parser.rb,
lib/jsend/parser/exceptions.rb,
lib/jsend/responses/response.rb,
lib/jsend/responses/fail_response.rb,
lib/jsend/responses/error_response.rb,
lib/jsend/parser/fail_message_parser.rb,
lib/jsend/responses/success_response.rb,
lib/jsend/parser/error_message_parser.rb,
lib/jsend/parser/success_message_parser.rb

Defined Under Namespace

Classes: InvalidData, InvalidType, Response

Constant Summary

SUCCESS =

'success'

ERROR =

'error'

FAIL =

'fail'

VERSION =

"0.1.0"

Class Method Summary

• .error(msg, code = nil, data = nil) ⇒ Object
• .fail(error_data) ⇒ Object
• .parse(json) ⇒ Object
• .success(data) ⇒ Object

Class Method Details

.error(msg, code = nil, data = nil) ⇒ Object

# File 'lib/jsend.rb', line 30

def error(msg, code = nil, data = nil)
  ErrorResponse.new(data, msg, code)
end

.fail(error_data) ⇒ Object

# File 'lib/jsend.rb', line 26

def fail(error_data)
  FailResponse.new(error_data)
end

.parse(json) ⇒ Object

# File 'lib/jsend.rb', line 17

def parse(json)
  values = JSON.parse(json)
  Parser.parser_for(values['status']).response_from_hash(values)
end

.success(data) ⇒ Object

# File 'lib/jsend.rb', line 22

def success(data)
  SucessResponse.new(data)
end