Class: ApiResponse

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

Class Method Summary collapse

Class Method Details

.error(message) ⇒ Object

Failure due to server error.

Example:

>> ApiResponse.error("service down")
=> {:status => "success", :message => "service down"}



27
28
29
 
# File 'lib/api_response.rb', line 27

def error(message)
  {:status => "error", :message => message}
end

.fail(data = {}) ⇒ Object

Used an API call is rejected due to invalid data or call conditions.

Example:

>> ApiResponse.fail("bad ID")
=> {:status => "fail", :data => "bad ID"}



17
18
19
 
# File 'lib/api_response.rb', line 17

def fail(data={})
  {:status => "fail", :data => data}
end

.success(data = {}) ⇒ Object

Example:

>> ApiResponse.success(:num_items => 3)
=> {:status => "success", :data => {:num_items => 3}}



7
8
9
 
# File 'lib/api_response.rb', line 7

def success(data={})
  {:status => "success", :data => data}
end