Class: ApimaticCalculator::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/apimatic_calculator/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::CALCULATOR => 'https://examples.apimatic.io/apps/calculator'
  }
}.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, 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) ⇒ Configuration

Returns a new instance of Configuration.



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
 
# File 'lib/apimatic_calculator/configuration.rb', line 33

def initialize(connection: nil, 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)
  # The Faraday connection object passed by the SDK user for making requests
  @connection = connection

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

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



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

def environments
  @environments
end

Instance Attribute Details

#backoff_factor ⇒ Object (readonly)

The attribute readers for properties.



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

def backoff_factor
  @backoff_factor
end

#connection ⇒ Object (readonly)

The attribute readers for properties.



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

def connection
  @connection
end

#environment ⇒ Object (readonly)

The attribute readers for properties.



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

def environment
  @environment
end

#http_client ⇒ Object (readonly)

The attribute readers for properties.



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

def http_client
  @http_client
end

#max_retries ⇒ Object (readonly)

The attribute readers for properties.



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

def max_retries
  @max_retries
end

#retry_interval ⇒ Object (readonly)

The attribute readers for properties.



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

def retry_interval
  @retry_interval
end

#retry_methods ⇒ Object (readonly)

The attribute readers for properties.



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

def retry_methods
  @retry_methods
end

#retry_statuses ⇒ Object (readonly)

The attribute readers for properties.



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

def retry_statuses
  @retry_statuses
end

#timeout ⇒ Object (readonly)

The attribute readers for properties.



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

def timeout
  @timeout
end

Instance Method Details

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/apimatic_calculator/configuration.rb', line 67

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

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

#create_http_client ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/apimatic_calculator/configuration.rb', line 87

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, connection: connection)
end

#get_base_uri(server = Server::CALCULATOR) ⇒ 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.



106
107
108
 
# File 'lib/apimatic_calculator/configuration.rb', line 106

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