Class: ActionService::Base

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

Overview

ActionService::Base is the parent class for all services that will be generated.

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



10
11
12
13
14
 
# File 'lib/action_service.rb', line 10

def initialize
  @errors = []     # contain errors
  @response = {}   # contain the service response data
  @success = true  # flag service execution without any error
end

Instance Method Details

#add_error(error_message) ⇒ Object 



28
29
30
31
 
# File 'lib/action_service.rb', line 28

def add_error(error_message)
  @success = false
  @errors << error_message
end

#add_errors(*error_messages) ⇒ Object 



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

def add_errors(*error_messages)
  @success = false
  if error_messages[0].kind_of?(Array)
    # called using array
    add_errors_array(error_messages[0])
  else
    @errors += error_messages
  end
end

#add_errors_array(error_messages_array) ⇒ Object 



43
44
45
46
 
# File 'lib/action_service.rb', line 43

def add_errors_array(error_messages_array)
  @success = false
  @errors += error_messages_array
end

#errors ⇒ Object 



16
17
18
 
# File 'lib/action_service.rb', line 16

def errors 
  @errors
end

#response ⇒ Object 



20
21
22
 
# File 'lib/action_service.rb', line 20

def response
  @response
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/action_service.rb', line 24

def success?
  @success
end