module Skittles::Configuration

Defines constants and methods related to configuration.

Constants

DEFAULT_ACCESS_TOKEN

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

DEFAULT_AUTHORIZATION_ENDPOINT

The endpoint that will be used to authorize a user if none is set.

DEFAULT_CLIENT_ID

By default, don't set a client id.

DEFAULT_CLIENT_SECRET

By default, don't set a cliet secret.

DEFAULT_ENDPOINT

The endpoint that will be used to connect if none is set.

DEFAULT_PROXY

By default, don't set a proxy server.

DEFAULT_USER_AGENT

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

VALID_OPTIONS_KEYS

An array of valid keys in the options hash when configuring a {Flixated::API}.

Public Class Methods

extended(base) click to toggle source

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

# File lib/skittles/configuration.rb, line 42
def self.extended(base)
        base.reset
end

Public Instance Methods

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

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

# File lib/skittles/configuration.rb, line 47
def configure
        yield self
end
options() click to toggle source

Create a hash of options and their values.

# File lib/skittles/configuration.rb, line 52
def options
        VALID_OPTIONS_KEYS.inject({}) do |option,key|
                option.merge!(key => send(key))
        end
end
reset() click to toggle source

Reset all configuration options to default.

# File lib/skittles/configuration.rb, line 59
def reset
        self.access_token           = DEFAULT_ACCESS_TOKEN
        self.authorization_endpoint = DEFAULT_AUTHORIZATION_ENDPOINT
        self.client_id              = DEFAULT_CLIENT_ID
        self.client_secret          = DEFAULT_CLIENT_SECRET
        self.endpoint               = DEFAULT_ENDPOINT
        self.proxy                  = DEFAULT_PROXY
        self.user_agent             = DEFAULT_USER_AGENT
end