Module: VagrantCloud::Configurable

Includes:
Defaults
Included in:
VagrantCloud, Client
Defined in:
lib/vagrant-cloud/configurable.rb

Constant Summary

Constants included from Defaults

Defaults::USER_AGENT

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Defaults

access_token, endpoint, options, proxy_address, proxy_password, proxy_port, proxy_username, ssl_pem_file, ssl_verify, user_agent, username

Class Method Details

.keys ⇒ Array<Symbol>

The list of configurable keys.

Returns:

  • (Array<Symbol>) 


9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/vagrant-cloud/configurable.rb', line 9

def keys
  @keys ||= [
    :endpoint,
    :username,
    :access_token,
    :proxy_address,
    :proxy_port,
    :proxy_password,
    :proxy_username,
    :ssl_pem_file,
    :ssl_verify,
    :user_agent,
  ]
end

Instance Method Details

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

Set the configuration for this config, using a block.

Examples:

Configure the API endpoint

Configurable.configure do |config|
  config.endpoint   = "http://www.somewhere.com"
  config.ssl_verify = false
end

Yields:

  • (_self)

Yield Parameters:

Returns:

  • (self) 


44
45
46
47
 
# File 'lib/vagrant-cloud/configurable.rb', line 44

def configure
  yield self
  self
end

#reset! ⇒ self Also known as: setup

Reset all configuration options to their default values.

Examples:

Reset all settings

Configurable.reset!

Returns:

  • (self) 


57
58
59
60
61
62
 
# File 'lib/vagrant-cloud/configurable.rb', line 57

def reset!
  Configurable.keys.each do |key|
    instance_variable_set(:"@#{key}", Defaults.options[key])
  end
  self
end