Class: Bandwidth::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api_client.rb

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



33
34
35
36
37
38
39
40
 
# File 'lib/bandwidth-sdk/api_client.rb', line 33

def initialize(config = Configuration.default)
  @config = config
  @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
  @default_headers = {
    'Content-Type' => 'application/json',
    'User-Agent' => @user_agent
  }
end

Instance Attribute Details

#config ⇒ Object

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



24
25
26
 
# File 'lib/bandwidth-sdk/api_client.rb', line 24

def config
  @config
end

#default_headers ⇒ Hash

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

Returns:

  • (Hash) 


29
30
31
 
# File 'lib/bandwidth-sdk/api_client.rb', line 29

def default_headers
  @default_headers
end

Class Method Details

.default ⇒ Object 



42
43
44
 
# File 'lib/bandwidth-sdk/api_client.rb', line 42

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

Instance Method Details

#basic_auth(conn) ⇒ Object 



200
201
202
203
204
205
206
207
208
 
# File 'lib/bandwidth-sdk/api_client.rb', line 200

def basic_auth(conn)
  if config.username && config.password
    if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
      conn.request(:authorization, :basic, config.username, config.password)
    else
      conn.request(:basic_auth, config.username, config.password)
    end
  end
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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/bandwidth-sdk/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 typhoeus will handle it as expected
    param
  else
    fail "unknown collection format: #{collection_format.inspect}"
  end
end

#build_connection ⇒ Object 



180
181
182
183
184
185
186
187
188
 
# File 'lib/bandwidth-sdk/api_client.rb', line 180

def build_connection
  Faraday.new(url: config.base_url, ssl: ssl_options, proxy: config.proxy) do |conn|
    basic_auth(conn)
    config.configure_middleware(conn)
    yield(conn) if block_given?
    conn.adapter(Faraday.default_adapter)
    config.configure_connection(conn)
  end
end

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

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::Request) —

    A Faraday Request



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
 
# File 'lib/bandwidth-sdk/api_client.rb', line 95

def build_request(http_method, path, request, opts = {})
  url = build_request_url(path, opts)
  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] || {}

  update_params_for_auth! header_params, query_params, opts[:auth_names]

  if [:post, :patch, :put, :delete].include?(http_method)
    req_body = build_request_body(header_params, form_params, opts[:body])
    if config.debugging
      config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
    end
  end
  request.headers = header_params
  request.body = req_body

  # Overload default options only if provided
  request.options.params_encoder = config.params_encoder if config.params_encoder
  request.options.timeout        = config.timeout        if config.timeout

  request.url url
  request.params = query_params
  download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
  request
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



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
 
# File 'lib/bandwidth-sdk/api_client.rb', line 130

def build_request_body(header_params, form_params, body)
  # http form
  if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
    data = URI.encode_www_form(form_params)
  elsif header_params['Content-Type'] == 'multipart/form-data'
    data = {}
    form_params.each do |key, value|
      case value
      when ::File, ::Tempfile
        # TODO hardcode to application/octet-stream, need better way to detect content type
        data[key] = Faraday::FilePart.new(value.path, 'application/octet-stream', value.path)
      when ::Array, nil
        # let Faraday handle 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, opts = {}) ⇒ Object 



331
332
333
334
335
 
# File 'lib/bandwidth-sdk/api_client.rb', line 331

def build_request_url(path, opts = {})
  # Add leading and trailing slashes to path
  path = "/#{path}".gsub(/\/+/, '/')
  @config.base_url(opts[:operation]) + path
end

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

Call an API with given options.

Returns:

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

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/bandwidth-sdk/api_client.rb', line 50

def call_api(http_method, path, opts = {})
  begin
    response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
      build_request(http_method, path, req, opts)
    end

    if config.debugging
      config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
    end

    unless response.success?
      if response.status == 0 && response.respond_to?(:return_message)
        # Errors from libcurl will be made visible here
        fail ApiError.new(code: 0,
                          message: response.return_message)
      else
        fail ApiError.new(code: response.status,
                          response_headers: response.headers,
                          response_body: response.body),
             response.reason_phrase
      end
    end
  rescue Faraday::TimeoutError
    fail ApiError.new('Connection timed out')
  rescue Faraday::ConnectionFailed
    fail ApiError.new('Connection failed')
  end

  if opts[:return_type]
    data = deserialize(response, opts[:return_type])
  else
    data = nil
  end
  return data, response.status, response.headers
end

#connection(opts) ⇒ Object 



165
166
167
 
# File 'lib/bandwidth-sdk/api_client.rb', line 165

def connection(opts)
  opts[:header_params]['Content-Type'] == 'multipart/form-data' ? connection_multipart : connection_regular
end

#connection_multipart ⇒ Object 



169
170
171
172
173
174
 
# File 'lib/bandwidth-sdk/api_client.rb', line 169

def connection_multipart
  @connection_multipart ||= build_connection do |conn|
    conn.request :multipart
    conn.request :url_encoded
  end
end

#connection_regular ⇒ Object 



176
177
178
 
# File 'lib/bandwidth-sdk/api_client.rb', line 176

def connection_regular
  @connection_regular ||= build_connection
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



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
313
314
315
316
317
318
319
320
 
# File 'lib/bandwidth-sdk/api_client.rb', line 285

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 'Time'
    # parse date time (expecting ISO 8601 format)
    Time.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) or oneOf
    klass = Bandwidth.const_get(return_type)
    klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
  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<User>”, “Hash<String, Integer>”



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
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
 
# File 'lib/bandwidth-sdk/api_client.rb', line 226

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
  if return_type == 'File'
    if @config.return_binary_data == true
      # return byte stream
      encoding = body.encoding
      return @stream.join.force_encoding(encoding)
    else
      # return file instead of binary data
      content_disposition = response.headers['Content-Disposition']
      if content_disposition && 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 = body.encoding
      @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
      @tempfile.write(@stream.join.force_encoding(encoding))
      @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`"
      return @tempfile
    end
  end

  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'

  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 Time).include?(return_type)
      data = body
    else
      raise e
    end
  end

  convert_to_type data, return_type
end

#download_file(request) ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/bandwidth-sdk/api_client.rb', line 156

def download_file(request)
  @stream = []

  # handle streaming Responses
  request.options.on_data = Proc.new do |chunk, overall_received_bytes|
    @stream << chunk
  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



218
219
220
 
# File 'lib/bandwidth-sdk/api_client.rb', line 218

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



400
401
402
403
404
405
406
 
# File 'lib/bandwidth-sdk/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.

Parameters:

  • model (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/bandwidth-sdk/api_client.rb', line 386

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

#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



327
328
329
 
# File 'lib/bandwidth-sdk/api_client.rb', line 327

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)



365
366
367
368
369
370
 
# File 'lib/bandwidth-sdk/api_client.rb', line 365

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.

Parameters:

  • content_types (Array) —

    array for Content-Type

Returns:

  • (String) —

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



375
376
377
378
379
380
381
 
# File 'lib/bandwidth-sdk/api_client.rb', line 375

def select_header_content_type(content_types)
  # return nil by default
  return 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

#ssl_options ⇒ Object 



190
191
192
193
194
195
196
197
198
 
# File 'lib/bandwidth-sdk/api_client.rb', line 190

def ssl_options
  {
    ca_file: config.ssl_ca_file,
    verify: config.ssl_verify,
    verify_mode: config.ssl_verify_mode,
    client_cert: config.ssl_client_cert,
    client_key: config.ssl_client_key
  }
end

#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object

Update header and query params based on authentication settings.

Parameters:

  • header_params (Hash) —

    Header parameters

  • query_params (Hash) —

    Query parameters

  • auth_names (String) —

    Authentication scheme name



342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/bandwidth-sdk/api_client.rb', line 342

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` or `header`'
    end
  end
end

#user_agent=(user_agent) ⇒ Object

Sets user agent in HTTP header

Parameters:

  • user_agent (String) —

    User agent (e.g. openapi-generator/ruby/1.0.0)



357
358
359
360
 
# File 'lib/bandwidth-sdk/api_client.rb', line 357

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