cloudstack_client 1.5.9 → 1.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0a4ca31c3cfcee330c0f72ca9d0fa9895788cfb5718e3499181abdc7564df1
-  data.tar.gz: 688112d58736d2ada94c993f271eda18a923308fc94bcd93bad2775d193506b1
+  metadata.gz: f12a44b9de9caef1d8ca803d2661fbf236b45428b00e9a9e88f222c630aee140
+  data.tar.gz: 90e786e18f99f3a6fcb19b94298d617f42d18d8892722e288da76891945bf9b3
 SHA512:
-  metadata.gz: 5d2e11bbf05fa22573de42450b49015bbeabfdf29dfe2ba49701c815bc3e6f0d6f1b35fadc72dca3f3ca8ff803fbe08b37e9320b961050d1e526e1803e45b307
-  data.tar.gz: bd6003fb8f3f82c4a07f548608d927eed95d17a051a0134c2bee061eea6562d9df94caca8c5549a01e0eeccb55ee6f0ec7076140c8d9744c4a2794e8addb3c1a
+  metadata.gz: 92cd5f09d2864d21556c524262ce2187ded3a28c65c1a324bc7a8a236d98e0f44261bb0a334b879955efdc0e1065c58235bf7c6077fd1635d2bad8657ec70308
+  data.tar.gz: 11a672cd0b5f2dbd377a0e4684a1a71c090ddb29e4b90b1e938f87c3eac1df638bb22d49570830442af687aa197fa7bfea3fbbf7de453aaa0e008ddd5d1e6345

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    cloudstack_client (1.5.9)
+    cloudstack_client (1.5.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bond (0.5.1)
-    minitest (5.24.1)
-    rake (13.2.1)
+    minitest (5.26.1)
+    rake (13.3.1)
     ripl (0.7.1)
       bond (~> 0.5.1)
-    thor (1.3.1)
+    thor (1.4.0)
 
 PLATFORMS
   x86_64-linux
@@ -24,4 +24,4 @@ DEPENDENCIES
   thor (~> 1.1)
 
 BUNDLED WITH
-   2.3.14
+   2.5.22

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.
@@ -155,6 +170,4 @@ $ gzip data/4.15.json
 
 ## License
 
-Copyright (c) 2014-2021, Nik Wolfgramm
-
 Released under the MIT License. See the [LICENSE](https://raw.github.com/niwo/cloudstack_client/master/LICENSE.txt) file for further details.

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/configuration.rb

@@ -5,7 +5,7 @@ module CloudstackClient
 
     def self.load(configuration)
       file = configuration[:config_file] || Configuration.locate_config_file
-      unless File.exists?(file)
+      unless File.exist?(file)
         raise ConfigurationError, "Configuration file '#{file}' not found."
       end
 
@@ -37,7 +37,7 @@ module CloudstackClient
     def self.locate_config_file
       %w(.cloudstack .cloudstack-cli).each do |file|
         file = File.join(Dir.home, "#{file}.yml")
-        return file if File.exists?(file)
+        return file if File.exist?(file)
       end
       nil
     end

data/lib/cloudstack_client/connection.rb

@@ -35,7 +35,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
@@ -68,12 +68,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 +87,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',
@@ -155,7 +155,10 @@ module CloudstackClient
     end
 
     def escape(input)
-      CGI.escape(input.to_s).gsub('+', '%20').gsub(' ', '%20')
+      CGI.escape(input.to_s)
+        .gsub('+', '%20')
+        .gsub(' ', '%20')
+        .gsub('%2A', '*')
     end
 
     def symbolized_key(name)

data/lib/cloudstack_client/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.5.11
 platform: ruby
 authors:
 - Nik Wolfgramm
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-06 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.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CloudStack API client written in Ruby
 test_files: