cloudstack_helper 0.2 → 0.3

data/README.md

@@ -1,5 +1,5 @@
 # cloudstack_helper
-cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier. With cloudstack_helper, you only have to specify the command the parameters for the request and it will handle everything for you.
+cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier. With cloudstack_helper, you only have to specify the command and the parameters for the request, and it will handle everything for you.
 
 ## Library Usage
 
@@ -18,8 +18,27 @@ cloudstack_helper is a simple ruby library that helps making request to CloudSta
      puts cs_helper.get(params).body
 ```
 
-## Executable Script Usage
+## Script Usage
 ```
-     cloudstack_rb -x listUsers domainid=1
-     cloudstack_rb -x deployVirtualMachine serviceofferingid=12 templateid=4 zoneid=1 displayname=ohyea
+    Usage: cloudstack_rb -c conf -x command param1=value1 param2=value2
+      -x, --execute COMMAND    command to execute. See CloudStack API for list of commands.
+      -c, --conf FILE          YAML config file that stores api and secret key
+      -h, --help               Show this message.
+
+```
+
+####Examples
+```
+    cloudstack_rb -x listUsers domainid=1
+    cloudstack_rb -x listUsers domainid=1 response=json
+    cloudstack_rb -x deployVirtualMachine serviceofferingid=12 templateid=4 zoneid=1 displayname=ohyea
+```
+
+####Configuration
+By default, if you don't specify a config file, cloudstack_rb assumes there is a config file in the current working directory under the name 'cloudstack.yaml'
+The config file should look like this
 ```
+    api_url: "http://mycloudstack:8080/client/api"
+    api_key: "WiUVlx74PpVE8w7z7J7gtojiOQasdaFL3A054D_IPeSxxcm1PadgasdgujGSJBGiS2uBcG0GoLwLisosDCA"
+    secret_key: "uqzgrfMXnYSVvUiasdgj0DgvtXBemILs_npqi90Ki0xigOKjagvQTtYg093EUrHSLZJEnI3lV1z9PrQmv2SxQ"
+````

data/cloudstack_helper.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "cloudstack_helper"
-  s.version     = "0.2"
+  s.version     = "0.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Darren Dao"]
   s.email       = ["darrendao@gmail.com"]

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cloudstack_helper
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Darren Dao