cloudstack_client 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ab2cb39a241bfd4688b632ad5399d0c76a8fe5
-  data.tar.gz: ae9f63f4a8ffc1162e54498fc64df85e3a08c2aa
+  metadata.gz: 2f64a91a71aa5ffe62432e9d5c306288f5814ab8
+  data.tar.gz: 529f9c16b616564a52f9a2abbbc3239a7e990abb
 SHA512:
-  metadata.gz: e306ce18d7185a2419519cd45e09661b280b152aa5e63e6ba6f8fcc72b8ec25d6177b45a0b9bc8dd41af6e983873c2bfa2f4cce1abd774430cc3bfdae9a485cd
-  data.tar.gz: a9909453dea1c17d5652ded8cdb392ef9dfab1baf640a8eb9ca5f1d60a57e90ec988515f7dd4af5f5efea63f7704d0c06b1a8ecaffe96d6d8e25bdf732660639
+  metadata.gz: 4989517ca038f29d621dc07f9956c3e7f30439571e6808a8894f17c0f74f43980cc7d65f8a01668c0124dac995c95aff8cf7b68f858cd9e334dfbee53832497e
+  data.tar.gz: 4fec2c1962dc14e1f6d7d7b58ffab771652c3690c0e2417be447b3dbdcb0880ec326a6897887d96faeac6c9952d000d262478b41597fc38148ab92e9b7a0775b

data/README.md

@@ -13,8 +13,18 @@ Install the cloudstack_client gem:
 $ gem install cloudstack_client
 ```
 
+## 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
+
+
 ## Usage
 
+### Basic usage
+
 ```ruby
 require "cloudstack_client"
 
@@ -29,25 +39,45 @@ cs.list_virtual_machines(state: "running").each do |server|
 end
 ```
 
-## Features
+### Initialize with options
 
-  - 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
+Load API definition file from a alternative path and set the version:
+
+```ruby
+cs = CloudstackClient::Client.new(
+  "https://cloudstack.local/client/api",
+  "API_KEY",
+  "API_SECRET",
+  {
+    api_path: "~/cloudstack",
+    api_version: "4.6"
+  }
+)
+```
+
+..or load the API definition directly from a file:
+
+```ruby
+cs = CloudstackClient::Client.new(
+  "https://cloudstack.local/client/api",
+  "API_KEY",
+  "API_SECRET",
+  { api_file: "~/cloudstack/4.6.json.gz" }
+)
+```
 
 ## Development
 
-### Generate new API configs
+### Generate/Update API versions
 
-New API configs can be genearted using the list_apis command.
+New API configs can be generated using the list_apis command.
 
 *Example:*
 
 ```bash
 # running against an CloudStack 4.5 API endpoint:
-$ cloudstack_client list_apis > config/4.5.msgpack
+$ cloudstack_client list_apis > data/4.5.json
+$ gzip data/4.5.json
 ```
 
 ### Interactive Console

data/cloudstack_client.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('ripl', '~> 0.7.0')
   gem.add_development_dependency('minitest', '~> 5.8.2')
 
-  gem.add_dependency('msgpack', '~> 0.7.0')
+  gem.add_dependency('json', '~> 1.8.3')
 end

data/lib/cloudstack_client/api.rb

@@ -1,35 +1,24 @@
-require "msgpack"
+require "zlib"
 
 module CloudstackClient
   class Api
 
     DEFAULT_API_VERSION = "4.5"
+    API_PATH = File.expand_path("../../../data/", __FILE__)
 
     attr_reader :commands
-    attr_reader :api_version
+    attr_reader :api_version, :api_file, :api_path
 
-    def self.versions
-      Dir["#{self.config_path}/*.msgpack"].map do |path|
-        File.basename(path, ".msgpack")
+    def self.versions(api_path = API_PATH)
+      Dir[api_path + "/*.json.gz"].map do |path|
+        File.basename(path, ".json.gz")
       end
     end
 
-    def self.config_path
-      File.expand_path("../../../config/", __FILE__)
-    end
-
     def initialize(options = {})
-      if options[:api_file]
-        @api_file = options[:api_file]
-        @api_version = File.basename(@api_file, ".msgpack")
-      else
-        @api_version = options[:api_version] || DEFAULT_API_VERSION
-        unless Api.versions.include? @api_version
-          raise "API definition not found for #{@api_version}"
-        end
-        @api_file = File.join(Api.config_path, "#{@api_version}.msgpack")
-      end
-      @commands = load_commands
+      set_api_path(options)
+      set_api_version_and_file(options)
+      load_commands
     end
 
     def command_supported?(command)
@@ -37,7 +26,11 @@ module CloudstackClient
     end
 
     def command_supports_param?(command, key)
-      @commands[command]["params"].detect { |p| p["name"] == key } ? true : false
+      if @commands[command]["params"].detect { |p| p["name"] == key }
+        true
+      else
+        false
+      end
     end
 
     def required_params(command)
@@ -51,21 +44,52 @@ module CloudstackClient
     end
 
     def missing_params_msg(command)
-      requ = required_params(command)
-      "#{command} requires the following parameter#{ 's' if requ.size > 1}: #{requ.join(', ')}"
+      "#{command} requires the following parameter" +
+        "#{ 's' if required_params(command).size > 1 }: " +
+        required_params(command).join(", ")
     end
 
     private
 
-    def load_commands
-      begin
-        api = MessagePack.unpack(IO.read @api_file)
-      rescue => e
-        raise "Error: Unable to read file '#{@api_file}' : #{e.message}"
+    def set_api_version_and_file(options)
+      if options[:api_file]
+        @api_file = options[:api_file]
+        @api_version = File.basename(@api_file, ".json.gz")
+      else
+        set_api_version(options)
+        @api_file = File.join(@api_path, "#{@api_version}.json.gz")
+      end
+    end
+
+    def set_api_path(options)
+      @api_path = if options[:api_path]
+        File.expand_path(options[:api_path])
+      else
+        API_PATH
+      end
+    end
+
+    def set_api_version(options)
+      @api_version = options[:api_version] || DEFAULT_API_VERSION
+      unless Api.versions(@api_path).include? @api_version
+        if options[:api_version]
+          raise "API definition not found for version '#{@api_version}' in api_path '#{@api_path}'"
+        elsif Api.versions(@api_path).size < 1
+          raise "no API file available in api_path '#{@api_path}'"
+        else
+          @api_version = Api.versions(@api_path).last
+        end
       end
-      commands = Hash.new
-      api.each { |command| commands[command["name"]] = command }
-      commands
+      @api_version
+    end
+
+    def load_commands
+      @commands = {}
+      Zlib::GzipReader.open(@api_file) do |gz|
+        JSON.parse(gz.read)
+      end.each {|cmd| @commands[cmd["name"]] = cmd }
+    rescue => e
+      raise "Error: Unable to read file '#{@api_file}': #{e.message}"
     end
 
   end

data/lib/cloudstack_client/cli.rb

@@ -1,5 +1,7 @@
 require "cloudstack_client/client"
 require "yaml"
+require "json"
+require 'pp'
 
 begin
   require "thor"
@@ -40,8 +42,8 @@ module CloudstackClient
     map %w(-v --version) => :version
 
     desc "list_apis", "list api commands using the Cloudstack API Discovery service"
-    option :format, default: 'msgpack',
-      enum: %w(msgpack json yaml), desc: "output format"
+    option :format, default: 'json',
+      enum: %w(json yaml), desc: "output format"
     option :pretty_print, default: true, type: :boolean,
       desc: "pretty print json output"
     option :remove_response, default: true, type: :boolean,
@@ -59,12 +61,10 @@ module CloudstackClient
       end
 
       print case options[:format]
-      when "json"
-        options[:pretty_print] ? JSON.pretty_generate(apis) : apis.to_json
       when "yaml"
         apis.to_yaml
       else
-        apis.to_msgpack
+        options[:pretty_print] ? JSON.pretty_generate(apis) : apis.to_json
       end
     end
 
@@ -84,7 +84,7 @@ module CloudstackClient
       ARGV.clear
       env = options[:env] ? options[:env] : load_configuration.last
       Ripl.config[:prompt] = "#{env} >> "
-      Ripl.start binding: cs_client.instance_eval('binding')
+      Ripl.start binding: cs_client.instance_eval{ binding }
     end
 
     no_commands do

data/lib/cloudstack_client/version.rb

@@ -1,3 +1,3 @@
 module CloudstackClient
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/test/api_test.rb

@@ -5,12 +5,36 @@ describe CloudstackClient::Api do
     @api = CloudstackClient::Api.new
   end
 
+  describe "when the API is initialized" do
+    it "has to find the default version in available versions" do
+      CloudstackClient::Api.versions.include?(
+        CloudstackClient::Api::DEFAULT_API_VERSION
+      ).must_equal true
+    end
+
+    it "must raise exception for unavailable version" do
+      proc { CloudstackClient::Api.new(api_version: "0.0") }.must_raise RuntimeError
+    end
+
+    it "must set correct version of fake api file" do
+      CloudstackClient::Api.new(
+        api_file: "#{File.expand_path File.dirname(__FILE__)}/data/0.42.json.gz"
+      ).api_version.must_equal "0.42"
+    end
+
+    it "must set correct api file of fake api when loaded with api_version option" do
+      CloudstackClient::Api.new(
+        api_path: "#{File.expand_path File.dirname(__FILE__)}/data/",
+      ).api_file.must_equal "#{File.expand_path File.dirname(__FILE__)}/data/0.42.json.gz"
+    end
+  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
+    it "must have a key named 'listDomains'" do
       @api.commands.has_key?('listDomains').must_equal true
     end
 

data/test/benchmark.rb

@@ -22,10 +22,8 @@ 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
-)
+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/data/0.42.json

@@ -0,0 +1,15 @@
+[
+  {
+    "name": "noCommand",
+    "isasync": true,
+    "related": "nilCommand",
+    "params": [
+      {
+        "name": "noparam",
+        "type": "string",
+        "length": 255,
+        "required": true
+      }
+    ]
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -81,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.8.2
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.8.3
 description: CloudStack API client written in Ruby
 email:
 - nik.wolfgramm@gmail.com
@@ -110,8 +110,7 @@ files:
 - Rakefile
 - bin/cloudstack_client
 - cloudstack_client.gemspec
-- config/4.2.msgpack
-- config/4.5.msgpack
+- data/4.5.json.gz
 - lib/cloudstack_client.rb
 - lib/cloudstack_client/api.rb
 - lib/cloudstack_client/cli.rb
@@ -123,6 +122,8 @@ files:
 - test/api_test.rb
 - test/benchmark.rb
 - test/client_test.rb
+- test/data/0.42.json
+- test/data/0.42.json.gz
 - test/test_helper.rb
 homepage: https://github.com/niwo/cloudstack_client
 licenses:
@@ -154,4 +155,6 @@ test_files:
 - test/api_test.rb
 - test/benchmark.rb
 - test/client_test.rb
+- test/data/0.42.json
+- test/data/0.42.json.gz
 - test/test_helper.rb