pulp_deb_client 2.0.0b2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +163 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContentGenericContentsApi.md +194 -0
  7. data/docs/ContentInstallerFileIndexApi.md +186 -0
  8. data/docs/ContentInstallerPackagesApi.md +194 -0
  9. data/docs/ContentPackageIndexApi.md +186 -0
  10. data/docs/ContentPackagesApi.md +194 -0
  11. data/docs/ContentReleasesApi.md +186 -0
  12. data/docs/DebDistribution.md +29 -0
  13. data/docs/DebPublication.md +31 -0
  14. data/docs/DebRemote.md +57 -0
  15. data/docs/DistributionsAptApi.md +358 -0
  16. data/docs/GenericContent.md +41 -0
  17. data/docs/InlineResponse200.md +23 -0
  18. data/docs/InlineResponse2001.md +23 -0
  19. data/docs/InlineResponse2002.md +23 -0
  20. data/docs/InlineResponse2003.md +23 -0
  21. data/docs/InlineResponse2004.md +23 -0
  22. data/docs/InlineResponse2005.md +23 -0
  23. data/docs/InlineResponse2006.md +23 -0
  24. data/docs/InlineResponse2007.md +23 -0
  25. data/docs/InlineResponse2008.md +23 -0
  26. data/docs/InlineResponse2009.md +23 -0
  27. data/docs/InstallerFileIndex.md +31 -0
  28. data/docs/InstallerPackage.md +99 -0
  29. data/docs/Package.md +99 -0
  30. data/docs/PackageIndex.md +31 -0
  31. data/docs/PublicationsAptApi.md +235 -0
  32. data/docs/PublicationsVerbatimApi.md +235 -0
  33. data/docs/Release.md +31 -0
  34. data/docs/RemotesAptApi.md +417 -0
  35. data/docs/RepositorySyncURL.md +19 -0
  36. data/docs/VerbatimPublication.md +27 -0
  37. data/git_push.sh +58 -0
  38. data/lib/pulp_deb_client/api/content_generic_contents_api.rb +239 -0
  39. data/lib/pulp_deb_client/api/content_installer_file_index_api.rb +225 -0
  40. data/lib/pulp_deb_client/api/content_installer_packages_api.rb +235 -0
  41. data/lib/pulp_deb_client/api/content_package_index_api.rb +225 -0
  42. data/lib/pulp_deb_client/api/content_packages_api.rb +235 -0
  43. data/lib/pulp_deb_client/api/content_releases_api.rb +225 -0
  44. data/lib/pulp_deb_client/api/distributions_apt_api.rb +436 -0
  45. data/lib/pulp_deb_client/api/publications_apt_api.rb +279 -0
  46. data/lib/pulp_deb_client/api/publications_verbatim_api.rb +279 -0
  47. data/lib/pulp_deb_client/api/remotes_apt_api.rb +510 -0
  48. data/lib/pulp_deb_client/api_client.rb +402 -0
  49. data/lib/pulp_deb_client/api_error.rb +57 -0
  50. data/lib/pulp_deb_client/configuration.rb +243 -0
  51. data/lib/pulp_deb_client/models/async_operation_response.rb +202 -0
  52. data/lib/pulp_deb_client/models/deb_distribution.rb +337 -0
  53. data/lib/pulp_deb_client/models/deb_publication.rb +282 -0
  54. data/lib/pulp_deb_client/models/deb_remote.rb +653 -0
  55. data/lib/pulp_deb_client/models/generic_content.rb +444 -0
  56. data/lib/pulp_deb_client/models/inline_response200.rb +235 -0
  57. data/lib/pulp_deb_client/models/inline_response2001.rb +235 -0
  58. data/lib/pulp_deb_client/models/inline_response2002.rb +235 -0
  59. data/lib/pulp_deb_client/models/inline_response2003.rb +235 -0
  60. data/lib/pulp_deb_client/models/inline_response2004.rb +235 -0
  61. data/lib/pulp_deb_client/models/inline_response2005.rb +235 -0
  62. data/lib/pulp_deb_client/models/inline_response2006.rb +235 -0
  63. data/lib/pulp_deb_client/models/inline_response2007.rb +235 -0
  64. data/lib/pulp_deb_client/models/inline_response2008.rb +235 -0
  65. data/lib/pulp_deb_client/models/inline_response2009.rb +235 -0
  66. data/lib/pulp_deb_client/models/installer_file_index.rb +355 -0
  67. data/lib/pulp_deb_client/models/installer_package.rb +1101 -0
  68. data/lib/pulp_deb_client/models/package.rb +1101 -0
  69. data/lib/pulp_deb_client/models/package_index.rb +355 -0
  70. data/lib/pulp_deb_client/models/release.rb +356 -0
  71. data/lib/pulp_deb_client/models/repository_sync_url.rb +214 -0
  72. data/lib/pulp_deb_client/models/verbatim_publication.rb +258 -0
  73. data/lib/pulp_deb_client/version.rb +15 -0
  74. data/lib/pulp_deb_client.rb +71 -0
  75. data/pulp_deb_client.gemspec +39 -0
  76. data/spec/api/content_generic_contents_api_spec.rb +80 -0
  77. data/spec/api/content_installer_file_index_api_spec.rb +77 -0
  78. data/spec/api/content_installer_packages_api_spec.rb +80 -0
  79. data/spec/api/content_package_index_api_spec.rb +77 -0
  80. data/spec/api/content_packages_api_spec.rb +80 -0
  81. data/spec/api/content_releases_api_spec.rb +77 -0
  82. data/spec/api/distributions_apt_api_spec.rb +118 -0
  83. data/spec/api/publications_apt_api_spec.rb +87 -0
  84. data/spec/api/publications_verbatim_api_spec.rb +87 -0
  85. data/spec/api/remotes_apt_api_spec.rb +132 -0
  86. data/spec/api_client_spec.rb +188 -0
  87. data/spec/configuration_spec.rb +42 -0
  88. data/spec/models/async_operation_response_spec.rb +41 -0
  89. data/spec/models/deb_distribution_spec.rb +77 -0
  90. data/spec/models/deb_publication_spec.rb +83 -0
  91. data/spec/models/deb_remote_spec.rb +165 -0
  92. data/spec/models/generic_content_spec.rb +113 -0
  93. data/spec/models/inline_response2001_spec.rb +59 -0
  94. data/spec/models/inline_response2002_spec.rb +59 -0
  95. data/spec/models/inline_response2003_spec.rb +59 -0
  96. data/spec/models/inline_response2004_spec.rb +59 -0
  97. data/spec/models/inline_response2005_spec.rb +59 -0
  98. data/spec/models/inline_response2006_spec.rb +59 -0
  99. data/spec/models/inline_response2007_spec.rb +59 -0
  100. data/spec/models/inline_response2008_spec.rb +59 -0
  101. data/spec/models/inline_response2009_spec.rb +59 -0
  102. data/spec/models/inline_response200_spec.rb +59 -0
  103. data/spec/models/installer_file_index_spec.rb +83 -0
  104. data/spec/models/installer_package_spec.rb +287 -0
  105. data/spec/models/package_index_spec.rb +83 -0
  106. data/spec/models/package_spec.rb +287 -0
  107. data/spec/models/release_spec.rb +83 -0
  108. data/spec/models/repository_sync_url_spec.rb +47 -0
  109. data/spec/models/verbatim_publication_spec.rb +71 -0
  110. data/spec/spec_helper.rb +111 -0
  111. metadata +242 -0
@@ -0,0 +1,402 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.1.3-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'faraday'
18
+
19
+ module PulpDebClient
20
+ class ApiClient
21
+ # The Configuration object holding settings to be used in the API client.
22
+ attr_accessor :config
23
+
24
+ # Defines the headers to be used in HTTP requests of all API calls by default.
25
+ #
26
+ # @return [Hash]
27
+ attr_accessor :default_headers
28
+
29
+ # Initializes the ApiClient
30
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
31
+ def initialize(config = Configuration.default)
32
+ @config = config
33
+ @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
34
+ @default_headers = {
35
+ 'Content-Type' => 'application/json',
36
+ 'User-Agent' => @user_agent
37
+ }
38
+ end
39
+
40
+ def self.default
41
+ @@default ||= ApiClient.new
42
+ end
43
+
44
+ # Call an API with given options.
45
+ #
46
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
47
+ # the data deserialized from response body (could be nil), response status code and response headers.
48
+ def call_api(http_method, path, opts = {})
49
+ ssl_options = {
50
+ :ca_file => @config.ssl_ca_file,
51
+ :verify => @config.ssl_verify,
52
+ :verify_mode => @config.ssl_verify_mode,
53
+ :client_cert => @config.ssl_client_cert,
54
+ :client_key => @config.ssl_client_key
55
+ }
56
+
57
+ connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
58
+ conn.basic_auth(config.username, config.password)
59
+ if opts[:header_params]["Content-Type"] == "multipart/form-data"
60
+ conn.request :multipart
61
+ conn.request :url_encoded
62
+ end
63
+ conn.adapter(Faraday.default_adapter)
64
+ end
65
+
66
+ begin
67
+ response = connection.public_send(http_method.to_sym.downcase) do |req|
68
+ build_request(http_method, path, req, opts)
69
+ end
70
+
71
+ if @config.debugging
72
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
73
+ end
74
+
75
+ unless response.success?
76
+ if response.status == 0
77
+ # Errors from libcurl will be made visible here
78
+ fail ApiError.new(:code => 0,
79
+ :message => response.return_message)
80
+ else
81
+ fail ApiError.new(:code => response.status,
82
+ :response_headers => response.headers,
83
+ :response_body => response.body),
84
+ response.reason_phrase
85
+ end
86
+ end
87
+ rescue Faraday::TimeoutError
88
+ fail ApiError.new('Connection timed out')
89
+ end
90
+
91
+ if opts[:return_type]
92
+ data = deserialize(response, opts[:return_type])
93
+ else
94
+ data = nil
95
+ end
96
+ return data, response.status, response.headers
97
+ end
98
+
99
+ # Builds the HTTP request
100
+ #
101
+ # @param [String] http_method HTTP method/verb (e.g. POST)
102
+ # @param [String] path URL path (e.g. /account/new)
103
+ # @option opts [Hash] :header_params Header parameters
104
+ # @option opts [Hash] :query_params Query parameters
105
+ # @option opts [Hash] :form_params Query parameters
106
+ # @option opts [Object] :body HTTP body (JSON/XML)
107
+ # @return [Typhoeus::Request] A Typhoeus Request
108
+ def build_request(http_method, path, request, opts = {})
109
+ url = build_request_url(path)
110
+ http_method = http_method.to_sym.downcase
111
+
112
+ header_params = @default_headers.merge(opts[:header_params] || {})
113
+ query_params = opts[:query_params] || {}
114
+ form_params = opts[:form_params] || {}
115
+
116
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
117
+
118
+ req_opts = {
119
+ :method => http_method,
120
+ :headers => header_params,
121
+ :params => query_params,
122
+ :params_encoding => @config.params_encoding,
123
+ :timeout => @config.timeout,
124
+ :verbose => @config.debugging
125
+ }
126
+
127
+ if [:post, :patch, :put, :delete].include?(http_method)
128
+ req_body = build_request_body(header_params, form_params, opts[:body])
129
+ req_opts.update :body => req_body
130
+ if @config.debugging
131
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
132
+ end
133
+ end
134
+ request.headers = header_params
135
+ request.body = req_body
136
+ request.url url
137
+ request.params = query_params
138
+ download_file(request) if opts[:return_type] == 'File'
139
+ request
140
+ end
141
+
142
+ # Builds the HTTP request body
143
+ #
144
+ # @param [Hash] header_params Header parameters
145
+ # @param [Hash] form_params Query parameters
146
+ # @param [Object] body HTTP body (JSON/XML)
147
+ # @return [String] HTTP body data in the form of string
148
+ def build_request_body(header_params, form_params, body)
149
+ # http form
150
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
151
+ data = URI.encode_www_form(form_params)
152
+ elsif header_params['Content-Type'] == 'multipart/form-data'
153
+ data = {}
154
+ form_params.each do |key, value|
155
+ case value
156
+ when ::File, ::Tempfile
157
+ # TODO hardcode to application/octet-stream, need better way to detect content type
158
+ data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
159
+ when ::Array, nil
160
+ # let Faraday handle Array and nil parameters
161
+ data[key] = value
162
+ else
163
+ data[key] = value.to_s
164
+ end
165
+ end
166
+ elsif body
167
+ data = body.is_a?(String) ? body : body.to_json
168
+ else
169
+ data = nil
170
+ end
171
+ data
172
+ end
173
+
174
+ # Check if the given MIME is a JSON MIME.
175
+ # JSON MIME examples:
176
+ # application/json
177
+ # application/json; charset=UTF8
178
+ # APPLICATION/JSON
179
+ # */*
180
+ # @param [String] mime MIME
181
+ # @return [Boolean] True if the MIME is application/json
182
+ def json_mime?(mime)
183
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
184
+ end
185
+
186
+ # Deserialize the response to the given return type.
187
+ #
188
+ # @param [Response] response HTTP response
189
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
190
+ def deserialize(response, return_type)
191
+ body = response.body
192
+
193
+ # handle file downloading - return the File instance processed in request callbacks
194
+ # note that response body is empty when the file is written in chunks in request on_body callback
195
+ return @tempfile if return_type == 'File'
196
+
197
+ return nil if body.nil? || body.empty?
198
+
199
+ # return response body directly for String return type
200
+ return body if return_type == 'String'
201
+
202
+ # ensuring a default content type
203
+ content_type = response.headers['Content-Type'] || 'application/json'
204
+
205
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
206
+
207
+ begin
208
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
209
+ rescue JSON::ParserError => e
210
+ if %w(String Date DateTime).include?(return_type)
211
+ data = body
212
+ else
213
+ raise e
214
+ end
215
+ end
216
+
217
+ convert_to_type data, return_type
218
+ end
219
+
220
+ # Convert data to the given return type.
221
+ # @param [Object] data Data to be converted
222
+ # @param [String] return_type Return type
223
+ # @return [Mixed] Data in a particular type
224
+ def convert_to_type(data, return_type)
225
+ return nil if data.nil?
226
+ case return_type
227
+ when 'String'
228
+ data.to_s
229
+ when 'Integer'
230
+ data.to_i
231
+ when 'Float'
232
+ data.to_f
233
+ when 'Boolean'
234
+ data == true
235
+ when 'DateTime'
236
+ # parse date time (expecting ISO 8601 format)
237
+ DateTime.parse data
238
+ when 'Date'
239
+ # parse date time (expecting ISO 8601 format)
240
+ Date.parse data
241
+ when 'Object'
242
+ # generic object (usually a Hash), return directly
243
+ data
244
+ when /\AArray<(.+)>\z/
245
+ # e.g. Array<Pet>
246
+ sub_type = $1
247
+ data.map { |item| convert_to_type(item, sub_type) }
248
+ when /\AHash\<String, (.+)\>\z/
249
+ # e.g. Hash<String, Integer>
250
+ sub_type = $1
251
+ {}.tap do |hash|
252
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
253
+ end
254
+ else
255
+ # models, e.g. Pet
256
+ PulpDebClient.const_get(return_type).build_from_hash(data)
257
+ end
258
+ end
259
+
260
+ # Save response body into a file in (the defined) temporary folder, using the filename
261
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
262
+ # The response body is written to the file in chunks in order to handle files which
263
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
264
+ # process can use.
265
+ #
266
+ # @see Configuration#temp_folder_path
267
+ def download_file(request)
268
+ tempfile = nil
269
+ encoding = nil
270
+ request.on_headers do |response|
271
+ content_disposition = response.headers['Content-Disposition']
272
+ if content_disposition && content_disposition =~ /filename=/i
273
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
274
+ prefix = sanitize_filename(filename)
275
+ else
276
+ prefix = 'download-'
277
+ end
278
+ prefix = prefix + '-' unless prefix.end_with?('-')
279
+ encoding = response.body.encoding
280
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
281
+ @tempfile = tempfile
282
+ end
283
+ request.on_body do |chunk|
284
+ chunk.force_encoding(encoding)
285
+ tempfile.write(chunk)
286
+ end
287
+ request.on_complete do |response|
288
+ tempfile.close if tempfile
289
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
290
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
291
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
292
+ "explicitly with `tempfile.delete`"
293
+ end
294
+ end
295
+
296
+ # Sanitize filename by removing path.
297
+ # e.g. ../../sun.gif becomes sun.gif
298
+ #
299
+ # @param [String] filename the filename to be sanitized
300
+ # @return [String] the sanitized filename
301
+ def sanitize_filename(filename)
302
+ filename.gsub(/.*[\/\\]/, '')
303
+ end
304
+
305
+ def build_request_url(path)
306
+ # Add leading and trailing slashes to path
307
+ path = "/#{path}".gsub(/\/+/, '/')
308
+ @config.base_url + path
309
+ end
310
+
311
+ # Update hearder and query params based on authentication settings.
312
+ #
313
+ # @param [Hash] header_params Header parameters
314
+ # @param [Hash] query_params Query parameters
315
+ # @param [String] auth_names Authentication scheme name
316
+ def update_params_for_auth!(header_params, query_params, auth_names)
317
+ Array(auth_names).each do |auth_name|
318
+ auth_setting = @config.auth_settings[auth_name]
319
+ next unless auth_setting
320
+ case auth_setting[:in]
321
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
322
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
323
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
324
+ end
325
+ end
326
+ end
327
+
328
+ # Sets user agent in HTTP header
329
+ #
330
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
331
+ def user_agent=(user_agent)
332
+ @user_agent = user_agent
333
+ @default_headers['User-Agent'] = @user_agent
334
+ end
335
+
336
+ # Return Accept header based on an array of accepts provided.
337
+ # @param [Array] accepts array for Accept
338
+ # @return [String] the Accept header (e.g. application/json)
339
+ def select_header_accept(accepts)
340
+ return nil if accepts.nil? || accepts.empty?
341
+ # use JSON when present, otherwise use all of the provided
342
+ json_accept = accepts.find { |s| json_mime?(s) }
343
+ json_accept || accepts.join(',')
344
+ end
345
+
346
+ # Return Content-Type header based on an array of content types provided.
347
+ # @param [Array] content_types array for Content-Type
348
+ # @return [String] the Content-Type header (e.g. application/json)
349
+ def select_header_content_type(content_types)
350
+ # use application/json by default
351
+ return 'application/json' if content_types.nil? || content_types.empty?
352
+ # use JSON when present, otherwise use the first one
353
+ json_content_type = content_types.find { |s| json_mime?(s) }
354
+ json_content_type || content_types.first
355
+ end
356
+
357
+ # Convert object (array, hash, object, etc) to JSON string.
358
+ # @param [Object] model object to be converted into JSON string
359
+ # @return [String] JSON string representation of the object
360
+ def object_to_http_body(model)
361
+ return model if model.nil? || model.is_a?(String)
362
+ local_body = nil
363
+ if model.is_a?(Array)
364
+ local_body = model.map { |m| object_to_hash(m) }
365
+ else
366
+ local_body = object_to_hash(model)
367
+ end
368
+ local_body.to_json
369
+ end
370
+
371
+ # Convert object(non-array) to hash.
372
+ # @param [Object] obj object to be converted into JSON string
373
+ # @return [String] JSON string representation of the object
374
+ def object_to_hash(obj)
375
+ if obj.respond_to?(:to_hash)
376
+ obj.to_hash
377
+ else
378
+ obj
379
+ end
380
+ end
381
+
382
+ # Build parameter value according to the given collection format.
383
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
384
+ def build_collection_param(param, collection_format)
385
+ case collection_format
386
+ when :csv
387
+ param.join(',')
388
+ when :ssv
389
+ param.join(' ')
390
+ when :tsv
391
+ param.join("\t")
392
+ when :pipes
393
+ param.join('|')
394
+ when :multi
395
+ # return the array directly as typhoeus will handle it as expected
396
+ param
397
+ else
398
+ fail "unknown collection format: #{collection_format.inspect}"
399
+ end
400
+ end
401
+ end
402
+ end
@@ -0,0 +1,57 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.1.3-SNAPSHOT
10
+
11
+ =end
12
+
13
+ module PulpDebClient
14
+ class ApiError < StandardError
15
+ attr_reader :code, :response_headers, :response_body
16
+
17
+ # Usage examples:
18
+ # ApiError.new
19
+ # ApiError.new("message")
20
+ # ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
21
+ # ApiError.new(:code => 404, :message => "Not Found")
22
+ def initialize(arg = nil)
23
+ if arg.is_a? Hash
24
+ if arg.key?(:message) || arg.key?('message')
25
+ super(arg[:message] || arg['message'])
26
+ else
27
+ super arg
28
+ end
29
+
30
+ arg.each do |k, v|
31
+ instance_variable_set "@#{k}", v
32
+ end
33
+ else
34
+ super arg
35
+ end
36
+ end
37
+
38
+ # Override to_s to display a friendly error message
39
+ def to_s
40
+ message
41
+ end
42
+
43
+ def message
44
+ if @message.nil?
45
+ msg = "Error message: the server returns an error"
46
+ else
47
+ msg = @message
48
+ end
49
+
50
+ msg += "\nHTTP status code: #{code}" if code
51
+ msg += "\nResponse headers: #{response_headers}" if response_headers
52
+ msg += "\nResponse body: #{response_body}" if response_body
53
+
54
+ msg
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,243 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.1.3-SNAPSHOT
10
+
11
+ =end
12
+
13
+ module PulpDebClient
14
+ class Configuration
15
+ # Defines url scheme
16
+ attr_accessor :scheme
17
+
18
+ # Defines url host
19
+ attr_accessor :host
20
+
21
+ # Defines url base path
22
+ attr_accessor :base_path
23
+
24
+ # Defines API keys used with API Key authentications.
25
+ #
26
+ # @return [Hash] key: parameter name, value: parameter value (API key)
27
+ #
28
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
29
+ # config.api_key['api_key'] = 'xxx'
30
+ attr_accessor :api_key
31
+
32
+ # Defines API key prefixes used with API Key authentications.
33
+ #
34
+ # @return [Hash] key: parameter name, value: API key prefix
35
+ #
36
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
37
+ # config.api_key_prefix['api_key'] = 'Token'
38
+ attr_accessor :api_key_prefix
39
+
40
+ # Defines the username used with HTTP basic authentication.
41
+ #
42
+ # @return [String]
43
+ attr_accessor :username
44
+
45
+ # Defines the password used with HTTP basic authentication.
46
+ #
47
+ # @return [String]
48
+ attr_accessor :password
49
+
50
+ # Defines the access token (Bearer) used with OAuth2.
51
+ attr_accessor :access_token
52
+
53
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
54
+ # details will be logged with `logger.debug` (see the `logger` attribute).
55
+ # Default to false.
56
+ #
57
+ # @return [true, false]
58
+ attr_accessor :debugging
59
+
60
+ # Defines the logger used for debugging.
61
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
62
+ #
63
+ # @return [#debug]
64
+ attr_accessor :logger
65
+
66
+ # Defines the temporary folder to store downloaded files
67
+ # (for API endpoints that have file response).
68
+ # Default to use `Tempfile`.
69
+ #
70
+ # @return [String]
71
+ attr_accessor :temp_folder_path
72
+
73
+ # The time limit for HTTP request in seconds.
74
+ # Default to 0 (never times out).
75
+ attr_accessor :timeout
76
+
77
+ # Set this to false to skip client side validation in the operation.
78
+ # Default to true.
79
+ # @return [true, false]
80
+ attr_accessor :client_side_validation
81
+
82
+ ### TLS/SSL setting
83
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
84
+ # Default to true.
85
+ #
86
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
87
+ #
88
+ # @return [true, false]
89
+ attr_accessor :ssl_verify
90
+
91
+ ### TLS/SSL setting
92
+ # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
93
+ #
94
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
95
+ #
96
+ attr_accessor :ssl_verify_mode
97
+
98
+ ### TLS/SSL setting
99
+ # Set this to customize the certificate file to verify the peer.
100
+ #
101
+ # @return [String] the path to the certificate file
102
+ attr_accessor :ssl_ca_file
103
+
104
+ ### TLS/SSL setting
105
+ # Client certificate file (for client certificate)
106
+ attr_accessor :ssl_client_cert
107
+
108
+ ### TLS/SSL setting
109
+ # Client private key file (for client certificate)
110
+ attr_accessor :ssl_client_key
111
+
112
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
113
+ # Default to nil.
114
+ #
115
+ # @see The params_encoding option of Ethon. Related source code:
116
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
117
+ attr_accessor :params_encoding
118
+
119
+ attr_accessor :inject_format
120
+
121
+ attr_accessor :force_ending_format
122
+
123
+ def initialize
124
+ @scheme = 'http'
125
+ @host = 'localhost'
126
+ @base_path = ''
127
+ @api_key = {}
128
+ @api_key_prefix = {}
129
+ @timeout = 0
130
+ @client_side_validation = true
131
+ @ssl_verify = true
132
+ @ssl_verify_mode = nil
133
+ @ssl_ca_file = nil
134
+ @ssl_client_cert = nil
135
+ @ssl_client_key = nil
136
+ @debugging = false
137
+ @inject_format = false
138
+ @force_ending_format = false
139
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
140
+
141
+ yield(self) if block_given?
142
+ end
143
+
144
+ # The default Configuration object.
145
+ def self.default
146
+ @@default ||= Configuration.new
147
+ end
148
+
149
+ def configure
150
+ yield(self) if block_given?
151
+ end
152
+
153
+ def scheme=(scheme)
154
+ # remove :// from scheme
155
+ @scheme = scheme.sub(/:\/\//, '')
156
+ end
157
+
158
+ def host=(host)
159
+ # remove http(s):// and anything after a slash
160
+ @host = host.sub(/https?:\/\//, '').split('/').first
161
+ end
162
+
163
+ def base_path=(base_path)
164
+ # Add leading and trailing slashes to base_path
165
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
166
+ @base_path = '' if @base_path == '/'
167
+ end
168
+
169
+ def base_url
170
+ "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
171
+ end
172
+
173
+ # Gets API key (with prefix if set).
174
+ # @param [String] param_name the parameter name of API key auth
175
+ def api_key_with_prefix(param_name)
176
+ if @api_key_prefix[param_name]
177
+ "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
178
+ else
179
+ @api_key[param_name]
180
+ end
181
+ end
182
+
183
+ # Gets Basic Auth token string
184
+ def basic_auth_token
185
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
186
+ end
187
+
188
+ # Returns Auth Settings hash for api client.
189
+ def auth_settings
190
+ {
191
+ 'Basic' =>
192
+ {
193
+ type: 'basic',
194
+ in: 'header',
195
+ key: 'Authorization',
196
+ value: basic_auth_token
197
+ },
198
+ }
199
+ end
200
+
201
+ # Returns an array of Server setting
202
+ def server_settings
203
+ [
204
+ {
205
+ url: "http://localhost:24817/",
206
+ description: "No descriptoin provided",
207
+ }
208
+ ]
209
+ end
210
+
211
+ # Returns URL based on server settings
212
+ #
213
+ # @param index array index of the server settings
214
+ # @param variables hash of variable and the corresponding value
215
+ def server_url(index, variables = {})
216
+ servers = server_settings
217
+
218
+ # check array index out of bound
219
+ if (index < 0 || index >= servers.size)
220
+ fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
221
+ end
222
+
223
+ server = servers[index]
224
+ url = server[:url]
225
+
226
+ # go through variable and assign a value
227
+ server[:variables].each do |name, variable|
228
+ if variables.key?(name)
229
+ if (server[:variables][name][:enum_values].include? variables[name])
230
+ url.gsub! "{" + name.to_s + "}", variables[name]
231
+ else
232
+ fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
233
+ end
234
+ else
235
+ # use default value
236
+ url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
237
+ end
238
+ end
239
+
240
+ url
241
+ end
242
+ end
243
+ end