Class: AsposeWordsCloud::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/api_client.rb

Overview

api client is mainly responsible for making the HTTP call to the API backend.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = Configuration.default) ⇒ ApiClient

Initializes the ApiClient

Parameters:

  • config (Hash) (defaults to: Configuration.default) —

    a customizable set of options

Options Hash (config):

  • Configuration (Configuration) —

    for initializing the object, default to Configuration.default



52
53
54
55
56
57
58
59
 
# File 'lib/aspose_words_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' => AsposeWordsCloud::VERSION.to_s
  }
end

Instance Attribute Details

#config ⇒ Object

The Configuration object holding settings to be used in the API client.



43
44
45
 
# File 'lib/aspose_words_cloud/api_client.rb', line 43

def config
  @config
end

#default_headers ⇒ Hash

Defines the headers to be used in HTTP requests of all API calls by default.

Returns:

  • (Hash) 


48
49
50
 
# File 'lib/aspose_words_cloud/api_client.rb', line 48

def default_headers
  @default_headers
end

Class Method Details

.default ⇒ Object 



61
62
63
 
# File 'lib/aspose_words_cloud/api_client.rb', line 61

def self.default
  @@default ||= ApiClient.new
end

Instance Method Details

#add_param_to_query(url, param_name, param_value) ⇒ Object

Append query parameter to url

Parameters:

  • url (String) —

    current url

  • param_name (String) —

    query parameter name

  • param_value (String) —

    query parameter value



444
445
446
447
448
449
 
# File 'lib/aspose_words_cloud/api_client.rb', line 444

def add_param_to_query(url, param_name, param_value)
  uri = URI(url)
  params = URI.decode_www_form(uri.query || "") << [param_name, param_value]
  uri.query = URI.encode_www_form(params)
  uri.to_s
end

#build_collection_param(param, collection_format) ⇒ Object

Build parameter value according to the given collection format.

Parameters:

  • collection_format (String) —

    one of :csv, :ssv, :tsv, :pipes and :multi



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/aspose_words_cloud/api_client.rb', line 525

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
    raise "unknown collection format: #{collection_format.inspect}"
  end
end

#build_request(http_method, path, opts = {}) ⇒ Faraday::Response

Builds the HTTP request

Parameters:

  • http_method (String) —

    HTTP method/verb (e.g. POST)

  • path (String) —

    URL path (e.g. /account/new)

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :header_params (Hash) —

    Header parameters

  • :query_params (Hash) —

    Query parameters

  • :form_params (Hash) —

    Query parameters

  • :body (Object) —

    HTTP body (JSON/XML)

Returns:

  • (Faraday::Response) —

    A Faraday Response



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
 
# File 'lib/aspose_words_cloud/api_client.rb', line 117

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] if opts[:body] || nil?

  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

  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

  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
    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

Parameters:

  • header_params (Hash) —

    Header parameters

  • form_params (Hash) —

    Query parameters

  • body (Object) —

    HTTP body (JSON/XML)

Returns:

  • (String) —

    HTTP body data in the form of string



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/aspose_words_cloud/api_client.rb', line 387

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, ::Tempfile
        data[key] = Faraday::UploadIO.new(value.path, Marcel::Magic.by_magic(value).to_s, key)
      when ::Array, nil, Faraday::ParamPart
        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_body_batch(header_params, form_params, body) ⇒ String

Builds the HTTP request body

Parameters:

  • header_params (Hash) —

    Header parameters

  • form_params (Hash) —

    Query parameters

  • body (Object) —

    HTTP body (JSON/XML)

Returns:

  • (String) —

    HTTP body data in the form of string



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/aspose_words_cloud/api_client.rb', line 416

def build_request_body_batch(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, ::Tempfile
        data[key] = File.open(value.path, 'rb') { |f| f.read }
      when ::Array, nil, Faraday::ParamPart
        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 



375
376
377
378
379
 
# File 'lib/aspose_words_cloud/api_client.rb', line 375

def build_request_url(path)
  # remove empty path parameter artifacts
  path = path.gsub(/\/+/, '/')
  return @config.getFullUrl(path, path == "/connect/token")
end

#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Call an API with given options.

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    an array of 3 elements: the data deserialized from response body (could be nil), response status code and response headers.



69
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
99
100
101
102
103
104
105
106
 
# File 'lib/aspose_words_cloud/api_client.rb', line 69

def call_api(http_method, path, opts = {})
  if @config.client_data['ClientId'].nil? || @config.client_data['ClientId'] == ''
    raise "ClientId could not be an empty string."
  end

  if @config.client_data['ClientSecret'].nil? || @config.client_data['ClientSecret'] == ''
    raise "ClientSecret could not be an empty string."
  end

  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
      raise ApiError.new(:code => 0,
                        :message => response.reason_phrase)
    else
      raise ApiError.new(:code => response.status,
                        :response_headers => response.headers,
                        :response_body => response.body),
           response.reason_phrase
    end
  end

  if opts[:multipart_response] == true
    data = deserialize_multipart(response)
  elsif opts[:batch] == true
    data = deserialize_batch(response, opts[:parts])
  else
    data = deserialize(response.body, opts[:return_type]) if opts[:return_type]
  end

  [data, response.status, response.headers]
end

#convert_to_type(data, return_type) ⇒ Mixed

Convert data to the given return type.

Parameters:

  • data (Object) —

    Data to be converted

  • return_type (String) —

    Return type

Returns:

  • (Mixed) —

    Data in a particular type



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/aspose_words_cloud/api_client.rb', line 276

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
    AsposeWordsCloud.const_get(return_type).new.tap do |model|
      model.build_from_hash data
    end
  end
end

#deserialize(body, return_type) ⇒ Object

Deserialize the response to the given return type.

Parameters:

  • response (String) —

    HTTP response

  • return_type (String) —

    some examples: “User”, “Array”, “Hash”



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/aspose_words_cloud/api_client.rb', line 179

def deserialize(body, return_type)
  # 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'

  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

#deserialize_batch(response, requests) ⇒ Object

Deserialize batch



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/aspose_words_cloud/api_client.rb', line 229

def deserialize_batch(response, requests)
  result = { errors: [], parts: [] }
  def result.part(name)
    hash = self[:parts].detect { |h| h[:part].name == name }
    [hash[:part], hash[:body].join]
  end
  responses_data = []
  content_type = response.headers['content-type']
  reader = MultipartParser::Reader.new(MultipartParser::Reader::extract_boundary_value(content_type))
  reader.on_part do |part|
    result[:parts] << thispart = {
      part: part,
      body: []
    }
    part.on_data do |chunk|
      thispart[:body] << chunk
    end
  end
  reader.on_error do |msg|
    result[:errors] << msg
  end
  reader.write response.body
  reader.ended? or raise Exception, 'Truncated multipart message'

  separator = "\r\n\r\n"
  result[:parts].each do |part|
    part[:body] = part[:body].join("")
    part_body = part[:body]
    data_index = part_body.index(separator)
    if data_index != nil
      header_data = part_body[0..data_index]
      body_data = part_body[data_index+separator.length, part_body.length]
      part[:body] = body_data
    end
  end

  result[:parts].each_with_index do |response_data, index|
    return_type = requests[index].get_response_type
    responses_data.push(deserialize(response_data[:body], return_type))
  end
  responses_data
end

#deserialize_multipart(response) ⇒ Object

Deserialize multipart the response to the given return type.

Parameters:

  • response (Response) —

    HTTP response



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aspose_words_cloud/api_client.rb', line 205

def deserialize_multipart(response)
  parts={}
  content_type = response.headers['content-type']
  reader = MultipartParser::Reader.new(MultipartParser::Reader::extract_boundary_value(content_type))

  reader.on_part do |part|
    pn = part.headers['content-type'] == 'application/json' ? 'model' : 'document'
    part.on_data do |partial_data|
      if parts[pn].nil?
        parts[pn] = partial_data
      else
        parts[pn] = [parts[pn]] if parts[pn].kind_of?(Array)
        parts[pn] << partial_data
      end
    end
  end

  reader.write response.body
  reader.ended? or raise Exception, 'Truncated multipart message'

  parts
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.

See Also:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aspose_words_cloud/api_client.rb', line 321

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 += '-' 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

#download_file_from_multipart(body) ⇒ 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.

See Also:



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aspose_words_cloud/api_client.rb', line 352

def download_file_from_multipart(body)
  prefix = 'download-'
  prefix += '-' unless prefix.end_with?('-')
  tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding:body.encoding, binmode: true)
  @tempfile = tempfile
  tempfile.write(body)
  tempfile.size
  @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`"
  @tempfile
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
*/*

Parameters:

  • mime (String) —

    MIME

Returns:

  • (Boolean) —

    True if the MIME is application/json



171
172
173
 
# File 'lib/aspose_words_cloud/api_client.rb', line 171

def json_mime?(mime)
   (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
end

#object_to_hash(obj) ⇒ String

Convert object(non-array) to hash.

Parameters:

  • obj (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



515
516
517
518
519
520
521
 
# File 'lib/aspose_words_cloud/api_client.rb', line 515

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.

Parameters:

  • model (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/aspose_words_cloud/api_client.rb', line 500

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

#sanitize_filename(filename) ⇒ String

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

Parameters:

  • filename (String) —

    the filename to be sanitized

Returns:

  • (String) —

    the sanitized filename



371
372
373
 
# File 'lib/aspose_words_cloud/api_client.rb', line 371

def sanitize_filename(filename)
  filename.gsub(/.*[\/\\]/, '')
end

#select_header_accept(accepts) ⇒ String

Return Accept header based on an array of accepts provided.

Parameters:

  • accepts (Array) —

    array for Accept

Returns:

  • (String) —

    the Accept header (e.g. application/json)



479
480
481
482
483
484
 
# File 'lib/aspose_words_cloud/api_client.rb', line 479

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.

Parameters:

  • content_types (Array) —

    array for Content-Type

Returns:

  • (String) —

    the Content-Type header (e.g. application/json)



489
490
491
492
493
494
495
 
# File 'lib/aspose_words_cloud/api_client.rb', line 489

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.

Parameters:

  • header_params (Hash) —

    Header parameters

  • query_params (Hash) —

    Query parameters

  • auth_names (String) —

    Authentication scheme name



456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/aspose_words_cloud/api_client.rb', line 456

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

Parameters:

  • user_agent (String) —

    User agent (e.g. swagger-codegen/ruby/1.0.0)



471
472
473
474
 
# File 'lib/aspose_words_cloud/api_client.rb', line 471

def user_agent=(user_agent)
  @user_agent = user_agent
  @default_headers['User-Agent'] = @user_agent
end