module Dirigible::Configuration

Constants

DEFAULT_APP_KEY

By default, don’t set app key.

DEFAULT_ENDPOINT

The endpoint that will be used to authorize a user if none is set.

DEFAULT_HTTP_ADAPTER

The Faraday HTTP adapter to be used.

DEFAULT_MASTER_SECRET

By default, don’t set the master secret.

DEFAULT_PROXY

By default, don’t set a proxy server.

DEFAULT_USER_AGENT

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

VALID_OPTION_KEYS

Public Class Methods

extended(base) click to toggle source

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

# File lib/dirigible/configuration.rb, line 35
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/dirigible/configuration.rb, line 41
def configure
  yield self
end
options() click to toggle source

Create a hash of options and their values.

# File lib/dirigible/configuration.rb, line 46
def options
  VALID_OPTION_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end
reset() click to toggle source

Reset all configuration options to default.

# File lib/dirigible/configuration.rb, line 53
def reset
  self.app_key = DEFAULT_APP_KEY
  self.master_secret = DEFAULT_MASTER_SECRET
  self.endpoint = DEFAULT_ENDPOINT
  self.http_adapter = DEFAULT_HTTP_ADAPTER
  self.proxy = DEFAULT_PROXY
  self.user_agent = DEFAULT_USER_AGENT
end