ovirt-engine-sdk 4.0.0.alpha0 → 4.0.0.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 591122a879ffd4ea3327f5643cb1ae978e3e3c99
-  data.tar.gz: 1668fa07c7899275224dc8e8f2350c46764176ed
+  metadata.gz: 53f6c08d5ffc685e834e967ab2f15cbb103c6cc7
+  data.tar.gz: 48d03be1e1adb660c3e379d725ef6680bf30930f
 SHA512:
-  metadata.gz: 9d1f6154f5045bfc631524ec12704845d83946e1a25ef309b02645e0e46fb9d24fb5466f68c9ca4cce76bf320d5a270d87ef67720d0d28050799b51728825a6a
-  data.tar.gz: f0f9a813ef9e75dd3e1be40667280bdfbe60f8e589a6cbd5abdabc139c83a02baf051ef231ac6f66278240fc0df3fe3ae6824de4a06626ebd052ec6bd3641361
+  metadata.gz: a468b34dc1fd284c7dddfc07bc1b0667be613f486aa840148bb577eb8cbc320465d9d9a421febe9c1b943d95b0c8ce3309b0a49e907d3beb0c93c2d331b83bf5
+  data.tar.gz: f734ad2e09545e15791c656e71e61f4463e3fe223657047eace57b76d3949a221d5cdc2bc97d26a98907326112530d33922d515c61b54824aa6678d28da0dd8a

data/README.md

@@ -30,7 +30,7 @@ connection = Ovirt::SDK::V4::Connection({
 })
 
 # Get the reference to the system service:
-system_service = connection.system
+system_service = connection.system_service
 
 # Always remember to close the connection when finished:
 connection.close
@@ -40,15 +40,15 @@ 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`.
 
-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 retrieve the list of virtual machines of the system you can use the
-`vms` method, which returns a reference to the service that manages
-the virtual machines:
+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
+retrieve the list of virtual machines of the system you can use the
+`vms_service` method, which returns a reference to the service that
+manages the virtual machines:
 
 ```ruby
 # Get the reference to the "vms" service:
-vms_service = system_service.vms
+vms_service = system_service.vms_service
 ```
 
 This service is an instance of Ovirt::SDK::V4::VmsService, and it has
@@ -65,4 +65,4 @@ vms.each do |vm|
 end
 ```
 
-In the future you will find more usuage examples in the `examples` directory.
+You will find more usuage examples in the `examples` directory.

data/lib/ovirt/sdk/v4.rb

@@ -20,17 +20,18 @@ require 'date'
 require 'stringio'
 
 ##
-# Load the xtension:
+# Load the extension:
 require 'ovirtsdk'
 
 ##
 # Own requirements.
 #
 require 'ovirt/sdk/v4/version.rb'
+require 'ovirt/sdk/v4/xml_formatter.rb'
 require 'ovirt/sdk/v4/xml_reader.rb'
 require 'ovirt/sdk/v4/xml_writer.rb'
+require 'ovirt/sdk/v4/connection.rb'
 require 'ovirt/sdk/v4/types.rb'
 require 'ovirt/sdk/v4/readers.rb'
 require 'ovirt/sdk/v4/writers.rb'
 require 'ovirt/sdk/v4/services.rb'
-require 'ovirt/sdk/v4/connection.rb'

data/lib/ovirt/sdk/v4/connection.rb

@@ -20,6 +20,57 @@ module Ovirt
   module SDK
     module V4
 
+      ##
+      # This class represents an HTTP request.
+      #
+      # This class is intended for internal use by other components of the SDK. Refrain from using it directly as there
+      # is no backwards compatibility guarantee.
+      #
+      class Request
+        attr_accessor :method
+        attr_accessor :path
+        attr_accessor :matrix
+        attr_accessor :query
+        attr_accessor :headers
+        attr_accessor :body
+
+        ##
+        # Creates a new HTTP request.
+        #
+        def initialize(opts = {})
+          self.method = opts[:method] || :GET
+          self.path = opts[:path] || ''
+          self.headers = opts[:headers] || {}
+          self.matrix = opts[:matrix] || {}
+          self.query = opts[:query] || {}
+          self.body = opts[:body]
+        end
+
+      end
+
+      ##
+      # This class represents an HTTP response.
+      #
+      # This class is intended for internal use by other components of the SDK. Refrain from using it directly as there
+      # is no backwards compatibility guarantee.
+      #
+      class Response
+        attr_accessor :body
+        attr_accessor :code
+        attr_accessor :headers
+        attr_accessor :message
+
+        ##
+        # Creates a new HTTP response.
+        #
+        def initialize(opts = {})
+          self.body = opts[:body]
+          self.code = opts[:code]
+          self.headers = opts[:headers]
+          self.message = opts[:message]
+        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
@@ -32,7 +83,8 @@ module Ovirt
         #
         # This method supports the following parameters, provided as an optional hash:
         #
-        # `:url` - The URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
+        # `:url` - A string containing the base URL of the server, usually something like
+        # `https://server.example.com/ovirt-engine/api`.
         #
         # `:username` - The name of the user, something like `admin@internal`.
         #
@@ -117,79 +169,89 @@ module Ovirt
 
         end
 
+        ##
+        # Returns a string containing the base URL used by this connection.
+        #
+        def url
+          return @url
+        end
+
         ##
         # Returns the reference to the root of the services tree.
         #
         # The returned value is an instance of the Ovirt::SDK::V4::SystemService class.
         #
-        def system
-          @system ||= SystemService.new(self, "")
-          return @system
+        def system_service
+          @system_service ||= SystemService.new(self, "")
+          return @system_service
         end
 
         ##
-        # Performs an HTTP request.
+        # 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`.
         #
-        # This method is intended for internal use by other components of the SDK, refrain from using it directly, as
-        # backwards compatibility isn't guaranteed.
+        # If there is no service corresponding to the given path an exception of type Ovirt::SDK::V4::Error will be
+        # raised.
         #
-        # This method supports the following parameters, provided as an optional hash:
-        #
-        # `:method` - The HTTP method to execute. The value should be `:GET`, `:POST`, `:PUT`, `:DELETE` or
-        # `:HEAD`.
+        def service(path)
+          return system_service.service(path)
+        end
+
+        ##
+        # Sends an HTTP request and waits for the response.
         #
-        # `:path` - The path that will be added to the URL used when the connection was created. For example, of the
-        # connection was created with `https://engine.example.com/ovirt-engine/api` and the value of `:path` is
-        # `vms/123` then the request will be sent to `https://engine.example.com/ovirt-engine/api/vms/123`.
+        # This method is intended for internal use by other components of the SDK. Refrain from using it directly, as
+        # backwards compatibility isn't guaranteed.
         #
-        # `:headers` - A hash containing the HTTP headers to add to the request. The keys of the hash should be
-        # strings containing the names of the headers, and the values should be strings containing the
-        # values. The default is an empty hash.
+        # This method supports the following parameters.
         #
-        # `:last` - Boolean flag indicating if this is the last request of a session. This will disable the use of
-        # the `Prefer: persistent-auth` header, thus indicating to the server that the session should be closed.
-        # The default is `false`.
+        # `request` - The Request object containing the details of the HTTP request to send.
         #
-        # `:persistent_auth` - Boolean flag indicating if persistent authentication based on cookies should be used.
-        # The default is `true`.
+        # `last` - A boolean flag indicating if this is the last request.
         #
-        # The returned value is an string containing the HTTP response body.
+        # The returned value is a Request object containing the details of the HTTP response received.
         #
-        def request(opts = {})
-          # Get the values of the parameters and assign default values:
-          method = opts[:method]
-          path = opts[:path]
-          headers = opts[:headers] || {}
-          last = opts[:last] || false
-          persistent_auth = opts[:persistent_auth] || true
-
-          # Set the URL:
-          @curl.url = @url.to_s + path
+        def send(request, last = false)
+          # Build the URL:
+          @curl.url = build_url({
+            :path => request.path,
+            :query => request.query,
+            :matrix => request.matrix,
+          })
 
           # Add headers, avoiding those that have no value:
           @curl.headers.clear
-          @curl.headers.merge!(headers)
+          @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'
 
-          # Every request except the last one should indicate that we prefer
-          # to use persistent authentication:
-          if persistent_auth and not last
+          # All requests except the last one should indicate that we want to use persistent authentication:
+          if !last
             @curl.headers['Prefer'] = 'persistent-auth'
           end
 
           # Send the request and wait for the response:
-          case method
+          case request.method
+          when :DELETE
+            @curl.http_delete
           when :GET
             @curl.http_get
           when :PUT
-            @curl.http_put(body)
+            @curl.http_put(request.body)
           when :HEAD
             @curl.http_head
+          when :POST
+            @curl.http_post(request.body)
           end
 
-          # Return the response body:
-          return @curl.body_str
+          # Return the response:
+          response = Response.new
+          response.body = @curl.body_str
+          response.code = @curl.response_code
+          return response
         end
 
         ##
@@ -197,12 +259,54 @@ module Ovirt
         #
         def close
           # Send the last request to indicate the server that the session should be closed:
-          request({:method => :HEAD, :path => '', :last => true})
+          request = Request.new({
+            :method => :HEAD,
+          })
+          send(request, true)
 
           # Release resources used by the cURL handle:
           @curl.close
         end
 
+        ##
+        # Builds a request URL from a path, and the sets of matrix and query parameters.
+        #
+        # This method is intended for internal use by other components of the SDK. Refrain from using it directly, as
+        # backwards compatibility isn't guaranteed.
+        #
+        # This method supports the following parameters, provided as an optional hash:
+        #
+        # `:path` - The path that will be added to the base URL. The default is an empty string.
+        #
+        # `:query` - A hash containing the query parameters to add to the URL. The keys of the hash should be strings
+        # containing the names of the parameters, and the values should be strings containing the values. The default
+        # is an empty hash.
+        #
+        # `:matrix` - A hash containing the matrix parameters to add to the URL. The keys of the hash should be strings
+        # containing the names of the parameters, and the values should be strings containing the values. The default
+        # is an empty hash.
+        #
+        # The returned value is an string containing the URL.
+        #
+        def build_url(opts = {})
+          # Get the values of the parameters and assign default values:
+          path = opts[:path] || ''
+          query = opts[:query] || {}
+          matrix = opts[:matrix] || {}
+
+          # Add the path and the parameters:
+          url = @url.to_s + path
+          if not matrix.empty?
+            matrix.each do |key, value|
+              url = url + ';' + URI.encode_www_form({key => value})
+            end
+          end
+          if not query.empty?
+            url = url + '?' + URI.encode_www_form(query)
+          end
+          return url
+        end
+
       end
 
     end

data/lib/ovirt/sdk/v4/readers.rb

@@ -560,6 +560,8 @@ end
 # Load all the readers.
 #
 load 'ovirt/sdk/v4/readers/reader.rb'
+load 'ovirt/sdk/v4/readers/action_reader.rb'
+load 'ovirt/sdk/v4/readers/fault_reader.rb'
 load 'ovirt/sdk/v4/readers/affinity_group_reader.rb'
 load 'ovirt/sdk/v4/readers/agent_reader.rb'
 load 'ovirt/sdk/v4/readers/agent_configuration_reader.rb'

data/lib/ovirt/sdk/v4/readers/action_reader.rb

@@ -0,0 +1,56 @@
+#--
+# 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 Ovirt
+  module SDK
+    module V4
+
+      class ActionReader < Reader # :nodoc:
+
+        def self.read_one(reader)
+          # Do nothing if there aren't more tags:
+          return nil unless reader.forward
+
+          # Create the object:
+          action = Action.new
+
+          # Discard the start tag:
+          empty = reader.empty_element?
+          reader.read
+          return action if empty
+
+          # Process the inner elements:
+          while reader.forward do
+            case reader.node_name
+            when 'status'
+              action.status = StatusReader.read_one(reader)
+            when 'fault'
+              action.fault = FaultReader.read_one(reader)
+            else
+              reader.next_element
+            end
+          end
+
+          # Discard the end tag:
+          reader.read
+
+          return action
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ovirt/sdk/v4/readers/affinity_group_reader.rb

@@ -20,14 +20,16 @@ module Ovirt
       
       class AffinityGroupReader < Reader # :nodoc:
         
-        def self.read_one(reader)
+        def self.read_one(reader, connection = nil)
           # Do nothing if there aren't more tags:
           return nil unless reader.forward
           
           # Create the object:
           object = AffinityGroup.new
+          object.connection = connection
           
           # Process the attributes:
+          object.href = reader.get_attribute('href')
           value = reader.get_attribute('comments')
           object.comments = value if not value.nil?
           value = reader.get_attribute('description')
@@ -66,7 +68,8 @@ module Ovirt
             when 'positive'
               object.positive = reader.read_boolean
             when 'cluster'
-              object.cluster = ClusterReader.read_one(reader)
+              object.cluster = ClusterReader.read_one(reader, connection)
+              object.cluster.is_link = true
             else
               reader.next_element
             end
@@ -79,11 +82,15 @@ module Ovirt
         end
         
         
-        def self.read_many(reader)
+        def self.read_many(reader, connection = nil)
           # Do nothing if there aren't more tags:
-          list = []
+          list = List.new
+          list.connection = connection
           return list unless reader.forward
           
+          # Process the attributes:
+          list.href = reader.get_attribute('href')
+          
           # Discard the start tag:
           empty = reader.empty_element?
           reader.read
@@ -91,7 +98,7 @@ module Ovirt
           
           # Process the inner elements:
           while reader.forward do
-            list << read_one(reader)
+            list << read_one(reader, connection)
           end
           
           # Discard the end tag:

data/lib/ovirt/sdk/v4/readers/agent_configuration_reader.rb

@@ -20,14 +20,16 @@ module Ovirt
       
       class AgentConfigurationReader < Reader # :nodoc:
         
-        def self.read_one(reader)
+        def self.read_one(reader, connection = nil)
           # Do nothing if there aren't more tags:
           return nil unless reader.forward
           
           # Create the object:
           object = AgentConfiguration.new
+          object.connection = connection
           
           # Process the attributes:
+          object.href = reader.get_attribute('href')
           value = reader.get_attribute('address')
           object.address = value if not value.nil?
           value = reader.get_attribute('broker_type')
@@ -78,11 +80,15 @@ module Ovirt
         end
         
         
-        def self.read_many(reader)
+        def self.read_many(reader, connection = nil)
           # Do nothing if there aren't more tags:
-          list = []
+          list = List.new
+          list.connection = connection
           return list unless reader.forward
           
+          # Process the attributes:
+          list.href = reader.get_attribute('href')
+          
           # Discard the start tag:
           empty = reader.empty_element?
           reader.read
@@ -90,7 +96,7 @@ module Ovirt
           
           # Process the inner elements:
           while reader.forward do
-            list << read_one(reader)
+            list << read_one(reader, connection)
           end
           
           # Discard the end tag: