Class: WordsApi::Client

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

Overview

words_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, logging_configuration: nil, environment: Environment::PRODUCTION, x_rapid_api_key: nil, custom_header_authentication_credentials: nil, config: nil) ⇒ Client

Returns a new instance of Client.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/words_api/client.rb', line 18

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,
  logging_configuration: nil, environment: Environment::PRODUCTION,
  x_rapid_api_key: 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,
                logging_configuration: logging_configuration,
                environment: environment, x_rapid_api_key: x_rapid_api_key,
                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/words_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/words_api/client.rb', line 10

def config
  @config
end

Instance Method Details

#ap_is ⇒ APIsController

Access to ap_is controller.

Returns:



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

def ap_is
  @ap_is ||= APIsController.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)



53
54
55
56
57
58
59
60
 
# File 'lib/words_api/client.rb', line 53

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