module Scalingo::Configuration
Defines constants and methods related to configuration
Constants
- DEFAULT_ADAPTER
The adapter that will be used to connect if none is set
@note The default faraday adapter is Net::HTTP.
- DEFAULT_AUTH_ENDPOINT
The endpoint to exchange the token with a
JWT
- DEFAULT_PROXY
By default, don't use a proxy server
- DEFAULT_TOKEN
By default, don't set an token
- DEFAULT_USER_AGENT
The user agent that will be sent to the
Api
endpoint if none is set- VALID_OPTIONS_KEYS
An array of valid keys in the options hash when configuring a {Scalingo::Api}
Public Class Methods
extended(base)
click to toggle source
When this module is extended, set all configuration options to their default values
# File lib/scalingo/configuration.rb, line 39 def self.extended(base) base.reset end
Public Instance Methods
configure() { |self| ... }
click to toggle source
Convenience method to allow configuration options to be set in a block
# File lib/scalingo/configuration.rb, line 44 def configure yield self end
options()
click to toggle source
Create a hash of options and their values
# File lib/scalingo/configuration.rb, line 49 def options VALID_OPTIONS_KEYS.inject({}) do |option, key| option.merge!(key => send(key)) end end
reset()
click to toggle source
Reset all configuration options to defaults
# 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