Module: Gitlab::Configuration

Included in:
Gitlab
Defined in:
lib/gitlab/configuration.rb

Overview

Defines constants and methods related to configuration.

Constant Summary collapse

VALID_OPTIONS_KEYS =

An array of valid keys in the options hash when configuring a Gitlab::API.

[:endpoint, :private_token, :user_agent].freeze
DEFAULT_USER_AGENT =

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

"Gitlab Ruby Gem #{Gitlab::VERSION}".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

Sets all configuration options to their default values when this module is extended.



15
16
17
 
# File 'lib/gitlab/configuration.rb', line 15

def self.extended(base)
  base.reset
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

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

Yields:

  • (_self)

Yield Parameters:



20
21
22
 
# File 'lib/gitlab/configuration.rb', line 20

def configure
  yield self
end

#options ⇒ Object

Creates a hash of options and their values.



25
26
27
28
29
 
# File 'lib/gitlab/configuration.rb', line 25

def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end

#reset ⇒ Object

Resets all configuration options to the defaults.



32
33
34
35
36
 
# File 'lib/gitlab/configuration.rb', line 32

def reset
  self.endpoint       = nil
  self.private_token  = nil
  self.user_agent     = DEFAULT_USER_AGENT
end