Class: SplititWebApiV4::Client

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

Overview

splitit_web_api_v4 client class.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, adapter: :net_http_persistent, timeout: 30, 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, proxy_settings: nil, logging_configuration: nil, environment: Environment::PRODUCTION_ENVIRONMENT, oauth_2_credentials: nil, api_key_credentials: nil, config: nil) ⇒ Client

Returns a new instance of Client.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/splitit_web_api_v4/client.rb', line 33

def initialize(
  connection: nil, adapter: :net_http_persistent, timeout: 30,
  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, proxy_settings: nil,
  logging_configuration: nil,
  environment: Environment::PRODUCTION_ENVIRONMENT,
  oauth_2_credentials: nil, api_key_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,
                proxy_settings: proxy_settings,
                logging_configuration: logging_configuration,
                environment: environment,
                oauth_2_credentials: oauth_2_credentials,
                api_key_credentials: api_key_credentials
              )
            else
              config
            end
  user_agent_params = BaseApi.user_agent_parameters

  @global_configuration = GlobalConfiguration.new(client_configuration: @config)
                                             .base_uri_executor(@config.method(:get_base_uri))
                                             .global_errors(BaseApi::GLOBAL_ERRORS)
                                             .user_agent(BaseApi.user_agent,
                                                         agent_parameters: user_agent_params)

  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/splitit_web_api_v4/client.rb', line 10

def auth_managers
  @auth_managers
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



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

def config
  @config
end

Class Method Details

.from_env(**overrides) ⇒ Object

Creates a client directly from environment variables.



81
82
83
84
85
 
# File 'lib/splitit_web_api_v4/client.rb', line 81

def self.from_env(**overrides)
  default_config = Configuration.build_default_config_from_env
  new_config = default_config.clone_with(**overrides)
  new(config: new_config)
end

Instance Method Details

#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)



72
73
74
75
76
77
78
 
# File 'lib/splitit_web_api_v4/client.rb', line 72

def initialize_auth_managers(global_config)
  @auth_managers = {}
  http_client_config = global_config.client_configuration
  %w[OAuth2 ApiKey].each { |auth| @auth_managers[auth] = nil }
  @auth_managers['OAuth2'] = Oauth2.new(http_client_config.oauth_2_credentials, global_config)
  @auth_managers['ApiKey'] = ApiKey.new(http_client_config.api_key_credentials)
end

#installment_plan ⇒ InstallmentPlanApi

Access to installment_plan controller.

Returns:



23
24
25
 
# File 'lib/splitit_web_api_v4/client.rb', line 23

def installment_plan
  @installment_plan ||= InstallmentPlanApi.new @global_configuration
end

#oauth_2 ⇒ Object

Returns the configured authentication OAuth2 instance.



17
18
19
 
# File 'lib/splitit_web_api_v4/client.rb', line 17

def oauth_2
  @auth_managers['OAuth2']
end

#oauth_authorization ⇒ OauthAuthorizationApi

Access to oauth_authorization controller.

Returns:



29
30
31
 
# File 'lib/splitit_web_api_v4/client.rb', line 29

def oauth_authorization
  @oauth_authorization ||= OauthAuthorizationApi.new @global_configuration
end

#user_agent_detail ⇒ Object 



12
13
14
 
# File 'lib/splitit_web_api_v4/client.rb', line 12

def user_agent_detail
  config.user_agent_detail
end