Module: Assistly::Configuration

Included in:: Assistly

Defined in:: lib/assistly/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 Twitter::API

[
:adapter,
:consumer_key,
:consumer_secret,
:format,
:oauth_token,
:oauth_token_secret,
:proxy,
:subdomain,
:support_email,
:user_agent,
:version].freeze

VALID_FORMATS =

Note:
Not all methods support the XML format.

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_CONSUMER_KEY = By default, don't set an application key

nil

DEFAULT_CONSUMER_SECRET = By default, don't set an application secret

nil

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_OAUTH_TOKEN = By default, don't set a user oauth token

nil

DEFAULT_OAUTH_TOKEN_SECRET = By default, don't set a user oauth secret

nil

DEFAULT_PROXY = By default, don't use a proxy server

nil

DEFAULT_SUBDOMAIN = By default use example

"example"

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

"Assistly Ruby Gem #{Assistly::VERSION}".freeze

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

"v1".freeze

DEFAULT_SUPPORT_EMAIL = By default, don't set a support email address

nil

Class Method Summary collapse

.extended(base) ⇒ Object
When this module is extended, set all configuration options to their default values.

Instance Method Summary collapse

#configure {|_self| ... } ⇒ Object
Convenience method to allow configuration options to be set in a block.
#options ⇒ Object
Create a hash of options and their values.
#reset ⇒ Object
Reset all configuration options to defaults.

Class Method Details

.extended(base) ⇒ `Object`

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



68
69
70

# File 'lib/assistly/configuration.rb', line 68

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:

_self (Assistly::Configuration) —
the object that the method was called on



73
74
75

# File 'lib/assistly/configuration.rb', line 73

def configure
  yield self
end

#options ⇒ `Object`

Create a hash of options and their values



78
79
80

# File 'lib/assistly/configuration.rb', line 78

def options
  Hash[VALID_OPTIONS_KEYS.map {|key| [key, send(key)] }]
end

#reset ⇒ `Object`

Reset all configuration options to defaults

# File 'lib/assistly/configuration.rb', line 83

def reset
  self.adapter            = DEFAULT_ADAPTER
  self.consumer_key       = DEFAULT_CONSUMER_KEY
  self.consumer_secret    = DEFAULT_CONSUMER_SECRET
  self.format             = DEFAULT_FORMAT
  self.oauth_token        = DEFAULT_OAUTH_TOKEN
  self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
  self.proxy              = DEFAULT_PROXY
  self.subdomain          = DEFAULT_SUBDOMAIN
  self.support_email      = DEFAULT_SUPPORT_EMAIL
  self.user_agent         = DEFAULT_USER_AGENT
  self.version            = DEFAULT_VERSION
  self
end