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 =
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 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 Gem'.freeze
DEFAULT_GATEWAY =
nil

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) extended(base)

When this module is extended, set all configuration options to their default values



52
53
54
# File 'lib/fullcontact/configuration.rb', line 52

def self.extended(base)
  base.reset
end

Instance Method Details

- (Object) configure {|_self| ... }

Convenience method to allow configuration options to be set in a block

Yields:

  • (_self)

Yield Parameters:



57
58
59
# File 'lib/fullcontact/configuration.rb', line 57

def configure
  yield self
end

- (Object) options

Create a hash of options and their values



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

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

- (Object) reset

Reset all configuration options to defaults



69
70
71
72
73
74
75
76
77
78
# File 'lib/fullcontact/configuration.rb', line 69

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