cloudstack_client 1.5.8 → 1.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b10551e9d3cb506c024a85a3a4977a29094b5d946a3b4493b8bcb46c71032f59
-  data.tar.gz: c6aea4f1cf7937a8056a4e3701df958a0842af5d3ec0ccf9e079ac887580477f
+  metadata.gz: 2a0a4ca31c3cfcee330c0f72ca9d0fa9895788cfb5718e3499181abdc7564df1
+  data.tar.gz: 688112d58736d2ada94c993f271eda18a923308fc94bcd93bad2775d193506b1
 SHA512:
-  metadata.gz: 4e6a17c1cb607fdb41bbf2fa211da7c38e1e4b5f5b3a7ba8cf7e6165c4abd3c8825fd046c55bd38e7bfca1933a2bd0899f1328fbc43eec77e76d455d65d79b70
-  data.tar.gz: f72b742f2155c93563251bc9c7f4576fda211b4f012915c4a3b99b926cfc3b59175f945a421b2ff6428db87825f02f3b3a320b4dd211f174ae6f39572f551e96
+  metadata.gz: 5d2e11bbf05fa22573de42450b49015bbeabfdf29dfe2ba49701c815bc3e6f0d6f1b35fadc72dca3f3ca8ff803fbe08b37e9320b961050d1e526e1803e45b307
+  data.tar.gz: bd6003fb8f3f82c4a07f548608d927eed95d17a051a0134c2bee061eea6562d9df94caca8c5549a01e0eeccb55ee6f0ec7076140c8d9744c4a2794e8addb3c1a

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.10
-  - 2.5.1
+  - 2.7
+  - 3.0
 before_install:
   - gem update --system
   - gem install bundler

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,7 @@
 # cloudstack_client
 
 [![Gem Version](https://badge.fury.io/rb/cloudstack_client.png)](http://badge.fury.io/rb/cloudstack_client)
- [![Build Status](https://travis-ci.org/niwo/cloudstack_client.svg?branch=master)](https://travis-ci.org/niwo/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.
 
@@ -14,12 +14,14 @@ $ gem install cloudstack_client
 ```
 
 ## Features
-  - Interactive console for playing with the CloudStack API: ```cloudstack_client console```
-  - Dynamically builds API methods based on the listApis function of CloudStack
-  - Command names are converted to match Ruby naming conventions (i.e. ListVirtualMachines becomes list_virtual_machines)
-  - Accepts Ruby Hash arguments passed to commands as options (i.e. list_all: true becomes listall=true)
-  - Makes sure all required arguments are passed
-  - Removes unsupported arguments and arguments with nil values from commands
+
+- Access to the whole CloudStack-API from Ruby
+- Interactive console for playing with the CloudStack API: ```cloudstack_client console```
+- Dynamically builds API methods based on the listApis function of CloudStack
+- Command names are converted to match Ruby naming conventions (i.e. ListVirtualMachines becomes list_virtual_machines)
+- Accepts Ruby Hash arguments passed to commands as options (i.e. list_all: true becomes listall=true)
+- Assure all required arguments are passed
+- Removes unsupported arguments and arguments with nil values from commands
 
 ## Usage
 
@@ -41,7 +43,7 @@ end
 
 ### Advanced Options
 
-*Load API definition file from a alternative path and set the version:*
+Load API definition file from an alternative path and set the version:
 
 ```ruby
 cs = CloudstackClient::Client.new(
@@ -50,26 +52,27 @@ cs = CloudstackClient::Client.new(
   "SECRET_KEY",
   {
     api_path: "~/cloudstack",
-    api_version: "4.9"
+    api_version: "4.15"
   }
 )
 ```
 
-*..or load the API definition directly from a file:*
+...or load the API definition directly from a file:
 
 ```ruby
 cs = CloudstackClient::Client.new(
   "https://cloudstack.local/client/api",
   "API_KEY",
   "API_SECRET",
-  { api_file: "~/cloudstack/4.6.json.gz" }
+  { api_file: "~/cloudstack/4.15.json.gz" }
 )
 ```
 
 ### Using the configuration module
 
-The Configuration module of CloudstackClient make it easy to load CloudStack API settings from configuration files.
-Use it like this:
+The configuration module of CloudstackClient makes it easy to load CloudStack API settings from configuration files.
+
+#### Example
 
 ```ruby
 require "cloudstack_client"
@@ -80,7 +83,9 @@ config = CloudstackClient::Configuration.load
 cs = CloudstackClient::Client.new(config[:url], config[:api_key], config[:secret_key])
 ```
 
-A configuration file supports multiple environments and looks like this:
+#### Configuration files
+
+Configuration files support multiple environments (i.e. `~/.cloudstack.yml`):
 
 ```yaml
 # default environment
@@ -99,11 +104,23 @@ test:
   :secret_key: "cloudstack-api-secret"
 ```
 
+### 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
+}
+cs = CloudstackClient::Client.new(config[:url], config[:api_key], config[:secret_key], options)
+```
+
 ### Interactive Console
 
-cloudstack_client comes with an interactive shell to test the client.
+cloudstack_client comes with an interactive console.
 
-*Example:*
+#### Example
 
 ```bash
 $ cloudstack_client console -e prod
@@ -112,20 +129,21 @@ prod >> list_virtual_machines
 
 ## Development
 
-### Generate/Update API versions
+### Generate or update API definitions
 
-New API configs can be generated using the list_apis command.
+New API definitions can be generated using the `list_apis` command.
 
-*Example:*
+#### Example
 
 ```bash
-# running against an CloudStack 4.5 API endpoint:
-$ cloudstack_client list_apis > data/4.5.json
-$ gzip data/4.5.json
+# running against a CloudStack 4.15 API endpoint:
+$ cloudstack_client list_apis > data/4.15.json
+$ gzip data/4.15.json
 ```
 
 ## References
-- [Apache CloudStack API documentation](http://cloudstack.apache.org/docs/api/)
+
+- [Apache CloudStack API documentation](http://cloudstack.apache.org/api/apidocs-4.15/)
 
 ## Contributing
 
@@ -137,6 +155,6 @@ $ gzip data/4.5.json
 
 ## License
 
-Copyright (c) 2014-2017, Nik Wolfgramm
+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/connection.rb

@@ -9,11 +9,12 @@ module CloudstackClient
   class Connection
     include Utils
 
-    attr_accessor :api_url, :api_key, :secret_key, :verbose, :debug
+    attr_accessor :api_url, :api_key, :secret_key, :verbose, :debug, :symbolize_keys, :host, :read_timeout
     attr_accessor :async_poll_interval, :async_timeout
 
     DEF_POLL_INTERVAL = 2.0
     DEF_ASYNC_TIMEOUT = 400
+    DEF_REQ_TIMEOUT = 60
 
     def initialize(api_url, api_key, secret_key, options = {})
       @api_url = api_url
@@ -21,6 +22,9 @@ module CloudstackClient
       @secret_key = secret_key
       @verbose = options[:quiet] ? false : true
       @debug = options[:debug] ? true : false
+      @symbolize_keys = options[:symbolize_keys] ? true : false
+      @host = options[:host]
+      @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
       @options = options
@@ -44,33 +48,36 @@ module CloudstackClient
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
+      http.read_timeout = @read_timeout
 
       begin
-        response = http.request(Net::HTTP::Get.new(uri.request_uri))
+        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."
       end
 
       begin
-        body = JSON.parse(response.body).values.first
+        body = JSON.parse(response.body, symbolize_names: @symbolize_keys).values.first
       rescue JSON::ParserError
         raise ParseError,
-          "Response from server is not readable. Check if the API endpoint (#{@api_url}) is valid and accessible."
+              "Response from server is not readable. Check if the API endpoint (#{@api_url}) is valid and accessible."
       end
 
       if response.is_a?(Net::HTTPOK)
         return body unless body.respond_to?(:keys)
-        if body.size == 2 && body.key?('count')
-          return body.reject { |key, _| key == 'count' }.values.first
+        if body.size == 2 && body.key?(k('count'))
+          return 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 == 'count' } if body.key?('count')
+          body.reject! { |key, _| key == k('count') } if body.key?(k('count'))
           body.size == 0 ? [] : body
         end
       else
-        message = body['errortext'] rescue body
+        message = body[k('errortext')] rescue body
         raise ApiError, "Status #{response.code}: #{message}."
       end
     end
@@ -85,18 +92,18 @@ module CloudstackClient
 
       params = {
         'command' => 'queryAsyncJobResult',
-        'jobid' => data['jobid']
+        'jobid' => data[k('jobid')]
       }
 
       max_tries.times do
         data = send_request(params)
         print "." if @verbose
 
-        case data['jobstatus']
+        case data[k('jobstatus')]
         when 1
-          return data['jobresult']
+          return data[k('jobresult')]
         when 2
-          raise JobError, "Request failed (#{data['jobresultcode']}): #{data['jobresult']['errortext']}."
+          raise JobError, "Request failed (#{data[k('jobresultcode')]}): #{data[k('jobresult')][k('errortext')]}."
         end
 
         STDOUT.flush if @verbose
@@ -128,7 +135,7 @@ module CloudstackClient
         when Hash # support for maps values of values (Hash values of Hashes)
           value.each_with_index.map do |(k, v), i|
             "#{key}[#{i}].key=#{escape(k)}&" +
-            "#{key}[#{i}].value=#{escape(v)}"
+              "#{key}[#{i}].value=#{escape(v)}"
           end.join("&")
         else
           "#{key}=#{escape(value)}"
@@ -151,5 +158,10 @@ module CloudstackClient
       CGI.escape(input.to_s).gsub('+', '%20').gsub(' ', '%20')
     end
 
+    def symbolized_key(name)
+      @symbolize_keys ? name.to_sym : name
+    end
+    alias_method :k, :symbolized_key
+
   end # class
 end # module

data/lib/cloudstack_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.5.8
+  version: 1.5.9
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: CloudStack API client written in Ruby