patch_ruby 1.0.0.pre

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 (68) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +10 -0
  3. data/Gemfile.lock +72 -0
  4. data/README.md +54 -0
  5. data/Rakefile +10 -0
  6. data/lib/patch_ruby.rb +61 -0
  7. data/lib/patch_ruby/api/estimates_api.rb +213 -0
  8. data/lib/patch_ruby/api/orders_api.rb +339 -0
  9. data/lib/patch_ruby/api/preferences_api.rb +276 -0
  10. data/lib/patch_ruby/api/projects_api.rb +148 -0
  11. data/lib/patch_ruby/api_client.rb +388 -0
  12. data/lib/patch_ruby/api_error.rb +57 -0
  13. data/lib/patch_ruby/configuration.rb +254 -0
  14. data/lib/patch_ruby/models/allocation.rb +229 -0
  15. data/lib/patch_ruby/models/create_mass_estimate_request.rb +216 -0
  16. data/lib/patch_ruby/models/create_order_request.rb +216 -0
  17. data/lib/patch_ruby/models/create_preference_request.rb +216 -0
  18. data/lib/patch_ruby/models/error_response.rb +239 -0
  19. data/lib/patch_ruby/models/estimate.rb +238 -0
  20. data/lib/patch_ruby/models/estimate_list_response.rb +255 -0
  21. data/lib/patch_ruby/models/estimate_response.rb +239 -0
  22. data/lib/patch_ruby/models/meta_index_object.rb +220 -0
  23. data/lib/patch_ruby/models/order.rb +313 -0
  24. data/lib/patch_ruby/models/order_list_response.rb +255 -0
  25. data/lib/patch_ruby/models/order_response.rb +239 -0
  26. data/lib/patch_ruby/models/preference.rb +229 -0
  27. data/lib/patch_ruby/models/preference_list_response.rb +255 -0
  28. data/lib/patch_ruby/models/preference_response.rb +239 -0
  29. data/lib/patch_ruby/models/project.rb +283 -0
  30. data/lib/patch_ruby/models/project_list_response.rb +255 -0
  31. data/lib/patch_ruby/models/project_response.rb +239 -0
  32. data/lib/patch_ruby/version.rb +15 -0
  33. data/patch_ruby.gemspec +39 -0
  34. data/spec/api/estimates_api_spec.rb +71 -0
  35. data/spec/api/orders_api_spec.rb +95 -0
  36. data/spec/api/preferences_api_spec.rb +83 -0
  37. data/spec/api/projects_api_spec.rb +59 -0
  38. data/spec/api_client_spec.rb +226 -0
  39. data/spec/configuration_spec.rb +42 -0
  40. data/spec/fixtures/vcr_cassettes/estimate_orders.yml +276 -0
  41. data/spec/fixtures/vcr_cassettes/estimates.yml +211 -0
  42. data/spec/fixtures/vcr_cassettes/orders.yml +229 -0
  43. data/spec/fixtures/vcr_cassettes/preferences.yml +352 -0
  44. data/spec/fixtures/vcr_cassettes/projects.yml +143 -0
  45. data/spec/integration/estimates_spec.rb +31 -0
  46. data/spec/integration/orders_spec.rb +53 -0
  47. data/spec/integration/preferences_spec.rb +40 -0
  48. data/spec/integration/projects_spec.rb +31 -0
  49. data/spec/models/allocation_spec.rb +53 -0
  50. data/spec/models/create_mass_estimate_request_spec.rb +41 -0
  51. data/spec/models/create_order_request_spec.rb +41 -0
  52. data/spec/models/create_preference_request_spec.rb +41 -0
  53. data/spec/models/error_response_spec.rb +53 -0
  54. data/spec/models/estimate_list_response_spec.rb +59 -0
  55. data/spec/models/estimate_response_spec.rb +53 -0
  56. data/spec/models/estimate_spec.rb +59 -0
  57. data/spec/models/meta_index_object_spec.rb +47 -0
  58. data/spec/models/order_list_response_spec.rb +59 -0
  59. data/spec/models/order_response_spec.rb +53 -0
  60. data/spec/models/order_spec.rb +85 -0
  61. data/spec/models/preference_list_response_spec.rb +59 -0
  62. data/spec/models/preference_response_spec.rb +53 -0
  63. data/spec/models/preference_spec.rb +53 -0
  64. data/spec/models/project_list_response_spec.rb +59 -0
  65. data/spec/models/project_response_spec.rb +53 -0
  66. data/spec/models/project_spec.rb +89 -0
  67. data/spec/spec_helper.rb +122 -0
  68. metadata +203 -0
@@ -0,0 +1,276 @@
1
+ =begin
2
+ #Patch API V1
3
+
4
+ #The core API used to integrate with Patch's service
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: developers@usepatch.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Patch
16
+ class PreferencesApi
17
+ OPERATIONS = [
18
+ :create_preference,
19
+ :delete_preference,
20
+ :retrieve_preference,
21
+ :retrieve_preferences,
22
+ ]
23
+
24
+ attr_accessor :api_client
25
+
26
+ def initialize(api_client = ApiClient.default)
27
+ @api_client = api_client
28
+ end
29
+ # creates a project preference
30
+ # Creates a project preference for the given organization. If you have a `preference` in place, all of your orders will be directed to the project the preference points to.
31
+ # @param create_preference_request [CreatePreferenceRequest]
32
+ # @param [Hash] opts the optional parameters
33
+ # @return [PreferenceResponse]
34
+ def create_preference(create_preference_request, opts = {})
35
+ data, _status_code, _headers = create_preference_with_http_info(create_preference_request, opts)
36
+ data
37
+ end
38
+
39
+ # creates a project preference
40
+ # Creates a project preference for the given organization. If you have a `preference` in place, all of your orders will be directed to the project the preference points to.
41
+ # @param create_preference_request [CreatePreferenceRequest]
42
+ # @param [Hash] opts the optional parameters
43
+ # @return [Array<(PreferenceResponse, Integer, Hash)>] PreferenceResponse data, response status code and response headers
44
+ def create_preference_with_http_info(create_preference_request, opts = {})
45
+ if @api_client.config.debugging
46
+ @api_client.config.logger.debug 'Calling API: PreferencesApi.create_preference ...'
47
+ end
48
+ # verify the required parameter 'create_preference_request' is set
49
+ if @api_client.config.client_side_validation && create_preference_request.nil?
50
+ fail ArgumentError, "Missing the required parameter 'create_preference_request' when calling PreferencesApi.create_preference"
51
+ end
52
+ # resource path
53
+ local_var_path = '/v1/preferences'
54
+
55
+ # query parameters
56
+ query_params = opts[:query_params] || {}
57
+
58
+ # header parameters
59
+ header_params = opts[:header_params] || {}
60
+ # HTTP header 'Accept' (if needed)
61
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
62
+ # HTTP header 'Content-Type'
63
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
64
+
65
+ # form parameters
66
+ form_params = opts[:form_params] || {}
67
+
68
+ # http body (model)
69
+ post_body = opts[:body] || @api_client.object_to_http_body(create_preference_request)
70
+
71
+ # return_type
72
+ return_type = opts[:return_type] || 'PreferenceResponse'
73
+
74
+ # auth_names
75
+ auth_names = opts[:auth_names] || ['bearer_auth']
76
+
77
+ new_options = opts.merge(
78
+ :header_params => header_params,
79
+ :query_params => query_params,
80
+ :form_params => form_params,
81
+ :body => post_body,
82
+ :auth_names => auth_names,
83
+ :return_type => return_type
84
+ )
85
+
86
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
87
+ if @api_client.config.debugging
88
+ @api_client.config.logger.debug "API called: PreferencesApi#create_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
89
+ end
90
+ return data, status_code, headers
91
+ end
92
+
93
+ # Deletes an organization's preference for a project
94
+ # Deletes the given `preference`. Once a preference is deleted, it cannot be undone. If you want to restore your previous preference, create a new one.
95
+ # @param id [String]
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [PreferenceResponse]
98
+ def delete_preference(id, opts = {})
99
+ data, _status_code, _headers = delete_preference_with_http_info(id, opts)
100
+ data
101
+ end
102
+
103
+ # Deletes an organization&#39;s preference for a project
104
+ # Deletes the given &#x60;preference&#x60;. Once a preference is deleted, it cannot be undone. If you want to restore your previous preference, create a new one.
105
+ # @param id [String]
106
+ # @param [Hash] opts the optional parameters
107
+ # @return [Array<(PreferenceResponse, Integer, Hash)>] PreferenceResponse data, response status code and response headers
108
+ def delete_preference_with_http_info(id, opts = {})
109
+ if @api_client.config.debugging
110
+ @api_client.config.logger.debug 'Calling API: PreferencesApi.delete_preference ...'
111
+ end
112
+ # verify the required parameter 'id' is set
113
+ if @api_client.config.client_side_validation && id.nil?
114
+ fail ArgumentError, "Missing the required parameter 'id' when calling PreferencesApi.delete_preference"
115
+ end
116
+ # resource path
117
+ local_var_path = '/v1/preferences/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
118
+
119
+ # query parameters
120
+ query_params = opts[:query_params] || {}
121
+
122
+ # header parameters
123
+ header_params = opts[:header_params] || {}
124
+ # HTTP header 'Accept' (if needed)
125
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
126
+
127
+ # form parameters
128
+ form_params = opts[:form_params] || {}
129
+
130
+ # http body (model)
131
+ post_body = opts[:body]
132
+
133
+ # return_type
134
+ return_type = opts[:return_type] || 'PreferenceResponse'
135
+
136
+ # auth_names
137
+ auth_names = opts[:auth_names] || ['bearer_auth']
138
+
139
+ new_options = opts.merge(
140
+ :header_params => header_params,
141
+ :query_params => query_params,
142
+ :form_params => form_params,
143
+ :body => post_body,
144
+ :auth_names => auth_names,
145
+ :return_type => return_type
146
+ )
147
+
148
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
149
+ if @api_client.config.debugging
150
+ @api_client.config.logger.debug "API called: PreferencesApi#delete_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
+ end
152
+ return data, status_code, headers
153
+ end
154
+
155
+ # Retrieve the preference
156
+ # Retrieve the preference and project of an organization. You can only retrieve preferences associated with your organization.
157
+ # @param id [String]
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [PreferenceResponse]
160
+ def retrieve_preference(id, opts = {})
161
+ data, _status_code, _headers = retrieve_preference_with_http_info(id, opts)
162
+ data
163
+ end
164
+
165
+ # Retrieve the preference
166
+ # Retrieve the preference and project of an organization. You can only retrieve preferences associated with your organization.
167
+ # @param id [String]
168
+ # @param [Hash] opts the optional parameters
169
+ # @return [Array<(PreferenceResponse, Integer, Hash)>] PreferenceResponse data, response status code and response headers
170
+ def retrieve_preference_with_http_info(id, opts = {})
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug 'Calling API: PreferencesApi.retrieve_preference ...'
173
+ end
174
+ # verify the required parameter 'id' is set
175
+ if @api_client.config.client_side_validation && id.nil?
176
+ fail ArgumentError, "Missing the required parameter 'id' when calling PreferencesApi.retrieve_preference"
177
+ end
178
+ # resource path
179
+ local_var_path = '/v1/preferences/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
180
+
181
+ # query parameters
182
+ query_params = opts[:query_params] || {}
183
+
184
+ # header parameters
185
+ header_params = opts[:header_params] || {}
186
+ # HTTP header 'Accept' (if needed)
187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
188
+
189
+ # form parameters
190
+ form_params = opts[:form_params] || {}
191
+
192
+ # http body (model)
193
+ post_body = opts[:body]
194
+
195
+ # return_type
196
+ return_type = opts[:return_type] || 'PreferenceResponse'
197
+
198
+ # auth_names
199
+ auth_names = opts[:auth_names] || ['bearer_auth']
200
+
201
+ new_options = opts.merge(
202
+ :header_params => header_params,
203
+ :query_params => query_params,
204
+ :form_params => form_params,
205
+ :body => post_body,
206
+ :auth_names => auth_names,
207
+ :return_type => return_type
208
+ )
209
+
210
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
211
+ if @api_client.config.debugging
212
+ @api_client.config.logger.debug "API called: PreferencesApi#retrieve_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
213
+ end
214
+ return data, status_code, headers
215
+ end
216
+
217
+ # Retrieves a list of preferences
218
+ # Retrieves a list of preferences and associated projects of an organization. You can only retrieve preferences associated with your organization.
219
+ # @param [Hash] opts the optional parameters
220
+ # @option opts [Integer] :page
221
+ # @return [PreferenceListResponse]
222
+ def retrieve_preferences(opts = {})
223
+ data, _status_code, _headers = retrieve_preferences_with_http_info(opts)
224
+ data
225
+ end
226
+
227
+ # Retrieves a list of preferences
228
+ # Retrieves a list of preferences and associated projects of an organization. You can only retrieve preferences associated with your organization.
229
+ # @param [Hash] opts the optional parameters
230
+ # @option opts [Integer] :page
231
+ # @return [Array<(PreferenceListResponse, Integer, Hash)>] PreferenceListResponse data, response status code and response headers
232
+ def retrieve_preferences_with_http_info(opts = {})
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug 'Calling API: PreferencesApi.retrieve_preferences ...'
235
+ end
236
+ # resource path
237
+ local_var_path = '/v1/preferences'
238
+
239
+ # query parameters
240
+ query_params = opts[:query_params] || {}
241
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
242
+
243
+ # header parameters
244
+ header_params = opts[:header_params] || {}
245
+ # HTTP header 'Accept' (if needed)
246
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
247
+
248
+ # form parameters
249
+ form_params = opts[:form_params] || {}
250
+
251
+ # http body (model)
252
+ post_body = opts[:body]
253
+
254
+ # return_type
255
+ return_type = opts[:return_type] || 'PreferenceListResponse'
256
+
257
+ # auth_names
258
+ auth_names = opts[:auth_names] || ['bearer_auth']
259
+
260
+ new_options = opts.merge(
261
+ :header_params => header_params,
262
+ :query_params => query_params,
263
+ :form_params => form_params,
264
+ :body => post_body,
265
+ :auth_names => auth_names,
266
+ :return_type => return_type
267
+ )
268
+
269
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
270
+ if @api_client.config.debugging
271
+ @api_client.config.logger.debug "API called: PreferencesApi#retrieve_preferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
272
+ end
273
+ return data, status_code, headers
274
+ end
275
+ end
276
+ end
@@ -0,0 +1,148 @@
1
+ =begin
2
+ #Patch API V1
3
+
4
+ #The core API used to integrate with Patch's service
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: developers@usepatch.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Patch
16
+ class ProjectsApi
17
+ OPERATIONS = [
18
+ :retrieve_project,
19
+ :retrieve_projects,
20
+ ]
21
+
22
+ attr_accessor :api_client
23
+
24
+ def initialize(api_client = ApiClient.default)
25
+ @api_client = api_client
26
+ end
27
+ # Retrieves a project
28
+ # Retrieves a project available on Patch's platform.
29
+ # @param id [String]
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [ProjectResponse]
32
+ def retrieve_project(id, opts = {})
33
+ data, _status_code, _headers = retrieve_project_with_http_info(id, opts)
34
+ data
35
+ end
36
+
37
+ # Retrieves a project
38
+ # Retrieves a project available on Patch&#39;s platform.
39
+ # @param id [String]
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(ProjectResponse, Integer, Hash)>] ProjectResponse data, response status code and response headers
42
+ def retrieve_project_with_http_info(id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.retrieve_project ...'
45
+ end
46
+ # verify the required parameter 'id' is set
47
+ if @api_client.config.client_side_validation && id.nil?
48
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.retrieve_project"
49
+ end
50
+ # resource path
51
+ local_var_path = '/v1/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
52
+
53
+ # query parameters
54
+ query_params = opts[:query_params] || {}
55
+
56
+ # header parameters
57
+ header_params = opts[:header_params] || {}
58
+ # HTTP header 'Accept' (if needed)
59
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:body]
66
+
67
+ # return_type
68
+ return_type = opts[:return_type] || 'ProjectResponse'
69
+
70
+ # auth_names
71
+ auth_names = opts[:auth_names] || ['bearer_auth']
72
+
73
+ new_options = opts.merge(
74
+ :header_params => header_params,
75
+ :query_params => query_params,
76
+ :form_params => form_params,
77
+ :body => post_body,
78
+ :auth_names => auth_names,
79
+ :return_type => return_type
80
+ )
81
+
82
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
83
+ if @api_client.config.debugging
84
+ @api_client.config.logger.debug "API called: ProjectsApi#retrieve_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ end
86
+ return data, status_code, headers
87
+ end
88
+
89
+ # Retrieves a list of projects
90
+ # Retrieves a list of projects available for purchase on Patch's platform.
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [Integer] :page
93
+ # @return [ProjectListResponse]
94
+ def retrieve_projects(opts = {})
95
+ data, _status_code, _headers = retrieve_projects_with_http_info(opts)
96
+ data
97
+ end
98
+
99
+ # Retrieves a list of projects
100
+ # Retrieves a list of projects available for purchase on Patch&#39;s platform.
101
+ # @param [Hash] opts the optional parameters
102
+ # @option opts [Integer] :page
103
+ # @return [Array<(ProjectListResponse, Integer, Hash)>] ProjectListResponse data, response status code and response headers
104
+ def retrieve_projects_with_http_info(opts = {})
105
+ if @api_client.config.debugging
106
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.retrieve_projects ...'
107
+ end
108
+ # resource path
109
+ local_var_path = '/v1/projects'
110
+
111
+ # query parameters
112
+ query_params = opts[:query_params] || {}
113
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
114
+
115
+ # header parameters
116
+ header_params = opts[:header_params] || {}
117
+ # HTTP header 'Accept' (if needed)
118
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
119
+
120
+ # form parameters
121
+ form_params = opts[:form_params] || {}
122
+
123
+ # http body (model)
124
+ post_body = opts[:body]
125
+
126
+ # return_type
127
+ return_type = opts[:return_type] || 'ProjectListResponse'
128
+
129
+ # auth_names
130
+ auth_names = opts[:auth_names] || ['bearer_auth']
131
+
132
+ new_options = opts.merge(
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: ProjectsApi#retrieve_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+ end
148
+ end
@@ -0,0 +1,388 @@
1
+ =begin
2
+ #Patch API V1
3
+
4
+ #The core API used to integrate with Patch's service
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: developers@usepatch.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'typhoeus'
18
+
19
+ module Patch
20
+ class ApiClient
21
+ # The Configuration object holding settings to be used in the API client.
22
+ attr_accessor :config
23
+
24
+ # Defines the headers to be used in HTTP requests of all API calls by default.
25
+ #
26
+ # @return [Hash]
27
+ attr_accessor :default_headers
28
+
29
+ # Initializes the ApiClient
30
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
31
+ def initialize(config = Configuration.default)
32
+ @config = config
33
+ @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
34
+ @default_headers = {
35
+ 'Content-Type' => 'application/json',
36
+ 'User-Agent' => @user_agent
37
+ }
38
+ end
39
+
40
+ def self.default
41
+ @@default ||= ApiClient.new
42
+ end
43
+
44
+ # Call an API with given options.
45
+ #
46
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
47
+ # the data deserialized from response body (could be nil), response status code and response headers.
48
+ def call_api(http_method, path, opts = {})
49
+ request = build_request(http_method, path, opts)
50
+ response = request.run
51
+
52
+ if @config.debugging
53
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
54
+ end
55
+
56
+ unless response.success?
57
+ if response.timed_out?
58
+ fail ApiError.new('Connection timed out')
59
+ elsif response.code == 0
60
+ # Errors from libcurl will be made visible here
61
+ fail ApiError.new(:code => 0,
62
+ :message => response.return_message)
63
+ else
64
+ fail ApiError.new(:code => response.code,
65
+ :response_headers => response.headers,
66
+ :response_body => response.body),
67
+ response.status_message
68
+ end
69
+ end
70
+
71
+ if opts[:return_type]
72
+ data = deserialize(response, opts[:return_type])
73
+ else
74
+ data = nil
75
+ end
76
+ return data, response.code, response.headers
77
+ end
78
+
79
+ # Builds the HTTP request
80
+ #
81
+ # @param [String] http_method HTTP method/verb (e.g. POST)
82
+ # @param [String] path URL path (e.g. /account/new)
83
+ # @option opts [Hash] :header_params Header parameters
84
+ # @option opts [Hash] :query_params Query parameters
85
+ # @option opts [Hash] :form_params Query parameters
86
+ # @option opts [Object] :body HTTP body (JSON/XML)
87
+ # @return [Typhoeus::Request] A Typhoeus Request
88
+ def build_request(http_method, path, opts = {})
89
+ url = build_request_url(path)
90
+ http_method = http_method.to_sym.downcase
91
+
92
+ header_params = @default_headers.merge(opts[:header_params] || {})
93
+ query_params = opts[:query_params] || {}
94
+ form_params = opts[:form_params] || {}
95
+
96
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
97
+
98
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
99
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
100
+
101
+ req_opts = {
102
+ :method => http_method,
103
+ :headers => header_params,
104
+ :params => query_params,
105
+ :params_encoding => @config.params_encoding,
106
+ :timeout => @config.timeout,
107
+ :ssl_verifypeer => @config.verify_ssl,
108
+ :ssl_verifyhost => _verify_ssl_host,
109
+ :sslcert => @config.cert_file,
110
+ :sslkey => @config.key_file,
111
+ :verbose => @config.debugging
112
+ }
113
+
114
+ # set custom cert, if provided
115
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
116
+
117
+ if [:post, :patch, :put, :delete].include?(http_method)
118
+ req_body = build_request_body(header_params, form_params, opts[:body])
119
+ req_opts.update :body => req_body
120
+ if @config.debugging
121
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
122
+ end
123
+ end
124
+
125
+ request = Typhoeus::Request.new(url, req_opts)
126
+ download_file(request) if opts[:return_type] == 'File'
127
+ request
128
+ end
129
+
130
+ # Builds the HTTP request body
131
+ #
132
+ # @param [Hash] header_params Header parameters
133
+ # @param [Hash] form_params Query parameters
134
+ # @param [Object] body HTTP body (JSON/XML)
135
+ # @return [String] HTTP body data in the form of string
136
+ def build_request_body(header_params, form_params, body)
137
+ # http form
138
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
139
+ header_params['Content-Type'] == 'multipart/form-data'
140
+ data = {}
141
+ form_params.each do |key, value|
142
+ case value
143
+ when ::File, ::Array, nil
144
+ # let typhoeus handle File, Array and nil parameters
145
+ data[key] = value
146
+ else
147
+ data[key] = value.to_s
148
+ end
149
+ end
150
+ elsif body
151
+ data = body.is_a?(String) ? body : body.to_json
152
+ else
153
+ data = nil
154
+ end
155
+ data
156
+ end
157
+
158
+ # Check if the given MIME is a JSON MIME.
159
+ # JSON MIME examples:
160
+ # application/json
161
+ # application/json; charset=UTF8
162
+ # APPLICATION/JSON
163
+ # */*
164
+ # @param [String] mime MIME
165
+ # @return [Boolean] True if the MIME is application/json
166
+ def json_mime?(mime)
167
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
168
+ end
169
+
170
+ # Deserialize the response to the given return type.
171
+ #
172
+ # @param [Response] response HTTP response
173
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
174
+ def deserialize(response, return_type)
175
+ body = response.body
176
+
177
+ # handle file downloading - return the File instance processed in request callbacks
178
+ # note that response body is empty when the file is written in chunks in request on_body callback
179
+ return @tempfile if return_type == 'File'
180
+
181
+ return nil if body.nil? || body.empty?
182
+
183
+ # return response body directly for String return type
184
+ return body if return_type == 'String'
185
+
186
+ # ensuring a default content type
187
+ content_type = response.headers['Content-Type'] || 'application/json'
188
+
189
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
190
+
191
+ begin
192
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
193
+ rescue JSON::ParserError => e
194
+ if %w(String Date DateTime).include?(return_type)
195
+ data = body
196
+ else
197
+ raise e
198
+ end
199
+ end
200
+
201
+ convert_to_type data, return_type
202
+ end
203
+
204
+ # Convert data to the given return type.
205
+ # @param [Object] data Data to be converted
206
+ # @param [String] return_type Return type
207
+ # @return [Mixed] Data in a particular type
208
+ def convert_to_type(data, return_type)
209
+ return nil if data.nil?
210
+ case return_type
211
+ when 'String'
212
+ data.to_s
213
+ when 'Integer'
214
+ data.to_i
215
+ when 'Float'
216
+ data.to_f
217
+ when 'Boolean'
218
+ data == true
219
+ when 'DateTime'
220
+ # parse date time (expecting ISO 8601 format)
221
+ DateTime.parse data
222
+ when 'Date'
223
+ # parse date time (expecting ISO 8601 format)
224
+ Date.parse data
225
+ when 'Object'
226
+ # generic object (usually a Hash), return directly
227
+ data
228
+ when /\AArray<(.+)>\z/
229
+ # e.g. Array<Pet>
230
+ sub_type = $1
231
+ data.map { |item| convert_to_type(item, sub_type) }
232
+ when /\AHash\<String, (.+)\>\z/
233
+ # e.g. Hash<String, Integer>
234
+ sub_type = $1
235
+ {}.tap do |hash|
236
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
237
+ end
238
+ else
239
+ # models, e.g. Pet
240
+ Patch.const_get(return_type).build_from_hash(data)
241
+ end
242
+ end
243
+
244
+ # Save response body into a file in (the defined) temporary folder, using the filename
245
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
246
+ # The response body is written to the file in chunks in order to handle files which
247
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
248
+ # process can use.
249
+ #
250
+ # @see Configuration#temp_folder_path
251
+ def download_file(request)
252
+ tempfile = nil
253
+ encoding = nil
254
+ request.on_headers do |response|
255
+ content_disposition = response.headers['Content-Disposition']
256
+ if content_disposition && content_disposition =~ /filename=/i
257
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
258
+ prefix = sanitize_filename(filename)
259
+ else
260
+ prefix = 'download-'
261
+ end
262
+ prefix = prefix + '-' unless prefix.end_with?('-')
263
+ encoding = response.body.encoding
264
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
265
+ @tempfile = tempfile
266
+ end
267
+ request.on_body do |chunk|
268
+ chunk.force_encoding(encoding)
269
+ tempfile.write(chunk)
270
+ end
271
+ request.on_complete do |response|
272
+ if tempfile
273
+ tempfile.close
274
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
275
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
276
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
277
+ "explicitly with `tempfile.delete`"
278
+ end
279
+ end
280
+ end
281
+
282
+ # Sanitize filename by removing path.
283
+ # e.g. ../../sun.gif becomes sun.gif
284
+ #
285
+ # @param [String] filename the filename to be sanitized
286
+ # @return [String] the sanitized filename
287
+ def sanitize_filename(filename)
288
+ filename.gsub(/.*[\/\\]/, '')
289
+ end
290
+
291
+ def build_request_url(path)
292
+ # Add leading and trailing slashes to path
293
+ path = "/#{path}".gsub(/\/+/, '/')
294
+ @config.base_url + path
295
+ end
296
+
297
+ # Update hearder and query params based on authentication settings.
298
+ #
299
+ # @param [Hash] header_params Header parameters
300
+ # @param [Hash] query_params Query parameters
301
+ # @param [String] auth_names Authentication scheme name
302
+ def update_params_for_auth!(header_params, query_params, auth_names)
303
+ Array(auth_names).each do |auth_name|
304
+ auth_setting = @config.auth_settings[auth_name]
305
+ next unless auth_setting
306
+ case auth_setting[:in]
307
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
308
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
309
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
310
+ end
311
+ end
312
+ end
313
+
314
+ # Sets user agent in HTTP header
315
+ #
316
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
317
+ def user_agent=(user_agent)
318
+ @user_agent = user_agent
319
+ @default_headers['User-Agent'] = @user_agent
320
+ end
321
+
322
+ # Return Accept header based on an array of accepts provided.
323
+ # @param [Array] accepts array for Accept
324
+ # @return [String] the Accept header (e.g. application/json)
325
+ def select_header_accept(accepts)
326
+ return nil if accepts.nil? || accepts.empty?
327
+ # use JSON when present, otherwise use all of the provided
328
+ json_accept = accepts.find { |s| json_mime?(s) }
329
+ json_accept || accepts.join(',')
330
+ end
331
+
332
+ # Return Content-Type header based on an array of content types provided.
333
+ # @param [Array] content_types array for Content-Type
334
+ # @return [String] the Content-Type header (e.g. application/json)
335
+ def select_header_content_type(content_types)
336
+ # use application/json by default
337
+ return 'application/json' if content_types.nil? || content_types.empty?
338
+ # use JSON when present, otherwise use the first one
339
+ json_content_type = content_types.find { |s| json_mime?(s) }
340
+ json_content_type || content_types.first
341
+ end
342
+
343
+ # Convert object (array, hash, object, etc) to JSON string.
344
+ # @param [Object] model object to be converted into JSON string
345
+ # @return [String] JSON string representation of the object
346
+ def object_to_http_body(model)
347
+ return model if model.nil? || model.is_a?(String)
348
+ local_body = nil
349
+ if model.is_a?(Array)
350
+ local_body = model.map { |m| object_to_hash(m) }
351
+ else
352
+ local_body = object_to_hash(model)
353
+ end
354
+ local_body.to_json
355
+ end
356
+
357
+ # Convert object(non-array) to hash.
358
+ # @param [Object] obj object to be converted into JSON string
359
+ # @return [String] JSON string representation of the object
360
+ def object_to_hash(obj)
361
+ if obj.respond_to?(:to_hash)
362
+ obj.to_hash
363
+ else
364
+ obj
365
+ end
366
+ end
367
+
368
+ # Build parameter value according to the given collection format.
369
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
370
+ def build_collection_param(param, collection_format)
371
+ case collection_format
372
+ when :csv
373
+ param.join(',')
374
+ when :ssv
375
+ param.join(' ')
376
+ when :tsv
377
+ param.join("\t")
378
+ when :pipes
379
+ param.join('|')
380
+ when :multi
381
+ # return the array directly as typhoeus will handle it as expected
382
+ param
383
+ else
384
+ fail "unknown collection format: #{collection_format.inspect}"
385
+ end
386
+ end
387
+ end
388
+ end