cloudmonkey 1.0.0 → 1.0.1

data/lib/cm.rb

@@ -3,13 +3,26 @@ require 'ostruct'
 require 'open3'
 
 module CloudMonkey
+  # A CloudMonkey client. Requires the cloudmonkey command to be
+  # installed on the system. The client must be synced outside of this
+  # module, or by using the provided sync method, to cache the API
+  # commands available. Once synced, cloudmonkey commands can be
+  # called like Ruby methods using symbolized parameter names in a
+  # hash for the parameters and values.
   class CMClient
     def initialize(params)
       @host = params[:host] || 'localhost'
       @port = params[:port] || 8080
       @apikey = params[:apikey]
       @secretkey = params[:secretkey]
-      @config = params[:config] || File.join("#{Dir.home}", ".cloudmonkey-cmrb")
+
+      @conf_dir = params[:conf_dir] || File.join("#{Dir.home}", ".cloudmonkey-cmrb")
+      Dir.mkdir(@conf_dir) if not Dir.exists?(@conf_dir)
+      
+      @config = params[:config] || File.join(@conf_dir, "config")
+      @cache = File.join(@conf_dir, "cache")
+      @log = File.join(@conf_dir, "log")
+      @history = File.join(@conf_dir, "history")
       @debug = params[:debug] || false
       configure
     end
@@ -21,15 +34,36 @@ module CloudMonkey
 
     # Configure the cloudmonkey client for use with the library.
     def configure
+      # Connection info
       set('host', "#{@host}")
       set('port', "#{@port}")
       set('apikey', "#{@apikey}")
       set('secretkey', "#{@secretkey}")
+
+      # Local Storage Info
+      set('cache_file', @cache)
+      set('log_file', @log)
+      set('history_file', @history)
+
+      # Display options needed to make parsing of responses simple.
       set('display', 'json')
       set('asyncblock', 'false')
       set('color', 'false')
     end
 
+    # Synchronize the API list for cloudmonkey and return true or
+    # false depending on success.
+    def sync
+      execute('sync').has_key?(:message)
+    end
+
+    # Retrieve the cloudmonkey version as a string.
+    def version
+      ver = run_cmd('-v')[:message]
+      # x.y.Z versioning scheme, e.g. 5.1.0
+      /\d+\.\d+\.\d+/.match(ver).to_s
+    end
+
     # Execute a command with cloudmonkey. The command can be
     # multi-word, e.g. "list users". Params, if provided, must be a
     # hash (e.g. :account => "admin"), or a string value (.e.g "help"
@@ -51,7 +85,7 @@ module CloudMonkey
       execute cmd, args[0]
     end    
 
-    private
+    private    
     # Run a cloudmonkey command.
     def run_cmd(input, params = nil)
       input += ' '
@@ -113,7 +147,7 @@ module CloudMonkey
 
     # Handle non-json output. This happens when Cloudmonkey returns an
     # error or if it's just a generic message. Errors are raised as a
-    # runtime exception, while generic message sare put into a hash
+    # runtime exception, while generic messages are put into a hash
     # with a :message property.
     def handle_non_json_output(message)     
       # handle various error messages, otherwise simply return a hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudmonkey
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -20,7 +20,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/cm.rb
-homepage: http://www.greenqloud.com
+homepage: https://github.com/greenqloud/cloudmonkey-ruby
 licenses:
 - Apache
 post_install_message: