rokka_client_codegen 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE +21 -0
  4. data/README.md +123 -0
  5. data/Rakefile +8 -0
  6. data/config.json +5 -0
  7. data/docs/AdminApi.md +398 -0
  8. data/docs/ListSourceImagesResponse.md +11 -0
  9. data/docs/ListStacksResponse.md +8 -0
  10. data/docs/Membership.md +11 -0
  11. data/docs/Organization.md +14 -0
  12. data/docs/OrganizationDefinition.md +10 -0
  13. data/docs/OrganizationOptions.md +10 -0
  14. data/docs/Role.md +8 -0
  15. data/docs/SourceImage.md +24 -0
  16. data/docs/SourceimagesApi.md +1032 -0
  17. data/docs/Stack.md +14 -0
  18. data/docs/StackDefinition.md +10 -0
  19. data/docs/StackExpression.md +9 -0
  20. data/docs/StackExpressionOverrides.md +8 -0
  21. data/docs/StackOperation.md +9 -0
  22. data/docs/StackOperationDescription.md +11 -0
  23. data/docs/StackOptions.md +8 -0
  24. data/docs/StacksApi.md +329 -0
  25. data/docs/User.md +11 -0
  26. data/docs/UserDefinition.md +9 -0
  27. data/examples/createstack.rb +33 -0
  28. data/examples/liststacks.rb +19 -0
  29. data/examples/setsubjectarea.rb +37 -0
  30. data/examples/uploadimage.rb +28 -0
  31. data/generate.sh +3 -0
  32. data/git_push.sh +55 -0
  33. data/lib/rokka_client_codegen.rb +59 -0
  34. data/lib/rokka_client_codegen/api/admin_api.rb +439 -0
  35. data/lib/rokka_client_codegen/api/sourceimages_api.rb +1225 -0
  36. data/lib/rokka_client_codegen/api/stacks_api.rb +371 -0
  37. data/lib/rokka_client_codegen/api_client.rb +389 -0
  38. data/lib/rokka_client_codegen/api_error.rb +38 -0
  39. data/lib/rokka_client_codegen/configuration.rb +209 -0
  40. data/lib/rokka_client_codegen/models/list_source_images_response.rb +217 -0
  41. data/lib/rokka_client_codegen/models/list_stacks_response.rb +190 -0
  42. data/lib/rokka_client_codegen/models/membership.rb +215 -0
  43. data/lib/rokka_client_codegen/models/organization.rb +264 -0
  44. data/lib/rokka_client_codegen/models/organization_definition.rb +211 -0
  45. data/lib/rokka_client_codegen/models/organization_options.rb +208 -0
  46. data/lib/rokka_client_codegen/models/role.rb +194 -0
  47. data/lib/rokka_client_codegen/models/source_image.rb +333 -0
  48. data/lib/rokka_client_codegen/models/stack.rb +246 -0
  49. data/lib/rokka_client_codegen/models/stack_definition.rb +217 -0
  50. data/lib/rokka_client_codegen/models/stack_expression.rb +207 -0
  51. data/lib/rokka_client_codegen/models/stack_expression_overrides.rb +188 -0
  52. data/lib/rokka_client_codegen/models/stack_operation.rb +203 -0
  53. data/lib/rokka_client_codegen/models/stack_operation_description.rb +231 -0
  54. data/lib/rokka_client_codegen/models/stack_options.rb +193 -0
  55. data/lib/rokka_client_codegen/models/user.rb +216 -0
  56. data/lib/rokka_client_codegen/models/user_definition.rb +204 -0
  57. data/lib/rokka_client_codegen/version.rb +15 -0
  58. data/patches/README.patch +59 -0
  59. data/patches/sourceimage_hash_long_hash.patch +62 -0
  60. data/rokka_client_codegen.gemspec +45 -0
  61. data/spec/api/admin_api_spec.rb +125 -0
  62. data/spec/api/sourceimages_api_spec.rb +274 -0
  63. data/spec/api/stacks_api_spec.rb +110 -0
  64. data/spec/api_client_spec.rb +226 -0
  65. data/spec/configuration_spec.rb +42 -0
  66. data/spec/models/list_source_images_response_spec.rb +60 -0
  67. data/spec/models/list_stacks_response_spec.rb +42 -0
  68. data/spec/models/membership_spec.rb +60 -0
  69. data/spec/models/organization_definition_spec.rb +54 -0
  70. data/spec/models/organization_options_spec.rb +54 -0
  71. data/spec/models/organization_spec.rb +78 -0
  72. data/spec/models/role_spec.rb +42 -0
  73. data/spec/models/source_image_spec.rb +138 -0
  74. data/spec/models/stack_definition_spec.rb +54 -0
  75. data/spec/models/stack_expression_overrides_spec.rb +42 -0
  76. data/spec/models/stack_expression_spec.rb +48 -0
  77. data/spec/models/stack_operation_description_spec.rb +60 -0
  78. data/spec/models/stack_operation_spec.rb +48 -0
  79. data/spec/models/stack_options_spec.rb +42 -0
  80. data/spec/models/stack_spec.rb +78 -0
  81. data/spec/models/user_definition_spec.rb +48 -0
  82. data/spec/models/user_spec.rb +60 -0
  83. data/spec/spec_helper.rb +111 -0
  84. metadata +330 -0
@@ -0,0 +1,371 @@
1
+ =begin
2
+ #rokka.io
3
+
4
+ #digital image processing done right. [Documentation](https://rokka.io/documentation). [Changelog](https://api.rokka.io/changelog.md).
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module RokkaClientCodegen
16
+ class StacksApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # Create a new stack.
24
+ #
25
+ # @param stack_definition Stack operations and options definition. See https://rokka.io/documentation/references/stacks.html for explanations how to define stacks.
26
+ # @param organization
27
+ # @param name
28
+ # @param [Hash] opts the optional parameters
29
+ # @option opts [BOOLEAN] :overwrite Whether to overwrite the stack if it already exists (default to false)
30
+ # @return [Stack]
31
+ def create_stack(stack_definition, organization, name, opts = {})
32
+ data, _status_code, _headers = create_stack_with_http_info(stack_definition, organization, name, opts)
33
+ return data
34
+ end
35
+
36
+ # Create a new stack.
37
+ #
38
+ # @param stack_definition Stack operations and options definition. See https://rokka.io/documentation/references/stacks.html for explanations how to define stacks.
39
+ # @param organization
40
+ # @param name
41
+ # @param [Hash] opts the optional parameters
42
+ # @option opts [BOOLEAN] :overwrite Whether to overwrite the stack if it already exists
43
+ # @return [Array<(Stack, Fixnum, Hash)>] Stack data, response status code and response headers
44
+ def create_stack_with_http_info(stack_definition, organization, name, opts = {})
45
+ if @api_client.config.debugging
46
+ @api_client.config.logger.debug "Calling API: StacksApi.create_stack ..."
47
+ end
48
+ # verify the required parameter 'stack_definition' is set
49
+ if @api_client.config.client_side_validation && stack_definition.nil?
50
+ fail ArgumentError, "Missing the required parameter 'stack_definition' when calling StacksApi.create_stack"
51
+ end
52
+ # verify the required parameter 'organization' is set
53
+ if @api_client.config.client_side_validation && organization.nil?
54
+ fail ArgumentError, "Missing the required parameter 'organization' when calling StacksApi.create_stack"
55
+ end
56
+ if @api_client.config.client_side_validation && organization !~ Regexp.new(/[0-9a-z\\-]+/)
57
+ fail ArgumentError, "invalid value for 'organization' when calling StacksApi.create_stack, must conform to the pattern /[0-9a-z\\-]+/."
58
+ end
59
+
60
+ # verify the required parameter 'name' is set
61
+ if @api_client.config.client_side_validation && name.nil?
62
+ fail ArgumentError, "Missing the required parameter 'name' when calling StacksApi.create_stack"
63
+ end
64
+ if @api_client.config.client_side_validation && name !~ Regexp.new(/[a-z0-9\\-_]+/)
65
+ fail ArgumentError, "invalid value for 'name' when calling StacksApi.create_stack, must conform to the pattern /[a-z0-9\\-_]+/."
66
+ end
67
+
68
+ # resource path
69
+ local_var_path = "/stacks/{organization}/{name}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'name' + '}', name.to_s)
70
+
71
+ # query parameters
72
+ query_params = {}
73
+ query_params[:'overwrite'] = opts[:'overwrite'] if !opts[:'overwrite'].nil?
74
+
75
+ # header parameters
76
+ header_params = {}
77
+
78
+ # form parameters
79
+ form_params = {}
80
+
81
+ # http body (model)
82
+ post_body = @api_client.object_to_http_body(stack_definition)
83
+ auth_names = ['ApiKeyAuth']
84
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => 'Stack')
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: StacksApi#create_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+
97
+ # Delete a stack.
98
+ #
99
+ # @param organization
100
+ # @param name
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [nil]
103
+ def delete_stack(organization, name, opts = {})
104
+ delete_stack_with_http_info(organization, name, opts)
105
+ return nil
106
+ end
107
+
108
+ # Delete a stack.
109
+ #
110
+ # @param organization
111
+ # @param name
112
+ # @param [Hash] opts the optional parameters
113
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
114
+ def delete_stack_with_http_info(organization, name, opts = {})
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug "Calling API: StacksApi.delete_stack ..."
117
+ end
118
+ # verify the required parameter 'organization' is set
119
+ if @api_client.config.client_side_validation && organization.nil?
120
+ fail ArgumentError, "Missing the required parameter 'organization' when calling StacksApi.delete_stack"
121
+ end
122
+ if @api_client.config.client_side_validation && organization !~ Regexp.new(/[0-9a-z\\-]+/)
123
+ fail ArgumentError, "invalid value for 'organization' when calling StacksApi.delete_stack, must conform to the pattern /[0-9a-z\\-]+/."
124
+ end
125
+
126
+ # verify the required parameter 'name' is set
127
+ if @api_client.config.client_side_validation && name.nil?
128
+ fail ArgumentError, "Missing the required parameter 'name' when calling StacksApi.delete_stack"
129
+ end
130
+ if @api_client.config.client_side_validation && name !~ Regexp.new(/[a-z0-9\\-_]+/)
131
+ fail ArgumentError, "invalid value for 'name' when calling StacksApi.delete_stack, must conform to the pattern /[a-z0-9\\-_]+/."
132
+ end
133
+
134
+ # resource path
135
+ local_var_path = "/stacks/{organization}/{name}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'name' + '}', name.to_s)
136
+
137
+ # query parameters
138
+ query_params = {}
139
+
140
+ # header parameters
141
+ header_params = {}
142
+
143
+ # form parameters
144
+ form_params = {}
145
+
146
+ # http body (model)
147
+ post_body = nil
148
+ auth_names = ['ApiKeyAuth']
149
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
150
+ :header_params => header_params,
151
+ :query_params => query_params,
152
+ :form_params => form_params,
153
+ :body => post_body,
154
+ :auth_names => auth_names)
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: StacksApi#delete_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ return data, status_code, headers
159
+ end
160
+
161
+ # Get a single stack.
162
+ #
163
+ # @param organization
164
+ # @param name
165
+ # @param [Hash] opts the optional parameters
166
+ # @return [Stack]
167
+ def get_stack(organization, name, opts = {})
168
+ data, _status_code, _headers = get_stack_with_http_info(organization, name, opts)
169
+ return data
170
+ end
171
+
172
+ # Get a single stack.
173
+ #
174
+ # @param organization
175
+ # @param name
176
+ # @param [Hash] opts the optional parameters
177
+ # @return [Array<(Stack, Fixnum, Hash)>] Stack data, response status code and response headers
178
+ def get_stack_with_http_info(organization, name, opts = {})
179
+ if @api_client.config.debugging
180
+ @api_client.config.logger.debug "Calling API: StacksApi.get_stack ..."
181
+ end
182
+ # verify the required parameter 'organization' is set
183
+ if @api_client.config.client_side_validation && organization.nil?
184
+ fail ArgumentError, "Missing the required parameter 'organization' when calling StacksApi.get_stack"
185
+ end
186
+ if @api_client.config.client_side_validation && organization !~ Regexp.new(/[0-9a-z\\-]+/)
187
+ fail ArgumentError, "invalid value for 'organization' when calling StacksApi.get_stack, must conform to the pattern /[0-9a-z\\-]+/."
188
+ end
189
+
190
+ # verify the required parameter 'name' is set
191
+ if @api_client.config.client_side_validation && name.nil?
192
+ fail ArgumentError, "Missing the required parameter 'name' when calling StacksApi.get_stack"
193
+ end
194
+ if @api_client.config.client_side_validation && name !~ Regexp.new(/[a-z0-9\\-_]+/)
195
+ fail ArgumentError, "invalid value for 'name' when calling StacksApi.get_stack, must conform to the pattern /[a-z0-9\\-_]+/."
196
+ end
197
+
198
+ # resource path
199
+ local_var_path = "/stacks/{organization}/{name}".sub('{' + 'organization' + '}', organization.to_s).sub('{' + 'name' + '}', name.to_s)
200
+
201
+ # query parameters
202
+ query_params = {}
203
+
204
+ # header parameters
205
+ header_params = {}
206
+
207
+ # form parameters
208
+ form_params = {}
209
+
210
+ # http body (model)
211
+ post_body = nil
212
+ auth_names = ['ApiKeyAuth']
213
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
214
+ :header_params => header_params,
215
+ :query_params => query_params,
216
+ :form_params => form_params,
217
+ :body => post_body,
218
+ :auth_names => auth_names,
219
+ :return_type => 'Stack')
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug "API called: StacksApi#get_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
+ end
223
+ return data, status_code, headers
224
+ end
225
+
226
+ # Listing all available operations that can be used in stacks.
227
+ #
228
+ # @param [Hash] opts the optional parameters
229
+ # @return [Hash<String, StackOperationDescription>]
230
+ def list_operations(opts = {})
231
+ data, _status_code, _headers = list_operations_with_http_info(opts)
232
+ return data
233
+ end
234
+
235
+ # Listing all available operations that can be used in stacks.
236
+ #
237
+ # @param [Hash] opts the optional parameters
238
+ # @return [Array<(Hash<String, StackOperationDescription>, Fixnum, Hash)>] Hash<String, StackOperationDescription> data, response status code and response headers
239
+ def list_operations_with_http_info(opts = {})
240
+ if @api_client.config.debugging
241
+ @api_client.config.logger.debug "Calling API: StacksApi.list_operations ..."
242
+ end
243
+ # resource path
244
+ local_var_path = "/operations"
245
+
246
+ # query parameters
247
+ query_params = {}
248
+
249
+ # header parameters
250
+ header_params = {}
251
+
252
+ # form parameters
253
+ form_params = {}
254
+
255
+ # http body (model)
256
+ post_body = nil
257
+ auth_names = ['ApiKeyAuth']
258
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
259
+ :header_params => header_params,
260
+ :query_params => query_params,
261
+ :form_params => form_params,
262
+ :body => post_body,
263
+ :auth_names => auth_names,
264
+ :return_type => 'Hash<String, StackOperationDescription>')
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "API called: StacksApi#list_operations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
267
+ end
268
+ return data, status_code, headers
269
+ end
270
+
271
+ # List all available options that can be set on stacks.
272
+ #
273
+ # @param [Hash] opts the optional parameters
274
+ # @return [StackOptions]
275
+ def list_stack_options(opts = {})
276
+ data, _status_code, _headers = list_stack_options_with_http_info(opts)
277
+ return data
278
+ end
279
+
280
+ # List all available options that can be set on stacks.
281
+ #
282
+ # @param [Hash] opts the optional parameters
283
+ # @return [Array<(StackOptions, Fixnum, Hash)>] StackOptions data, response status code and response headers
284
+ def list_stack_options_with_http_info(opts = {})
285
+ if @api_client.config.debugging
286
+ @api_client.config.logger.debug "Calling API: StacksApi.list_stack_options ..."
287
+ end
288
+ # resource path
289
+ local_var_path = "/stackoptions"
290
+
291
+ # query parameters
292
+ query_params = {}
293
+
294
+ # header parameters
295
+ header_params = {}
296
+
297
+ # form parameters
298
+ form_params = {}
299
+
300
+ # http body (model)
301
+ post_body = nil
302
+ auth_names = ['ApiKeyAuth']
303
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
304
+ :header_params => header_params,
305
+ :query_params => query_params,
306
+ :form_params => form_params,
307
+ :body => post_body,
308
+ :auth_names => auth_names,
309
+ :return_type => 'StackOptions')
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "API called: StacksApi#list_stack_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
+ end
313
+ return data, status_code, headers
314
+ end
315
+
316
+ # Get all stacks of an organization.
317
+ #
318
+ # @param organization
319
+ # @param [Hash] opts the optional parameters
320
+ # @return [ListStacksResponse]
321
+ def list_stacks(organization, opts = {})
322
+ data, _status_code, _headers = list_stacks_with_http_info(organization, opts)
323
+ return data
324
+ end
325
+
326
+ # Get all stacks of an organization.
327
+ #
328
+ # @param organization
329
+ # @param [Hash] opts the optional parameters
330
+ # @return [Array<(ListStacksResponse, Fixnum, Hash)>] ListStacksResponse data, response status code and response headers
331
+ def list_stacks_with_http_info(organization, opts = {})
332
+ if @api_client.config.debugging
333
+ @api_client.config.logger.debug "Calling API: StacksApi.list_stacks ..."
334
+ end
335
+ # verify the required parameter 'organization' is set
336
+ if @api_client.config.client_side_validation && organization.nil?
337
+ fail ArgumentError, "Missing the required parameter 'organization' when calling StacksApi.list_stacks"
338
+ end
339
+ if @api_client.config.client_side_validation && organization !~ Regexp.new(/[0-9a-z\\-]+/)
340
+ fail ArgumentError, "invalid value for 'organization' when calling StacksApi.list_stacks, must conform to the pattern /[0-9a-z\\-]+/."
341
+ end
342
+
343
+ # resource path
344
+ local_var_path = "/stacks/{organization}".sub('{' + 'organization' + '}', organization.to_s)
345
+
346
+ # query parameters
347
+ query_params = {}
348
+
349
+ # header parameters
350
+ header_params = {}
351
+
352
+ # form parameters
353
+ form_params = {}
354
+
355
+ # http body (model)
356
+ post_body = nil
357
+ auth_names = ['ApiKeyAuth']
358
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
359
+ :header_params => header_params,
360
+ :query_params => query_params,
361
+ :form_params => form_params,
362
+ :body => post_body,
363
+ :auth_names => auth_names,
364
+ :return_type => 'ListStacksResponse')
365
+ if @api_client.config.debugging
366
+ @api_client.config.logger.debug "API called: StacksApi#list_stacks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
367
+ end
368
+ return data, status_code, headers
369
+ end
370
+ end
371
+ end
@@ -0,0 +1,389 @@
1
+ =begin
2
+ #rokka.io
3
+
4
+ #digital image processing done right. [Documentation](https://rokka.io/documentation). [Changelog](https://api.rokka.io/changelog.md).
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
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 RokkaClientCodegen
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 = "Swagger-Codegen/#{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, Fixnum, 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
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
98
+
99
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
100
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
101
+
102
+ req_opts = {
103
+ :method => http_method,
104
+ :headers => header_params,
105
+ :params => query_params,
106
+ :params_encoding => @config.params_encoding,
107
+ :timeout => @config.timeout,
108
+ :ssl_verifypeer => @config.verify_ssl,
109
+ :ssl_verifyhost => _verify_ssl_host,
110
+ :sslcert => @config.cert_file,
111
+ :sslkey => @config.key_file,
112
+ :verbose => @config.debugging
113
+ }
114
+
115
+ # set custom cert, if provided
116
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
117
+
118
+ if [:post, :patch, :put, :delete].include?(http_method)
119
+ req_body = build_request_body(header_params, form_params, opts[:body])
120
+ req_opts.update :body => req_body
121
+ if @config.debugging
122
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
123
+ end
124
+ end
125
+
126
+ request = Typhoeus::Request.new(url, req_opts)
127
+ download_file(request) if opts[:return_type] == 'File'
128
+ request
129
+ end
130
+
131
+ # Check if the given MIME is a JSON MIME.
132
+ # JSON MIME examples:
133
+ # application/json
134
+ # application/json; charset=UTF8
135
+ # APPLICATION/JSON
136
+ # */*
137
+ # @param [String] mime MIME
138
+ # @return [Boolean] True if the MIME is application/json
139
+ def json_mime?(mime)
140
+ (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
141
+ end
142
+
143
+ # Deserialize the response to the given return type.
144
+ #
145
+ # @param [Response] response HTTP response
146
+ # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
147
+ def deserialize(response, return_type)
148
+ body = response.body
149
+
150
+ # handle file downloading - return the File instance processed in request callbacks
151
+ # note that response body is empty when the file is written in chunks in request on_body callback
152
+ return @tempfile if return_type == 'File'
153
+
154
+ return nil if body.nil? || body.empty?
155
+
156
+ # return response body directly for String return type
157
+ return body if return_type == 'String'
158
+
159
+ # ensuring a default content type
160
+ content_type = response.headers['Content-Type'] || 'application/json'
161
+
162
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
163
+
164
+ begin
165
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
166
+ rescue JSON::ParserError => e
167
+ if %w(String Date DateTime).include?(return_type)
168
+ data = body
169
+ else
170
+ raise e
171
+ end
172
+ end
173
+
174
+ convert_to_type data, return_type
175
+ end
176
+
177
+ # Convert data to the given return type.
178
+ # @param [Object] data Data to be converted
179
+ # @param [String] return_type Return type
180
+ # @return [Mixed] Data in a particular type
181
+ def convert_to_type(data, return_type)
182
+ return nil if data.nil?
183
+ case return_type
184
+ when 'String'
185
+ data.to_s
186
+ when 'Integer'
187
+ data.to_i
188
+ when 'Float'
189
+ data.to_f
190
+ when 'BOOLEAN'
191
+ data == true
192
+ when 'DateTime'
193
+ # parse date time (expecting ISO 8601 format)
194
+ DateTime.parse data
195
+ when 'Date'
196
+ # parse date time (expecting ISO 8601 format)
197
+ Date.parse data
198
+ when 'Object'
199
+ # generic object (usually a Hash), return directly
200
+ data
201
+ when /\AArray<(.+)>\z/
202
+ # e.g. Array<Pet>
203
+ sub_type = $1
204
+ data.map {|item| convert_to_type(item, sub_type) }
205
+ when /\AHash\<String, (.+)\>\z/
206
+ # e.g. Hash<String, Integer>
207
+ sub_type = $1
208
+ {}.tap do |hash|
209
+ data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
210
+ end
211
+ else
212
+ # models, e.g. Pet
213
+ RokkaClientCodegen.const_get(return_type).new.tap do |model|
214
+ model.build_from_hash data
215
+ end
216
+ end
217
+ end
218
+
219
+ # Save response body into a file in (the defined) temporary folder, using the filename
220
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
221
+ # The response body is written to the file in chunks in order to handle files which
222
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
223
+ # process can use.
224
+ #
225
+ # @see Configuration#temp_folder_path
226
+ def download_file(request)
227
+ tempfile = nil
228
+ encoding = nil
229
+ request.on_headers do |response|
230
+ content_disposition = response.headers['Content-Disposition']
231
+ if content_disposition and content_disposition =~ /filename=/i
232
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
233
+ prefix = sanitize_filename(filename)
234
+ else
235
+ prefix = 'download-'
236
+ end
237
+ prefix = prefix + '-' unless prefix.end_with?('-')
238
+ encoding = response.body.encoding
239
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
240
+ @tempfile = tempfile
241
+ end
242
+ request.on_body do |chunk|
243
+ chunk.force_encoding(encoding)
244
+ tempfile.write(chunk)
245
+ end
246
+ request.on_complete do |response|
247
+ tempfile.close
248
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
249
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
250
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
251
+ "explicitly with `tempfile.delete`"
252
+ end
253
+ end
254
+
255
+ # Sanitize filename by removing path.
256
+ # e.g. ../../sun.gif becomes sun.gif
257
+ #
258
+ # @param [String] filename the filename to be sanitized
259
+ # @return [String] the sanitized filename
260
+ def sanitize_filename(filename)
261
+ filename.gsub(/.*[\/\\]/, '')
262
+ end
263
+
264
+ def build_request_url(path)
265
+ # Add leading and trailing slashes to path
266
+ path = "/#{path}".gsub(/\/+/, '/')
267
+ URI.encode(@config.base_url + path)
268
+ end
269
+
270
+ # Builds the HTTP request body
271
+ #
272
+ # @param [Hash] header_params Header parameters
273
+ # @param [Hash] form_params Query parameters
274
+ # @param [Object] body HTTP body (JSON/XML)
275
+ # @return [String] HTTP body data in the form of string
276
+ def build_request_body(header_params, form_params, body)
277
+ # http form
278
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
279
+ header_params['Content-Type'] == 'multipart/form-data'
280
+ data = {}
281
+ form_params.each do |key, value|
282
+ case value
283
+ when ::File, ::Array, nil
284
+ # let typhoeus handle File, Array and nil parameters
285
+ data[key] = value
286
+ else
287
+ data[key] = value.to_s
288
+ end
289
+ end
290
+ elsif body
291
+ data = body.is_a?(String) ? body : body.to_json
292
+ else
293
+ data = nil
294
+ end
295
+ data
296
+ end
297
+
298
+ # Update hearder and query params based on authentication settings.
299
+ #
300
+ # @param [Hash] header_params Header parameters
301
+ # @param [Hash] query_params Query parameters
302
+ # @param [String] auth_names Authentication scheme name
303
+ def update_params_for_auth!(header_params, query_params, auth_names)
304
+ Array(auth_names).each do |auth_name|
305
+ auth_setting = @config.auth_settings[auth_name]
306
+ next unless auth_setting
307
+ case auth_setting[:in]
308
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
309
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
310
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
311
+ end
312
+ end
313
+ end
314
+
315
+ # Sets user agent in HTTP header
316
+ #
317
+ # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
318
+ def user_agent=(user_agent)
319
+ @user_agent = user_agent
320
+ @default_headers['User-Agent'] = @user_agent
321
+ end
322
+
323
+ # Return Accept header based on an array of accepts provided.
324
+ # @param [Array] accepts array for Accept
325
+ # @return [String] the Accept header (e.g. application/json)
326
+ def select_header_accept(accepts)
327
+ return nil if accepts.nil? || accepts.empty?
328
+ # use JSON when present, otherwise use all of the provided
329
+ json_accept = accepts.find { |s| json_mime?(s) }
330
+ return json_accept || accepts.join(',')
331
+ end
332
+
333
+ # Return Content-Type header based on an array of content types provided.
334
+ # @param [Array] content_types array for Content-Type
335
+ # @return [String] the Content-Type header (e.g. application/json)
336
+ def select_header_content_type(content_types)
337
+ # use application/json by default
338
+ return 'application/json' if content_types.nil? || content_types.empty?
339
+ # use JSON when present, otherwise use the first one
340
+ json_content_type = content_types.find { |s| json_mime?(s) }
341
+ return json_content_type || content_types.first
342
+ end
343
+
344
+ # Convert object (array, hash, object, etc) to JSON string.
345
+ # @param [Object] model object to be converted into JSON string
346
+ # @return [String] JSON string representation of the object
347
+ def object_to_http_body(model)
348
+ return model if model.nil? || model.is_a?(String)
349
+ local_body = nil
350
+ if model.is_a?(Array)
351
+ local_body = model.map{|m| object_to_hash(m) }
352
+ else
353
+ local_body = object_to_hash(model)
354
+ end
355
+ local_body.to_json
356
+ end
357
+
358
+ # Convert object(non-array) to hash.
359
+ # @param [Object] obj object to be converted into JSON string
360
+ # @return [String] JSON string representation of the object
361
+ def object_to_hash(obj)
362
+ if obj.respond_to?(:to_hash)
363
+ obj.to_hash
364
+ else
365
+ obj
366
+ end
367
+ end
368
+
369
+ # Build parameter value according to the given collection format.
370
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
371
+ def build_collection_param(param, collection_format)
372
+ case collection_format
373
+ when :csv
374
+ param.join(',')
375
+ when :ssv
376
+ param.join(' ')
377
+ when :tsv
378
+ param.join("\t")
379
+ when :pipes
380
+ param.join('|')
381
+ when :multi
382
+ # return the array directly as typhoeus will handle it as expected
383
+ param
384
+ else
385
+ fail "unknown collection format: #{collection_format.inspect}"
386
+ end
387
+ end
388
+ end
389
+ end