xbim_identity 2.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 (103) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +174 -0
  4. data/Rakefile +10 -0
  5. data/lib/xbim_identity/api/authentication_api.rb +118 -0
  6. data/lib/xbim_identity/api/client_applications_api.rb +315 -0
  7. data/lib/xbim_identity/api/invitations_api.rb +489 -0
  8. data/lib/xbim_identity/api/me_api.rb +148 -0
  9. data/lib/xbim_identity/api/members_api.rb +406 -0
  10. data/lib/xbim_identity/api/registration_api.rb +85 -0
  11. data/lib/xbim_identity/api/tenants_api.rb +709 -0
  12. data/lib/xbim_identity/api/users_api.rb +308 -0
  13. data/lib/xbim_identity/api_client.rb +390 -0
  14. data/lib/xbim_identity/api_error.rb +57 -0
  15. data/lib/xbim_identity/configuration.rb +278 -0
  16. data/lib/xbim_identity/models/application_type.rb +39 -0
  17. data/lib/xbim_identity/models/client_app.rb +351 -0
  18. data/lib/xbim_identity/models/client_app_endpoint.rb +239 -0
  19. data/lib/xbim_identity/models/draft_invitation.rb +379 -0
  20. data/lib/xbim_identity/models/invitation.rb +379 -0
  21. data/lib/xbim_identity/models/invitation_create.rb +253 -0
  22. data/lib/xbim_identity/models/invitation_edit.rb +239 -0
  23. data/lib/xbim_identity/models/invite_status.rb +41 -0
  24. data/lib/xbim_identity/models/master.rb +331 -0
  25. data/lib/xbim_identity/models/master_base.rb +243 -0
  26. data/lib/xbim_identity/models/master_subscription.rb +323 -0
  27. data/lib/xbim_identity/models/o_data_boolean.rb +230 -0
  28. data/lib/xbim_identity/models/o_data_client_app_endpoint_list.rb +252 -0
  29. data/lib/xbim_identity/models/o_data_client_app_list.rb +252 -0
  30. data/lib/xbim_identity/models/o_data_invitation_list.rb +252 -0
  31. data/lib/xbim_identity/models/o_data_string.rb +230 -0
  32. data/lib/xbim_identity/models/o_data_tenant_list.rb +252 -0
  33. data/lib/xbim_identity/models/o_data_tenant_user_list.rb +252 -0
  34. data/lib/xbim_identity/models/o_data_user_list.rb +252 -0
  35. data/lib/xbim_identity/models/problem_details.rb +259 -0
  36. data/lib/xbim_identity/models/region.rb +280 -0
  37. data/lib/xbim_identity/models/region_info.rb +256 -0
  38. data/lib/xbim_identity/models/subscription.rb +309 -0
  39. data/lib/xbim_identity/models/team_member_create.rb +229 -0
  40. data/lib/xbim_identity/models/team_member_edit.rb +219 -0
  41. data/lib/xbim_identity/models/tenancy_type.rb +38 -0
  42. data/lib/xbim_identity/models/tenant.rb +383 -0
  43. data/lib/xbim_identity/models/tenant_create.rb +267 -0
  44. data/lib/xbim_identity/models/tenant_edit.rb +229 -0
  45. data/lib/xbim_identity/models/tenant_role.rb +39 -0
  46. data/lib/xbim_identity/models/tenant_user.rb +299 -0
  47. data/lib/xbim_identity/models/token_err_response.rb +219 -0
  48. data/lib/xbim_identity/models/token_response.rb +259 -0
  49. data/lib/xbim_identity/models/user.rb +261 -0
  50. data/lib/xbim_identity/models/user_create.rb +247 -0
  51. data/lib/xbim_identity/models/user_tenant.rb +279 -0
  52. data/lib/xbim_identity/version.rb +15 -0
  53. data/lib/xbim_identity.rb +83 -0
  54. data/spec/api/authentication_api_spec.rb +52 -0
  55. data/spec/api/client_applications_api_spec.rb +101 -0
  56. data/spec/api/invitations_api_spec.rb +130 -0
  57. data/spec/api/me_api_spec.rb +61 -0
  58. data/spec/api/members_api_spec.rb +113 -0
  59. data/spec/api/registration_api_spec.rb +48 -0
  60. data/spec/api/tenants_api_spec.rb +176 -0
  61. data/spec/api/users_api_spec.rb +95 -0
  62. data/spec/api_client_spec.rb +226 -0
  63. data/spec/configuration_spec.rb +42 -0
  64. data/spec/models/application_type_spec.rb +28 -0
  65. data/spec/models/client_app_endpoint_spec.rb +46 -0
  66. data/spec/models/client_app_spec.rb +112 -0
  67. data/spec/models/draft_invitation_spec.rb +130 -0
  68. data/spec/models/invitation_create_spec.rb +52 -0
  69. data/spec/models/invitation_edit_spec.rb +46 -0
  70. data/spec/models/invitation_spec.rb +130 -0
  71. data/spec/models/invite_status_spec.rb +28 -0
  72. data/spec/models/master_base_spec.rb +46 -0
  73. data/spec/models/master_spec.rb +94 -0
  74. data/spec/models/master_subscription_spec.rb +94 -0
  75. data/spec/models/o_data_boolean_spec.rb +40 -0
  76. data/spec/models/o_data_client_app_endpoint_list_spec.rb +52 -0
  77. data/spec/models/o_data_client_app_list_spec.rb +52 -0
  78. data/spec/models/o_data_invitation_list_spec.rb +52 -0
  79. data/spec/models/o_data_string_spec.rb +40 -0
  80. data/spec/models/o_data_tenant_list_spec.rb +52 -0
  81. data/spec/models/o_data_tenant_user_list_spec.rb +52 -0
  82. data/spec/models/o_data_user_list_spec.rb +52 -0
  83. data/spec/models/problem_details_spec.rb +58 -0
  84. data/spec/models/region_info_spec.rb +46 -0
  85. data/spec/models/region_spec.rb +58 -0
  86. data/spec/models/subscription_spec.rb +88 -0
  87. data/spec/models/team_member_create_spec.rb +40 -0
  88. data/spec/models/team_member_edit_spec.rb +34 -0
  89. data/spec/models/tenancy_type_spec.rb +28 -0
  90. data/spec/models/tenant_create_spec.rb +58 -0
  91. data/spec/models/tenant_edit_spec.rb +40 -0
  92. data/spec/models/tenant_role_spec.rb +28 -0
  93. data/spec/models/tenant_spec.rb +130 -0
  94. data/spec/models/tenant_user_spec.rb +82 -0
  95. data/spec/models/token_err_response_spec.rb +34 -0
  96. data/spec/models/token_response_spec.rb +58 -0
  97. data/spec/models/user_create_spec.rb +46 -0
  98. data/spec/models/user_spec.rb +58 -0
  99. data/spec/models/user_tenant_spec.rb +70 -0
  100. data/spec/spec_helper.rb +111 -0
  101. data/xbim_identity-1.0.0.gem +0 -0
  102. data/xbim_identity.gemspec +38 -0
  103. metadata +184 -0
@@ -0,0 +1,308 @@
1
+ =begin
2
+ #Xbim Flex Identity API 2.0
3
+
4
+ #Communication centralised around construction data
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: info@xbim.net
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module XbimIdentity
16
+ class UsersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get Users
23
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ODataUserList</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
26
+ # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 1000. The allowed functions are: allfunctions.
27
+ # @option opts [String] :select Limits the properties returned in the result.
28
+ # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
29
+ # @option opts [Integer] :top Limits the number of items returned from a collection. The maximum value is 1000.
30
+ # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
31
+ # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
32
+ # @return [ODataUserList]
33
+ def id20_users_get(opts = {})
34
+ data, _status_code, _headers = id20_users_get_with_http_info(opts)
35
+ data
36
+ end
37
+
38
+ # Get Users
39
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ODataUserList&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
40
+ # @param [Hash] opts the optional parameters
41
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
42
+ # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 1000. The allowed functions are: allfunctions.
43
+ # @option opts [String] :select Limits the properties returned in the result.
44
+ # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
45
+ # @option opts [Integer] :top Limits the number of items returned from a collection. The maximum value is 1000.
46
+ # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
47
+ # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
48
+ # @return [Array<(ODataUserList, Integer, Hash)>] ODataUserList data, response status code and response headers
49
+ def id20_users_get_with_http_info(opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_get ...'
52
+ end
53
+ # resource path
54
+ local_var_path = '/id/2.0/Users'
55
+
56
+ # query parameters
57
+ query_params = opts[:query_params] || {}
58
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
59
+ query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
60
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
61
+ query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
62
+ query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
63
+ query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
64
+ query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
65
+
66
+ # header parameters
67
+ header_params = opts[:header_params] || {}
68
+ # HTTP header 'Accept' (if needed)
69
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
70
+
71
+ # form parameters
72
+ form_params = opts[:form_params] || {}
73
+
74
+ # http body (model)
75
+ post_body = opts[:debug_body]
76
+
77
+ # return_type
78
+ return_type = opts[:debug_return_type] || 'ODataUserList'
79
+
80
+ # auth_names
81
+ auth_names = opts[:debug_auth_names] || ['oauth2']
82
+
83
+ new_options = opts.merge(
84
+ :operation => :"UsersApi.id20_users_get",
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 => return_type
91
+ )
92
+
93
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
94
+ if @api_client.config.debugging
95
+ @api_client.config.logger.debug "API called: UsersApi#id20_users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
96
+ end
97
+ return data, status_code, headers
98
+ end
99
+
100
+ # Gets the specified User by their key
101
+ # <span style='font-size: 17px;'>Summary:</span>Gets the specified User by their key.<br/>Return Type: <b>User</b><br/><br/>
102
+ # @param external_id [String] Optional external login ID. This can be used as an alternative key by master users
103
+ # @param [Hash] opts the optional parameters
104
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
105
+ # @option opts [String] :select Limits the properties returned in the result.
106
+ # @return [User]
107
+ def id20_users_get_by_external_id_external_idexternal_id_get(external_id, opts = {})
108
+ data, _status_code, _headers = id20_users_get_by_external_id_external_idexternal_id_get_with_http_info(external_id, opts)
109
+ data
110
+ end
111
+
112
+ # Gets the specified User by their key
113
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the specified User by their key.&lt;br/&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
114
+ # @param external_id [String] Optional external login ID. This can be used as an alternative key by master users
115
+ # @param [Hash] opts the optional parameters
116
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
117
+ # @option opts [String] :select Limits the properties returned in the result.
118
+ # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
119
+ def id20_users_get_by_external_id_external_idexternal_id_get_with_http_info(external_id, opts = {})
120
+ if @api_client.config.debugging
121
+ @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_get_by_external_id_external_idexternal_id_get ...'
122
+ end
123
+ # resource path
124
+ local_var_path = '/id/2.0/Users/GetByExternalId(externalId={externalId})'.sub('{' + 'externalId' + '}', CGI.escape(external_id.to_s))
125
+
126
+ # query parameters
127
+ query_params = opts[:query_params] || {}
128
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
129
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
130
+
131
+ # header parameters
132
+ header_params = opts[:header_params] || {}
133
+ # HTTP header 'Accept' (if needed)
134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
135
+
136
+ # form parameters
137
+ form_params = opts[:form_params] || {}
138
+
139
+ # http body (model)
140
+ post_body = opts[:debug_body]
141
+
142
+ # return_type
143
+ return_type = opts[:debug_return_type] || 'User'
144
+
145
+ # auth_names
146
+ auth_names = opts[:debug_auth_names] || ['oauth2']
147
+
148
+ new_options = opts.merge(
149
+ :operation => :"UsersApi.id20_users_get_by_external_id_external_idexternal_id_get",
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
+ :return_type => return_type
156
+ )
157
+
158
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
159
+ if @api_client.config.debugging
160
+ @api_client.config.logger.debug "API called: UsersApi#id20_users_get_by_external_id_external_idexternal_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
161
+ end
162
+ return data, status_code, headers
163
+ end
164
+
165
+ # Post Users
166
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>User</b><br/><br/>
167
+ # @param user_create [UserCreate] User to be created
168
+ # @param [Hash] opts the optional parameters
169
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
170
+ # @option opts [String] :select Limits the properties returned in the result.
171
+ # @return [User]
172
+ def id20_users_post(user_create, opts = {})
173
+ data, _status_code, _headers = id20_users_post_with_http_info(user_create, opts)
174
+ data
175
+ end
176
+
177
+ # Post Users
178
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
179
+ # @param user_create [UserCreate] User to be created
180
+ # @param [Hash] opts the optional parameters
181
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
182
+ # @option opts [String] :select Limits the properties returned in the result.
183
+ # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
184
+ def id20_users_post_with_http_info(user_create, opts = {})
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_post ...'
187
+ end
188
+ # verify the required parameter 'user_create' is set
189
+ if @api_client.config.client_side_validation && user_create.nil?
190
+ fail ArgumentError, "Missing the required parameter 'user_create' when calling UsersApi.id20_users_post"
191
+ end
192
+ # resource path
193
+ local_var_path = '/id/2.0/Users'
194
+
195
+ # query parameters
196
+ query_params = opts[:query_params] || {}
197
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
198
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
199
+
200
+ # header parameters
201
+ header_params = opts[:header_params] || {}
202
+ # HTTP header 'Accept' (if needed)
203
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
204
+ # HTTP header 'Content-Type'
205
+ content_type = @api_client.select_header_content_type(['application/json', 'application/xml', 'text/json', 'application/*+json'])
206
+ if !content_type.nil?
207
+ header_params['Content-Type'] = content_type
208
+ end
209
+
210
+ # form parameters
211
+ form_params = opts[:form_params] || {}
212
+
213
+ # http body (model)
214
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create)
215
+
216
+ # return_type
217
+ return_type = opts[:debug_return_type] || 'User'
218
+
219
+ # auth_names
220
+ auth_names = opts[:debug_auth_names] || ['oauth2']
221
+
222
+ new_options = opts.merge(
223
+ :operation => :"UsersApi.id20_users_post",
224
+ :header_params => header_params,
225
+ :query_params => query_params,
226
+ :form_params => form_params,
227
+ :body => post_body,
228
+ :auth_names => auth_names,
229
+ :return_type => return_type
230
+ )
231
+
232
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug "API called: UsersApi#id20_users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
+ end
236
+ return data, status_code, headers
237
+ end
238
+
239
+ # Gets the specified User by their key
240
+ # <span style='font-size: 17px;'>Summary:</span>Gets the specified User by their key.<br/>Return Type: <b>User</b><br/><br/>
241
+ # @param user_id [String] The key.
242
+ # @param [Hash] opts the optional parameters
243
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
244
+ # @option opts [String] :select Limits the properties returned in the result.
245
+ # @return [User]
246
+ def id20_users_user_id_get(user_id, opts = {})
247
+ data, _status_code, _headers = id20_users_user_id_get_with_http_info(user_id, opts)
248
+ data
249
+ end
250
+
251
+ # Gets the specified User by their key
252
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the specified User by their key.&lt;br/&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
253
+ # @param user_id [String] The key.
254
+ # @param [Hash] opts the optional parameters
255
+ # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
256
+ # @option opts [String] :select Limits the properties returned in the result.
257
+ # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
258
+ def id20_users_user_id_get_with_http_info(user_id, opts = {})
259
+ if @api_client.config.debugging
260
+ @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_user_id_get ...'
261
+ end
262
+ # verify the required parameter 'user_id' is set
263
+ if @api_client.config.client_side_validation && user_id.nil?
264
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.id20_users_user_id_get"
265
+ end
266
+ # resource path
267
+ local_var_path = '/id/2.0/Users({userId})'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
268
+
269
+ # query parameters
270
+ query_params = opts[:query_params] || {}
271
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
272
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
273
+
274
+ # header parameters
275
+ header_params = opts[:header_params] || {}
276
+ # HTTP header 'Accept' (if needed)
277
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
278
+
279
+ # form parameters
280
+ form_params = opts[:form_params] || {}
281
+
282
+ # http body (model)
283
+ post_body = opts[:debug_body]
284
+
285
+ # return_type
286
+ return_type = opts[:debug_return_type] || 'User'
287
+
288
+ # auth_names
289
+ auth_names = opts[:debug_auth_names] || ['oauth2']
290
+
291
+ new_options = opts.merge(
292
+ :operation => :"UsersApi.id20_users_user_id_get",
293
+ :header_params => header_params,
294
+ :query_params => query_params,
295
+ :form_params => form_params,
296
+ :body => post_body,
297
+ :auth_names => auth_names,
298
+ :return_type => return_type
299
+ )
300
+
301
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
302
+ if @api_client.config.debugging
303
+ @api_client.config.logger.debug "API called: UsersApi#id20_users_user_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
304
+ end
305
+ return data, status_code, headers
306
+ end
307
+ end
308
+ end
@@ -0,0 +1,390 @@
1
+ =begin
2
+ #Xbim Flex Identity API 2.0
3
+
4
+ #Communication centralised around construction data
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: info@xbim.net
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'time'
18
+ require 'typhoeus'
19
+
20
+ module XbimIdentity
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, opts)
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
+ # Builds the HTTP request body
132
+ #
133
+ # @param [Hash] header_params Header parameters
134
+ # @param [Hash] form_params Query parameters
135
+ # @param [Object] body HTTP body (JSON/XML)
136
+ # @return [String] HTTP body data in the form of string
137
+ def build_request_body(header_params, form_params, body)
138
+ # http form
139
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
140
+ header_params['Content-Type'] == 'multipart/form-data'
141
+ data = {}
142
+ form_params.each do |key, value|
143
+ case value
144
+ when ::File, ::Array, nil
145
+ # let typhoeus handle File, Array and nil parameters
146
+ data[key] = value
147
+ else
148
+ data[key] = value.to_s
149
+ end
150
+ end
151
+ elsif body
152
+ data = body.is_a?(String) ? body : body.to_json
153
+ else
154
+ data = nil
155
+ end
156
+ data
157
+ end
158
+
159
+ # Save response body into a file in (the defined) temporary folder, using the filename
160
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
161
+ # The response body is written to the file in chunks in order to handle files which
162
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
163
+ # process can use.
164
+ #
165
+ # @see Configuration#temp_folder_path
166
+ def download_file(request)
167
+ tempfile = nil
168
+ encoding = nil
169
+ request.on_headers do |response|
170
+ content_disposition = response.headers['Content-Disposition']
171
+ if content_disposition && content_disposition =~ /filename=/i
172
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
173
+ prefix = sanitize_filename(filename)
174
+ else
175
+ prefix = 'download-'
176
+ end
177
+ prefix = prefix + '-' unless prefix.end_with?('-')
178
+ encoding = response.body.encoding
179
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
180
+ @tempfile = tempfile
181
+ end
182
+ request.on_body do |chunk|
183
+ chunk.force_encoding(encoding)
184
+ tempfile.write(chunk)
185
+ end
186
+ request.on_complete do |response|
187
+ if tempfile
188
+ tempfile.close
189
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
190
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
191
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
192
+ "explicitly with `tempfile.delete`"
193
+ end
194
+ end
195
+ end
196
+
197
+ # Check if the given MIME is a JSON MIME.
198
+ # JSON MIME examples:
199
+ # application/json
200
+ # application/json; charset=UTF8
201
+ # APPLICATION/JSON
202
+ # */*
203
+ # @param [String] mime MIME
204
+ # @return [Boolean] True if the MIME is application/json
205
+ def json_mime?(mime)
206
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
207
+ end
208
+
209
+ # Deserialize the response to the given return type.
210
+ #
211
+ # @param [Response] response HTTP response
212
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
213
+ def deserialize(response, return_type)
214
+ body = response.body
215
+
216
+ # handle file downloading - return the File instance processed in request callbacks
217
+ # note that response body is empty when the file is written in chunks in request on_body callback
218
+ return @tempfile if return_type == 'File'
219
+
220
+ return nil if body.nil? || body.empty?
221
+
222
+ # return response body directly for String return type
223
+ return body if return_type == 'String'
224
+
225
+ # ensuring a default content type
226
+ content_type = response.headers['Content-Type'] || 'application/json'
227
+
228
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
229
+
230
+ begin
231
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
232
+ rescue JSON::ParserError => e
233
+ if %w(String Date Time).include?(return_type)
234
+ data = body
235
+ else
236
+ raise e
237
+ end
238
+ end
239
+
240
+ convert_to_type data, return_type
241
+ end
242
+
243
+ # Convert data to the given return type.
244
+ # @param [Object] data Data to be converted
245
+ # @param [String] return_type Return type
246
+ # @return [Mixed] Data in a particular type
247
+ def convert_to_type(data, return_type)
248
+ return nil if data.nil?
249
+ case return_type
250
+ when 'String'
251
+ data.to_s
252
+ when 'Integer'
253
+ data.to_i
254
+ when 'Float'
255
+ data.to_f
256
+ when 'Boolean'
257
+ data == true
258
+ when 'Time'
259
+ # parse date time (expecting ISO 8601 format)
260
+ Time.parse data
261
+ when 'Date'
262
+ # parse date time (expecting ISO 8601 format)
263
+ Date.parse data
264
+ when 'Object'
265
+ # generic object (usually a Hash), return directly
266
+ data
267
+ when /\AArray<(.+)>\z/
268
+ # e.g. Array<Pet>
269
+ sub_type = $1
270
+ data.map { |item| convert_to_type(item, sub_type) }
271
+ when /\AHash\<String, (.+)\>\z/
272
+ # e.g. Hash<String, Integer>
273
+ sub_type = $1
274
+ {}.tap do |hash|
275
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
276
+ end
277
+ else
278
+ # models (e.g. Pet) or oneOf
279
+ klass = XbimIdentity.const_get(return_type)
280
+ klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
281
+ end
282
+ end
283
+
284
+ # Sanitize filename by removing path.
285
+ # e.g. ../../sun.gif becomes sun.gif
286
+ #
287
+ # @param [String] filename the filename to be sanitized
288
+ # @return [String] the sanitized filename
289
+ def sanitize_filename(filename)
290
+ filename.gsub(/.*[\/\\]/, '')
291
+ end
292
+
293
+ def build_request_url(path, opts = {})
294
+ # Add leading and trailing slashes to path
295
+ path = "/#{path}".gsub(/\/+/, '/')
296
+ @config.base_url(opts[:operation]) + path
297
+ end
298
+
299
+ # Update header and query params based on authentication settings.
300
+ #
301
+ # @param [Hash] header_params Header parameters
302
+ # @param [Hash] query_params Query parameters
303
+ # @param [String] auth_names Authentication scheme name
304
+ def update_params_for_auth!(header_params, query_params, auth_names)
305
+ Array(auth_names).each do |auth_name|
306
+ auth_setting = @config.auth_settings[auth_name]
307
+ next unless auth_setting
308
+ case auth_setting[:in]
309
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
310
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
311
+ else fail ArgumentError, 'Authentication token must be in `query` or `header`'
312
+ end
313
+ end
314
+ end
315
+
316
+ # Sets user agent in HTTP header
317
+ #
318
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
319
+ def user_agent=(user_agent)
320
+ @user_agent = user_agent
321
+ @default_headers['User-Agent'] = @user_agent
322
+ end
323
+
324
+ # Return Accept header based on an array of accepts provided.
325
+ # @param [Array] accepts array for Accept
326
+ # @return [String] the Accept header (e.g. application/json)
327
+ def select_header_accept(accepts)
328
+ return nil if accepts.nil? || accepts.empty?
329
+ # use JSON when present, otherwise use all of the provided
330
+ json_accept = accepts.find { |s| json_mime?(s) }
331
+ json_accept || accepts.join(',')
332
+ end
333
+
334
+ # Return Content-Type header based on an array of content types provided.
335
+ # @param [Array] content_types array for Content-Type
336
+ # @return [String] the Content-Type header (e.g. application/json)
337
+ def select_header_content_type(content_types)
338
+ # return nil by default
339
+ return if content_types.nil? || content_types.empty?
340
+ # use JSON when present, otherwise use the first one
341
+ json_content_type = content_types.find { |s| json_mime?(s) }
342
+ json_content_type || content_types.first
343
+ end
344
+
345
+ # Convert object (array, hash, object, etc) to JSON string.
346
+ # @param [Object] model object to be converted into JSON string
347
+ # @return [String] JSON string representation of the object
348
+ def object_to_http_body(model)
349
+ return model if model.nil? || model.is_a?(String)
350
+ local_body = nil
351
+ if model.is_a?(Array)
352
+ local_body = model.map { |m| object_to_hash(m) }
353
+ else
354
+ local_body = object_to_hash(model)
355
+ end
356
+ local_body.to_json
357
+ end
358
+
359
+ # Convert object(non-array) to hash.
360
+ # @param [Object] obj object to be converted into JSON string
361
+ # @return [String] JSON string representation of the object
362
+ def object_to_hash(obj)
363
+ if obj.respond_to?(:to_hash)
364
+ obj.to_hash
365
+ else
366
+ obj
367
+ end
368
+ end
369
+
370
+ # Build parameter value according to the given collection format.
371
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
372
+ def build_collection_param(param, collection_format)
373
+ case collection_format
374
+ when :csv
375
+ param.join(',')
376
+ when :ssv
377
+ param.join(' ')
378
+ when :tsv
379
+ param.join("\t")
380
+ when :pipes
381
+ param.join('|')
382
+ when :multi
383
+ # return the array directly as typhoeus will handle it as expected
384
+ param
385
+ else
386
+ fail "unknown collection format: #{collection_format.inspect}"
387
+ end
388
+ end
389
+ end
390
+ end