Module: Rancher::Configurable

Included in:
Rancher, Client
Defined in:
lib/rancher/configurable.rb

Overview

Configuration options for Client, defaulting to values in Default

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#access_key ⇒ String

Returns Access Key from inside rancher.

Returns:

  • (String) —

    Access Key from inside rancher



23
24
25
 
# File 'lib/rancher/configurable.rb', line 23

def access_key
  @access_key
end

#api_endpoint ⇒ String

Returns Base URL for API requests. default: localhost:8080/v1/projects/1p1.

Returns:



23
24
 
# File 'lib/rancher/configurable.rb', line 23

attr_accessor :access_key, :secret_key, :connection_options,
:middleware, :proxy, :user_agent, :default_media_type

#connection_options ⇒ Hash

Returns Configure connection options for Faraday.

Returns:

  • (Hash) —

    Configure connection options for Faraday

See Also:



23
24
 
# File 'lib/rancher/configurable.rb', line 23

attr_accessor :access_key, :secret_key, :connection_options,
:middleware, :proxy, :user_agent, :default_media_type

#default_media_type ⇒ Object

Returns the value of attribute default_media_type.



23
24
25
 
# File 'lib/rancher/configurable.rb', line 23

def default_media_type
  @default_media_type
end

#middleware ⇒ Faraday::Builder or Faraday::RackBuilder

Returns Configure middleware for Faraday.

Returns:

  • (Faraday::Builder or Faraday::RackBuilder) —

    Configure middleware for Faraday

See Also:



23
24
 
# File 'lib/rancher/configurable.rb', line 23

attr_accessor :access_key, :secret_key, :connection_options,
:middleware, :proxy, :user_agent, :default_media_type

#proxy ⇒ String

Returns URI for proxy server.

Returns:

  • (String) —

    URI for proxy server

See Also:



23
24
 
# File 'lib/rancher/configurable.rb', line 23

attr_accessor :access_key, :secret_key, :connection_options,
:middleware, :proxy, :user_agent, :default_media_type

#secret_key ⇒ Object

Returns the value of attribute secret_key.



23
24
25
 
# File 'lib/rancher/configurable.rb', line 23

def secret_key
  @secret_key
end

#user_agent ⇒ String

Returns Configure User-Agent header for requests.

Returns:

  • (String) —

    Configure User-Agent header for requests.



23
24
 
# File 'lib/rancher/configurable.rb', line 23

attr_accessor :access_key, :secret_key, :connection_options,
:middleware, :proxy, :user_agent, :default_media_type

Class Method Details

.keys ⇒ Array

List of configurable keys for Rancher::Client

Returns:

  • (Array) —

    of option keys



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rancher/configurable.rb', line 30

def keys
  @keys ||= [
    :api_endpoint,
    :access_key,
    :secret_key,
    :connection_options,
    :default_media_type,
    :middleware,
    :proxy,
    :user_agent
  ]
end

Instance Method Details

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

Set configuration options using a block

Yields:

  • (_self)

Yield Parameters:



45
46
47
 
# File 'lib/rancher/configurable.rb', line 45

def configure
  yield self
end

#reset! ⇒ Object Also known as: setup

Reset configuration options to default values



50
51
52
53
54
55
 
# File 'lib/rancher/configurable.rb', line 50

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

#same_options?(opts) ⇒ Boolean

Compares client options to a Hash of requested options

Parameters:

  • opts (Hash) —

    Options to compare with current client options

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/rancher/configurable.rb', line 62

def same_options?(opts)
  opts.hash == options.hash
end