ovirt-engine-sdk 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc70e7bc96b552de89ef13a91ae7ceb1f4a3bbb0
-  data.tar.gz: 5ad0eb7711a5f490acf4774169bb480d65d8f0cc
+  metadata.gz: ecdf7ff085e2d14fdca2923dc0b77b35597c2af9
+  data.tar.gz: 620d7620903f1c24346b49e6b36c334e9b18ec29
 SHA512:
-  metadata.gz: f2f28c98d659ae7a54fc0b7fdc98042d22005c3d01825b91d1e9df8018e480adbb79f69b751289cecc2a8cd2ff6ee3037cf3c7779d3781102e19957d3360c3e4
-  data.tar.gz: 919165505e1e6b2fe06c80f2eda1d0556c9a628c53abf42309be2433e44b695de12b00ce14fb73de41f7c137d533938ca7d7fc4efbb9a1dfa4b991b52b56cefb
+  metadata.gz: 7f9d24ced354d42aa6f9e63b2122c59a898331d442742363f81345ecd3b96f02d3c5ac02de08e4d5534fe2651c6dea28dba7e5424c4047d20845dbb0d018e7dc
+  data.tar.gz: 8a14c4b538b101f78eee8f36e1862777f9574bb2c1bcf29664cb5b65b506fff966f3bfa10392968cf4b9c665d746a20d802532b79c8696aa67833c013d647dd9

data/CHANGES.adoc

@@ -2,6 +2,27 @@
 
 This document describes the relevant changes between releases of the SDK.
 
+== 4.0.2 / Sep 29 2016
+
+New features:
+
+* Add generic `Writer.write` method to support generating XML from
+  objects of unknown types.
+
+* Add new `Probe.probe` method to detect the versions of the API
+  supported by the server.
+
+Bug fixes:
+
+* Add support for optional parameters to update methods.
+
+* Use XML schema naming exceptions to correctly generate tag names like
+  `openstack_image_provider`.
+
+* Write correctly lists of enum values  https://bugzilla.redhat.com/1378066[#1378066].
+
+* Write correctly empty lists of enum values.
+
 == 4.0.1 / Sep 6 2016
 
 Update to model 4.0.33.

data/lib/ovirtsdk4.rb

@@ -37,3 +37,4 @@ require 'ovirtsdk4/writer.rb'
 require 'ovirtsdk4/writers.rb'
 require 'ovirtsdk4/service.rb'
 require 'ovirtsdk4/services.rb'
+require 'ovirtsdk4/probe.rb'

data/lib/ovirtsdk4/http.rb

@@ -137,6 +137,7 @@ module OvirtSDK4
       @kerberos = opts[:kerberos] || false
       @timeout = opts[:timeout] || 0
       @compress = opts[:compress] || false
+      @auth = opts[:auth] || :oauth
 
       # Check mandatory parameters:
       if url.nil?
@@ -179,7 +180,6 @@ module OvirtSDK4
           end
         end
       end
-
     end
 
     #
@@ -223,27 +223,16 @@ module OvirtSDK4
     # @api private
     #
     def send(request)
-      # Check if we already have an SSO access token:
-      @token ||= get_access_token
-
       # Build the URL:
       @curl.url = build_url({
         :path => request.path,
         :query => request.query,
       })
 
-      # Add headers, avoiding those that have no value:
-      @curl.headers.clear
-      @curl.headers.merge!(request.headers)
-      @curl.headers['User-Agent'] = "RubySDK/#{VERSION}"
-      @curl.headers['Version'] = '4'
-      @curl.headers['Content-Type'] = 'application/xml'
-      @curl.headers['Accept'] = 'application/xml'
-      @curl.headers['Authorization'] = "Bearer #{@token}"
-
+      set_headers!(request)
+      set_authentication!
       # Clear any data that may be in the buffers:
       @curl.post_body = nil
-
       # Send the request and wait for the response:
       case request.method
       when :DELETE
@@ -543,6 +532,34 @@ module OvirtSDK4
       return url
     end
 
+    private
+
+    # @api private
+    def set_authentication!
+      case @auth
+      when :oauth
+        # Check if we already have an SSO access token:
+        @token ||= get_access_token
+        @curl.headers['Authorization'] = "Bearer #{@token}"
+      when :basic
+        @curl.http_auth_types = :basic
+        @curl.username = @username
+        @curl.password = @password
+      end
+    end
+
+    # @api private
+    def set_headers!(request)
+      # Add headers, avoiding those that have no value:
+      @curl.headers.clear
+      @curl.headers['user-agent'] = "RubySDK/#{VERSION}"
+      @curl.headers['content-type'] = 'application/xml'
+      @curl.headers['accept'] = 'application/xml'
+      @curl.headers['version'] = 4
+      request.headers.each do |k,v|
+        @curl.headers[k.to_s.downcase] = v
+      end
+    end
   end
 
 end

data/lib/ovirtsdk4/probe.rb

@@ -0,0 +1,244 @@
+#
+# Copyright (c) 2016 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module OvirtSDK4
+  #
+  # This class is used to probe the engine to find which API versions it supports.
+  #
+  class Probe
+    attr_reader :path_detector,
+                :version_detector
+
+    #
+    # This class method receives a set of options that define the server to probe and returns an arrays of objects of
+    # the OvirtSDK4::ProbeResult class containing the results of the probe.
+    #
+    # @options opts [Hash] The options used to create the probe.
+    #
+    # @option opts [String] :host The name or IP address of the host to probe.
+    #
+    # @option opts [Integer] :port (443) The port number to probe.
+    #
+    # @option opts [String] :username The name of the user, something like `admin@internal`.
+    #
+    # @option opts [String] :password The password of the user.
+    #
+    # @option opts [Boolean] :insecure (false) A boolean flag that indicates if the server TLS certificate and host
+    #   name should be checked.
+    #
+    # @option opts [String] :ca_file The name of a PEM file containing the trusted CA certificates. The certificate
+    #   presented by the server will be verified using these CA certificates. If not set then the system wide CA
+    #   certificates store is used.
+    #
+    # @option opts [String] :log The logger where the log messages will be written.
+    #
+    # @option opts [Boolean] :debug (false)  (false) A boolean flag indicating if debug output should be generated. If
+    #   the values is `true` and the `log` parameter isn't `nil` then the data sent to and received from the server
+    #   will be written to the log. Be aware that user names and passwords will also be written, so handle with care.
+    #
+    def self.probe(opts)
+      new(path_detector: PathDetector.new,
+          version_detector: VersionDetector.new)
+        .probe(opts)
+    end
+
+    #
+    # Creates a new probe instance.
+    #
+    # @param opts [Hash] The options for the initalization for the probe instance.
+    #
+    # @option opts [PathDetector] :path_detector An instance of a class that can recevie a connection and return the
+    #   servers API path.
+    #
+    # @options opts [VersionDetector] :version_detector An instance of a class that can receive a connection and an
+    #   API path and return the API versions the server supports.
+    #
+    # @api private
+    #
+    def initialize(opts)
+      @path_detector = opts[:path_detector]
+      @version_detector = opts[:version_detector]
+    end
+
+    #
+    # This instance method receives a set of options that define the server to probe and returns the API versions that
+    # the server supports.
+    #
+    # @param opts [Hash] The options to base the probing on. See the `probe` class method for details.
+    #
+    # @api private
+    #
+    def probe(opts)
+      path = path_detector.detect(opts)
+      raise OvirtSDK4::Error.new('API path not found') unless path
+      version_detector.detect(opts, path).map { |version| ProbeResult.new(version: version) }
+    end
+  end
+
+  #
+  # This class is responsible for detecting the API path an oVirt server.
+  #
+  # @api private
+  #
+  class PathDetector
+    PATH_CANDIDATES = [
+      '/api',
+      '/ovirt-engine/api'
+    ].freeze
+
+    def detect(opts)
+      PATH_CANDIDATES.each do |path|
+        begin
+          connection = ConnectionBuilder.build(opts.merge(path: path))
+          res = connection.send(request)
+          return path if res.code == 200
+          raise OvirtSDK4::Error.new('Unauthorized') if res.code == 401
+        ensure
+          connection.close if connection
+        end
+      end
+      nil
+    end
+
+    def request
+      Request.new(path: '')
+    end
+  end
+
+  #
+  # Class contains class methods to build connections from options.
+  #
+  # @api private
+  #
+  class ConnectionBuilder
+    DEFAULT_PORT = 443
+
+    def self.build(opts)
+      Connection.new(
+        url:      build_url(opts),
+        username: opts[:username],
+        password: opts[:password],
+        insecure: opts[:insecure],
+        ca_file:  opts[:ca_file],
+        log:      opts[:log],
+        debug:    opts[:debug],
+        auth:     :basic
+      )
+    end
+
+    def self.build_url(opts)
+      host = opts[:host]
+      path = opts[:path]
+      port = opts[:port] || DEFAULT_PORT
+      "https://#{host}:#{port}#{path}"
+    end
+  end
+
+  #
+  # This class is responsible for detecting the API versions an oVirt server engine supports.
+  #
+  # @api private
+  #
+  class VersionDetector
+    attr_accessor :supported_versions,
+                  :path,
+                  :connection
+
+    def detect(connection_opts, path)
+      @connection = ConnectionBuilder.build(connection_opts.merge(path: path))
+      self.path = path
+      supported_versions = []
+      supported_versions << '3' if detect_v3
+      supported_versions << '4' if detect_v4
+      supported_versions
+    ensure
+      @connection.close if @connection
+    end
+
+    private
+
+    def detect_v3
+      res = connection.send(request_for_v3_detection)
+      special_response_regexp_in_api3 =~ res.body
+    end
+
+    def detect_v4
+      res = connection.send(request_for_v4_detection)
+      special_response_regexp_in_api4 =~ res.body
+    end
+
+    def request_for_v3_detection
+      OvirtSDK4::Request.new(
+        path: '',
+        headers: { version: 3 },
+      )
+    end
+
+    def request_for_v4_detection
+      OvirtSDK4::Request.new(
+        path: '',
+        headers: { version: 4 },
+      )
+    end
+
+    # The methods below are based on headers oVirt returns depending on the API
+    # version it supports when queried with <version: 3> or <version: 4> header.
+    # Refer to spec to see the return values.
+    def special_response_regexp_in_api3
+      /major=/
+    end
+
+    def special_response_regexp_in_api4
+      /<major>/
+    end
+  end
+
+  #
+  # The probe returns an array of instances of this class.
+  #
+  class ProbeResult
+    attr_reader :version
+
+    #
+    # This method is used to initialize a class instance,
+    #
+    # @param opts [Hash] The attributes of the result.
+    #
+    # @option opts [String] :version The version obtained as the result of the probe.
+    #
+    def initialize(opts)
+      @version = opts[:version]
+    end
+
+    # Override the comparison method.
+    def ==(o)
+      o.class == self.class && o.state == state
+    end
+
+    alias_method :eql?, :==
+
+    # Should always be overriden if one overrides ==, used to get a hash value
+    # for the object.
+    def hash
+      state.hash
+    end
+
+    #@api private
+    def state
+      [version]
+    end
+  end
+end

data/lib/ovirtsdk4/services.rb

@@ -810,7 +810,7 @@ module OvirtSDK4
     # 
     # @return [AffinityGroup]
     # 
-    def update(group)
+    def update(group, opts = {})
       if group.is_a?(Hash)
         group = OvirtSDK4::AffinityGroup.new(group)
       end
@@ -1256,7 +1256,7 @@ module OvirtSDK4
     # 
     # @return [AffinityLabel]
     # 
-    def update(label)
+    def update(label, opts = {})
       if label.is_a?(Hash)
         label = OvirtSDK4::AffinityLabel.new(label)
       end
@@ -2535,7 +2535,7 @@ module OvirtSDK4
     # 
     # @return [Network]
     # 
-    def update(network)
+    def update(network, opts = {})
       if network.is_a?(Hash)
         network = OvirtSDK4::Network.new(network)
       end
@@ -3918,7 +3918,7 @@ module OvirtSDK4
     # 
     # @return [Bookmark]
     # 
-    def update(bookmark)
+    def update(bookmark, opts = {})
       if bookmark.is_a?(Hash)
         bookmark = OvirtSDK4::Bookmark.new(bookmark)
       end
@@ -4203,7 +4203,7 @@ module OvirtSDK4
     # 
     # @return [Cluster]
     # 
-    def update(cluster)
+    def update(cluster, opts = {})
       if cluster.is_a?(Hash)
         cluster = OvirtSDK4::Cluster.new(cluster)
       end
@@ -4787,7 +4787,7 @@ module OvirtSDK4
     # 
     # @return [CpuProfile]
     # 
-    def update(profile)
+    def update(profile, opts = {})
       if profile.is_a?(Hash)
         profile = OvirtSDK4::CpuProfile.new(profile)
       end
@@ -5076,7 +5076,7 @@ module OvirtSDK4
     # 
     # @return [DataCenter]
     # 
-    def update(data_center)
+    def update(data_center, opts = {})
       if data_center.is_a?(Hash)
         data_center = OvirtSDK4::DataCenter.new(data_center)
       end
@@ -5461,7 +5461,7 @@ module OvirtSDK4
     # 
     # @return [DiskAttachment]
     # 
-    def update(disk_attachment)
+    def update(disk_attachment, opts = {})
       if disk_attachment.is_a?(Hash)
         disk_attachment = OvirtSDK4::DiskAttachment.new(disk_attachment)
       end
@@ -5727,7 +5727,7 @@ module OvirtSDK4
     # 
     # @return [DiskProfile]
     # 
-    def update(profile)
+    def update(profile, opts = {})
       if profile.is_a?(Hash)
         profile = OvirtSDK4::DiskProfile.new(profile)
       end
@@ -8214,7 +8214,7 @@ module OvirtSDK4
     # 
     # @return [Agent]
     # 
-    def update(agent)
+    def update(agent, opts = {})
       if agent.is_a?(Hash)
         agent = OvirtSDK4::Agent.new(agent)
       end
@@ -11422,7 +11422,7 @@ module OvirtSDK4
     # 
     # @return [InstanceType]
     # 
-    def update(instance_type)
+    def update(instance_type, opts = {})
       if instance_type.is_a?(Hash)
         instance_type = OvirtSDK4::InstanceType.new(instance_type)
       end
@@ -11592,7 +11592,7 @@ module OvirtSDK4
     # 
     # @return [Nic]
     # 
-    def update(nic)
+    def update(nic, opts = {})
       if nic.is_a?(Hash)
         nic = OvirtSDK4::Nic.new(nic)
       end
@@ -11843,7 +11843,7 @@ module OvirtSDK4
     # 
     # @return [Watchdog]
     # 
-    def update(watchdog)
+    def update(watchdog, opts = {})
       if watchdog.is_a?(Hash)
         watchdog = OvirtSDK4::Watchdog.new(watchdog)
       end
@@ -12217,7 +12217,7 @@ module OvirtSDK4
     # 
     # @return [IscsiBond]
     # 
-    def update(bond)
+    def update(bond, opts = {})
       if bond.is_a?(Hash)
         bond = OvirtSDK4::IscsiBond.new(bond)
       end
@@ -12906,7 +12906,7 @@ module OvirtSDK4
     # 
     # @return [MacPool]
     # 
-    def update(pool)
+    def update(pool, opts = {})
       if pool.is_a?(Hash)
         pool = OvirtSDK4::MacPool.new(pool)
       end
@@ -13280,7 +13280,7 @@ module OvirtSDK4
     # 
     # @return [Network]
     # 
-    def update(network)
+    def update(network, opts = {})
       if network.is_a?(Hash)
         network = OvirtSDK4::Network.new(network)
       end
@@ -13450,7 +13450,7 @@ module OvirtSDK4
     # 
     # @return [NetworkAttachment]
     # 
-    def update(attachment)
+    def update(attachment, opts = {})
       if attachment.is_a?(Hash)
         attachment = OvirtSDK4::NetworkAttachment.new(attachment)
       end
@@ -14346,7 +14346,7 @@ module OvirtSDK4
     # 
     # @return [OpenStackImageProvider]
     # 
-    def update(provider)
+    def update(provider, opts = {})
       if provider.is_a?(Hash)
         provider = OvirtSDK4::OpenStackImageProvider.new(provider)
       end
@@ -14878,7 +14878,7 @@ module OvirtSDK4
     # 
     # @return [OpenStackNetworkProvider]
     # 
-    def update(provider)
+    def update(provider, opts = {})
       if provider.is_a?(Hash)
         provider = OvirtSDK4::OpenStackNetworkProvider.new(provider)
       end
@@ -15451,7 +15451,7 @@ module OvirtSDK4
     # 
     # @return [OpenstackVolumeAuthenticationKey]
     # 
-    def update(key)
+    def update(key, opts = {})
       if key.is_a?(Hash)
         key = OvirtSDK4::OpenstackVolumeAuthenticationKey.new(key)
       end
@@ -15751,7 +15751,7 @@ module OvirtSDK4
     # 
     # @return [OpenStackVolumeProvider]
     # 
-    def update(provider)
+    def update(provider, opts = {})
       if provider.is_a?(Hash)
         provider = OvirtSDK4::OpenStackVolumeProvider.new(provider)
       end
@@ -16642,7 +16642,7 @@ module OvirtSDK4
     # 
     # @return [Qos]
     # 
-    def update(qos)
+    def update(qos, opts = {})
       if qos.is_a?(Hash)
         qos = OvirtSDK4::Qos.new(qos)
       end
@@ -16893,7 +16893,7 @@ module OvirtSDK4
     # 
     # @return [Quota]
     # 
-    def update(quota)
+    def update(quota, opts = {})
       if quota.is_a?(Hash)
         quota = OvirtSDK4::Quota.new(quota)
       end
@@ -17602,7 +17602,7 @@ module OvirtSDK4
     # 
     # @return [Role]
     # 
-    def update(role)
+    def update(role, opts = {})
       if role.is_a?(Hash)
         role = OvirtSDK4::Role.new(role)
       end
@@ -18004,7 +18004,7 @@ module OvirtSDK4
     # 
     # @return [SchedulingPolicy]
     # 
-    def update(policy)
+    def update(policy, opts = {})
       if policy.is_a?(Hash)
         policy = OvirtSDK4::SchedulingPolicy.new(policy)
       end
@@ -19097,7 +19097,7 @@ module OvirtSDK4
     # 
     # @return [SshPublicKey]
     # 
-    def update(key)
+    def update(key, opts = {})
       if key.is_a?(Hash)
         key = OvirtSDK4::SshPublicKey.new(key)
       end
@@ -19968,7 +19968,7 @@ module OvirtSDK4
     # 
     # @return [StorageDomain]
     # 
-    def update(storage_domain)
+    def update(storage_domain, opts = {})
       if storage_domain.is_a?(Hash)
         storage_domain = OvirtSDK4::StorageDomain.new(storage_domain)
       end
@@ -21320,7 +21320,7 @@ module OvirtSDK4
     # 
     # @return [StorageConnection]
     # 
-    def update(connection)
+    def update(connection, opts = {})
       if connection.is_a?(Hash)
         connection = OvirtSDK4::StorageConnection.new(connection)
       end
@@ -21448,7 +21448,7 @@ module OvirtSDK4
     # 
     # @return [StorageConnectionExtension]
     # 
-    def update(extension)
+    def update(extension, opts = {})
       if extension.is_a?(Hash)
         extension = OvirtSDK4::StorageConnectionExtension.new(extension)
       end
@@ -22565,7 +22565,7 @@ module OvirtSDK4
     # 
     # @return [Tag]
     # 
-    def update(tag)
+    def update(tag, opts = {})
       if tag.is_a?(Hash)
         tag = OvirtSDK4::Tag.new(tag)
       end
@@ -22852,7 +22852,7 @@ module OvirtSDK4
     # 
     # @return [Template]
     # 
-    def update(template)
+    def update(template, opts = {})
       if template.is_a?(Hash)
         template = OvirtSDK4::Template.new(template)
       end
@@ -23640,7 +23640,7 @@ module OvirtSDK4
     # 
     # @return [Nic]
     # 
-    def update(nic)
+    def update(nic, opts = {})
       if nic.is_a?(Hash)
         nic = OvirtSDK4::Nic.new(nic)
       end
@@ -23891,7 +23891,7 @@ module OvirtSDK4
     # 
     # @return [Watchdog]
     # 
-    def update(watchdog)
+    def update(watchdog, opts = {})
       if watchdog.is_a?(Hash)
         watchdog = OvirtSDK4::Watchdog.new(watchdog)
       end
@@ -25576,7 +25576,7 @@ module OvirtSDK4
     # 
     # @return [Vm]
     # 
-    def update(vm)
+    def update(vm, opts = {})
       if vm.is_a?(Hash)
         vm = OvirtSDK4::Vm.new(vm)
       end
@@ -26084,7 +26084,7 @@ module OvirtSDK4
     # 
     # @return [Cdrom]
     # 
-    def update(cdrom)
+    def update(cdrom, opts = {})
       if cdrom.is_a?(Hash)
         cdrom = OvirtSDK4::Cdrom.new(cdrom)
       end
@@ -26415,7 +26415,7 @@ module OvirtSDK4
     # 
     # @return [Disk]
     # 
-    def update(disk)
+    def update(disk, opts = {})
       if disk.is_a?(Hash)
         disk = OvirtSDK4::Disk.new(disk)
       end
@@ -27085,7 +27085,7 @@ module OvirtSDK4
     # 
     # @return [Nic]
     # 
-    def update(nic)
+    def update(nic, opts = {})
       if nic.is_a?(Hash)
         nic = OvirtSDK4::Nic.new(nic)
       end
@@ -27364,7 +27364,7 @@ module OvirtSDK4
     # 
     # @return [VirtualNumaNode]
     # 
-    def update(node)
+    def update(node, opts = {})
       if node.is_a?(Hash)
         node = OvirtSDK4::VirtualNumaNode.new(node)
       end
@@ -27649,7 +27649,7 @@ module OvirtSDK4
     # 
     # @return [VmPool]
     # 
-    def update(pool)
+    def update(pool, opts = {})
       if pool.is_a?(Hash)
         pool = OvirtSDK4::VmPool.new(pool)
       end
@@ -28240,7 +28240,7 @@ module OvirtSDK4
     # 
     # @return [Watchdog]
     # 
-    def update(watchdog)
+    def update(watchdog, opts = {})
       if watchdog.is_a?(Hash)
         watchdog = OvirtSDK4::Watchdog.new(watchdog)
       end
@@ -28810,7 +28810,7 @@ module OvirtSDK4
     # 
     # @return [VnicProfile]
     # 
-    def update(profile)
+    def update(profile, opts = {})
       if profile.is_a?(Hash)
         profile = OvirtSDK4::VnicProfile.new(profile)
       end
@@ -29646,7 +29646,7 @@ module OvirtSDK4
     # 
     # @return [ExternalHostProvider]
     # 
-    def update(provider)
+    def update(provider, opts = {})
       if provider.is_a?(Hash)
         provider = OvirtSDK4::ExternalHostProvider.new(provider)
       end
@@ -30924,7 +30924,7 @@ module OvirtSDK4
     # 
     # @return [Host]
     # 
-    def update(host)
+    def update(host, opts = {})
       if host.is_a?(Hash)
         host = OvirtSDK4::Host.new(host)
       end