Module: TINAMI::Configuration

Included in:
TINAMI
Defined in:
lib/tinami/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 TINAMI::Client

[
  :adapter,
  :api_key,
  :auth_key,
  :endpoint,
  :proxy,
  :user_agent
].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 application api key

nil
DEFAULT_AUTH_KEY =

By default, don't set an user auth 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

'http://api.tinami.com'.freeze
DEFAULT_PROXY =

By default, don't use a proxy server

nil
DEFAULT_USER_AGENT =

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

"TINAMI/#{VERSION} (https://github.com/mitukiii/tinami-for-ruby)".freeze

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



45
46
47
 
# File 'lib/tinami/configuration.rb', line 45

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:



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

def configure
  yield self
  self
end

#options ⇒ Object

Create a hash of options and their values



56
57
58
59
60
 
# File 'lib/tinami/configuration.rb', line 56

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

#reset ⇒ Object

Reset all configuration options to defaults



63
64
65
66
67
68
69
70
71
 
# File 'lib/tinami/configuration.rb', line 63

def reset
  self.adapter    = DEFAULT_ADAPTER
  self.api_key    = DEFAULT_API_KEY
  self.auth_key   = DEFAULT_AUTH_KEY
  self.endpoint   = DEFAULT_ENDPOINT
  self.proxy      = DEFAULT_PROXY
  self.user_agent = DEFAULT_USER_AGENT
  self
end