Class: ApacheFelix::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/apache_felix_api_client/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



43
44
45
46
47
48
49
50
 
# File 'lib/apache_felix_api_client/api_client.rb', line 43

def initialize(config = Configuration.default)
  @config = config
  @user_agent = "Swagger-Codegen/#{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.



34
35
36
 
# File 'lib/apache_felix_api_client/api_client.rb', line 34

def config
  @config
end

#default_headers ⇒ Hash

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

Returns:

  • (Hash) 


39
40
41
 
# File 'lib/apache_felix_api_client/api_client.rb', line 39

def default_headers
  @default_headers
end

Class Method Details

.default ⇒ Object 



52
53
54
 
# File 'lib/apache_felix_api_client/api_client.rb', line 52

def self.default
  @@default ||= ApiClient.new
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



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

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(http_method, path, opts = {}) ⇒ Typhoeus::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:

  • (Typhoeus::Request) —

    A Typhoeus Request



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

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] || {}

  update_params_for_auth! header_params, query_params, opts[:auth_names]

  # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
  _verify_ssl_host = @config.verify_ssl_host ? 2 : 0

  req_opts = {
    :method => http_method,
    :headers => header_params,
    :params => query_params,
    :params_encoding => @config.params_encoding,
    :timeout => @config.timeout,
    :ssl_verifypeer => @config.verify_ssl,
    :ssl_verifyhost => _verify_ssl_host,
    :sslcert => @config.cert_file,
    :sslkey => @config.key_file,
    :verbose => @config.debugging
  }

  # set custom cert, if provided
  req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert

  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

  Typhoeus::Request.new(url, req_opts)
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/apache_felix_api_client/api_client.rb', line 266

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



254
255
256
257
258
 
# File 'lib/apache_felix_api_client/api_client.rb', line 254

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/apache_felix_api_client/api_client.rb', line 60

def call_api(http_method, path, opts = {})
  request = build_request(http_method, path, opts)
  response = request.run

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

  unless response.success?
    fail ApiError.new(:code => response.code,
                      :response_headers => response.headers,
                      :response_body => response.body),
         response.status_message
  end

  if opts[:return_type]
    data = deserialize(response, opts[:return_type])
  else
    data = nil
  end
  return data, response.code, 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



179
180
181
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
211
212
213
214
215
 
# File 'lib/apache_felix_api_client/api_client.rb', line 179

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
    ApacheFelix.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”



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/apache_felix_api_client/api_client.rb', line 147

def deserialize(response, return_type)
  body = response.body
  return nil if body.nil? || body.empty?

  # return response body directly for String return type
  return body if return_type == 'String'

  # handle file downloading - save response body into a tmp file and return the File instance
  return download_file(response) if 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

#download_file(response) ⇒ Tempfile

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.

Returns:

  • (Tempfile) —

    the file downloaded

See Also:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/apache_felix_api_client/api_client.rb', line 222

def download_file(response)
  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?('-')

  tempfile = nil
  encoding = response.body.encoding
  Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
    file.write(response.body)
    tempfile = file
  end
  @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 applicaton/json



139
140
141
 
# File 'lib/apache_felix_api_client/api_client.rb', line 139

def json_mime?(mime)
   !(mime =~ /\Aapplication\/json(;.*)?\z/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



351
352
353
354
355
356
357
 
# File 'lib/apache_felix_api_client/api_client.rb', line 351

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



337
338
339
340
341
342
343
344
345
346
 
# File 'lib/apache_felix_api_client/api_client.rb', line 337

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



250
251
252
 
# File 'lib/apache_felix_api_client/api_client.rb', line 250

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)



316
317
318
319
320
321
 
# File 'lib/apache_felix_api_client/api_client.rb', line 316

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)



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

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

  • form_params (Hash) —

    Query parameters

  • auth_names (String) —

    Authentication scheme name



293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/apache_felix_api_client/api_client.rb', line 293

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

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



308
309
310
311
 
# File 'lib/apache_felix_api_client/api_client.rb', line 308

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