ovirt-engine-sdk 4.2.0.alpha2 → 4.2.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40908e6b88b521aaf3a23e7c0580a1048f6c8ffd
-  data.tar.gz: e8acc264e9fb9d97b492fbb9981b107296f336e1
+  metadata.gz: 80eb53f5a009746e0161ca6038d089370c372df8
+  data.tar.gz: 6285abc6584ca83aec8df2be1dfabca6d2485afa
 SHA512:
-  metadata.gz: bcac4e7e89424f3ededf6541482a49f2f219597658c8d91faa6fe40d8e0f7c0aea0a97415c5cb8b039e835af9e4931ed1e56e2a394f95e833fb59b834e7728f7
-  data.tar.gz: 1d844327f93a72ca2ecdd893cdefa40befb17f3e8d73bd396e46de8e1a103673d7fbf9884058adf6d4ee3362b5c2e7503e028fc87eecd2b7f00379da4b409d53
+  metadata.gz: 123a67164cf851403136b4af9362d8c3c73826b30a6573bae326827929c4f9df5f46642a02a8f10a16634ae1782f77f3e202ed10a9d2f3069b5d6fbcf95f4616
+  data.tar.gz: 9ca5ab17eba09f5a7f1ae1e73d66008a9ccfc76d0f77f589c6cbaa12c5a9f9e0e072f83ded518d68111c6db63fd7d3e4cc5cbeecb4defad008dc08318977504e

data/CHANGES.adoc

@@ -2,6 +2,73 @@
 
 This document describes the relevant changes between releases of the SDK.
 
+== 4.2.0-alpha3 / Sep 25 2017
+
+Update to model 4.2.19:
+
+* Add new `NicNetworkFilterParameter` type and related services.
+
+* Add `StorageDomainDisks` and `AttachedStorageDomainDisks`.
+
+* Add operation to register storage domain disk.
+
+* Add `all_content` parameter to snapshots services.
+
+* Add `default_route` value to the `NetworkUsage` enum.
+
+* Add the `all_content` parameter to `Host.Get` and `Hosts.List`.
+
+* Fix the documentation of the method that lists events
+  https://bugzilla.redhat.com/1447622[#1447622].
+
+* Fix the direction of the main parameter of the method that adds a
+  CDROM to a virtual machine. It should be input and output.
+
+* Add the `index` attribute to the `Event` type
+  https://bugzilla.redhat.com/1448511[#1448511].
+
+* Add `volatile` parameter to the method that starts a virtual machine.
+
+* Add `RefreshLun` method to the service that manages a disk.
+  https://bugzilla.redhat.com/1404389[#1404389].
+
+* Add Link Layer Discovery Protocol (LLDP).
+
+* Add a `refresh` parameter to `FilesService.list`.
+
+* Add `firewal_type` attribute to the `Cluster` type.
+
+* Add `has_illegal_images` attribute to the `Vm` type.
+
+* Add support for creating image transfers using disks and snapshots.
+
+* Add `size` and `type` properties to the `Image` type.
+
+* Add `total_size` attribute to the `Disk` type.
+
+* Add support for listing cluster level features, and enabling/disabing
+  them for clusters.
+
+* Storage domain identifier isn't mandatory to create quota limit.
+
+* Don't require deprecated affinity group attributes
+  https://bugzilla.redhat.com/1488729[#1488729].
+
+* Fix optional fields in storage domain add and update
+  https://bugzilla.redhat.com/1488929[1488929].
+
+* Add new `HIGH_PERFORMANCE` value to the `VmType` enum.
+
+* Add new types and services for access to system configuration options.
+
+New features:
+
+* Improve log messages so that they contain the method and path of the
+  request.
+
+* Add `AuthError`, `ConnectionError`, `NotFoundError` and
+  `TimeoutError`.
+
 == 4.2.0-alpha2 / Jul 21 2017
 
 New features:

data/README.adoc

@@ -68,10 +68,26 @@ The {reference}/Connection[Connection] class, as is the mechanism to
 connect to the server and to get the reference to the root of the
 services tree.
 
-Error::
+Errors::
 
-The {reference}/Error[Error] class is the exception that the SDK will
-raise when it needs to report any error.
+The {reference}/Error[Error] class is the base exception class that the
+SDK will raise when it needs to report any error.
++
+For certain kinds of errors there are specific error classes, extending
+the base error class:
++
+* {reference}/AuthError[AuthError] - Raised when authentication or
+authorization fail.
++
+* {reference}/ConnectionError[ConnectionError] - Raised when the name of
+the server can't be resolved, and when the server is down or
+unreachable.
++
+* {reference}/NotFoundError[NotFoundError] - Raised when the requested
+object doesn't exist.
++
+* {reference}/TimeoutError[TimeoutError] - Raised when an operation times
+out.
 
 Types::
 
@@ -106,7 +122,7 @@ locators_ and _service methods_ (described later) may change in the
 future.
 
 There are other classes, like HTTP client classes, readers and writers.
-These are used to implement the HTTP communication, and to for XML
+These are used to implement the HTTP communication, and for XML
 parsing and rendering. Refrain from using them, as they are internal
 implementation details that may change in the future: backwards
 compatibility isn't guaranteed.
@@ -127,6 +143,9 @@ connection = OvirtSDK4::Connection.new(
   password: '...',
   ca_file: 'ca.pem',
 )
+
+# Get the reference to the root of the tree of services:
+system_service = connection.system_service
 ----
 
 The connection holds expensive resources, including a pool of HTTP
@@ -139,7 +158,8 @@ important to free these resources when they are no longer in use:
 connection.close
 ----
 
-Once a connection is closed it can't be reused.
+The connection and all the services that have been obtained from it
+can't be used after the connection has been closed.
 
 The `ca.pem` file is required when connecting to a server protected
 with TLS. In an usual oVirt installation it will be in
@@ -156,9 +176,9 @@ The type classes are pure data containers, they don't have any logic or
 operations. Instances can be created and modified at will.
 
 Creating or modifying one of this instances does *not* have any effect
-in the server side, unless one they are explicitly passed to a call to
-one of the service methods described below. Changes in the server side
-are *not* automatically reflected in the instances that already exist in
+in the server side, unless they are explicitly passed to a call to one
+of the service methods described below. Changes in the server side are
+*not* automatically reflected in the instances that already exist in
 memory.
 
 The constructors of these classes have multiple optional arguments, one
@@ -181,6 +201,28 @@ vm = OvirtSDK4::Vm.new(
 )
 ----
 
+The hashes passed to these constructors are processed recursively. For
+example, in the above code instead of explicitly calling the constructor
+for the `Cluster` and `Template` classes it is also possible to use
+plain hashes:
+
+[source,ruby]
+----
+vm = OvirtSDK4::Vm.new(
+  name: 'myvm',
+  cluster: {
+    name: 'mycluster'
+  },
+  template: {
+    name: 'mytemplate'
+  },
+  memory: 1073741824
+)
+----
+
+The SDK will internally convert those hashes to the required classes, so
+the result will be exactly the same.
+
 Using the constructors in this way is recommended, but not mandatory.
 You can also create the instance with no arguments in the call to the
 constructor, and then populate the object step by step, using the
@@ -192,7 +234,7 @@ vm = OvirtSDK4::Vm.new
 vm.name = 'myvm'
 vm.cluster = OvirtSDK4::Cluster.new(name: 'mycluster')
 vm.template = OvirtSDK4::Template.new(name: 'mytemplate')
-vm.memory=1073741824
+vm.memory = 1073741824
 ----
 
 Attributes that are defined as lists of objects in the specification of
@@ -299,7 +341,7 @@ manages the collection of virtual machines of the system lives in
 
 In the SDK the root of that tree of services is implemented by the
 _system service_. It is obtained calling the
-{rererence}/Connection#system_service-instance_method[system_service]
+{reference}/Connection#system_service-instance_method[system_service]
 method of the connection:
 
 [source,ruby]
@@ -352,7 +394,8 @@ The services that manage a single object usually have the `get`,
 
 Both kinds of services can also have additional _action methods_, which
 perform actions other than retrieving, creating, updating or removing.
-Most frequently they available in services that manage a single object.
+Most frequently they are available in services that manage a single
+object.
 
 ==== Using the _get_ methods
 
@@ -427,7 +470,7 @@ vms_service = system_service.vms_service
 vms = vms_service.list
 ----
 
-The result will be a Ruby array containing the instances of
+The result will be a Ruby array containing the instances of the
 corresponding types. For example, in this case, the result will be a
 list of instances of the Ruby class {reference}/Vm[Vm].
 
@@ -456,8 +499,8 @@ of the failure.
 
 ==== Using the _add_ methods
 
-These service methods add new elements to the collection. They receive
-an instance of the relevant type describing the object to add, send the
+These service methods add new elements to collections. They receive an
+instance of the relevant type describing the object to add, send the
 request to add it, and return an instance of the type describing the
 added object.
 
@@ -469,12 +512,12 @@ For example, to add a new virtual machine named `myvm`:
 vm = vms_service.add(
   OvirtSDK4::Vm.new(
     name: 'myvm',
-    cluster: OvirtSDK4::Cluster.new(
+    cluster: {
       name: 'mycluster'
-    ),
-    template: OvirtSDK4::Template.new(
+    },
+    template: {
       name: 'mytemplate'
-    )
+    }
   )
 )
 ----
@@ -539,10 +582,10 @@ updated.
 
 ==== Using the _update_ methods
 
-These service methods update existing objects. They receive
-an instance of the relevant type describing the update to perform, send
-the request to update it, and return an instance of the type describing
-the updated object.
+These service methods update existing objects. They receive an instance
+of the relevant type describing the update to perform, send the request
+to update it, and return an instance of the type describing the updated
+object.
 
 For example, to update the name of a virtual machine from `myvm` to
 `newvm`:
@@ -569,7 +612,7 @@ update. For example, try to *avoid* this:
 [source,ruby]
 ----
 # Retrieve the current representation:
-vm = vm_service.get()
+vm = vm_service.get
 
 # Update the representation, in memory, no request sent
 # to the server:

data/ext/ovirtsdk4c/ov_error.c

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2015-2016 Red Hat, Inc.
+Copyright (c) 2015-2017 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.
@@ -19,9 +19,16 @@ limitations under the License.
 #include "ov_module.h"
 #include "ov_error.h"
 
-/* Class: */
+/* Classes: */
 VALUE ov_error_class;
+VALUE ov_connection_error_class;
+VALUE ov_timeout_error_class;
 
 void ov_error_define(void) {
+    /* Define the base error class: */
     ov_error_class = rb_define_class_under(ov_module, "Error", rb_eStandardError);
+
+    /* Define the specialized error classes: */
+    ov_connection_error_class = rb_define_class_under(ov_module, "ConnectionError", ov_error_class);
+    ov_timeout_error_class = rb_define_class_under(ov_module, "TimeoutError", ov_error_class);
 }

data/ext/ovirtsdk4c/ov_error.h

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2015-2016 Red Hat, Inc.
+Copyright (c) 2015-2017 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.
@@ -19,6 +19,8 @@ limitations under the License.
 
 // Classes:
 extern VALUE ov_error_class;
+extern VALUE ov_connection_error_class;
+extern VALUE ov_timeout_error_class;
 
 // Initialization function:
 extern void ov_error_define(void);

data/ext/ovirtsdk4c/ov_http_client.c

@@ -583,10 +583,12 @@ static int ov_http_client_add_header(VALUE name, VALUE value, struct curl_slist*
 static void* ov_http_client_complete_task(void* data) {
     CURLM* handle;
     CURLMsg* message;
-    VALUE error;
+    VALUE error_class;
+    VALUE error_instance;
     VALUE transfer;
     long code;
     ov_http_client_object* client_ptr;
+    ov_http_request_object* request_ptr;
     ov_http_response_object* response_ptr;
     ov_http_transfer_object* transfer_ptr;
 
@@ -600,6 +602,7 @@ static void* ov_http_client_complete_task(void* data) {
     /* Get the pointers to the transfer, client and response: */
     ov_http_transfer_ptr(transfer, transfer_ptr);
     ov_http_client_ptr(transfer_ptr->client, client_ptr);
+    ov_http_request_ptr(transfer_ptr->request, request_ptr);
     ov_http_response_ptr(transfer_ptr->response, response_ptr);
 
     /* Remove the transfer from the pending hash: */
@@ -617,15 +620,31 @@ static void* ov_http_client_complete_task(void* data) {
         /* Send a summary of the response to the log: */
         ov_http_client_log_info(
             client_ptr->log,
-            "Received response code '%"PRIsVALUE"'.",
-            response_ptr->code
+            "Received response code %"PRIsVALUE" for %"PRIsVALUE" request to URL '%"PRIsVALUE"'.",
+            response_ptr->code,
+            request_ptr->method,
+            request_ptr->url
         );
     }
     else {
+        /* Select the error class according to the kind of error returned by libcurl: */
+        switch (message->data.result) {
+        case CURLE_COULDNT_CONNECT:
+        case CURLE_COULDNT_RESOLVE_HOST:
+        case CURLE_COULDNT_RESOLVE_PROXY:
+            error_class = ov_connection_error_class;
+            break;
+        case CURLE_OPERATION_TIMEDOUT:
+            error_class = ov_timeout_error_class;
+            break;
+        default:
+            error_class = ov_error_class;
+        }
+
         /* Put the request and error in the completed transfers hash: */
-        error = rb_sprintf("Can't send request: %s", curl_easy_strerror(message->data.result));
-        error = rb_class_new_instance(1, &error, ov_error_class);
-        rb_hash_aset(client_ptr->completed, transfer_ptr->request, error);
+        error_instance = rb_sprintf("Can't send request: %s", curl_easy_strerror(message->data.result));
+        error_instance = rb_class_new_instance(1, &error_instance, error_class);
+        rb_hash_aset(client_ptr->completed, transfer_ptr->request, error_instance);
     }
 
     /* Now that the libcurl easy handle is released, we can release the headers as well: */
@@ -806,7 +825,7 @@ static void ov_http_client_prepare_handle(ov_http_client_object* client_ptr, ov_
     /* Send a summary of the request to the log: */
     ov_http_client_log_info(
         client_ptr->log,
-        "Sending '%"PRIsVALUE"' request to URL '%"PRIsVALUE"'.",
+        "Sending %"PRIsVALUE" request to URL '%"PRIsVALUE"'.",
         request_ptr->method,
         url
     );

data/lib/ovirtsdk4.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015-2016 Red Hat, Inc.
+# Copyright (c) 2015-2017 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.
@@ -28,7 +28,7 @@ require 'ovirtsdk4c'
 # Own requirements.
 #
 require 'ovirtsdk4/version.rb'
-require 'ovirtsdk4/error.rb'
+require 'ovirtsdk4/errors.rb'
 require 'ovirtsdk4/connection.rb'
 require 'ovirtsdk4/type.rb'
 require 'ovirtsdk4/types.rb'

data/lib/ovirtsdk4/connection.rb

@@ -192,7 +192,7 @@ module OvirtSDK4
     #
     def send(request)
       # Add the base URL to the request:
-      request.url = request.url.nil? ? request.url = @url : "#{@url}#{request.url}"
+      request.url = request.url.nil? ? request.url = @url : "#{@url}/#{request.url}"
 
       # Set the headers common to all requests:
       request.headers.merge!(
@@ -227,6 +227,8 @@ module OvirtSDK4
     # @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 wait(request)
       # Wait for the response:
       response = @client.wait(request)
@@ -245,144 +247,6 @@ module OvirtSDK4
       response
     end
 
-    #
-    # Obtains the access token from SSO to be used for bearer authentication.
-    #
-    # @return [String] The access token.
-    #
-    # @api private
-    #
-    def create_access_token
-      # Build the URL and parameters required for the request:
-      url, parameters = build_sso_auth_request
-
-      # Send the request and wait for the request:
-      response = get_sso_response(url, parameters)
-      response = response[0] if response.is_a?(Array)
-
-      # 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
-
-    #
-    # Revoke the SSO access token.
-    #
-    # @api private
-    #
-    def revoke_access_token
-      # 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)
-
-      # 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
-
-    #
-    # Execute a get request to the SSO server and return the response.
-    #
-    # @param url [String] The URL of the SSO server.
-    #
-    # @param parameters [Hash] The parameters to send to the SSO server.
-    #
-    # @return [Hash] The JSON response.
-    #
-    # @api private
-    #
-    def get_sso_response(url, parameters)
-      # Create the request:
-      request = HttpRequest.new
-      request.method = :POST
-      request.url = url
-      request.headers = {
-        'User-Agent' => "RubySDK/#{VERSION}",
-        'Content-Type' => 'application/x-www-form-urlencoded',
-        'Accept' => 'application/json'
-      }
-      request.body = URI.encode_www_form(parameters)
-
-      # Add the global headers:
-      request.headers.merge!(@headers) if @headers
-
-      # Send the request and wait for the response:
-      @client.send(request)
-      response = @client.wait(request)
-      raise response if response.is_a?(Exception)
-
-      # Check the returned content type:
-      check_json_content_type(response)
-
-      # Parse and return the JSON response:
-      JSON.parse(response.body)
-    end
-
-    #
-    # Builds a the URL and parameters to acquire the access token from SSO.
-    #
-    # @return [Array] An array containing two elements, the first is the URL of the SSO service and the second is a hash
-    #   containing the parameters required to perform authentication.
-    #
-    # @api private
-    #
-    def build_sso_auth_request
-      # Compute the entry point and the parameters:
-      parameters = {
-        scope: 'ovirt-app-api'
-      }
-      if @kerberos
-        entry_point = 'token-http-auth'
-        parameters[:grant_type] = 'urn:ovirt:params:oauth:grant-type:http'
-      else
-        entry_point = 'token'
-        parameters.merge!(
-          grant_type: 'password',
-          username: @username,
-          password: @password
-        )
-      end
-
-      # Compute the URL:
-      url = URI(@url.to_s)
-      url.path = "/ovirt-engine/sso/oauth/#{entry_point}"
-      url = url.to_s
-
-      # Return the pair containing the URL and the parameters:
-      [url, parameters]
-    end
-
-    #
-    # Builds a the URL and parameters to revoke the SSO access token
-    #
-    # @return [Array] An array containing two elements, the first is the URL of the SSO service and the second is a hash
-    #   containing the parameters required to perform the revoke.
-    #
-    # @api private
-    #
-    def build_sso_revoke_request
-      # Compute the parameters:
-      parameters = {
-        scope: '',
-        token: @token
-      }
-
-      # Compute the URL:
-      url = URI(@url.to_s)
-      url.path = '/ovirt-engine/services/sso-logout'
-      url = url.to_s
-
-      # Return the pair containing the URL and the parameters:
-      [url, parameters]
-    end
-
     #
     # Tests the connectivity with the server. If connectivity works correctly it returns `true`. If there is any
     # connectivity problem it will either return `false` or raise an exception if the `raise_exception` parameter is
@@ -546,7 +410,16 @@ module OvirtSDK4
       end
 
       # Create and populate the error:
-      error = Error.new(message)
+      klass = Error
+      unless response.nil?
+        case response.code
+        when 401, 403
+          klass = AuthError
+        when 404
+          klass = NotFoundError
+        end
+      end
+      error = klass.new(message)
       error.code = response.code if response
       error.fault = fault
 
@@ -596,5 +469,161 @@ module OvirtSDK4
       end
       raise_error(response, detail)
     end
+
+    #
+    # Obtains the access token from SSO to be used for bearer authentication.
+    #
+    # @return [String] The access token.
+    #
+    # @api private
+    #
+    def create_access_token
+      # Build the URL and parameters required for the request:
+      url, parameters = build_sso_auth_request
+
+      # Send the request and wait for the request:
+      response = get_sso_response(url, parameters)
+      response = response[0] if response.is_a?(Array)
+
+      # Check the response and raise an error if it contains an error code:
+      error = get_sso_error_message(response)
+      raise AuthError, "Error during SSO authentication: #{error}" if error
+
+      response['access_token']
+    end
+
+    #
+    # Revoke the SSO access token.
+    #
+    # @api private
+    #
+    def revoke_access_token
+      # 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)
+
+      # Check the response and raise an error if it contains an error code:
+      error = get_sso_error_message(response)
+      raise AuthError, "Error during SSO revoke: #{error}" if error
+    end
+
+    #
+    # Execute a get request to the SSO server and return the response.
+    #
+    # @param url [String] The URL of the SSO server.
+    #
+    # @param parameters [Hash] The parameters to send to the SSO server.
+    #
+    # @return [Hash] The JSON response.
+    #
+    # @api private
+    #
+    def get_sso_response(url, parameters)
+      # Create the request:
+      request = HttpRequest.new
+      request.method = :POST
+      request.url = url
+      request.headers = {
+        'User-Agent' => "RubySDK/#{VERSION}",
+        'Content-Type' => 'application/x-www-form-urlencoded',
+        'Accept' => 'application/json'
+      }
+      request.body = URI.encode_www_form(parameters)
+
+      # Add the global headers:
+      request.headers.merge!(@headers) if @headers
+
+      # Send the request and wait for the response:
+      @client.send(request)
+      response = @client.wait(request)
+      raise response if response.is_a?(Exception)
+
+      # Check the returned content type:
+      check_json_content_type(response)
+
+      # Parse and return the JSON response:
+      JSON.parse(response.body)
+    end
+
+    #
+    # Builds a the URL and parameters to acquire the access token from SSO.
+    #
+    # @return [Array] An array containing two elements, the first is the URL of the SSO service and the second is a hash
+    #   containing the parameters required to perform authentication.
+    #
+    # @api private
+    #
+    def build_sso_auth_request
+      # Compute the entry point and the parameters:
+      parameters = {
+        scope: 'ovirt-app-api'
+      }
+      if @kerberos
+        entry_point = 'token-http-auth'
+        parameters[:grant_type] = 'urn:ovirt:params:oauth:grant-type:http'
+      else
+        entry_point = 'token'
+        parameters.merge!(
+          grant_type: 'password',
+          username: @username,
+          password: @password
+        )
+      end
+
+      # Compute the URL:
+      url = URI(@url.to_s)
+      url.path = "/ovirt-engine/sso/oauth/#{entry_point}"
+      url = url.to_s
+
+      # Return the pair containing the URL and the parameters:
+      [url, parameters]
+    end
+
+    #
+    # Builds a the URL and parameters to revoke the SSO access token
+    #
+    # @return [Array] An array containing two elements, the first is the URL of the SSO service and the second is a hash
+    #   containing the parameters required to perform the revoke.
+    #
+    # @api private
+    #
+    def build_sso_revoke_request
+      # Compute the parameters:
+      parameters = {
+        scope: '',
+        token: @token
+      }
+
+      # Compute the URL:
+      url = URI(@url.to_s)
+      url.path = '/ovirt-engine/services/sso-logout'
+      url = url.to_s
+
+      # Return the pair containing the URL and the parameters:
+      [url, parameters]
+    end
+
+    #
+    # Extrats the error message from the given SSO response.
+    #
+    # @param response [Hash] The result of parsing the JSON document returned by the SSO server.
+    # @return [String] The error message, or `nil` if there was no error.
+    #
+    def get_sso_error_message(response)
+      # OAuth uses the 'error_code' attribute for the error code, and 'error' for the error description. But OpenID uses
+      # 'error' for the error code and 'error_description' for the description. So we need to check if the
+      # 'error_description' attribute is present, and extract the code and description accordingly.
+      description = response['error_description']
+      if description.nil?
+        code = response['error_code']
+        description = response['error']
+      else
+        code = response['error']
+      end
+      "#{code}: #{description}" if code
+    end
   end
 end