Module: FullContact::Configuration

Included in:
FullContact
Defined in:
lib/fullcontact/configuration.rb

Overview

Defines constants and methods related to configuration

Constant Summary

VALID_OPTIONS_KEYS =

An array of valid keys in the options hash when configuring a API

[
:adapter,
:api_key,
:endpoint,
:format,
:gateway,
:proxy,
:user_agent].freeze
VALID_FORMATS =

An array of valid request/response formats

[:json].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 key

nil
DEFAULT_ENDPOINT =

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

'https://api.fullcontact.com/v2/'.freeze
DEFAULT_FORMAT =
Note:

JSON is preferred over XML because it is more concise and faster to parse.

The response format appended to the path and sent in the 'Accept' header if none is set

:json
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

"FullContact Ruby Client/#{FullContact::VERSION}".freeze
DEFAULT_GATEWAY =
nil

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



49
50
51
# File 'lib/fullcontact/configuration.rb', line 49

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:



54
55
56
# File 'lib/fullcontact/configuration.rb', line 54

def configure
  yield self
end

#optionsObject

Create a hash of options and their values



59
60
61
62
63
# File 'lib/fullcontact/configuration.rb', line 59

def options
  options = {}
  VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
  options
end

#resetObject

Reset all configuration options to defaults



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

def reset
  self.adapter = DEFAULT_ADAPTER
  self.api_key = DEFAULT_API_KEY
  self.endpoint = DEFAULT_ENDPOINT
  self.format = DEFAULT_FORMAT
  self.proxy = DEFAULT_PROXY
  self.user_agent = DEFAULT_USER_AGENT
  self.gateway = DEFAULT_GATEWAY
  self
end