Contents

module Brat
  # Defines constants and methods related to configuration.
  module Configuration
    # An array of valid keys in the options hash when configuring a Brat::API.
    VALID_OPTIONS_KEYS = [:endpoint, :private_token, :user_agent, :sudo,
                           :namespace, :api_version, :host].freeze

    # The user agent that will be sent to the API endpoint if none is set.
    DEFAULT_USER_AGENT = "Brat Ruby Gem #{Brat::VERSION}".freeze

    # @private
    attr_accessor(*VALID_OPTIONS_KEYS)

    # Sets all configuration options to their default values
    # when this module is extended.
    def self.extended(base)
      base.reset
    end

    # Convenience method to allow configuration options to be set in a block.
    def configure
      yield self
    end

    # Creates a hash of options and their values.
    def options
      VALID_OPTIONS_KEYS.inject({}) do |option, key|
        option.merge!(key => send(key))
      end
    end

    # Resets all configuration options to the defaults.
    def reset
      self.endpoint       = 'http://brat.io/api/v3'
      self.private_token  = ENV['BRAT_API_PRIVATE_TOKEN']
      self.sudo           = nil
      self.user_agent     = DEFAULT_USER_AGENT
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
brat-0.1.1	lib/brat/configuration.rb