Class: GroupDocsComparisonCloud::ApiClient

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ ApiClient

Initializes the ApiClient

Parameters:

  • config (Hash) —

    a customizable set of options

Options Hash (config):



50
51
52
53
54
55
56
57
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 50

def initialize(config)
  @config = config
  @default_headers = {
    'Content-Type' => config.api_version == '' ? "application/x-www-form-urlencoded" : "application/json",
    'x-groupdocs-client' => "ruby sdk",
    'x-groupdocs-version' => GroupDocsComparisonCloud::VERSION.to_s
  }
end

Instance Attribute Details

#config ⇒ Object

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



41
42
43
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 41

def config
  @config
end

#default_headers ⇒ Hash

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

Returns:

  • (Hash) 


46
47
48
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 46

def default_headers
  @default_headers
end

Instance Method Details

#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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 363

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 87

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_oauth! header_params, opts[:access_token]

  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

  conn.options.timeout = 30

  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

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 275

def build_request_body(header_params, form_params, body)
  # http form
  if body
    data = body.is_a?(String) ? body : body.to_json      
  elsif 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)
      when ::Array, nil
        data[key] = value
      else
        data[key] = value.to_s
      end
    end
  else
    data = nil
  end
  data
end

#build_request_url(path) ⇒ Object 



263
264
265
266
267
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 263

def build_request_url(path)
  # Add leading and trailing slashes to path
  path = "/#{path}".gsub(/\/+/, '/')
  Addressable::URI.encode(@config.api_base_url + @config.api_version + path)
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.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 63

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?
    raise ApiClientError.new(:code => response.status, :response_body => response.body)
  end
  
  data = deserialize(response, opts[:return_type]) if opts[:return_type]
  [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



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
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 185

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

Parameters:

  • response (Response) —

    HTTP response

  • return_type (String) —

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 151

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.

See Also:



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/groupdocs_comparison_cloud/api_client.rb', line 230

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

#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



143
144
145
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 143

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



353
354
355
356
357
358
359
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 353

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



338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 338

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



259
260
261
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 259

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)



317
318
319
320
321
322
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 317

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)



327
328
329
330
331
332
333
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 327

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_oauth!(header_params, access_token) ⇒ Object

Update hearder and query params based on authentication settings.

Parameters:

  • header_params (Hash) —

    Header parameters

  • access_token (String) —

    OAuth access token



302
303
304
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 302

def update_params_for_oauth!(header_params, access_token)
  header_params["Authorization"] = "Bearer #{access_token}"
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)



309
310
311
312
 
# File 'lib/groupdocs_comparison_cloud/api_client.rb', line 309

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