ovirt-engine-sdk 4.0.10 → 4.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8d7ce4cc9a8dd0463f0edafefa029f17d4958b3
-  data.tar.gz: 3705cddc5e1a5d9bef44ce7e386fe17eb3a6ae22
+  metadata.gz: ef3151a5a4fdf9357755606aa19a21ac6190df9e
+  data.tar.gz: e3a3afbb4b946fe05f8fc51147d56d1dea1bb0cd
 SHA512:
-  metadata.gz: 984ec5278d20a63cafd010f841b641d983747add12dc97ccdfa4c27cee0405852e5e06bee8c9271061bf0da2a74b75ae8dd11be9cb450c142511c6d9544d4d95
-  data.tar.gz: d70dc1c8a093cba2127c31ca4f6ae406ec714d22b52b4317b9832c65aaf4c1cc3fa57985f0ec23721444dfebb8f81876662d450e1c4b364dcd2e0307cbf388f0
+  metadata.gz: 3195ac3fc190a9ce0aae6a0ccc89ae4a53bcc6fcd9c1fbe8c64b7727d1a5dddda50a16084e3136bafc5089a5296382ec69fd1bd4352072e15eb583afa72df7e1
+  data.tar.gz: e3ee355131e9bef66cf67fab83f493155b614ac31083271c41def40fef19d8ffa1b4e4932f5b5ff818796f74cdf720c12048b8cc15552e1b4d734d3516b2196e

data/CHANGES.adoc

@@ -2,6 +2,22 @@
 
 This document describes the relevant changes between releases of the SDK.
 
+== 4.0.11 / Mar 2 2017
+
+New features:
+
+* Add support for custom headers and query parameters.
+
+* Ignore unsupported enum values.
+
+* Check that URL has been provided.
+
+* Send INFO log messages with summaries of requests and responses.
+
+Bug fixes:
+
+* Fix writing of lists of structs.
+
 == 4.0.10 / Feb 9 2017
 
 Bug fixes:

data/ext/ovirtsdk4c/ov_http_client.c

@@ -19,6 +19,7 @@ limitations under the License.
 
 #include <ctype.h>
 #include <curl/curl.h>
+#include <stdarg.h>
 #include <stdbool.h>
 #include <stdlib.h>
 #include <string.h>
@@ -48,6 +49,8 @@ static VALUE PROXY_PASSWORD_SYMBOL;
 /* Method identifiers: */
 static ID DEBUG_ID;
 static ID ENCODE_WWW_FORM_ID;
+static ID INFO_ID;
+static ID INFO_Q_ID;
 static ID READ_ID;
 static ID STRING_ID;
 static ID STRING_IO_ID;
@@ -549,6 +552,22 @@ static void ov_http_client_perform_cancel(void* data) {
     perform_context->cancel = true;
 }
 
+static void ov_http_client_log_info(VALUE log, const char* format, ...) {
+    VALUE enabled;
+    VALUE message;
+    va_list args;
+
+    if (!NIL_P(log)) {
+        enabled = rb_funcall(log, INFO_Q_ID, 0);
+        if (RTEST(enabled)) {
+            va_start(args, format);
+            message = rb_vsprintf(format, args);
+            rb_funcall(log, INFO_ID, 1, message);
+            va_end(args);
+        }
+    }
+}
+
 static VALUE ov_http_client_send(VALUE self, VALUE request, VALUE response) {
     VALUE header;
     VALUE url;
@@ -626,6 +645,14 @@ static VALUE ov_http_client_send(VALUE self, VALUE request, VALUE response) {
     }
     curl_easy_setopt(object->curl, CURLOPT_HTTPHEADER, headers);
 
+    /* Send a summary of the request to the log: */
+    ov_http_client_log_info(
+        object->log,
+        "Sending '%"PRIsVALUE"' request to URL '%"PRIsVALUE"'.",
+        request_object->method,
+        url
+    );
+
     /* Performing the request is a potentially lengthy and blocking operation, so we need to make sure that it runs
        without the global interpreter lock acquired as much as possible: */
     perform_context.object = object;
@@ -674,6 +701,13 @@ static VALUE ov_http_client_send(VALUE self, VALUE request, VALUE response) {
     /* Get the response body: */
     response_object->body = rb_funcall(perform_context.out, STRING_ID, 0);
 
+    /* Send a summary of the response to the log: */
+    ov_http_client_log_info(
+        object->log,
+        "Received response code '%"PRIsVALUE"'.",
+        response_object->code
+    );
+
     return Qnil;
 }
 
@@ -712,6 +746,8 @@ void ov_http_client_define(void) {
     /* Define the method identifiers: */
     DEBUG_ID           = rb_intern("debug");
     ENCODE_WWW_FORM_ID = rb_intern("encode_www_form");
+    INFO_ID            = rb_intern("info");
+    INFO_Q_ID          = rb_intern("info?");
     READ_ID            = rb_intern("read");
     STRING_ID          = rb_intern("string");
     STRING_IO_ID       = rb_intern("StringIO");

data/lib/ovirtsdk4/connection.rb

@@ -90,6 +90,11 @@ module OvirtSDK4
     #
     # @option opts [String] :proxy_password The password of the user to authenticate to the proxy server.
     #
+    # @option opts [Hash] :headers Custom HTTP headers to send with all requests. The keys of the hash can be
+    #   strings of symbols, and they will be used as the names of the headers. The values of the hash will be used
+    #   as the names of the headers. If the same header is provided here and in the `headers` parameter of a specific
+    #   method call, then the `headers` parameter of the specific method call will have precendence.
+    #
     def initialize(opts = {})
       # Get the values of the parameters and assign default values:
       @url = opts[:url]
@@ -107,6 +112,10 @@ module OvirtSDK4
       @proxy_url = opts[:proxy_url]
       @proxy_username = opts[:proxy_username]
       @proxy_password = opts[:proxy_password]
+      @headers = opts[:headers]
+
+      # Check that the URL has been provided:
+      raise ArgumentError, "The 'url' option is mandatory" unless @url
 
       # Create a temporary file to store the CA certificates, and populate it with the contents of the 'ca_file' and
       # 'ca_certs' options. The file will be removed when the connection is closed.
@@ -186,6 +195,9 @@ module OvirtSDK4
         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
@@ -266,6 +278,9 @@ module OvirtSDK4
         body: URI.encode_www_form(parameters)
       )
 
+      # Add the global headers:
+      request.headers.merge!(@headers) if @headers
+
       # Create an empty response:
       response = HttpResponse.new
 

data/lib/ovirtsdk4/reader.rb

@@ -189,6 +189,46 @@ module OvirtSDK4
       reader.read_elements.map { |text| Reader.parse_date(text) }
     end
 
+    #
+    # Converts the given text to an enum.
+    #
+    # @param enum_type [module]
+    # @param text [String]
+    # @return [String]
+    #
+    def self.parse_enum(enum_type, text)
+      return nil unless text
+      begin
+        text if enum_type.constants.map(&:downcase).include?(text.to_sym)
+      rescue
+        nil
+      end
+    end
+
+    #
+    # Reads a enum value, assuming that the cursor is positioned at the
+    # start element that contains the value.
+    #
+    # @param enum_type [module]
+    # @param reader [XmlReader]
+    # @return [Array<String>]
+    #
+    def self.read_enum(enum_type, reader)
+      Reader.parse_enum(enum_type, reader.read_element)
+    end
+
+    #
+    # Reads a list of enum values, assuming that the cursor is positioned
+    # at the start element of the element that contains the first value.
+    #
+    # @param enum_type [module]
+    # @param reader [XmlReader]
+    # @return [Array<String>]
+    #
+    def self.read_enums(enum_type, reader)
+      reader.read_elements.map { |text| Reader.parse_enum(enum_type, text) }
+    end
+
     #
     # This hash stores for each known tag a reference to the method that read the object corresponding for that tag. For
     # example, for the `vm` tag it will contain a reference to the `VmReader.read_one` method, and for the `vms` tag