cloudstack_client 1.6.0 → 2.0.0

data/test/support/api_stubs.rb

@@ -0,0 +1,85 @@
+require "json"
+
+# Helpers for stubbing CloudStack HTTP responses.
+#
+# Every CloudStack request carries a generated `signature` query parameter, so
+# stubs match on the `command` parameter with `hash_including` rather than on a
+# full URL.
+module ApiStubs
+  API_ENDPOINT = "https://cloudstack.test/client/api".freeze
+
+  # WebMock matches a bare URL only against requests with no query string, and
+  # every CloudStack request carries one. Match on the endpoint prefix instead.
+  ANY_REQUEST = %r{\Ahttps://cloudstack\.test/client/api}.freeze
+
+  # Stub a CloudStack command with an already-shaped response body.
+  #
+  #   stub_command("listZones", "listzonesresponse" => { "count" => 1, ... })
+  def stub_command(command, body, status: 200)
+    stub_request(:get, API_ENDPOINT)
+      .with(query: hash_including("command" => command))
+      .to_return(
+        status: status,
+        body: JSON.generate(body),
+        headers: { "Content-Type" => "application/json" }
+      )
+  end
+
+  # Stub a command using CloudStack's usual envelope:
+  # { "<command>response" => { "count" => n, "<entity>" => [...] } }
+  def stub_list(command, entity, items, count: nil, extra: {})
+    inner = { "count" => count || items.size, entity => items }.merge(extra)
+    stub_command(command, { "#{command.downcase}response" => inner })
+  end
+
+  # Stub the initial async command, then the queryAsyncJobResult polls.
+  #
+  # `polls` is an array of jobstatus payloads returned in order.
+  def stub_async(command, job_id: "job-1", polls: [])
+    stub_command(command, { "#{command.downcase}response" => { "jobid" => job_id } })
+
+    responses = polls.map do |poll|
+      {
+        status: 200,
+        body: JSON.generate("queryasyncjobresultresponse" => poll),
+        headers: { "Content-Type" => "application/json" }
+      }
+    end
+
+    stub_request(:get, API_ENDPOINT)
+      .with(query: hash_including("command" => "queryAsyncJobResult"))
+      .to_return(*responses)
+  end
+
+  # A completed async job payload.
+  def job_success(result)
+    { "jobstatus" => 1, "jobresult" => result }
+  end
+
+  # A failed async job payload.
+  def job_failure(errortext, code: 530)
+    {
+      "jobstatus" => 2,
+      "jobresultcode" => code,
+      "jobresult" => { "errortext" => errortext }
+    }
+  end
+
+  # An in-flight async job payload.
+  def job_pending
+    { "jobstatus" => 0 }
+  end
+
+  # Parsed query parameters of the most recent request, for asserting on how
+  # a request was built rather than only on what came back.
+  def last_request_params
+    signature = WebMock::RequestRegistry.instance.requested_signatures.hash.keys.last
+    raise "no request was made" if signature.nil?
+
+    # CGI.parse was removed in Ruby 4.0; only CGI.escape/unescape remain.
+    URI.decode_www_form(signature.uri.query.to_s)
+       .each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |(key, value), acc|
+         acc[key] << value
+       end
+  end
+end

data/test/test_helper.rb

@@ -2,4 +2,41 @@ require "cloudstack_client"
 
 require "minitest/spec"
 require "minitest/autorun"
-require "minitest/pride"
+# Minitest 6 extracted Object#stub into the minitest-mock gem.
+require "minitest/mock"
+require "minitest/reporters"
+
+require "webmock/minitest"
+
+# No test may reach the network. An accidental live request should fail loudly
+# rather than turn into a slow or flaky test.
+WebMock.disable_net_connect!(allow_localhost: false)
+
+Minitest::Reporters.use!(
+  ENV["CI"] ? Minitest::Reporters::ProgressReporter.new : Minitest::Reporters::SpecReporter.new
+)
+
+require_relative "support/api_stubs"
+
+module TestHelpers
+  TEST_URL    = "https://cloudstack.test/client/api".freeze
+  TEST_KEY    = "test-key".freeze
+  TEST_SECRET = "test-secret".freeze
+
+  def fixture_path(*parts)
+    File.join(File.expand_path("data", __dir__), *parts)
+  end
+
+  # A client with no dynamically defined API methods: useful when the test
+  # targets Connection behaviour rather than the generated command methods.
+  def bare_client(options = {})
+    CloudstackClient::Client.new(
+      TEST_URL, TEST_KEY, TEST_SECRET, { no_api_methods: true }.merge(options)
+    )
+  end
+end
+
+class Minitest::Spec
+  include TestHelpers
+  include ApiStubs
+end

data/test/utils_test.rb

@@ -0,0 +1,62 @@
+require "test_helper"
+
+describe CloudstackClient::Utils do
+  let(:utils) { Object.new.extend(CloudstackClient::Utils) }
+
+  describe "camel_case_to_underscore" do
+    it "converts a simple camel case command" do
+      _(utils.camel_case_to_underscore("listVirtualMachines"))
+        .must_equal "list_virtual_machines"
+    end
+
+    it "splits a leading acronym from the following word" do
+      _(utils.camel_case_to_underscore("listVPCOfferings"))
+        .must_equal "list_vpc_offerings"
+    end
+
+    it "handles a trailing acronym" do
+      _(utils.camel_case_to_underscore("listOsTypes")).must_equal "list_os_types"
+    end
+
+    it "handles consecutive capitals followed by a word" do
+      _(utils.camel_case_to_underscore("createSSHKeyPair"))
+        .must_equal "create_ssh_key_pair"
+    end
+
+    it "converts hyphens to underscores" do
+      _(utils.camel_case_to_underscore("some-command")).must_equal "some_command"
+    end
+
+    it "leaves an already underscored name unchanged" do
+      _(utils.camel_case_to_underscore("list_apis")).must_equal "list_apis"
+    end
+  end
+
+  describe "underscore_to_camel_case" do
+    it "converts an underscored name" do
+      _(utils.underscore_to_camel_case("list_virtual_machines"))
+        .must_equal "listVirtualMachines"
+    end
+
+    it "returns a name without underscores unchanged" do
+      _(utils.underscore_to_camel_case("listApis")).must_equal "listApis"
+    end
+
+    it "cannot restore acronym casing, because the conversion is lossy" do
+      # Documents a known limitation: "ssh" carries no record of "SSH".
+      # Api resolves underscored names through an index instead of relying
+      # on this method being a true inverse.
+      _(utils.underscore_to_camel_case("create_ssh_key_pair"))
+        .must_equal "createSshKeyPair"
+    end
+  end
+
+  describe "round tripping real command names" do
+    it "round trips names without acronyms" do
+      %w[listVirtualMachines deployVirtualMachine listOsTypes listApis].each do |name|
+        underscored = utils.camel_case_to_underscore(name)
+        _(utils.underscore_to_camel_case(underscored)).must_equal name
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nik Wolfgramm
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,17 +69,108 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.14'
-description: CloudStack API client written in Ruby
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.26'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.90'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A Ruby client for the Apache CloudStack API that builds its methods dynamically
+  from the CloudStack API definition, including an interactive console.
 email:
 - nik.wolfgramm@gmail.com
 executables:
@@ -74,12 +178,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -93,22 +199,33 @@ files:
 - lib/cloudstack_client/configuration.rb
 - lib/cloudstack_client/connection.rb
 - lib/cloudstack_client/error.rb
+- lib/cloudstack_client/request_handling.rb
 - lib/cloudstack_client/utils.rb
 - lib/cloudstack_client/version.rb
 - test/api_test.rb
 - test/benchmark.rb
 - test/client_test.rb
 - test/configuration_test.rb
+- test/connection_test.rb
 - test/data/0.42.json
 - test/data/0.42.json.gz
 - test/data/cloudstack-1.yml
 - test/data/cloudstack-2.yml
+- test/data/cloudstack-empty.yml
+- test/data/cloudstack-incomplete.yml
+- test/data/cloudstack-malformed.yml
+- test/data/cloudstack-unsafe.yml
+- test/support/api_stubs.rb
 - test/test_helper.rb
+- test/utils_test.rb
 homepage: https://github.com/niwo/cloudstack_client
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/niwo/cloudstack_client
+  bug_tracker_uri: https://github.com/niwo/cloudstack_client/issues
+  changelog_uri: https://github.com/niwo/cloudstack_client/releases
+  rubygems_mfa_required: 'true'
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -118,24 +235,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.18
 specification_version: 4
 summary: CloudStack API client written in Ruby
-test_files:
-- test/api_test.rb
-- test/benchmark.rb
-- test/client_test.rb
-- test/configuration_test.rb
-- test/data/0.42.json
-- test/data/0.42.json.gz
-- test/data/cloudstack-1.yml
-- test/data/cloudstack-2.yml
-- test/test_helper.rb
+test_files: []

data/.travis.yml

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

data/Gemfile.lock

@@ -1,27 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cloudstack_client (1.6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    bond (0.5.1)
-    minitest (5.27.0)
-    rake (13.4.1)
-    ripl (0.7.1)
-      bond (~> 0.5.1)
-    thor (1.5.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  cloudstack_client!
-  minitest (~> 5.14)
-  rake (~> 13.0)
-  ripl (~> 0.7)
-  thor (~> 1.1)
-
-BUNDLED WITH
-   2.6.9