Module: BlippexAPI::Configuration

Included in:

BlippexAPI

Defined in:

lib/blippex_api/configuration.rb

Overview

Configuration module to set default and custom client credentials

Constant Summary

OPTION_KEYS =

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

DEFAULT_ADAPTER =

Faraday.default_adapter

DEFAULT_API_ENDPOINT =

'https://api.blippex.org/'

DEFAULT_USER_AGENT =

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

Class Method Summary

• .extended(base) ⇒ Object

  Extend hook.

Instance Method Summary

• #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

# File 'lib/blippex_api/configuration.rb', line 20

def self.extended(base)
  base.reset
end

Instance Method Details

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

Set configuration options using a block

Yields:

• (_self)

Yield Parameters:

• _self (BlippexAPI::Configuration) —

  the object that the method was called on

# File 'lib/blippex_api/configuration.rb', line 25

def configure
  yield self
end

#options ⇒ Object

Convert option_keys to hash and return

# File 'lib/blippex_api/configuration.rb', line 30

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

#reset ⇒ Object

Reset the configuration options

# File 'lib/blippex_api/configuration.rb', line 35

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