cloudstack-cli 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f2298c84a2760737a6a3b3e7b3a8104f3fe383e
-  data.tar.gz: c3eba72da15dd9fbcf61a162dfd723330ceabdee
+  metadata.gz: f42a25136394a7e73e0d22f3a9a0bd83d60a73eb
+  data.tar.gz: 709963bf4063b0554ac1822c5825df8661e18c0a
 SHA512:
-  metadata.gz: 26f8de3dec1b5f9f937cc2dabc8d1b189e43439ccff01e47a504f4fac8b393f97814a49fe7acafa86d5a4b8d2643e7f703e6f97169a4df6ef4453b4d92818765
-  data.tar.gz: 7cc8fa873dc54a6962b9a63b9bb05d36af7c05b69ad349189a24ae29ee369a70ec75ec5309bcdb84c1869ba1a97dab4fd8ce55584d15f5511b8960feab9f8acf
+  metadata.gz: 057b1a7111b838b0a94b08230496a50d0485b5ae36b4ab7b9e024e6e980ac06f7d7e7624623160218043412c3980dba22a260d37460995b86beaea56f259f8f1
+  data.tar.gz: 26a448beb6dcaee8f7512a30f3bd47f71c0681d305db5ec3e09be6f53b43963d9a2ff90f181de88f1e0c233183426975f718a136b7b14e94402ee9db6c94c61a

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.8, release 24.02.2014
+* Added support for bash auto-completion

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cloudstack-cli.gemspec
 gemspec
 
-gem 'cloudstack_client', git: 'git@github.com:niwo/cloudstack_client.git', branch: 'master'
+gem 'cloudstack_client', git: 'git@github.com:niwo/cloudstack_client.git', branch: 'master'
+gem 'thor', git: 'git@github.com:erikhuda/thor.git', branch: 'master'

data/Gemfile.lock

@@ -1,6 +1,13 @@
+GIT
+  remote: git@github.com:erikhuda/thor.git
+  revision: 2c6e4fe957efa63cdd7edc61e3fd166d5e8409f2
+  branch: master
+  specs:
+    thor (0.18.1)
+
 GIT
   remote: git@github.com:niwo/cloudstack_client.git
-  revision: 0421f2e3f58e726099d99d98898f48a6be7183a7
+  revision: 5547d67014571b3818e0a695604207a10c7d6cf4
   branch: master
   specs:
     cloudstack_client (0.4.4)
@@ -8,7 +15,7 @@ GIT
 PATH
   remote: .
   specs:
-    cloudstack-cli (0.7.3)
+    cloudstack-cli (0.7.4)
       cloudstack_client (~> 0.4, >= 0.4.4)
       thor (~> 0.18)
 
@@ -19,7 +26,6 @@ GEM
     rake (10.1.1)
     rdoc (4.1.1)
       json (~> 1.4)
-    thor (0.18.1)
 
 PLATFORMS
   ruby
@@ -29,3 +35,4 @@ DEPENDENCIES
   cloudstack_client!
   rake (~> 10.1)
   rdoc (~> 4.1)
+  thor!

data/README.md

@@ -9,28 +9,49 @@ cloudstack-cli uses the [cloudstack_client](https://github.com/niwo/cloudstack_c
 
 Install the cloudstack-cli gem:
 
-    $ gem install cloudstack-cli
+```sh
+$ gem install cloudstack-cli
+```
 
 ## Setup
 
-Create the initial configuration:
+### Create a cloudstack-cli environmet
 
-    $ cs setup
+Create your first environment, which defines your connection options:
+
+```sh
+$ cs environment add [environment-name]
+```
 
 cloudstack-cli expects to find a configuartion file with the API URL and your CloudStack credentials in your home directory named .cloudstack-cli.yml. If the file is located elsewhere you can specify the loaction using the --config option.
 
 cloudstack-cli supports multiple environments using the --environment option.
 
+see `cs help environment` for more options. 
+
 Example content of the configuration file:
 
-    :url:         "https://my-cloudstack-server/client/api/"
-    :api_key:     "cloudstack-api-key"
-    :secret_key:  "cloudstack-api-secret"
+```yaml
+:url:         "https://my-cloudstack-server/client/api/"
+:api_key:     "cloudstack-api-key"
+:secret_key:  "cloudstack-api-secret"
+
+test:
+    :url:           "http://my-cloudstack-testserver/client/api/"
+    :api_key:       "cloudstack-api-key"
+    :secret_key:    "cloudstack-api-secret"
+```
+
+### Shell tab auto-completion
+
+To enable tab auto-completion for cloudstack-cli, add the following lines to your ~/.bash_profile file.
+
+```sh
+# Bash, ~/.bash_profile
+eval "$(cs completion --shell=bash)"
+```
 
-    test:
-      :url:         "http://my-cloudstack-testserver/client/api/"
-      :api_key:     "cloudstack-api-key"
-      :secret_key:  "cloudstack-api-secret"
+__Note__: use `~/.bashrc` on Ubuntu
 
 ## Usage
 
@@ -38,75 +59,91 @@ For additional documentation find the RubyDoc [here](http://rubydoc.info/gems/cl
 
 See the help screen:
 
-    $ cs
+```sh
+$ cs
+```
 
 ### Example: Bootsrapping a server
 
 Bootsraps a server using a template and creating port-forwarding rules for port 22 and 80.
 
-    $ cs server create server-01 --template CentOS-6.4-x64-v1.4 --zone DC1 --offering 1cpu_1gb --port-rules :22 :80
+```sh
+$ cs server create server-01 --template CentOS-6.4-x64-v1.4 --zone DC1 --offering 1cpu_1gb --port-rules :22 :80
+```
 
 ### Example: Run a any custom API command
 
 Run the "listAlerts" command against the Cloudstack API with an argument of type=8:
 
-    $ cs command listAlerts type=8
+```sh
+$ cs command listAlerts type=8
+```
 
 ### Example: Creating a complete stack of servers
 
 An example stackfile looks like this (my_stackfile.json)
 
-    {
-      "name": "web_stack-a",
-      "description": "Web Application Stack",
-      "version": "1.0",
-      "zone": "DC-BIE-1",
-      "group": "my_web_stack",
-      "keypair": "mykeypair",
-      "servers": [
+```json
+{
+    "name": "web_stack-a",
+    "description": "Web Application Stack",
+    "version": "1.0",
+    "zone": "DC-BIE-1",
+    "group": "my_web_stack",
+    "keypair": "mykeypair",
+    "servers": [
         {
-          "name": "web-d1, web-d2",
-          "description": "Web nodes",
-          "template": "CentOS-6.4-x64-v1.2",
-          "offering": "1cpu_1gb",
-          "networks": "server_network",
-          "port_rules": ":80, :443"
+            "name": "web-d1, web-d2",
+            "description": "Web nodes",
+            "template": "CentOS-6.4-x64-v1.2",
+            "offering": "1cpu_1gb",
+            "networks": "server_network",
+            "port_rules": ":80, :443"
         },
         {
-          "name": "db-01",
-          "description": "PostgreSQL Master",
-          "iso": "CentOS-6.4-x86_64-swisstxt-v15",
-          "disk_offering": "Perf Storage",
-          "disk_size": "5",
-          "offering": "2cpu_4gb",
-          "networks": [
-            "server_network",
-            "storage_network"
-          ]
+            "name": "db-01",
+            "description": "PostgreSQL Master",
+            "iso": "CentOS-6.4-x86_64-swisstxt-v15",
+            "disk_offering": "Perf Storage",
+            "disk_size": "5",
+            "offering": "2cpu_4gb",
+            "networks": [
+                "server_network",
+                "storage_network"
+            ]
         }
-      ]
-    }
+    ]
+}
+```
 
 Create the stack of servers from above:
 
-    $ cs stack create my_stackfile.json
+```sh
+$ cs stack create my_stackfile.json
+```
 
 ### Example: Sort computing offerings
 
 Sort all computing offerings by CPU and Memory grouped my Domain:
 
-    $ cs offering sort
+```sh
+$ cs offering sort
+```
 
 ### Example: Stop all backup routers of a given project
 
 Stop all virtual routers of project Demo (you could filter by zone too):
 (This command is helpful if you have to deploy new versions of Cloudstack when using redundant routers)
 
-    $ cs router list --project Demo --status running --redundant-state BACKUP --command stop
+```sh
+$ cs router list --project Demo --status running --redundant-state BACKUP --command stop
+````
 
 Hint: You can watch the status of the command with watch.
 
-    $ watch -n cs router list --project Demo
+```sh
+$ watch -n cs router list --project Demo
+```
 
 
 ## References

data/completions/cs.bash

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# cloudstack-cli
+# https://github.com/niwo/cloudstack-cli
+#
+# Copyright (c) 2014 Nik Wolfgramm
+# Licensed under the MIT license.
+# https://raw.github.com/niwo/cloudstack-cli/master/LICENSE.txt
+
+# Usage:
+#
+# To enable bash <tab> completion for cloudstack-cli, add the following line (minus the
+# leading #, which is the bash comment character) to your ~/.bash_profile file (use ~/.bashrc on Ubuntu):
+#
+# eval "$(cs completion --shell=bash)"
+
+_cs() {
+  COMPREPLY=()
+  local word="${COMP_WORDS[COMP_CWORD]}"
+  if [ "$COMP_CWORD" -eq 1 ]; then
+    COMPREPLY=( $(compgen -W "$(cs help | grep cs | cut -d ' ' -f4)" -- "$word") )
+  else
+    local words=("${COMP_WORDS[@]}")
+    if [ $(echo ${words[@]} | wc -w) -eq 2 ]; then
+      COMPREPLY=( $(compgen -W "$(${words[@]} help | grep cs | cut -d ' ' -f5)" -- "$word") )
+    fi
+    if [ $(echo ${words[@]} | wc -w) -ge 3 ]; then
+      local cp1=$(echo ${words[@]} | cut -d ' ' -f1-2)
+      local cp2=$(echo ${words[@]} | cut -d ' ' -f3)
+      if [ "$cp2" != "help" ]; then
+        local cp3=$($cp1 help $cp2)
+        COMPREPLY=( $(compgen -W "$(echo $cp3 | awk 'NR>1{print $1}' RS=[ FS='\=')" -- "$word") )
+      fi
+    fi
+  fi
+}
+
+complete -F _cs cs

data/lib/cloudstack-cli/base.rb

@@ -51,6 +51,12 @@ module CloudstackCli
             exit 1
           end
         end
+
+        unless config.key?(:url) && config.key?(:api_key) && config.key?(:secret_key)
+          say "The environment #{env || '\'-\''} contains no valid data.", :red
+          say "Please check with 'cs environment list' and set a valid default environment."
+          exit 1
+        end
         config
       end
 

data/lib/cloudstack-cli/cli.rb

@@ -29,6 +29,20 @@ module CloudstackCli
         :config_file => options[:config_file]
     end
 
+    desc "completion", "loads the shell scripts for tab auto-completion"
+    option :shell, default: 'bash'
+    def completion
+      shell_script = File.join(
+        File.dirname(__FILE__), '..', '..',
+        'completions', "cs.#{options[:shell]}"
+      )
+      unless File.file? shell_script
+        say "Specified cloudstack-cli shell auto-completion rules for #{options[:shell]} not found.", :red
+        exit 1
+      end
+      puts File.read shell_script
+    end
+
     desc "command COMMAND [arg1=val1 arg2=val2...]", "run a custom api command"
     def command(command, *args)
       params = {'command' => command}

data/lib/cloudstack-cli/commands/environment.rb

@@ -4,7 +4,7 @@ class Environment < CloudstackCli::Base
   def list
     config = parse_config_file
     table = [%w(Name URL Default)]
-    table << ['-', config[:url], !config[:default]]
+    table << ['-', config[:url], !config[:default]] if config.key?(:url)
     config.each_key do |key|
       unless key.class == Symbol
         table << [key, config[key][:url], key == config[:default]]
@@ -64,14 +64,26 @@ class Environment < CloudstackCli::Base
   desc "delete", "delete a Cloudstack connection"
   def delete(env)
     config = parse_config_file
-    if config.delete(env)
-      exit unless yes?("Do you really want to delete environment #{env}? [y/N]", :yellow)
-      config.delete :default if config[:default] == env
-      write_config_file(config)
-      say "OK.", :green
+    if env == '-'
+      config.delete(:url)
+      config.delete(:api_key)
+      config.delete(:secret_key)
+      # check if the config file is empty, delete it if true
+      if config.keys.select { |key| !key.is_a? Symbol}.size == 0
+        exit unless yes?("Do you really want to delete environment #{env}? [y/N]", :yellow)
+        File.delete(options[:config_file])
+        say "OK.", :green    
+        exit
+      end
+    elsif config.delete(env)  
     else
       say "Environment #{env} does not exist.", :red
+      exit 1
     end
+    exit unless yes?("Do you really want to delete environment #{env}? [y/N]", :yellow)
+    config.delete :default if config[:default] == env
+    write_config_file(config)
+    say "OK.", :green
   end
 
   desc "default [ENV]", "show or set the default environment"
@@ -84,7 +96,7 @@ class Environment < CloudstackCli::Base
       exit 0
     end
 
-    if env == '-'
+    if env == '-' && config.key?(:url)
       config.delete :default
     else
       unless config.has_key?(env)

data/lib/cloudstack-cli/version.rb

@@ -1,3 +1,3 @@
 module CloudstackCli
-  VERSION = "0.7.4"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,75 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack-cli
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
   name: cloudstack_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4
 description: cloudstack-cli is a CloudStack API command line client written in Ruby.
@@ -80,13 +80,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - bin/cs
 - cloudstack-cli.gemspec
+- completions/cs.bash
 - lib/cloudstack-cli.rb
 - lib/cloudstack-cli/base.rb
 - lib/cloudstack-cli/cli.rb
@@ -128,23 +130,23 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --line-numbers
-- --inline-source
+- "--line-numbers"
+- "--inline-source"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: cloudstack-cli CloudStack API client