Contents

# coding: utf-8
module Evostream
  module Configuration
    VALID_CONFIG_KEYS = [
      :host, :protocol, :port, :path_prefix, :timeout, :username, :password
    ].freeze
    OPTIONAL_CONFIG_KEYS = VALID_CONFIG_KEYS - [:host]

    DEFAULT_PROTOCOL = 'http'
    DEFAULT_PORT = 80
    DEFAULT_PATH_PREFIX = ''
    DEFAULT_USERNAME = ''
    DEFAULT_PASSWORD = ''
    DEFAULT_TIMEOUT = 5

    # Build accessor methods for every config options so we can do this, for example:
    #   Evostream.host = 'evostream.example.com'
    attr_accessor *VALID_CONFIG_KEYS

    # Make sure we have the default values set when we get 'extended'
    def self.extended(base)
      base.reset
    end

    def reset
      self.protocol    = DEFAULT_PROTOCOL
      self.port        = DEFAULT_PORT
      self.path_prefix = DEFAULT_PATH_PREFIX
      self.username    = DEFAULT_USERNAME
      self.password    = DEFAULT_PASSWORD
      self.timeout     = DEFAULT_TIMEOUT
    end

    # config/initializers/evostream.rb (for instance)
    #
    # Evostream.configure do |config|
    #   config.host = 'evostream.example.com'
    #   config.protocol = 'http'
    #   config.port = 80
    #   config.path_prefix = '/evo'
    #   config.username = 'evo'
    #   config.password = 'password'
    # end
    #
    # elsewhere
    #
    # client = Evostream::Client.new
    #
    def configure
      yield self
      true
    end

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

  end # Configuration
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
evostream-0.0.8	lib/evostream/configuration.rb