Class: PaymentsApi::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/payments_api/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::PRODUCTION => {
    Server::DEFAULT => 'https://api.payments.example.local/v1'
  }
}.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(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],, environment: Environment::PRODUCTION, x_api_key: '') ⇒ Configuration

Returns a new instance of Configuration.



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
69
70
71
 
# File 'lib/payments_api/configuration.rb', line 39

def initialize(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],
               environment: Environment::PRODUCTION, x_api_key: '')
  # The value to use for connection timeout

  @timeout = timeout

  # The number of times to retry an endpoint call if it fails

  @max_retries = max_retries

  # Pause in seconds between retries

  @retry_interval = retry_interval

  # The amount to multiply each successive retry's interval amount

  # by in order to provide backoff

  @backoff_factor = backoff_factor

  # A list of HTTP statuses to retry

  @retry_statuses = retry_statuses

  # A list of HTTP methods to retry

  @retry_methods = retry_methods

  # Current API environment

  @environment = String(environment)

  # API Key

  @x_api_key = x_api_key

  # The Http Client to use for making requests.

  @http_client = create_http_client
end

Class Attribute Details

.environments ⇒ Object (readonly)

Returns the value of attribute environments.



36
37
38
 
# File 'lib/payments_api/configuration.rb', line 36

def environments
  @environments
end

Instance Attribute Details

#backoff_factor ⇒ Object (readonly)

Returns the value of attribute backoff_factor.



29
30
31
 
# File 'lib/payments_api/configuration.rb', line 29

def backoff_factor
  @backoff_factor
end

#environment ⇒ Object (readonly)

Returns the value of attribute environment.



32
33
34
 
# File 'lib/payments_api/configuration.rb', line 32

def environment
  @environment
end

#http_client ⇒ Object (readonly)

The attribute readers for properties.



25
26
27
 
# File 'lib/payments_api/configuration.rb', line 25

def http_client
  @http_client
end

#max_retries ⇒ Object (readonly)

Returns the value of attribute max_retries.



27
28
29
 
# File 'lib/payments_api/configuration.rb', line 27

def max_retries
  @max_retries
end

#retry_interval ⇒ Object (readonly)

Returns the value of attribute retry_interval.



28
29
30
 
# File 'lib/payments_api/configuration.rb', line 28

def retry_interval
  @retry_interval
end

#retry_methods ⇒ Object (readonly)

Returns the value of attribute retry_methods.



31
32
33
 
# File 'lib/payments_api/configuration.rb', line 31

def retry_methods
  @retry_methods
end

#retry_statuses ⇒ Object (readonly)

Returns the value of attribute retry_statuses.



30
31
32
 
# File 'lib/payments_api/configuration.rb', line 30

def retry_statuses
  @retry_statuses
end

#timeout ⇒ Object (readonly)

Returns the value of attribute timeout.



26
27
28
 
# File 'lib/payments_api/configuration.rb', line 26

def timeout
  @timeout
end

#x_api_key ⇒ Object (readonly)

Returns the value of attribute x_api_key.



33
34
35
 
# File 'lib/payments_api/configuration.rb', line 33

def x_api_key
  @x_api_key
end

Instance Method Details

#clone_with(timeout: nil, max_retries: nil, retry_interval: nil, backoff_factor: nil, retry_statuses: nil, retry_methods: nil, environment: nil, x_api_key: nil) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/payments_api/configuration.rb', line 73

def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
               backoff_factor: nil, retry_statuses: nil, retry_methods: nil,
               environment: nil, x_api_key: nil)
  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
  environment ||= self.environment
  x_api_key ||= self.x_api_key

  Configuration.new(timeout: timeout, max_retries: max_retries,
                    retry_interval: retry_interval,
                    backoff_factor: backoff_factor,
                    retry_statuses: retry_statuses,
                    retry_methods: retry_methods, environment: environment,
                    x_api_key: x_api_key)
end

#create_http_client ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/payments_api/configuration.rb', line 93

def create_http_client
  FaradayClient.new(timeout: timeout, max_retries: max_retries,
                    retry_interval: retry_interval,
                    backoff_factor: backoff_factor,
                    retry_statuses: retry_statuses,
                    retry_methods: retry_methods)
end

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

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

Parameters:

  • The (Configuration::Server) —

    server enum for which the base URI is

Returns:

  • (String) —

    The base URI.



112
113
114
 
# File 'lib/payments_api/configuration.rb', line 112

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