module Nimbu::Configuration

Constants

DEFAULT_ADAPTER

Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test

DEFAULT_AUTO_PAGINATION

By default, don't traverse the page links

DEFAULT_BASIC_AUTH

By default, don't set a user basic authentication

DEFAULT_CLIENT_ID

By default, don't set an application key

DEFAULT_CLIENT_SECRET

By default, don't set an application secret

DEFAULT_CONNECTION_OPTIONS

By default uses the Faraday connection options if none is set

DEFAULT_CONTENT_LOCALE

By default, don't set a content_locale

DEFAULT_ENDPOINT

The api endpoint used to connect to Nimbu if none is set

DEFAULT_LOGIN

By default, don't set a user login name

DEFAULT_MIME_TYPE

By default the Accept header will make a request for JSON

DEFAULT_OAUTH_TOKEN

By default, don't set a user oauth access token

DEFAULT_PASSWORD

By default, don't set a user password

DEFAULT_SITE

The web endpoint used to connect to Nimbu if none is set

DEFAULT_SSL

The default SSL configuration

DEFAULT_SUBDOMAIN

By default, don't set a nimbu subdomain

DEFAULT_USER_AGENT

The value sent in the http header for 'User-Agent' if none is set

VALID_OPTIONS_KEYS

Public Class Methods

extended(base) click to toggle source
# File lib/nimbu-api/configuration.rb, line 80
def self.extended(base)
  base.reset!
end
keys() click to toggle source
# File lib/nimbu-api/configuration.rb, line 85
def keys
  VALID_OPTIONS_KEYS
end

Public Instance Methods

configure() { |self| ... } click to toggle source

Convenience method to allow for global setting of configuration options

# File lib/nimbu-api/configuration.rb, line 76
def configure
  yield self
end
options() click to toggle source
# File lib/nimbu-api/configuration.rb, line 90
def options
  options = {}
  VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
  options
end
reset!() click to toggle source

Reset configuration options to their defaults

# File lib/nimbu-api/configuration.rb, line 98
def reset!
  self.client_id          = DEFAULT_CLIENT_ID
  self.client_secret      = DEFAULT_CLIENT_SECRET
  self.oauth_token        = DEFAULT_OAUTH_TOKEN
  self.endpoint           = DEFAULT_ENDPOINT
  self.site               = DEFAULT_SITE
  self.ssl                = DEFAULT_SSL
  self.user_agent         = DEFAULT_USER_AGENT
  self.connection_options = DEFAULT_CONNECTION_OPTIONS
  self.mime_type          = DEFAULT_MIME_TYPE
  self.login              = DEFAULT_LOGIN
  self.password           = DEFAULT_PASSWORD
  self.basic_auth         = DEFAULT_BASIC_AUTH
  self.auto_pagination    = DEFAULT_AUTO_PAGINATION
  self.content_locale     = DEFAULT_CONTENT_LOCALE
  self.adapter            = DEFAULT_ADAPTER
  self.subdomain          = DEFAULT_SUBDOMAIN
  self
end