Class: MistApi::Configuration

Inherits:

CoreLibrary::HttpClientConfiguration

Object
CoreLibrary::HttpClientConfiguration
MistApi::Configuration

show all

Defined in:: lib/mist_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::MIST_GLOBAL_01 => {
    Server::API_HOST => 'https://api.mist.com'
  },
  Environment::MIST_GLOBAL_02 => {
    Server::API_HOST => 'https://api.gc1.mist.com'
  },
  Environment::MIST_GLOBAL_03 => {
    Server::API_HOST => 'https://api.ac2.mist.com'
  },
  Environment::MIST_GLOBAL_04 => {
    Server::API_HOST => 'https://api.gc2.mist.com'
  },
  Environment::MIST_GLOBAL_05 => {
    Server::API_HOST => 'https://api.gc4.mist.com'
  },
  Environment::MIST_EMEA_01 => {
    Server::API_HOST => 'https://api.eu.mist.com'
  },
  Environment::MIST_EMEA_02 => {
    Server::API_HOST => 'https://api.gc3.mist.com'
  },
  Environment::MIST_EMEA_03 => {
    Server::API_HOST => 'https://api.ac6.mist.com'
  },
  Environment::MIST_EMEA_04 => {
    Server::API_HOST => 'https://api.gc6.mist.com'
  },
  Environment::MIST_APAC_01 => {
    Server::API_HOST => 'https://api.ac5.mist.com'
  },
  Environment::MIST_APAC_02 => {
    Server::API_HOST => 'https://api.gc5.mist.com'
  },
  Environment::MIST_APAC_03 => {
    Server::API_HOST => 'https://api.gc7.mist.com'
  }
}.freeze

Class Attribute Summary collapse

.environments ⇒ Object readonly

Returns the value of attribute environments.

Instance Attribute Summary collapse

#accept ⇒ Object readonly

The attribute readers for properties.
#api_token_credentials ⇒ Object readonly

The attribute readers for properties.
#basic_auth_credentials ⇒ Object readonly

The attribute readers for properties.
#csrf_token_credentials ⇒ Object readonly

The attribute readers for properties.
#environment ⇒ Object readonly

The attribute readers for properties.

Class Method Summary collapse

.build_default_config_from_env ⇒ Object

Builds a Configuration instance using environment variables.

Instance Method Summary collapse

#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, api_token_credentials: nil, basic_auth_credentials: nil, csrf_token_credentials: nil, accept: nil) ⇒ Object
#get_base_uri(server = Server::API_HOST) ⇒ String

Generates the appropriate base URI for the environment and the server.
#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, proxy_settings: nil, logging_configuration: nil, environment: Environment::MIST_GLOBAL_01, api_token_credentials: nil, basic_auth_credentials: nil, csrf_token_credentials: nil, accept: 'application/json, application/vnd.api+json') ⇒ Configuration constructor

A new instance of Configuration.

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, proxy_settings: nil, logging_configuration: nil, environment: Environment::MIST_GLOBAL_01, api_token_credentials: nil, basic_auth_credentials: nil, csrf_token_credentials: nil, accept: 'application/json, application/vnd.api+json') ⇒ `Configuration`

Returns a new instance of Configuration.

# File 'lib/mist_api/configuration.rb', line 75

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, proxy_settings: nil,
  logging_configuration: nil, environment: Environment::MIST_GLOBAL_01,
  api_token_credentials: nil, basic_auth_credentials: nil,
  csrf_token_credentials: nil,
  accept: 'application/json, application/vnd.api+json'
)
  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 Custom Header Signature credentials
  @api_token_credentials = api_token_credentials

  # The object holding Basic Authentication credentials
  @basic_auth_credentials = basic_auth_credentials

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

  # TODO: Replace
  @accept = accept

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



72
73
74

# File 'lib/mist_api/configuration.rb', line 72

def environments
  @environments
end