cloudstack_client 1.5.10 → 1.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cafadb44577a4fb75b477438b2a6e256c8715c06681dde1a8e6e815f96a47ff
-  data.tar.gz: 24e9e5324a23c639d3e6c472c25614ecade9ed3af6eb8d450dba10d871b021d9
+  metadata.gz: 58ccc2b4e84e160367f416922cc1489c7344c4e64c5fd5b047d91a5c6cedebb3
+  data.tar.gz: e55008e191421c0cbf993e7c51d25d9a1638c39322f97db97eb583e4925aef0e
 SHA512:
-  metadata.gz: 38b9395b2f67ad5842b554444465d1da58b3ef8173b6d4bea880bf7263d763c5114e8afdca7b6e66f21972a8790afabbb3630d8ed85044366427769f72734bc4
-  data.tar.gz: 774377ebc139f7f79acdf146358b30a69229caf814477855a76677629178e9033685a6d5fb3aff0dd896bbc9123e5f558ba9c30b8805a269a5464c7415326720
+  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

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    cloudstack_client (1.5.10)
+    cloudstack_client (1.5.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bond (0.5.1)
-    minitest (5.25.4)
-    rake (13.2.1)
+    minitest (5.27.0)
+    rake (13.3.1)
     ripl (0.7.1)
       bond (~> 0.5.1)
-    thor (1.3.2)
+    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/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2015 Nik Wolfgramm
+Copyright (c) 2013-2025 Nik Wolfgramm
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -68,6 +68,21 @@ cs = CloudstackClient::Client.new(
 )
 ```
 
+### Pagination and Response Options
+
+When working with paginated responses, you can include the total count in the API response:
+
+```ruby
+# Get paginated results with count information
+vms = cs.list_virtual_machines({ page: 1, pagesize: 10 }, { include_count: true })
+total_count = vms[:count]
+items = vms[:virtualmachine]
+
+# Default behavior (without count)
+vms = cs.list_virtual_machines(page: 1, pagesize: 10)
+# Returns just the items array
+```
+
 ### Using the configuration module
 
 The configuration module of CloudstackClient makes it easy to load CloudStack API settings from configuration files.
@@ -105,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/client.rb

@@ -34,10 +34,11 @@ module CloudstackClient
             raise ParameterError, @api.missing_params_msg(command["name"])
           end
 
+
           if command["isasync"] == false || options[:sync]
-            send_request(params)
+            send_request(params, options)
           else
-            send_async_request(params)
+            send_async_request(params, options)
           end
         end
       end

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
@@ -35,7 +37,7 @@ module CloudstackClient
     # Sends a synchronous request to the CloudStack API and returns the response as a Hash.
     #
 
-    def send_request(params)
+    def send_request(params, opts = {})
       params['response'] = 'json'
       params['apiKey'] = @api_key
       print_debug_output JSON.pretty_generate(params) if @debug
@@ -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
@@ -68,12 +77,12 @@ module CloudstackClient
       if response.is_a?(Net::HTTPOK)
         return body unless body.respond_to?(:keys)
         if body.size == 2 && body.key?(k('count'))
-          return body.reject { |key, _| key == k('count') }.values.first
+          return opts[:include_count] ? body : body.reject { |key, _| key == k('count') }.values.first
         elsif body.size == 1 && body.values.first.respond_to?(:keys)
           item = body.values.first
           return (item.is_a?(Array) || item.is_a?(Hash)) ? item : []
         else
-          body.reject! { |key, _| key == k('count') } if body.key?(k('count'))
+          body.reject! { |key, _| key == k('count') } if body.key?(k('count')) && !opts[:include_count]
           body.size == 0 ? [] : body
         end
       else
@@ -87,8 +96,8 @@ module CloudstackClient
     #
     # The contents of the 'jobresult' element are returned upon completion of the command.
 
-    def send_async_request(params)
-      data = send_request(params)
+    def send_async_request(params, opts = {})
+      data = send_request(params, opts)
 
       params = {
         'command' => 'queryAsyncJobResult',
@@ -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.10"
+  VERSION = "1.5.12"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.5.10
+  version: 1.5.12
 platform: ruby
 authors:
 - Nik Wolfgramm
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -106,7 +105,6 @@ homepage: https://github.com/niwo/cloudstack_client
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -123,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CloudStack API client written in Ruby
 test_files: