module Shirtsio::Configuration

Defines constants and methods related to configuration.

Constants

DEFAULT_API_KEY

By default, don’t set API key.

DEFAULT_ENDPOINT

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

DEFAULT_PROXY

By default, don’t set a proxy server

DEFAULT_USER_AGENT

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

VALID_OPTIONS_KEYS

Public Class Methods

extended(base) click to toggle source

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

# File lib/shirtsio/configuration.rb, line 28
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/shirtsio/configuration.rb, line 34
def configure
  yield self
end
options() click to toggle source

Create a hash of options and their values.

# File lib/shirtsio/configuration.rb, line 39
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/shirtsio/configuration.rb, line 46
def reset
  self.api_key = DEFAULT_API_KEY
  self.endpoint = DEFAULT_ENDPOINT
  self.proxy = DEFAULT_PROXY
  self.user_agent = DEFAULT_USER_AGENT
end