ovirt-engine-sdk 4.0.0.alpha12 → 4.0.0.alpha13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a910fa355950cb5a7ae1e1263fa42de439a4388d
-  data.tar.gz: a5da7ba22f549c6f20e27d11011ecf6da33b7abf
+  metadata.gz: 33908ba5949e1f10edc66d7c0ca0a99fe3149c4f
+  data.tar.gz: e487f795b8ffe9d2f194abf098c42e876fb5234b
 SHA512:
-  metadata.gz: e662f4df3c0254d86f05bceedb55e40e1d08fd8108912b9f46f36f95e1f5e7980a35c2e2e498df8788b544cd39114d0248626e63ed1e0e4f05a7da1bd41230d7
-  data.tar.gz: 282472f9d5e04d8d4c0120f80f9607fef94e7ebcf1f0466a91d0f320e211cfdcdd8090cea098ded44b1f4049d0384f6d52301db6128b1567361c9c74f9b2cf4d
+  metadata.gz: 4e8b89c2ffe1f29612826ffce6aee91a19bb769c94ae27a89360317e788067c6e1aa8a8180dcfe3489d8c9aa3ac3d0aaeeb56b5a9e3b5d3d17fd2262fd539e18
+  data.tar.gz: c91b62007c94d7c5e0c55fb4684693d41785ede5a7327af2f686692fc21c31e27d0d1bb2785cc31a7b563dda124defd72b7ad96162bae7b6352bc92812ea40d9

data/README.adoc

@@ -39,7 +39,8 @@ connection.close
 
 The `ca.pem` file is required when connecting to a server protected
 with TLS. In an usual oVirt installation it will be in
-`/etc/pki/ovirt-engine/ca.pem`.
+`/etc/pki/ovirt-engine/ca.pem`. If you don't specify `ca_file`, then
+the system wide CA certificate store will be used.
 
 Once you have the reference to the system service you can use it to get
 references to other services, and call their methods. For example, to

data/lib/ovirtsdk4/http.rb

@@ -1,4 +1,4 @@
-#--
+#
 # Copyright (c) 2015-2016 Red Hat, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,7 +12,7 @@
 # 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.
-#++
+#
 
 require 'curb'
 require 'json'
@@ -20,7 +20,7 @@ require 'uri'
 
 module OvirtSDK4
 
-  ##
+  #
   # This class represents an HTTP request.
   #
   # @api private
@@ -32,7 +32,7 @@ module OvirtSDK4
     attr_accessor :headers
     attr_accessor :body
 
-    ##
+    #
     # Creates a new HTTP request.
     #
     def initialize(opts = {})
@@ -45,7 +45,7 @@ module OvirtSDK4
 
   end
 
-  ##
+  #
   # This class represents an HTTP response.
   #
   # @api private
@@ -56,7 +56,7 @@ module OvirtSDK4
     attr_accessor :headers
     attr_accessor :message
 
-    ##
+    #
     # Creates a new HTTP response.
     #
     def initialize(opts = {})
@@ -67,14 +67,14 @@ module OvirtSDK4
     end
   end
 
-  ##
+  #
   # This class is responsible for managing an HTTP connection to the engine server. It is intended as the entry
   # point for the SDK, and it provides access to the `system` service and, from there, to the rest of the services
   # provided by the API.
   #
   class Connection
 
-    ##
+    #
     # Creates a new connection to the API server.
     #
     # Note that all the parameters with names starting with `sso` are intended for use with external authentication
@@ -105,7 +105,8 @@ module OvirtSDK4
     #   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.
+    #   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 [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
@@ -212,11 +213,8 @@ module OvirtSDK4
         if insecure
           @curl.ssl_verify_peer = false
           @curl.ssl_verify_host = false
-        elsif ca_file.nil?
-          raise ArgumentError.new("The \"ca_file\" argument is mandatory when using TLS.")
-        elsif not ::File.file?(ca_file)
-          raise ArgumentError.new("The CA file \"#{ca_file}\" doesn't exist.")
-        else
+        elsif !ca_file.nil?
+          raise ArgumentError.new("The CA file \"#{ca_file}\" doesn't exist.") unless ::File.file?(ca_file)
           @curl.cacert = ca_file
         end
       end
@@ -265,7 +263,7 @@ module OvirtSDK4
 
     end
 
-    ##
+    #
     # Returns the base URL of this connection.
     #
     # @return [String]
@@ -274,7 +272,7 @@ module OvirtSDK4
       return @url
     end
 
-    ##
+    #
     # Returns a reference to the root of the services tree.
     #
     # @return [SystemService]
@@ -284,7 +282,7 @@ module OvirtSDK4
       return @system_service
     end
 
-    ##
+    #
     # Returns a reference to the service corresponding to the given path. For example, if the `path` parameter
     # is `vms/123/disks` then it will return a reference to the service that manages the disks for the virtual
     # machine with identifier `123`.
@@ -297,11 +295,10 @@ module OvirtSDK4
       return system_service.service(path)
     end
 
-    ##
+    #
     # Sends an HTTP request and waits for the response.
     #
     # @param request [Request] The Request object containing the details of the HTTP request to send.
-    # @param last [Boolean] A boolean flag indicating if this is the last request.
     # @return [Response] A request object containing the details of the HTTP response received.
     #
     # @api private
@@ -349,7 +346,7 @@ module OvirtSDK4
       return response
     end
 
-    ##
+    #
     # Obtains the access token from SSO to be used for Bearer authentication.
     #
     # @return [String] The URL.
@@ -377,7 +374,7 @@ module OvirtSDK4
       return sso_response[@sso_token_name]
     end
 
-    ##
+    #
     # Revoke the SSO access token.
     #
     # @api private
@@ -401,7 +398,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Execute a get request to the SSO server and return the response.
     #
     # @return [Hash] The JSON response.
@@ -456,11 +453,8 @@ module OvirtSDK4
           if @sso_insecure
             sso_curl.ssl_verify_peer = false
             sso_curl.ssl_verify_host = false
-          elsif @sso_ca_file.nil?
-            raise ArgumentError.new("The \"sso_ca_file\" argument is mandatory when using TLS.")
-          elsif not ::File.file?(@sso_ca_file)
-            raise ArgumentError.new("The CA file \"#{@sso_ca_file}\" doesn't exist.")
-          else
+          elsif !@sso_ca_file.nil?
+            raise ArgumentError.new("The CA file \"#{@sso_ca_file}\" doesn't exist.") unless ::File.file?(@sso_ca_file)
             sso_curl.cacert = @sso_ca_file
           end
         end
@@ -509,7 +503,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Builds a request URL to acquire the access token from SSO. The URLS are different for basic auth and Kerberos,
     # @return [String] The URL.
     #
@@ -535,7 +529,7 @@ module OvirtSDK4
       return "#{sso_url}sso/oauth/#{entry_point}?grant_type=#{grant_type}&scope=#{scope}"
     end
 
-    ##
+    #
     # Builds a request URL to revoke the SSO access token.
     # @return [String] The URL.
     #
@@ -549,7 +543,7 @@ module OvirtSDK4
       return "#{sso_url}services/sso-logout?scope=&token=#{@sso_token}"
     end
 
-    ##
+    #
     # Tests the connectivity with the server. If connectivity works correctly it returns `true`. If there is any
     # connectivity problem it will either return `false` or raise an exception if the `raise_exception` parameter is
     # `true`.
@@ -567,7 +561,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Indicates if the given object is a link. An object is a link if it has an `href` attribute.
     #
     # @return [Boolean]
@@ -576,7 +570,7 @@ module OvirtSDK4
       return !object.href.nil?
     end
 
-    ##
+    #
     # Follows the `href` attribute of the given object, retrieves the target object and returns it.
     #
     # @param object [Type] The object containing the `href` attribute.
@@ -605,7 +599,7 @@ module OvirtSDK4
       return service.get
     end
 
-    ##
+    #
     # Releases the resources used by this connection.
     #
     def close
@@ -627,7 +621,7 @@ module OvirtSDK4
       @curl.close
     end
 
-    ##
+    #
     # Builds a request URL from a path, and the set of query parameters.
     #
     # @params opts [Hash] The options used to build the URL.

data/lib/ovirtsdk4/reader.rb

@@ -1,4 +1,4 @@
-#--
+#
 # Copyright (c) 2015 Red Hat, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,11 +12,11 @@
 # 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 is the base class for all the XML readers used by the SDK. It contains the utility methods used by all
   # of them.
   #
@@ -24,7 +24,7 @@ module OvirtSDK4
   #
   class Reader
 
-    ##
+    #
     # Reads a string value, assuming that the cursor is positioned at the start element that contains the value.
     #
     # @param reader [XmlReader]
@@ -34,7 +34,7 @@ module OvirtSDK4
       return reader.read_element
     end
 
-    ##
+    #
     # Reads a list of string values, assuming that the cursor is positioned at the start of the element that contains
     # the first value.
     #
@@ -45,7 +45,7 @@ module OvirtSDK4
       return reader.read_elements
     end
 
-    ##
+    #
     # Converts the given text to a boolean value.
     #
     # @param text [String]
@@ -63,7 +63,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Reads a boolean value, assuming that the cursor is positioned at the start element that contains the value.
     #
     # @param reader [XmlReader]
@@ -73,7 +73,7 @@ module OvirtSDK4
       return Reader.parse_boolean(reader.read_element)
     end
 
-    ##
+    #
     # Reads a list of boolean values, assuming that the cursor is positioned at the start element that contains
     # the values.
     #
@@ -84,7 +84,7 @@ module OvirtSDK4
       return reader.read_elements.map { |text| Reader.parse_boolean(text) }
     end
 
-    ##
+    #
     # Converts the given text to an integer value.
     #
     # @param text [String]
@@ -99,7 +99,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Reads an integer value, assuming that the cursor is positioned at the start element that contains the value.
     #
     # @param reader [XmlReader]
@@ -109,7 +109,7 @@ module OvirtSDK4
       return Reader.parse_integer(reader.read_element)
     end
 
-    ##
+    #
     # Reads a list of integer values, assuming that the cursor is positioned at the start element that contains the
     # values.
     #
@@ -120,7 +120,7 @@ module OvirtSDK4
       return reader.read_elements.map { |text| Reader.parse_integer(text) }
     end
 
-    ##
+    #
     # Converts the given text to a decimal value.
     #
     # @return [Fixnum]
@@ -134,7 +134,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Reads a decimal value, assuming that the cursor is positioned at the start element that contains the value.
     #
     # @param reader [XmlReader]
@@ -144,7 +144,7 @@ module OvirtSDK4
       return Reader.parse_decimal(reader.read_element)
     end
 
-    ##
+    #
     # Reads a list of decimal values, assuming that the cursor is positioned at the start element that contains the
     # values.
     #
@@ -155,7 +155,7 @@ module OvirtSDK4
       return reader.read_elements.map { |text| Reader.parse_decimal(text) }
     end
 
-    ##
+    #
     # Converts the given text to a date value.
     #
     # @param text [String]
@@ -170,7 +170,7 @@ module OvirtSDK4
       end
     end
 
-    ##
+    #
     # Reads a date value, assuming that the cursor is positioned at the start element that contains the value.
     #
     # @param reader [XmlReader]
@@ -180,7 +180,7 @@ module OvirtSDK4
       return Reader.parse_date(reader.read_element)
     end
 
-    ##
+    #
     # Reads a list of dates values, assuming that the cursor is positioned at the start element that contains the
     # values.
     #