pulp_npm_client 0.1.0a1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +157 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContentPackagesApi.md +208 -0
  7. data/docs/ContentSummary.md +21 -0
  8. data/docs/ContentSummaryResponse.md +21 -0
  9. data/docs/DistributionsNpmApi.md +364 -0
  10. data/docs/NpmNpmDistribution.md +25 -0
  11. data/docs/NpmNpmDistributionResponse.md +31 -0
  12. data/docs/NpmNpmRemote.md +37 -0
  13. data/docs/NpmNpmRemoteResponse.md +43 -0
  14. data/docs/NpmNpmRepository.md +21 -0
  15. data/docs/NpmNpmRepositoryResponse.md +29 -0
  16. data/docs/NpmPackage.md +27 -0
  17. data/docs/NpmPackageResponse.md +27 -0
  18. data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
  19. data/docs/PaginatednpmNpmDistributionResponseList.md +23 -0
  20. data/docs/PaginatednpmNpmRemoteResponseList.md +23 -0
  21. data/docs/PaginatednpmNpmRepositoryResponseList.md +23 -0
  22. data/docs/PaginatednpmPackageResponseList.md +23 -0
  23. data/docs/PatchednpmNpmDistribution.md +25 -0
  24. data/docs/PatchednpmNpmRemote.md +37 -0
  25. data/docs/PatchednpmNpmRepository.md +21 -0
  26. data/docs/PolicyEnum.md +16 -0
  27. data/docs/PulpNpmPackagesApi.md +60 -0
  28. data/docs/RemotesNpmApi.md +368 -0
  29. data/docs/RepositoriesNpmApi.md +468 -0
  30. data/docs/RepositoriesNpmVersionsApi.md +271 -0
  31. data/docs/RepositoryAddRemoveContent.md +21 -0
  32. data/docs/RepositorySyncURL.md +19 -0
  33. data/docs/RepositoryVersion.md +17 -0
  34. data/docs/RepositoryVersionResponse.md +25 -0
  35. data/git_push.sh +58 -0
  36. data/lib/pulp_npm_client.rb +69 -0
  37. data/lib/pulp_npm_client/api/content_packages_api.rb +264 -0
  38. data/lib/pulp_npm_client/api/distributions_npm_api.rb +445 -0
  39. data/lib/pulp_npm_client/api/pulp_npm_packages_api.rb +86 -0
  40. data/lib/pulp_npm_client/api/remotes_npm_api.rb +451 -0
  41. data/lib/pulp_npm_client/api/repositories_npm_api.rb +573 -0
  42. data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +339 -0
  43. data/lib/pulp_npm_client/api_client.rb +402 -0
  44. data/lib/pulp_npm_client/api_error.rb +57 -0
  45. data/lib/pulp_npm_client/configuration.rb +243 -0
  46. data/lib/pulp_npm_client/models/async_operation_response.rb +213 -0
  47. data/lib/pulp_npm_client/models/content_summary.rb +240 -0
  48. data/lib/pulp_npm_client/models/content_summary_response.rb +240 -0
  49. data/lib/pulp_npm_client/models/npm_npm_distribution.rb +261 -0
  50. data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +290 -0
  51. data/lib/pulp_npm_client/models/npm_npm_remote.rb +339 -0
  52. data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +368 -0
  53. data/lib/pulp_npm_client/models/npm_npm_repository.rb +234 -0
  54. data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +271 -0
  55. data/lib/pulp_npm_client/models/npm_package.rb +270 -0
  56. data/lib/pulp_npm_client/models/npm_package_response.rb +269 -0
  57. data/lib/pulp_npm_client/models/paginated_repository_version_response_list.rb +237 -0
  58. data/lib/pulp_npm_client/models/paginatednpm_npm_distribution_response_list.rb +237 -0
  59. data/lib/pulp_npm_client/models/paginatednpm_npm_remote_response_list.rb +237 -0
  60. data/lib/pulp_npm_client/models/paginatednpm_npm_repository_response_list.rb +237 -0
  61. data/lib/pulp_npm_client/models/paginatednpm_package_response_list.rb +237 -0
  62. data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +251 -0
  63. data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +329 -0
  64. data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +229 -0
  65. data/lib/pulp_npm_client/models/policy_enum.rb +37 -0
  66. data/lib/pulp_npm_client/models/repository_add_remove_content.rb +232 -0
  67. data/lib/pulp_npm_client/models/repository_sync_url.rb +220 -0
  68. data/lib/pulp_npm_client/models/repository_version.rb +208 -0
  69. data/lib/pulp_npm_client/models/repository_version_response.rb +246 -0
  70. data/lib/pulp_npm_client/version.rb +15 -0
  71. data/pulp_npm_client.gemspec +39 -0
  72. data/spec/api/content_packages_api_spec.rb +87 -0
  73. data/spec/api/distributions_npm_api_spec.rb +121 -0
  74. data/spec/api/pulp_npm_packages_api_spec.rb +48 -0
  75. data/spec/api/remotes_npm_api_spec.rb +123 -0
  76. data/spec/api/repositories_npm_api_spec.rb +143 -0
  77. data/spec/api/repositories_npm_versions_api_spec.rb +104 -0
  78. data/spec/api_client_spec.rb +188 -0
  79. data/spec/configuration_spec.rb +42 -0
  80. data/spec/models/async_operation_response_spec.rb +41 -0
  81. data/spec/models/content_summary_response_spec.rb +53 -0
  82. data/spec/models/content_summary_spec.rb +53 -0
  83. data/spec/models/npm_npm_distribution_response_spec.rb +83 -0
  84. data/spec/models/npm_npm_distribution_spec.rb +65 -0
  85. data/spec/models/npm_npm_remote_response_spec.rb +119 -0
  86. data/spec/models/npm_npm_remote_spec.rb +101 -0
  87. data/spec/models/npm_npm_repository_response_spec.rb +77 -0
  88. data/spec/models/npm_npm_repository_spec.rb +53 -0
  89. data/spec/models/npm_package_response_spec.rb +71 -0
  90. data/spec/models/npm_package_spec.rb +71 -0
  91. data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
  92. data/spec/models/paginatednpm_npm_distribution_response_list_spec.rb +59 -0
  93. data/spec/models/paginatednpm_npm_remote_response_list_spec.rb +59 -0
  94. data/spec/models/paginatednpm_npm_repository_response_list_spec.rb +59 -0
  95. data/spec/models/paginatednpm_package_response_list_spec.rb +59 -0
  96. data/spec/models/patchednpm_npm_distribution_spec.rb +65 -0
  97. data/spec/models/patchednpm_npm_remote_spec.rb +101 -0
  98. data/spec/models/patchednpm_npm_repository_spec.rb +53 -0
  99. data/spec/models/policy_enum_spec.rb +35 -0
  100. data/spec/models/repository_add_remove_content_spec.rb +53 -0
  101. data/spec/models/repository_sync_url_spec.rb +47 -0
  102. data/spec/models/repository_version_response_spec.rb +65 -0
  103. data/spec/models/repository_version_spec.rb +41 -0
  104. data/spec/spec_helper.rb +111 -0
  105. metadata +233 -0
@@ -0,0 +1,339 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #Fetch, Upload, Organize, and Distribute Software Packages
5
+
6
+ The version of the OpenAPI document: v3
7
+ Contact: pulp-list@redhat.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module PulpNpmClient
16
+ class RepositoriesNpmVersionsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete a repository version
23
+ # Trigger an asynchronous task to delete a repositroy version.
24
+ # @param npm_npm_repository_version_href [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [AsyncOperationResponse]
27
+ def delete(npm_npm_repository_version_href, opts = {})
28
+ data, _status_code, _headers = delete_with_http_info(npm_npm_repository_version_href, opts)
29
+ data
30
+ end
31
+
32
+ # Delete a repository version
33
+ # Trigger an asynchronous task to delete a repositroy version.
34
+ # @param npm_npm_repository_version_href [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
37
+ def delete_with_http_info(npm_npm_repository_version_href, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: RepositoriesNpmVersionsApi.delete ...'
40
+ end
41
+ # verify the required parameter 'npm_npm_repository_version_href' is set
42
+ if @api_client.config.client_side_validation && npm_npm_repository_version_href.nil?
43
+ fail ArgumentError, "Missing the required parameter 'npm_npm_repository_version_href' when calling RepositoriesNpmVersionsApi.delete"
44
+ end
45
+ # resource path
46
+ local_var_path = '{npm_npm_repository_version_href}'.sub('{' + 'npm_npm_repository_version_href' + '}', CGI.escape(npm_npm_repository_version_href.to_s).gsub('%2F', '/'))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:body]
61
+
62
+ # return_type
63
+ return_type = opts[:return_type] || 'AsyncOperationResponse'
64
+
65
+ # auth_names
66
+ auth_names = opts[:auth_names] || ['basicAuth']
67
+
68
+ new_options = opts.merge(
69
+ :header_params => header_params,
70
+ :query_params => query_params,
71
+ :form_params => form_params,
72
+ :body => post_body,
73
+ :auth_names => auth_names,
74
+ :return_type => return_type
75
+ )
76
+
77
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
78
+ if @api_client.config.debugging
79
+ @api_client.config.logger.debug "API called: RepositoriesNpmVersionsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
+ end
81
+ return data, status_code, headers
82
+ end
83
+
84
+ # List repository versions
85
+ # A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
86
+ # @param npm_npm_repository_href [String]
87
+ # @param [Hash] opts the optional parameters
88
+ # @option opts [String] :content content
89
+ # @option opts [String] :content__in content__in
90
+ # @option opts [Integer] :limit Number of results to return per page.
91
+ # @option opts [String] :number number
92
+ # @option opts [String] :number__gt number__gt
93
+ # @option opts [String] :number__gte number__gte
94
+ # @option opts [String] :number__lt number__lt
95
+ # @option opts [String] :number__lte number__lte
96
+ # @option opts [String] :number__range number__range
97
+ # @option opts [Integer] :offset The initial index from which to return the results.
98
+ # @option opts [String] :ordering Which field to use when ordering the results.
99
+ # @option opts [String] :pulp_created pulp_created
100
+ # @option opts [String] :pulp_created__gt pulp_created__gt
101
+ # @option opts [String] :pulp_created__gte pulp_created__gte
102
+ # @option opts [String] :pulp_created__lt pulp_created__lt
103
+ # @option opts [String] :pulp_created__lte pulp_created__lte
104
+ # @option opts [String] :pulp_created__range pulp_created__range
105
+ # @option opts [String] :fields A list of fields to include in the response.
106
+ # @option opts [String] :exclude_fields A list of fields to exclude from the response.
107
+ # @return [PaginatedRepositoryVersionResponseList]
108
+ def list(npm_npm_repository_href, opts = {})
109
+ data, _status_code, _headers = list_with_http_info(npm_npm_repository_href, opts)
110
+ data
111
+ end
112
+
113
+ # List repository versions
114
+ # A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
115
+ # @param npm_npm_repository_href [String]
116
+ # @param [Hash] opts the optional parameters
117
+ # @option opts [String] :content content
118
+ # @option opts [String] :content__in content__in
119
+ # @option opts [Integer] :limit Number of results to return per page.
120
+ # @option opts [String] :number number
121
+ # @option opts [String] :number__gt number__gt
122
+ # @option opts [String] :number__gte number__gte
123
+ # @option opts [String] :number__lt number__lt
124
+ # @option opts [String] :number__lte number__lte
125
+ # @option opts [String] :number__range number__range
126
+ # @option opts [Integer] :offset The initial index from which to return the results.
127
+ # @option opts [String] :ordering Which field to use when ordering the results.
128
+ # @option opts [String] :pulp_created pulp_created
129
+ # @option opts [String] :pulp_created__gt pulp_created__gt
130
+ # @option opts [String] :pulp_created__gte pulp_created__gte
131
+ # @option opts [String] :pulp_created__lt pulp_created__lt
132
+ # @option opts [String] :pulp_created__lte pulp_created__lte
133
+ # @option opts [String] :pulp_created__range pulp_created__range
134
+ # @option opts [String] :fields A list of fields to include in the response.
135
+ # @option opts [String] :exclude_fields A list of fields to exclude from the response.
136
+ # @return [Array<(PaginatedRepositoryVersionResponseList, Integer, Hash)>] PaginatedRepositoryVersionResponseList data, response status code and response headers
137
+ def list_with_http_info(npm_npm_repository_href, opts = {})
138
+ if @api_client.config.debugging
139
+ @api_client.config.logger.debug 'Calling API: RepositoriesNpmVersionsApi.list ...'
140
+ end
141
+ # verify the required parameter 'npm_npm_repository_href' is set
142
+ if @api_client.config.client_side_validation && npm_npm_repository_href.nil?
143
+ fail ArgumentError, "Missing the required parameter 'npm_npm_repository_href' when calling RepositoriesNpmVersionsApi.list"
144
+ end
145
+ # resource path
146
+ local_var_path = '{npm_npm_repository_href}versions/'.sub('{' + 'npm_npm_repository_href' + '}', CGI.escape(npm_npm_repository_href.to_s).gsub('%2F', '/'))
147
+
148
+ # query parameters
149
+ query_params = opts[:query_params] || {}
150
+ query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
151
+ query_params[:'content__in'] = opts[:'content__in'] if !opts[:'content__in'].nil?
152
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
153
+ query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
154
+ query_params[:'number__gt'] = opts[:'number__gt'] if !opts[:'number__gt'].nil?
155
+ query_params[:'number__gte'] = opts[:'number__gte'] if !opts[:'number__gte'].nil?
156
+ query_params[:'number__lt'] = opts[:'number__lt'] if !opts[:'number__lt'].nil?
157
+ query_params[:'number__lte'] = opts[:'number__lte'] if !opts[:'number__lte'].nil?
158
+ query_params[:'number__range'] = opts[:'number__range'] if !opts[:'number__range'].nil?
159
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
160
+ query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
161
+ query_params[:'pulp_created'] = opts[:'pulp_created'] if !opts[:'pulp_created'].nil?
162
+ query_params[:'pulp_created__gt'] = opts[:'pulp_created__gt'] if !opts[:'pulp_created__gt'].nil?
163
+ query_params[:'pulp_created__gte'] = opts[:'pulp_created__gte'] if !opts[:'pulp_created__gte'].nil?
164
+ query_params[:'pulp_created__lt'] = opts[:'pulp_created__lt'] if !opts[:'pulp_created__lt'].nil?
165
+ query_params[:'pulp_created__lte'] = opts[:'pulp_created__lte'] if !opts[:'pulp_created__lte'].nil?
166
+ query_params[:'pulp_created__range'] = opts[:'pulp_created__range'] if !opts[:'pulp_created__range'].nil?
167
+ query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
168
+ query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
169
+
170
+ # header parameters
171
+ header_params = opts[:header_params] || {}
172
+ # HTTP header 'Accept' (if needed)
173
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
174
+
175
+ # form parameters
176
+ form_params = opts[:form_params] || {}
177
+
178
+ # http body (model)
179
+ post_body = opts[:body]
180
+
181
+ # return_type
182
+ return_type = opts[:return_type] || 'PaginatedRepositoryVersionResponseList'
183
+
184
+ # auth_names
185
+ auth_names = opts[:auth_names] || ['basicAuth']
186
+
187
+ new_options = opts.merge(
188
+ :header_params => header_params,
189
+ :query_params => query_params,
190
+ :form_params => form_params,
191
+ :body => post_body,
192
+ :auth_names => auth_names,
193
+ :return_type => return_type
194
+ )
195
+
196
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
197
+ if @api_client.config.debugging
198
+ @api_client.config.logger.debug "API called: RepositoriesNpmVersionsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
199
+ end
200
+ return data, status_code, headers
201
+ end
202
+
203
+ # Inspect a repository version
204
+ # A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
205
+ # @param npm_npm_repository_version_href [String]
206
+ # @param [Hash] opts the optional parameters
207
+ # @option opts [String] :fields A list of fields to include in the response.
208
+ # @option opts [String] :exclude_fields A list of fields to exclude from the response.
209
+ # @return [RepositoryVersionResponse]
210
+ def read(npm_npm_repository_version_href, opts = {})
211
+ data, _status_code, _headers = read_with_http_info(npm_npm_repository_version_href, opts)
212
+ data
213
+ end
214
+
215
+ # Inspect a repository version
216
+ # A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
217
+ # @param npm_npm_repository_version_href [String]
218
+ # @param [Hash] opts the optional parameters
219
+ # @option opts [String] :fields A list of fields to include in the response.
220
+ # @option opts [String] :exclude_fields A list of fields to exclude from the response.
221
+ # @return [Array<(RepositoryVersionResponse, Integer, Hash)>] RepositoryVersionResponse data, response status code and response headers
222
+ def read_with_http_info(npm_npm_repository_version_href, opts = {})
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug 'Calling API: RepositoriesNpmVersionsApi.read ...'
225
+ end
226
+ # verify the required parameter 'npm_npm_repository_version_href' is set
227
+ if @api_client.config.client_side_validation && npm_npm_repository_version_href.nil?
228
+ fail ArgumentError, "Missing the required parameter 'npm_npm_repository_version_href' when calling RepositoriesNpmVersionsApi.read"
229
+ end
230
+ # resource path
231
+ local_var_path = '{npm_npm_repository_version_href}'.sub('{' + 'npm_npm_repository_version_href' + '}', CGI.escape(npm_npm_repository_version_href.to_s).gsub('%2F', '/'))
232
+
233
+ # query parameters
234
+ query_params = opts[:query_params] || {}
235
+ query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
236
+ query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
237
+
238
+ # header parameters
239
+ header_params = opts[:header_params] || {}
240
+ # HTTP header 'Accept' (if needed)
241
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
242
+
243
+ # form parameters
244
+ form_params = opts[:form_params] || {}
245
+
246
+ # http body (model)
247
+ post_body = opts[:body]
248
+
249
+ # return_type
250
+ return_type = opts[:return_type] || 'RepositoryVersionResponse'
251
+
252
+ # auth_names
253
+ auth_names = opts[:auth_names] || ['basicAuth']
254
+
255
+ new_options = opts.merge(
256
+ :header_params => header_params,
257
+ :query_params => query_params,
258
+ :form_params => form_params,
259
+ :body => post_body,
260
+ :auth_names => auth_names,
261
+ :return_type => return_type
262
+ )
263
+
264
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "API called: RepositoriesNpmVersionsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
267
+ end
268
+ return data, status_code, headers
269
+ end
270
+
271
+ # Trigger an asynchronous task to repair a repositroy version.
272
+ # @param npm_npm_repository_version_href [String]
273
+ # @param repository_version [RepositoryVersion]
274
+ # @param [Hash] opts the optional parameters
275
+ # @return [AsyncOperationResponse]
276
+ def repair(npm_npm_repository_version_href, repository_version, opts = {})
277
+ data, _status_code, _headers = repair_with_http_info(npm_npm_repository_version_href, repository_version, opts)
278
+ data
279
+ end
280
+
281
+ # Trigger an asynchronous task to repair a repositroy version.
282
+ # @param npm_npm_repository_version_href [String]
283
+ # @param repository_version [RepositoryVersion]
284
+ # @param [Hash] opts the optional parameters
285
+ # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
286
+ def repair_with_http_info(npm_npm_repository_version_href, repository_version, opts = {})
287
+ if @api_client.config.debugging
288
+ @api_client.config.logger.debug 'Calling API: RepositoriesNpmVersionsApi.repair ...'
289
+ end
290
+ # verify the required parameter 'npm_npm_repository_version_href' is set
291
+ if @api_client.config.client_side_validation && npm_npm_repository_version_href.nil?
292
+ fail ArgumentError, "Missing the required parameter 'npm_npm_repository_version_href' when calling RepositoriesNpmVersionsApi.repair"
293
+ end
294
+ # verify the required parameter 'repository_version' is set
295
+ if @api_client.config.client_side_validation && repository_version.nil?
296
+ fail ArgumentError, "Missing the required parameter 'repository_version' when calling RepositoriesNpmVersionsApi.repair"
297
+ end
298
+ # resource path
299
+ local_var_path = '{npm_npm_repository_version_href}repair/'.sub('{' + 'npm_npm_repository_version_href' + '}', CGI.escape(npm_npm_repository_version_href.to_s).gsub('%2F', '/'))
300
+
301
+ # query parameters
302
+ query_params = opts[:query_params] || {}
303
+
304
+ # header parameters
305
+ header_params = opts[:header_params] || {}
306
+ # HTTP header 'Accept' (if needed)
307
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
308
+ # HTTP header 'Content-Type'
309
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
310
+
311
+ # form parameters
312
+ form_params = opts[:form_params] || {}
313
+
314
+ # http body (model)
315
+ post_body = opts[:body] || @api_client.object_to_http_body(repository_version)
316
+
317
+ # return_type
318
+ return_type = opts[:return_type] || 'AsyncOperationResponse'
319
+
320
+ # auth_names
321
+ auth_names = opts[:auth_names] || ['basicAuth']
322
+
323
+ new_options = opts.merge(
324
+ :header_params => header_params,
325
+ :query_params => query_params,
326
+ :form_params => form_params,
327
+ :body => post_body,
328
+ :auth_names => auth_names,
329
+ :return_type => return_type
330
+ )
331
+
332
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
333
+ if @api_client.config.debugging
334
+ @api_client.config.logger.debug "API called: RepositoriesNpmVersionsApi#repair\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
335
+ end
336
+ return data, status_code, headers
337
+ end
338
+ end
339
+ end
@@ -0,0 +1,402 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #Fetch, Upload, Organize, and Distribute Software Packages
5
+
6
+ The version of the OpenAPI document: v3
7
+ Contact: pulp-list@redhat.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'faraday'
18
+
19
+ module PulpNpmClient
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
+ PulpNpmClient.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