cloudstack_client 0.9.7 → 1.0.0.rc1

data/lib/cloudstack_client/api.rb

@@ -0,0 +1,29 @@
+require "json"
+require "ostruct"
+
+module CloudstackClient
+  class Api
+
+    DEFAULT_API_VERSION = "4.2"
+
+    def initialize(options = {})
+      if options[:api_file]
+        @api_file = options[:api_file]
+        @api_version = File.basename(@api_file, ".json")
+      else
+        @api_version = options[:api_version] || DEFAULT_API_VERSION
+        @api_file = File.expand_path("../../../config/#{@api_version}.json", __FILE__)
+      end
+    end
+
+    def commands
+      begin
+        api = JSON.parse(IO.read @api_file)
+      rescue => e
+        raise "Error: Unable to read file '#{@api_file}' : #{e.message}"
+      end
+      api["api"].map {|command| OpenStruct.new command }
+    end
+
+  end
+end

data/lib/cloudstack_client/cli.rb

@@ -0,0 +1,107 @@
+require 'cloudstack_client/client'
+require 'thor'
+require 'yaml'
+require 'ripl'
+
+module CloudstackClient
+  class Cli < Thor
+    include Thor::Actions
+
+    class_option :config_file,
+      default: File.join(Dir.home, '.cloudstack-cli.yml'),
+      aliases: '-c',
+      desc: 'location of your cloudstack-cli configuration file'
+
+    class_option :env,
+      aliases: '-e',
+      desc: 'environment to use'
+
+    class_option :debug,
+      desc: 'enable debug output',
+      type: :boolean
+
+    desc "version", "Print cloudstack_client version number"
+    def version
+      say "cloudstack_client version #{CloudstackClient::VERSION}"
+    end
+    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 :pretty_print, default: true, type: :boolean,
+      desc: "pretty print json output"
+    option :remove_response, default: true, type: :boolean,
+      desc: "remove response sections"
+    option :remove_description, default: true, type: :boolean,
+      desc: "remove description sections"
+    def list_apis
+      apis = client.send_request('command' => 'listApis')
+      apis.each do |command|
+        command.delete("response") if options[:remove_response]
+        if options[:remove_description]
+          command.delete("description")
+          command["params"].each {|param| param.delete("description")}
+        end
+      end
+      output = if options[:format] == "json"
+        options[:pretty_print] ? JSON.pretty_generate(apis) : data.to_json
+      else
+        apis.to_yaml
+      end
+      puts output
+    end
+
+    desc "console", "Cloudstack Client interactive shell"
+    def console
+      puts "cloudstack_client version #{CloudstackClient::VERSION}"
+      puts '  try: list_virtual_machines state: "Started"'
+      ARGV.clear
+      env = options[:env] ? options[:env] : load_configuration.last
+      Ripl.config[:prompt] = "#{env} >> "
+      Ripl.start binding: client.instance_eval('binding')
+    end
+
+    no_commands do
+      def client(opts = {})
+        @config ||= load_configuration.first
+        @client ||= CloudstackClient::Client.new(
+          @config[:url],
+          @config[:api_key],
+          @config[:secret_key]
+        )
+      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."
+          exit 1
+        end
+
+        begin
+          config = YAML::load(IO.read(config_file))
+        rescue
+          say "Can't load configuration from file #{config_file}.", :red
+          exit 1
+        end
+
+        env ||= config[:default]
+        if env
+          unless config = config[env]
+            say "Can't find environment #{env}.", :red
+            exit 1
+          end
+        end
+
+        unless config.key?(:url) && config.key?(:api_key) && config.key?(:secret_key)
+          say "The environment #{env || '\'-\''} contains no valid data.", :red
+          exit 1
+        end
+        return config, env
+      end
+
+    end # no_commands
+
+	end # class
+end # module

data/lib/cloudstack_client/client.rb

@@ -1,147 +1,54 @@
-require 'base64'
-require 'openssl'
-require 'uri'
-require 'cgi'
-require 'net/http'
-require 'net/https'
-require 'json'
-require 'yaml'
+require "cloudstack_client/api"
+require "cloudstack_client/error"
+require "cloudstack_client/connection"
 
 module CloudstackClient
-  class Connection
+  class Client < Connection
 
-    @@async_poll_interval = 2.0
-    @@async_timeout = 400
+    attr_accessor :api_version, :api_path
 
-    # include all commands
-    Dir.glob(File.dirname(__FILE__) + "/commands/*.rb").each do |file|
-      require file
-      module_name = File.basename(file, '.rb').split('_').map{|f| f.capitalize}.join
-      include Object.const_get("CloudstackClient").const_get(module_name)
+    def initialize(api_url, api_key, secret_key, options = {})
+      super(api_url, api_key, secret_key, options = {})
+      @api_version = options[:api_version] if options[:api_version]
+      @api_file = options[:api_file] if options[:api_file]
+      define_api_methods unless options[:no_api_methods]
     end
 
-    attr_accessor :verbose
-    attr_accessor :debug
+    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
 
-    def initialize(api_url, api_key, secret_key, opts = {})
-      @api_url = api_url
-      @api_key = api_key
-      @secret_key = secret_key
-      @verbose = opts[:quiet] ? false : true
-      @debug = opts[:debug] ? true : false
-    end
-
-    ##
-    # Sends a synchronous request to the CloudStack API and returns the response as a Hash.
-    #
-    # The wrapper element of the response (e.g. mycommandresponse) is discarded and the
-    # contents of that element are returned.
-
-    def send_request(params)
-      params['response'] = 'json'
-      params['apiKey'] = @api_key
-
-      params_arr = []
-      params.sort.each { |elem|
-        params_arr << elem[0].to_s + '=' + CGI.escape(elem[1].to_s).gsub('+', '%20').gsub(' ','%20')
-      }
-
-      debug_output JSON.pretty_generate(params) if @debug
-
-      data = params_arr.join('&')
-      signature = OpenSSL::HMAC.digest('sha1', @secret_key, data.downcase)
-      signature = Base64.encode64(signature).chomp
-      signature = CGI.escape(signature)
-
-      url = "#{@api_url}?#{data}&signature=#{signature}"
+        define_singleton_method(method_name) do |args = {}, options = {}|
+          params = {"command" => command.name}
 
-      uri = URI.parse(url)
-      http = Net::HTTP.new(uri.host, uri.port)
+          args.each do |k, v|
+            k = normalize_key(k)
+            if v != nil && command_supports_key?(command, k)
+              params[k] = v
+            end
+          end
 
-      if uri.scheme == 'https'
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
-
-      begin
-        response = http.request(Net::HTTP::Get.new(uri.request_uri))
-      rescue
-        puts "Error connecting to API:"
-        puts "#{@api_url} is not reachable"
-        exit 1
-      end
-
-
-      if response.is_a? Net::HTTPOK
-        begin
-          json = JSON.parse(response.body)
-          json = json[params['command'].downcase + 'response']
-        rescue JSON::ParserError
-          puts "Error parsing response from server:"
-          puts response.body
-          exit 2
-        end
-      else
-        begin
-          json = JSON.parse(response.body)
-          puts "Error executing command..."
-          puts json if @debug
-          json = json[params['command'].downcase + 'response']
-          puts "#{json['errorcode']}: #{json['errortext']}"
-        rescue
-          puts "Error parsing response from server..."
-          puts "#{response.code}: #{response.body}"
+          sync = command.isasync == false || options[:sync]
+          sync ? send_request(params) : send_async_request(params)
         end
-        exit 3
       end
     end
 
-    ##
-    # Sends an asynchronous request and waits for the response.
-    #
-    # The contents of the 'jobresult' element are returned upon completion of the command.
-
-    def send_async_request(params)
-
-      json = send_request(params)
-
-      params = {
-          'command' => 'queryAsyncJobResult',
-          'jobId' => json['jobid']
-      }
-
-      max_tries = (@@async_timeout / @@async_poll_interval).round
-      max_tries.times do
-        json = send_request(params)
-        status = json['jobstatus']
-
-        print "." if @verbose
-
-        if status == 1
-          return json['jobresult']
-        elsif status == 2
-          puts
-          puts "Request failed (#{json['jobresultcode']}): #{json['jobresult']}"
-          exit 1
-        end
-
-        STDOUT.flush
-        sleep @@async_poll_interval
-      end
+    private
 
-      print "\n"
-      puts "Error: Asynchronous request timed out"
-      exit 1
+    def normalize_key(key)
+      key.to_s.gsub("_", "")
     end
 
-    private
+    def command_supports_key?(command, key)
+      command.params.detect { |p| p["name"] == key }
+    end
 
-    def debug_output(output, seperator = '-' * 80)
-      puts
-      puts seperator
-      puts output
-      puts seperator
-      puts
+    def underscore(camel_case)
+      camel_case.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").downcase
     end
 
   end # class

data/lib/cloudstack_client/connection.rb

@@ -0,0 +1,131 @@
+require 'base64'
+require 'openssl'
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+module CloudstackClient
+  class Connection
+
+    attr_accessor :api_url, :api_key, :secret_key, :verbose, :debug
+    attr_accessor :async_poll_interval, :async_timeout
+
+    def initialize(api_url, api_key, secret_key, options = {})
+      @api_url = api_url
+      @api_key = api_key
+      @secret_key = secret_key
+      @verbose = options[:quiet] ? false : true
+      @debug = options[:debug] ? true : false
+      @async_poll_interval = options[:async_poll_interval] || 2.0
+      @async_timeout = options[:async_timeout] || 400
+    end
+
+    ##
+    # Sends a synchronous request to the CloudStack API and returns the response as a Hash.
+    #
+
+    def send_request(params)
+      params['response'] = 'json'
+      params['apiKey'] = @api_key
+
+      params_arr = params.sort.map do |key, value|
+        value = CGI.escape(value.to_s).gsub('+', '%20').gsub(' ','%20')
+        "#{key}=#{value}"
+      end
+
+      debug_output JSON.pretty_generate(params) if @debug
+
+      data = params_arr.join('&')
+      signature = OpenSSL::HMAC.digest('sha1', @secret_key, data.downcase)
+      signature = Base64.encode64(signature).chomp
+      signature = CGI.escape(signature)
+
+      url = "#{@api_url}?#{data}&signature=#{signature}"
+
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      begin
+        response = http.request(Net::HTTP::Get.new(uri.request_uri))
+      rescue
+        raise ConnectionError, "API URL \'#{@api_url}\' is not reachable."
+      end
+
+      begin
+        body = JSON.parse(response.body).values.first
+      rescue JSON::ParserError
+        raise ParseError, "Error parsing response from server: #{response.body}."
+      end
+
+      if response.is_a? Net::HTTPOK
+        return body unless body.respond_to?(:keys)
+        if body.size == 2 && body.key?('count')
+          return body.reject { |key, _| key == 'count' }.values.first
+        elsif body.size == 1 && body.values.first.respond_to?(:keys)
+          item = body.values.first
+          return item.is_a?(Array) ? item : []
+        else
+          body.reject! { |key, _| key == 'count' } if body.key?('count')
+          body.size == 0 ? [] : body
+        end
+      else
+        message = data[data.keys.first]['errortext'] rescue data
+        raise ApiError, "Error #{response.code} - #{message}."
+      end
+    end
+
+    ##
+    # Sends an asynchronous request and waits for the response.
+    #
+    # The contents of the 'jobresult' element are returned upon completion of the command.
+
+    def send_async_request(params)
+      data = send_request(params)
+
+      params = {
+        'command' => 'queryAsyncJobResult',
+        'jobid' => data['jobid']
+      }
+
+      max_tries.times do
+        data = send_request(params)
+
+        print "." if @verbose
+
+        case data['jobstatus']
+        when 1
+          return data['jobresult']
+        when 2
+          raise JobError, "Request failed (#{data['jobresultcode']}). #{data['jobresult']}."
+        end
+
+        STDOUT.flush if @verbose
+        sleep @async_poll_interval
+      end
+
+      raise TimeoutError, "Asynchronous request timed out."
+    end
+
+    private
+
+    def max_tries
+      (@async_timeout / @async_poll_interval).round
+    end
+
+    def debug_output(output, seperator = '-' * 80)
+      puts
+      puts seperator
+      puts output
+      puts seperator
+      puts
+    end
+
+  end
+end

data/lib/cloudstack_client/error.rb

@@ -0,0 +1,9 @@
+module CloudstackClient
+  class Error < StandardError; end
+  class ArgumentError < Error; end
+  class ConnectionError < Error; end
+  class ParseError < Error; end
+  class ApiError < Error; end
+  class JobError < Error; end
+  class TimeoutError < Error; end
+end

data/lib/cloudstack_client/version.rb

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

data/lib/cloudstack_client.rb

@@ -1,3 +1,2 @@
 require "cloudstack_client/version"
 require "cloudstack_client/client"
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudstack_client
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -44,6 +44,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ripl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CloudStack API client written in Ruby
 email:
 - nik.wolfgramm@gmail.com
@@ -56,40 +84,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cloudstack_client
 - cloudstack_client.gemspec
+- config/4.2.json
 - lib/cloudstack_client.rb
+- lib/cloudstack_client/api.rb
+- lib/cloudstack_client/cli.rb
 - lib/cloudstack_client/client.rb
-- lib/cloudstack_client/commands/account.rb
-- lib/cloudstack_client/commands/affinity_group.rb
-- lib/cloudstack_client/commands/capacity.rb
-- lib/cloudstack_client/commands/cluster.rb
-- lib/cloudstack_client/commands/configuration.rb
-- lib/cloudstack_client/commands/disk_offering.rb
-- lib/cloudstack_client/commands/domain.rb
-- lib/cloudstack_client/commands/host.rb
-- lib/cloudstack_client/commands/ip_address.rb
-- lib/cloudstack_client/commands/iso.rb
-- lib/cloudstack_client/commands/job.rb
-- lib/cloudstack_client/commands/load_balancer_rule.rb
-- lib/cloudstack_client/commands/network.rb
-- lib/cloudstack_client/commands/pod.rb
-- lib/cloudstack_client/commands/port_forwarding_rule.rb
-- lib/cloudstack_client/commands/project.rb
-- lib/cloudstack_client/commands/region.rb
-- lib/cloudstack_client/commands/resource_limit.rb
-- lib/cloudstack_client/commands/router.rb
-- lib/cloudstack_client/commands/server.rb
-- lib/cloudstack_client/commands/service_offering.rb
-- lib/cloudstack_client/commands/snapshot.rb
-- lib/cloudstack_client/commands/ssh_key_pair.rb
-- lib/cloudstack_client/commands/storage_pool.rb
-- lib/cloudstack_client/commands/system_vm.rb
-- lib/cloudstack_client/commands/template.rb
-- lib/cloudstack_client/commands/user.rb
-- lib/cloudstack_client/commands/volume.rb
-- lib/cloudstack_client/commands/zone.rb
+- lib/cloudstack_client/connection.rb
+- lib/cloudstack_client/error.rb
 - lib/cloudstack_client/version.rb
-- lib/connection_helper.rb
 homepage: https://github.com/niwo/cloudstack_client
 licenses:
 - MIT
@@ -107,9 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/lib/cloudstack_client/commands/account.rb

@@ -1,38 +0,0 @@
-module CloudstackClient
-
-  module Account
-
-    ##
-    # Lists accounts.
-
-    def list_accounts(args = { :name => nil })
-      params = {
-        'command' => 'listAccounts',
-        'listall' => 'true',
-        'isrecursive' => 'true'
-      }
-      params['name'] = args[:name] if args[:name]
-
-      json = send_request(params)
-      json['account'] || []
-    end
-
-    ##
-    # Lists project accounts.
-
-    def list_project_accounts(project_id, args = {})
-      params = {
-        'command' => 'listProjectAccounts',
-        'projectid' => project_id,
-        'listall' => 'true',
-        'isrecursive' => 'true'
-      }
-      params['name'] = args[:name] if args[:name]
-
-      json = send_request(params)
-      json['account'] || []
-    end
-
-  end
-
-end

data/lib/cloudstack_client/commands/affinity_group.rb

@@ -1,39 +0,0 @@
-module CloudstackClient
-
-	module AffinityGroup
-
-		##
-    # List Affinity Groups.
-
-    def list_affinity_groups(args = {})
-      params = {
-        'command' => 'listAffinityGroups',
-      }
-
-      if args[:account]
-        account = list_accounts({name: args[:account]}).first
-        unless account
-          puts "Error: Account #{args[:account]} not found."
-          exit 1
-        end
-        params['domainid'] = account["domainid"]
-        params['account'] = args[:account]
-      end
-
-      if args['listall']
-        params['listall'] = true
-        params['isrecursive'] = true
-      end
-
-      params['name'] = args['name'] if args['name']
-      params['type'] = args['type'] if args['type']
-      params['virtualmachineid'] = args['virtualmachine_id'] if args['virtualmachine_id']
-      params['keyword'] = args['keyword'] if args['keyword']
-
-      json = send_request(params)
-      json['affinitygroup'] || []
-    end
-
-	end
-
-end

data/lib/cloudstack_client/commands/capacity.rb

@@ -1,30 +0,0 @@
-module CloudstackClient
-
-	module Capacity
-
-		##
-    # List capacity.
-
-    def list_capacity(args = {})
-      params = {
-        'command' => 'listCapacity',
-      }
-
-      if args[:zone]
-        zone = get_zone(args[:zone])
-        unless zone 
-          puts "Error: Zone #{args[:zone]} not found"
-          exit 1
-        end
-        params['zoneid'] = zone['id']  
-      end
-
-      params['type'] = args[:type] if args[:type]
-
-      json = send_request(params)
-      json['capacity'] || []
-    end
-
-	end
-
-end