Class: SoftLayer::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/softlayer/Config.rb

Overview

The SoftLayer Config class is responsible for providing the key information the library needs to communicate with the network SoftLayer API. Those three crucial pieces of information are the Username, the API Key, and the endpoint_url. This information is collected in a hash with the keys ‘:username`, `:api_key`, and `:endpoint_url` respectively.

The routine used to retrieve this information from a Config object is Config.client_settings

There are several locations that the Config class looks for this information:

  • Stored in a configuration file

  • In the Environment Variables of the running process

  • Placed in Global Variables

  • In a hash provided directly to the Config class.

These locations are searched in the order listed above. Information found lower in this list will replace the information found at higher levels. For example if the configuration file provides a username but a different username is also set in the global variables, the Config class allows the global variable to override the name from the config file.

Config File

The library will search for the SoftLayer config file at the file locations listed in the ‘SoftLayer::Config::FILE_LOCATIONS` array. The config file follows the format recognized by Python’s ConfigParser class (and consequently is compatible with the) SoftLayer-Python language bindings). A simple config file looks something like this:

[softlayer]
api_key = DEADBEEFBADF00D
endpoint_url = 'API_PUBLIC_ENDPOINT'
timeout = 60
user_agent = "softlayer-ruby x.x.x"
username = joeusername

Environment Variables

The config class will search the environment variables SL_USERNAME and SL_API_KEY for the username and API key respectively. The endpoint_url may not be set through environment variables.

Global Variables

The names of the global variables that can be used to provide authentication key are:

  • $SL_API_USERNAME

  • $SL_API_KEY

  • $SL_API_BASE_URL (or alias $SL_API_ENDPOINT_URL)

XML RPC Variables

The config allows for two variables that are passed on to the underlying XML RPC agent for interacting with the SoftLayer API (as with other settings these can be loaded from config file, environment variables, globals or provided values):

  • SL_API_TIMEOUT

  • SL_API_USER_AGENT

Direct parameters

Finally, the Config.client_settings routine accepts a hash of arguments. If any of the key information is provided in that hash, that information will override any discovered through the techniques above.

Constant Summary collapse

ENDPOINT_URL_ALIAS = 
[ 'API_PRIVATE_ENDPOINT', 'API_PUBLIC_ENDPOINT' ]
FILE_LOCATIONS = 
[ '/etc/softlayer.conf', '~/.softlayer', './.softlayer' ]

Class Method Summary collapse

Class Method Details

.client_settings(provided_settings = {}) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/softlayer/Config.rb', line 78

def Config.client_settings(provided_settings = {})
  settings = { :endpoint_url => API_PUBLIC_ENDPOINT }

  settings.merge! file_settings
  settings.merge! environment_settings
  settings.merge! globals_settings
  settings.merge! provided_settings

  settings
end

.environment_settings ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/softlayer/Config.rb', line 89

def Config.environment_settings
  result = {}

  result[:api_key]      = ENV['SL_API_KEY'] if ENV['SL_API_KEY']
  result[:user_agent]   = ENV['SL_API_USER_AGENT'] || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
  result[:username]     = ENV['SL_USERNAME'] if ENV['SL_USERNAME']

  if ENV['SL_API_BASE_URL'] && ENDPOINT_URL_ALIAS.include?(ENV['SL_API_BASE_URL'])
    result[:endpoint_url] = (ENV["SL_API_BASE_URL"] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
  elsif ENV['SL_API_ENDPOINT_URL'] && ENDPOINT_URL_ALIAS.include?(ENV['SL_API_ENDPOINT_URL'])
    result[:endpoint_url] = (ENV["SL_API_ENDPOINT_URL"] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
  elsif (ENV['SL_API_BASE_URL']     && ! ENDPOINT_URL_ALIAS.include?(ENV['SL_API_BASE_URL'])) ||
        (ENV['SL_API_ENDPOINT_URL'] && ! ENDPOINT_URL_ALIAS.include?(ENV['SL_API_ENDPOINT_URL']))
    result[:endpoint_url] = ENV['SL_API_BASE_URL'] || ENV['SL_API_ENDPOINT_URL']
  end

  begin
    result[:timeout] = Integer(ENV['SL_API_TIMEOUT']) if ENV['SL_API_TIMEOUT']
  rescue => integer_parse_exception
    raise "Expected the value of the timeout configuration property, '#{ENV['SL_API_TIMEOUT']}', to be parseable as an integer"
  end

  result
end

.file_settings(*additional_files) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/softlayer/Config.rb', line 114

def Config.file_settings(*additional_files)
  result = {}

  search_path = FILE_LOCATIONS
  search_path = search_path + additional_files if additional_files
  search_path = search_path.map { |file_path| File.expand_path(file_path) }

  search_path.each do |file_path|
    if File.readable? file_path
      config            = ConfigParser.new file_path
      softlayer_section = config['softlayer']

      if softlayer_section
        result[:api_key]      = softlayer_section['api_key'] if softlayer_section['api_key']
        result[:user_agent]   = softlayer_section['user_agent'] || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
        result[:username]     = softlayer_section['username'] if softlayer_section['username']

        if softlayer_section['base_url'] && ENDPOINT_URL_ALIAS.include?(softlayer_section['base_url'])
          result[:endpoint_url] = (softlayer_section['base_url'] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
        elsif softlayer_section['endpoint_url'] && ENDPOINT_URL_ALIAS.include?(softlayer_section['endpoint_url'])
          result[:endpoint_url] = (softlayer_section['endpoint_url'] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
        elsif (softlayer_section['base_url']     && ! ENDPOINT_URL_ALIAS.include?(softlayer_section['base_url'])) ||
              (softlayer_section['endpoint_url'] && ! ENDPOINT_URL_ALIAS.include?(softlayer_section['endpoint_url']))
          result[:endpoint_url] = softlayer_section['base_url'] || softlayer_section['endpoint_url']
        end

        begin
          result[:timeout] = Integer(softlayer_section['timeout']) if softlayer_section['timeout']
        rescue => integer_parse_exception
          raise "Expected the value of the timeout configuration property, '#{softlayer_section['timeout']}', to be parseable as an integer"
        end
      end
    end
  end

  result
end

.globals_settings ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/softlayer/Config.rb', line 152

def Config.globals_settings
  result = {}

  result[:api_key]      = $SL_API_KEY if $SL_API_KEY
  result[:user_agent]   = $SL_API_USER_AGENT || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
  result[:username]     = $SL_API_USERNAME if $SL_API_USERNAME

  if $SL_API_ENDPOINT_URL && ENDPOINT_URL_ALIAS.include?($SL_API_ENDPOINT_URL)
    result[:endpoint_url] = ($SL_API_ENDPOINT_URL == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
  elsif $SL_API_BASE_URL && ENDPOINT_URL_ALIAS.include?($SL_API_BASE_URL)
    result[:endpoint_url] = ($SL_API_BASE_URL == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
  elsif ($SL_API_BASE_URL     && ! ENDPOINT_URL_ALIAS.include?($SL_API_BASE_URL)) ||
        ($SL_API_ENDPOINT_URL && ! ENDPOINT_URL_ALIAS.include?($SL_API_ENDPOINT_URL))
    result[:endpoint_url] = $SL_API_ENDPOINT_URL || $SL_API_BASE_URL
  end

  begin
    result[:timeout] = Integer($SL_API_TIMEOUT) if $SL_API_TIMEOUT
  rescue => integer_parse_exception
    raise "Expected the value of the timeout configuration property, '#{$SL_API_TIMEOUT}', to be parseable as an integer"
  end

  result
end