Class: UntitledApi::Client

Inherits:
Object
  • Object
show all
Includes:
CoreLibrary
Defined in:
lib/untitled_api/client.rb

Overview

untitled_api client class.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, adapter: :net_http_persistent, timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put],, http_callback: nil, environment: Environment::PRODUCTION, default_host: 'www.example.com', authorization: nil, custom_header_authentication_credentials: nil, config: nil) ⇒ Client

Returns a new instance of Client.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/untitled_api/client.rb', line 60

def initialize(
  connection: nil, adapter: :net_http_persistent, timeout: 60,
  max_retries: 0, retry_interval: 1, backoff_factor: 2,
  retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
  retry_methods: %i[get put], http_callback: nil,
  environment: Environment::PRODUCTION, default_host: 'www.example.com',
  authorization: nil, custom_header_authentication_credentials: nil,
  config: nil
)
  @config = if config.nil?
              Configuration.new(
                connection: connection, adapter: adapter, timeout: timeout,
                max_retries: max_retries, retry_interval: retry_interval,
                backoff_factor: backoff_factor,
                retry_statuses: retry_statuses,
                retry_methods: retry_methods, http_callback: http_callback,
                environment: environment, default_host: default_host,
                authorization: authorization,
                custom_header_authentication_credentials: custom_header_authentication_credentials
              )
            else
              config
            end

  @global_configuration = GlobalConfiguration.new(client_configuration: @config)
                                             .base_uri_executor(@config.method(:get_base_uri))
                                             .global_errors(BaseController::GLOBAL_ERRORS)
                                             .user_agent(BaseController.user_agent)

  initialize_auth_managers(@global_configuration)
  @global_configuration = @global_configuration.auth_managers(@auth_managers)
end

Instance Attribute Details

#auth_managers ⇒ Object (readonly)

Returns the value of attribute auth_managers.



10
11
12
 
# File 'lib/untitled_api/client.rb', line 10

def auth_managers
  @auth_managers
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



10
11
12
 
# File 'lib/untitled_api/client.rb', line 10

def config
  @config
end

Instance Method Details

#about ⇒ AboutController

Access to about controller.

Returns:



14
15
16
 
# File 'lib/untitled_api/client.rb', line 14

def about
  @about ||= AboutController.new @global_configuration
end

#api ⇒ ApiController

Access to api controller.

Returns:



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

def api
  @api ||= ApiController.new @global_configuration
end

#initialize_auth_managers(global_config) ⇒ Object

Initializes the auth managers hash used for authenticating API calls.

Parameters:

  • global_config (GlobalConfiguration) —

    The global configuration of the SDK)



95
96
97
98
99
100
101
102
 
# File 'lib/untitled_api/client.rb', line 95

def initialize_auth_managers(global_config)
  @auth_managers = {}
  http_client_config = global_config.client_configuration
  %w[tokenAuth].each { |auth| @auth_managers[auth] = nil }
  @auth_managers['tokenAuth'] = CustomHeaderAuthentication.new(
    http_client_config.custom_header_authentication_credentials
  )
end

#internal ⇒ InternalController

Access to internal controller.

Returns:



26
27
28
 
# File 'lib/untitled_api/client.rb', line 26

def internal
  @internal ||= InternalController.new @global_configuration
end

#manuf ⇒ ManufController

Access to manuf controller.

Returns:



32
33
34
 
# File 'lib/untitled_api/client.rb', line 32

def manuf
  @manuf ||= ManufController.new @global_configuration
end

#portal ⇒ PortalController

Access to portal controller.

Returns:



38
39
40
 
# File 'lib/untitled_api/client.rb', line 38

def portal
  @portal ||= PortalController.new @global_configuration
end

#search ⇒ SearchController

Access to search controller.

Returns:



44
45
46
 
# File 'lib/untitled_api/client.rb', line 44

def search
  @search ||= SearchController.new @global_configuration
end

#tardis ⇒ TardisController

Access to tardis controller.

Returns:



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

def tardis
  @tardis ||= TardisController.new @global_configuration
end

#tdb ⇒ TdbController

Access to tdb controller.

Returns:



56
57
58
 
# File 'lib/untitled_api/client.rb', line 56

def tdb
  @tdb ||= TdbController.new @global_configuration
end