ovirt-engine-sdk 4.0.6 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e5bfa1388e71cd3c46306600f1684f33840cab9
-  data.tar.gz: 1aef00ac9898fe1ee30e31d8bde8be4f3b6ec01c
+  metadata.gz: 941838d3336897908d87d082d471f5aa63bc1302
+  data.tar.gz: 07eee0003584d83b43dbaf5f11c5b8dc7ce593e8
 SHA512:
-  metadata.gz: 575ee5fd660bfe4747f22c0dd56bb36ee7ef4f688f30bc92fe1acec76f208d40a31e9d555b274df2afba03dd869a4a516e5ddd1d543ed0304005ae661ff60c76
-  data.tar.gz: 008405cdde7b82e2f07b7cf15a5f6d741d887fe7a64070d4b96bbfa1fc76ecac36ed9dcfc55d579d41533448e945bdac59d92238c77ec8ac061b009dd66dac24
+  metadata.gz: 28756c56277fad2ed7b439ab0a12d61719e15d4636172dbb21fcf086d10afcc6777e40f05f2f437f6d1c4e510f26b524fa714775393ba31b3388d78ba4525b27
+  data.tar.gz: a094e808b259fd31d37d1bf8849f08e871dad46a863cd6817e2ac7249d92c45c3061f9bf0c2b56cb6d749e06ce689a31a676fc536cc06b722fcf66e9743d9eeb

data/CHANGES.adoc

@@ -2,6 +2,22 @@
 
 This document describes the relevant changes between releases of the SDK.
 
+== 4.0.7 / Jan 12 2017
+
+New features:
+
+* Add HTTP proxy support.
+
+* Require Ruby 2.
+
+Bug fixes:
+
+* Fix writing `id` attribute for enum values
+  https://bugzilla.redhat.com/1408839[#1408839].
+
+* Enable installation in Vagrant with embedded Ruby
+  https://bugzilla.redhat.com/1411594[#1411594].
+
 == 4.0.6 / Oct 18 2016
 
 Update to model 4.0.37.

data/README.adoc

@@ -23,12 +23,12 @@ and gives you access to the root of the tree of services of the API:
 require 'ovirtsdk4'
 
 # Create a connection to the server:
-connection = OvirtSDK4::Connection.new({
-  :url => 'https://engine.example.com/ovirt-engine/api',
-  :username => 'admin@internal',
-  :password => '...',
-  :ca_file => 'ca.pem',
-})
+connection = OvirtSDK4::Connection.new(
+  url: 'https://engine.example.com/ovirt-engine/api',
+  username: 'admin@internal',
+  password: '...',
+  ca_file: 'ca.pem'
+)
 
 # Get the reference to the system service:
 system_service = connection.system_service

data/ext/ovirtsdk4c/extconf.rb

@@ -30,5 +30,15 @@ unless pkg_config('libcurl')
   raise 'The "libcurl" package isn\'t available.'
 end
 
+# When installing the SDK as a plugin in Vagrant there is an issue with
+# some versions of Vagrant that embed "libxml2" and "libcurl", but using
+# an incorrect directory. To avoid that we need to explicitly fix the
+# Vagrant path.
+def fix_vagrant_prefix(flags)
+  flags.gsub!('/vagrant-substrate/staging', '/opt/vagrant')
+end
+fix_vagrant_prefix($CPPFLAGS)
+fix_vagrant_prefix($LDFLAGS)
+
 # Create the Makefile:
 create_makefile 'ovirtsdk4c'

data/ext/ovirtsdk4c/ov_http_client.c

@@ -41,6 +41,9 @@ static VALUE LOG_SYMBOL;
 static VALUE PASSWORD_SYMBOL;
 static VALUE TIMEOUT_SYMBOL;
 static VALUE USERNAME_SYMBOL;
+static VALUE PROXY_URL_SYMBOL;
+static VALUE PROXY_USERNAME_SYMBOL;
+static VALUE PROXY_PASSWORD_SYMBOL;
 
 /* Method identifiers: */
 static ID DEBUG_ID;
@@ -342,6 +345,9 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
     bool debug;
     bool insecure;
     char* ca_file;
+    char* proxy_password;
+    char* proxy_url;
+    char* proxy_username;
     int timeout;
     ov_http_client_object* object;
 
@@ -416,6 +422,36 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
         compress = RTEST(opt);
     }
 
+    /* Get the value of the 'proxy_url' parameter: */
+    opt = rb_hash_aref(opts, PROXY_URL_SYMBOL);
+    if (NIL_P(opt)) {
+        proxy_url = NULL;
+    }
+    else {
+        Check_Type(opt, T_STRING);
+        proxy_url = StringValueCStr(opt);
+    }
+
+    /* Get the value of the 'proxy_username' parameter: */
+    opt = rb_hash_aref(opts, PROXY_USERNAME_SYMBOL);
+    if (NIL_P(opt)) {
+        proxy_username = NULL;
+    }
+    else {
+        Check_Type(opt, T_STRING);
+        proxy_username = StringValueCStr(opt);
+    }
+
+    /* Get the value of the 'proxy_password' parameter: */
+    opt = rb_hash_aref(opts, PROXY_PASSWORD_SYMBOL);
+    if (NIL_P(opt)) {
+        proxy_password = NULL;
+    }
+    else {
+        Check_Type(opt, T_STRING);
+        proxy_password = StringValueCStr(opt);
+    }
+
     /* Create the libcurl object: */
     object->curl = curl_easy_init();
     if (object->curl == NULL) {
@@ -431,7 +467,6 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
         curl_easy_setopt(object->curl, CURLOPT_CAINFO, ca_file);
     }
 
-
     /* Configure the timeout: */
     curl_easy_setopt(object->curl, CURLOPT_TIMEOUT, timeout);
 
@@ -447,6 +482,15 @@ static VALUE ov_http_client_initialize(int argc, VALUE* argv, VALUE self) {
         curl_easy_setopt(object->curl, CURLOPT_DEBUGFUNCTION, ov_http_client_debug_function);
     }
 
+    /* Configure the proxy: */
+    if (proxy_url != NULL) {
+        curl_easy_setopt(object->curl, CURLOPT_PROXY, proxy_url);
+        if (proxy_username != NULL && proxy_password != NULL) {
+            curl_easy_setopt(object->curl, CURLOPT_PROXYUSERNAME, proxy_username);
+            curl_easy_setopt(object->curl, CURLOPT_PROXYPASSWORD, proxy_password);
+        }
+    }
+
     /* Configure callbacks: */
     curl_easy_setopt(object->curl, CURLOPT_READFUNCTION, ov_http_client_read_function);
     curl_easy_setopt(object->curl, CURLOPT_WRITEFUNCTION, ov_http_client_write_function);
@@ -653,14 +697,17 @@ void ov_http_client_define(void) {
     rb_define_method(ov_http_client_class, "send",      ov_http_client_send,      2);
 
     /* Define the symbols: */
-    USERNAME_SYMBOL = ID2SYM(rb_intern("username"));
-    PASSWORD_SYMBOL = ID2SYM(rb_intern("password"));
-    INSECURE_SYMBOL = ID2SYM(rb_intern("insecure"));
-    CA_FILE_SYMBOL  = ID2SYM(rb_intern("ca_file"));
-    DEBUG_SYMBOL    = ID2SYM(rb_intern("debug"));
-    LOG_SYMBOL      = ID2SYM(rb_intern("log"));
-    COMPRESS_SYMBOL = ID2SYM(rb_intern("compress"));
-    TIMEOUT_SYMBOL  = ID2SYM(rb_intern("timeout"));
+    USERNAME_SYMBOL       = ID2SYM(rb_intern("username"));
+    PASSWORD_SYMBOL       = ID2SYM(rb_intern("password"));
+    INSECURE_SYMBOL       = ID2SYM(rb_intern("insecure"));
+    CA_FILE_SYMBOL        = ID2SYM(rb_intern("ca_file"));
+    DEBUG_SYMBOL          = ID2SYM(rb_intern("debug"));
+    LOG_SYMBOL            = ID2SYM(rb_intern("log"));
+    COMPRESS_SYMBOL       = ID2SYM(rb_intern("compress"));
+    TIMEOUT_SYMBOL        = ID2SYM(rb_intern("timeout"));
+    PROXY_URL_SYMBOL      = ID2SYM(rb_intern("proxy_url"));
+    PROXY_USERNAME_SYMBOL = ID2SYM(rb_intern("proxy_username"));
+    PROXY_PASSWORD_SYMBOL = ID2SYM(rb_intern("proxy_password"));
 
     /* Define the method identifiers: */
     DEBUG_ID           = rb_intern("debug");

data/lib/ovirtsdk4/connection.rb

@@ -18,7 +18,6 @@ require 'json'
 require 'uri'
 
 module OvirtSDK4
-
   #
   # 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
@@ -31,10 +30,10 @@ module OvirtSDK4
     # [source,ruby]
     # ----
     # connection = OvirtSDK4::Connection.new(
-    #   :url      => 'https://engine.example.com/ovirt-engine/api',
-    #   :username => 'admin@internal',
-    #   :password => '...',
-    #   :ca_file  => '/etc/pki/ovirt-engine/ca.pem',
+    #   url: 'https://engine.example.com/ovirt-engine/api',
+    #   username: 'admin@internal',
+    #   password: '...',
+    #   ca_file:'/etc/pki/ovirt-engine/ca.pem'
     # )
     # ----
     #
@@ -75,6 +74,15 @@ module OvirtSDK4
     #   compressed responses. Note that this is a hint for the server, and that it may return uncompressed data even
     #   when this parameter is set to `true`.
     #
+    # @option opts [String] :proxy_url A string containing the protocol, address and port number of the proxy server
+    #   to use to connect to the server. For example, in order to use the HTTP proxy `proxy.example.com` that is
+    #   listening on port `3128` the value should be `http://proxy.example.com:3128`. This is optional, and if not
+    #   given the connection will go directly to the server specified in the `url` parameter.
+    #
+    # @option opts [String] :proxy_username The name of the user to authenticate to the proxy server.
+    #
+    # @option opts [String] :proxy_password The password of the user to authenticate to the proxy server.
+    #
     def initialize(opts = {})
       # Get the values of the parameters and assign default values:
       @url = opts[:url]
@@ -88,15 +96,21 @@ module OvirtSDK4
       @kerberos = opts[:kerberos] || false
       @timeout = opts[:timeout] || 0
       @compress = opts[:compress] || false
+      @proxy_url = opts[:proxy_url]
+      @proxy_username = opts[:proxy_username]
+      @proxy_password = opts[:proxy_password]
 
       # Create the HTTP client:
       @client = HttpClient.new(
-        :insecure => @insecure,
-        :ca_file => @ca_file,
-        :debug => @debug,
-        :log => @log,
-        :timeout => @timeout,
-        :compress => @compress,
+        insecure: @insecure,
+        ca_file: @ca_file,
+        debug: @debug,
+        log: @log,
+        timeout: @timeout,
+        compress: @compress,
+        proxy_url: @proxy_url,
+        proxy_username: @proxy_username,
+        proxy_password: @proxy_password
       )
     end
 
@@ -106,7 +120,7 @@ module OvirtSDK4
     # @return [SystemService]
     #
     def system_service
-      @system_service ||= SystemService.new(self, "")
+      @system_service ||= SystemService.new(self, '')
     end
 
     #
@@ -119,7 +133,7 @@ module OvirtSDK4
     # @raise [Error] If there is no service corresponding to the given path.
     #
     def service(path)
-      return system_service.service(path)
+      system_service.service(path)
     end
 
     #
@@ -132,18 +146,14 @@ module OvirtSDK4
     #
     def send(request)
       # Add the base URL to the request:
-      if request.url.nil?
-        request.url = @url
-      else
-        request.url = "#{@url}#{request.url}"
-      end
+      request.url = request.url.nil? ? request.url = @url : "#{@url}#{request.url}"
 
       # Set the headers common to all requests:
       request.headers.merge!(
         'User-Agent'   => "RubySDK/#{VERSION}",
         'Version'      => '4',
         'Content-Type' => 'application/xml',
-        'Accept'       => 'application/xml',
+        'Accept'       => 'application/xml'
       )
 
       # Older versions of the engine (before 4.1) required the 'all_content' as an HTTP header instead of a query
@@ -151,13 +161,11 @@ module OvirtSDK4
       # included in the request, and add the corresponding header.
       unless request.query.nil?
         all_content = request.query['all_content']
-        unless all_content.nil?
-          request.headers['All-Content'] = all_content
-        end
+        request.headers['All-Content'] = all_content unless all_content.nil?
       end
 
       # Set the authentication token:
-      @token ||= get_access_token
+      @token ||= create_access_token
       request.token = @token
 
       # Create an empty response:
@@ -167,7 +175,7 @@ module OvirtSDK4
       @client.send(request, response)
 
       # Return the response:
-      return response
+      response
     end
 
     #
@@ -177,20 +185,18 @@ module OvirtSDK4
     #
     # @api private
     #
-    def get_access_token
+    def create_access_token
       # Build the URL and parameters required for the request:
       url, parameters = build_sso_auth_request
 
-      # Send the response and wait for the request:
+      # Send the request and wait for the request:
       response = get_sso_response(url, parameters)
+      response = response[0] if response.is_a?(Array)
 
-      if response.is_a?(Array)
-        response = response[0]
-      end
-
-      unless response['error'].nil?
-        raise Error.new("Error during SSO authentication: #{response['error_code']}: #{response['error']}")
-      end
+      # Check the response and raise an error if it contains an error code:
+      code = response['error_code']
+      error = response['error']
+      raise Error, "Error during SSO authentication: #{code}: #{error}" if error
 
       response['access_token']
     end
@@ -204,15 +210,14 @@ module OvirtSDK4
       # Build the URL and parameters required for the request:
       url, parameters = build_sso_revoke_request
 
+      # Send the request and wait for the response:
       response = get_sso_response(url, parameters)
+      response = response[0] if response.is_a?(Array)
 
-      if response.is_a?(Array)
-        response = response[0]
-      end
-
-      unless response['error'].nil?
-        raise Error.new("Error during SSO revoke: #{response['error_code']}: #{response['error']}")
-      end
+      # Check the response and raise an error if it contains an error code:
+      code = response['error_code']
+      error = response['error']
+      raise Error, "Error during SSO revoke: #{code}: #{error}" if error
     end
 
     #
@@ -229,14 +234,14 @@ module OvirtSDK4
     def get_sso_response(url, parameters)
       # Create the request:
       request = HttpRequest.new(
-        :method => :POST,
-        :url => url,
-        :headers => {
+        method: :POST,
+        url: url,
+        headers: {
           'User-Agent' => "RubySDK/#{VERSION}",
           'Content-Type' => 'application/x-www-form-urlencoded',
-          'Accept' => 'application/json',
+          'Accept' => 'application/json'
         },
-        :body => URI.encode_www_form(parameters),
+        body: URI.encode_www_form(parameters)
       )
 
       # Create an empty response:
@@ -260,19 +265,17 @@ module OvirtSDK4
     def build_sso_auth_request
       # Compute the entry point and the parameters:
       parameters = {
-        :scope => 'ovirt-app-api',
+        scope: 'ovirt-app-api'
       }
       if @kerberos
         entry_point = 'token-http-auth'
-        parameters.merge!(
-          :grant_type => 'urn:ovirt:params:oauth:grant-type:http',
-        )
+        parameters[:grant_type] = 'urn:ovirt:params:oauth:grant-type:http'
       else
         entry_point = 'token'
         parameters.merge!(
-          :grant_type => 'password',
-          :username => @username,
-          :password => @password,
+          grant_type: 'password',
+          username: @username,
+          password: @password
         )
       end
 
@@ -296,8 +299,8 @@ module OvirtSDK4
     def build_sso_revoke_request
       # Compute the parameters:
       parameters = {
-        :scope => '',
-        :token => @token,
+        scope: '',
+        token: @token
       }
 
       # Compute the URL:
@@ -318,13 +321,11 @@ module OvirtSDK4
     # @return [Boolean]
     #
     def test(raise_exception = false)
-      begin
-        system_service.get
-        true
-      rescue Exception
-        raise if raise_exception
-        false
-      end
+      system_service.get
+      true
+    rescue StandardError
+      raise if raise_exception
+      false
     end
 
     #
@@ -336,7 +337,7 @@ module OvirtSDK4
     # @return [String]
     #
     def authenticate
-      @token ||= get_access_token
+      @token ||= create_access_token
     end
 
     #
@@ -344,10 +345,20 @@ module OvirtSDK4
     #
     # @return [Boolean]
     #
-    def is_link?(object)
+    def link?(object)
       !object.href.nil?
     end
 
+    #
+    # The `link?` method used to be named `is_link?`, and we need to preserve it for backwards compatibility, but try to
+    # avoid using it.
+    #
+    # @return [Boolean]
+    #
+    # @deprecated Please use `link?` instead.
+    #
+    alias is_link? link?
+
     #
     # Follows the `href` attribute of the given object, retrieves the target object and returns it.
     #
@@ -358,16 +369,14 @@ module OvirtSDK4
       # Check that the "href" has a value, as it is needed in order to retrieve the representation of the object:
       href = object.href
       if href.nil?
-        raise Error.new("Can't follow link because the 'href' attribute does't have a value")
+        raise Error, "Can't follow link because the 'href' attribute does't have a value"
       end
 
       # Check that the value of the "href" attribute is compatible with the base URL of the connection:
       prefix = URI(@url).path
-      if !prefix.end_with?('/')
-        prefix += '/'
-      end
-      if !href.start_with?(prefix)
-        raise Error.new("The URL '#{href}' isn't compatible with the base URL of the connection")
+      prefix += '/' unless prefix.end_with?('/')
+      unless href.start_with?(prefix)
+        raise Error, "The URL '#{href}' isn't compatible with the base URL of the connection"
       end
 
       # Remove the prefix from the URL, follow the path to the relevant service and invoke the "get" or "list" method
@@ -391,6 +400,5 @@ module OvirtSDK4
       # Close the HTTP client:
       @client.close if @client
     end
-
   end
 end