apache_sling_api_client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #Apache Sling Resource API
3
+
4
+ #API for interacting with a Sling system.
5
+
6
+ OpenAPI spec version: 1.0.0
7
+ Contact: bryan.stopp@gmail.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ module ApacheSling
25
+ class ApiError < StandardError
26
+ attr_reader :code, :response_headers, :response_body
27
+
28
+ # Usage examples:
29
+ # ApiError.new
30
+ # ApiError.new("message")
31
+ # ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
32
+ # ApiError.new(:code => 404, :message => "Not Found")
33
+ def initialize(arg = nil)
34
+ if arg.is_a? Hash
35
+ arg.each do |k, v|
36
+ if k.to_s == 'message'
37
+ super v
38
+ else
39
+ instance_variable_set "@#{k}", v
40
+ end
41
+ end
42
+ else
43
+ super arg
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,214 @@
1
+ =begin
2
+ #Apache Sling Resource API
3
+
4
+ #API for interacting with a Sling system.
5
+
6
+ OpenAPI spec version: 1.0.0
7
+ Contact: bryan.stopp@gmail.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require 'uri'
25
+
26
+ module ApacheSling
27
+ class Configuration
28
+ # Defines url scheme
29
+ attr_accessor :scheme
30
+
31
+ # Defines url host
32
+ attr_accessor :host
33
+
34
+ # Defines url base path
35
+ attr_accessor :base_path
36
+
37
+ # Defines API keys used with API Key authentications.
38
+ #
39
+ # @return [Hash] key: parameter name, value: parameter value (API key)
40
+ #
41
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
42
+ # config.api_key['api_key'] = 'xxx'
43
+ attr_accessor :api_key
44
+
45
+ # Defines API key prefixes used with API Key authentications.
46
+ #
47
+ # @return [Hash] key: parameter name, value: API key prefix
48
+ #
49
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
50
+ # config.api_key_prefix['api_key'] = 'Token'
51
+ attr_accessor :api_key_prefix
52
+
53
+ # Defines the username used with HTTP basic authentication.
54
+ #
55
+ # @return [String]
56
+ attr_accessor :username
57
+
58
+ # Defines the password used with HTTP basic authentication.
59
+ #
60
+ # @return [String]
61
+ attr_accessor :password
62
+
63
+ # Defines the access token (Bearer) used with OAuth2.
64
+ attr_accessor :access_token
65
+
66
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
67
+ # details will be logged with `logger.debug` (see the `logger` attribute).
68
+ # Default to false.
69
+ #
70
+ # @return [true, false]
71
+ attr_accessor :debugging
72
+
73
+ # Defines the logger used for debugging.
74
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
75
+ #
76
+ # @return [#debug]
77
+ attr_accessor :logger
78
+
79
+ # Defines the temporary folder to store downloaded files
80
+ # (for API endpoints that have file response).
81
+ # Default to use `Tempfile`.
82
+ #
83
+ # @return [String]
84
+ attr_accessor :temp_folder_path
85
+
86
+ # The time limit for HTTP request in seconds.
87
+ # Default to 0 (never times out).
88
+ attr_accessor :timeout
89
+
90
+ ### TLS/SSL setting
91
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
92
+ # Default to true.
93
+ #
94
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
95
+ #
96
+ # @return [true, false]
97
+ attr_accessor :verify_ssl
98
+
99
+ ### TLS/SSL setting
100
+ # Set this to false to skip verifying SSL host name
101
+ # Default to true.
102
+ #
103
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
104
+ #
105
+ # @return [true, false]
106
+ attr_accessor :verify_ssl_host
107
+
108
+ ### TLS/SSL setting
109
+ # Set this to customize the certificate file to verify the peer.
110
+ #
111
+ # @return [String] the path to the certificate file
112
+ #
113
+ # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
114
+ # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
115
+ attr_accessor :ssl_ca_cert
116
+
117
+ ### TLS/SSL setting
118
+ # Client certificate file (for client certificate)
119
+ attr_accessor :cert_file
120
+
121
+ ### TLS/SSL setting
122
+ # Client private key file (for client certificate)
123
+ attr_accessor :key_file
124
+
125
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
126
+ # Default to nil.
127
+ #
128
+ # @see The params_encoding option of Ethon. Related source code:
129
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
130
+ attr_accessor :params_encoding
131
+
132
+ attr_accessor :inject_format
133
+
134
+ attr_accessor :force_ending_format
135
+
136
+ def initialize
137
+ @scheme = 'http'
138
+ @host = 'localhost:8080'
139
+ @base_path = '/'
140
+ @api_key = {}
141
+ @api_key_prefix = {}
142
+ @timeout = 0
143
+ @verify_ssl = true
144
+ @verify_ssl_host = true
145
+ @params_encoding = nil
146
+ @cert_file = nil
147
+ @key_file = nil
148
+ @debugging = false
149
+ @inject_format = false
150
+ @force_ending_format = false
151
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
152
+
153
+ yield(self) if block_given?
154
+ end
155
+
156
+ # The default Configuration object.
157
+ def self.default
158
+ @@default ||= Configuration.new
159
+ end
160
+
161
+ def configure
162
+ yield(self) if block_given?
163
+ end
164
+
165
+ def scheme=(scheme)
166
+ # remove :// from scheme
167
+ @scheme = scheme.sub(/:\/\//, '')
168
+ end
169
+
170
+ def host=(host)
171
+ # remove http(s):// and anything after a slash
172
+ @host = host.sub(/https?:\/\//, '').split('/').first
173
+ end
174
+
175
+ def base_path=(base_path)
176
+ # Add leading and trailing slashes to base_path
177
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
178
+ @base_path = "" if @base_path == "/"
179
+ end
180
+
181
+ def base_url
182
+ url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
183
+ URI.encode(url)
184
+ end
185
+
186
+ # Gets API key (with prefix if set).
187
+ # @param [String] param_name the parameter name of API key auth
188
+ def api_key_with_prefix(param_name)
189
+ if @api_key_prefix[param_name]
190
+ "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
191
+ else
192
+ @api_key[param_name]
193
+ end
194
+ end
195
+
196
+ # Gets Basic Auth token string
197
+ def basic_auth_token
198
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
199
+ end
200
+
201
+ # Returns Auth Settings hash for api client.
202
+ def auth_settings
203
+ {
204
+ 'basic' =>
205
+ {
206
+ type: 'basic',
207
+ in: 'header',
208
+ key: 'Authorization',
209
+ value: basic_auth_token
210
+ },
211
+ }
212
+ end
213
+ end
214
+ end
@@ -0,0 +1,26 @@
1
+ =begin
2
+ #Apache Sling Resource API
3
+
4
+ #API for interacting with a Sling system.
5
+
6
+ OpenAPI spec version: 1.0.0
7
+ Contact: bryan.stopp@gmail.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ module ApacheSling
25
+ VERSION = "0.1.0"
26
+ end
@@ -0,0 +1,51 @@
1
+ =begin
2
+ #Apache Sling Resource API
3
+
4
+ #API for interacting with a Sling system.
5
+
6
+ OpenAPI spec version: 1.0.0
7
+ Contact: bryan.stopp@gmail.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ # Common files
25
+ require 'swagger_client/api_client'
26
+ require 'swagger_client/api_error'
27
+ require 'swagger_client/version'
28
+ require 'swagger_client/configuration'
29
+
30
+ # Models
31
+
32
+ # APIs
33
+ require 'swagger_client/api/default_api'
34
+
35
+ module SwaggerClient
36
+ class << self
37
+ # Customize default settings for the SDK using block.
38
+ # SwaggerClient.configure do |config|
39
+ # config.username = "xxx"
40
+ # config.password = "xxx"
41
+ # end
42
+ # If no block given, return the default Configuration object.
43
+ def configure
44
+ if block_given?
45
+ yield(Configuration.default)
46
+ else
47
+ Configuration.default
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,91 @@
1
+ =begin
2
+ #Apache Sling Resource API
3
+
4
+ #API for interacting with a Sling system.
5
+
6
+ OpenAPI spec version: 1.0.0
7
+ Contact: bryan.stopp@gmail.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require "uri"
25
+
26
+ module SwaggerClient
27
+ class DefaultApi
28
+ attr_accessor :api_client
29
+
30
+ def initialize(api_client = ApiClient.default)
31
+ @api_client = api_client
32
+ end
33
+
34
+ # Get a resource
35
+ # Returns a representation of a Sling resource.
36
+ # @param resource The relative path to the resource.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Hash<String, String>]
39
+ def resource(resource, opts = {})
40
+ data, _status_code, _headers = resource_with_http_info(resource, opts)
41
+ return data
42
+ end
43
+
44
+ # Get a resource
45
+ # Returns a representation of a Sling resource.
46
+ # @param resource The relative path to the resource.
47
+ # @param [Hash] opts the optional parameters
48
+ # @return [Array<(Hash<String, String>, Fixnum, Hash)>] Hash<String, String> data, response status code and response headers
49
+ def resource_with_http_info(resource, opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug "Calling API: DefaultApi.resource ..."
52
+ end
53
+ # verify the required parameter 'resource' is set
54
+ fail ArgumentError, "Missing the required parameter 'resource' when calling DefaultApi.resource" if resource.nil?
55
+ # resource path
56
+ local_var_path = "/{resource}.json".sub('{format}','json').sub('{' + 'resource' + '}', resource.to_s)
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = []
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+ auth_names = ['basic']
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 => 'Hash<String, String>')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: DefaultApi#resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,379 @@
1
+ =begin
2
+ #Apache Sling Resource API
3
+
4
+ #API for interacting with a Sling system.
5
+
6
+ OpenAPI spec version: 1.0.0
7
+ Contact: bryan.stopp@gmail.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require 'date'
25
+ require 'json'
26
+ require 'logger'
27
+ require 'tempfile'
28
+ require 'typhoeus'
29
+ require 'uri'
30
+
31
+ module SwaggerClient
32
+ class ApiClient
33
+ # The Configuration object holding settings to be used in the API client.
34
+ attr_accessor :config
35
+
36
+ # Defines the headers to be used in HTTP requests of all API calls by default.
37
+ #
38
+ # @return [Hash]
39
+ attr_accessor :default_headers
40
+
41
+ # Initializes the ApiClient
42
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
43
+ def initialize(config = Configuration.default)
44
+ @config = config
45
+ @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
46
+ @default_headers = {
47
+ 'Content-Type' => "application/json",
48
+ 'User-Agent' => @user_agent
49
+ }
50
+ end
51
+
52
+ def self.default
53
+ @@default ||= ApiClient.new
54
+ end
55
+
56
+ # Call an API with given options.
57
+ #
58
+ # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
59
+ # the data deserialized from response body (could be nil), response status code and response headers.
60
+ def call_api(http_method, path, opts = {})
61
+ request = build_request(http_method, path, opts)
62
+ response = request.run
63
+
64
+ if @config.debugging
65
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
66
+ end
67
+
68
+ unless response.success?
69
+ fail ApiError.new(:code => response.code,
70
+ :response_headers => response.headers,
71
+ :response_body => response.body),
72
+ response.status_message
73
+ end
74
+
75
+ if opts[:return_type]
76
+ data = deserialize(response, opts[:return_type])
77
+ else
78
+ data = nil
79
+ end
80
+ return data, response.code, response.headers
81
+ end
82
+
83
+ # Builds the HTTP request
84
+ #
85
+ # @param [String] http_method HTTP method/verb (e.g. POST)
86
+ # @param [String] path URL path (e.g. /account/new)
87
+ # @option opts [Hash] :header_params Header parameters
88
+ # @option opts [Hash] :query_params Query parameters
89
+ # @option opts [Hash] :form_params Query parameters
90
+ # @option opts [Object] :body HTTP body (JSON/XML)
91
+ # @return [Typhoeus::Request] A Typhoeus Request
92
+ def build_request(http_method, path, opts = {})
93
+ url = build_request_url(path)
94
+ http_method = http_method.to_sym.downcase
95
+
96
+ header_params = @default_headers.merge(opts[:header_params] || {})
97
+ query_params = opts[:query_params] || {}
98
+ form_params = opts[:form_params] || {}
99
+
100
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
101
+
102
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
103
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
104
+
105
+ req_opts = {
106
+ :method => http_method,
107
+ :headers => header_params,
108
+ :params => query_params,
109
+ :params_encoding => @config.params_encoding,
110
+ :timeout => @config.timeout,
111
+ :ssl_verifypeer => @config.verify_ssl,
112
+ :ssl_verifyhost => _verify_ssl_host,
113
+ :sslcert => @config.cert_file,
114
+ :sslkey => @config.key_file,
115
+ :verbose => @config.debugging
116
+ }
117
+
118
+ # set custom cert, if provided
119
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
120
+
121
+ if [:post, :patch, :put, :delete].include?(http_method)
122
+ req_body = build_request_body(header_params, form_params, opts[:body])
123
+ req_opts.update :body => req_body
124
+ if @config.debugging
125
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
126
+ end
127
+ end
128
+
129
+ Typhoeus::Request.new(url, req_opts)
130
+ end
131
+
132
+ # Check if the given MIME is a JSON MIME.
133
+ # JSON MIME examples:
134
+ # application/json
135
+ # application/json; charset=UTF8
136
+ # APPLICATION/JSON
137
+ # @param [String] mime MIME
138
+ # @return [Boolean] True if the MIME is applicaton/json
139
+ def json_mime?(mime)
140
+ !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
141
+ end
142
+
143
+ # Deserialize the response to the given return type.
144
+ #
145
+ # @param [Response] response HTTP response
146
+ # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
147
+ def deserialize(response, return_type)
148
+ body = response.body
149
+ return nil if body.nil? || body.empty?
150
+
151
+ # return response body directly for String return type
152
+ return body if return_type == 'String'
153
+
154
+ # handle file downloading - save response body into a tmp file and return the File instance
155
+ return download_file(response) if return_type == 'File'
156
+
157
+ # ensuring a default content type
158
+ content_type = response.headers['Content-Type'] || 'application/json'
159
+
160
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
161
+
162
+ begin
163
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
164
+ rescue JSON::ParserError => e
165
+ if %w(String Date DateTime).include?(return_type)
166
+ data = body
167
+ else
168
+ raise e
169
+ end
170
+ end
171
+
172
+ convert_to_type data, return_type
173
+ end
174
+
175
+ # Convert data to the given return type.
176
+ # @param [Object] data Data to be converted
177
+ # @param [String] return_type Return type
178
+ # @return [Mixed] Data in a particular type
179
+ def convert_to_type(data, return_type)
180
+ return nil if data.nil?
181
+ case return_type
182
+ when 'String'
183
+ data.to_s
184
+ when 'Integer'
185
+ data.to_i
186
+ when 'Float'
187
+ data.to_f
188
+ when 'BOOLEAN'
189
+ data == true
190
+ when 'DateTime'
191
+ # parse date time (expecting ISO 8601 format)
192
+ DateTime.parse data
193
+ when 'Date'
194
+ # parse date time (expecting ISO 8601 format)
195
+ Date.parse data
196
+ when 'Object'
197
+ # generic object (usually a Hash), return directly
198
+ data
199
+ when /\AArray<(.+)>\z/
200
+ # e.g. Array<Pet>
201
+ sub_type = $1
202
+ data.map {|item| convert_to_type(item, sub_type) }
203
+ when /\AHash\<String, (.+)\>\z/
204
+ # e.g. Hash<String, Integer>
205
+ sub_type = $1
206
+ {}.tap do |hash|
207
+ data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
208
+ end
209
+ else
210
+ # models, e.g. Pet
211
+ SwaggerClient.const_get(return_type).new.tap do |model|
212
+ model.build_from_hash data
213
+ end
214
+ end
215
+ end
216
+
217
+ # Save response body into a file in (the defined) temporary folder, using the filename
218
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
219
+ #
220
+ # @see Configuration#temp_folder_path
221
+ # @return [Tempfile] the file downloaded
222
+ def download_file(response)
223
+ content_disposition = response.headers['Content-Disposition']
224
+ if content_disposition and content_disposition =~ /filename=/i
225
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
226
+ prefix = sanitize_filename(filename)
227
+ else
228
+ prefix = 'download-'
229
+ end
230
+ prefix = prefix + '-' unless prefix.end_with?('-')
231
+
232
+ tempfile = nil
233
+ encoding = response.body.encoding
234
+ Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
235
+ file.write(response.body)
236
+ tempfile = file
237
+ end
238
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
239
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
240
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
241
+ "explicitly with `tempfile.delete`"
242
+ tempfile
243
+ end
244
+
245
+ # Sanitize filename by removing path.
246
+ # e.g. ../../sun.gif becomes sun.gif
247
+ #
248
+ # @param [String] filename the filename to be sanitized
249
+ # @return [String] the sanitized filename
250
+ def sanitize_filename(filename)
251
+ filename.gsub(/.*[\/\\]/, '')
252
+ end
253
+
254
+ def build_request_url(path)
255
+ # Add leading and trailing slashes to path
256
+ path = "/#{path}".gsub(/\/+/, '/')
257
+ URI.encode(@config.base_url + path)
258
+ end
259
+
260
+ # Builds the HTTP request body
261
+ #
262
+ # @param [Hash] header_params Header parameters
263
+ # @param [Hash] form_params Query parameters
264
+ # @param [Object] body HTTP body (JSON/XML)
265
+ # @return [String] HTTP body data in the form of string
266
+ def build_request_body(header_params, form_params, body)
267
+ # http form
268
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
269
+ header_params['Content-Type'] == 'multipart/form-data'
270
+ data = {}
271
+ form_params.each do |key, value|
272
+ case value
273
+ when File, Array, nil
274
+ # let typhoeus handle File, Array and nil parameters
275
+ data[key] = value
276
+ else
277
+ data[key] = value.to_s
278
+ end
279
+ end
280
+ elsif body
281
+ data = body.is_a?(String) ? body : body.to_json
282
+ else
283
+ data = nil
284
+ end
285
+ data
286
+ end
287
+
288
+ # Update hearder and query params based on authentication settings.
289
+ #
290
+ # @param [Hash] header_params Header parameters
291
+ # @param [Hash] form_params Query parameters
292
+ # @param [String] auth_names Authentication scheme name
293
+ def update_params_for_auth!(header_params, query_params, auth_names)
294
+ Array(auth_names).each do |auth_name|
295
+ auth_setting = @config.auth_settings[auth_name]
296
+ next unless auth_setting
297
+ case auth_setting[:in]
298
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
299
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
300
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
301
+ end
302
+ end
303
+ end
304
+
305
+ # Sets user agent in HTTP header
306
+ #
307
+ # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
308
+ def user_agent=(user_agent)
309
+ @user_agent = user_agent
310
+ @default_headers['User-Agent'] = @user_agent
311
+ end
312
+
313
+ # Return Accept header based on an array of accepts provided.
314
+ # @param [Array] accepts array for Accept
315
+ # @return [String] the Accept header (e.g. application/json)
316
+ def select_header_accept(accepts)
317
+ return nil if accepts.nil? || accepts.empty?
318
+ # use JSON when present, otherwise use all of the provided
319
+ json_accept = accepts.find { |s| json_mime?(s) }
320
+ return json_accept || accepts.join(',')
321
+ end
322
+
323
+ # Return Content-Type header based on an array of content types provided.
324
+ # @param [Array] content_types array for Content-Type
325
+ # @return [String] the Content-Type header (e.g. application/json)
326
+ def select_header_content_type(content_types)
327
+ # use application/json by default
328
+ return 'application/json' if content_types.nil? || content_types.empty?
329
+ # use JSON when present, otherwise use the first one
330
+ json_content_type = content_types.find { |s| json_mime?(s) }
331
+ return json_content_type || content_types.first
332
+ end
333
+
334
+ # Convert object (array, hash, object, etc) to JSON string.
335
+ # @param [Object] model object to be converted into JSON string
336
+ # @return [String] JSON string representation of the object
337
+ def object_to_http_body(model)
338
+ return model if model.nil? || model.is_a?(String)
339
+ local_body = nil
340
+ if model.is_a?(Array)
341
+ local_body = model.map{|m| object_to_hash(m) }
342
+ else
343
+ local_body = object_to_hash(model)
344
+ end
345
+ local_body.to_json
346
+ end
347
+
348
+ # Convert object(non-array) to hash.
349
+ # @param [Object] obj object to be converted into JSON string
350
+ # @return [String] JSON string representation of the object
351
+ def object_to_hash(obj)
352
+ if obj.respond_to?(:to_hash)
353
+ obj.to_hash
354
+ else
355
+ obj
356
+ end
357
+ end
358
+
359
+ # Build parameter value according to the given collection format.
360
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
361
+ def build_collection_param(param, collection_format)
362
+ case collection_format
363
+ when :csv
364
+ param.join(',')
365
+ when :ssv
366
+ param.join(' ')
367
+ when :tsv
368
+ param.join("\t")
369
+ when :pipes
370
+ param.join('|')
371
+ when :multi
372
+ # return the array directly as typhoeus will handle it as expected
373
+ param
374
+ else
375
+ fail "unknown collection format: #{collection_format.inspect}"
376
+ end
377
+ end
378
+ end
379
+ end