ddr_client 2.0.0.d9f2bd2b

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 (120) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +168 -0
  4. data/Rakefile +8 -0
  5. data/ddr_client.gemspec +46 -0
  6. data/docs/BatchObjectsApi.md +125 -0
  7. data/docs/BatchesApi.md +305 -0
  8. data/docs/DdrAPIBatchEntity.md +24 -0
  9. data/docs/DdrAPIBatchEntityLogfile.md +11 -0
  10. data/docs/DdrAPIBatchObjectAttributeEntity.md +16 -0
  11. data/docs/DdrAPIBatchObjectDatastreamEntity.md +17 -0
  12. data/docs/DdrAPIBatchObjectEntity.md +26 -0
  13. data/docs/DdrAPIBatchObjectMessageEntity.md +13 -0
  14. data/docs/DdrAPIBatchObjectRelationshipEntity.md +15 -0
  15. data/docs/DdrAPIBatchObjectRoleEntity.md +15 -0
  16. data/docs/DdrAPIEventEntity.md +17 -0
  17. data/docs/DdrAPIFileEntity.md +11 -0
  18. data/docs/DdrAPIGroupEntity.md +10 -0
  19. data/docs/DdrAPIGroupMemberEntity.md +10 -0
  20. data/docs/DdrAPILinkEntity.md +9 -0
  21. data/docs/DdrAPIResourceEntity.md +17 -0
  22. data/docs/DdrAPIResourceEntityFiles.md +17 -0
  23. data/docs/DdrAPIResourceEntityMetadata.md +62 -0
  24. data/docs/DdrAPIResourceEntityRelated.md +11 -0
  25. data/docs/DdrAPIRoleEntity.md +10 -0
  26. data/docs/DdrAPITechnicalMetadataEntity.md +24 -0
  27. data/docs/DdrAPIUserEntity.md +19 -0
  28. data/docs/EventsApi.md +131 -0
  29. data/docs/GroupsApi.md +63 -0
  30. data/docs/IndexApi.md +161 -0
  31. data/docs/PatchResources.md +11 -0
  32. data/docs/PatchResourcesMetadata.md +62 -0
  33. data/docs/PatchResourcesRelated.md +11 -0
  34. data/docs/PatchResourcesRoles.md +10 -0
  35. data/docs/PostResources.md +12 -0
  36. data/docs/QueuesApi.md +102 -0
  37. data/docs/ReportsApi.md +177 -0
  38. data/docs/ResourcesApi.md +1003 -0
  39. data/docs/SchemaApi.md +128 -0
  40. data/docs/UsersApi.md +131 -0
  41. data/git_push.sh +55 -0
  42. data/lib/ddr_client/api/batch_objects_api.rb +138 -0
  43. data/lib/ddr_client/api/batches_api.rb +306 -0
  44. data/lib/ddr_client/api/events_api.rb +147 -0
  45. data/lib/ddr_client/api/groups_api.rb +70 -0
  46. data/lib/ddr_client/api/index_api.rb +164 -0
  47. data/lib/ddr_client/api/queues_api.rb +109 -0
  48. data/lib/ddr_client/api/reports_api.rb +179 -0
  49. data/lib/ddr_client/api/resources_api.rb +1098 -0
  50. data/lib/ddr_client/api/schema_api.rb +152 -0
  51. data/lib/ddr_client/api/users_api.rb +141 -0
  52. data/lib/ddr_client/api_client.rb +391 -0
  53. data/lib/ddr_client/api_error.rb +38 -0
  54. data/lib/ddr_client/configuration.rb +209 -0
  55. data/lib/ddr_client/models/ddr_api_batch_entity.rb +333 -0
  56. data/lib/ddr_client/models/ddr_api_batch_entity_logfile.rb +211 -0
  57. data/lib/ddr_client/models/ddr_api_batch_object_attribute_entity.rb +256 -0
  58. data/lib/ddr_client/models/ddr_api_batch_object_datastream_entity.rb +265 -0
  59. data/lib/ddr_client/models/ddr_api_batch_object_entity.rb +349 -0
  60. data/lib/ddr_client/models/ddr_api_batch_object_message_entity.rb +230 -0
  61. data/lib/ddr_client/models/ddr_api_batch_object_relationship_entity.rb +247 -0
  62. data/lib/ddr_client/models/ddr_api_batch_object_role_entity.rb +247 -0
  63. data/lib/ddr_client/models/ddr_api_event_entity.rb +325 -0
  64. data/lib/ddr_client/models/ddr_api_file_entity.rb +215 -0
  65. data/lib/ddr_client/models/ddr_api_group_entity.rb +203 -0
  66. data/lib/ddr_client/models/ddr_api_group_member_entity.rb +202 -0
  67. data/lib/ddr_client/models/ddr_api_link_entity.rb +193 -0
  68. data/lib/ddr_client/models/ddr_api_resource_entity.rb +310 -0
  69. data/lib/ddr_client/models/ddr_api_resource_entity_files.rb +276 -0
  70. data/lib/ddr_client/models/ddr_api_resource_entity_metadata.rb +874 -0
  71. data/lib/ddr_client/models/ddr_api_resource_entity_related.rb +216 -0
  72. data/lib/ddr_client/models/ddr_api_role_entity.rb +251 -0
  73. data/lib/ddr_client/models/ddr_api_technical_metadata_entity.rb +329 -0
  74. data/lib/ddr_client/models/ddr_api_user_entity.rb +296 -0
  75. data/lib/ddr_client/models/patch_resources.rb +221 -0
  76. data/lib/ddr_client/models/patch_resources_metadata.rb +726 -0
  77. data/lib/ddr_client/models/patch_resources_related.rb +216 -0
  78. data/lib/ddr_client/models/patch_resources_roles.rb +220 -0
  79. data/lib/ddr_client/models/post_resources.rb +265 -0
  80. data/lib/ddr_client/version.rb +15 -0
  81. data/lib/ddr_client.rb +74 -0
  82. data/spec/api/batch_objects_api_spec.rb +61 -0
  83. data/spec/api/batches_api_spec.rb +100 -0
  84. data/spec/api/events_api_spec.rb +64 -0
  85. data/spec/api/groups_api_spec.rb +46 -0
  86. data/spec/api/index_api_spec.rb +67 -0
  87. data/spec/api/queues_api_spec.rb +55 -0
  88. data/spec/api/reports_api_spec.rb +70 -0
  89. data/spec/api/resources_api_spec.rb +271 -0
  90. data/spec/api/schema_api_spec.rb +65 -0
  91. data/spec/api/users_api_spec.rb +64 -0
  92. data/spec/api_client_spec.rb +243 -0
  93. data/spec/configuration_spec.rb +42 -0
  94. data/spec/models/ddr_api_batch_entity_logfile_spec.rb +59 -0
  95. data/spec/models/ddr_api_batch_entity_spec.rb +137 -0
  96. data/spec/models/ddr_api_batch_object_attribute_entity_spec.rb +89 -0
  97. data/spec/models/ddr_api_batch_object_datastream_entity_spec.rb +95 -0
  98. data/spec/models/ddr_api_batch_object_entity_spec.rb +149 -0
  99. data/spec/models/ddr_api_batch_object_message_entity_spec.rb +71 -0
  100. data/spec/models/ddr_api_batch_object_relationship_entity_spec.rb +83 -0
  101. data/spec/models/ddr_api_batch_object_role_entity_spec.rb +83 -0
  102. data/spec/models/ddr_api_event_entity_spec.rb +103 -0
  103. data/spec/models/ddr_api_file_entity_spec.rb +59 -0
  104. data/spec/models/ddr_api_group_entity_spec.rb +53 -0
  105. data/spec/models/ddr_api_group_member_entity_spec.rb +53 -0
  106. data/spec/models/ddr_api_link_entity_spec.rb +47 -0
  107. data/spec/models/ddr_api_resource_entity_files_spec.rb +95 -0
  108. data/spec/models/ddr_api_resource_entity_metadata_spec.rb +389 -0
  109. data/spec/models/ddr_api_resource_entity_related_spec.rb +59 -0
  110. data/spec/models/ddr_api_resource_entity_spec.rb +99 -0
  111. data/spec/models/ddr_api_role_entity_spec.rb +61 -0
  112. data/spec/models/ddr_api_technical_metadata_entity_spec.rb +137 -0
  113. data/spec/models/ddr_api_user_entity_spec.rb +107 -0
  114. data/spec/models/patch_resources_metadata_spec.rb +365 -0
  115. data/spec/models/patch_resources_related_spec.rb +59 -0
  116. data/spec/models/patch_resources_roles_spec.rb +53 -0
  117. data/spec/models/patch_resources_spec.rb +59 -0
  118. data/spec/models/post_resources_spec.rb +69 -0
  119. data/spec/spec_helper.rb +111 -0
  120. metadata +399 -0
@@ -0,0 +1,152 @@
1
+ =begin
2
+ #Duke Digital Repository API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.36
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module DdrClient
16
+ class SchemaApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Event schema
23
+ # @param [Hash] opts the optional parameters
24
+ # @return [nil]
25
+ def get_schema_event(opts = {})
26
+ get_schema_event_with_http_info(opts)
27
+ nil
28
+ end
29
+
30
+ # Event schema
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
33
+ def get_schema_event_with_http_info(opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: SchemaApi.get_schema_event ...'
36
+ end
37
+ # resource path
38
+ local_var_path = '/schema/event'
39
+
40
+ # query parameters
41
+ query_params = {}
42
+
43
+ # header parameters
44
+ header_params = {}
45
+ # HTTP header 'Accept' (if needed)
46
+ header_params['Accept'] = @api_client.select_header_accept(['application/schema+json'])
47
+
48
+ # form parameters
49
+ form_params = {}
50
+
51
+ # http body (model)
52
+ post_body = nil
53
+ auth_names = []
54
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
55
+ :header_params => header_params,
56
+ :query_params => query_params,
57
+ :form_params => form_params,
58
+ :body => post_body,
59
+ :auth_names => auth_names)
60
+ if @api_client.config.debugging
61
+ @api_client.config.logger.debug "API called: SchemaApi#get_schema_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
62
+ end
63
+ return data, status_code, headers
64
+ end
65
+ # Resource schema
66
+ # @param [Hash] opts the optional parameters
67
+ # @return [nil]
68
+ def get_schema_resource(opts = {})
69
+ get_schema_resource_with_http_info(opts)
70
+ nil
71
+ end
72
+
73
+ # Resource schema
74
+ # @param [Hash] opts the optional parameters
75
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
76
+ def get_schema_resource_with_http_info(opts = {})
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug 'Calling API: SchemaApi.get_schema_resource ...'
79
+ end
80
+ # resource path
81
+ local_var_path = '/schema/resource'
82
+
83
+ # query parameters
84
+ query_params = {}
85
+
86
+ # header parameters
87
+ header_params = {}
88
+ # HTTP header 'Accept' (if needed)
89
+ header_params['Accept'] = @api_client.select_header_accept(['application/schema+json'])
90
+
91
+ # form parameters
92
+ form_params = {}
93
+
94
+ # http body (model)
95
+ post_body = nil
96
+ auth_names = []
97
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
98
+ :header_params => header_params,
99
+ :query_params => query_params,
100
+ :form_params => form_params,
101
+ :body => post_body,
102
+ :auth_names => auth_names)
103
+ if @api_client.config.debugging
104
+ @api_client.config.logger.debug "API called: SchemaApi#get_schema_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
105
+ end
106
+ return data, status_code, headers
107
+ end
108
+ # User schema
109
+ # @param [Hash] opts the optional parameters
110
+ # @return [nil]
111
+ def get_schema_user(opts = {})
112
+ get_schema_user_with_http_info(opts)
113
+ nil
114
+ end
115
+
116
+ # User schema
117
+ # @param [Hash] opts the optional parameters
118
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
119
+ def get_schema_user_with_http_info(opts = {})
120
+ if @api_client.config.debugging
121
+ @api_client.config.logger.debug 'Calling API: SchemaApi.get_schema_user ...'
122
+ end
123
+ # resource path
124
+ local_var_path = '/schema/user'
125
+
126
+ # query parameters
127
+ query_params = {}
128
+
129
+ # header parameters
130
+ header_params = {}
131
+ # HTTP header 'Accept' (if needed)
132
+ header_params['Accept'] = @api_client.select_header_accept(['application/schema+json'])
133
+
134
+ # form parameters
135
+ form_params = {}
136
+
137
+ # http body (model)
138
+ post_body = nil
139
+ auth_names = []
140
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names)
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "API called: SchemaApi#get_schema_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ end
149
+ return data, status_code, headers
150
+ end
151
+ end
152
+ end
@@ -0,0 +1,141 @@
1
+ =begin
2
+ #Duke Digital Repository API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.36
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module DdrClient
16
+ class UsersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # List users
23
+ # @param [Hash] opts the optional parameters
24
+ # @option opts [String] :username User Name
25
+ # @option opts [String] :netid Duke NetID
26
+ # @option opts [String] :duid Duke Unique ID
27
+ # @option opts [String] :email Email Address
28
+ # @option opts [String] :first_name First Name
29
+ # @option opts [String] :last_name Last Name
30
+ # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
31
+ # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
32
+ # @return [Array<DdrAPIUserEntity>]
33
+ def get_users(opts = {})
34
+ data, _status_code, _headers = get_users_with_http_info(opts)
35
+ data
36
+ end
37
+
38
+ # List users
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [String] :username User Name
41
+ # @option opts [String] :netid Duke NetID
42
+ # @option opts [String] :duid Duke Unique ID
43
+ # @option opts [String] :email Email Address
44
+ # @option opts [String] :first_name First Name
45
+ # @option opts [String] :last_name Last Name
46
+ # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
47
+ # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
48
+ # @return [Array<(Array<DdrAPIUserEntity>, Fixnum, Hash)>] Array<DdrAPIUserEntity> data, response status code and response headers
49
+ def get_users_with_http_info(opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug 'Calling API: UsersApi.get_users ...'
52
+ end
53
+ # resource path
54
+ local_var_path = '/users'
55
+
56
+ # query parameters
57
+ query_params = {}
58
+ query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
59
+ query_params[:'netid'] = opts[:'netid'] if !opts[:'netid'].nil?
60
+ query_params[:'duid'] = opts[:'duid'] if !opts[:'duid'].nil?
61
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
62
+ query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
63
+ query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
64
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
65
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
66
+
67
+ # header parameters
68
+ header_params = {}
69
+ # HTTP header 'Accept' (if needed)
70
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv'])
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+ auth_names = ['oauth']
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'Array<DdrAPIUserEntity>')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+ # Retrieve a user record
91
+ # @param id
92
+ # @param [Hash] opts the optional parameters
93
+ # @return [DdrAPIUserEntity]
94
+ def get_users_id(id, opts = {})
95
+ data, _status_code, _headers = get_users_id_with_http_info(id, opts)
96
+ data
97
+ end
98
+
99
+ # Retrieve a user record
100
+ # @param id
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [Array<(DdrAPIUserEntity, Fixnum, Hash)>] DdrAPIUserEntity data, response status code and response headers
103
+ def get_users_id_with_http_info(id, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: UsersApi.get_users_id ...'
106
+ end
107
+ # verify the required parameter 'id' is set
108
+ if @api_client.config.client_side_validation && id.nil?
109
+ fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_users_id"
110
+ end
111
+ # resource path
112
+ local_var_path = '/users/{id}'.sub('{' + 'id' + '}', id.to_s)
113
+
114
+ # query parameters
115
+ query_params = {}
116
+
117
+ # header parameters
118
+ header_params = {}
119
+ # HTTP header 'Accept' (if needed)
120
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
121
+
122
+ # form parameters
123
+ form_params = {}
124
+
125
+ # http body (model)
126
+ post_body = nil
127
+ auth_names = ['oauth']
128
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
129
+ :header_params => header_params,
130
+ :query_params => query_params,
131
+ :form_params => form_params,
132
+ :body => post_body,
133
+ :auth_names => auth_names,
134
+ :return_type => 'DdrAPIUserEntity')
135
+ if @api_client.config.debugging
136
+ @api_client.config.logger.debug "API called: UsersApi#get_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
137
+ end
138
+ return data, status_code, headers
139
+ end
140
+ end
141
+ end
@@ -0,0 +1,391 @@
1
+ =begin
2
+ #Duke Digital Repository API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.36
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'typhoeus'
18
+ require 'addressable/uri'
19
+
20
+ module DdrClient
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.to_h,
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
+ req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
116
+
117
+ # set custom cert, if provided
118
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
119
+
120
+ if [:post, :patch, :put, :delete].include?(http_method)
121
+ req_body = build_request_body(header_params, form_params, opts[:body])
122
+ req_opts.update :body => req_body
123
+ if @config.debugging
124
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
125
+ end
126
+ end
127
+
128
+ request = Typhoeus::Request.new(url, req_opts)
129
+ download_file(request) if opts[:return_type] == 'File'
130
+ request
131
+ end
132
+
133
+ # Check if the given MIME is a JSON MIME.
134
+ # JSON MIME examples:
135
+ # application/json
136
+ # application/json; charset=UTF8
137
+ # APPLICATION/JSON
138
+ # */*
139
+ # @param [String] mime MIME
140
+ # @return [Boolean] True if the MIME is application/json
141
+ def json_mime?(mime)
142
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
143
+ end
144
+
145
+ # Deserialize the response to the given return type.
146
+ #
147
+ # @param [Response] response HTTP response
148
+ # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
149
+ def deserialize(response, return_type)
150
+ body = response.body
151
+
152
+ # handle file downloading - return the File instance processed in request callbacks
153
+ # note that response body is empty when the file is written in chunks in request on_body callback
154
+ return @tempfile if return_type == 'File'
155
+
156
+ return nil if body.nil? || body.empty?
157
+
158
+ # return response body directly for String return type
159
+ return body if return_type == 'String'
160
+
161
+ # ensuring a default content type
162
+ content_type = response.headers['Content-Type'] || 'application/json'
163
+
164
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
165
+
166
+ begin
167
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
168
+ rescue JSON::ParserError => e
169
+ if %w(String Date DateTime).include?(return_type)
170
+ data = body
171
+ else
172
+ raise e
173
+ end
174
+ end
175
+
176
+ convert_to_type data, return_type
177
+ end
178
+
179
+ # Convert data to the given return type.
180
+ # @param [Object] data Data to be converted
181
+ # @param [String] return_type Return type
182
+ # @return [Mixed] Data in a particular type
183
+ def convert_to_type(data, return_type)
184
+ return nil if data.nil?
185
+ case return_type
186
+ when 'String'
187
+ data.to_s
188
+ when 'Integer'
189
+ data.to_i
190
+ when 'Float'
191
+ data.to_f
192
+ when 'BOOLEAN'
193
+ data == true
194
+ when 'DateTime'
195
+ # parse date time (expecting ISO 8601 format)
196
+ DateTime.parse data
197
+ when 'Date'
198
+ # parse date time (expecting ISO 8601 format)
199
+ Date.parse data
200
+ when 'Object'
201
+ # generic object (usually a Hash), return directly
202
+ data
203
+ when /\AArray<(.+)>\z/
204
+ # e.g. Array<Pet>
205
+ sub_type = $1
206
+ data.map { |item| convert_to_type(item, sub_type) }
207
+ when /\AHash\<String, (.+)\>\z/
208
+ # e.g. Hash<String, Integer>
209
+ sub_type = $1
210
+ {}.tap do |hash|
211
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
212
+ end
213
+ else
214
+ # models, e.g. Pet
215
+ DdrClient.const_get(return_type).new.tap do |model|
216
+ model.build_from_hash data
217
+ end
218
+ end
219
+ end
220
+
221
+ # Save response body into a file in (the defined) temporary folder, using the filename
222
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
223
+ # The response body is written to the file in chunks in order to handle files which
224
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
225
+ # process can use.
226
+ #
227
+ # @see Configuration#temp_folder_path
228
+ def download_file(request)
229
+ tempfile = nil
230
+ encoding = nil
231
+ request.on_headers do |response|
232
+ content_disposition = response.headers['Content-Disposition']
233
+ if content_disposition && content_disposition =~ /filename=/i
234
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
235
+ prefix = sanitize_filename(filename)
236
+ else
237
+ prefix = 'download-'
238
+ end
239
+ prefix = prefix + '-' unless prefix.end_with?('-')
240
+ encoding = response.body.encoding
241
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
242
+ @tempfile = tempfile
243
+ end
244
+ request.on_body do |chunk|
245
+ chunk.force_encoding(encoding)
246
+ tempfile.write(chunk)
247
+ end
248
+ request.on_complete do |response|
249
+ tempfile.close
250
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
251
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
252
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
253
+ "explicitly with `tempfile.delete`"
254
+ end
255
+ end
256
+
257
+ # Sanitize filename by removing path.
258
+ # e.g. ../../sun.gif becomes sun.gif
259
+ #
260
+ # @param [String] filename the filename to be sanitized
261
+ # @return [String] the sanitized filename
262
+ def sanitize_filename(filename)
263
+ filename.gsub(/.*[\/\\]/, '')
264
+ end
265
+
266
+ def build_request_url(path)
267
+ # Add leading and trailing slashes to path
268
+ path = "/#{path}".gsub(/\/+/, '/')
269
+ Addressable::URI.encode(@config.base_url + path)
270
+ end
271
+
272
+ # Builds the HTTP request body
273
+ #
274
+ # @param [Hash] header_params Header parameters
275
+ # @param [Hash] form_params Query parameters
276
+ # @param [Object] body HTTP body (JSON/XML)
277
+ # @return [String] HTTP body data in the form of string
278
+ def build_request_body(header_params, form_params, body)
279
+ # http form
280
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
281
+ header_params['Content-Type'] == 'multipart/form-data'
282
+ data = {}
283
+ form_params.each do |key, value|
284
+ case value
285
+ when ::File, ::Array, nil
286
+ # let typhoeus handle File, Array and nil parameters
287
+ data[key] = value
288
+ else
289
+ data[key] = value.to_s
290
+ end
291
+ end
292
+ elsif body
293
+ data = body.is_a?(String) ? body : body.to_json
294
+ else
295
+ data = nil
296
+ end
297
+ data
298
+ end
299
+
300
+ # Update hearder and query params based on authentication settings.
301
+ #
302
+ # @param [Hash] header_params Header parameters
303
+ # @param [Hash] query_params Query parameters
304
+ # @param [String] auth_names Authentication scheme name
305
+ def update_params_for_auth!(header_params, query_params, auth_names)
306
+ Array(auth_names).each do |auth_name|
307
+ auth_setting = @config.auth_settings[auth_name]
308
+ next unless auth_setting
309
+ case auth_setting[:in]
310
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
311
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
312
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
313
+ end
314
+ end
315
+ end
316
+
317
+ # Sets user agent in HTTP header
318
+ #
319
+ # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
320
+ def user_agent=(user_agent)
321
+ @user_agent = user_agent
322
+ @default_headers['User-Agent'] = @user_agent
323
+ end
324
+
325
+ # Return Accept header based on an array of accepts provided.
326
+ # @param [Array] accepts array for Accept
327
+ # @return [String] the Accept header (e.g. application/json)
328
+ def select_header_accept(accepts)
329
+ return nil if accepts.nil? || accepts.empty?
330
+ # use JSON when present, otherwise use all of the provided
331
+ json_accept = accepts.find { |s| json_mime?(s) }
332
+ json_accept || accepts.join(',')
333
+ end
334
+
335
+ # Return Content-Type header based on an array of content types provided.
336
+ # @param [Array] content_types array for Content-Type
337
+ # @return [String] the Content-Type header (e.g. application/json)
338
+ def select_header_content_type(content_types)
339
+ # use application/json by default
340
+ return 'application/json' if content_types.nil? || content_types.empty?
341
+ # use JSON when present, otherwise use the first one
342
+ json_content_type = content_types.find { |s| json_mime?(s) }
343
+ json_content_type || content_types.first
344
+ end
345
+
346
+ # Convert object (array, hash, object, etc) to JSON string.
347
+ # @param [Object] model object to be converted into JSON string
348
+ # @return [String] JSON string representation of the object
349
+ def object_to_http_body(model)
350
+ return model if model.nil? || model.is_a?(String)
351
+ local_body = nil
352
+ if model.is_a?(Array)
353
+ local_body = model.map { |m| object_to_hash(m) }
354
+ else
355
+ local_body = object_to_hash(model)
356
+ end
357
+ local_body.to_json
358
+ end
359
+
360
+ # Convert object(non-array) to hash.
361
+ # @param [Object] obj object to be converted into JSON string
362
+ # @return [String] JSON string representation of the object
363
+ def object_to_hash(obj)
364
+ if obj.respond_to?(:to_hash)
365
+ obj.to_hash
366
+ else
367
+ obj
368
+ end
369
+ end
370
+
371
+ # Build parameter value according to the given collection format.
372
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
373
+ def build_collection_param(param, collection_format)
374
+ case collection_format
375
+ when :csv
376
+ param.join(',')
377
+ when :ssv
378
+ param.join(' ')
379
+ when :tsv
380
+ param.join("\t")
381
+ when :pipes
382
+ param.join('|')
383
+ when :multi
384
+ # return the array directly as typhoeus will handle it as expected
385
+ param
386
+ else
387
+ fail "unknown collection format: #{collection_format.inspect}"
388
+ end
389
+ end
390
+ end
391
+ end