Module: FREDAPI::Configuration

Included in:: FREDAPI

Defined in:: lib/fredapi/configuration.rb

Overview

Configuration module to set default and custom client credentials

Constant Summary collapse

OPTION_KEYS =

[
  'adapter',
  'api_endpoint',
  'user_agent',
  'api_key',
  'file_type'
].freeze

DEFAULT_ADAPTER =

Faraday.default_adapter

DEFAULT_API_ENDPOINT =

'http://api.stlouisfed.org/'

DEFAULT_USER_AGENT =

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

DEFAULT_FILE_TYPE =

'json'

Class Method Summary collapse

.extended(base) ⇒ Object

Extend hook.

Instance Method Summary collapse

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

Set configuration options using a block.
#options ⇒ Object

Convert option_keys to hash and return.
#reset ⇒ Object

Reset the configuration options.

Class Method Details

.extended(base) ⇒ `Object`

Extend hook



23
24
25

# File 'lib/fredapi/configuration.rb', line 23

def self.extended(base)
  base.reset
end

Instance Method Details

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

Set configuration options using a block

Yields:

(_self)

Yield Parameters:

_self (FREDAPI::Configuration) —

the object that the method was called on



28
29
30

# File 'lib/fredapi/configuration.rb', line 28

def configure
  yield self
end

#options ⇒ `Object`

Convert option_keys to hash and return



33
34
35

# File 'lib/fredapi/configuration.rb', line 33

def options
  OPTION_KEYS.inject({}){|o,k|o.merge!(k => send(k))}
end

#reset ⇒ `Object`

Reset the configuration options

# File 'lib/fredapi/configuration.rb', line 38

def reset
  self.adapter      = DEFAULT_ADAPTER
  self.user_agent   = DEFAULT_USER_AGENT
  self.api_endpoint = DEFAULT_API_ENDPOINT
  self.file_type    = DEFAULT_FILE_TYPE
end