vsphere-automation-runtime 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 226f670b612a7a585fe4060cbe04aab7842dade81af508133b98c5e4abe079db
-  data.tar.gz: 701e30402efc0cb0aee6a5682b82820e2cb91d41450671dfdd8da8c2aa41d0ea
+  metadata.gz: 3e3ced8b72983d106a8c17f4cdb4739deb2528a39e9401df2f1f6b77947ec305
+  data.tar.gz: ad42fda3b57f5d50096c843bab5bb2a377098cee166d272cdeee5f52c440778e
 SHA512:
-  metadata.gz: 63b795bdfd4676d86db78e1ba3ac2ccd12ff80358359dd9bc84285dde03fe294d4dba80e9dba1a506ad8da973757c550bd83ba9a054b1f548bf9ea68983c158c
-  data.tar.gz: 4a14b1681ba6cd51a7afd5c1a1dcfa1ffecbed03fb1636af5b737905ed7ef4fb1b020ab2ffd14a6979af2bbe117597d3fd7aa530b2872ddb1f8108fb98baf63b
+  metadata.gz: fa8fbb24d7d5d79ee0296782742238e3dac960cf8c489f62805c026ef81816f003d5ce3b87d7e5c32b97c4de7b43cd3f8e7c52cd7114b92d42272920c39a6cff
+  data.tar.gz: dbd31185017068890cf6c3379a6b747a74be62be85fffec7aa5c593c5a020c717cdc1b12a56c79310427cd5574721e7ff771aeabfc1ce744aed2726fd406ba8f

data/Gemfile.lock

@@ -1,32 +1,28 @@
 PATH
   remote: .
   specs:
-    vsphere-automation-runtime (0.3.0)
-      typhoeus (~> 1.3)
+    vsphere-automation-runtime (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.11.1)
     hashdiff (1.0.0)
     jaro_winkler (1.5.3)
     method_source (0.9.2)
     parallel (1.17.0)
-    parser (2.6.3.0)
+    parser (2.6.4.0)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rainbow (3.0.0)
     rake (12.3.3)
     rspec (3.8.0)
@@ -51,11 +47,9 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    typhoeus (1.3.1)
-      ethon (>= 0.9.0)
     unicode-display_width (1.6.0)
     vcr (5.0.0)
-    webmock (3.6.2)
+    webmock (3.7.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -3,7 +3,7 @@
 The Ruby gem for the vSphere Runtime API
 
 - API version: 2.0.0
-- Package version: 0.3.0
+- Package version: 0.4.0
 
 ## Installation
 

data/lib/vsphere-automation-runtime/api_client.rb

@@ -1,184 +1,188 @@
-=begin
-# Copyright (c) 2018-2019 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
+# frozen_string_literal: true
 
-# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
-
-# runtime - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-=end
-
-require 'date'
 require 'json'
 require 'logger'
-require 'tempfile'
-require 'typhoeus'
+require 'net/http'
+require 'openssl'
 require 'uri'
+require 'vsphere-automation-runtime/configuration'
 
 module VSphereAutomation
+  # The client responsible for communicating with the API.
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
 
-    # Defines the headers to be used in HTTP requests of all API calls by default.
+    # Defines the headers to be used in HTTP requests of all API calls by
+    # default.
     #
     # @return [Hash]
-    attr_accessor :default_headers
+    attr_reader :default_headers
 
-    # Initializes the ApiClient
-    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+    # Creates a new instance
+    #
+    # @param config [Configuration] configuration object with values to use
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "SDK/0.3.0 Ruby/#{RUBY_VERSION} (#{Gem::Platform.local.os}; #{Gem::Platform.local.version}; #{Gem::Platform.local.cpu})"
-      @default_headers = {
-        'Content-Type' => 'application/json',
-        'User-Agent' => @user_agent
-      }
+      @http = create_http
+      @user_agent = default_user_agent
+      @default_headers = { 'Content-Type' => 'application/json',
+                           'User-Agent' => @user_agent }
     end
 
+    # Retrieves an instance of the object in it's default state
+    #
+    # @return [ApiClient] an instance of the object in it's default state
     def self.default
-      @@default ||= ApiClient.new
+      DEFAULT
     end
 
-    # Call an API with given options.
+    # Build the collection of parameters
+    def build_collection_param(params, format)
+      params
+    end
+
+    # Make a request to an API endpoint with the given options
     #
-    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    # @param http_method [Symbol] the HTTP method to be used
+    # @param path [String] the path request will be made to
+    # @param opts [Hash] any additional options needed
+    # @return [Array<(Object, Fixnum, Hash)>] the deserialized body, status
+    #   code, and headers.
     def call_api(http_method, path, opts = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+      query_params = opts.fetch(:query_params, {})
+      header_params = opts.fetch(:header_params, {})
+      form_params = opts.fetch(:form_params, {})
+      add_auth(query_params, header_params, opts.fetch(:auth_names, []))
+
+      uri = build_request_uri(path, query_params)
+      request = Net::HTTP.const_get(http_method.capitalize).new(uri)
+
+      add_form_params(request, form_params)
+      add_header_params(request, header_params)
+      request.body = opts[:body] if opts[:body]
+      request.content_type = request['Content-Type'] if request['Content-Type']
 
       if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        @config.logger.debug("Request Body:\n#{request.body}\n")
       end
 
-      unless opts.fetch(:return_type, {}).keys.include?(response.code.to_s) || 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
+      response = @http.request(request)
+      @cookie = cookie_from_response(response)
+      api_key_from_response(response)
 
-      if opts[:return_type]
-        data = deserialize(response, opts[:return_type][response.code.to_s])
-        if path == '/com/vmware/cis/session'
-          @config.api_key['vmware-api-session-id'] = data.value
-        end
-      else
-        data = nil
-      end
-      return data, response.code, response.headers
+      return_type = opts.fetch(:return_type, {}).fetch(response.code, nil)
+      data = deserialize(response, return_type)
+      [data, Integer(response.code), response.each_header.to_h]
+    end
+
+    # Takes an object and returns the object as an HTTP body
+    #
+    # @param object [Object] object to transform
+    # @return [String] object as JSON string
+    def object_to_http_body(object)
+      return object.map { |o| object_to_http_body(o) } if object.is_a?(Array)
+
+      return object unless object.respond_to?(:to_hash)
+
+      object.to_hash.to_json
+    end
+
+    # Select an Accept header to use
+    #
+    # @param types [Array] a list of suggested types
+    # @return [String] the Accept header value
+    def select_header_accept(types)
+      return DEFAULT_MIME_TYPE unless types.is_a?(Array)
+
+      types.find { |t| t.include?('json') } || types.join(', ')
     end
 
-    # Builds the HTTP request
+    # Select an Content-Type header to use
     #
-    # @param [String] http_method HTTP method/verb (e.g. POST)
-    # @param [String] path URL path (e.g. /account/new)
-    # @option opts [Hash] :header_params Header parameters
-    # @option opts [Hash] :query_params Query parameters
-    # @option opts [Hash] :form_params Query parameters
-    # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
-    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"
+    # @param types [Array] a list of suggested types
+    # @return [String] the Content-Type header value
+    def select_header_content_type(types)
+      return DEFAULT_MIME_TYPE unless types.is_a?(Array)
+
+      types.find { |t| t.include?('json') } || types.first
+    end
+
+    private
+
+    def add_auth(query_params, header_params, auth_names)
+      auth_names.map do |name|
+        settings = @config.auth_settings.fetch(name, {})
+        case settings[:in]
+        when 'header'
+          header_params[settings[:key]] = settings[:value]
+          api_key_from_cookie(header_params, settings) unless settings[:value]
+        when 'query'
+          query_params[settings[:key]] = settings[:value]
         end
       end
+    end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+    def add_form_params(request, form_params)
+      request.set_form_data(form_params) unless form_params.empty?
     end
 
-    # Check if the given MIME is a JSON MIME.
-    # JSON MIME examples:
-    #   application/json
-    #   application/json; charset=UTF8
-    #   APPLICATION/JSON
-    #   */*
-    # @param [String] mime MIME
-    # @return [Boolean] True if the MIME is application/json
-    def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+    def add_header_params(request, headers)
+      header_params = @default_headers.merge(headers, Hash(@cookie))
+      header_params.map { |name, value| request[name] = value }
     end
 
-    # Deserialize the response to the given return type.
-    #
-    # @param [Response] response HTTP response
-    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
-    def deserialize(response, return_type)
-      body = response.body
+    def add_query_params(uri, query_params)
+      uri.query = URI.encode_www_form(query_params)
+    end
 
-      # 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'
+    def build_request_uri(path = '', query_params = {})
+      path = "/#{path}".gsub(%r{/+}, '/')
+      uri = URI.parse(@config.base_url + path)
+      add_query_params(uri, query_params)
+      uri
+    end
 
-      return nil if body.nil? || body.empty?
+    def create_http
+      uri = build_request_uri
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = @config.scheme == 'https'
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @config.verify_ssl_host
+      http
+    end
 
-      # return response body directly for String return type
-      return body if return_type == 'String'
+    # The default user agent
+    #
+    # @return [String] the default user agent
+    def default_user_agent
+      "SDK/#{VSphereAutomation::Runtime::VERSION} "\
+      "Ruby/#{RUBY_VERSION} "\
+      "(#{Gem::Platform.local.os}; "\
+      "#{Gem::Platform.local.version}; "\
+      "#{Gem::Platform.local.cpu})"
+    end
 
-      # ensuring a default content type
-      content_type = response.headers['Content-Type'] || 'application/json'
+    # Deserialize the response to the given return type
+    #
+    # @param [Response] response the HTTP response
+    # @param [String] return_type the type to return
+    # @return [Object] the response represented as the return type
+    def deserialize(response, return_type)
+      body = response.body
 
-      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+      return nil if body.nil? || body.empty? || return_type.nil?
 
       begin
-        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+        data = JSON.parse("[#{body}]", symbolize_names: true).first
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
-          data = body
-        else
-          raise e
-        end
+        raise e unless %w[String Date DateTime].include?(return_type)
+
+        data = body
       end
 
-      convert_to_type data, return_type
+      convert_to_type(data, return_type)
     end
 
-    # Convert data to the given return type.
-    # @param [Object] data Data to be converted
-    # @param [String] return_type Return type
-    # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
       case return_type
@@ -217,174 +221,33 @@ module VSphereAutomation
       end
     end
 
-    # 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 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|
-        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
-
-    # Sanitize filename by removing path.
-    # e.g. ../../sun.gif becomes sun.gif
-    #
-    # @param [String] filename the filename to be sanitized
-    # @return [String] the sanitized filename
-    def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
-    end
-
-    def build_request_url(path)
-      # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
-    end
-
-    # Builds the HTTP request body
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] form_params Query parameters
-    # @param [Object] body HTTP body (JSON/XML)
-    # @return [String] HTTP body data in the form of string
-    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
-
-    # Update hearder and query params based on authentication settings.
+    # Create the Cookie header from a response
     #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] query_params Query parameters
-    # @param [String] auth_names Authentication scheme name
-    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
+    # @param response [Net::HTTPResponse] the response
+    # @return [Hash, nil] the Cookie header
+    def cookie_from_response(response)
+      { 'Cookie' => response['set-cookie'] } if response['set-cookie']
     end
 
-    # Sets user agent in HTTP header
-    #
-    # @param [String] user_agent 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
+    def api_key_from_response(response)
+      key = @config.auth_settings['api_key'][:key]
+      @config.api_key[key] = response[key] if response[key]
     end
 
-    # Return Accept header based on an array of accepts provided.
-    # @param [Array] accepts array for Accept
-    # @return [String] the Accept header (e.g. application/json)
-    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 api_key_from_cookie(headers, auth)
+      return if @cookie.nil?
 
-    # Return Content-Type header based on an array of content types provided.
-    # @param [Array] content_types array for Content-Type
-    # @return [String] the Content-Type header  (e.g. application/json)
-    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) }
-      json_content_type || content_types.first
+      regex = /(?<key>#{auth[:key]})=(?<value>\w+)/
+      matches = Hash(@cookie)['Cookie'].match(regex)
+      headers[matches[:key]] = matches[:value] if matches
     end
 
-    # Convert object (array, hash, object, etc) to JSON string.
-    # @param [Object] model object to be converted into JSON string
-    # @return [String] JSON string representation of the object
-    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
+    # An instance of the object in it's default state
+    DEFAULT = new
 
-    # Convert object(non-array) to hash.
-    # @param [Object] obj object to be converted into JSON string
-    # @return [String] JSON string representation of the object
-    def object_to_hash(obj)
-      if obj.respond_to?(:to_hash)
-        obj.to_hash
-      else
-        obj
-      end
-    end
+    # The default MIME type for Content-Type and Accept headers
+    DEFAULT_MIME_TYPE = 'application/json'
 
-    # Build parameter value according to the given collection format.
-    # @param [String] collection_format 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
+    private_constant :DEFAULT, :DEFAULT_MIME_TYPE
   end
 end

data/lib/vsphere-automation-runtime/version.rb

@@ -8,6 +8,6 @@
 
 module VSphereAutomation
   module Runtime
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/spec/api_client_spec.rb

@@ -1,222 +1,236 @@
-# Copyright (c) 2018-2019 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
-
-# runtime - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-
 require 'spec_helper'
 
 describe VSphereAutomation::ApiClient do
-  context 'initialization' do
-    context 'URL stuff' do
-      context 'host' do
-        it 'removes http from host' do
-          VSphereAutomation.configure { |c| c.host = 'http://example.com' }
-          expect(VSphereAutomation::Configuration.default.host).to eq('example.com')
-        end
+  describe '.default' do
+    it 'returns the same instance every time' do
+      first_instance  = VSphereAutomation::ApiClient.default
+      second_instance = VSphereAutomation::ApiClient.default
+      third_instance  = VSphereAutomation::ApiClient.default
+      expect(first_instance).to be(second_instance)
+      expect(first_instance).to be(third_instance)
+    end
+  end
 
-        it 'removes https from host' do
-          VSphereAutomation.configure { |c| c.host = 'https://wookiee.com' }
-          expect(VSphereAutomation::ApiClient.default.config.host).to eq('wookiee.com')
-        end
+  describe '#build_collection_param' do
+    context 'when called with format :multi' do
+      it 'returns the collection' do
+        params = { foo: 'bar', baz: 'quux' }
+        expect(subject.build_collection_param(params, :multi)).to eq(params)
+      end
+    end
+  end
 
-        it 'removes trailing path from host' do
-          VSphereAutomation.configure { |c| c.host = 'hobo.com/v4' }
-          expect(VSphereAutomation::Configuration.default.host).to eq('hobo.com')
-        end
+  describe '#call_api' do
+    let(:host) { 'example.com' }
+    let(:config) do
+      VSphereAutomation::Configuration.new.tap do |c|
+        c.scheme = 'https'
+        c.host = host
       end
+    end
+    let(:url) { 'https://example.com/rest/test' }
+    subject { VSphereAutomation::ApiClient.new(config) }
 
-      context 'base_path' do
-        it "prepends a slash to base_path" do
-          VSphereAutomation.configure { |c| c.base_path = 'v4/dog' }
-          expect(VSphereAutomation::Configuration.default.base_path).to eq('/v4/dog')
-        end
+    it 'adds headers to request' do
+      headers = { 'foo' => 'bar' }
+      stub_request(:get, url).with(headers: headers)
 
-        it "doesn't prepend a slash if one is already there" do
-          VSphereAutomation.configure { |c| c.base_path = '/v4/dog' }
-          expect(VSphereAutomation::Configuration.default.base_path).to eq('/v4/dog')
-        end
+      subject.call_api(:GET, '/test', header_params: headers)
 
-        it "ends up as a blank string if nil" do
-          VSphereAutomation.configure { |c| c.base_path = nil }
-          expect(VSphereAutomation::Configuration.default.base_path).to eq('')
-        end
-      end
+      expect(a_request(:get, url).with(headers: headers)).to have_been_made
     end
-  end
 
-  describe 'params_encoding in #build_request' do
-    let(:config) { VSphereAutomation::Configuration.new }
-    let(:api_client) { VSphereAutomation::ApiClient.new(config) }
+    it 'adds query parameters to request' do
+      query_params = { 'foo' => 'bar' }
+      stub_request(:get, url).with(query: query_params)
 
-    it 'defaults to nil' do
-      expect(VSphereAutomation::Configuration.default.params_encoding).to eq(nil)
-      expect(config.params_encoding).to eq(nil)
+      subject.call_api(:GET, '/test', query_params: query_params)
 
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:params_encoding]).to eq(nil)
+      expect(a_request(:get, url).with(query: query_params)).to have_been_made
     end
 
-    it 'can be customized' do
-      config.params_encoding = :multi
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:params_encoding]).to eq(:multi)
+    it 'adds form parameters to the request body' do
+      form_params = { 'foo' => 'bar' }
+      body = form_params.to_a.map { |e| e.join('=') }.join('&')
+      stub_request(:get, url).with(body: body)
+
+      subject.call_api(:GET, '/test', form_params: form_params)
+
+      expect(a_request(:get, url).with(body: body)).to have_been_made
     end
-  end
 
-  describe 'timeout in #build_request' do
-    let(:config) { VSphereAutomation::Configuration.new }
-    let(:api_client) { VSphereAutomation::ApiClient.new(config) }
+    it 'uses basic auth information from configuration' do
+      auth_name = 'basic_auth'
+      auth_header = { config.auth_settings[auth_name][:key] =>
+                      config.auth_settings[auth_name][:value] }
+      stub_request(:get, url).with(headers: auth_header)
 
-    it 'defaults to 0' do
-      expect(VSphereAutomation::Configuration.default.timeout).to eq(0)
-      expect(config.timeout).to eq(0)
+      subject.call_api(:GET, '/test', auth_names: [auth_name])
 
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:timeout]).to eq(0)
+      expect(a_request(:get, url)
+               .with(headers: auth_header)).to have_been_made
     end
 
-    it 'can be customized' do
-      config.timeout = 100
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:timeout]).to eq(100)
-    end
-  end
+    it 'use API key information from configuration' do
+      auth_name = 'api_key'
+      config.api_key[config.auth_settings[auth_name][:key]] = 'foo'
+      auth_header = { config.auth_settings[auth_name][:key] =>
+                      config.auth_settings[auth_name][:value] }
+      stub_request(:get, url).with(headers: auth_header)
 
-  describe '#deserialize' do
-    it "handles Array<Integer>" do
-      api_client = VSphereAutomation::ApiClient.new
-      headers = { 'Content-Type' => 'application/json' }
-      response = double('response', headers: headers, body: '[12, 34]')
-      data = api_client.deserialize(response, 'Array<Integer>')
-      expect(data).to be_instance_of(Array)
-      expect(data).to eq([12, 34])
-    end
-
-    it 'handles Array<Array<Integer>>' do
-      api_client = VSphereAutomation::ApiClient.new
-      headers = { 'Content-Type' => 'application/json' }
-      response = double('response', headers: headers, body: '[[12, 34], [56]]')
-      data = api_client.deserialize(response, 'Array<Array<Integer>>')
-      expect(data).to be_instance_of(Array)
-      expect(data).to eq([[12, 34], [56]])
-    end
-
-    it 'handles Hash<String, String>' do
-      api_client = VSphereAutomation::ApiClient.new
-      headers = { 'Content-Type' => 'application/json' }
-      response = double('response', headers: headers, body: '{"message": "Hello"}')
-      data = api_client.deserialize(response, 'Hash<String, String>')
-      expect(data).to be_instance_of(Hash)
-      expect(data).to eq(:message => 'Hello')
-    end
-  end
+      subject.call_api(:GET, '/test', auth_names: [auth_name])
 
-  describe "#object_to_hash" do
-    it 'ignores nils and includes empty arrays' do
-      # uncomment below to test object_to_hash for model
-      # api_client = VSphereAutomation::ApiClient.new
-      # _model = VSphereAutomation::ModelName.new
-      # update the model attribute below
-      # _model.id = 1
-      # update the expected value (hash) below
-      # expected = {id: 1, name: '', tags: []}
-      # expect(api_client.object_to_hash(_model)).to eq(expected)
+      expect(a_request(:get, url)
+               .with(headers: auth_header)).to have_been_made
     end
-  end
 
-  describe '#build_collection_param' do
-    let(:param) { ['aa', 'bb', 'cc'] }
-    let(:api_client) { VSphereAutomation::ApiClient.new }
+    it 'updates api_key from responses with set-cookie header' do
+      key = config.auth_settings['api_key'][:key]
+      value = 'foo'
+      cookie = "#{key}=#{value};Path=/rest;Secure;HttpOnly"
+      set_cookie_header = { 'set-cookie' => cookie }
+      auth_header = { key => value }
+      stub_request(:get, url + '1').to_return(headers: set_cookie_header)
+      stub_request(:get, url + '2').with(headers: auth_header)
+
+      subject.call_api(:GET, '/test1')
+      subject.call_api(:GET, '/test2', auth_names: ['api_key'])
 
-    it 'works for csv' do
-      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+      expect(a_request(:get, url + '1')).to have_been_made
+      expect(a_request(:get, url + '2')
+               .with(headers: auth_header)).to have_been_made
     end
 
-    it 'works for ssv' do
-      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    it 'updates api_key from responses with api_key header' do
+      key = config.auth_settings['api_key'][:key]
+      value = 'foo'
+      auth_header = { key => value }
+
+      stub_request(:get, url + '1').to_return(headers: auth_header)
+      stub_request(:get, url + '2').with(headers: auth_header)
+
+      subject.call_api(:GET, '/test1')
+      subject.call_api(:GET, '/test2', auth_names: ['api_key'])
+
+      expect(a_request(:get, url + '1')).to have_been_made
+      expect(a_request(:get, url + '2')
+               .with(headers: auth_header)).to have_been_made
     end
 
-    it 'works for tsv' do
-      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    it 'adds the body to requests when available' do
+      body = { foo: 'bar' }.to_json
+      stub_request(:post, url).with(body: body)
+
+      subject.call_api(:POST, '/test', body: body)
+
+      expect(a_request(:post, url).with(body: body)).to have_been_made
     end
 
-    it 'works for pipes' do
-      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    it 'sets the Content-Type on requests when available' do
+      content_type = { 'Content-Type' => 'application/json' }
+      body = { foo: 'bar' }.to_json
+
+      stub_request(:post, url).with(body: body, headers: content_type)
+
+      subject.call_api(:POST, '/test', body: body, header_params: content_type)
+
+      expect(a_request(:post, url)
+               .with(body: body, headers: content_type)).to have_been_made
     end
+  end
 
-    it 'works for multi' do
-      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+  describe '#object_to_http_body' do
+    context 'when given nil' do
+      it 'returns the object as is' do
+        expect(subject.object_to_http_body(nil)).to be_nil
+      end
     end
 
-    it 'fails for invalid collection format' do
-      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    context 'when given a string' do
+      it 'returns the object as is' do
+        expect(subject.object_to_http_body('asdf')).to eq('asdf')
+      end
     end
-  end
 
-  describe '#json_mime?' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
+    context 'when given an object that responds to `to_hash`' do
+      it 'returns that object as JSON' do
+        obj = OpenStruct.new(foo: 'bar', baz: 'quux')
+        obj.to_hash = obj.to_h
+        json = obj.to_hash.to_json
 
-    it 'works' do
-      expect(api_client.json_mime?(nil)).to eq false
-      expect(api_client.json_mime?('')).to eq false
+        expect(subject.object_to_http_body(obj)).to eq(json)
+      end
+    end
 
-      expect(api_client.json_mime?('application/json')).to eq true
-      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
-      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+    context 'when given an array' do
+      it 'returns a JSON array of objects' do
+        obj = OpenStruct.new(foo: 'bar', baz: 'quux')
+        obj.to_hash = obj.to_h
+        json = obj.to_hash.to_json
 
-      expect(api_client.json_mime?('application/xml')).to eq false
-      expect(api_client.json_mime?('text/plain')).to eq false
-      expect(api_client.json_mime?('application/jsonp')).to eq false
+        expect(subject.object_to_http_body([obj])).to eq([json])
+      end
     end
   end
 
   describe '#select_header_accept' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
+    context 'when given anything other than an array' do
+      it 'returns application/json as a default' do
+        expect(subject.select_header_accept(nil)).to eq('application/json')
+        expect(subject.select_header_accept('')).to eq('application/json')
+        expect(subject.select_header_accept(1)).to eq('application/json')
+      end
+    end
+
+    context 'when given a list of types' do
+      context 'that includes a JSON type' do
+        it 'returns the first type containing JSON' do
+          xml = 'application/xml'
+          json = 'application/json'
 
-    it 'works' do
-      expect(api_client.select_header_accept(nil)).to be_nil
-      expect(api_client.select_header_accept([])).to be_nil
+          expect(subject.select_header_accept([xml, json])).to eq(json)
+        end
+      end
 
-      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
-      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
-      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      context 'that does not include a JSON type' do
+        it 'returns the all of the types' do
+          xml = 'application/xml'
+          html = 'text/html'
+          result = [xml, html].join(', ')
 
-      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
-      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+          expect(subject.select_header_accept([xml, html])).to eq(result)
+        end
+      end
     end
   end
 
   describe '#select_header_content_type' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
+    context 'when given anything other than an array' do
+      it 'returns application/json as a default' do
+        expect(subject.select_header_content_type(nil)).to eq('application/json')
+        expect(subject.select_header_content_type('')).to eq('application/json')
+        expect(subject.select_header_content_type(1)).to eq('application/json')
+      end
+    end
 
-    it 'works' do
-      expect(api_client.select_header_content_type(nil)).to eq('application/json')
-      expect(api_client.select_header_content_type([])).to eq('application/json')
+    context 'when given a list of types' do
+      context 'that includes a JSON type' do
+        it 'returns the first type containing JSON' do
+          xml = 'application/xml'
+          json = 'application/json'
 
-      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
-      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
-      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
-      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
-      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
-    end
-  end
+          expect(subject.select_header_content_type([xml, json])).to eq(json)
+        end
+      end
 
-  describe '#sanitize_filename' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
-
-    it 'works' do
-      expect(api_client.sanitize_filename('sun')).to eq('sun')
-      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
-      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+      context 'that does not include a JSON type' do
+        it 'returns the first type' do
+          xml = 'application/xml'
+          html = 'text/html'
+
+          expect(subject.select_header_content_type([xml, html])).to eq(xml)
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,9 @@
 
 # load the gem
 require 'vsphere-automation-runtime'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)
 
 # The following  was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/vsphere-automation-runtime.gemspec

@@ -23,8 +23,6 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.required_ruby_version = ">= 2.3"
 
-  s.add_runtime_dependency 'typhoeus', '~> 1.3'
-
   s.add_development_dependency 'bundler', '~> 2.0'
   s.add_development_dependency 'pry', '~> 0.12.2'
   s.add_development_dependency 'rake', '~> 12.3'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vsphere-automation-runtime
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - J.R. Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -139,8 +125,8 @@ files:
 - lib/vsphere-automation-runtime/api_error.rb
 - lib/vsphere-automation-runtime/configuration.rb
 - lib/vsphere-automation-runtime/version.rb
-- pkg/vsphere-automation-runtime-0.2.1.gem
-- pkg/vsphere-automation-runtime-0.2.2.gem
+- pkg/vsphere-automation-runtime-0.3.0.gem
+- pkg/vsphere-automation-runtime-0.4.0.gem
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/spec_helper.rb