Module: Scalingo::Configuration

Included in:
Scalingo
Defined in:
lib/scalingo/configuration.rb

Overview

Defines constants and methods related to configuration

Constant Summary collapse

VALID_OPTIONS_KEYS =

An array of valid keys in the options hash when configuring a Api

[
  :adapter,
  :token,
  :endpoint,
  :auth_endpoint,
  :region,
  :user_agent,
  :proxy,
].freeze
DEFAULT_ADAPTER =
Note:

The default faraday adapter is Net::HTTP.

The adapter that will be used to connect if none is set

Faraday.default_adapter
DEFAULT_TOKEN =

By default, don’t set an token

nil
DEFAULT_AUTH_ENDPOINT =

The endpoint to exchange the token with a JWT

'https://auth.scalingo.com/v1'.freeze
DEFAULT_PROXY =

By default, don’t use a proxy server

nil
DEFAULT_USER_AGENT =

The user agent that will be sent to the Api endpoint if none is set

"Scalingo Ruby Gem #{Scalingo::VERSION}".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

When this module is extended, set all configuration options to their default values



39
40
41
 
# File 'lib/scalingo/configuration.rb', line 39

def self.extended(base)
  base.reset
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Convenience method to allow configuration options to be set in a block

Yields:

  • (_self)

Yield Parameters:



44
45
46
 
# File 'lib/scalingo/configuration.rb', line 44

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



49
50
51
52
53
 
# File 'lib/scalingo/configuration.rb', line 49

def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end

#reset ⇒ Object

Reset all configuration options to defaults



56
57
58
59
60
61
62
63
64
 
# File 'lib/scalingo/configuration.rb', line 56

def reset
  self.adapter       = DEFAULT_ADAPTER
  self.token         = DEFAULT_TOKEN
  self.endpoint      = nil
  self.auth_endpoint = DEFAULT_AUTH_ENDPOINT
  self.region        = nil
  self.user_agent    = DEFAULT_USER_AGENT
  self.proxy         = DEFAULT_PROXY
end