vsphere-automation-vcenter 0.3.0 → 0.4.0

data/lib/vsphere-automation-vcenter/api_error.rb

@@ -1,34 +0,0 @@
-# Copyright (c) 2018-2019 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
-
-# vcenter - VMware vCenter Server provides a centralized platform for managing your VMware vSphere environments
-
-
-module VSphereAutomation
-  class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
-
-    # Usage examples:
-    #   ApiError.new
-    #   ApiError.new("message")
-    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
-    #   ApiError.new(:code => 404, :message => "Not Found")
-    def initialize(arg = nil)
-      if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
-        else
-          super arg
-        end
-
-        arg.each do |k, v|
-          instance_variable_set "@#{k}", v
-        end
-      else
-        super arg
-      end
-    end
-  end
-end

data/lib/vsphere-automation-vcenter/configuration.rb

@@ -1,212 +0,0 @@
-# Copyright (c) 2018-2019 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
-
-# vcenter - VMware vCenter Server provides a centralized platform for managing your VMware vSphere environments
-
-
-require 'uri'
-
-module VSphereAutomation
-  class Configuration
-    # Defines url scheme
-    attr_accessor :scheme
-
-    # Defines url host
-    attr_accessor :host
-
-    # Defines url base path
-    attr_accessor :base_path
-
-    # Defines API keys used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: parameter value (API key)
-    #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
-
-    # Defines API key prefixes used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: API key prefix
-    #
-    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-    #   config.api_key_prefix['api_key'] = 'Token'
-    attr_accessor :api_key_prefix
-
-    # Defines the username used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :username
-
-    # Defines the password used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :password
-
-    # Defines the access token (Bearer) used with OAuth2.
-    attr_accessor :access_token
-
-    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
-    # details will be logged with `logger.debug` (see the `logger` attribute).
-    # Default to false.
-    #
-    # @return [true, false]
-    attr_accessor :debugging
-
-    # Defines the logger used for debugging.
-    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-    #
-    # @return [#debug]
-    attr_accessor :logger
-
-    # Defines the temporary folder to store downloaded files
-    # (for API endpoints that have file response).
-    # Default to use `Tempfile`.
-    #
-    # @return [String]
-    attr_accessor :temp_folder_path
-
-    # The time limit for HTTP request in seconds.
-    # Default to 0 (never times out).
-    attr_accessor :timeout
-
-    # Set this to false to skip client side validation in the operation.
-    # Default to true.
-    # @return [true, false]
-    attr_accessor :client_side_validation
-
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL certificate when calling API from https server.
-    # Default to true.
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    # @return [true, false]
-    attr_accessor :verify_ssl
-
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL host name
-    # Default to true.
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    # @return [true, false]
-    attr_accessor :verify_ssl_host
-
-    ### TLS/SSL setting
-    # Set this to customize the certificate file to verify the peer.
-    #
-    # @return [String] the path to the certificate file
-    #
-    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
-    attr_accessor :ssl_ca_cert
-
-    ### TLS/SSL setting
-    # Client certificate file (for client certificate)
-    attr_accessor :cert_file
-
-    ### TLS/SSL setting
-    # Client private key file (for client certificate)
-    attr_accessor :key_file
-
-    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
-    # Default to nil.
-    #
-    # @see The params_encoding option of Ethon. Related source code:
-    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
-    attr_accessor :params_encoding
-
-    attr_accessor :inject_format
-
-    attr_accessor :force_ending_format
-
-    def initialize
-      @scheme = 'https'
-      @host = '<vcenter>'
-      @base_path = '/rest'
-      @api_key = {}
-      @api_key_prefix = {}
-      @timeout = 0
-      @client_side_validation = true
-      @verify_ssl = true
-      @verify_ssl_host = true
-      @params_encoding = :multi
-      @cert_file = nil
-      @key_file = nil
-      @debugging = false
-      @inject_format = false
-      @force_ending_format = false
-      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-
-      yield(self) if block_given?
-    end
-
-    # The default Configuration object.
-    def self.default
-      @@default ||= Configuration.new
-    end
-
-    def configure
-      yield(self) if block_given?
-    end
-
-    def scheme=(scheme)
-      # remove :// from scheme
-      @scheme = scheme.sub(/:\/\//, '')
-    end
-
-    def host=(host)
-      # remove http(s):// and anything after a slash
-      @host = host.sub(/https?:\/\//, '').split('/').first
-    end
-
-    def base_path=(base_path)
-      # Add leading and trailing slashes to base_path
-      @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = '' if @base_path == '/'
-    end
-
-    def base_url
-      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
-    end
-
-    # Gets API key (with prefix if set).
-    # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
-      if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
-      else
-        @api_key[param_name]
-      end
-    end
-
-    # Gets Basic Auth token string
-    def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-    end
-
-    # Returns Auth Settings hash for api client.
-    def auth_settings
-      {
-        'api_key' =>
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'vmware-api-session-id',
-            value: api_key_with_prefix('vmware-api-session-id')
-          },
-        'basic_auth' =>
-          {
-            type: 'basic',
-            in: 'header',
-            key: 'Authorization',
-            value: basic_auth_token
-          },
-      }
-    end
-  end
-end

data/spec/api_client_spec.rb

@@ -1,222 +0,0 @@
-# Copyright (c) 2018-2019 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
-
-# vcenter - VMware vCenter Server provides a centralized platform for managing your VMware vSphere environments
-
-
-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
-
-        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
-
-        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
-      end
-
-      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 "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
-
-        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
-    end
-  end
-
-  describe 'params_encoding in #build_request' do
-    let(:config) { VSphereAutomation::Configuration.new }
-    let(:api_client) { VSphereAutomation::ApiClient.new(config) }
-
-    it 'defaults to nil' do
-      expect(VSphereAutomation::Configuration.default.params_encoding).to eq(nil)
-      expect(config.params_encoding).to eq(nil)
-
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:params_encoding]).to eq(nil)
-    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)
-    end
-  end
-
-  describe 'timeout in #build_request' do
-    let(:config) { VSphereAutomation::Configuration.new }
-    let(:api_client) { VSphereAutomation::ApiClient.new(config) }
-
-    it 'defaults to 0' do
-      expect(VSphereAutomation::Configuration.default.timeout).to eq(0)
-      expect(config.timeout).to eq(0)
-
-      request = api_client.build_request(:get, '/test')
-      expect(request.options[:timeout]).to eq(0)
-    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
-
-  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
-
-  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)
-    end
-  end
-
-  describe '#build_collection_param' do
-    let(:param) { ['aa', 'bb', 'cc'] }
-    let(:api_client) { VSphereAutomation::ApiClient.new }
-
-    it 'works for csv' do
-      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
-    end
-
-    it 'works for ssv' do
-      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
-    end
-
-    it 'works for tsv' do
-      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
-    end
-
-    it 'works for pipes' do
-      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
-    end
-
-    it 'works for multi' do
-      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
-    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')
-    end
-  end
-
-  describe '#json_mime?' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
-
-    it 'works' do
-      expect(api_client.json_mime?(nil)).to eq false
-      expect(api_client.json_mime?('')).to eq false
-
-      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
-
-      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
-    end
-  end
-
-  describe '#select_header_accept' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
-
-    it 'works' do
-      expect(api_client.select_header_accept(nil)).to be_nil
-      expect(api_client.select_header_accept([])).to be_nil
-
-      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')
-
-      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')
-    end
-  end
-
-  describe '#select_header_content_type' do
-    let(:api_client) { VSphereAutomation::ApiClient.new }
-
-    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')
-
-      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
-
-  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')
-    end
-  end
-end