Module: FullContact::Configuration

Included in:
FullContact
Defined in:
lib/fullcontact/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 API

[
:adapter,
:api_key,
:account_key,
:get_request_url_only,
:endpoint,
:format,
:access_token,
:gateway,
:proxy,
:user_agent].freeze
VALID_FORMATS =
Note:

Not all methods support the XML format.

An array of valid request/response formats

[
:json,
:xml].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_ACCESS_TOKEN =

By default, don’t set an access key

nil
DEFAULT_ACCOUNT_KEY =

By default, don’t set an account key

nil
GET_REQUEST_URL_ONLY =

By default, get full response

false
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 Gem".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



64
65
66
 
# File 'lib/fullcontact/configuration.rb', line 64

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:



69
70
71
 
# File 'lib/fullcontact/configuration.rb', line 69

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



74
75
76
77
78
 
# File 'lib/fullcontact/configuration.rb', line 74

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

#reset ⇒ Object

Reset all configuration options to defaults



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/fullcontact/configuration.rb', line 81

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