ovirt-engine-sdk 4.1.13 → 4.2.0.alpha1

data/ext/ovirtsdk4c/ov_http_client.h

@@ -28,12 +28,9 @@ extern VALUE ov_http_client_class;
 
 /* Content: */
 typedef struct {
-    /* The libcurl multi handle, used to implement multiple simultaneous requests: */
+    /* The libcurl multi handle: */
     CURLM* handle;
 
-    /* The libcurl share handle, used to share cookie data between multiple requests: */
-    CURLSH* share;
-
     /* The logger: */
     VALUE log;
 
@@ -54,8 +51,6 @@ typedef struct {
     char* proxy_username;
     char* proxy_password;
     int timeout;
-    int connect_timeout;
-    char* cookies;
 } ov_http_client_object;
 
 /* Macro to get the pointer: */

data/ext/ovirtsdk4c/ov_http_request.c

@@ -40,7 +40,6 @@ static VALUE TOKEN_SYMBOL;
 static VALUE KERBEROS_SYMBOL;
 static VALUE BODY_SYMBOL;
 static VALUE TIMEOUT_SYMBOL;
-static VALUE CONNECT_TIMEOUT_SYMBOL;
 
 static void ov_http_request_mark(void* vptr) {
     ov_http_request_object* ptr;
@@ -56,7 +55,6 @@ static void ov_http_request_mark(void* vptr) {
     rb_gc_mark(ptr->kerberos);
     rb_gc_mark(ptr->body);
     rb_gc_mark(ptr->timeout);
-    rb_gc_mark(ptr->connect_timeout);
 }
 
 static void ov_http_request_free(void* vptr) {
@@ -85,17 +83,16 @@ static VALUE ov_http_request_alloc(VALUE klass) {
     ov_http_request_object* ptr;
 
     ptr = ALLOC(ov_http_request_object);
-    ptr->method          = Qnil;
-    ptr->url             = Qnil;
-    ptr->query           = Qnil;
-    ptr->headers         = Qnil;
-    ptr->username        = Qnil;
-    ptr->password        = Qnil;
-    ptr->token           = Qnil;
-    ptr->kerberos        = Qnil;
-    ptr->body            = Qnil;
-    ptr->timeout         = Qnil;
-    ptr->connect_timeout = Qnil;
+    ptr->method   = Qnil;
+    ptr->url      = Qnil;
+    ptr->query    = Qnil;
+    ptr->headers  = Qnil;
+    ptr->username = Qnil;
+    ptr->password = Qnil;
+    ptr->token    = Qnil;
+    ptr->kerberos = Qnil;
+    ptr->body     = Qnil;
+    ptr->timeout  = Qnil;
     return TypedData_Wrap_Struct(klass, &ov_http_request_type, ptr);
 }
 
@@ -282,36 +279,6 @@ static VALUE ov_http_request_set_timeout(VALUE self, VALUE value) {
     return Qnil;
 }
 
-static VALUE ov_http_request_get_connect_timeout(VALUE self) {
-    ov_http_request_object* ptr;
-
-    ov_http_request_ptr(self, ptr);
-    return ptr->connect_timeout;
-}
-
-static VALUE ov_http_request_set_connect_timeout(VALUE self, VALUE value) {
-    ov_http_request_object* ptr;
-
-    ov_http_request_ptr(self, ptr);
-    if (!NIL_P(value)) {
-        Check_Type(value, T_FIXNUM);
-    }
-    ptr->connect_timeout = value;
-    return Qnil;
-}
-
-static VALUE ov_http_request_inspect(VALUE self) {
-    ov_http_request_object* ptr;
-
-    ov_http_request_ptr(self, ptr);
-    return rb_sprintf(
-        "#<%"PRIsVALUE":%"PRIsVALUE" %"PRIsVALUE">",
-        ov_http_request_class,
-        ptr->method,
-        ptr->url
-    );
-}
-
 static VALUE ov_http_request_initialize(int argc, VALUE* argv, VALUE self) {
     VALUE opts;
 
@@ -337,7 +304,6 @@ static VALUE ov_http_request_initialize(int argc, VALUE* argv, VALUE self) {
     ov_http_request_set_token(self, rb_hash_aref(opts, TOKEN_SYMBOL));
     ov_http_request_set_body(self, rb_hash_aref(opts, BODY_SYMBOL));
     ov_http_request_set_timeout(self, rb_hash_aref(opts, TIMEOUT_SYMBOL));
-    ov_http_request_set_connect_timeout(self, rb_hash_aref(opts, CONNECT_TIMEOUT_SYMBOL));
 
     return self;
 }
@@ -351,43 +317,38 @@ void ov_http_request_define(void) {
     rb_define_method(ov_http_request_class, "initialize", ov_http_request_initialize, -1);
 
     /* Define the methods: */
-    rb_define_method(ov_http_request_class, "method",           ov_http_request_get_method,          0);
-    rb_define_method(ov_http_request_class, "method=",          ov_http_request_set_method,          1);
-    rb_define_method(ov_http_request_class, "url",              ov_http_request_get_url,             0);
-    rb_define_method(ov_http_request_class, "url=",             ov_http_request_set_url,             1);
-    rb_define_method(ov_http_request_class, "query",            ov_http_request_get_query,           0);
-    rb_define_method(ov_http_request_class, "query=",           ov_http_request_set_query,           1);
-    rb_define_method(ov_http_request_class, "headers",          ov_http_request_get_headers,         0);
-    rb_define_method(ov_http_request_class, "headers=",         ov_http_request_set_headers,         1);
-    rb_define_method(ov_http_request_class, "username",         ov_http_request_get_username,        0);
-    rb_define_method(ov_http_request_class, "username=",        ov_http_request_set_username,        1);
-    rb_define_method(ov_http_request_class, "password",         ov_http_request_get_password,        0);
-    rb_define_method(ov_http_request_class, "password=",        ov_http_request_set_password,        1);
-    rb_define_method(ov_http_request_class, "token",            ov_http_request_get_token,           0);
-    rb_define_method(ov_http_request_class, "token=",           ov_http_request_set_token,           1);
-    rb_define_method(ov_http_request_class, "kerberos",         ov_http_request_get_kerberos,        0);
-    rb_define_method(ov_http_request_class, "kerberos=",        ov_http_request_set_kerberos,        1);
-    rb_define_method(ov_http_request_class, "body",             ov_http_request_get_body,            0);
-    rb_define_method(ov_http_request_class, "body=",            ov_http_request_set_body,            1);
-    rb_define_method(ov_http_request_class, "timeout",          ov_http_request_get_timeout,         0);
-    rb_define_method(ov_http_request_class, "timeout=",         ov_http_request_set_timeout,         1);
-    rb_define_method(ov_http_request_class, "connect_timeout",  ov_http_request_get_connect_timeout, 0);
-    rb_define_method(ov_http_request_class, "connect_timeout=", ov_http_request_set_connect_timeout, 1);
-    rb_define_method(ov_http_request_class, "inspect",          ov_http_request_inspect,             0);
-    rb_define_method(ov_http_request_class, "to_s",             ov_http_request_inspect,             0);
+    rb_define_method(ov_http_request_class, "method",    ov_http_request_get_method,   0);
+    rb_define_method(ov_http_request_class, "method=",   ov_http_request_set_method,   1);
+    rb_define_method(ov_http_request_class, "url",       ov_http_request_get_url,      0);
+    rb_define_method(ov_http_request_class, "url=",      ov_http_request_set_url,      1);
+    rb_define_method(ov_http_request_class, "query",     ov_http_request_get_query,    0);
+    rb_define_method(ov_http_request_class, "query=",    ov_http_request_set_query,    1);
+    rb_define_method(ov_http_request_class, "headers",   ov_http_request_get_headers,  0);
+    rb_define_method(ov_http_request_class, "headers=",  ov_http_request_set_headers,  1);
+    rb_define_method(ov_http_request_class, "username",  ov_http_request_get_username, 0);
+    rb_define_method(ov_http_request_class, "username=", ov_http_request_set_username, 1);
+    rb_define_method(ov_http_request_class, "password",  ov_http_request_get_password, 0);
+    rb_define_method(ov_http_request_class, "password=", ov_http_request_set_password, 1);
+    rb_define_method(ov_http_request_class, "token",     ov_http_request_get_token,    0);
+    rb_define_method(ov_http_request_class, "token=",    ov_http_request_set_token,    1);
+    rb_define_method(ov_http_request_class, "kerberos",  ov_http_request_get_kerberos, 0);
+    rb_define_method(ov_http_request_class, "kerberos=", ov_http_request_set_kerberos, 1);
+    rb_define_method(ov_http_request_class, "body",      ov_http_request_get_body,     0);
+    rb_define_method(ov_http_request_class, "body=",     ov_http_request_set_body,     1);
+    rb_define_method(ov_http_request_class, "timeout",   ov_http_request_get_timeout,  0);
+    rb_define_method(ov_http_request_class, "timeout=",  ov_http_request_set_timeout,  1);
 
     /* Define the symbols for the attributes: */
-    URL_SYMBOL             = ID2SYM(rb_intern("url"));
-    METHOD_SYMBOL          = ID2SYM(rb_intern("method"));
-    QUERY_SYMBOL           = ID2SYM(rb_intern("query"));
-    HEADERS_SYMBOL         = ID2SYM(rb_intern("headers"));
-    USERNAME_SYMBOL        = ID2SYM(rb_intern("username"));
-    PASSWORD_SYMBOL        = ID2SYM(rb_intern("password"));
-    TOKEN_SYMBOL           = ID2SYM(rb_intern("token"));
-    KERBEROS_SYMBOL        = ID2SYM(rb_intern("kerberos"));
-    BODY_SYMBOL            = ID2SYM(rb_intern("body"));
-    TIMEOUT_SYMBOL         = ID2SYM(rb_intern("timeout"));
-    CONNECT_TIMEOUT_SYMBOL = ID2SYM(rb_intern("connect_timeout"));
+    URL_SYMBOL      = ID2SYM(rb_intern("url"));
+    METHOD_SYMBOL   = ID2SYM(rb_intern("method"));
+    QUERY_SYMBOL    = ID2SYM(rb_intern("query"));
+    HEADERS_SYMBOL  = ID2SYM(rb_intern("headers"));
+    USERNAME_SYMBOL = ID2SYM(rb_intern("username"));
+    PASSWORD_SYMBOL = ID2SYM(rb_intern("password"));
+    TOKEN_SYMBOL    = ID2SYM(rb_intern("token"));
+    KERBEROS_SYMBOL = ID2SYM(rb_intern("kerberos"));
+    BODY_SYMBOL     = ID2SYM(rb_intern("body"));
+    TIMEOUT_SYMBOL  = ID2SYM(rb_intern("timeout"));
 
     /* Define the symbols for the HTTP methods: */
     GET_SYMBOL    = ID2SYM(rb_intern("GET"));

data/ext/ovirtsdk4c/ov_http_request.h

@@ -31,17 +31,16 @@ extern VALUE DELETE_SYMBOL;
 
 /* Content: */
 typedef struct {
-    VALUE method;          /* Symbol */
-    VALUE url;             /* String */
-    VALUE query;           /* Hash<String, String> */
-    VALUE headers;         /* Hash<String, String> */
-    VALUE username;        /* String */
-    VALUE password;        /* String */
-    VALUE token;           /* String */
-    VALUE kerberos;        /* Boolean */
-    VALUE body;            /* String */
-    VALUE timeout;         /* Integer */
-    VALUE connect_timeout; /* Integer */
+    VALUE method;   /* Symbol */
+    VALUE url;      /* String */
+    VALUE query;    /* Hash<String, String> */
+    VALUE headers;  /* Hash<String, String> */
+    VALUE username; /* String */
+    VALUE password; /* String */
+    VALUE token;    /* String */
+    VALUE kerberos; /* Boolean */
+    VALUE body;     /* String */
+    VALUE timeout;  /* Integer */
 } ov_http_request_object;
 
 /* Macro to get the pointer: */

data/ext/ovirtsdk4c/ov_http_response.c

@@ -146,18 +146,6 @@ static VALUE ov_http_response_set_message(VALUE self, VALUE value) {
     return Qnil;
 }
 
-static VALUE ov_http_response_inspect(VALUE self) {
-    ov_http_response_object* ptr;
-
-    ov_http_response_ptr(self, ptr);
-    return rb_sprintf(
-        "#<%"PRIsVALUE":%"PRIsVALUE" %"PRIsVALUE">",
-        ov_http_response_class,
-        ptr->code,
-        ptr->message
-    );
-}
-
 static VALUE ov_http_response_initialize(int argc, VALUE* argv, VALUE self) {
     VALUE opts;
 
@@ -199,8 +187,6 @@ void ov_http_response_define(void) {
     rb_define_method(ov_http_response_class, "headers=", ov_http_response_set_headers, 1);
     rb_define_method(ov_http_response_class, "message",  ov_http_response_get_message, 0);
     rb_define_method(ov_http_response_class, "message=", ov_http_response_set_message, 1);
-    rb_define_method(ov_http_response_class, "inspect",  ov_http_response_inspect,     0);
-    rb_define_method(ov_http_response_class, "to_s",     ov_http_response_inspect,     0);
 
     /* Define the symbols: */
     BODY_SYMBOL    = ID2SYM(rb_intern("body"));

data/ext/ovirtsdk4c/ov_http_transfer.c

@@ -71,21 +71,10 @@ static VALUE ov_http_transfer_alloc(VALUE klass) {
     return TypedData_Wrap_Struct(klass, &ov_http_transfer_type, ptr);
 }
 
-static VALUE ov_http_transfer_inspect(VALUE self) {
-    ov_http_transfer_object* ptr;
-
-    ov_http_transfer_ptr(self, ptr);
-    return rb_sprintf("#<%"PRIsVALUE":%p>", ov_http_transfer_class, ptr);
-}
-
 void ov_http_transfer_define(void) {
     /* Define the class: */
     ov_http_transfer_class = rb_define_class_under(ov_module, "HttpTransfer", rb_cData);
 
     /* Define the constructor: */
     rb_define_alloc_func(ov_http_transfer_class, ov_http_transfer_alloc);
-
-    /* Define the methods: */
-    rb_define_method(ov_http_transfer_class, "inspect", ov_http_transfer_inspect, 0);
-    rb_define_method(ov_http_transfer_class, "to_s",    ov_http_transfer_inspect, 0);
 }

data/ext/ovirtsdk4c/ov_module.h

@@ -17,10 +17,10 @@ limitations under the License.
 #ifndef __OV_MODULE_H__
 #define __OV_MODULE_H__
 
-/* Module: */
+// Module:
 extern VALUE ov_module;
 
-/* Initialization function: */
+// Initialization function:
 extern void ov_module_define(void);
 
 #endif

data/lib/ovirtsdk4/connection.rb

@@ -16,7 +16,6 @@
 
 require 'json'
 require 'tempfile'
-require 'thread'
 require 'uri'
 
 module OvirtSDK4
@@ -75,11 +74,8 @@ module OvirtSDK4
     #   instead of user name and password to obtain the OAuth token.
     #
     # @option opts [Integer] :timeout (0) The maximun total time to wait for the response, in seconds. A value of zero
-    #   (the default) means wait for ever. If the timeout expires before the response is received a `TimeoutError`
-    #   exception will be raised.
-    #
-    # @option opts [Integer] :connect_timeout (300) The maximun time to wait for connection establishment, in seconds.
-    #   If the timeout expires before the connection is established a `TimeoutError` exception will be raised.
+    #   (the default) means wait for ever. If the timeout expires before the response is received an exception will be
+    #   raised.
     #
     # @option opts [Boolean] :compress (true) A boolean flag indicating if the SDK should ask the server to send
     #   compressed responses. Note that this is a hint for the server, and that it may return uncompressed data even
@@ -120,7 +116,6 @@ module OvirtSDK4
       @log = opts[:log]
       @kerberos = opts[:kerberos] || false
       @timeout = opts[:timeout] || 0
-      @connect_timeout = opts[:connect_timeout] || 0
       @compress = opts[:compress] || true
       @proxy_url = opts[:proxy_url]
       @proxy_username = opts[:proxy_username]
@@ -150,9 +145,6 @@ module OvirtSDK4
         @ca_store.close
       end
 
-      # Create the mutex that will be used to prevents simultaneous access to the same HTTP client by multiple threads:
-      @mutex = Mutex.new
-
       # Create the HTTP client:
       @client = HttpClient.new(
         insecure: @insecure,
@@ -160,7 +152,6 @@ module OvirtSDK4
         debug: @debug,
         log: @log,
         timeout: @timeout,
-        connect_timeout: @connect_timeout,
         compress: @compress,
         proxy_url: @proxy_url,
         proxy_username: @proxy_username,
@@ -193,24 +184,65 @@ module OvirtSDK4
     end
 
     #
-    # Sends an HTTP request, making sure that multiple threads are coordinated correctly.
+    # Sends an HTTP request.
     #
     # @param request [HttpRequest] The request object containing the details of the HTTP request to send.
     #
     # @api private
     #
     def send(request)
-      @mutex.synchronize { internal_send(request) }
+      # Add the base URL to the request:
+      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'
+      )
+
+      # Older versions of the engine (before 4.1) required the 'all_content' as an HTTP header instead of a query
+      # parameter. In order to better support those older versions of the engine we need to check if this parameter is
+      # included in the request, and add the corresponding header.
+      unless request.query.nil?
+        all_content = request.query['all_content']
+        request.headers['All-Content'] = all_content unless all_content.nil?
+      end
+
+      # Add the global headers, but without replacing the values that may already exist:
+      request.headers.merge!(@headers) { |_name, local, _global| local } if @headers
+
+      # Set the authentication token:
+      @token ||= create_access_token
+      request.token = @token
+
+      # Send the request:
+      @client.send(request)
     end
 
     #
-    # Waits for the response to the given request, making sure that multiple threads are coordinated correctly.
+    # Waits for the response to the given request.
     #
     # @param request [HttpRequest] The request object whose corresponding response you want to wait for.
-    # @return [HttpResponse] A request object containing the details of the HTTP response received.
+    # @return [Response] A request object containing the details of the HTTP response received.
     #
     def wait(request)
-      @mutex.synchronize { internal_wait(request) }
+      # Wait for the response:
+      response = @client.wait(request)
+      raise response if response.is_a?(Exception)
+
+      # If the request failed because of authentication, and it wasn't a request to the SSO service, then the
+      # most likely cause is an expired SSO token. In this case we need to request a new token, and try the original
+      # request again, but only once. It if fails again, we just return the failed response.
+      if response.code == 401 && request.token
+        @token = create_access_token
+        request.token = @token
+        @client.send(request)
+        response = @client.wait(request)
+      end
+
+      response
     end
 
     #
@@ -434,10 +466,17 @@ module OvirtSDK4
     end
 
     #
-    # Releases the resources used by this connection, making sure that multiple threads are coordinated correctly.
+    # Releases the resources used by this connection.
     #
     def close
-      @mutex.synchronize { internal_close }
+      # Revoke the SSO access token:
+      revoke_access_token if @token
+
+      # Close the HTTP client:
+      @client.close if @client
+
+      # Remove the temporary file that contains the trusted CA certificates:
+      @ca_store.unlink if @ca_store
     end
 
     #
@@ -514,30 +553,6 @@ module OvirtSDK4
       raise error
     end
 
-    #
-    # Returns a string representation of the connection.
-    #
-    # @return [String] The string representation.
-    #
-    def inspect
-      "#<#{self.class.name}:#{@url}>"
-    end
-
-    #
-    # Returns a string representation of the connection.
-    #
-    # @return [String] The string representation.
-    #
-    def to_s
-      inspect
-    end
-
-    #
-    # Returns a string representation of the connection.
-    #
-    # @return [String] The string representation.
-    #
-
     private
 
     #
@@ -581,85 +596,5 @@ module OvirtSDK4
       end
       raise_error(response, detail)
     end
-
-    #
-    # Sends an HTTP request.
-    #
-    # @param request [HttpRequest] The request object containing the details of the HTTP request to send.
-    #
-    # @api private
-    #
-    def internal_send(request)
-      # Add the base URL to the request:
-      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'
-      )
-
-      # Older versions of the engine (before 4.1) required the 'all_content' as an HTTP header instead of a query
-      # parameter. In order to better support those older versions of the engine we need to check if this parameter is
-      # included in the request, and add the corresponding header.
-      unless request.query.nil?
-        all_content = request.query['all_content']
-        request.headers['All-Content'] = all_content unless all_content.nil?
-      end
-
-      # Add the global headers, but without replacing the values that may already exist:
-      request.headers.merge!(@headers) { |_name, local, _global| local } if @headers
-
-      # Set the authentication token:
-      @token ||= create_access_token
-      request.token = @token
-
-      # Send the request:
-      @client.send(request)
-    end
-
-    #
-    # Waits for the response to the given request.
-    #
-    # @param request [HttpRequest] The request object whose corresponding response you want to wait for.
-    # @return [Response] A request object containing the details of the HTTP response received.
-    #
-    # @api private
-    #
-    def internal_wait(request)
-      # Wait for the response:
-      response = @client.wait(request)
-      raise response if response.is_a?(Exception)
-
-      # If the request failed because of authentication, and it wasn't a request to the SSO service, then the
-      # most likely cause is an expired SSO token. In this case we need to request a new token, and try the original
-      # request again, but only once. It if fails again, we just return the failed response.
-      if response.code == 401 && request.token
-        @token = create_access_token
-        request.token = @token
-        @client.send(request)
-        response = @client.wait(request)
-      end
-
-      response
-    end
-
-    #
-    # Releases the resources used by this connection.
-    #
-    # @api private
-    #
-    def internal_close
-      # Revoke the SSO access token:
-      revoke_access_token if @token
-
-      # Close the HTTP client:
-      @client.close if @client
-
-      # Remove the temporary file that contains the trusted CA certificates:
-      @ca_store.unlink if @ca_store
-    end
   end
 end