Class: LoyaltyApIs::Configuration

Inherits:
CoreLibrary::HttpClientConfiguration
  • Object
show all
Defined in:
lib/loyalty_ap_is/configuration.rb

Overview

All configuration including auth info and base URI for the API access are configured in this class.

Constant Summary collapse

ENVIRONMENTS =

All the environments the SDK can run in.

{
  Environment::SIT => {
    Server::OAUTH_SERVER => 'https://api-test.shell.com',
    Server::SHELL => 'https://api-test.shell.com',
    Server::SHELL1 => 'https://api-test.shell.com/loyalty/v1',
    Server::SHELL2 => 'https://api-test.shell.com/loyalty'
  },
  Environment::PRODUCTION => {
    Server::OAUTH_SERVER => 'https://api.shell.com',
    Server::SHELL => 'https://id.consumer.shell.com',
    Server::SHELL1 => 'https://api.shell.com/loyalty/v1',
    Server::SHELL2 => 'https://api.shell.com/loyalty'
  },
  Environment::UAT => {
    Server::OAUTH_SERVER => 'https://api.shell.com',
    Server::SHELL => 'https://test.id.consumer.shell.com',
    Server::SHELL1 => 'https://api-uat.shell.com/loyalty/v1',
    Server::SHELL2 => 'https://api-uat.shell.com/loyalty'
  }
}.freeze

Class Attribute Summary collapse

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::SIT, public_bearer_token_credentials: nil, public_basic_token_credentials: nil, private_basic_token_credentials: nil, client_authorization_token_credentials: nil, customer_header_credentials: nil) ⇒ Configuration

Returns a new instance of Configuration.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/loyalty_ap_is/configuration.rb', line 73

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::SIT,
  public_bearer_token_credentials: nil, public_basic_token_credentials: nil,
  private_basic_token_credentials: nil,
  client_authorization_token_credentials: nil,
  customer_header_credentials: nil
)
  super 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

  # Current API environment
  @environment = String(environment)

  # The object holding OAuth 2 Bearer token credentials
  @public_bearer_token_credentials = public_bearer_token_credentials

  # The object holding Custom Header Signature credentials
  @public_basic_token_credentials = public_basic_token_credentials

  # The object holding Custom Header Signature credentials
  @private_basic_token_credentials = private_basic_token_credentials

  # The object holding OAuth 2 Client Credentials Grant credentials
  @client_authorization_token_credentials = client_authorization_token_credentials

  # The object holding Custom Header Signature credentials
  @customer_header_credentials = customer_header_credentials

  # The Http Client to use for making requests.
  set_http_client CoreLibrary::FaradayClient.new(self)
end

Class Attribute Details

.environments ⇒ Object (readonly)

Returns the value of attribute environments.



70
71
72
 
# File 'lib/loyalty_ap_is/configuration.rb', line 70

def environments
  @environments
end

Instance Attribute Details

#client_authorization_token_credentials ⇒ Object (readonly)

The attribute readers for properties.



63
64
65
 
# File 'lib/loyalty_ap_is/configuration.rb', line 63

def client_authorization_token_credentials
  @client_authorization_token_credentials
end

#customer_header_credentials ⇒ Object (readonly)

The attribute readers for properties.



63
64
65
 
# File 'lib/loyalty_ap_is/configuration.rb', line 63

def customer_header_credentials
  @customer_header_credentials
end

#environment ⇒ Object (readonly)

The attribute readers for properties.



63
64
65
 
# File 'lib/loyalty_ap_is/configuration.rb', line 63

def environment
  @environment
end

#private_basic_token_credentials ⇒ Object (readonly)

The attribute readers for properties.



63
64
65
 
# File 'lib/loyalty_ap_is/configuration.rb', line 63

def private_basic_token_credentials
  @private_basic_token_credentials
end

#public_basic_token_credentials ⇒ Object (readonly)

The attribute readers for properties.



63
64
65
 
# File 'lib/loyalty_ap_is/configuration.rb', line 63

def public_basic_token_credentials
  @public_basic_token_credentials
end

#public_bearer_token_credentials ⇒ Object (readonly)

The attribute readers for properties.



63
64
65
 
# File 'lib/loyalty_ap_is/configuration.rb', line 63

def public_bearer_token_credentials
  @public_bearer_token_credentials
end

Class Method Details

.build_default_config_from_env ⇒ Object

Builds a Configuration instance using environment variables.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/loyalty_ap_is/configuration.rb', line 187

def self.build_default_config_from_env
  # === Core environment ===
  environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'sit'))
  timeout = (ENV['TIMEOUT'] || 30).to_f
  max_retries = (ENV['MAX_RETRIES'] || 0).to_i
  retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
  backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
  retry_statuses = ENV.fetch('RETRY_STATUSES',
                             '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
                                      .split(',')
                                      .map(&:strip)
                                      .map do |item|
                                        item.match?(/\A\d+\z/) ? item.to_i : item.downcase
                                      end
  retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
                                      .split(',')
                                      .map(&:strip)
                                      .map do |item|
                                        item.match?(/\A\d+\z/) ? item.to_i : item.downcase
                                      end

  # === Authentication credentials ===
  public_bearer_token_credentials = PublicBearerTokenCredentials.from_env
  public_basic_token_credentials = PublicBasicTokenCredentials.from_env
  private_basic_token_credentials = PrivateBasicTokenCredentials.from_env
  client_authorization_token_credentials = ClientAuthorizationTokenCredentials.from_env
  customer_header_credentials = CustomerHeaderCredentials.from_env

  # === Proxy settings ===
  proxy_settings = ProxySettings.from_env
  # === Logging Configuration ===
  logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?

  Configuration.new(
    environment: environment,
    timeout: timeout,
    max_retries: max_retries,
    retry_interval: retry_interval,
    backoff_factor: backoff_factor,
    retry_statuses: retry_statuses,
    retry_methods: retry_methods,
    public_bearer_token_credentials: public_bearer_token_credentials,
    public_basic_token_credentials: public_basic_token_credentials,
    private_basic_token_credentials: private_basic_token_credentials,
    client_authorization_token_credentials: client_authorization_token_credentials,
    customer_header_credentials: customer_header_credentials,
    proxy_settings: proxy_settings,
    logging_configuration: logging_configuration
  )
end

Instance Method Details

#clone_with(connection: nil, adapter: nil, timeout: nil, max_retries: nil, retry_interval: nil, backoff_factor: nil, retry_statuses: nil, retry_methods: nil, http_callback: nil, proxy_settings: nil, logging_configuration: nil, environment: nil, public_bearer_token_credentials: nil, public_basic_token_credentials: nil, private_basic_token_credentials: nil, client_authorization_token_credentials: nil, customer_header_credentials: nil) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/loyalty_ap_is/configuration.rb', line 113

def clone_with(connection: nil, adapter: nil, timeout: nil,
               max_retries: nil, retry_interval: nil, backoff_factor: nil,
               retry_statuses: nil, retry_methods: nil, http_callback: nil,
               proxy_settings: nil, logging_configuration: nil,
               environment: nil, public_bearer_token_credentials: nil,
               public_basic_token_credentials: nil,
               private_basic_token_credentials: nil,
               client_authorization_token_credentials: nil,
               customer_header_credentials: nil)
  connection ||= self.connection
  adapter ||= self.adapter
  timeout ||= self.timeout
  max_retries ||= self.max_retries
  retry_interval ||= self.retry_interval
  backoff_factor ||= self.backoff_factor
  retry_statuses ||= self.retry_statuses
  retry_methods ||= self.retry_methods
  http_callback ||= self.http_callback
  proxy_settings ||= self.proxy_settings
  logging_configuration ||= self.logging_configuration
  environment ||= self.environment
  public_bearer_token_credentials ||= self.public_bearer_token_credentials
  public_basic_token_credentials ||= self.public_basic_token_credentials
  private_basic_token_credentials ||= self.private_basic_token_credentials
  client_authorization_token_credentials ||= self.client_authorization_token_credentials
  customer_header_credentials ||= self.customer_header_credentials

  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,
    public_bearer_token_credentials: public_bearer_token_credentials,
    public_basic_token_credentials: public_basic_token_credentials,
    private_basic_token_credentials: private_basic_token_credentials,
    client_authorization_token_credentials: client_authorization_token_credentials,
    customer_header_credentials: customer_header_credentials
  )
end

#get_base_uri(server = Server::SHELL) ⇒ String

Generates the appropriate base URI for the environment and the server. required.

Parameters:

  • server (Configuration::Server) (defaults to: Server::SHELL) —

    The server enum for which the base URI is

Returns:

  • (String) —

    The base URI.



182
183
184
 
# File 'lib/loyalty_ap_is/configuration.rb', line 182

def get_base_uri(server = Server::SHELL)
  ENVIRONMENTS[environment][server].clone
end