Module: NYCGeoClient::Configuration

Included in:
NYCGeoClient
Defined in:
lib/nyc_geo_client/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,
  :app_id,
  :app_key,
  :endpoint,
  :format,
  :user_agent,
  :proxy,
  :debug
].freeze
VALID_FORMATS =

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_APP_ID =

By default, don’t set an application ID

nil
DEFAULT_APP_KEY =

By default, don’t set an application 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

'https://api.cityofnewyork.us/geoclient/v1/'.freeze
DEFAULT_FORMAT =
Note:

JSON and XML are the available formats

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_DEBUG =

By default, dont’ log the request/response

false
DEFAULT_USER_AGENT =

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

"NYCGeoClient #{NYCGeoClient::VERSION}".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



56
57
58
 
# File 'lib/nyc_geo_client/configuration.rb', line 56

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:



61
62
63
 
# File 'lib/nyc_geo_client/configuration.rb', line 61

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



66
67
68
69
70
 
# File 'lib/nyc_geo_client/configuration.rb', line 66

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

#reset ⇒ Object

Reset all configuration options to defaults



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/nyc_geo_client/configuration.rb', line 73

def reset
  self.adapter        = DEFAULT_ADAPTER
  self.app_id         = DEFAULT_APP_ID
  self.app_key        = DEFAULT_APP_KEY
  self.endpoint       = DEFAULT_ENDPOINT
  self.format         = DEFAULT_FORMAT
  self.user_agent     = DEFAULT_USER_AGENT
  self.proxy          = DEFAULT_PROXY
  self.debug          = DEFAULT_DEBUG
end