Class: Raas::BaseController

Inherits:
Object
  • Object
show all
Defined in:
lib/raas/controllers/base_controller.rb

Overview

Base controller.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_client: nil, http_call_back: nil) ⇒ BaseController

Returns a new instance of BaseController.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/raas/controllers/base_controller.rb', line 9

def initialize(http_client: nil, http_call_back: nil)
  @http_client = http_client || FaradayClient.new(timeout: 60)
  @http_call_back = http_call_back

  @global_headers = {
    'user-agent' => 'V2NGSDK'
  }
  @logger = Logging.logger[self]
  @logger.info("Instantiated controller class.")
end

Instance Attribute Details

#http_call_back ⇒ Object

Returns the value of attribute http_call_back.



7
8
9
 
# File 'lib/raas/controllers/base_controller.rb', line 7

def http_call_back
  @http_call_back
end

#http_client ⇒ Object

Returns the value of attribute http_client.



7
8
9
 
# File 'lib/raas/controllers/base_controller.rb', line 7

def http_client
  @http_client
end

Instance Method Details

#execute_request(request, binary: false, name: nil) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/raas/controllers/base_controller.rb', line 28

def execute_request(request, binary: false, name: nil)
  @logger.info("Calling the on_before_request method of http_call_back for #{name}.") if @http_call_back
  @http_call_back.on_before_request(request) if @http_call_back

  @logger.info("Merging global headers with endpoint headers for #{name}.")
  APIHelper.clean_hash(request.headers)
  request.headers = @global_headers.clone.merge(request.headers)

  @logger.debug("Raw request for #{name} is: #{request.inspect}")
  response = if binary
               @http_client.execute_as_binary(request)
             else
               @http_client.execute_as_string(request)
             end
  @logger.debug("Raw response for #{name} is: #{response.inspect}")
  @logger.info("Wrapping request and response in a context object for #{name}.")
  context = HttpContext.new(request, response)

  @logger.info("Calling on_after_response method of http_call_back for #{name}.") if @http_call_back
  @http_call_back.on_after_response(context) if @http_call_back

  context
end

#validate_parameters(args) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/raas/controllers/base_controller.rb', line 20

def validate_parameters(args)
  args.each do |_name, value|
    if value.nil?
      raise ArgumentError, "Required parameter #{_name} cannot be nil."
    end
  end
end

#validate_response(context) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/raas/controllers/base_controller.rb', line 52

def validate_response(context)
  raise RaasClientException.new 'Bad Request', context if
  context.response.status_code == 400
  raise RaasGenericException.new 'Unauthorized - Invalid Credentials', context if
  context.response.status_code == 401
  raise RaasClientException.new 'Forbidden', context if
  context.response.status_code == 403
  raise RaasGenericException.new 'Not Found', context if
  context.response.status_code == 404
  raise RaasClientException.new 'Conflict', context if
  context.response.status_code == 409
  raise RaasServerException.new 'Internal Server Error - Retry Later', context if
  context.response.status_code == 500
  raise RaasServerException.new 'Service Unavailable - Retry Later', context if
  context.response.status_code == 503
  raise RaasGenericException.new 'API Error', context unless
    context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
end