Class: PulpcoreClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/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:


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/pulpcore_client/configuration.rb', line 123

def initialize
  @scheme = 'http'
  @host = 'pulp'
  @base_path = ''
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_tokenObject

Defines the access token (Bearer) used with OAuth2.


51
52
53
# File 'lib/pulpcore_client/configuration.rb', line 51

def access_token
  @access_token
end

#api_keyHash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash)

    key: parameter name, value: parameter value (API key)


30
31
32
# File 'lib/pulpcore_client/configuration.rb', line 30

def api_key
  @api_key
end

#api_key_prefixHash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash)

    key: parameter name, value: API key prefix


38
39
40
# File 'lib/pulpcore_client/configuration.rb', line 38

def api_key_prefix
  @api_key_prefix
end

#base_pathObject

Defines url base path


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

def base_path
  @base_path
end

#client_side_validationtrue, false

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

Returns:

  • (true, false)

80
81
82
# File 'lib/pulpcore_client/configuration.rb', line 80

def client_side_validation
  @client_side_validation
end

#debuggingtrue, 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)

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

def debugging
  @debugging
end

#force_ending_formatObject

Returns the value of attribute force_ending_format


121
122
123
# File 'lib/pulpcore_client/configuration.rb', line 121

def force_ending_format
  @force_ending_format
end

#hostObject

Defines url host


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

def host
  @host
end

#inject_formatObject

Returns the value of attribute inject_format


119
120
121
# File 'lib/pulpcore_client/configuration.rb', line 119

def inject_format
  @inject_format
end

#logger#debug

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

Returns:

  • (#debug)

64
65
66
# File 'lib/pulpcore_client/configuration.rb', line 64

def logger
  @logger
end

#params_encodingObject

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:

117
118
119
# File 'lib/pulpcore_client/configuration.rb', line 117

def params_encoding
  @params_encoding
end

#passwordString

Defines the password used with HTTP basic authentication.

Returns:

  • (String)

48
49
50
# File 'lib/pulpcore_client/configuration.rb', line 48

def password
  @password
end

#schemeObject

Defines url scheme


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

def scheme
  @scheme
end

#ssl_ca_fileString

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

Returns:

  • (String)

    the path to the certificate file


102
103
104
# File 'lib/pulpcore_client/configuration.rb', line 102

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_certObject

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


106
107
108
# File 'lib/pulpcore_client/configuration.rb', line 106

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_keyObject

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


110
111
112
# File 'lib/pulpcore_client/configuration.rb', line 110

def ssl_client_key
  @ssl_client_key
end

#ssl_verifytrue, 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)

89
90
91
# File 'lib/pulpcore_client/configuration.rb', line 89

def ssl_verify
  @ssl_verify
end

#ssl_verify_modeObject

Note:

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

TLS/SSL setting Any `OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)


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

def ssl_verify_mode
  @ssl_verify_mode
end

#temp_folder_pathString

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

Returns:

  • (String)

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

def temp_folder_path
  @temp_folder_path
end

#timeoutObject

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


75
76
77
# File 'lib/pulpcore_client/configuration.rb', line 75

def timeout
  @timeout
end

#usernameString

Defines the username used with HTTP basic authentication.

Returns:

  • (String)

43
44
45
# File 'lib/pulpcore_client/configuration.rb', line 43

def username
  @username
end

Class Method Details

.defaultObject

The default Configuration object.


145
146
147
# File 'lib/pulpcore_client/configuration.rb', line 145

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

Instance Method Details

#api_key_with_prefix(param_name) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String)

    the parameter name of API key auth


175
176
177
178
179
180
181
# File 'lib/pulpcore_client/configuration.rb', line 175

def api_key_with_prefix(param_name)
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
  else
    @api_key[param_name]
  end
end

#auth_settingsObject

Returns Auth Settings hash for api client.


189
190
191
192
193
194
195
196
197
198
199
# File 'lib/pulpcore_client/configuration.rb', line 189

def auth_settings
  {
    'basicAuth' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
  }
end

#base_urlObject


169
170
171
# File 'lib/pulpcore_client/configuration.rb', line 169

def base_url
  "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
end

#basic_auth_tokenObject

Gets Basic Auth token string


184
185
186
# File 'lib/pulpcore_client/configuration.rb', line 184

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

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

Yields:

  • (_self)

Yield Parameters:


149
150
151
# File 'lib/pulpcore_client/configuration.rb', line 149

def configure
  yield(self) if block_given?
end

#server_settingsObject

Returns an array of Server setting


202
203
204
205
206
207
208
209
# File 'lib/pulpcore_client/configuration.rb', line 202

def server_settings
  [
    {
      url: "http://pulp/",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}) ⇒ 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


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/pulpcore_client/configuration.rb', line 215

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

  # 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]

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (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