ovirt-engine-sdk 4.0.0.alpha15 → 4.0.0.alpha16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45f68dcb075baaac787e50ab40a5216f83007bee
-  data.tar.gz: a2551fe22711d50fa1403679945f7b7f5ce46439
+  metadata.gz: c80b2e7a94752a957caf5fbd45ff4a91d5889d12
+  data.tar.gz: 41c7ca64c5079f96b24e15df22132158bbe951d2
 SHA512:
-  metadata.gz: 2cadec05dd57ba9e08d040d117d9ffa03cfc296d2451e91ac4a345a6635ac8a5a3b922f3322f10aa37c993c5704268379d20015f62273e5dc74399c02ad9ed26
-  data.tar.gz: 302fd95b00e9742c35b7960d6b1f8c4f06bd71be3411de5d273f4486e6cfb17f81b5d85480c33902715235ef1ed528734a69ce10c8db11aceec82dd407eebc26
+  metadata.gz: b0ddc42749d4ee4783ab17ea5099c4c772d17677e87c35ebf1e2bc174e03201de2cac044260131ebc527d38a53f6eaa30293dda1821787640df4f10af1460976
+  data.tar.gz: 6922ca5d7c89985404dd5270aaf1af139afaa15cd4b11602e6b8e3e35bd9cad4de0b4a8632f6d5e83a31310a56248227d46e331fae399d8f04901f4d0192ebcc

data/CHANGES.adoc

@@ -0,0 +1,13 @@
+= Changes
+
+This document describes the relevant changes between releases of the
+API model.
+
+== 4.0.0.alpha16 / Jul 15 2016
+
+New features:
+
+* Use `Logger` instead of file for the `:log` parameter of the
+  connection class.
+
+* Add `dig` method to all types.

data/lib/ovirtsdk4/http.rb

@@ -109,13 +109,10 @@ module OvirtSDK4
     #   certificates store is used.
     #
     # @option opts [Boolean] :debug (false) A boolean flag indicating if debug output should be generated. If the
-    #   values is `true` all the data sent to and received from the server will be written to `$stdout`. Be aware that
-    #   user names and passwords will also be written, so handle it with care.
+    #   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.
     #
-    # @option opts [String, IO] :log The log file where the debug output will be written. The value can be an string
-    #   containing a file name or an IO object. If it is a file name then the file will be created if it doesn't
-    #   exist, and the debug output will be added to the end. The file will be closed when the connection is closed.
-    #   If it is an IO object then the debug output will be written directly, and it won't be closed.
+    # @option opts [Logger] :log The logger where the log messages will be written.
     #
     # @option opts [Boolean] :kerberos (false) A boolean flag indicating if Kerberos uthentication should be used
     #   instead of the default basic authentication.
@@ -145,16 +142,6 @@ module OvirtSDK4
     #   certificate presented by the SSO server will be verified using these CA certificates. Default is value of
     #   `ca_file`.
     #
-    # @option opts [Boolean] :sso_debug A boolean flag indicating if SSO debug output should be generated. If the
-    #   values is `true` all the data sent to and received from the SSO server will be written to `$stdout`. Be aware
-    #   that user names and passwords will also be written, so handle it with care. Default is value of `debug`.
-    #
-    # @option opts [String, IO] :sso_log The log file where the SSO debug output will be written. The value can be a
-    #   string containing a file name or an IO object. If it is a file name then the file will be created if it doesn't
-    #   exist, and the SSO debug output will be added to the end. The file will be closed when the connection is closed.
-    #   If it is an IO object then the SSO debug output will be written directly, and it won't be closed. Default is
-    #   value of `log`.
-    #
     # @option opts [Boolean] :sso_timeout The maximun total time to wait for the SSO response, in seconds. A value
     #   of zero means wait for ever. If the timeout expires before the SSO response is received an exception will be
     #   raised. Default is value of `timeout`.
@@ -169,8 +156,8 @@ module OvirtSDK4
       password = opts[:password]
       insecure = opts[:insecure] || false
       ca_file = opts[:ca_file]
-      debug = opts[:debug] || false
-      log = opts[:log]
+      @debug = opts[:debug] || false
+      @log = opts[:log]
       kerberos = opts[:kerberos] || false
       timeout = opts[:timeout] || 0
       compress = opts[:compress] || false
@@ -178,8 +165,6 @@ module OvirtSDK4
       sso_revoke_url = opts[:sso_revoke_url]
       sso_insecure = opts[:sso_insecure] || insecure
       sso_ca_file = opts[:sso_ca_file] || ca_file
-      sso_debug = opts[:sso_debug] || debug
-      sso_log = opts[:sso_log] || log
       sso_timeout = opts[:sso_timeout] || timeout
       sso_token_name = opts[:sso_token_name] || 'access_token'
 
@@ -199,10 +184,7 @@ module OvirtSDK4
       @kerberos = kerberos
       @sso_insecure = sso_insecure
       @sso_ca_file = sso_ca_file
-      @sso_log_file = sso_log
-      @sso_debug = sso_debug
       @sso_timeout = sso_timeout
-      @log_file = log
       @sso_token_name = sso_token_name
 
       # Create the cURL handle:
@@ -229,35 +211,13 @@ module OvirtSDK4
       end
 
       # Configure debug mode:
-      @close_log = false
-      if debug
-        if log.nil?
-          @log = STDOUT
-        elsif log.is_a?(String)
-          @log = ::File.open(log, 'a')
-          @close_log = true
-        else
-          @log = log
-        end
+      if @debug && @log
         @curl.verbose = true
-        @curl.on_debug do |type, data|
-          case type
-          when Curl::CURLINFO_DATA_IN
-            prefix = '< '
-          when Curl::CURLINFO_DATA_OUT
-            prefix = '> '
-          when Curl::CURLINFO_HEADER_IN
-            prefix = '< '
-          when Curl::CURLINFO_HEADER_OUT
-            prefix = '> '
-          else
-            prefix = '* '
-          end
+        @curl.on_debug do |_, data|
           lines = data.gsub("\r\n", "\n").strip.split("\n")
           lines.each do |line|
-            @log.puts(prefix + line)
+            @log.debug(line)
           end
-          @log.flush
         end
       end
 
@@ -416,37 +376,13 @@ module OvirtSDK4
       sso_curl.timeout = @sso_timeout
 
       # Configure debug mode:
-      sso_close_log = false
-      if @sso_debug
-        if @sso_log_file.nil?
-          sso_log = STDOUT
-        elsif @sso_log_file == @log_file
-          sso_log = @log
-        elsif @sso_log_file.is_a?(String)
-          sso_log = ::File.open(@sso_log_file, 'a')
-          sso_close_log = true
-        else
-          sso_log = @sso_log_file
-        end
+      if @debug && @log
         sso_curl.verbose = true
-        sso_curl.on_debug do |type, data|
-          case type
-            when Curl::CURLINFO_DATA_IN
-              prefix = '< '
-            when Curl::CURLINFO_DATA_OUT
-              prefix = '> '
-            when Curl::CURLINFO_HEADER_IN
-              prefix = '< '
-            when Curl::CURLINFO_HEADER_OUT
-              prefix = '> '
-            else
-              prefix = '* '
-          end
+        sso_curl.on_debug do |_, data|
           lines = data.gsub("\r\n", "\n").strip.split("\n")
           lines.each do |line|
-            sso_log.puts(prefix + line)
+            @log.debug(line)
           end
-          sso_log.flush
         end
       end
 
@@ -499,10 +435,6 @@ module OvirtSDK4
         return JSON.parse(sso_curl.body_str)
       ensure
         sso_curl.close
-        # Close the log file, if we did open it:
-        if sso_close_log
-          sso_log.close
-        end
       end
     end
 
@@ -619,11 +551,6 @@ module OvirtSDK4
       # Revoke the SSO access token:
       revoke_access_token
 
-      # Close the log file, if we did open it:
-      if @close_log
-        @log.close
-      end
-
       # Release resources used by the cURL handle:
       @curl.close
     end

data/lib/ovirtsdk4/type.rb

@@ -39,6 +39,60 @@ module OvirtSDK4
       @href = value
     end
 
+    #
+    # Returns the attribute corresponding to the given set of keys, but will not generate a `NoMethodError` when
+    # the value corresponding to the key is `nil`, it will return `nil` instead. It is intended to simplify access
+    # to deeply nested attributes within an structure, and mostly copied from the Ruby 2.3 `dig` method available
+    # for hashes.
+    #
+    # For example, to access the alias of the first disk attached to a virtual machine that is part of an event without
+    # having to check for `nil` several times:
+    #
+    # [source,ruby]
+    # ----
+    # event = ...
+    # first_disk_id = event.dig(:vm, :disk_attachments, 0, :disk, :alias)
+    # ----
+    #
+    # Which is equivalent to this:
+    #
+    # [source,ruby]
+    # ----
+    # event = ...
+    # first_disk_id = nil
+    # vm = event.vm
+    # if !vm.nil?
+    #   disk_attachments = vm.disk_attachments
+    #   if !disk_attachments.nil?
+    #     first_disk_attachment = disk_attachments[0]
+    #     if !first_disk_attachment.nil?
+    #       disk = first_disk_attachment.disk
+    #       if !disk.nil?
+    #         first_disk_id = disk.id
+    #       end
+    #     end
+    #   end
+    # end
+    # ----
+    #
+    # @param keys [Array<Symbol, Integer>] An array of symbols corresponding to attribute names of structs, or integers
+    #   corresponding to list indexes.
+    #
+    def dig(*keys)
+      current = self
+      keys.each do |key|
+        if key.is_a?(Symbol)
+          current = current.send(key)
+        elsif key.is_a?(Integer)
+          current = current[key]
+        else
+          raise TypeError.new("The key '#{key}' isn't a symbol or integer")
+        end
+        break if current.nil?
+      end
+      current
+    end
+
   end
 
   #

data/lib/ovirtsdk4/version.rb

@@ -16,5 +16,5 @@
 
 
 module OvirtSDK4
-  VERSION = '4.0.0.alpha15'
+  VERSION = '4.0.0.alpha16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ovirt-engine-sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha15
+  version: 4.0.0.alpha16
 platform: ruby
 authors:
 - Juan Hernandez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -74,6 +74,7 @@ extensions:
 - ext/ovirtsdk4c/extconf.rb
 extra_rdoc_files: []
 files:
+- CHANGES.adoc
 - LICENSE.txt
 - README.adoc
 - ext/ovirtsdk4c/extconf.rb