Class: Oz::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/oz/configuration.rb

Overview

Global configuration for the SDK.

Values set here act as defaults for every Client created without explicit overrides. Configure it once at boot time:

Oz.configure do |config|
  config.api_key = ENV.fetch("WARP_API_KEY")
  config.max_retries = 3
end

Constant Summary collapse

DEFAULT_BASE_URL =

Default base URL for the Oz API.

'https://app.warp.dev/api/v1'
DEFAULT_TIMEOUT =

Default request timeout, in seconds.

60
DEFAULT_MAX_RETRIES =

Default number of automatic retries for transient failures.

2

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



36
37
38
39
40
41
42
43
44
 
# File 'lib/oz/configuration.rb', line 36

def initialize
  @api_key = nil
  @base_url = DEFAULT_BASE_URL
  @timeout = DEFAULT_TIMEOUT
  @max_retries = DEFAULT_MAX_RETRIES
  @default_headers = {}
  @logger = nil
  @adapter = nil
end

Instance Attribute Details

#adapter ⇒ Symbol?

Returns Faraday adapter override (defaults to net_http).

Returns:

  • (Symbol, nil) —

    Faraday adapter override (defaults to net_http).



34
35
36
 
# File 'lib/oz/configuration.rb', line 34

def adapter
  @adapter
end

#api_key ⇒ String?

Returns Bearer token used to authenticate requests.

Returns:

  • (String, nil) —

    Bearer token used to authenticate requests.



22
23
24
 
# File 'lib/oz/configuration.rb', line 22

def api_key
  @api_key
end

#base_url ⇒ String

Returns base URL the client points at.

Returns:

  • (String) —

    base URL the client points at.



24
25
26
 
# File 'lib/oz/configuration.rb', line 24

def base_url
  @base_url
end

#default_headers ⇒ Hash

Returns extra headers sent on every request.

Returns:

  • (Hash) —

    extra headers sent on every request.



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

def default_headers
  @default_headers
end

#logger ⇒ Logger?

Returns optional logger; enables Faraday request logging.

Returns:

  • (Logger, nil) —

    optional logger; enables Faraday request logging.



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

def logger
  @logger
end

#max_retries ⇒ Integer

Returns number of retries for retryable failures.

Returns:

  • (Integer) —

    number of retries for retryable failures.



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

def max_retries
  @max_retries
end

#timeout ⇒ Integer, Float

Returns per-request timeout in seconds.

Returns:

  • (Integer, Float) —

    per-request timeout in seconds.



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

def timeout
  @timeout
end