rbvmomi2 3.0.0 → 3.0.1

data/lib/rbvmomi/pbm.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
@@ -7,62 +8,63 @@ module RbVmomi
 
 # A connection to one vSphere ProfileBasedManagement endpoint.
 # @see #serviceInstance
-class PBM < Connection
-  # Connect to a vSphere ProfileBasedManagement endpoint
-  #
-  # @param [VIM] Connection to main vSphere API endpoint
-  # @param [Hash] opts The options hash.
-  # @option opts [String]  :host Host to connect to.
-  # @option opts [Numeric] :port (443) Port to connect to.
-  # @option opts [Boolean] :ssl (true) Whether to use SSL.
-  # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
-  # @option opts [String]  :path (/pbm/sdk) SDK endpoint path.
-  # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
-  def self.connect vim, opts = {}
-    fail unless opts.is_a? Hash
-    opts[:host] = vim.host
-    opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
-    opts[:insecure] ||= false
-    opts[:port] ||= (opts[:ssl] ? 443 : 80)
-    opts[:path] ||= '/pbm/sdk'
-    opts[:ns] ||= 'urn:pbm'
-    rev_given = opts[:rev] != nil
-    opts[:rev] = '1.0' unless rev_given
-    opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
+  class PBM < Connection
+    # Connect to a vSphere ProfileBasedManagement endpoint
+    #
+    # @param [VIM] Connection to main vSphere API endpoint
+    # @param [Hash] opts The options hash.
+    # @option opts [String]  :host Host to connect to.
+    # @option opts [Numeric] :port (443) Port to connect to.
+    # @option opts [Boolean] :ssl (true) Whether to use SSL.
+    # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
+    # @option opts [String]  :path (/pbm/sdk) SDK endpoint path.
+    # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+    def self.connect vim, opts = {}
+      raise unless opts.is_a? Hash
 
-    new(opts).tap do |pbm|
-      pbm.vcSessionCookie = vim.cookie.split('"')[1]
+      opts[:host] = vim.host
+      opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
+      opts[:insecure] ||= false
+      opts[:port] ||= (opts[:ssl] ? 443 : 80)
+      opts[:path] ||= '/pbm/sdk'
+      opts[:ns] ||= 'urn:pbm'
+      rev_given = opts[:rev] != nil
+      opts[:rev] = '1.0' unless rev_given
+      opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
+
+      new(opts).tap do |pbm|
+        pbm.vcSessionCookie = vim.cookie.split('"')[1]
+      end
     end
-  end
-  
-  def vcSessionCookie= cookie
-    @vcSessionCookie = cookie
-  end
 
-  def rev= x
-    super
-    @serviceContent = nil
-  end
+    def vcSessionCookie= cookie
+      @vcSessionCookie = cookie
+    end
 
-  # Return the ServiceInstance
-  #
-  # The ServiceInstance is the root of the vSphere inventory.
-  def serviceInstance
-    @serviceInstance ||= VIM::PbmServiceInstance self, 'ServiceInstance'
-  end
+    def rev= x
+      super
+      @serviceContent = nil
+    end
 
-  # Alias to serviceInstance.PbmRetrieveServiceContent
-  def serviceContent
-    @serviceContent ||= serviceInstance.PbmRetrieveServiceContent
-  end
+    # Return the ServiceInstance
+    #
+    # The ServiceInstance is the root of the vSphere inventory.
+    def serviceInstance
+      @serviceInstance ||= VIM::PbmServiceInstance self, 'ServiceInstance'
+    end
 
-  # @private
-  def pretty_print pp
-    pp.text "PBM(#{@opts[:host]})"
-  end
+    # Alias to serviceInstance.PbmRetrieveServiceContent
+    def serviceContent
+      @serviceContent ||= serviceInstance.PbmRetrieveServiceContent
+    end
 
-  add_extension_dir File.join(File.dirname(__FILE__), "pbm")
-  load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), "../../vmodl.db"))
-end
+    # @private
+    def pretty_print pp
+      pp.text "PBM(#{@opts[:host]})"
+    end
+
+    add_extension_dir File.join(File.dirname(__FILE__), 'pbm')
+    load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), '../../vmodl.db'))
+  end
 
 end

data/lib/rbvmomi/sms/SmsStorageManager.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 # Copyright (c) 2013-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
 class RbVmomi::SMS::SmsStorageManager
 
   def RegisterProvider_Task2 providerSpec
-     self.RegisterProvider_Task providerSpec
+    self.RegisterProvider_Task providerSpec
   end
 
 end

data/lib/rbvmomi/sms.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2013-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
@@ -6,58 +7,59 @@ module RbVmomi
 
 # A connection to one vSphere SMS endpoint.
 # @see #serviceInstance
-class SMS < Connection
-  # Connect to a vSphere SMS endpoint
-  #
-  # @param [VIM] Connection to main vSphere API endpoint
-  # @param [Hash] opts The options hash.
-  # @option opts [String]  :host Host to connect to.
-  # @option opts [Numeric] :port (443) Port to connect to.
-  # @option opts [Boolean] :ssl (true) Whether to use SSL.
-  # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
-  # @option opts [String]  :path (/sms/sdk) SDK endpoint path.
-  # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
-  def self.connect vim, opts = {}
-    fail unless opts.is_a? Hash
-    opts[:host] = vim.host
-    opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
-    opts[:insecure] ||= true
-    opts[:port] ||= (opts[:ssl] ? 443 : 80)
-    opts[:path] ||= '/sms/sdk'
-    opts[:ns] ||= 'urn:sms'
-    rev_given = opts[:rev] != nil
-    opts[:rev] = '4.0' unless rev_given
-    opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
-
-    new(opts).tap do |sms|
-      sms.vcSessionCookie = vim.cookie.split('"')[1]
+  class SMS < Connection
+    # Connect to a vSphere SMS endpoint
+    #
+    # @param [VIM] Connection to main vSphere API endpoint
+    # @param [Hash] opts The options hash.
+    # @option opts [String]  :host Host to connect to.
+    # @option opts [Numeric] :port (443) Port to connect to.
+    # @option opts [Boolean] :ssl (true) Whether to use SSL.
+    # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
+    # @option opts [String]  :path (/sms/sdk) SDK endpoint path.
+    # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+    def self.connect vim, opts = {}
+      raise unless opts.is_a? Hash
+
+      opts[:host] = vim.host
+      opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
+      opts[:insecure] ||= true
+      opts[:port] ||= (opts[:ssl] ? 443 : 80)
+      opts[:path] ||= '/sms/sdk'
+      opts[:ns] ||= 'urn:sms'
+      rev_given = opts[:rev] != nil
+      opts[:rev] = '4.0' unless rev_given
+      opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
+
+      new(opts).tap do |sms|
+        sms.vcSessionCookie = vim.cookie.split('"')[1]
+      end
     end
-  end
 
-  def vcSessionCookie= cookie
-    @vcSessionCookie = cookie
-  end
+    def vcSessionCookie= cookie
+      @vcSessionCookie = cookie
+    end
 
-  def rev= x
-    super
-    @serviceContent = nil
-  end
+    def rev= x
+      super
+      @serviceContent = nil
+    end
 
-  # Return the ServiceInstance
-  #
-  # The ServiceInstance is the root of the vSphere inventory.
-  def serviceInstance
-    @serviceInstance ||= VIM::SmsServiceInstance self, 'ServiceInstance'
-  end
+    # Return the ServiceInstance
+    #
+    # The ServiceInstance is the root of the vSphere inventory.
+    def serviceInstance
+      @serviceInstance ||= VIM::SmsServiceInstance self, 'ServiceInstance'
+    end
 
-  # @private
-  def pretty_print pp
-    pp.text "SMS(#{@opts[:host]})"
-  end
+    # @private
+    def pretty_print pp
+      pp.text "SMS(#{@opts[:host]})"
+    end
 
-  add_extension_dir File.join(File.dirname(__FILE__), "sms")
-  load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), "../../vmodl.db"))
-end
+    add_extension_dir File.join(File.dirname(__FILE__), 'sms')
+    load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), '../../vmodl.db'))
+  end
 
 end
 

data/lib/rbvmomi/sso.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'base64'
 require 'net/https'
 require 'nokogiri'
@@ -18,12 +19,12 @@ module RbVmomi
     TOKEN_TYPE = 'urn:oasis:names:tc:SAML:2.0:assertion'.freeze
     TOKEN_PROFILE = 'http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0'.freeze
     NAMESPACES = {
-      :ds => 'http://www.w3.org/2000/09/xmldsig#',
-      :soap => 'http://schemas.xmlsoap.org/soap/envelope/',
-      :wsse => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd',
-      :wsse11 => 'http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd',
-      :wst => 'http://docs.oasis-open.org/ws-sx/ws-trust/200512',
-      :wsu => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd'
+      ds: 'http://www.w3.org/2000/09/xmldsig#',
+      soap: 'http://schemas.xmlsoap.org/soap/envelope/',
+      wsse: 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd',
+      wsse11: 'http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd',
+      wst: 'http://docs.oasis-open.org/ws-sx/ws-trust/200512',
+      wsu: 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd'
     }.freeze
 
     attr_reader :assertion,
@@ -110,14 +111,14 @@ module RbVmomi
       end
 
       signed = sign(request)
-      signed.gsub!('SAML_ASSERTION_PLACEHOLDER', @assertion.to_xml(:indent => 0, :save_with => Nokogiri::XML::Node::SaveOptions::AS_XML).strip)
+      signed.gsub!('SAML_ASSERTION_PLACEHOLDER', @assertion.to_xml(indent: 0, save_with: Nokogiri::XML::Node::SaveOptions::AS_XML).strip)
 
       signed
     end
 
     # We default to Issue, since that's all we currently need.
     def sso_call(body)
-      sso_url = URI::HTTPS.build(:host => @host, :port => @port, :path => @path)
+      sso_url = URI::HTTPS.build(host: @host, port: @port, path: @path)
       http = Net::HTTP.new(sso_url.host, sso_url.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @insecure
@@ -209,23 +210,17 @@ module RbVmomi
       signature_value_tag = doc.at_xpath('/soap:Envelope/soap:Header/wsse:Security/ds:Signature/ds:SignatureValue', doc.collect_namespaces)
       signature_value_tag.add_child(Nokogiri::XML::Text.new(signature, doc))
 
-      doc.to_xml(:indent => 0, :save_with => Nokogiri::XML::Node::SaveOptions::AS_XML).strip
+      doc.to_xml(indent: 0, save_with: Nokogiri::XML::Node::SaveOptions::AS_XML).strip
     end
 
     def load_x509(private_key, certificate)
       @private_key = private_key ? private_key : OpenSSL::PKey::RSA.new(2048)
-      if @private_key.is_a? String
-        @private_key = OpenSSL::PKey::RSA.new(@private_key)
-      end
+      @private_key = OpenSSL::PKey::RSA.new(@private_key) if @private_key.is_a? String
 
       @certificate = certificate
-      if @certificate && !private_key
-        raise(ArgumentError, "Can't generate private key from a certificate")
-      end
+      raise(ArgumentError, "Can't generate private key from a certificate") if @certificate && !private_key
 
-      if @certificate.is_a? String
-        @certificate = OpenSSL::X509::Certificate.new(@certificate)
-      end
+      @certificate = OpenSSL::X509::Certificate.new(@certificate) if @certificate.is_a? String
       # If only a private key is specified, we will generate a certificate.
       unless @certificate
         timestamp = Time.now.utc

data/lib/rbvmomi/trivial_soap.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
@@ -12,9 +13,11 @@ class RbVmomi::TrivialSoap
   attr_reader :http
 
   def initialize opts
-    fail unless opts.is_a? Hash
+    raise unless opts.is_a? Hash
+
     @opts = opts
     return unless @opts[:host] # for testcases
+
     @debug = @opts[:debug]
     @cookie = @opts[:cookie]
     @sso = @opts[:sso]
@@ -33,7 +36,7 @@ class RbVmomi::TrivialSoap
   end
 
   def restart_http
-    begin 
+    begin
       @http.finish if @http
     rescue Exception => ex
       puts "WARNING: Ignoring exception: #{ex.message}"
@@ -61,7 +64,7 @@ class RbVmomi::TrivialSoap
     xsd = 'http://www.w3.org/2001/XMLSchema'
     env = 'http://schemas.xmlsoap.org/soap/envelope/'
     xsi = 'http://www.w3.org/2001/XMLSchema-instance'
-    xml = Builder::XmlMarkup.new :indent => 0
+    xml = Builder::XmlMarkup.new indent: 0
     xml.tag!('env:Envelope', 'xmlns:xsd' => xsd, 'xmlns:env' => env, 'xmlns:xsi' => xsi) do
       if @vcSessionCookie || @operation_id
         xml.tag!('env:Header') do
@@ -82,7 +85,7 @@ class RbVmomi::TrivialSoap
     headers['cookie'] = @cookie if @cookie
 
     if @debug
-      $stderr.puts "Request:"
+      $stderr.puts 'Request:'
       $stderr.puts body
       $stderr.puts
     end
@@ -102,10 +105,8 @@ class RbVmomi::TrivialSoap
       end
     end
     end_time = Time.now
-    
-    if response.is_a? Net::HTTPServiceUnavailable
-      raise "Got HTTP 503: Service unavailable"
-    end
+
+    raise 'Got HTTP 503: Service unavailable' if response.is_a? Net::HTTPServiceUnavailable
 
     self.cookie = response['set-cookie'] if response.key? 'set-cookie'
 

data/lib/rbvmomi/type_loader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
@@ -6,133 +7,131 @@ require 'monitor'
 
 module RbVmomi
 
-class TypeLoader
-  def initialize fn, extension_dirs, namespace
-    @extension_dirs = extension_dirs
-    @namespace = namespace
-    @lock = Monitor.new
-    @db = {}
-    @id2wsdl = {}
-    @loaded = {}
-    add_types Hash[BasicTypes::BUILTIN.map { |k| [k,nil] }]
-    vmodl_database = File.open(fn, 'r') { |io| Marshal.load io }
-    vmodl_database.reject! { |k,v| k =~ /^_/ }
-    add_types vmodl_database
-    preload
-  end
-
-  def preload
-    names = (@namespace.constants + Object.constants).map(&:to_s).uniq.
-                                                      select { |x| has? x }
-    names.each { |x| get(x) }
-  end
+  class TypeLoader
+    def initialize fn, extension_dirs, namespace
+      @extension_dirs = extension_dirs
+      @namespace = namespace
+      @lock = Monitor.new
+      @db = {}
+      @id2wsdl = {}
+      @loaded = {}
+      add_types Hash[BasicTypes::BUILTIN.map { |k| [k, nil] }]
+      vmodl_database = File.open(fn, 'r') { |io| Marshal.load io }
+      vmodl_database.reject! { |k, v| k =~ /^_/ }
+      add_types vmodl_database
+      preload
+    end
 
-  # Reload all extensions for loaded VMODL types
-  def reload_extensions
-    @extension_dirs.each do |path|
-      reload_extensions_dir path
+    def preload
+      names = (@namespace.constants + Object.constants).map(&:to_s).uniq.
+                                                        select { |x| has? x }
+      names.each { |x| get(x) }
     end
-  end
 
-  # Reload all extensions for loaded VMODL types from the given directory
-  def reload_extensions_dir path
-    loaded = Set.new(typenames.select { |x| @namespace.const_defined? x })
-    Dir.open(path) do |dir|
-      dir.each do |file|
-        next unless file =~ /\.rb$/
-        next unless loaded.member? $`
-        file_path = File.join(dir, file)
-        load file_path
+    # Reload all extensions for loaded VMODL types
+    def reload_extensions
+      @extension_dirs.each do |path|
+        reload_extensions_dir path
       end
     end
-  end
 
-  def has? name
-    fail unless name.is_a? String
+    # Reload all extensions for loaded VMODL types from the given directory
+    def reload_extensions_dir path
+      loaded = Set.new(typenames.select { |x| @namespace.const_defined? x })
+      Dir.open(path) do |dir|
+        dir.each do |file|
+          next unless file =~ /\.rb$/
+          next unless loaded.member? $`
 
-    @db.member?(name) or BasicTypes::BUILTIN.member?(name)
-  end
+          file_path = File.join(dir, file)
+          load file_path
+        end
+      end
+    end
 
-  def get name
-    fail "name '#{name}' is #{name.class} expecting String" unless name.is_a? String
+    def has? name
+      raise unless name.is_a? String
 
-    first_char = name[0].chr
-    if first_char.downcase == first_char
-      name = "%s%s" % [first_char.upcase, name[1..-1]]
+      @db.member?(name) or BasicTypes::BUILTIN.member?(name)
     end
 
-    return @loaded[name] if @loaded.member? name
-    @lock.synchronize do
+    def get name
+      raise "name '#{name}' is #{name.class} expecting String" unless name.is_a? String
+
+      first_char = name[0].chr
+      name = '%s%s' % [first_char.upcase, name[1..-1]] if first_char.downcase == first_char
+
       return @loaded[name] if @loaded.member? name
-      klass = make_type(name)
-      @namespace.const_set name, klass
-      load_extension name
-      @loaded[name] = klass
+
+      @lock.synchronize do
+        return @loaded[name] if @loaded.member? name
+
+        klass = make_type(name)
+        @namespace.const_set name, klass
+        load_extension name
+        @loaded[name] = klass
+      end
     end
-  end
 
-  def add_types types
-    @lock.synchronize do
-      @db.merge! types
-      @db = Hash[@db.map do |name, value|
-        if value
-          value['wsdl_name'] ||= name
-        end
-        first_char = name[0].chr
-        if first_char.downcase == first_char
-          name = "%s%s" % [first_char.upcase, name[1..-1]]
-        end
-        [name, value]
-      end]
+    def add_types types
+      @lock.synchronize do
+        @db.merge! types
+        @db = Hash[@db.map do |name, value|
+          value['wsdl_name'] ||= name if value
+          first_char = name[0].chr
+          name = '%s%s' % [first_char.upcase, name[1..-1]] if first_char.downcase == first_char
+          [name, value]
+        end]
+      end
     end
-  end
 
-  def typenames
-    @db.keys
-  end
+    def typenames
+      @db.keys
+    end
 
-  private
+    private
 
-  def load_extension name
-    @extension_dirs.map { |x| File.join(x, "#{name}.rb") }.
-                    select { |x| File.exist? x }.
-                    each { |x| load x }
-  end
+    def load_extension name
+      @extension_dirs.map { |x| File.join(x, "#{name}.rb") }.
+                      select { |x| File.exist? x }.
+                      each { |x| load x }
+    end
+
+    def make_type name
+      name = name.to_s
+      return BasicTypes.const_get(name) if BasicTypes::BUILTIN.member? name
 
-  def make_type name
-    name = name.to_s
-    return BasicTypes.const_get(name) if BasicTypes::BUILTIN.member? name
-    desc = @db[name] or fail "unknown VMODL type #{name}"
-    case desc['kind']
-    when 'data' then make_data_type name, desc
-    when 'managed' then make_managed_type name, desc
-    when 'enum' then make_enum_type name, desc
-    else fail desc.inspect
+      desc = @db[name] or raise "unknown VMODL type #{name}"
+      case desc['kind']
+      when 'data' then make_data_type name, desc
+      when 'managed' then make_managed_type name, desc
+      when 'enum' then make_enum_type name, desc
+      else raise desc.inspect
+      end
     end
-  end
 
-  def make_data_type name, desc
-    superclass = get desc['wsdl_base']
-    Class.new(superclass).tap do |klass|
-      klass.init name, desc['props']
-      klass.wsdl_name = desc['wsdl_name']
+    def make_data_type name, desc
+      superclass = get desc['wsdl_base']
+      Class.new(superclass).tap do |klass|
+        klass.init name, desc['props']
+        klass.wsdl_name = desc['wsdl_name']
+      end
     end
-  end
 
-  def make_managed_type name, desc
-    superclass = get desc['wsdl_base']
-    Class.new(superclass).tap do |klass|
-      klass.init name, desc['props'], desc['methods']
-      klass.wsdl_name = desc['wsdl_name']
+    def make_managed_type name, desc
+      superclass = get desc['wsdl_base']
+      Class.new(superclass).tap do |klass|
+        klass.init name, desc['props'], desc['methods']
+        klass.wsdl_name = desc['wsdl_name']
+      end
     end
-  end
 
-  def make_enum_type name, desc
-    Class.new(BasicTypes::Enum).tap do |klass|
-      klass.init name, desc['values']
-      klass.wsdl_name = desc['wsdl_name']
+    def make_enum_type name, desc
+      Class.new(BasicTypes::Enum).tap do |klass|
+        klass.init name, desc['values']
+        klass.wsdl_name = desc['wsdl_name']
+      end
     end
   end
-end
 
 end