xbim_aim 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +413 -0
- data/Rakefile +10 -0
- data/lib/xbim_aim/api/admin_api.rb +358 -0
- data/lib/xbim_aim/api/applications_api.rb +203 -0
- data/lib/xbim_aim/api/assemblies_api.rb +690 -0
- data/lib/xbim_aim/api/assets_api.rb +926 -0
- data/lib/xbim_aim/api/attributes_api.rb +789 -0
- data/lib/xbim_aim/api/component_types_api.rb +690 -0
- data/lib/xbim_aim/api/components_api.rb +803 -0
- data/lib/xbim_aim/api/contacts_api.rb +690 -0
- data/lib/xbim_aim/api/diagnostics_api.rb +109 -0
- data/lib/xbim_aim/api/document_files_api.rb +224 -0
- data/lib/xbim_aim/api/documents_api.rb +690 -0
- data/lib/xbim_aim/api/entities_api.rb +904 -0
- data/lib/xbim_aim/api/facilities_api.rb +690 -0
- data/lib/xbim_aim/api/issues_api.rb +690 -0
- data/lib/xbim_aim/api/jobs_api.rb +690 -0
- data/lib/xbim_aim/api/levels_api.rb +690 -0
- data/lib/xbim_aim/api/logs_api.rb +90 -0
- data/lib/xbim_aim/api/model_files_api.rb +219 -0
- data/lib/xbim_aim/api/model_mapping_api.rb +203 -0
- data/lib/xbim_aim/api/models_api.rb +1308 -0
- data/lib/xbim_aim/api/resources_api.rb +690 -0
- data/lib/xbim_aim/api/schedules_api.rb +496 -0
- data/lib/xbim_aim/api/sites_api.rb +690 -0
- data/lib/xbim_aim/api/spaces_api.rb +803 -0
- data/lib/xbim_aim/api/spares_api.rb +690 -0
- data/lib/xbim_aim/api/stats_api.rb +170 -0
- data/lib/xbim_aim/api/systems_api.rb +690 -0
- data/lib/xbim_aim/api/thumbnails_api.rb +182 -0
- data/lib/xbim_aim/api/wexbim_api.rb +849 -0
- data/lib/xbim_aim/api/zones_api.rb +690 -0
- data/lib/xbim_aim/api_client.rb +390 -0
- data/lib/xbim_aim/api_error.rb +57 -0
- data/lib/xbim_aim/configuration.rb +278 -0
- data/lib/xbim_aim/models/application.rb +277 -0
- data/lib/xbim_aim/models/assembly_diagnostics.rb +299 -0
- data/lib/xbim_aim/models/assembly_info.rb +308 -0
- data/lib/xbim_aim/models/assembly_item.rb +454 -0
- data/lib/xbim_aim/models/asset.rb +339 -0
- data/lib/xbim_aim/models/asset_create.rb +268 -0
- data/lib/xbim_aim/models/asset_edit.rb +263 -0
- data/lib/xbim_aim/models/asset_segment.rb +304 -0
- data/lib/xbim_aim/models/attribute_definition.rb +354 -0
- data/lib/xbim_aim/models/attribute_definition_create.rb +338 -0
- data/lib/xbim_aim/models/attribute_definition_edit.rb +288 -0
- data/lib/xbim_aim/models/attribute_definition_entity.rb +392 -0
- data/lib/xbim_aim/models/attribute_value.rb +333 -0
- data/lib/xbim_aim/models/attribute_value_entity.rb +272 -0
- data/lib/xbim_aim/models/cell.rb +236 -0
- data/lib/xbim_aim/models/classification_node.rb +254 -0
- data/lib/xbim_aim/models/column_definition.rb +297 -0
- data/lib/xbim_aim/models/complex_value_base.rb +261 -0
- data/lib/xbim_aim/models/component.rb +535 -0
- data/lib/xbim_aim/models/component_create.rb +283 -0
- data/lib/xbim_aim/models/component_edit.rb +248 -0
- data/lib/xbim_aim/models/component_info.rb +326 -0
- data/lib/xbim_aim/models/component_type.rb +498 -0
- data/lib/xbim_aim/models/component_type_info.rb +308 -0
- data/lib/xbim_aim/models/contact.rb +443 -0
- data/lib/xbim_aim/models/contact_entity.rb +333 -0
- data/lib/xbim_aim/models/contact_info.rb +308 -0
- data/lib/xbim_aim/models/db_update.rb +227 -0
- data/lib/xbim_aim/models/document.rb +421 -0
- data/lib/xbim_aim/models/document_create.rb +345 -0
- data/lib/xbim_aim/models/document_edit.rb +310 -0
- data/lib/xbim_aim/models/document_info.rb +308 -0
- data/lib/xbim_aim/models/entity.rb +421 -0
- data/lib/xbim_aim/models/entity_base.rb +308 -0
- data/lib/xbim_aim/models/entity_contact.rb +333 -0
- data/lib/xbim_aim/models/entity_create.rb +274 -0
- data/lib/xbim_aim/models/entity_edit.rb +239 -0
- data/lib/xbim_aim/models/entity_mapping_info.rb +299 -0
- data/lib/xbim_aim/models/entity_match_descriptor.rb +245 -0
- data/lib/xbim_aim/models/entity_match_info.rb +238 -0
- data/lib/xbim_aim/models/entity_ref.rb +281 -0
- data/lib/xbim_aim/models/facility.rb +432 -0
- data/lib/xbim_aim/models/facility_info.rb +308 -0
- data/lib/xbim_aim/models/file_upload_result.rb +300 -0
- data/lib/xbim_aim/models/footprint.rb +254 -0
- data/lib/xbim_aim/models/i_metered_resource.rb +254 -0
- data/lib/xbim_aim/models/ifc_type.rb +247 -0
- data/lib/xbim_aim/models/inline_object.rb +294 -0
- data/lib/xbim_aim/models/inline_object1.rb +294 -0
- data/lib/xbim_aim/models/inline_object2.rb +220 -0
- data/lib/xbim_aim/models/inline_object3.rb +223 -0
- data/lib/xbim_aim/models/inline_object4.rb +294 -0
- data/lib/xbim_aim/models/inline_object5.rb +294 -0
- data/lib/xbim_aim/models/issue.rb +443 -0
- data/lib/xbim_aim/models/issue_info.rb +308 -0
- data/lib/xbim_aim/models/job.rb +483 -0
- data/lib/xbim_aim/models/job_create.rb +283 -0
- data/lib/xbim_aim/models/job_edit.rb +248 -0
- data/lib/xbim_aim/models/job_info.rb +308 -0
- data/lib/xbim_aim/models/level.rb +463 -0
- data/lib/xbim_aim/models/level_create.rb +274 -0
- data/lib/xbim_aim/models/level_edit.rb +239 -0
- data/lib/xbim_aim/models/level_info.rb +308 -0
- data/lib/xbim_aim/models/mapping_message_info.rb +281 -0
- data/lib/xbim_aim/models/mapping_properties.rb +227 -0
- data/lib/xbim_aim/models/member_permission.rb +292 -0
- data/lib/xbim_aim/models/member_role.rb +320 -0
- data/lib/xbim_aim/models/model.rb +617 -0
- data/lib/xbim_aim/models/model_create.rb +318 -0
- data/lib/xbim_aim/models/model_edit.rb +284 -0
- data/lib/xbim_aim/models/model_info.rb +380 -0
- data/lib/xbim_aim/models/model_mapping.rb +363 -0
- data/lib/xbim_aim/models/model_mapping_report.rb +354 -0
- data/lib/xbim_aim/models/o_data_list_response_of_application.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_assembly_diagnostics.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_assembly_item.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_asset.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_attribute_definition.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_attribute_definition_entity.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_attribute_value.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_complex_value_base.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_component.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_component_type.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_contact.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_document.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_entity.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_entity_ref.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_facility.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_issue.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_job.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_level.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_member_permission.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_model.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_model_mapping.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_model_mapping_report.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_resource.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_role.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_row.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_schedule.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_site.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_space.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_spare.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_system_item.rb +247 -0
- data/lib/xbim_aim/models/o_data_list_response_of_zone.rb +247 -0
- data/lib/xbim_aim/models/o_data_response_of_boolean.rb +227 -0
- data/lib/xbim_aim/models/quota_status.rb +300 -0
- data/lib/xbim_aim/models/related_entity.rb +432 -0
- data/lib/xbim_aim/models/resource.rb +443 -0
- data/lib/xbim_aim/models/resource_info.rb +308 -0
- data/lib/xbim_aim/models/role.rb +331 -0
- data/lib/xbim_aim/models/role_member.rb +279 -0
- data/lib/xbim_aim/models/row.rb +229 -0
- data/lib/xbim_aim/models/schedule.rb +258 -0
- data/lib/xbim_aim/models/site.rb +432 -0
- data/lib/xbim_aim/models/space.rb +491 -0
- data/lib/xbim_aim/models/space_create.rb +283 -0
- data/lib/xbim_aim/models/space_edit.rb +248 -0
- data/lib/xbim_aim/models/space_info.rb +326 -0
- data/lib/xbim_aim/models/spare.rb +450 -0
- data/lib/xbim_aim/models/spare_create.rb +283 -0
- data/lib/xbim_aim/models/spare_edit.rb +248 -0
- data/lib/xbim_aim/models/spare_info.rb +308 -0
- data/lib/xbim_aim/models/system_info.rb +319 -0
- data/lib/xbim_aim/models/system_item.rb +454 -0
- data/lib/xbim_aim/models/user_permissions.rb +275 -0
- data/lib/xbim_aim/models/value_container.rb +308 -0
- data/lib/xbim_aim/models/zone.rb +454 -0
- data/lib/xbim_aim/models/zone_info.rb +308 -0
- data/lib/xbim_aim/version.rb +15 -0
- data/lib/xbim_aim.rb +197 -0
- data/spec/api/admin_api_spec.rb +95 -0
- data/spec/api/applications_api_spec.rb +71 -0
- data/spec/api/assemblies_api_spec.rb +160 -0
- data/spec/api/assets_api_spec.rb +203 -0
- data/spec/api/attributes_api_spec.rb +177 -0
- data/spec/api/component_types_api_spec.rb +160 -0
- data/spec/api/components_api_spec.rb +184 -0
- data/spec/api/contacts_api_spec.rb +160 -0
- data/spec/api/diagnostics_api_spec.rb +54 -0
- data/spec/api/document_files_api_spec.rb +69 -0
- data/spec/api/documents_api_spec.rb +160 -0
- data/spec/api/entities_api_spec.rb +203 -0
- data/spec/api/facilities_api_spec.rb +160 -0
- data/spec/api/issues_api_spec.rb +160 -0
- data/spec/api/jobs_api_spec.rb +160 -0
- data/spec/api/levels_api_spec.rb +160 -0
- data/spec/api/logs_api_spec.rb +47 -0
- data/spec/api/model_files_api_spec.rb +71 -0
- data/spec/api/model_mapping_api_spec.rb +71 -0
- data/spec/api/models_api_spec.rb +273 -0
- data/spec/api/resources_api_spec.rb +160 -0
- data/spec/api/schedules_api_spec.rb +126 -0
- data/spec/api/sites_api_spec.rb +160 -0
- data/spec/api/spaces_api_spec.rb +184 -0
- data/spec/api/spares_api_spec.rb +160 -0
- data/spec/api/stats_api_spec.rb +61 -0
- data/spec/api/systems_api_spec.rb +160 -0
- data/spec/api/thumbnails_api_spec.rb +63 -0
- data/spec/api/wexbim_api_spec.rb +175 -0
- data/spec/api/zones_api_spec.rb +160 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/application_spec.rb +70 -0
- data/spec/models/assembly_diagnostics_spec.rb +88 -0
- data/spec/models/assembly_info_spec.rb +94 -0
- data/spec/models/assembly_item_spec.rb +178 -0
- data/spec/models/asset_create_spec.rb +44 -0
- data/spec/models/asset_edit_spec.rb +44 -0
- data/spec/models/asset_segment_spec.rb +88 -0
- data/spec/models/asset_spec.rb +92 -0
- data/spec/models/attribute_definition_create_spec.rb +78 -0
- data/spec/models/attribute_definition_edit_spec.rb +62 -0
- data/spec/models/attribute_definition_entity_spec.rb +126 -0
- data/spec/models/attribute_definition_spec.rb +102 -0
- data/spec/models/attribute_value_entity_spec.rb +70 -0
- data/spec/models/attribute_value_spec.rb +92 -0
- data/spec/models/cell_spec.rb +46 -0
- data/spec/models/classification_node_spec.rb +58 -0
- data/spec/models/column_definition_spec.rb +68 -0
- data/spec/models/complex_value_base_spec.rb +44 -0
- data/spec/models/component_create_spec.rb +70 -0
- data/spec/models/component_edit_spec.rb +52 -0
- data/spec/models/component_info_spec.rb +106 -0
- data/spec/models/component_spec.rb +226 -0
- data/spec/models/component_type_info_spec.rb +94 -0
- data/spec/models/component_type_spec.rb +202 -0
- data/spec/models/contact_entity_spec.rb +92 -0
- data/spec/models/contact_info_spec.rb +94 -0
- data/spec/models/contact_spec.rb +172 -0
- data/spec/models/db_update_spec.rb +40 -0
- data/spec/models/document_create_spec.rb +106 -0
- data/spec/models/document_edit_spec.rb +88 -0
- data/spec/models/document_info_spec.rb +94 -0
- data/spec/models/document_spec.rb +160 -0
- data/spec/models/entity_base_spec.rb +94 -0
- data/spec/models/entity_contact_spec.rb +92 -0
- data/spec/models/entity_create_spec.rb +64 -0
- data/spec/models/entity_edit_spec.rb +46 -0
- data/spec/models/entity_mapping_info_spec.rb +88 -0
- data/spec/models/entity_match_descriptor_spec.rb +52 -0
- data/spec/models/entity_match_info_spec.rb +46 -0
- data/spec/models/entity_ref_spec.rb +76 -0
- data/spec/models/entity_spec.rb +160 -0
- data/spec/models/facility_info_spec.rb +94 -0
- data/spec/models/facility_spec.rb +166 -0
- data/spec/models/file_upload_result_spec.rb +82 -0
- data/spec/models/footprint_spec.rb +58 -0
- data/spec/models/i_metered_resource_spec.rb +58 -0
- data/spec/models/ifc_type_spec.rb +52 -0
- data/spec/models/inline_object1_spec.rb +56 -0
- data/spec/models/inline_object2_spec.rb +34 -0
- data/spec/models/inline_object3_spec.rb +34 -0
- data/spec/models/inline_object4_spec.rb +56 -0
- data/spec/models/inline_object5_spec.rb +56 -0
- data/spec/models/inline_object_spec.rb +56 -0
- data/spec/models/issue_info_spec.rb +94 -0
- data/spec/models/issue_spec.rb +172 -0
- data/spec/models/job_create_spec.rb +70 -0
- data/spec/models/job_edit_spec.rb +52 -0
- data/spec/models/job_info_spec.rb +94 -0
- data/spec/models/job_spec.rb +196 -0
- data/spec/models/level_create_spec.rb +64 -0
- data/spec/models/level_edit_spec.rb +46 -0
- data/spec/models/level_info_spec.rb +94 -0
- data/spec/models/level_spec.rb +184 -0
- data/spec/models/mapping_message_info_spec.rb +76 -0
- data/spec/models/mapping_properties_spec.rb +40 -0
- data/spec/models/member_permission_spec.rb +66 -0
- data/spec/models/member_role_spec.rb +82 -0
- data/spec/models/model_create_spec.rb +68 -0
- data/spec/models/model_edit_spec.rb +56 -0
- data/spec/models/model_info_spec.rb +142 -0
- data/spec/models/model_mapping_report_spec.rb +118 -0
- data/spec/models/model_mapping_spec.rb +124 -0
- data/spec/models/model_spec.rb +260 -0
- data/spec/models/o_data_list_response_of_application_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_assembly_diagnostics_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_assembly_item_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_asset_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_attribute_definition_entity_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_attribute_definition_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_attribute_value_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_complex_value_base_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_component_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_component_type_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_contact_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_document_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_entity_ref_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_entity_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_facility_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_issue_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_job_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_level_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_member_permission_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_model_mapping_report_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_model_mapping_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_model_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_resource_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_role_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_row_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_schedule_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_site_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_space_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_spare_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_system_item_spec.rb +52 -0
- data/spec/models/o_data_list_response_of_zone_spec.rb +52 -0
- data/spec/models/o_data_response_of_boolean_spec.rb +40 -0
- data/spec/models/quota_status_spec.rb +66 -0
- data/spec/models/related_entity_spec.rb +166 -0
- data/spec/models/resource_info_spec.rb +94 -0
- data/spec/models/resource_spec.rb +172 -0
- data/spec/models/role_member_spec.rb +56 -0
- data/spec/models/role_spec.rb +88 -0
- data/spec/models/row_spec.rb +40 -0
- data/spec/models/schedule_spec.rb +58 -0
- data/spec/models/site_spec.rb +166 -0
- data/spec/models/space_create_spec.rb +70 -0
- data/spec/models/space_edit_spec.rb +52 -0
- data/spec/models/space_info_spec.rb +106 -0
- data/spec/models/space_spec.rb +202 -0
- data/spec/models/spare_create_spec.rb +70 -0
- data/spec/models/spare_edit_spec.rb +52 -0
- data/spec/models/spare_info_spec.rb +94 -0
- data/spec/models/spare_spec.rb +178 -0
- data/spec/models/system_info_spec.rb +100 -0
- data/spec/models/system_item_spec.rb +178 -0
- data/spec/models/user_permissions_spec.rb +56 -0
- data/spec/models/value_container_spec.rb +78 -0
- data/spec/models/zone_info_spec.rb +94 -0
- data/spec/models/zone_spec.rb +178 -0
- data/spec/spec_helper.rb +111 -0
- data/xbim_aim-1.0.0.gem +0 -0
- data/xbim_aim.gemspec +38 -0
- metadata +413 -0
@@ -0,0 +1,390 @@
|
|
1
|
+
=begin
|
2
|
+
#XBIM Flex API v2
|
3
|
+
|
4
|
+
#This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
|
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 XbimAim
|
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 = XbimAim.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
|
@@ -0,0 +1,57 @@
|
|
1
|
+
=begin
|
2
|
+
#XBIM Flex API v2
|
3
|
+
|
4
|
+
#This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
|
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
|
+
module XbimAim
|
14
|
+
class ApiError < StandardError
|
15
|
+
attr_reader :code, :response_headers, :response_body
|
16
|
+
|
17
|
+
# Usage examples:
|
18
|
+
# ApiError.new
|
19
|
+
# ApiError.new("message")
|
20
|
+
# ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
|
21
|
+
# ApiError.new(:code => 404, :message => "Not Found")
|
22
|
+
def initialize(arg = nil)
|
23
|
+
if arg.is_a? Hash
|
24
|
+
if arg.key?(:message) || arg.key?('message')
|
25
|
+
super(arg[:message] || arg['message'])
|
26
|
+
else
|
27
|
+
super arg
|
28
|
+
end
|
29
|
+
|
30
|
+
arg.each do |k, v|
|
31
|
+
instance_variable_set "@#{k}", v
|
32
|
+
end
|
33
|
+
else
|
34
|
+
super arg
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
# Override to_s to display a friendly error message
|
39
|
+
def to_s
|
40
|
+
message
|
41
|
+
end
|
42
|
+
|
43
|
+
def message
|
44
|
+
if @message.nil?
|
45
|
+
msg = "Error message: the server returns an error"
|
46
|
+
else
|
47
|
+
msg = @message
|
48
|
+
end
|
49
|
+
|
50
|
+
msg += "\nHTTP status code: #{code}" if code
|
51
|
+
msg += "\nResponse headers: #{response_headers}" if response_headers
|
52
|
+
msg += "\nResponse body: #{response_body}" if response_body
|
53
|
+
|
54
|
+
msg
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|