reference_service 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +79 -0
  4. data/README.md +126 -0
  5. data/Rakefile +10 -0
  6. data/docs/ActiveSubscription.md +27 -0
  7. data/docs/Error.md +17 -0
  8. data/docs/ErrorErrors.md +17 -0
  9. data/docs/ErrorErrorsError.md +25 -0
  10. data/docs/ReportsApi.md +168 -0
  11. data/docs/Sector.md +19 -0
  12. data/docs/SectorApi.md +100 -0
  13. data/docs/SectorSpending.md +23 -0
  14. data/docs/SpendingReport.md +23 -0
  15. data/docs/SubscribeApi.md +244 -0
  16. data/docs/Subscription.md +17 -0
  17. data/docs/SubscriptionObject.md +27 -0
  18. data/docs/SubscriptionPaymentCard.md +21 -0
  19. data/docs/SubscriptionResponse.md +19 -0
  20. data/docs/TopLocationsReport.md +17 -0
  21. data/docs/UnsubscribedResponse.md +19 -0
  22. data/git_push.sh +55 -0
  23. data/lib/openapi_client.rb +55 -0
  24. data/lib/openapi_client/api/reports_api.rb +252 -0
  25. data/lib/openapi_client/api/sector_api.rb +151 -0
  26. data/lib/openapi_client/api/subscribe_api.rb +334 -0
  27. data/lib/openapi_client/api_client.rb +386 -0
  28. data/lib/openapi_client/api_error.rb +57 -0
  29. data/lib/openapi_client/configuration.rb +244 -0
  30. data/lib/openapi_client/models/active_subscription.rb +262 -0
  31. data/lib/openapi_client/models/error.rb +201 -0
  32. data/lib/openapi_client/models/error_errors.rb +203 -0
  33. data/lib/openapi_client/models/error_errors_error.rb +232 -0
  34. data/lib/openapi_client/models/sector.rb +216 -0
  35. data/lib/openapi_client/models/sector_spending.rb +244 -0
  36. data/lib/openapi_client/models/spending_report.rb +235 -0
  37. data/lib/openapi_client/models/subscription.rb +197 -0
  38. data/lib/openapi_client/models/subscription_object.rb +247 -0
  39. data/lib/openapi_client/models/subscription_payment_card.rb +254 -0
  40. data/lib/openapi_client/models/subscription_response.rb +206 -0
  41. data/lib/openapi_client/models/top_locations_report.rb +200 -0
  42. data/lib/openapi_client/models/unsubscribed_response.rb +207 -0
  43. data/lib/openapi_client/version.rb +15 -0
  44. data/openapi_client.gemspec +38 -0
  45. data/spec/api/reports_api_spec.rb +77 -0
  46. data/spec/api/sector_api_spec.rb +58 -0
  47. data/spec/api/subscribe_api_spec.rb +92 -0
  48. data/spec/api_client_spec.rb +226 -0
  49. data/spec/configuration_spec.rb +42 -0
  50. data/spec/models/active_subscription_spec.rb +71 -0
  51. data/spec/models/error_errors_error_spec.rb +65 -0
  52. data/spec/models/error_errors_spec.rb +41 -0
  53. data/spec/models/error_spec.rb +41 -0
  54. data/spec/models/sector_spec.rb +47 -0
  55. data/spec/models/sector_spending_spec.rb +59 -0
  56. data/spec/models/spending_report_spec.rb +59 -0
  57. data/spec/models/subscription_object_spec.rb +71 -0
  58. data/spec/models/subscription_payment_card_spec.rb +53 -0
  59. data/spec/models/subscription_response_spec.rb +47 -0
  60. data/spec/models/subscription_spec.rb +41 -0
  61. data/spec/models/top_locations_report_spec.rb +41 -0
  62. data/spec/models/unsubscribed_response_spec.rb +47 -0
  63. data/spec/spec_helper.rb +111 -0
  64. metadata +199 -0
@@ -0,0 +1,334 @@
1
+ =begin
2
+ #Golden Service API
3
+
4
+ #An API that conforms to the standards and best practices that should be adhered to in all Mastercard owned APIs. Can be used to create subscriptions to reports that are generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations. <br/> --- * **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/** --- * **The user must provide their card details when creating a subscription. These details must be encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)** ---
5
+
6
+ The version of the OpenAPI document: 1.1.0
7
+ Contact: developers@mastercard.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module OpenapiClient
16
+ class SubscribeApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Gets a specific subscription using a subscription Id passed as in the path
23
+ # @param subscription_id [String] Unique identifier of a particular subscription (UUID Version 4)
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [SubscriptionResponse]
26
+ def get_subscription(subscription_id, opts = {})
27
+ data, _status_code, _headers = get_subscription_with_http_info(subscription_id, opts)
28
+ data
29
+ end
30
+
31
+ # Gets a specific subscription using a subscription Id passed as in the path
32
+ # @param subscription_id [String] Unique identifier of a particular subscription (UUID Version 4)
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(SubscriptionResponse, Integer, Hash)>] SubscriptionResponse data, response status code and response headers
35
+ def get_subscription_with_http_info(subscription_id, opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: SubscribeApi.get_subscription ...'
38
+ end
39
+ # verify the required parameter 'subscription_id' is set
40
+ if @api_client.config.client_side_validation && subscription_id.nil?
41
+ fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscribeApi.get_subscription"
42
+ end
43
+ # resource path
44
+ local_var_path = '/subscriptions/{subscription_id}'.sub('{' + 'subscription_id' + '}', subscription_id.to_s)
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+
49
+ # header parameters
50
+ header_params = opts[:header_params] || {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:body]
59
+
60
+ # return_type
61
+ return_type = opts[:return_type] || 'SubscriptionResponse'
62
+
63
+ # auth_names
64
+ auth_names = opts[:auth_names] || []
65
+
66
+ new_options = opts.merge(
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => return_type
73
+ )
74
+
75
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: SubscribeApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+
82
+ # gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
83
+ # @param [Hash] opts the optional parameters
84
+ # @option opts [Integer] :limit Can be used to limit the amount of results returned from a query (Pagination)
85
+ # @option opts [Integer] :offset The number of items to offset the start of the list from (Pagination)
86
+ # @return [Array<ActiveSubscription>]
87
+ def list_subscriptions(opts = {})
88
+ data, _status_code, _headers = list_subscriptions_with_http_info(opts)
89
+ data
90
+ end
91
+
92
+ # gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
93
+ # @param [Hash] opts the optional parameters
94
+ # @option opts [Integer] :limit Can be used to limit the amount of results returned from a query (Pagination)
95
+ # @option opts [Integer] :offset The number of items to offset the start of the list from (Pagination)
96
+ # @return [Array<(Array<ActiveSubscription>, Integer, Hash)>] Array<ActiveSubscription> data, response status code and response headers
97
+ def list_subscriptions_with_http_info(opts = {})
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug 'Calling API: SubscribeApi.list_subscriptions ...'
100
+ end
101
+ # resource path
102
+ local_var_path = '/subscriptions'
103
+
104
+ # query parameters
105
+ query_params = opts[:query_params] || {}
106
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
107
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
108
+
109
+ # header parameters
110
+ header_params = opts[:header_params] || {}
111
+ # HTTP header 'Accept' (if needed)
112
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
113
+
114
+ # form parameters
115
+ form_params = opts[:form_params] || {}
116
+
117
+ # http body (model)
118
+ post_body = opts[:body]
119
+
120
+ # return_type
121
+ return_type = opts[:return_type] || 'Array<ActiveSubscription>'
122
+
123
+ # auth_names
124
+ auth_names = opts[:auth_names] || []
125
+
126
+ new_options = opts.merge(
127
+ :header_params => header_params,
128
+ :query_params => query_params,
129
+ :form_params => form_params,
130
+ :body => post_body,
131
+ :auth_names => auth_names,
132
+ :return_type => return_type
133
+ )
134
+
135
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
136
+ if @api_client.config.debugging
137
+ @api_client.config.logger.debug "API called: SubscribeApi#list_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
138
+ end
139
+ return data, status_code, headers
140
+ end
141
+
142
+ # Allows the user to subscribe to a particular location and receive updates on e-commerce spending in their chosen area. The user can pay for the subscription on a daily basis. The user is charged for every report they receive until their subscription is cancelled
143
+ # @param request_body [Hash<String, SubscriptionObject>] Request body required to create a particular subscription
144
+ # @param [Hash] opts the optional parameters
145
+ # @return [Array<SubscriptionResponse>]
146
+ def subscribe(request_body, opts = {})
147
+ data, _status_code, _headers = subscribe_with_http_info(request_body, opts)
148
+ data
149
+ end
150
+
151
+ # Allows the user to subscribe to a particular location and receive updates on e-commerce spending in their chosen area. The user can pay for the subscription on a daily basis. The user is charged for every report they receive until their subscription is cancelled
152
+ # @param request_body [Hash<String, SubscriptionObject>] Request body required to create a particular subscription
153
+ # @param [Hash] opts the optional parameters
154
+ # @return [Array<(Array<SubscriptionResponse>, Integer, Hash)>] Array<SubscriptionResponse> data, response status code and response headers
155
+ def subscribe_with_http_info(request_body, opts = {})
156
+ if @api_client.config.debugging
157
+ @api_client.config.logger.debug 'Calling API: SubscribeApi.subscribe ...'
158
+ end
159
+ # verify the required parameter 'request_body' is set
160
+ if @api_client.config.client_side_validation && request_body.nil?
161
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling SubscribeApi.subscribe"
162
+ end
163
+ # resource path
164
+ local_var_path = '/subscriptions'
165
+
166
+ # query parameters
167
+ query_params = opts[:query_params] || {}
168
+
169
+ # header parameters
170
+ header_params = opts[:header_params] || {}
171
+ # HTTP header 'Accept' (if needed)
172
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
173
+ # HTTP header 'Content-Type'
174
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
175
+
176
+ # form parameters
177
+ form_params = opts[:form_params] || {}
178
+
179
+ # http body (model)
180
+ post_body = opts[:body] || @api_client.object_to_http_body(request_body)
181
+
182
+ # return_type
183
+ return_type = opts[:return_type] || 'Array<SubscriptionResponse>'
184
+
185
+ # auth_names
186
+ auth_names = opts[:auth_names] || []
187
+
188
+ new_options = opts.merge(
189
+ :header_params => header_params,
190
+ :query_params => query_params,
191
+ :form_params => form_params,
192
+ :body => post_body,
193
+ :auth_names => auth_names,
194
+ :return_type => return_type
195
+ )
196
+
197
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
198
+ if @api_client.config.debugging
199
+ @api_client.config.logger.debug "API called: SubscribeApi#subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
200
+ end
201
+ return data, status_code, headers
202
+ end
203
+
204
+ # Un-subscribes from a specified subcription
205
+ # @param subscription_id [String] Unique identifier of a particular subscription (Version 4 UUID)
206
+ # @param [Hash] opts the optional parameters
207
+ # @return [UnsubscribedResponse]
208
+ def unsubscribe(subscription_id, opts = {})
209
+ data, _status_code, _headers = unsubscribe_with_http_info(subscription_id, opts)
210
+ data
211
+ end
212
+
213
+ # Un-subscribes from a specified subcription
214
+ # @param subscription_id [String] Unique identifier of a particular subscription (Version 4 UUID)
215
+ # @param [Hash] opts the optional parameters
216
+ # @return [Array<(UnsubscribedResponse, Integer, Hash)>] UnsubscribedResponse data, response status code and response headers
217
+ def unsubscribe_with_http_info(subscription_id, opts = {})
218
+ if @api_client.config.debugging
219
+ @api_client.config.logger.debug 'Calling API: SubscribeApi.unsubscribe ...'
220
+ end
221
+ # verify the required parameter 'subscription_id' is set
222
+ if @api_client.config.client_side_validation && subscription_id.nil?
223
+ fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscribeApi.unsubscribe"
224
+ end
225
+ # resource path
226
+ local_var_path = '/subscriptions'
227
+
228
+ # query parameters
229
+ query_params = opts[:query_params] || {}
230
+ query_params[:'subscription_id'] = subscription_id
231
+
232
+ # header parameters
233
+ header_params = opts[:header_params] || {}
234
+ # HTTP header 'Accept' (if needed)
235
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
236
+
237
+ # form parameters
238
+ form_params = opts[:form_params] || {}
239
+
240
+ # http body (model)
241
+ post_body = opts[:body]
242
+
243
+ # return_type
244
+ return_type = opts[:return_type] || 'UnsubscribedResponse'
245
+
246
+ # auth_names
247
+ auth_names = opts[:auth_names] || []
248
+
249
+ new_options = opts.merge(
250
+ :header_params => header_params,
251
+ :query_params => query_params,
252
+ :form_params => form_params,
253
+ :body => post_body,
254
+ :auth_names => auth_names,
255
+ :return_type => return_type
256
+ )
257
+
258
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
259
+ if @api_client.config.debugging
260
+ @api_client.config.logger.debug "API called: SubscribeApi#unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
261
+ end
262
+ return data, status_code, headers
263
+ end
264
+
265
+ # Updates an active subscription
266
+ # @param subscription_id [String] Unique identifier of a particular subscription (UUID Version 4)
267
+ # @param subscription_object [SubscriptionObject] Request body required to update a particular subscription
268
+ # @param [Hash] opts the optional parameters
269
+ # @return [SubscriptionResponse]
270
+ def update_subscription(subscription_id, subscription_object, opts = {})
271
+ data, _status_code, _headers = update_subscription_with_http_info(subscription_id, subscription_object, opts)
272
+ data
273
+ end
274
+
275
+ # Updates an active subscription
276
+ # @param subscription_id [String] Unique identifier of a particular subscription (UUID Version 4)
277
+ # @param subscription_object [SubscriptionObject] Request body required to update a particular subscription
278
+ # @param [Hash] opts the optional parameters
279
+ # @return [Array<(SubscriptionResponse, Integer, Hash)>] SubscriptionResponse data, response status code and response headers
280
+ def update_subscription_with_http_info(subscription_id, subscription_object, opts = {})
281
+ if @api_client.config.debugging
282
+ @api_client.config.logger.debug 'Calling API: SubscribeApi.update_subscription ...'
283
+ end
284
+ # verify the required parameter 'subscription_id' is set
285
+ if @api_client.config.client_side_validation && subscription_id.nil?
286
+ fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscribeApi.update_subscription"
287
+ end
288
+ # verify the required parameter 'subscription_object' is set
289
+ if @api_client.config.client_side_validation && subscription_object.nil?
290
+ fail ArgumentError, "Missing the required parameter 'subscription_object' when calling SubscribeApi.update_subscription"
291
+ end
292
+ # resource path
293
+ local_var_path = '/subscriptions'
294
+
295
+ # query parameters
296
+ query_params = opts[:query_params] || {}
297
+ query_params[:'subscription_id'] = subscription_id
298
+
299
+ # header parameters
300
+ header_params = opts[:header_params] || {}
301
+ # HTTP header 'Accept' (if needed)
302
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
303
+ # HTTP header 'Content-Type'
304
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
305
+
306
+ # form parameters
307
+ form_params = opts[:form_params] || {}
308
+
309
+ # http body (model)
310
+ post_body = opts[:body] || @api_client.object_to_http_body(subscription_object)
311
+
312
+ # return_type
313
+ return_type = opts[:return_type] || 'SubscriptionResponse'
314
+
315
+ # auth_names
316
+ auth_names = opts[:auth_names] || []
317
+
318
+ new_options = opts.merge(
319
+ :header_params => header_params,
320
+ :query_params => query_params,
321
+ :form_params => form_params,
322
+ :body => post_body,
323
+ :auth_names => auth_names,
324
+ :return_type => return_type
325
+ )
326
+
327
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
328
+ if @api_client.config.debugging
329
+ @api_client.config.logger.debug "API called: SubscribeApi#update_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
330
+ end
331
+ return data, status_code, headers
332
+ end
333
+ end
334
+ end
@@ -0,0 +1,386 @@
1
+ =begin
2
+ #Golden Service API
3
+
4
+ #An API that conforms to the standards and best practices that should be adhered to in all Mastercard owned APIs. Can be used to create subscriptions to reports that are generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations. <br/> --- * **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/** --- * **The user must provide their card details when creating a subscription. These details must be encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)** ---
5
+
6
+ The version of the OpenAPI document: 1.1.0
7
+ Contact: developers@mastercard.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'typhoeus'
18
+ require 'uri'
19
+
20
+ module OpenapiClient
21
+ class ApiClient
22
+ # The Configuration object holding settings to be used in the API client.
23
+ attr_accessor :config
24
+
25
+ # Defines the headers to be used in HTTP requests of all API calls by default.
26
+ #
27
+ # @return [Hash]
28
+ attr_accessor :default_headers
29
+
30
+ # Initializes the ApiClient
31
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
+ def initialize(config = Configuration.default)
33
+ @config = config
34
+ @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
35
+ @default_headers = {
36
+ 'Content-Type' => 'application/json',
37
+ 'User-Agent' => @user_agent
38
+ }
39
+ end
40
+
41
+ def self.default
42
+ @@default ||= ApiClient.new
43
+ end
44
+
45
+ # Call an API with given options.
46
+ #
47
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
48
+ # the data deserialized from response body (could be nil), response status code and response headers.
49
+ def call_api(http_method, path, opts = {})
50
+ request = build_request(http_method, path, opts)
51
+ response = request.run
52
+
53
+ if @config.debugging
54
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
+ end
56
+
57
+ unless response.success?
58
+ if response.timed_out?
59
+ fail ApiError.new('Connection timed out')
60
+ elsif response.code == 0
61
+ # Errors from libcurl will be made visible here
62
+ fail ApiError.new(:code => 0,
63
+ :message => response.return_message)
64
+ else
65
+ fail ApiError.new(:code => response.code,
66
+ :response_headers => response.headers,
67
+ :response_body => response.body),
68
+ response.status_message
69
+ end
70
+ end
71
+
72
+ if opts[:return_type]
73
+ data = deserialize(response, opts[:return_type])
74
+ else
75
+ data = nil
76
+ end
77
+ return data, response.code, response.headers
78
+ end
79
+
80
+ # Builds the HTTP request
81
+ #
82
+ # @param [String] http_method HTTP method/verb (e.g. POST)
83
+ # @param [String] path URL path (e.g. /account/new)
84
+ # @option opts [Hash] :header_params Header parameters
85
+ # @option opts [Hash] :query_params Query parameters
86
+ # @option opts [Hash] :form_params Query parameters
87
+ # @option opts [Object] :body HTTP body (JSON/XML)
88
+ # @return [Typhoeus::Request] A Typhoeus Request
89
+ def build_request(http_method, path, opts = {})
90
+ url = build_request_url(path)
91
+ http_method = http_method.to_sym.downcase
92
+
93
+ header_params = @default_headers.merge(opts[:header_params] || {})
94
+ query_params = opts[:query_params] || {}
95
+ form_params = opts[:form_params] || {}
96
+
97
+
98
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
99
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
100
+
101
+ req_opts = {
102
+ :method => http_method,
103
+ :headers => header_params,
104
+ :params => query_params,
105
+ :params_encoding => @config.params_encoding,
106
+ :timeout => @config.timeout,
107
+ :ssl_verifypeer => @config.verify_ssl,
108
+ :ssl_verifyhost => _verify_ssl_host,
109
+ :sslcert => @config.cert_file,
110
+ :sslkey => @config.key_file,
111
+ :verbose => @config.debugging
112
+ }
113
+
114
+ # set custom cert, if provided
115
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
116
+
117
+ if [:post, :patch, :put, :delete].include?(http_method)
118
+ req_body = build_request_body(header_params, form_params, opts[:body])
119
+ req_opts.update :body => req_body
120
+ if @config.debugging
121
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
122
+ end
123
+ end
124
+
125
+ request = Typhoeus::Request.new(url, req_opts)
126
+ download_file(request) if opts[:return_type] == 'File'
127
+ request
128
+ end
129
+
130
+ # Check if the given MIME is a JSON MIME.
131
+ # JSON MIME examples:
132
+ # application/json
133
+ # application/json; charset=UTF8
134
+ # APPLICATION/JSON
135
+ # */*
136
+ # @param [String] mime MIME
137
+ # @return [Boolean] True if the MIME is application/json
138
+ def json_mime?(mime)
139
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
140
+ end
141
+
142
+ # Deserialize the response to the given return type.
143
+ #
144
+ # @param [Response] response HTTP response
145
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
146
+ def deserialize(response, return_type)
147
+ body = response.body
148
+
149
+ # handle file downloading - return the File instance processed in request callbacks
150
+ # note that response body is empty when the file is written in chunks in request on_body callback
151
+ return @tempfile if return_type == 'File'
152
+
153
+ return nil if body.nil? || body.empty?
154
+
155
+ # return response body directly for String return type
156
+ return body if return_type == 'String'
157
+
158
+ # ensuring a default content type
159
+ content_type = response.headers['Content-Type'] || 'application/json'
160
+
161
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
162
+
163
+ begin
164
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
165
+ rescue JSON::ParserError => e
166
+ if %w(String Date DateTime).include?(return_type)
167
+ data = body
168
+ else
169
+ raise e
170
+ end
171
+ end
172
+
173
+ convert_to_type data, return_type
174
+ end
175
+
176
+ # Convert data to the given return type.
177
+ # @param [Object] data Data to be converted
178
+ # @param [String] return_type Return type
179
+ # @return [Mixed] Data in a particular type
180
+ def convert_to_type(data, return_type)
181
+ return nil if data.nil?
182
+ case return_type
183
+ when 'String'
184
+ data.to_s
185
+ when 'Integer'
186
+ data.to_i
187
+ when 'Float'
188
+ data.to_f
189
+ when 'Boolean'
190
+ data == true
191
+ when 'DateTime'
192
+ # parse date time (expecting ISO 8601 format)
193
+ DateTime.parse data
194
+ when 'Date'
195
+ # parse date time (expecting ISO 8601 format)
196
+ Date.parse data
197
+ when 'Object'
198
+ # generic object (usually a Hash), return directly
199
+ data
200
+ when /\AArray<(.+)>\z/
201
+ # e.g. Array<Pet>
202
+ sub_type = $1
203
+ data.map { |item| convert_to_type(item, sub_type) }
204
+ when /\AHash\<String, (.+)\>\z/
205
+ # e.g. Hash<String, Integer>
206
+ sub_type = $1
207
+ {}.tap do |hash|
208
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
209
+ end
210
+ else
211
+ # models, e.g. Pet
212
+ OpenapiClient.const_get(return_type).build_from_hash(data)
213
+ end
214
+ end
215
+
216
+ # Save response body into a file in (the defined) temporary folder, using the filename
217
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
218
+ # The response body is written to the file in chunks in order to handle files which
219
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
220
+ # process can use.
221
+ #
222
+ # @see Configuration#temp_folder_path
223
+ def download_file(request)
224
+ tempfile = nil
225
+ encoding = nil
226
+ request.on_headers do |response|
227
+ content_disposition = response.headers['Content-Disposition']
228
+ if content_disposition && content_disposition =~ /filename=/i
229
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
230
+ prefix = sanitize_filename(filename)
231
+ else
232
+ prefix = 'download-'
233
+ end
234
+ prefix = prefix + '-' unless prefix.end_with?('-')
235
+ encoding = response.body.encoding
236
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
237
+ @tempfile = tempfile
238
+ end
239
+ request.on_body do |chunk|
240
+ chunk.force_encoding(encoding)
241
+ tempfile.write(chunk)
242
+ end
243
+ request.on_complete do |response|
244
+ tempfile.close if tempfile
245
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
246
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
247
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
248
+ "explicitly with `tempfile.delete`"
249
+ end
250
+ end
251
+
252
+ # Sanitize filename by removing path.
253
+ # e.g. ../../sun.gif becomes sun.gif
254
+ #
255
+ # @param [String] filename the filename to be sanitized
256
+ # @return [String] the sanitized filename
257
+ def sanitize_filename(filename)
258
+ filename.gsub(/.*[\/\\]/, '')
259
+ end
260
+
261
+ def build_request_url(path)
262
+ # Add leading and trailing slashes to path
263
+ path = "/#{path}".gsub(/\/+/, '/')
264
+ URI.encode(@config.base_url + path)
265
+ end
266
+
267
+ # Builds the HTTP request body
268
+ #
269
+ # @param [Hash] header_params Header parameters
270
+ # @param [Hash] form_params Query parameters
271
+ # @param [Object] body HTTP body (JSON/XML)
272
+ # @return [String] HTTP body data in the form of string
273
+ def build_request_body(header_params, form_params, body)
274
+ # http form
275
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
276
+ header_params['Content-Type'] == 'multipart/form-data'
277
+ data = {}
278
+ form_params.each do |key, value|
279
+ case value
280
+ when ::File, ::Array, nil
281
+ # let typhoeus handle File, Array and nil parameters
282
+ data[key] = value
283
+ else
284
+ data[key] = value.to_s
285
+ end
286
+ end
287
+ elsif body
288
+ data = body.is_a?(String) ? body : body.to_json
289
+ else
290
+ data = nil
291
+ end
292
+ data
293
+ end
294
+
295
+ # Update hearder and query params based on authentication settings.
296
+ #
297
+ # @param [Hash] header_params Header parameters
298
+ # @param [Hash] query_params Query parameters
299
+ # @param [String] auth_names Authentication scheme name
300
+ def update_params_for_auth!(header_params, query_params, auth_names)
301
+ Array(auth_names).each do |auth_name|
302
+ auth_setting = @config.auth_settings[auth_name]
303
+ next unless auth_setting
304
+ case auth_setting[:in]
305
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
306
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
307
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
308
+ end
309
+ end
310
+ end
311
+
312
+ # Sets user agent in HTTP header
313
+ #
314
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
315
+ def user_agent=(user_agent)
316
+ @user_agent = user_agent
317
+ @default_headers['User-Agent'] = @user_agent
318
+ end
319
+
320
+ # Return Accept header based on an array of accepts provided.
321
+ # @param [Array] accepts array for Accept
322
+ # @return [String] the Accept header (e.g. application/json)
323
+ def select_header_accept(accepts)
324
+ return nil if accepts.nil? || accepts.empty?
325
+ # use JSON when present, otherwise use all of the provided
326
+ json_accept = accepts.find { |s| json_mime?(s) }
327
+ json_accept || accepts.join(',')
328
+ end
329
+
330
+ # Return Content-Type header based on an array of content types provided.
331
+ # @param [Array] content_types array for Content-Type
332
+ # @return [String] the Content-Type header (e.g. application/json)
333
+ def select_header_content_type(content_types)
334
+ # use application/json by default
335
+ return 'application/json' if content_types.nil? || content_types.empty?
336
+ # use JSON when present, otherwise use the first one
337
+ json_content_type = content_types.find { |s| json_mime?(s) }
338
+ json_content_type || content_types.first
339
+ end
340
+
341
+ # Convert object (array, hash, object, etc) to JSON string.
342
+ # @param [Object] model object to be converted into JSON string
343
+ # @return [String] JSON string representation of the object
344
+ def object_to_http_body(model)
345
+ return model if model.nil? || model.is_a?(String)
346
+ local_body = nil
347
+ if model.is_a?(Array)
348
+ local_body = model.map { |m| object_to_hash(m) }
349
+ else
350
+ local_body = object_to_hash(model)
351
+ end
352
+ local_body.to_json
353
+ end
354
+
355
+ # Convert object(non-array) to hash.
356
+ # @param [Object] obj object to be converted into JSON string
357
+ # @return [String] JSON string representation of the object
358
+ def object_to_hash(obj)
359
+ if obj.respond_to?(:to_hash)
360
+ obj.to_hash
361
+ else
362
+ obj
363
+ end
364
+ end
365
+
366
+ # Build parameter value according to the given collection format.
367
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
368
+ def build_collection_param(param, collection_format)
369
+ case collection_format
370
+ when :csv
371
+ param.join(',')
372
+ when :ssv
373
+ param.join(' ')
374
+ when :tsv
375
+ param.join("\t")
376
+ when :pipes
377
+ param.join('|')
378
+ when :multi
379
+ # return the array directly as typhoeus will handle it as expected
380
+ param
381
+ else
382
+ fail "unknown collection format: #{collection_format.inspect}"
383
+ end
384
+ end
385
+ end
386
+ end