Contents

module Gemfury
  # Defines constants and methods related to configuration
  module Configuration
    # An array of valid keys in the options hash when configuring
    VALID_OPTIONS_KEYS = [
      :user_api_key,
      :adapter,
      :endpoint,
      :gitpoint,
      :user_agent,
      :api_version,
      :account].freeze

    # The adapter that will be used to connect if none is set
    DEFAULT_ADAPTER = :net_http

    # The endpoint that will be used to connect if none is set
    DEFAULT_ENDPOINT  = 'https://api.fury.io/'.freeze

    # The HTTP endpoint for git repo (used for .netrc credentials)
    DEFAULT_GITPOINT  = 'https://git.fury.io/'.freeze

    # The value sent in the 'User-Agent' header if none is set
    DEFAULT_USER_AGENT = "Gemfury RubyGem #{Gemfury::VERSION}".freeze

    # Default API version
    DEFAULT_API_VERSION = 1

    # Default user API key
    DEFAULT_API_KEY = nil

    # Use the current account (no impersonation)
    DEFAULT_ACCOUNT = nil

    # @private
    attr_accessor *VALID_OPTIONS_KEYS

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

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

    # Create a hash of options and their values
    def options
      options = {}
      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
      options
    end

    # Reset all configuration options to defaults
    def reset
      self.user_api_key       = DEFAULT_API_KEY
      self.adapter            = DEFAULT_ADAPTER
      self.endpoint           = DEFAULT_ENDPOINT
      self.gitpoint           = DEFAULT_GITPOINT
      self.user_agent         = DEFAULT_USER_AGENT
      self.api_version        = DEFAULT_API_VERSION
      self.account            = DEFAULT_ACCOUNT
      self
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
gemfury-0.7.0	lib/gemfury/configuration.rb
gemfury-0.6.0	lib/gemfury/configuration.rb
gemfury-0.6.0.rc1	lib/gemfury/configuration.rb
gemfury-0.5.0	lib/gemfury/configuration.rb
gemfury-0.5.0.beta3	lib/gemfury/configuration.rb