Module: KahunaClient::Configuration

Included in:
KahunaClient
Defined in:
lib/kahuna_client/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 NYCGeoClient::API

[
  :adapter,
  :api_key, #password BasicAuthentication
  :secret_key, #username BasicAuthentication
  :endpoint,
  :environment, # (s = sandbox, p = production)
  :user_agent,
  :proxy,
  :debug
].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_API_KEY =

By default, don’t set an API Key

nil
DEFAULT_SECRET_KEY =

By default, don’t set a Secret Key

nil
DEFAULT_ENDPOINT =
Note:

There is no reason to use any other endpoint at this time

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

'https://tap-nexus.appspot.com/'.freeze
DEFAULT_PROXY =

By default, don’t use a proxy server

nil
DEFAULT_DEBUG =

By default, dont’ log the request/response

false
DEFAULT_USER_AGENT =

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

"KahunaClient #{KahunaClient::VERSION}".freeze
DEFAULT_ENVIRONMENT =

By default, use sandbox as environment

's'

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



50
51
52
 
# File 'lib/kahuna_client/configuration.rb', line 50

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:



55
56
57
 
# File 'lib/kahuna_client/configuration.rb', line 55

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



60
61
62
63
64
 
# File 'lib/kahuna_client/configuration.rb', line 60

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

#reset ⇒ Object

Reset all configuration options to defaults



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/kahuna_client/configuration.rb', line 67

def reset
  self.adapter        = DEFAULT_ADAPTER
  self.api_key        = DEFAULT_API_KEY
  self.secret_key     = DEFAULT_SECRET_KEY
  self.endpoint       = DEFAULT_ENDPOINT
  self.environment    = DEFAULT_ENVIRONMENT
  self.user_agent     = DEFAULT_USER_AGENT
  self.proxy          = DEFAULT_PROXY
  self.debug          = DEFAULT_DEBUG
end