cloudstack_client 1.5.11 → 1.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f12a44b9de9caef1d8ca803d2661fbf236b45428b00e9a9e88f222c630aee140
-  data.tar.gz: 90e786e18f99f3a6fcb19b94298d617f42d18d8892722e288da76891945bf9b3
+  metadata.gz: 58ccc2b4e84e160367f416922cc1489c7344c4e64c5fd5b047d91a5c6cedebb3
+  data.tar.gz: e55008e191421c0cbf993e7c51d25d9a1638c39322f97db97eb583e4925aef0e
 SHA512:
-  metadata.gz: 92cd5f09d2864d21556c524262ce2187ded3a28c65c1a324bc7a8a236d98e0f44261bb0a334b879955efdc0e1065c58235bf7c6077fd1635d2bad8657ec70308
-  data.tar.gz: 11a672cd0b5f2dbd377a0e4684a1a71c090ddb29e4b90b1e938f87c3eac1df638bb22d49570830442af687aa197fa7bfea3fbbf7de453aaa0e008ddd5d1e6345
+  metadata.gz: 718ddbe8ed71342f2a2067497c71863c0407722bed849aed2e1061978ecbd6440bacedc4c3f20fcd5f0c395e969ab664f4d8d63afbebd381fe51eb5d5d3d38c9
+  data.tar.gz: 2f67eab635a6a61bae7df757bde727d2d4ccaa03f3b2a654dccea02e7fab0069913f7faef5924be50bc4a0037164119e4c36aedb9854c63d8db327df2c255d29

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - 2.7
-  - 3.0
+  - 3.2
+  - 3.4
+  - 4.0
 before_install:
   - gem update --system
   - gem install bundler

data/Gemfile.lock

@@ -7,11 +7,11 @@ GEM
   remote: https://rubygems.org/
   specs:
     bond (0.5.1)
-    minitest (5.26.1)
+    minitest (5.27.0)
     rake (13.3.1)
     ripl (0.7.1)
       bond (~> 0.5.1)
-    thor (1.4.0)
+    thor (1.5.0)
 
 PLATFORMS
   x86_64-linux
@@ -24,4 +24,4 @@ DEPENDENCIES
   thor (~> 1.1)
 
 BUNDLED WITH
-   2.5.22
+   2.6.9

data/README.md

@@ -120,13 +120,15 @@ test:
 ```
 
 ### Configuration options
+
 You can pass `options` as 4th argument in `CloudstackClient::Client.new`. All its keys are optional.
 
 ```ruby
 options = {
   symbolize_keys: true, # pass symbolize_names: true in JSON#parse for Cloudstack responses, default: false
   host: 'localhost', # custom host header to be used in Net::Http. May be useful when Cloudstack is set up locally via docker (i.e. Cloudstack-simulator), default: parsed from config[:url] via Net::Http
-  read_timeout: 10 # timeout in seconds of a connection to the Cloudstack, default: 60
+  read_timeout: 10, # timeout in seconds of a connection to the Cloudstack, default: 60
+  request_retries: 3 # number of attempts for HTTP requests before raising a ConnectionError, default: 1 (no retries). Uses incremental back-off between attempts.
 }
 cs = CloudstackClient::Client.new(config[:url], config[:api_key], config[:secret_key], options)
 ```

data/lib/cloudstack_client/connection.rb

@@ -10,11 +10,12 @@ module CloudstackClient
     include Utils
 
     attr_accessor :api_url, :api_key, :secret_key, :verbose, :debug, :symbolize_keys, :host, :read_timeout
-    attr_accessor :async_poll_interval, :async_timeout
+    attr_accessor :async_poll_interval, :async_timeout, :request_retries
 
     DEF_POLL_INTERVAL = 2.0
     DEF_ASYNC_TIMEOUT = 400
     DEF_REQ_TIMEOUT = 60
+    DEF_REQUEST_RETRIES = 1
 
     def initialize(api_url, api_key, secret_key, options = {})
       @api_url = api_url
@@ -27,6 +28,7 @@ module CloudstackClient
       @read_timeout = options[:read_timeout] || DEF_REQ_TIMEOUT
       @async_poll_interval = options[:async_poll_interval] || DEF_POLL_INTERVAL
       @async_timeout = options[:async_timeout] || DEF_ASYNC_TIMEOUT
+      @request_retries = options[:request_retries] || DEF_REQUEST_RETRIES
       @options = options
       validate_input!
     end
@@ -50,12 +52,19 @@ module CloudstackClient
       end
       http.read_timeout = @read_timeout
 
+      retries = 0
       begin
         req = Net::HTTP::Get.new(uri.request_uri)
         req['Host'] = host if host.present?
         response = http.request(req)
-      rescue
-        raise ConnectionError, "API URL \'#{@api_url}\' is not reachable."
+      rescue => e
+        retries += 1
+        if retries < @request_retries
+          sleep(retries) # incremental back-off
+          print "." if @verbose
+          retry
+        end
+        raise ConnectionError, "API URL \'#{@api_url}\' is not reachable (after #{retries} attempt#{'s' if retries > 1}): #{e.message}"
       end
 
       begin
@@ -87,7 +96,7 @@ module CloudstackClient
     #
     # The contents of the 'jobresult' element are returned upon completion of the command.
 
-    def send_async_request(params, **opts)
+    def send_async_request(params, opts = {})
       data = send_request(params, opts)
 
       params = {
@@ -121,6 +130,7 @@ module CloudstackClient
       raise InputError, "API SECRET KEY not set." if @secret_key == nil
       raise InputError, "ASYNC POLL INTERVAL must be at least 1." if @async_poll_interval < 1.0
       raise InputError, "ASYNC TIMEOUT must be at least 60." if @async_timeout < 60
+      raise InputError, "REQUEST RETRIES must be at least 1." if @request_retries < 1
     end
 
     def params_to_data(params)

data/lib/cloudstack_client/version.rb

@@ -1,3 +1,3 @@
 module CloudstackClient
-  VERSION = "1.5.11"
+  VERSION = "1.5.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.5.11
+  version: 1.5.12
 platform: ruby
 authors:
 - Nik Wolfgramm