Class: ServiceResponse

Inherits:
Object
  • Object
show all
Defined in:
app/services/service_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, message: nil, payload: {}, http_status: nil) ⇒ ServiceResponse

Returns a new instance of ServiceResponse.


14
15
16
17
18
19
 
# File 'app/services/service_response.rb', line 14

def initialize(status:, message: nil, payload: {}, http_status: nil)
  self.status = status
  self.message = message
  self.payload = payload
  self.http_status = http_status
end

Instance Attribute Details

#http_status ⇒ Object

Returns the value of attribute http_status


12
13
14
 
# File 'app/services/service_response.rb', line 12

def http_status
  @http_status
end

#message ⇒ Object

Returns the value of attribute message


12
13
14
 
# File 'app/services/service_response.rb', line 12

def message
  @message
end

#payload ⇒ Object

Returns the value of attribute payload


12
13
14
 
# File 'app/services/service_response.rb', line 12

def payload
  @payload
end

#status ⇒ Object

Returns the value of attribute status


12
13
14
 
# File 'app/services/service_response.rb', line 12

def status
  @status
end

Class Method Details

.error(message:, payload: {}, http_status: nil) ⇒ Object 


8
9
10
 
# File 'app/services/service_response.rb', line 8

def self.error(message:, payload: {}, http_status: nil)
  new(status: :error, message: message, payload: payload, http_status: http_status)
end

.success(message: nil, payload: {}, http_status: :ok) ⇒ Object 


4
5
6
 
# File 'app/services/service_response.rb', line 4

def self.success(message: nil, payload: {}, http_status: :ok)
  new(status: :success, message: message, payload: payload, http_status: http_status)
end

Instance Method Details

#error? ⇒ Boolean

Returns:

  • (Boolean) 

25
26
27
 
# File 'app/services/service_response.rb', line 25

def error?
  status == :error
end

#errors ⇒ Object 


29
30
31
32
33
 
# File 'app/services/service_response.rb', line 29

def errors
  return [] unless error?

  Array.wrap(message)
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 

21
22
23
 
# File 'app/services/service_response.rb', line 21

def success?
  status == :success
end