ovirt-engine-sdk 4.0.0.alpha5 → 4.0.0.alpha7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f31c52cb5a642f97c1d03a7f9d91a7701c2e0f0a
-  data.tar.gz: df1e123b9952bd594f011aaef8f006760bf80126
+  metadata.gz: efdf7aa3b7b78aee1c6719d815c395754ef047ec
+  data.tar.gz: f69f766b423df49b6c151d0901ed27d2f4129fcc
 SHA512:
-  metadata.gz: 95b54caddc857be47136e9d4cb5cc87e68232d1d6ec607c52f39271959d7b6fd300fb7319e7e6260d304fc9f876929b539a627d49ff9b24da548e71d7187e410
-  data.tar.gz: d4e9755613ddd8c6ea47b64839b9ec963044b9b39e2e42f6fff9b5acd133330917dc317463fc49fa52bc63ddb7c6aed215b9fd067f7a4b5735210d0135228424
+  metadata.gz: 19301c12a0fc586a4ec4d3b819c50b4a7472d96df40fb0acc626348201de2f49a4aba80a071c3dbc2f32d43dc63d5424e621fb7548449016cd17d8ec65078b01
+  data.tar.gz: c0efc3a839b6e942b7ba9902afbf935185aaa59d86489687d07202e6d437f4ff5d59f588e7d8d1f0fe95d15a9c50cc00e09d6bcaa9e9fd5f987944b5715f2d4e

data/README.md

@@ -13,16 +13,16 @@ instructions in the `README.md` file of the parent directory.
 
 ## Usage
 
-To use the SDK require the `ovirt/sdk/v4` file. That will give you
+To use the SDK require the `ovirtsdk4` file. That will give you
 access to all the classes of th SDK, and in particular to the
-Ovirt::SDK::V4::Connection class. This is the entry point of the SDK,
+OvirtSDKV4::Connection class. This is the entry point of the SDK,
 and gives you access to the root of the tree of services of the API:
 
 ```ruby
-require 'ovirt/sdk/v4'
+require 'ovirtsdk4'
 
 # Create a connection to the server:
-connection = Ovirt::SDK::V4::Connection({
+connection = OvirtSDK4::Connection({
   :url => 'https://engine.example.com/ovirt-engine/api',
   :username => 'admin@internal',
   :password => '...',
@@ -51,9 +51,9 @@ manages the virtual machines:
 vms_service = system_service.vms_service
 ```
 
-This service is an instance of Ovirt::SDK::V4::VmsService, and it has
+This service is an instance of OvirtSDK4::VmsService, and it has
 a `list` method that returns an array of virtual machines, which are
-instances of the Ovirt::SDK::V4::Vm class:
+instances of the OvirtSDK4::Vm class:
 
 ```ruby
 # Retrieve the virtual machines:

data/ext/{ovirtsdk → ovirtsdk4c}/extconf.rb

@@ -1,7 +1,8 @@
 #!/usr/bin/ruby
 
 #
-# Copyright (c) 2015 Red Hat, Inc.
+# Copyright (c) 2015-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
@@ -22,4 +23,4 @@ unless pkg_config('libxml-2.0')
   raise 'The "libxml2" package isn\'t available.'
 end
 
-create_makefile 'ovirtsdk'
+create_makefile 'ovirtsdk4c'

data/ext/{ovirtsdk → ovirtsdk4c}/ov_error.c

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_error.h

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_module.c

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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
@@ -19,7 +20,5 @@ limitations under the License.
 
 // Initialization function:
 void ov_module_define(void) {
-    ov_module = rb_define_module("Ovirt");
-    ov_module = rb_define_module_under(ov_module, "SDK");
-    ov_module = rb_define_module_under(ov_module, "V4");
+    ov_module = rb_define_module("OvirtSDK4");
 }

data/ext/{ovirtsdk → ovirtsdk4c}/ov_module.h

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_xml_constants.c

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_xml_constants.h

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_xml_reader.c

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_xml_reader.h

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk → ovirtsdk4c}/ov_xml_writer.c

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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
@@ -100,7 +101,7 @@ static VALUE ov_xml_writer_initialize(VALUE self, VALUE options) {
 
     // Create the libxml buffer that writes to the IO object:
     xmlOutputBufferPtr buffer = xmlOutputBufferCreateIO(ov_xml_writer_callback, NULL, object, NULL);
-    if (object == NULL) {
+    if (buffer == NULL) {
         rb_raise(ov_error_class, "Can't create XML buffer");
     }
 
@@ -134,7 +135,7 @@ static VALUE ov_xml_writer_write_start(VALUE self, VALUE name) {
     char *c_name = StringValueCStr(name);
     int rc = xmlTextWriterStartElement(object->writer, BAD_CAST c_name);
     if (rc < 0) {
-        rb_raise(ov_error_class, "Can't end XML element");
+        rb_raise(ov_error_class, "Can't start XML element");
     }
     return Qnil;
 }

data/ext/{ovirtsdk → ovirtsdk4c}/ov_xml_writer.h

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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

data/ext/{ovirtsdk/ovirtsdk.c → ovirtsdk4c/ovirtsdk4c.c}

@@ -1,5 +1,6 @@
 /*
-Copyright (c) 2015 Red Hat, Inc.
+Copyright (c) 2015-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
@@ -21,7 +22,7 @@ limitations under the License.
 #include "ov_xml_reader.h"
 #include "ov_xml_writer.h"
 
-void Init_ovirtsdk(void) {
+void Init_ovirtsdk4c(void) {
     // Define the module:
     ov_module_define();
 

data/lib/{ovirt/sdk/v4.rb → ovirtsdk4.rb}

@@ -1,5 +1,6 @@
 #--
-# Copyright (c) 2015 Red Hat, Inc.
+# Copyright (c) 2015-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
@@ -21,17 +22,19 @@ require 'stringio'
 
 ##
 # Load the extension:
-require 'ovirtsdk'
+require 'ovirtsdk4c'
 
 ##
 # 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 'ovirtsdk4/version.rb'
+require 'ovirtsdk4/xml.rb'
+require 'ovirtsdk4/http.rb'
+require 'ovirtsdk4/type.rb'
+require 'ovirtsdk4/types.rb'
+require 'ovirtsdk4/reader.rb'
+require 'ovirtsdk4/readers.rb'
+require 'ovirtsdk4/writer.rb'
+require 'ovirtsdk4/writers.rb'
+require 'ovirtsdk4/service.rb'
+require 'ovirtsdk4/services.rb'

data/lib/ovirtsdk4/http.rb

@@ -0,0 +1,328 @@
+#--
+# Copyright (c) 2015-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.
+#++
+
+require 'curb'
+require 'uri'
+
+module OvirtSDK4
+
+  ##
+  # 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
+  # provided by the API.
+  #
+  class Connection
+
+    ##
+    # Creates a new connection to the API server.
+    #
+    # This method supports the following parameters, provided as an optional hash:
+    #
+    # `: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`.
+    #
+    # `:password` - The name password of the user.
+    #
+    # `:insecure` - A boolean flag that indicates if the server TLS certificate and host name should be
+    # checked. The default is `true`.
+    #
+    # `:ca_file` - A PEM file containing the trusted CA certificates. The certificate presented by the server
+    # will be verified using these CA certificates.
+    #
+    # `:debug` - 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. The default values is `false`.
+    #
+    # `: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.
+    #
+    def initialize(opts = {})
+      # Get the values of the parameters and assign default values:
+      url = opts[:url]
+      username = opts[:username]
+      password = opts[:password]
+      insecure = opts[:insecure] || false
+      ca_file = opts[:ca_file]
+      debug = opts[:debug] || false
+      log = opts[:log] || STDOUT
+
+      # Check mandatory parameters:
+      if url.nil?
+         raise ArgumentError.new("The \"url\" parameter is mandatory.")
+      end
+
+      # Save the URL:
+      @url = URI(url)
+
+      # Create the cURL handle:
+      @curl = Curl::Easy.new
+
+      # Configure cookies so that they are enabled but stored only in memory:
+      @curl.enable_cookies = true
+      @curl.cookiefile = '/dev/null'
+      @curl.cookiejar = '/dev/null'
+
+      # Configure authentication:
+      @curl.http_auth_types = :basic
+      @curl.username = username
+      @curl.password = password
+
+      # Configure TLS parameters:
+      if @url.scheme == 'https'
+        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
+          @curl.cacert = ca_file
+        end
+      end
+
+      # Configure debug mode:
+      if debug
+        if log.is_a?(String)
+          @log = ::File.open(log, 'a')
+        else
+          @log = log
+        end
+        @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
+          lines = data.gsub("\r\n", "\n").strip.split("\n")
+          lines.each do |line|
+            @log.puts(prefix + line)
+          end
+          @log.flush
+        end
+      end
+
+    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 OvirtSDK4::SystemService class.
+    #
+    def system_service
+      @system_service ||= SystemService.new(self, "")
+      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`.
+    #
+    # If there is no service corresponding to the given path an exception of type OvirtSDK4::Error will be
+    # raised.
+    #
+    def service(path)
+      return system_service.service(path)
+    end
+
+    ##
+    # Sends an HTTP request and waits for the response.
+    #
+    # 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.
+    #
+    # `request` - The Request object containing the details of the HTTP request to send.
+    #
+    # `last` - A boolean flag indicating if this is the last request.
+    #
+    # The returned value is a Request object containing the details of the HTTP response received.
+    #
+    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!(request.headers)
+      @curl.headers['User-Agent'] = "RubySDK/#{VERSION}"
+      @curl.headers['Version'] = '4'
+      @curl.headers['Content-Type'] = 'application/xml'
+      @curl.headers['Accept'] = 'application/xml'
+
+      # 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 request.method
+      when :DELETE
+        @curl.http_delete
+      when :GET
+        @curl.http_get
+      when :PUT
+        @curl.http_put(request.body)
+      when :HEAD
+        @curl.http_head
+      when :POST
+        @curl.http_post(request.body)
+      end
+
+      # Return the response:
+      response = Response.new
+      response.body = @curl.body_str
+      response.code = @curl.response_code
+      return response
+    end
+
+    ##
+    # Releases the resources used by this connection.
+    #
+    def close
+      # Send the last request to indicate the server that the session should be closed:
+      request = Request.new({
+        :method => :HEAD,
+      })
+      send(request, true)
+
+      # Close the log file, if we did open it:
+      unless @log.nil? || @log.equal?(STDOUT)
+        @log.close
+      end
+
+      # 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