module SparkApi::Configuration

Constants

DEFAULT_ACCESS_URI
DEFAULT_API_KEY
DEFAULT_API_SECRET
DEFAULT_API_USER
DEFAULT_AUTHORIZATION_URI
DEFAULT_AUTH_ENDPOINT
DEFAULT_COMPRESS
DEFAULT_DICTIONARY_VERSION
DEFAULT_ENDPOINT
DEFAULT_MIDDLEWARE
DEFAULT_OAUTH2
DEFAULT_REDIRECT_URI
DEFAULT_REQUEST_ID_CHAIN
DEFAULT_SESSION_PATH
DEFAULT_SSL
DEFAULT_SSL_VERIFY
DEFAULT_TIMEOUT
DEFAULT_USER_AGENT
DEFAULT_VERSION
OAUTH2_KEYS
VALID_OPTION_KEYS

valid configuration options

X_SPARK_API_USER_AGENT

Public Class Methods

extended(base) click to toggle source
# File lib/spark_api/configuration.rb, line 58
def self.extended(base)
  base.reset_configuration
end

Public Instance Methods

configure() { |self| ... } click to toggle source
# File lib/spark_api/configuration.rb, line 53
def configure
  yield(self)
  oauthify! if convert_to_oauth2?
end
options() click to toggle source
# File lib/spark_api/configuration.rb, line 62
def options
  VALID_OPTION_KEYS.inject({}) do |opt,key|
    opt.merge(key => send(key))
  end
end
reset_configuration() click to toggle source
# File lib/spark_api/configuration.rb, line 68
def reset_configuration
  self.api_key     = DEFAULT_API_KEY
  self.api_secret  = DEFAULT_API_SECRET
  self.api_user    = DEFAULT_API_USER
  self.authentication_mode = SparkApi::Authentication::ApiAuth
  self.auth_endpoint  = DEFAULT_AUTH_ENDPOINT
  self.endpoint    = DEFAULT_ENDPOINT
  self.oauth2_provider = DEFAULT_OAUTH2
  self.user_agent  = DEFAULT_USER_AGENT
  self.ssl         = DEFAULT_SSL
  self.ssl_verify  = DEFAULT_SSL_VERIFY
  self.version     = DEFAULT_VERSION
  self.compress    = DEFAULT_COMPRESS
  self.timeout     = DEFAULT_TIMEOUT
  self.middleware = DEFAULT_MIDDLEWARE
  self.dictionary_version = DEFAULT_DICTIONARY_VERSION
  self.request_id_chain = DEFAULT_REQUEST_ID_CHAIN
  self
end