Creizer-Meli 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +137 -0
  4. data/Rakefile +10 -0
  5. data/creizer-meli.gemspec +33 -0
  6. data/docs/Attributes.md +31 -0
  7. data/docs/AttributesValueStruct.md +19 -0
  8. data/docs/AttributesValues.md +21 -0
  9. data/docs/CategoriesApi.md +150 -0
  10. data/docs/InlineObject.md +27 -0
  11. data/docs/Item.md +41 -0
  12. data/docs/ItemPictures.md +17 -0
  13. data/docs/ItemsApi.md +152 -0
  14. data/docs/ItemsHealthApi.md +150 -0
  15. data/docs/OAuth20Api.md +117 -0
  16. data/docs/RestClientApi.md +204 -0
  17. data/docs/Variations.md +25 -0
  18. data/docs/VariationsAttributeCombinations.md +21 -0
  19. data/examples/get_token.rb +21 -0
  20. data/examples/restclient_post.rb +73 -0
  21. data/lib/meli.rb +52 -0
  22. data/lib/meli/api/categories_api.rb +216 -0
  23. data/lib/meli/api/items_api.rb +226 -0
  24. data/lib/meli/api/items_health_api.rb +216 -0
  25. data/lib/meli/api/o_auth20_api.rb +178 -0
  26. data/lib/meli/api/rest_client_api.rb +306 -0
  27. data/lib/meli/api_client.rb +387 -0
  28. data/lib/meli/api_error.rb +57 -0
  29. data/lib/meli/configuration.rb +297 -0
  30. data/lib/meli/models/attributes.rb +273 -0
  31. data/lib/meli/models/attributes_value_struct.rb +215 -0
  32. data/lib/meli/models/attributes_values.rb +226 -0
  33. data/lib/meli/models/inline_object.rb +251 -0
  34. data/lib/meli/models/item.rb +375 -0
  35. data/lib/meli/models/item_pictures.rb +206 -0
  36. data/lib/meli/models/variations.rb +246 -0
  37. data/lib/meli/models/variations_attribute_combinations.rb +224 -0
  38. data/lib/meli/version.rb +15 -0
  39. data/spec/api/categories_api_spec.rb +70 -0
  40. data/spec/api/items_api_spec.rb +71 -0
  41. data/spec/api/items_health_api_spec.rb +70 -0
  42. data/spec/api/o_auth20_api_spec.rb +65 -0
  43. data/spec/api/rest_client_api_spec.rb +85 -0
  44. data/spec/api_client_spec.rb +226 -0
  45. data/spec/configuration_spec.rb +42 -0
  46. data/spec/models/attributes_spec.rb +83 -0
  47. data/spec/models/attributes_value_struct_spec.rb +47 -0
  48. data/spec/models/attributes_values_spec.rb +53 -0
  49. data/spec/models/inline_object_spec.rb +71 -0
  50. data/spec/models/item_pictures_spec.rb +41 -0
  51. data/spec/models/item_spec.rb +113 -0
  52. data/spec/models/variations_attribute_combinations_spec.rb +53 -0
  53. data/spec/models/variations_spec.rb +65 -0
  54. data/spec/spec_helper.rb +111 -0
  55. metadata +173 -0
@@ -0,0 +1,306 @@
1
+ =begin
2
+ #MELI Markeplace SDK
3
+
4
+ #This is a the codebase to generate a SDK for Open Platform Marketplace
5
+
6
+ The version of the OpenAPI document: 3.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Meli
16
+ class RestClientApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Resource path DELETE
23
+ # @param resource [String]
24
+ # @param access_token [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [Object]
27
+ def resource_delete(resource, access_token, opts = {})
28
+ data, _status_code, _headers = resource_delete_with_http_info(resource, access_token, opts)
29
+ data
30
+ end
31
+
32
+ # Resource path DELETE
33
+ # @param resource [String]
34
+ # @param access_token [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
37
+ def resource_delete_with_http_info(resource, access_token, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: RestClientApi.resource_delete ...'
40
+ end
41
+ # verify the required parameter 'resource' is set
42
+ if @api_client.config.client_side_validation && resource.nil?
43
+ fail ArgumentError, "Missing the required parameter 'resource' when calling RestClientApi.resource_delete"
44
+ end
45
+ # verify the required parameter 'access_token' is set
46
+ if @api_client.config.client_side_validation && access_token.nil?
47
+ fail ArgumentError, "Missing the required parameter 'access_token' when calling RestClientApi.resource_delete"
48
+ end
49
+ # resource path
50
+ local_var_path = '/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+ query_params[:'access_token'] = access_token
55
+
56
+ # header parameters
57
+ header_params = opts[:header_params] || {}
58
+ # HTTP header 'Accept' (if needed)
59
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:body]
66
+
67
+ # return_type
68
+ return_type = opts[:return_type] || 'Object'
69
+
70
+ # auth_names
71
+ auth_names = opts[:auth_names] || []
72
+
73
+ new_options = opts.merge(
74
+ :header_params => header_params,
75
+ :query_params => query_params,
76
+ :form_params => form_params,
77
+ :body => post_body,
78
+ :auth_names => auth_names,
79
+ :return_type => return_type
80
+ )
81
+
82
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
83
+ if @api_client.config.debugging
84
+ @api_client.config.logger.debug "API called: RestClientApi#resource_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ end
86
+ return data, status_code, headers
87
+ end
88
+
89
+ # Resource path GET
90
+ # @param resource [String]
91
+ # @param access_token [String]
92
+ # @param [Hash] opts the optional parameters
93
+ # @return [Object]
94
+ def resource_get(resource, access_token, opts = {})
95
+ data, _status_code, _headers = resource_get_with_http_info(resource, access_token, opts)
96
+ data
97
+ end
98
+
99
+ # Resource path GET
100
+ # @param resource [String]
101
+ # @param access_token [String]
102
+ # @param [Hash] opts the optional parameters
103
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
104
+ def resource_get_with_http_info(resource, access_token, opts = {})
105
+ if @api_client.config.debugging
106
+ @api_client.config.logger.debug 'Calling API: RestClientApi.resource_get ...'
107
+ end
108
+ # verify the required parameter 'resource' is set
109
+ if @api_client.config.client_side_validation && resource.nil?
110
+ fail ArgumentError, "Missing the required parameter 'resource' when calling RestClientApi.resource_get"
111
+ end
112
+ # verify the required parameter 'access_token' is set
113
+ if @api_client.config.client_side_validation && access_token.nil?
114
+ fail ArgumentError, "Missing the required parameter 'access_token' when calling RestClientApi.resource_get"
115
+ end
116
+ # resource path
117
+ local_var_path = '/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
118
+
119
+ # query parameters
120
+ query_params = opts[:query_params] || {}
121
+ query_params[:'access_token'] = access_token
122
+
123
+ # header parameters
124
+ header_params = opts[:header_params] || {}
125
+ # HTTP header 'Accept' (if needed)
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = opts[:form_params] || {}
130
+
131
+ # http body (model)
132
+ post_body = opts[:body]
133
+
134
+ # return_type
135
+ return_type = opts[:return_type] || 'Object'
136
+
137
+ # auth_names
138
+ auth_names = opts[:auth_names] || []
139
+
140
+ new_options = opts.merge(
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: RestClientApi#resource_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Resourse path POST
157
+ # @param resource [String]
158
+ # @param access_token [String]
159
+ # @param body [Object]
160
+ # @param [Hash] opts the optional parameters
161
+ # @return [Object]
162
+ def resource_post(resource, access_token, body, opts = {})
163
+ data, _status_code, _headers = resource_post_with_http_info(resource, access_token, body, opts)
164
+ data
165
+ end
166
+
167
+ # Resourse path POST
168
+ # @param resource [String]
169
+ # @param access_token [String]
170
+ # @param body [Object]
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
173
+ def resource_post_with_http_info(resource, access_token, body, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug 'Calling API: RestClientApi.resource_post ...'
176
+ end
177
+ # verify the required parameter 'resource' is set
178
+ if @api_client.config.client_side_validation && resource.nil?
179
+ fail ArgumentError, "Missing the required parameter 'resource' when calling RestClientApi.resource_post"
180
+ end
181
+ # verify the required parameter 'access_token' is set
182
+ if @api_client.config.client_side_validation && access_token.nil?
183
+ fail ArgumentError, "Missing the required parameter 'access_token' when calling RestClientApi.resource_post"
184
+ end
185
+ # verify the required parameter 'body' is set
186
+ if @api_client.config.client_side_validation && body.nil?
187
+ fail ArgumentError, "Missing the required parameter 'body' when calling RestClientApi.resource_post"
188
+ end
189
+ # resource path
190
+ local_var_path = '/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
191
+
192
+ # query parameters
193
+ query_params = opts[:query_params] || {}
194
+ query_params[:'access_token'] = access_token
195
+
196
+ # header parameters
197
+ header_params = opts[:header_params] || {}
198
+ # HTTP header 'Accept' (if needed)
199
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
200
+ # HTTP header 'Content-Type'
201
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
202
+
203
+ # form parameters
204
+ form_params = opts[:form_params] || {}
205
+
206
+ # http body (model)
207
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
208
+
209
+ # return_type
210
+ return_type = opts[:return_type] || 'Object'
211
+
212
+ # auth_names
213
+ auth_names = opts[:auth_names] || []
214
+
215
+ new_options = opts.merge(
216
+ :header_params => header_params,
217
+ :query_params => query_params,
218
+ :form_params => form_params,
219
+ :body => post_body,
220
+ :auth_names => auth_names,
221
+ :return_type => return_type
222
+ )
223
+
224
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
225
+ if @api_client.config.debugging
226
+ @api_client.config.logger.debug "API called: RestClientApi#resource_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
227
+ end
228
+ return data, status_code, headers
229
+ end
230
+
231
+ # Resourse path PUT
232
+ # @param resource [String]
233
+ # @param access_token [String]
234
+ # @param body [Object]
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [Object]
237
+ def resource_put(resource, access_token, body, opts = {})
238
+ data, _status_code, _headers = resource_put_with_http_info(resource, access_token, body, opts)
239
+ data
240
+ end
241
+
242
+ # Resourse path PUT
243
+ # @param resource [String]
244
+ # @param access_token [String]
245
+ # @param body [Object]
246
+ # @param [Hash] opts the optional parameters
247
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
248
+ def resource_put_with_http_info(resource, access_token, body, opts = {})
249
+ if @api_client.config.debugging
250
+ @api_client.config.logger.debug 'Calling API: RestClientApi.resource_put ...'
251
+ end
252
+ # verify the required parameter 'resource' is set
253
+ if @api_client.config.client_side_validation && resource.nil?
254
+ fail ArgumentError, "Missing the required parameter 'resource' when calling RestClientApi.resource_put"
255
+ end
256
+ # verify the required parameter 'access_token' is set
257
+ if @api_client.config.client_side_validation && access_token.nil?
258
+ fail ArgumentError, "Missing the required parameter 'access_token' when calling RestClientApi.resource_put"
259
+ end
260
+ # verify the required parameter 'body' is set
261
+ if @api_client.config.client_side_validation && body.nil?
262
+ fail ArgumentError, "Missing the required parameter 'body' when calling RestClientApi.resource_put"
263
+ end
264
+ # resource path
265
+ local_var_path = '/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
266
+
267
+ # query parameters
268
+ query_params = opts[:query_params] || {}
269
+ query_params[:'access_token'] = access_token
270
+
271
+ # header parameters
272
+ header_params = opts[:header_params] || {}
273
+ # HTTP header 'Accept' (if needed)
274
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
275
+ # HTTP header 'Content-Type'
276
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
277
+
278
+ # form parameters
279
+ form_params = opts[:form_params] || {}
280
+
281
+ # http body (model)
282
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
283
+
284
+ # return_type
285
+ return_type = opts[:return_type] || 'Object'
286
+
287
+ # auth_names
288
+ auth_names = opts[:auth_names] || []
289
+
290
+ new_options = opts.merge(
291
+ :header_params => header_params,
292
+ :query_params => query_params,
293
+ :form_params => form_params,
294
+ :body => post_body,
295
+ :auth_names => auth_names,
296
+ :return_type => return_type
297
+ )
298
+
299
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
300
+ if @api_client.config.debugging
301
+ @api_client.config.logger.debug "API called: RestClientApi#resource_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
302
+ end
303
+ return data, status_code, headers
304
+ end
305
+ end
306
+ end
@@ -0,0 +1,387 @@
1
+ =begin
2
+ #MELI Markeplace SDK
3
+
4
+ #This is a the codebase to generate a SDK for Open Platform Marketplace
5
+
6
+ The version of the OpenAPI document: 3.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'typhoeus'
18
+
19
+ module Meli
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 = "MELI-RUBY-SDK-3.0.0"
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
+ request = build_request(http_method, path, opts)
50
+ response = request.run
51
+
52
+ if @config.debugging
53
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
54
+ end
55
+
56
+ unless response.success?
57
+ if response.timed_out?
58
+ fail ApiError.new('Connection timed out')
59
+ elsif response.code == 0
60
+ # Errors from libcurl will be made visible here
61
+ fail ApiError.new(:code => 0,
62
+ :message => response.return_message)
63
+ else
64
+ fail ApiError.new(:code => response.code,
65
+ :response_headers => response.headers,
66
+ :response_body => response.body),
67
+ response.status_message
68
+ end
69
+ end
70
+
71
+ if opts[:return_type]
72
+ data = deserialize(response, opts[:return_type])
73
+ else
74
+ data = nil
75
+ end
76
+ return data, response.code, response.headers
77
+ end
78
+
79
+ # Builds the HTTP request
80
+ #
81
+ # @param [String] http_method HTTP method/verb (e.g. POST)
82
+ # @param [String] path URL path (e.g. /account/new)
83
+ # @option opts [Hash] :header_params Header parameters
84
+ # @option opts [Hash] :query_params Query parameters
85
+ # @option opts [Hash] :form_params Query parameters
86
+ # @option opts [Object] :body HTTP body (JSON/XML)
87
+ # @return [Typhoeus::Request] A Typhoeus Request
88
+ def build_request(http_method, path, opts = {})
89
+ url = build_request_url(path)
90
+ http_method = http_method.to_sym.downcase
91
+
92
+ header_params = @default_headers.merge(opts[:header_params] || {})
93
+ query_params = opts[:query_params] || {}
94
+ form_params = opts[:form_params] || {}
95
+
96
+
97
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
98
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
99
+
100
+ req_opts = {
101
+ :method => http_method,
102
+ :headers => header_params,
103
+ :params => query_params,
104
+ :params_encoding => @config.params_encoding,
105
+ :timeout => @config.timeout,
106
+ :ssl_verifypeer => @config.verify_ssl,
107
+ :ssl_verifyhost => _verify_ssl_host,
108
+ :sslcert => @config.cert_file,
109
+ :sslkey => @config.key_file,
110
+ :verbose => @config.debugging
111
+ }
112
+
113
+ # set custom cert, if provided
114
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
115
+
116
+ if [:post, :patch, :put, :delete].include?(http_method)
117
+ req_body = build_request_body(header_params, form_params, opts[:body])
118
+ req_opts.update :body => req_body
119
+ if @config.debugging
120
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
121
+ end
122
+ end
123
+
124
+ request = Typhoeus::Request.new(url, req_opts)
125
+ download_file(request) if opts[:return_type] == 'File'
126
+ request
127
+ end
128
+
129
+ # Builds the HTTP request body
130
+ #
131
+ # @param [Hash] header_params Header parameters
132
+ # @param [Hash] form_params Query parameters
133
+ # @param [Object] body HTTP body (JSON/XML)
134
+ # @return [String] HTTP body data in the form of string
135
+ def build_request_body(header_params, form_params, body)
136
+ # http form
137
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
138
+ header_params['Content-Type'] == 'multipart/form-data'
139
+ data = {}
140
+ form_params.each do |key, value|
141
+ case value
142
+ when ::File, ::Array, nil
143
+ # let typhoeus handle File, Array and nil parameters
144
+ data[key] = value
145
+ else
146
+ data[key] = value.to_s
147
+ end
148
+ end
149
+ elsif body
150
+ data = body.is_a?(String) ? body : body.to_json
151
+ else
152
+ data = nil
153
+ end
154
+ data
155
+ end
156
+
157
+ # Check if the given MIME is a JSON MIME.
158
+ # JSON MIME examples:
159
+ # application/json
160
+ # application/json; charset=UTF8
161
+ # APPLICATION/JSON
162
+ # */*
163
+ # @param [String] mime MIME
164
+ # @return [Boolean] True if the MIME is application/json
165
+ def json_mime?(mime)
166
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
167
+ end
168
+
169
+ # Deserialize the response to the given return type.
170
+ #
171
+ # @param [Response] response HTTP response
172
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
173
+ def deserialize(response, return_type)
174
+ body = response.body
175
+
176
+ # handle file downloading - return the File instance processed in request callbacks
177
+ # note that response body is empty when the file is written in chunks in request on_body callback
178
+ return @tempfile if return_type == 'File'
179
+
180
+ return nil if body.nil? || body.empty?
181
+
182
+ # return response body directly for String return type
183
+ return body if return_type == 'String'
184
+
185
+ # ensuring a default content type
186
+ content_type = response.headers['Content-Type'] || 'application/json'
187
+
188
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
189
+
190
+ begin
191
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
192
+ rescue JSON::ParserError => e
193
+ if %w(String Date DateTime).include?(return_type)
194
+ data = body
195
+ else
196
+ raise e
197
+ end
198
+ end
199
+
200
+ convert_to_type data, return_type
201
+ end
202
+
203
+ # Convert data to the given return type.
204
+ # @param [Object] data Data to be converted
205
+ # @param [String] return_type Return type
206
+ # @return [Mixed] Data in a particular type
207
+ def convert_to_type(data, return_type)
208
+ return nil if data.nil?
209
+ case return_type
210
+ when 'String'
211
+ data.to_s
212
+ when 'Integer'
213
+ data.to_i
214
+ when 'Float'
215
+ data.to_f
216
+ when 'Boolean'
217
+ data == true
218
+ when 'DateTime'
219
+ # parse date time (expecting ISO 8601 format)
220
+ DateTime.parse data
221
+ when 'Date'
222
+ # parse date time (expecting ISO 8601 format)
223
+ Date.parse data
224
+ when 'Object'
225
+ # generic object (usually a Hash), return directly
226
+ data
227
+ when /\AArray<(.+)>\z/
228
+ # e.g. Array<Pet>
229
+ sub_type = $1
230
+ data.map { |item| convert_to_type(item, sub_type) }
231
+ when /\AHash\<String, (.+)\>\z/
232
+ # e.g. Hash<String, Integer>
233
+ sub_type = $1
234
+ {}.tap do |hash|
235
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
236
+ end
237
+ else
238
+ # models, e.g. Pet
239
+ Meli.const_get(return_type).build_from_hash(data)
240
+ end
241
+ end
242
+
243
+ # Save response body into a file in (the defined) temporary folder, using the filename
244
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
245
+ # The response body is written to the file in chunks in order to handle files which
246
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
247
+ # process can use.
248
+ #
249
+ # @see Configuration#temp_folder_path
250
+ def download_file(request)
251
+ tempfile = nil
252
+ encoding = nil
253
+ request.on_headers do |response|
254
+ content_disposition = response.headers['Content-Disposition']
255
+ if content_disposition && content_disposition =~ /filename=/i
256
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
257
+ prefix = sanitize_filename(filename)
258
+ else
259
+ prefix = 'download-'
260
+ end
261
+ prefix = prefix + '-' unless prefix.end_with?('-')
262
+ encoding = response.body.encoding
263
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
264
+ @tempfile = tempfile
265
+ end
266
+ request.on_body do |chunk|
267
+ chunk.force_encoding(encoding)
268
+ tempfile.write(chunk)
269
+ end
270
+ request.on_complete do |response|
271
+ if tempfile
272
+ tempfile.close
273
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
274
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
275
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
276
+ "explicitly with `tempfile.delete`"
277
+ end
278
+ end
279
+ end
280
+
281
+ # Sanitize filename by removing path.
282
+ # e.g. ../../sun.gif becomes sun.gif
283
+ #
284
+ # @param [String] filename the filename to be sanitized
285
+ # @return [String] the sanitized filename
286
+ def sanitize_filename(filename)
287
+ filename.gsub(/.*[\/\\]/, '')
288
+ end
289
+
290
+ def build_request_url(path)
291
+ # Add leading and trailing slashes to path
292
+ path = "/#{path}".gsub(/\/+/, '/')
293
+ @config.base_url + path
294
+ end
295
+
296
+ # Update hearder and query params based on authentication settings.
297
+ #
298
+ # @param [Hash] header_params Header parameters
299
+ # @param [Hash] query_params Query parameters
300
+ # @param [String] auth_names Authentication scheme name
301
+ def update_params_for_auth!(header_params, query_params, auth_names)
302
+ Array(auth_names).each do |auth_name|
303
+ auth_setting = @config.auth_settings[auth_name]
304
+ next unless auth_setting
305
+ case auth_setting[:in]
306
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
307
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
308
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
309
+ end
310
+ end
311
+ end
312
+
313
+ # Sets user agent in HTTP header
314
+ #
315
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
316
+ def user_agent=(user_agent)
317
+ @user_agent = user_agent
318
+ @default_headers['User-Agent'] = @user_agent
319
+ end
320
+
321
+ # Return Accept header based on an array of accepts provided.
322
+ # @param [Array] accepts array for Accept
323
+ # @return [String] the Accept header (e.g. application/json)
324
+ def select_header_accept(accepts)
325
+ return nil if accepts.nil? || accepts.empty?
326
+ # use JSON when present, otherwise use all of the provided
327
+ json_accept = accepts.find { |s| json_mime?(s) }
328
+ json_accept || accepts.join(',')
329
+ end
330
+
331
+ # Return Content-Type header based on an array of content types provided.
332
+ # @param [Array] content_types array for Content-Type
333
+ # @return [String] the Content-Type header (e.g. application/json)
334
+ def select_header_content_type(content_types)
335
+ # use application/json by default
336
+ return 'application/json' if content_types.nil? || content_types.empty?
337
+ # use JSON when present, otherwise use the first one
338
+ json_content_type = content_types.find { |s| json_mime?(s) }
339
+ json_content_type || content_types.first
340
+ end
341
+
342
+ # Convert object (array, hash, object, etc) to JSON string.
343
+ # @param [Object] model object to be converted into JSON string
344
+ # @return [String] JSON string representation of the object
345
+ def object_to_http_body(model)
346
+ return model if model.nil? || model.is_a?(String)
347
+ local_body = nil
348
+ if model.is_a?(Array)
349
+ local_body = model.map { |m| object_to_hash(m) }
350
+ else
351
+ local_body = object_to_hash(model)
352
+ end
353
+ local_body.to_json
354
+ end
355
+
356
+ # Convert object(non-array) to hash.
357
+ # @param [Object] obj object to be converted into JSON string
358
+ # @return [String] JSON string representation of the object
359
+ def object_to_hash(obj)
360
+ if obj.respond_to?(:to_hash)
361
+ obj.to_hash
362
+ else
363
+ obj
364
+ end
365
+ end
366
+
367
+ # Build parameter value according to the given collection format.
368
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
369
+ def build_collection_param(param, collection_format)
370
+ case collection_format
371
+ when :csv
372
+ param.join(',')
373
+ when :ssv
374
+ param.join(' ')
375
+ when :tsv
376
+ param.join("\t")
377
+ when :pipes
378
+ param.join('|')
379
+ when :multi
380
+ # return the array directly as typhoeus will handle it as expected
381
+ param
382
+ else
383
+ fail "unknown collection format: #{collection_format.inspect}"
384
+ end
385
+ end
386
+ end
387
+ end