cloudstack_client 1.5.11 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f12a44b9de9caef1d8ca803d2661fbf236b45428b00e9a9e88f222c630aee140
-  data.tar.gz: 90e786e18f99f3a6fcb19b94298d617f42d18d8892722e288da76891945bf9b3
+  metadata.gz: 99f564bf41bdccf82b53c267179080034a91d8ab0650b164c8099a6e4cdba289
+  data.tar.gz: 79fc42e2f3dcef1ae5111edc9e19d70158e42c444d2814f5a637d4de4e8612bb
 SHA512:
-  metadata.gz: 92cd5f09d2864d21556c524262ce2187ded3a28c65c1a324bc7a8a236d98e0f44261bb0a334b879955efdc0e1065c58235bf7c6077fd1635d2bad8657ec70308
-  data.tar.gz: 11a672cd0b5f2dbd377a0e4684a1a71c090ddb29e4b90b1e938f87c3eac1df638bb22d49570830442af687aa197fa7bfea3fbbf7de453aaa0e008ddd5d1e6345
+  metadata.gz: 76fadda1e05ea7b8083323bd780bd8ac876e29a3f807d8e2486a1142dd6f88d4f8ef71dfececb105c4f180f8cf4650bfad113eb9483048762df6b5c9aac42669
+  data.tar.gz: a140a1f97df576782796745c7f64a012b9be86a355f48cd50a223765889cce489c2cb8698cbed70ee4d7479c25c88ded4b45540148282ff636e8c753028ed943

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.3']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test
+
+      - name: Build gem
+        run: bundle exec rake build

data/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  push:
+    branches: [ "main" ]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test
+
+      - name: Ensure version is bumped
+        run: |
+          CURRENT_VERSION="$(ruby -Ilib -e "require 'cloudstack_client/version'; puts CloudstackClient::VERSION")"
+          LATEST_JSON="$(curl -fsSL https://rubygems.org/api/v1/versions/cloudstack_client/latest.json || true)"
+          if [ -n "$LATEST_JSON" ]; then
+            LATEST_VERSION="$(printf '%s' "$LATEST_JSON" | ruby -rjson -e "puts JSON.parse(STDIN.read)['version']")"
+            ruby -e "require 'rubygems/version'; current = Gem::Version.new('$CURRENT_VERSION'); latest = Gem::Version.new('$LATEST_VERSION'); abort(\"Version must be bumped before building (current=#{current}, latest=#{latest})\") unless current > latest"
+          fi
+
+      - name: Build gem
+        run: bundle exec rake build
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: verify
+    environment: rubygems
+
+
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Publish gem to RubyGems
+        uses: rubygems/release-gem@v1
+        with:
+          api-key: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}

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.11)
+    cloudstack_client (1.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bond (0.5.1)
-    minitest (5.26.1)
-    rake (13.3.1)
+    minitest (5.27.0)
+    rake (13.4.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

@@ -1,7 +1,6 @@
 # cloudstack_client
 
 [![Gem Version](https://badge.fury.io/rb/cloudstack_client.png)](http://badge.fury.io/rb/cloudstack_client)
- [![Build Status](https://travis-ci.com/niwo/cloudstack_client.svg?branch=master)](https://travis-ci.com/niwo/cloudstack_client)
 
 A CloudStack API client written in Ruby.
 
@@ -120,17 +119,26 @@ 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)
 ```
 
+For a single call you can override defaults on the **second** hash (client options), without changing the client instance:
+
+```ruby
+cs.deploy_virtual_machine({ zoneid: "...", serviceofferingid: "...", templateid: "..." },
+                          async_timeout: 600, async_poll_interval: 5)
+```
+
 ### Interactive Console
 
 cloudstack_client comes with an interactive console.
@@ -156,6 +164,19 @@ $ cloudstack_client list_apis > data/4.15.json
 $ gzip data/4.15.json
 ```
 
+### GitHub Actions
+
+This repository includes GitHub Actions workflows for:
+
+- Running tests and gem build on every push and pull request (`CI`)
+- Publishing the gem to RubyGems when a GitHub Release is published (`Release`)
+
+To enable publishing, add this repository secret:
+
+- `RUBYGEMS_AUTH_TOKEN`: your RubyGems API key with push permissions
+
+The release workflow checks that `CloudstackClient::VERSION` is greater than the latest version on RubyGems before building, then uses the `rubygems` environment to publish.
+
 ## References
 
 - [Apache CloudStack API documentation](http://cloudstack.apache.org/api/apidocs-4.15/)

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,11 @@ 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 = {})
+      request_timeout = opts[:async_timeout] || @async_timeout
+      poll_interval = opts[:async_poll_interval] || @async_poll_interval
+      validate_async_timeouts!(request_timeout, poll_interval)
+
       data = send_request(params, opts)
 
       params = {
@@ -95,7 +108,7 @@ module CloudstackClient
         'jobid' => data[k('jobid')]
       }
 
-      max_tries.times do
+      max_tries(request_timeout, poll_interval).times do
         data = send_request(params)
         print "." if @verbose
 
@@ -107,7 +120,7 @@ module CloudstackClient
         end
 
         STDOUT.flush if @verbose
-        sleep @async_poll_interval
+        sleep poll_interval
       end
 
       raise TimeoutError, "Asynchronous request timed out."
@@ -119,8 +132,13 @@ module CloudstackClient
       raise InputError, "API URL not set." if @api_url == nil
       raise InputError, "API KEY not set." if @api_key == nil
       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
+      validate_async_timeouts!(@async_timeout, @async_poll_interval)
+      raise InputError, "REQUEST RETRIES must be at least 1." if @request_retries < 1
+    end
+
+    def validate_async_timeouts!(timeout, interval)
+      raise InputError, "ASYNC POLL INTERVAL must be at least 1." if interval < 1.0
+      raise InputError, "ASYNC TIMEOUT must be at least 60." if timeout < 60
     end
 
     def params_to_data(params)
@@ -150,8 +168,8 @@ module CloudstackClient
       CGI.escape(signature)
     end
 
-    def max_tries
-      (@async_timeout / @async_poll_interval).round
+    def max_tries(timeout, interval)
+      (timeout / interval).round
     end
 
     def escape(input)

data/lib/cloudstack_client/version.rb

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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.5.11
+  version: 1.6.0
 platform: ruby
 authors:
 - Nik Wolfgramm
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,6 +74,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -105,6 +108,7 @@ homepage: https://github.com/niwo/cloudstack_client
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -121,7 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: CloudStack API client written in Ruby
 test_files: