cloudstack_client 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1821ae743081017bcc2364d49c2143aa32232fe
-  data.tar.gz: fc7ecb150733a64483c8b140c17d0193c562e5d2
+  metadata.gz: 689edb1f1411766d7a826b67539d9d68a4f05602
+  data.tar.gz: 581a43d3b56a7ae35c9cce4bf5fa1d341dc4fe4f
 SHA512:
-  metadata.gz: 771a583ce86206fbce47659de1c78cacab3a3512340fa603d8ce3291cf1b685502e2075d7adf2df76bfdccd5b9318ee0a7cd7809c19ad88d9c9db32e5cc5a6a3
-  data.tar.gz: 779249793d7cfc062b72b767f69c0f26ed7ebae87d18287ef629e1c836c3b4888e202ebe32554305513d98bb1cbda1108fbaa2d0f193c4f2a5298f5af31c7d30
+  metadata.gz: 44f316e9813d7aac565bcad2984dafb11e8a34d8b6b8218fd1b6dd3ebf94c0f2d6a5fb8abab13e300ea99792c2bab6ac90517f37ece64460754b4379b9b96d7a
+  data.tar.gz: 50ade51230f8f45bdca2c4257c1c0e70e14ec5cda55a078f49c387a66b55079dddbb899ba60a582544b0c9ad45893ef5bc7566e947a2562d8b8b4c595de5cd4a

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    cloudstack_client (1.5.0)
+    cloudstack_client (1.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bond (0.5.1)
-    minitest (5.10.1)
+    minitest (5.10.2)
     rake (12.0.0)
     ripl (0.7.1)
       bond (~> 0.5.1)
@@ -18,7 +18,7 @@ PLATFORMS
 
 DEPENDENCIES
   cloudstack_client!
-  minitest (~> 5.9)
+  minitest (~> 5.10)
   rake (~> 12.0)
   ripl (~> 0.7)
   thor (~> 0.19)

data/README.md

@@ -34,12 +34,12 @@ cs = CloudstackClient::Client.new(
   "SECRET_KEY"
 )
 
-cs.list_virtual_machines(state: "running").each do |server|
-  puts server["name"]
+cs.list_virtual_machines(state: "running").each do |vm|
+  puts vm["name"]
 end
 ```
 
-### Initialize with options
+### Advanced Options
 
 *Load API definition file from a alternative path and set the version:*
 
@@ -50,7 +50,7 @@ cs = CloudstackClient::Client.new(
   "SECRET_KEY",
   {
     api_path: "~/cloudstack",
-    api_version: "4.6"
+    api_version: "4.9"
   }
 )
 ```
@@ -66,6 +66,39 @@ cs = CloudstackClient::Client.new(
 )
 ```
 
+### Using the configuration module
+
+The Configuration module of CloudstackClient make it easy to load CloudStack API settings from configuration files.
+Use it like this:
+
+```ruby
+require "cloudstack_client"
+require "cloudstack_client/configuration"
+
+# looks for ~/.cloudstack.yml per default
+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:
+
+```yaml
+# default environment
+:default: production
+
+# production environment
+production:
+  :url: "https://my-cloudstack-server/client/api/"
+  :api_key: "cloudstack-api-key"
+  :secret_key: "cloudstack-api-secret"
+
+# test environment
+test:
+  :url: "http://my-cloudstack-testserver/client/api/"
+  :api_key: "cloudstack-api-key"
+  :secret_key: "cloudstack-api-secret"
+```
+
 ### Interactive Console
 
 cloudstack_client comes with an interactive shell to test the client.

data/cloudstack_client.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rake', '~> 12.0')
   gem.add_development_dependency('thor', '~> 0.19')
   gem.add_development_dependency('ripl', '~> 0.7')
-  gem.add_development_dependency('minitest', '~> 5.9')
+  gem.add_development_dependency('minitest', '~> 5.10')
 end

data/lib/cloudstack_client/cli.rb

@@ -7,15 +7,13 @@ begin
   require "thor"
   require "ripl"
 rescue LoadError => e
-  missing_gem = if e.message =~ /thor/
-    "thor"
-  elsif e.message =~ /ripl/
-    "ripl"
-  else
-    raise
+  %w(thor ripl).each do |gem|
+    if e.message =~ /#{gem}/
+      puts "Please install the #{gem} gem first ('gem install #{gem}')."
+      exit 1
+    end
   end
-  puts "Please install the #{missing_gem} gem first ('gem install #{missing_gem}')."
-  exit 1
+  raise e.message
 end
 
 module CloudstackClient
@@ -23,7 +21,7 @@ module CloudstackClient
     include Thor::Actions
 
     class_option :config_file,
-      default: File.join(Dir.home, '.cloudstack-cli.yml'),
+      default: Configuration.locate_config_file,
       aliases: '-c',
       desc: 'location of your cloudstack-cli configuration file'
 
@@ -89,7 +87,7 @@ module CloudstackClient
       desc: 'specify a custom API definition file'
     option :pretty_print,
       desc: 'pretty client output',
-      type: :numeric,
+      type: :boolean,
       default: true
     def console
       cs_client = client(options)

data/lib/cloudstack_client/configuration.rb

@@ -2,32 +2,45 @@ module CloudstackClient
   require "yaml"
 
   module Configuration
+
     def self.load(configuration)
-      unless File.exists?(configuration[:config_file])
-        message = "Configuration file '#{configuration[:config_file]}' not found."
-        raise message
+      file = configuration[:config_file] || Configuration.locate_config_file
+      unless File.exists?(file)
+        raise ConfigurationError, "Configuration file '#{file}' not found."
       end
+
       begin
-        config = YAML::load(IO.read(configuration[:config_file]))
+        config = YAML::load(IO.read file)
       rescue => e
-        message = "Can't load configuration from file '#{configuration[:config_file]}'."
-        message += "Message: #{e.message}" if configuration[:debug]
-        message += "Backtrace:\n\t#{e.backtrace.join("\n\t")}" if configuration[:debug]
+        message = "Can't load configuration from file '#{file}'."
+        if configuration[:debug]
+          message += "\nMessage: #{e.message}"
+          message += "\nBacktrace:\n\t#{e.backtrace.join("\n\t")}"
+        end
         raise message
       end
 
-      env ||= config[:default]
-      if env
+      if env ||= config[:default]
         unless config = config[env]
-          raise "Can't find environment #{env}."
+          raise ConfigurationError, "Can't find environment #{env}."
         end
       end
 
       unless config.key?(:url) && config.key?(:api_key) && config.key?(:secret_key)
         message = "The environment #{env || '\'-\''} does not contain all required keys."
-        raise message
+        raise ConfigurationError, message
       end
+
       config.merge(environment: env)
     end
+
+    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)
+      end
+      nil
+    end
+
   end
 end

data/lib/cloudstack_client/error.rb

@@ -2,6 +2,7 @@ module CloudstackClient
   class Error < StandardError; end
   class ParameterError < Error; end
   class ConnectionError < Error; end
+  class ConfigurationError < Error; end
   class ParseError < Error; end
   class ApiError < Error; end
   class JobError < Error; end

data/lib/cloudstack_client/version.rb

@@ -1,3 +1,3 @@
 module CloudstackClient
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/test/configuration_test.rb

@@ -5,11 +5,11 @@ describe CloudstackClient::Configuration do
 
   before do
     @config1 = CloudstackClient::Configuration.load({
-      config_file: "#{File.expand_path File.dirname(__FILE__)}/data/cloudstack-cli-1.yml",
+      config_file: "#{File.expand_path File.dirname(__FILE__)}/data/cloudstack-1.yml",
       debug: true
     })
     @config2 = CloudstackClient::Configuration.load({
-      config_file: "#{File.expand_path File.dirname(__FILE__)}/data/cloudstack-cli-2.yml",
+      config_file: "#{File.expand_path File.dirname(__FILE__)}/data/cloudstack-2.yml",
       debug: true
     })
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.10'
 description: CloudStack API client written in Ruby
 email:
 - nik.wolfgramm@gmail.com
@@ -99,8 +99,8 @@ files:
 - test/configuration_test.rb
 - test/data/0.42.json
 - test/data/0.42.json.gz
-- test/data/cloudstack-cli-1.yml
-- test/data/cloudstack-cli-2.yml
+- test/data/cloudstack-1.yml
+- test/data/cloudstack-2.yml
 - test/test_helper.rb
 homepage: https://github.com/niwo/cloudstack_client
 licenses:
@@ -135,6 +135,6 @@ test_files:
 - test/configuration_test.rb
 - test/data/0.42.json
 - test/data/0.42.json.gz
-- test/data/cloudstack-cli-1.yml
-- test/data/cloudstack-cli-2.yml
+- test/data/cloudstack-1.yml
+- test/data/cloudstack-2.yml
 - test/test_helper.rb