Class: AsposeSlidesCloud::ApiClient
- Inherits:
-
Object
- Object
- AsposeSlidesCloud::ApiClient
- Defined in:
- lib/aspose_slides_cloud/api_client.rb
Instance Attribute Summary collapse
-
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
-
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
Class Method Summary collapse
Instance Method Summary collapse
-
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
-
#build_request(req, http_method, path, opts = {}) ⇒ Typhoeus::Request
Builds the HTTP request.
-
#build_request_body(header_params, form_params, body, files) ⇒ String
Builds the HTTP request body.
-
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
-
#call_api_method(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
-
#convert_to_type(data, return_type) ⇒ Mixed
Convert data to the given return type.
-
#deserialize(response, return_type) ⇒ Object
Deserialize the response to the given return type.
-
#initialize(config = Configuration.default) ⇒ ApiClient
constructor
Initializes the ApiClient.
-
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME.
-
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
-
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
-
#process_response(response, opts) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
-
#put_multipart!(data, boundary, part_index, part_data) ⇒ String
Builds the HTTP request body.
-
#repeat_call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
-
#replace_path_parameter(path, name, value) ⇒ String
Convert object(non-array) to hash.
-
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
-
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
- #set_auth_header(headers) ⇒ Object
- #set_headers(headers) ⇒ Object
-
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update hearder and query params based on authentication settings.
Constructor Details
#initialize(config = Configuration.default) ⇒ ApiClient
Initializes the ApiClient
42 43 44 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 42 def initialize(config = Configuration.default) @config = config end |
Instance Attribute Details
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
33 34 35 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 33 def config @config end |
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
38 39 40 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 38 def default_headers @default_headers end |
Class Method Details
Instance Method Details
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 418 def build_collection_param(param, collection_format) case collection_format when :csv param.join(',') when :ssv param.join(' ') when :tsv param.join("\t") when :pipes param.join('|') when :multi # return the array directly as typhoeus will handle it as expected param else fail "unknown collection format: #{collection_format.inspect}" end end |
#build_request(req, http_method, path, opts = {}) ⇒ Typhoeus::Request
Builds the HTTP request
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 144 def build_request(req, http_method, path, opts = {}) opts[:query_params].each_key do |key| if opts[:query_params][key].kind_of?(Array) opts[:query_params][key] = opts[:query_params][key].join[","] end end if @config.http_request_timeout > 0 req..timeout = @config.http_request_timeout end req.url path.sub(/^\/+/, '') req.headers = opts[:header_params] req.params = opts[:query_params] form_params = opts[:form_params] || {} req.body = build_request_body(req.headers, form_params, opts[:body], opts[:files]) set_headers(req.headers) if @config.debugging @config.logger.debug "HTTP request\nMethod: #{req.method}\nPath: #{req.path}\nParams: #{req.params}\nHeaders: #{req.headers}\nBody: #{req.body}\n" end end |
#build_request_body(header_params, form_params, body, files) ⇒ String
Builds the HTTP request body
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 296 def build_request_body(header_params, form_params, body, files) if files and files.length > 0 boundary = "7d70fb31-0eb9-4846-9ea8-933dfb69d8f1" header_params['Content-Type'] = "multipart/form-data; boundary=#{boundary}" data = "" if body put_multipart!(data, boundary, 0, body) end files.each_with_index do |val, index| put_multipart!(data, boundary, index + 1, val) end data << "\r\n--#{boundary}--\r\n" data else header_params['Content-Type'] = 'text/json' if body data = body.is_a?(String) ? body : body.to_json else data = nil end end data end |
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 54 def call_api(http_method, path, opts = {}) response = call_api_method(http_method, path, opts) if @config.debugging @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n" end if (response.status == 401 || (response.status == 500 && response.body.length == 0)) and @config.access_token @config.access_token = nil return repeat_call_api(http_method, path, opts) end return process_response(response, opts) end |
#call_api_method(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 112 def call_api_method(http_method, path, opts = {}) connection = Faraday.new(:url => @config.base_path) case http_method when :GET response = connection.get do |req| build_request(req, http_method, path, opts) end when :POST response = connection.post do |req| build_request(req, http_method, path, opts) end when :PUT response = connection.put do |req| build_request(req, http_method, path, opts) end when :DELETE response = connection.delete do |req| build_request(req, http_method, path, opts) end end response end |
#convert_to_type(data, return_type) ⇒ Mixed
Convert data to the given return type.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 249 def convert_to_type(data, return_type) return nil if data.nil? case return_type when 'String' data.to_s when 'Integer' data.to_i when 'Float' data.to_f when 'BOOLEAN' data == true when 'DateTime' # parse date time (expecting ISO 8601 format) DateTime.parse data when 'Date' # parse date time (expecting ISO 8601 format) Date.parse data when 'Object' # generic object (usually a Hash), return directly data when /\AArray<(.+)>\z/ # e.g. Array<Pet> sub_type = $1 data.map { |item| convert_to_type(item, sub_type) } when /\AHash\<String, (.+)\>\z/ # e.g. Hash<String, Integer> sub_type = $1 {}.tap do |hash| data.each { |k, v| hash[k] = convert_to_type(v, sub_type) } end else type = AsposeSlidesCloud::TypeRegistry.get_type(return_type, data) if !type type = return_type end AsposeSlidesCloud.const_get(type).new.tap do |model| model.build_from_hash data end end end |
#deserialize(response, return_type) ⇒ Object
Deserialize the response to the given return type.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 216 def deserialize(response, return_type) body = response.body # handle file downloading - return the File instance processed in request callbacks # note that response body is empty when the file is written in chunks in request on_body callback return nil if body.nil? || body.empty? # return response body directly for String return type return body if return_type == 'String' or return_type == 'File' # ensuring a default content type content_type = response.headers['Content-Type'] || 'application/json' fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type) begin data = JSON.parse("[#{body}]", :symbolize_names => true)[0] rescue JSON::ParserError => e if %w(String Date DateTime).include?(return_type) data = body else raise e end end convert_to_type data, return_type end |
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME. JSON MIME examples:
application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*
208 209 210 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 208 def json_mime?(mime) (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil? end |
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
395 396 397 398 399 400 401 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 395 def object_to_hash(obj) if obj.respond_to?(:to_hash) obj.to_hash else obj end end |
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
381 382 383 384 385 386 387 388 389 390 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 381 def object_to_http_body(model) return model if model.nil? || model.is_a?(String) local_body = nil if model.is_a?(Array) local_body = model.map { |m| object_to_hash(m) } else local_body = object_to_hash(model) end local_body.to_json end |
#process_response(response, opts) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 85 def process_response(response, opts) unless response.success? if response.status == 0 # Errors from libcurl will be made visible here fail ApiError.new(:code => 0, :message => response.) else fail ApiError.new(:code => response.status, :response_headers => response.headers, :response_body => response.body), response.reason_phrase end end if opts[:return_type] data = deserialize(response, opts[:return_type]) else data = nil end return data, response.status, response.headers end |
#put_multipart!(data, boundary, part_index, part_data) ⇒ String
Builds the HTTP request body
326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 326 def put_multipart!(data, boundary, part_index, part_data) data << "\r\n--#{boundary}\r\n" if part_index > 0 data << "Content-Disposition: form-data; name=\"file#{part_index}\";filename=\"null\"\r\n" data << "Content-Type: application/octet-stream\r\n" elsif data << "Content-Disposition: form-data; name=\"data\"\r\n" data << "Content-Type: text/json\r\n" end data << "Content-Length: #{part_data.length}\r\n" data << "\r\n" data << part_data end |
#repeat_call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
72 73 74 75 76 77 78 79 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 72 def repeat_call_api(http_method, path, opts = {}) response = call_api_method(http_method, path, opts) if @config.debugging @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n" end return process_response(response, opts) end |
#replace_path_parameter(path, name, value) ⇒ String
Convert object(non-array) to hash.
406 407 408 409 410 411 412 413 414 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 406 def replace_path_parameter(path, name, value) if value == nil value = "" end if value.to_s != "" value = "/" + value.to_s end path.sub('/{' + name + '}', URI::encode(value)) end |
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
360 361 362 363 364 365 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 360 def select_header_accept(accepts) return nil if accepts.nil? || accepts.empty? # use JSON when present, otherwise use all of the provided json_accept = accepts.find { |s| json_mime?(s) } json_accept || accepts.join(',') end |
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
370 371 372 373 374 375 376 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 370 def select_header_content_type(content_types) # use application/json by default return 'application/json' if content_types.nil? || content_types.empty? # use JSON when present, otherwise use the first one json_content_type = content_types.find { |s| json_mime?(s) } json_content_type || content_types.first end |
#set_auth_header(headers) ⇒ Object
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 175 def set_auth_header(headers) if config.app_sid || config.access_token unless @config.access_token auth_token_response = Faraday.post( @config.auth_base_url + '/connect/token', { :grant_type => 'client_credentials', 'client_id' => @config.app_sid, 'client_secret' => @config.app_sid }) unless auth_token_response.success? if auth_token_response.status == 0 # Errors from libcurl will be made visible here fail ApiError.new(:code => 0, :message => auth_token_response.) else fail ApiError.new(:code => 401, :response_headers => auth_token_response.headers, :response_body => auth_token_response.body), "unauthorized" end end @config.access_token = JSON.parse("[#{auth_token_response.body}]", :symbolize_names => true)[0][:access_token] end headers['Authorization'] = 'Bearer ' + @config.access_token end end |
#set_headers(headers) ⇒ Object
164 165 166 167 168 169 170 171 172 173 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 164 def set_headers(headers) headers['x-aspose-client'] = "ruby sdk v#{AsposeSlidesCloud::VERSION}" if @config.timeout > 0 headers['x-aspose-timeout'] = @config.timeout.to_s end @config.custom_headers.each do |key, value| headers[key] = value end set_auth_header(headers) end |
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update hearder and query params based on authentication settings.
345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/aspose_slides_cloud/api_client.rb', line 345 def update_params_for_auth!(header_params, query_params, auth_names) Array(auth_names).each do |auth_name| auth_setting = @config.auth_settings[auth_name] next unless auth_setting case auth_setting[:in] when 'header' then header_params[auth_setting[:key]] = auth_setting[:value] when 'query' then query_params[auth_setting[:key]] = auth_setting[:value] else fail ArgumentError, 'Authentication token must be in `query` of `header`' end end end |