Module: Octokit::Configuration

Included in:
Octokit
Defined in:
lib/octokit/configuration.rb

Constant Summary collapse

VALID_OPTIONS_KEYS = 
[
:adapter,
:api_version,
:login,
:password,
:proxy,
:oauth_token,
:user_agent].freeze
DEFAULT_ADAPTER = 
Faraday.default_adapter
DEFAULT_API_VERSION = 
2
DEFAULT_USER_AGENT = 
"Octokit Ruby Gem #{Octokit::VERSION}".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



21
22
23
 
# File 'lib/octokit/configuration.rb', line 21

def self.extended(base)
  base.reset
end

Instance Method Details

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

Yields:

  • (_self)

Yield Parameters:



25
26
27
 
# File 'lib/octokit/configuration.rb', line 25

def configure
  yield self
end

#options ⇒ Object 



29
30
31
 
# File 'lib/octokit/configuration.rb', line 29

def options
  VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
end

#reset ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/octokit/configuration.rb', line 33

def reset
  self.adapter     = DEFAULT_ADAPTER
  self.api_version = DEFAULT_API_VERSION
  self.       = nil
  self.password    = nil
  self.proxy       = nil
  self.oauth_token = nil
  self.user_agent  = DEFAULT_USER_AGENT
end