class CybridApiId::ApiClient

def self.default

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

def build_collection_param(param, collection_format)

Parameters:
  • collection_format (String) -- one of :csv, :ssv, :tsv, :pipes and :multi
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

def build_request(http_method, path, opts = {})

Returns:
  • (Typhoeus::Request) - A Typhoeus Request

Options Hash: (**opts)
  • :body (Object) -- HTTP body (JSON/XML)
  • :form_params (Hash) -- Query parameters
  • :query_params (Hash) -- Query parameters
  • :header_params (Hash) -- Header parameters

Parameters:
  • path (String) -- URL path (e.g. /account/new)
  • http_method (String) -- HTTP method/verb (e.g. POST)
def build_request(http_method, path, 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] || {}
  follow_location = opts[:follow_location] || true
  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,
    :followlocation => follow_location
  }
  # 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
  request = Typhoeus::Request.new(url, req_opts)
  download_file(request) if opts[:return_type] == 'File'
  request
end

def build_request_body(header_params, form_params, body)

Returns:
  • (String) - HTTP body data in the form of string

Parameters:
  • body (Object) -- HTTP body (JSON/XML)
  • form_params (Hash) -- Query parameters
  • header_params (Hash) -- Header parameters
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

def build_request_url(path, opts = {})

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

def call_api(http_method, path, opts = {})

Returns:
  • (Array<(Object, Integer, Hash)>) - an array of 3 elements:
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?
    if response.timed_out?
      fail ApiError.new('Connection timed out')
    elsif response.code == 0
      # Errors from libcurl will be made visible here
      fail ApiError.new(:code => 0,
                        :message => response.return_message)
    else
      fail ApiError.new(:code => response.code,
                        :response_headers => response.headers,
                        :response_body => response.body),
           response.status_message
    end
  end
  if opts[:return_type]
    data = deserialize(response, opts[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
end

def convert_to_type(data, return_type)

Returns:
  • (Mixed) - Data in a particular type

Parameters:
  • return_type (String) -- Return type
  • data (Object) -- Data to be converted
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 = CybridApiId.const_get(return_type)
    klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
  end
end

def deserialize(response, return_type)

Parameters:
  • return_type (String) -- some examples: "User", "Array", "Hash"
  • response (Response) -- HTTP response
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'
  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

def download_file(request)

Other tags:
    See: Configuration#temp_folder_path -
def download_file(request)
  tempfile = nil
  encoding = nil
  request.on_headers do |response|
    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 = response.body.encoding
    tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
    @tempfile = tempfile
  end
  request.on_body do |chunk|
    chunk.force_encoding(encoding)
    tempfile.write(chunk)
  end
  request.on_complete do |response|
    if tempfile
      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
end

def initialize(config = Configuration.default)

Options Hash: (**config)
  • Configuration (Configuration) -- for initializing the object, default to Configuration.default
def initialize(config = Configuration.default)
  @config = config
  @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
  @default_headers = {
    'Content-Type' => 'application/json',
    'User-Agent' => @user_agent
  }
end

def json_mime?(mime)

Returns:
  • (Boolean) - True if the MIME is application/json

Parameters:
  • mime (String) -- MIME
def json_mime?(mime)
  (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
end

def object_to_hash(obj)

Returns:
  • (String) - JSON string representation of the object

Parameters:
  • obj (Object) -- object to be converted into JSON string
def object_to_hash(obj)
  if obj.respond_to?(:to_hash)
    obj.to_hash
  else
    obj
  end
end

def object_to_http_body(model)

Returns:
  • (String) - JSON string representation of the object

Parameters:
  • model (Object) -- object to be converted into JSON string
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

def sanitize_filename(filename)

Returns:
  • (String) - the sanitized filename

Parameters:
  • filename (String) -- the filename to be sanitized
def sanitize_filename(filename)
  filename.gsub(/.*[\/\\]/, '')
end

def select_header_accept(accepts)

Returns:
  • (String) - the Accept header (e.g. application/json)

Parameters:
  • accepts (Array) -- array for Accept
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

def select_header_content_type(content_types)

Returns:
  • (String) - the Content-Type header (e.g. application/json)

Parameters:
  • content_types (Array) -- array for Content-Type
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

def update_params_for_auth!(header_params, query_params, auth_names)

Parameters:
  • auth_names (String) -- Authentication scheme name
  • query_params (Hash) -- Query parameters
  • header_params (Hash) -- Header parameters
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

def user_agent=(user_agent)

Parameters:
  • user_agent (String) -- User agent (e.g. openapi-generator/ruby/1.0.0)
def user_agent=(user_agent)
  @user_agent = user_agent
  @default_headers['User-Agent'] = @user_agent
end