cloudstack_client 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6127adfd7dadcb64018f35d332657b3bc1337249
-  data.tar.gz: 400f596034466b1efc5f406646f26b0cc1a2846a
+  metadata.gz: c717a0dab3ed2016549deae5d529b9da29b1f083
+  data.tar.gz: 13c959b12cbc809503910b5bfd97e910ab166946
 SHA512:
-  metadata.gz: f4edc4749533a536be14b1b8c718abd47144ebba52a6bc9f737901cf32a94723394da94328680b6c1206857690ef7921ab6bf0403f3c9a45de155971ddef29e1
-  data.tar.gz: 51a48c6e1934569891e42fa012645d831ebac09fbf397b89f1191371370355fcea9cfb7c91b9491d1e2e6da6c930770a7fc8246c49445182d01150cdc4d997e0
+  metadata.gz: c22640516a49e62f7346de350219097d9f155789435d9928b09c50c52e80bbf40584a42c3407516ca37a489862335657df6625214c18d857c459f30f846264a3
+  data.tar.gz: 61e750a05e16187411fb5b26bf26e5f363a5b2728f0442ccb4aa5b73a663f6465d084fd3320efdf038764852f5a982e9d11ad01f59721609df9c179ec031cbb6

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/README.md

@@ -1,6 +1,7 @@
 # cloudstack_client
 
 [![Gem Version](https://badge.fury.io/rb/cloudstack_client.png)](http://badge.fury.io/rb/cloudstack_client)
+ [![Build Status](https://travis-ci.org/niwo/cloudstack_client.svg?branch=master)](https://travis-ci.org/niwo/cloudstack_client)
 
 A CloudStack API client written in Ruby.
 

data/Rakefile

@@ -1,2 +1,12 @@
-require 'bundler'  
-Bundler::GemHelper.install_tasks
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run Tests"
+task default: :test

data/cloudstack_client.gemspec

@@ -20,10 +20,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.rdoc_options  = %w[--line-numbers --inline-source]
 
-  gem.add_dependency('msgpack', '~> 0.5.11')
-
   gem.add_development_dependency('rdoc', '~> 4.2.0')
   gem.add_development_dependency('rake', '~> 10.4.2')
   gem.add_development_dependency('thor', '~> 0.19.1')
   gem.add_development_dependency('ripl', '~> 0.7.0')
+  gem.add_development_dependency('minitest', '~> 5.6.1')
+
+  gem.add_dependency('msgpack', '~> 0.5.11')
 end

data/lib/cloudstack_client/api.rb

@@ -1,6 +1,4 @@
 require "msgpack"
-require "json"
-require "ostruct"
 
 module CloudstackClient
   class Api
@@ -20,22 +18,22 @@ module CloudstackClient
       @commands = load_commands
     end
 
+    def command_supported?(command)
+      @commands.has_key? command
+    end
+
     def command_supports_param?(command, key)
-      commands[command].params.detect { |p| p["name"] == key }
+      @commands[command]["params"].detect { |p| p["name"] == key } ? true : false
     end
 
     def required_params(command)
-      commands[command].params.map do |param|
+      @commands[command]["params"].map do |param|
         param["name"] if param["required"] == true
       end.compact
     end
 
     def all_required_params?(command, args)
-      required_params(command).all? {|k| args.key? k}
-    end
-
-    def normalize_key(key)
-      key.to_s.gsub("_", "")
+      required_params(command).all? { |k| args.key? k }
     end
 
     def missing_params_msg(command)
@@ -51,11 +49,8 @@ module CloudstackClient
       rescue => e
         raise "Error: Unable to read file '#{@api_file}' : #{e.message}"
       end
-      @command_map
       commands = Hash.new
-      api["api"].each do |command|
-        commands[command["name"]] = OpenStruct.new command
-      end
+      api.each { |command| commands[command["name"]] = command }
       commands
     end
 

data/lib/cloudstack_client/cli.rb

@@ -49,7 +49,7 @@ module CloudstackClient
     option :remove_description, default: true, type: :boolean,
       desc: "remove description sections"
     def list_apis
-      apis = client.send_request('command' => 'listApis')
+      apis = client(no_api_methods: true).send_request('command' => 'listApis')
       apis.each do |command|
         command.delete("response") if options[:remove_response]
         if options[:remove_description]
@@ -58,9 +58,9 @@ module CloudstackClient
         end
       end
 
-      puts case options[:format]
+      print case options[:format]
       when "json"
-        options[:pretty_print] ? JSON.pretty_generate(apis) : data.to_json
+        options[:pretty_print] ? JSON.pretty_generate(apis) : apis.to_json
       when "yaml"
         apis.to_yaml
       else
@@ -84,14 +84,15 @@ module CloudstackClient
         @client ||= CloudstackClient::Client.new(
           @config[:url],
           @config[:api_key],
-          @config[:secret_key]
+          @config[:secret_key],
+          opts
         )
       end
 
       def load_configuration(config_file = options[:config_file], env = options[:env])
         unless File.exists?(config_file)
           say "Configuration file #{config_file} not found.", :red
-          say "Please run \'cloudstack-cli environment add\' to create one."
+          say "Please run 'cloudstack-cli environment add' to create one."
           exit 1
         end
 
@@ -102,8 +103,7 @@ module CloudstackClient
           exit 1
         end
 
-        env ||= config[:default]
-        if env
+        if env ||= config[:default]
           unless config = config[env]
             say "Can't find environment #{env}.", :red
             exit 1

data/lib/cloudstack_client/client.rb

@@ -17,24 +17,27 @@ module CloudstackClient
     def define_api_methods
       @api = Api.new(@options)
       @api.commands.each do |name, command|
-        method_name = camel_case_to_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}
+          params = { "command" => command["name"] }
 
           args.each do |k, v|
-            k = @api.normalize_key(k)
-            if v != nil && @api.command_supports_param?(command.name, k)
+            k = k.to_s.gsub("_", "")
+            if v && @api.command_supports_param?(command["name"], k)
               params[k] = v
             end
           end
 
-          unless @api.all_required_params?(command.name, params)
-            raise ParameterError, @api.missing_params_msg(command.name)
+          unless @api.all_required_params?(command["name"], params)
+            raise ParameterError, @api.missing_params_msg(command["name"])
           end
 
-          sync = command.isasync == false || options[:sync]
-          sync ? send_request(params) : send_async_request(params)
+          if command["isasync"] == false || options[:sync]
+            send_request(params)
+          else
+            send_async_request(params)
+          end
         end
       end
     end

data/lib/cloudstack_client/version.rb

@@ -1,3 +1,3 @@
 module CloudstackClient
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test/api_test.rb

@@ -0,0 +1,76 @@
+require "test_helper"
+
+describe CloudstackClient::Api do
+  before do
+    @api = CloudstackClient::Api.new
+  end
+
+  describe "when commands are accessed" do
+    it "must return a Hash" do
+      @api.commands.class.must_equal Hash
+    end
+
+    it "the Hash must have a key named 'listDomains'" do
+      @api.commands.has_key?('listDomains').must_equal true
+    end
+
+    it "the 'listDomains' element must  contain the correct 'name' value" do
+      @api.commands['listDomains']['name'].must_equal "listDomains"
+    end
+
+    it "the 'listDomains' element must  contain 'params'" do
+      @api.commands['listDomains'].has_key?('params').must_equal true
+    end
+  end
+
+  describe "when asked about supported commands" do
+    it "must respond positively for 'listVirtualMachines'" do
+      @api.command_supported?('listVirtualMachines').must_equal true
+    end
+
+    it "must respond positively for 'createUser'" do
+      @api.command_supported?('createUser').must_equal true
+    end
+
+    it "must respond netagively for 'listClowns'" do
+      @api.command_supported?('listClowns').must_equal false
+    end
+  end
+
+  describe "when asked about supported params" do
+    it "must respond positively for 'listVirtualMachines' and param 'name'" do
+      @api.command_supports_param?('listVirtualMachines', 'name').must_equal true
+    end
+
+    it "must respond netagively for 'listVirtualMachines' and param 'hotdog'" do
+      @api.command_supports_param?('listVirtualMachines', 'hotdog').must_equal false
+    end
+  end
+
+  describe "when asked about required params" do
+    it "must respond with correct Array for 'createUser'" do
+      params = %w(account email firstname lastname password username)
+      @api.required_params('createUser').sort.must_equal params.sort
+    end
+  end
+
+  describe "when asked about all required params" do
+    it "must respond positively for 'createUser' and params 'account, email, firtsname, lastname, password, username'" do
+      params = {
+        "account"   => "Master",
+        "email"     => "me@me.com",
+        "firstname" => "Me",
+        "lastname"  => "Me",
+        "password"  => "secret",
+        "username"  => "meme",
+        "domainid"  => "1"
+      }
+      @api.all_required_params?('createUser', params).must_equal true
+    end
+
+    it "must respond netagively for 'createUser' and params 'username'" do
+      @api.all_required_params?('createUser', { "username" => "meme" }).must_equal false
+    end
+  end
+
+end

data/test/benchmark.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require "cloudstack_client/api"
+require "benchmark"
+require "json"
+
+GC.disable
+
+memory_before = `ps -o rss= -p #{Process.pid}`.to_i/1024
+gc_stat_before = GC.stat
+
+time = Benchmark.realtime do
+  100.times do
+    api = CloudstackClient::Api.new
+    command = "listVirtualMachines"
+    api.command_supports_param?(command, "id")
+    api.required_params(command)
+    api.all_required_params?("deployVirtualMachine", { name: "test", templateid: 1 })
+  end
+end
+
+gc_stat_after = GC.stat
+memory_after = `ps -o rss= -p #{Process.pid}`.to_i/1024
+
+puts(
+  {
+    time: time.round(2),
+    gc_count: gc_stat_after[:count] - gc_stat_before[:count],
+    memory: "%dM" % (memory_after - memory_before)
+  }.to_json
+)

data/test/client_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+describe CloudstackClient::Client do
+  before do
+    @client = CloudstackClient::Client.new(
+      "https://cloudstack.api/client/api",
+      "test-key",
+      "test-secret"
+    )
+  end
+
+  describe "when the client is instantiated" do
+    it "must respond_to 'list_virtual_machines'" do
+      @client.respond_to?(:list_virtual_machines).must_equal true
+    end
+
+    it "must respond_to 'deploy_virtual_machine'" do
+      @client.respond_to?(:deploy_virtual_machine).must_equal true
+    end
+
+    it "must respond_to 'create_user'" do
+      @client.respond_to?(:create_user).must_equal true
+    end
+
+    it "must not be in debug mode" do
+      @client.debug.must_equal false
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "cloudstack_client"
+
+require "minitest/spec"
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: msgpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.11
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.11
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.1
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.11
 description: CloudStack API client written in Ruby
 email:
 - nik.wolfgramm@gmail.com
@@ -89,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,6 +119,10 @@ files:
 - lib/cloudstack_client/error.rb
 - lib/cloudstack_client/utils.rb
 - lib/cloudstack_client/version.rb
+- test/api_test.rb
+- test/benchmark.rb
+- test/client_test.rb
+- test/test_helper.rb
 homepage: https://github.com/niwo/cloudstack_client
 licenses:
 - MIT
@@ -130,4 +149,8 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: CloudStack API client written in Ruby
-test_files: []
+test_files:
+- test/api_test.rb
+- test/benchmark.rb
+- test/client_test.rb
+- test/test_helper.rb