Class: AsposeCellsCloud::ApiClient
- Inherits:
-
Object
- Object
- AsposeCellsCloud::ApiClient
- Defined in:
- lib/aspose_cells_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.
-
#get_access_token_time ⇒ Object
Returns the value of attribute get_access_token_time.
Class Method Summary collapse
Instance Method Summary collapse
-
#add_o_auth_token(req_opts) ⇒ Object
Adds OAuth2.0 token.
-
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
-
#build_request(http_method, path, opts = {}) ⇒ Faraday::Response
Builds the HTTP request.
-
#build_request_body(header_params, form_params, body) ⇒ String
Builds the HTTP request body.
- #build_request_url(path) ⇒ Object
-
#call_api(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.
-
#download_file(response) ⇒ Object
Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename.
-
#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.
-
#request_token_if_needed ⇒ Object
Request access and refresh tokens if needed.
-
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path.
-
#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.
-
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update hearder and query params based on authentication settings.
-
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header.
Constructor Details
#initialize(config = Configuration.default) ⇒ ApiClient
Initializes the ApiClient
52 53 54 55 56 57 58 59 60 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 52 def initialize(config = Configuration.default) @config = config @default_headers = { 'Content-Type' => "application/json", 'x-aspose-client' => "ruby sdk", 'x-aspose-version' => "#{ AsposeCellsCloud::VERSION }" } end |
Instance Attribute Details
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
42 43 44 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 42 def config @config end |
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
47 48 49 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 47 def default_headers @default_headers end |
#get_access_token_time ⇒ Object
Returns the value of attribute get_access_token_time.
49 50 51 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 49 def get_access_token_time @get_access_token_time end |
Class Method Details
Instance Method Details
#add_o_auth_token(req_opts) ⇒ Object
Adds OAuth2.0 token
499 500 501 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 499 def add_o_auth_token(req_opts) req_opts[:headers][:Authorization] = "Bearer " + @config.access_token end |
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 410 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 faraday will handle it as expected param else fail "unknown collection format: #{collection_format.inspect}" end end |
#build_request(http_method, path, opts = {}) ⇒ Faraday::Response
Builds the HTTP request
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 109 def build_request(http_method, path, opts = {}) url = build_request_url(path) http_method = http_method.to_sym.downcase header_params = @default_headers.merge(opts[:header_params] || {}) query_params = opts[:query_params] || {} form_params = opts[:form_params] || {} body = opts[:body] || {} update_params_for_auth! header_params, query_params, opts[:auth_names] req_opts = { :method => http_method, :headers => header_params, :params => query_params, :body => body } if [:post, :patch, :put, :delete].include?(http_method) req_body = build_request_body(header_params, form_params, opts[:body]) req_opts.update :body => req_body if @config.debugging @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" end end # OAuth 2.0 req_opts[:params] = opts[:query_params] if @config.access_token add_o_auth_token(req_opts) end conn = Faraday.new url, {:params => query_params, :headers => header_params} do |f| f.request :multipart f.request :url_encoded f.adapter Faraday.default_adapter end if req_opts[:body] == {} req_opts[:body] = nil end case http_method when :post return conn.post url, req_opts[:body] when :put return conn.put url, req_opts[:body] when :get return conn.get url, req_opts[:body] else return conn.delete url do |c| c.body = req_opts[:body] end end end |
#build_request_body(header_params, form_params, body) ⇒ String
Builds the HTTP request body
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 311 def build_request_body(header_params, form_params, body) # http form if header_params['Content-Type'] == 'application/x-www-form-urlencoded' || header_params['Content-Type'] == 'multipart/form-data' data = {} form_params.each do |key, value| case value when ::File data[key] = Faraday::UploadIO.new(value.path, "application/octet-stream", key) #MimeMagic::by_magic(value).to_s # data[key] = Faraday::UploadIO.new(value.path, MimeMagic.by_magic(value).to_s, key) when ::Array, nil # let typhoeus handle File, Array and nil parameters data[key] = value else data[key] = value.to_s end end elsif body data = body.is_a?(String) ? body : body.to_json else data = nil end data end |
#build_request_url(path) ⇒ Object
297 298 299 300 301 302 303 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 297 def build_request_url(path) # Add leading and trailing slashes to path path = "/#{path}".gsub(/\/+/, '/') # URI.encode(@config.base_url + path) # URI.encode_www_form_component(@config.base_url + path) @config.base_url + path end |
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 70 def call_api(http_method, path, opts = {}) response = build_request(http_method, path, opts) download_file response if opts[:return_type] == 'File' if @config.debugging @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" end unless response.success? if response.status == 0 # Errors from libcurl will be made visible here fail ApiError.new(:code => 0, :message => response.reason_phrase) 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 [data, response.status, response.headers] end |
#convert_to_type(data, return_type) ⇒ Mixed
Convert data 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 244 245 246 247 248 249 250 251 252 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 216 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 # models, e.g. Pet AsposeCellsCloud.const_get(return_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.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 182 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 @tempfile if return_type == 'File' return nil if body.nil? || body.empty? # return response body directly for String return type return body if return_type == 'String' # ensuring a default content type content_type = response.headers['Content-Type'] || 'application/json' raise "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 |
#download_file(response) ⇒ Object
Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename. The response body is written to the file in chunks in order to handle files which size is larger than maximum Ruby String or even larger than the maximum memory a Ruby process can use.
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 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 261 def download_file(response) tempfile = nil encoding = nil content_disposition = response.headers['Content-Disposition'] if content_disposition and content_disposition =~ /filename=/i filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1] prefix = sanitize_filename(filename) else prefix = 'download-' end prefix = prefix + '-' unless prefix.end_with?('-') encoding = response.body.encoding tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) @tempfile = tempfile tempfile.write(response.body) response.on_complete do |resp| tempfile.close @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\ "will be deleted automatically with GC. It's also recommended to delete the temp file "\ "explicitly with `tempfile.delete`" end 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
*/*
174 175 176 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 174 def json_mime?(mime) (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil? end |
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
400 401 402 403 404 405 406 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 400 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.
385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 385 def object_to_http_body(model) return '"' + model + '"' if model.is_a?(String) return model if model.nil? 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 |
#request_token_if_needed ⇒ Object
Request access and refresh tokens if needed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 429 def request_token_if_needed # check token exists if @config.client_id.nil? && @config.client_secret.nil? return end if @config.access_token now = Time.now time_difference = now - $get_access_token_time if time_difference < 86300 return end end # resource path local_var_path = "/cells/connect/token" if @config.api_version === "v1.1" local_var_path ="/oauth2/token" end url = build_request_url(local_var_path) #url = build_request_url(local_var_path).gsub('/'+config.api_version, '') #url = build_request_url(local_var_path).gsub('/v3.0', '') # header parameters header_params = {} # HTTP header 'Content-Type' header_params['Content-Type'] = select_header_content_type(['application/x-www-form-urlencoded']) query_params = {} # form parameters form_params = {} form_params["grant_type"] = 'client_credentials' form_params["client_id"] = @config.client_id form_params["client_secret"] = @config.client_secret body = {} req_opts = { :headers => header_params, :params => query_params, :body => body } req_body = build_request_body(header_params, form_params, body) req_opts.update :body => req_body req_opts[:params] = query_params conn = Faraday.new url, {:params => query_params, :headers => header_params} do |f| f.request :multipart f.request :url_encoded f.adapter Faraday.default_adapter end if req_opts[:body] == {} req_opts[:body] = nil end response = conn.post url, form_params, req_opts[:body] data = JSON.parse("[#{response.body}]", :symbolize_names => true)[0] @config.access_token = data[:access_token] $get_access_token_time = Time.now end |
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif
293 294 295 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 293 def sanitize_filename(filename) filename.gsub(/.*[\/\\]/, '') end |
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
364 365 366 367 368 369 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 364 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) } return json_accept || accepts.join(',') end |
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
374 375 376 377 378 379 380 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 374 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) } return json_content_type || content_types.first end |
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update hearder and query params based on authentication settings.
341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 341 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 raise ArgumentError, 'Authentication token must be in `query` of `header`' end end end |
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header
356 357 358 359 |
# File 'lib/aspose_cells_cloud/api_client.rb', line 356 def user_agent=(user_agent) @user_agent = user_agent @default_headers['User-Agent'] = @user_agent end |