Module: ApiResponser

Defined in:
lib/api_responser.rb,
lib/api_responser/railtie.rb

Defined Under Namespace

Classes: Railtie

Instance Method Summary collapse

Instance Method Details

#bad_request(debug_message = "", report: false) ⇒ Object 



62
63
64
 
# File 'lib/api_responser.rb', line 62

def bad_request(debug_message = "", report:false)
  error_render(code: 400, message: i18n_message(__method__, status:"error"), debug_message: debug_message, report:report)
end

#conflict ⇒ Object 



86
87
88
 
# File 'lib/api_responser.rb', line 86

def conflict
  error_render(code: 409, message: i18n_message(__method__, status:"error"))
end

#forbidden(debug_message = "", report: false) ⇒ Object 



70
71
72
 
# File 'lib/api_responser.rb', line 70

def forbidden(debug_message = "", report:false)
  error_render(code: 403, message: i18n_message(__method__, status:"error"), debug_message: debug_message, report:report)
end

#gone ⇒ Object 



90
91
92
 
# File 'lib/api_responser.rb', line 90

def gone
  error_render(code: 410, message: i18n_message(__method__, status:"error"))
end

#internal_server_error(debug_message = "", report: false) ⇒ Object 



74
75
76
 
# File 'lib/api_responser.rb', line 74

def internal_server_error(debug_message = "", report:false)
  error_render(code: 500, message: i18n_message(__method__, status:"error"), debug_message: debug_message, report:report)
end

#method_not_allowed ⇒ Object 



78
79
80
 
# File 'lib/api_responser.rb', line 78

def method_not_allowed
  error_render(code: 405, message: i18n_message(__method__, status:"error"))
end

#not_acceptable ⇒ Object 



82
83
84
 
# File 'lib/api_responser.rb', line 82

def not_acceptable
  error_render(code: 406, message: i18n_message(__method__, status:"error"))
end

#not_implemented ⇒ Object 



103
104
105
 
# File 'lib/api_responser.rb', line 103

def not_implemented
  error_render(code: 501, message: i18n_message(__method__, status:"error"))
end

#page_not_found ⇒ Object

Error responses



42
43
44
 
# File 'lib/api_responser.rb', line 42

def page_not_found
  error_render(code: 404, message: i18n_message(__method__, status:"error"))
end

#record_created(records = nil) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/api_responser.rb', line 16

def record_created(records = nil)
  if records.nil?
    api_success(code: 201)
  else
    success_render(code: 201, message: i18n_message(__method__, status:"success"), records: records)
  end
end

#record_deleted(records = nil) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/api_responser.rb', line 33

def record_deleted(records = nil)
  if records.nil?
    api_success(code: 204)
  else
    success_render(code: 200, message: i18n_message(__method__, status:"success"), records: records)
  end
end

#record_index(records, records_count = nil) ⇒ Object

Success responses



8
9
10
 
# File 'lib/api_responser.rb', line 8

def record_index(records, records_count = nil)
  success_render(code: 200, message: i18n_message(__method__, status:"success"), records: records, records_count: records_count)
end

#record_not_created(message, debug_message = "", report: false) ⇒ Object 



50
51
52
 
# File 'lib/api_responser.rb', line 50

def record_not_created(message, debug_message = "", report:false)
  error_render(code: 422, message: i18n_message(__method__, status:"error", message: message), debug_message: debug_message, report:report)
end

#record_not_deleted(message, debug_message = "", report: false) ⇒ Object 



58
59
60
 
# File 'lib/api_responser.rb', line 58

def record_not_deleted(message, debug_message = "", report:false)
  error_render(code: 500, message: i18n_message(__method__, status:"error", message: message), debug_message: debug_message, report:report)
end

#record_not_found ⇒ Object 



46
47
48
 
# File 'lib/api_responser.rb', line 46

def record_not_found
  error_render(code: 404, message: i18n_message(__method__, status:"error"))
end

#record_not_updated(message, debug_message = "", report: false) ⇒ Object 



54
55
56
 
# File 'lib/api_responser.rb', line 54

def record_not_updated(message, debug_message = "", report:false)
  error_render(code: 422, message: i18n_message(__method__, status:"error", message: message), debug_message: debug_message, report:report)
end

#record_show(records) ⇒ Object 



12
13
14
 
# File 'lib/api_responser.rb', line 12

def record_show(records)
  success_render(code: 200, message: i18n_message(__method__, status:"success"), records: records)
end

#record_updated(records = nil) ⇒ Object

204 No Content must not carry a body, so a response with records is sent as 200.



25
26
27
28
29
30
31
 
# File 'lib/api_responser.rb', line 25

def record_updated(records = nil)
  if records.nil?
    api_success(code: 204)
  else
    success_render(code: 200, message: i18n_message(__method__, status:"success"), records: records)
  end
end

#service_unavailable ⇒ Object 



107
108
109
 
# File 'lib/api_responser.rb', line 107

def service_unavailable
  error_render(code: 503, message: i18n_message(__method__, status:"error"))
end

#too_many_requests ⇒ Object 



98
99
100
 
# File 'lib/api_responser.rb', line 98

def too_many_requests
  error_render(code: 429, message: i18n_message(__method__, status:"error"))
end

#unauthorized(debug_message = "", message: nil, report: false) ⇒ Object 



66
67
68
 
# File 'lib/api_responser.rb', line 66

def unauthorized(debug_message = "", message: nil,report:false)
  error_render(code: 401, message: message.nil? ? i18n_message(__method__, status:"error") : message, debug_message: debug_message, report:report)
end

#unsupported_media_type ⇒ Object 



94
95
96
 
# File 'lib/api_responser.rb', line 94

def unsupported_media_type
  error_render(code: 415, message: i18n_message(__method__, status:"error"))
end