cloudstack_client 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbdf827427d6082f13e387fb4ac08e1d3ca53a26
-  data.tar.gz: 62ef06679e1f7cd5ba5e21eb031d7a08902c4b54
+  metadata.gz: a01d5f236a8d9221f700202643596f426c820d0d
+  data.tar.gz: 37cca417cd8bceb6b49a37089fae0564081a6c25
 SHA512:
-  metadata.gz: 1481dfdd002e4d8cca0a286919a38222d29e76e7280050e32169b80daa765ab9a780012ed714f23c5470201d28b23bd15f6240b6b58daa573ab8ab302e21b579
-  data.tar.gz: 76e25246ad5b51bf3666ff36bac2d680c018a2d0e98961ad6ef1171705a44b34b980a691029ee1d6108083180d1c3cbf17e4c73e731ba6a8ab9f8533389433ae
+  metadata.gz: df2b4c3bb08b861705dadbfdcfadd3b1197c45ecbb8d50da1be5fc2427491951117a5df7e10287d0b2305187e7558ba5897ece4d4a07eb2860a0bca5c3713fe5
+  data.tar.gz: 5f0daf52f5d581096662935d9c7fc087a08cc04b36c7bff3615e2cba80be699e0a95912306afd0e8a011f7466025b6ebc8fed6ad5b8f7fa32a2cd78df488c492

data/README.md

@@ -28,6 +28,38 @@ cs.list_virtual_machines(state: "running").each do |server|
 end
 ```
 
+## Features
+
+  - Dynamically builds API methods based on the lisApis function of CloudStack
+  - Command names are converted to match Ruby naming conventions (i.e. ListVirtualMachines becomes list_virtual_machines)
+  - Accepts Ruby style args passed to commands (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
+
+## Development
+
+### Generate new API configs
+
+New API configs can be genearted using the list_apis command.
+
+*Example:*
+
+```bash
+# running against an CloudStack 4.5 API endpoint:
+$ bundle exec bin/cloudstack_client list_apis > config/4.5.msgpack
+```
+
+### Interactive Console
+
+cloudstack_client comes with an interactive shell to test the client.
+
+*Example:*
+
+```bash
+$ bundle exec bin/cloudstack_client console -e prod
+prod >> list_virtual_machines
+```
+
 ## References
 -  [Apache CloudStack API documentation](http://cloudstack.apache.org/docs/api/)
 

data/cloudstack_client.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.rdoc_options  = %w[--line-numbers --inline-source]
 
+  gem.add_dependency('msgpack')
+
   gem.add_development_dependency('rdoc')
   gem.add_development_dependency('rake', '~> 10.0', '>= 10.0.4')
   gem.add_development_dependency('thor')

data/lib/cloudstack_client/api.rb

@@ -1,3 +1,4 @@
+require "msgpack"
 require "json"
 require "ostruct"
 
@@ -9,16 +10,16 @@ module CloudstackClient
     def initialize(options = {})
       if options[:api_file]
         @api_file = options[:api_file]
-        @api_version = File.basename(@api_file, ".json")
+        @api_version = File.basename(@api_file, ".msgpack")
       else
         @api_version = options[:api_version] || DEFAULT_API_VERSION
-        @api_file = File.expand_path("../../../config/#{@api_version}.json", __FILE__)
+        @api_file = File.expand_path("../../../config/#{@api_version}.msgpack", __FILE__)
       end
     end
 
     def commands
       begin
-        api = JSON.parse(IO.read @api_file)
+        api = MessagePack.unpack(IO.read @api_file)
       rescue => e
         raise "Error: Unable to read file '#{@api_file}' : #{e.message}"
       end

data/lib/cloudstack_client/cli.rb

@@ -1,7 +1,20 @@
 require 'cloudstack_client/client'
-require 'thor'
 require 'yaml'
-require 'ripl'
+
+begin
+  require 'thor'
+  require 'ripl'
+rescue LoadError => e
+  missing_gem = if e.message =~ /thor/
+    "thor"
+  elsif e.message =~ /ripl/
+    "ripl"
+  else
+    raise
+  end
+  puts "Please install the #{missing_gem} gem first ('gem install #{missing_gem}')"
+  exit 1
+end
 
 module CloudstackClient
   class Cli < Thor
@@ -27,8 +40,8 @@ module CloudstackClient
     map %w(-v --version) => :version
 
     desc "list_apis", "list api commands using the Cloudstack API Discovery service"
-    option :format, default: 'json',
-      enum: %w(json yaml), desc: "output format"
+    option :format, default: 'msgpack',
+      enum: %w(msgpack json yaml), desc: "output format"
     option :pretty_print, default: true, type: :boolean,
       desc: "pretty print json output"
     option :remove_response, default: true, type: :boolean,
@@ -44,12 +57,15 @@ module CloudstackClient
           command["params"].each {|param| param.delete("description")}
         end
       end
-      output = if options[:format] == "json"
+
+      puts case options[:format]
+      when "json"
         options[:pretty_print] ? JSON.pretty_generate(apis) : data.to_json
-      else
+      when "yaml"
         apis.to_yaml
+      else
+        apis.to_msgpack
       end
-      puts output
     end
 
     desc "console", "Cloudstack Client interactive shell"

data/lib/cloudstack_client/client.rb

@@ -16,7 +16,7 @@ module CloudstackClient
 
     def define_api_methods
       Api.new(api_file: @api_file, api_version: @api_version).commands.each do |command|
-        method_name = underscore(command.name).to_sym
+        method_name = camel_case_to_underscore(command.name).to_sym
 
         define_singleton_method(method_name) do |args = {}, options = {}|
           params = {"command" => command.name}
@@ -28,23 +28,42 @@ module CloudstackClient
             end
           end
 
+          unless all_required_args?(command, params)
+            raise MissingArgumentsError, missing_args_msg(command)
+          end
+
           sync = command.isasync == false || options[:sync]
           sync ? send_request(params) : send_async_request(params)
         end
       end
     end
 
+    def command_supports_key?(command, key)
+      command.params.detect { |p| p["name"] == key }
+    end
+
+    def required_args(command)
+      command.params.map do |param|
+        param["name"] if param["required"] == true
+      end.compact
+    end
+
+    def all_required_args?(command, args)
+      required_args(command).all? {|k| args.key? k}
+    end
+
     private
 
     def normalize_key(key)
       key.to_s.gsub("_", "")
     end
 
-    def command_supports_key?(command, key)
-      command.params.detect { |p| p["name"] == key }
+    def missing_args_msg(command)
+      requ = required_args(command)
+      "#{command.name} requires the following argument#{ 's' if requ.size > 1}: #{requ.join(', ')}"
     end
 
-    def underscore(camel_case)
+    def camel_case_to_underscore(camel_case)
       camel_case.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
         gsub(/([a-z\d])([A-Z])/,'\1_\2').

data/lib/cloudstack_client/error.rb

@@ -6,4 +6,5 @@ module CloudstackClient
   class ApiError < Error; end
   class JobError < Error; end
   class TimeoutError < Error; end
+  class MissingArgumentsError < Error; end
 end

data/lib/cloudstack_client/version.rb

@@ -1,3 +1,3 @@
 module CloudstackClient
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +100,7 @@ files:
 - Rakefile
 - bin/cloudstack_client
 - cloudstack_client.gemspec
-- config/4.2.json
+- config/4.2.msgpack
 - lib/cloudstack_client.rb
 - lib/cloudstack_client/api.rb
 - lib/cloudstack_client/cli.rb