Class: Ionoscloud::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ionoscloud/configuration.rb', line 141

def initialize
  @scheme = 'https'
  @host = 'api.ionos.com'
  @base_path = '/cloudapi/v6'
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @token = nil
  @token_prefix = 'Bearer'
  @timeout = 0
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @params_encoding = nil
  @cert_file = nil
  @key_file = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
  @max_retries = 3
  @wait_time = 0.1
  @max_wait_time = 2

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



58
59
60
 
# File 'lib/ionoscloud/configuration.rb', line 58

def access_token
  @access_token
end

#base_path ⇒ Object

Defines url base path



22
23
24
 
# File 'lib/ionoscloud/configuration.rb', line 22

def base_path
  @base_path
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



118
119
120
 
# File 'lib/ionoscloud/configuration.rb', line 118

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


87
88
89
 
# File 'lib/ionoscloud/configuration.rb', line 87

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


65
66
67
 
# File 'lib/ionoscloud/configuration.rb', line 65

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



133
134
135
 
# File 'lib/ionoscloud/configuration.rb', line 133

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



19
20
21
 
# File 'lib/ionoscloud/configuration.rb', line 19

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



131
132
133
 
# File 'lib/ionoscloud/configuration.rb', line 131

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



122
123
124
 
# File 'lib/ionoscloud/configuration.rb', line 122

def key_file
  @key_file
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


71
72
73
 
# File 'lib/ionoscloud/configuration.rb', line 71

def logger
  @logger
end

#max_retries ⇒ Object

Returns the value of attribute max_retries.



135
136
137
 
# File 'lib/ionoscloud/configuration.rb', line 135

def max_retries
  @max_retries
end

#max_wait_time ⇒ Object

Returns the value of attribute max_wait_time.



139
140
141
 
# File 'lib/ionoscloud/configuration.rb', line 139

def max_wait_time
  @max_wait_time
end

#params_encoding ⇒ Object

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


129
130
131
 
# File 'lib/ionoscloud/configuration.rb', line 129

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


55
56
57
 
# File 'lib/ionoscloud/configuration.rb', line 55

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



16
17
18
 
# File 'lib/ionoscloud/configuration.rb', line 16

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



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

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



28
29
30
 
# File 'lib/ionoscloud/configuration.rb', line 28

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



34
35
36
 
# File 'lib/ionoscloud/configuration.rb', line 34

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



31
32
33
 
# File 'lib/ionoscloud/configuration.rb', line 31

def server_variables
  @server_variables
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


114
115
116
 
# File 'lib/ionoscloud/configuration.rb', line 114

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


78
79
80
 
# File 'lib/ionoscloud/configuration.rb', line 78

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



82
83
84
 
# File 'lib/ionoscloud/configuration.rb', line 82

def timeout
  @timeout
end

#token ⇒ String

Defines Tokens used with Token authentications.

Returns:

  • (String) 


39
40
41
 
# File 'lib/ionoscloud/configuration.rb', line 39

def token
  @token
end

#token_prefix ⇒ String

Defines Token prefixes used with Token authentications. Default to ‘Bearer’.

Returns:

  • (String) 


45
46
47
 
# File 'lib/ionoscloud/configuration.rb', line 45

def token_prefix
  @token_prefix
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


50
51
52
 
# File 'lib/ionoscloud/configuration.rb', line 50

def username
  @username
end

#verify_ssl ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


96
97
98
 
# File 'lib/ionoscloud/configuration.rb', line 96

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.

Returns:

  • (true, false) 


105
106
107
 
# File 'lib/ionoscloud/configuration.rb', line 105

def verify_ssl_host
  @verify_ssl_host
end

#wait_time ⇒ Object

Returns the value of attribute wait_time.



137
138
139
 
# File 'lib/ionoscloud/configuration.rb', line 137

def wait_time
  @wait_time
end

Class Method Details

.default ⇒ Object

The default Configuration object.



170
171
172
 
# File 'lib/ionoscloud/configuration.rb', line 170

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/ionoscloud/configuration.rb', line 208

def auth_settings
  {
    'Basic Authentication' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
    'Token Authentication' =>
      {
        type: 'token',
        in: 'header',
        key: 'Authorization',
        value: token.nil? ? nil : "#{token_prefix} #{token}"
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



195
196
197
198
199
200
 
# File 'lib/ionoscloud/configuration.rb', line 195

def base_url(operation = nil)
  index = server_operation_index.fetch(operation, server_index)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

  server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



203
204
205
 
# File 'lib/ionoscloud/configuration.rb', line 203

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

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

Yields:

  • (_self)

Yield Parameters:



174
175
176
 
# File 'lib/ionoscloud/configuration.rb', line 174

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



237
238
239
240
 
# File 'lib/ionoscloud/configuration.rb', line 237

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



228
229
230
231
232
233
234
235
 
# File 'lib/ionoscloud/configuration.rb', line 228

def server_settings
  [
    {
      url: "https://api.ionos.com/cloudapi/v6",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ionoscloud/configuration.rb', line 246

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end