cloudstack_client 0.2.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43c3f2c6cbd2c9fce29924116038430b9ac604e0
+  data.tar.gz: 6a1f2a09db25a4e900b789745319198759bf38bd
+SHA512:
+  metadata.gz: d96c69957ef3a4fd0776edecc5b452b8fb827a67b9f38cac4f8dbc00a5ccaa8519f79aceb4eb367ff6ee48b58d26f126f7031e5cd588bdc96972d9f273d1286d
+  data.tar.gz: c2aace87c686c8e7b7bb5e7f3bf3aeba2dc326b6f14d30881e66d575f7f2af6eb0c7670615f7438ba1a9f681fdcb4dc045ae09e67779c0ff194774491259fce7

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.bundle/*
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudstack-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Nik Wolfgramm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# cloudstack_client
+
+A ruby CloudStack API client.
+
+## Installation
+
+Install the cloudstack-cli gem:
+
+    $ gem install cloudstack_client
+
+## References
+-  [Cloudstack API documentation](http://cloudstack.apache.org/docs/api/apidocs-4.2/TOC_Root_Admin.html)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013, Nik Wolfgramm
+
+Released under the MIT License. See the [LICENSE](https://bitbucket.org/swisstxt/cloudstack-cli/raw/master/LICENSE.txt) file for further details.

data/cloudstack_client.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudstack_client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cloudstack_client"
+  gem.version       = CloudstackClient::VERSION
+  gem.authors       = ["Nik Wolfgramm"]
+  gem.email         = ["nik.wolfgramm@gmail.com"]
+  gem.description   = %q{A ruby CloudStack API client}
+  gem.summary       = %q{A ruby CloudStack API client}
+  gem.homepage      = "https://bitbucket.org/swisstxt/cloudstack_client"
+  gem.license       = 'MIT'
+
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.rdoc_options  = %w[--line-numbers --inline-source]
+
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('rake', '~> 10.0.4')
+end

data/lib/cloudstack_client.rb

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

data/lib/cloudstack_client/client.rb

@@ -0,0 +1,136 @@
+require 'base64'
+require 'openssl'
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'yaml'
+
+module CloudstackClient
+  class Connection
+
+    @@async_poll_interval = 2.0
+    @@async_timeout = 400
+
+    # 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)
+    end
+
+    attr_accessor :verbose
+
+    def initialize(api_url, api_key, secret_key, opts = {})
+      @api_url = api_url
+      @api_key = api_key
+      @secret_key = secret_key
+      @use_ssl = api_url.start_with? "https"
+      @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}"
+
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = @use_ssl
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      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)
+        puts "Error #{response.code}: #{response.message}"
+        puts JSON.pretty_generate(JSON.parse(response.body))
+        puts "URL: #{url}"
+        exit 1
+      end
+
+      begin 
+        json = JSON.parse(response.body)
+      rescue JSON::ParserError
+        puts "Error parsing response from server."
+        exit 1
+      end
+      json[params['command'].downcase + 'response']
+    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
+
+      print "\n"
+      puts "Error: Asynchronous request timed out"
+      exit 1
+    end
+
+    private
+
+    def debug_output(output, seperator = '-' * 80)
+      puts
+      puts seperator 
+      puts output
+      puts seperator
+      puts
+    end
+
+  end # class
+end

data/lib/cloudstack_client/commands/account.rb

@@ -0,0 +1,22 @@
+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
+
+	end
+
+end

data/lib/cloudstack_client/commands/capacity.rb

@@ -0,0 +1,19 @@
+module CloudstackClient
+
+	module Capacity
+
+		##
+    # List capacity.
+
+    def list_capacity(args = {})
+      params = {
+        'command' => 'listCapacity',
+      }
+
+      json = send_request(params)
+      json['capacity'] || []
+    end
+
+	end
+
+end

data/lib/cloudstack_client/commands/cluster.rb

@@ -0,0 +1,19 @@
+module CloudstackClient
+
+	module Cluster
+
+		##
+    # Lists clusters.
+
+    def list_clusters(args = {})
+      params = {
+        'command' => 'listClusters',
+      }
+
+      json = send_request(params)
+      json['cluster'] || []
+    end
+
+	end
+
+end

data/lib/cloudstack_client/commands/disk_offering.rb

@@ -0,0 +1,49 @@
+module CloudstackClient
+
+	module DiskOffering
+
+		##
+    # Lists all available disk offerings.
+
+    def list_disk_offerings(domain = nil)
+      params = {
+          'command' => 'listDiskOfferings'
+      }
+
+      if domain
+        params['domainid'] = list_domains(domain).first["id"]
+      end
+
+      json = send_request(params)
+      json['diskoffering'] || []
+    end
+
+    ##
+    # Get disk offering by name.
+
+    def get_disk_offering(name)
+
+      # TODO: use name parameter
+      # listServiceOfferings in CloudStack 2.2 doesn't seem to work
+      # when the name parameter is specified. When this is fixed,
+      # the name parameter should be added to the request.
+      params = {
+          'command' => 'listDiskOfferings'
+      }
+      json = send_request(params)
+
+      services = json['diskoffering']
+      return nil unless services
+
+      services.each { |s|
+        if s['name'] == name then
+          return s
+        end
+      }
+      nil
+    end
+
+
+	end
+
+end

data/lib/cloudstack_client/commands/domain.rb

@@ -0,0 +1,22 @@
+module CloudstackClient
+
+	module Domain
+		
+		##
+    # List domains.
+
+    def list_domains(name = nil)
+      params = {
+        'command' => 'listDomains',
+        'listall' => 'true',
+        'isrecursive' => 'true'
+      }
+      params['name'] = name if name
+
+      json = send_request(params)
+      json['domain'] || []
+    end
+
+  end
+
+end

data/lib/cloudstack_client/commands/host.rb

@@ -0,0 +1,28 @@
+module CloudstackClient
+
+	module Host
+
+		##
+    # Lists hosts.
+
+    def list_hosts(args = {})
+      params = {
+        'command' => 'listHosts'
+      }
+
+      if args[:zone]
+        zone = get_zone(args[:zone])
+        unless zone
+          puts "Error: zone #{args[:project]} not found."
+          exit 1
+        end
+        params['zoneid'] = zone['id']
+      end
+
+      json = send_request(params)
+      json['host'] || []
+    end
+
+	end
+
+end

data/lib/cloudstack_client/commands/ip_address.rb

@@ -0,0 +1,82 @@
+module CloudstackClient
+
+	module IpAddress
+
+		##
+    # Lists the public ip addresses.
+
+    def list_public_ip_addresses(args = {})
+      params = {
+          'command' => 'listPublicIpAddresses',
+          'isrecursive' => true
+      }
+      if args[:project]
+        project = get_project(args[:project])
+        unless project
+          puts "Error: project #{args[:project]} not found."
+          exit 1
+        end
+        params['projectid'] = project['id']
+      end
+      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
+      params['listall'] = args[:listall] if args[:listall]
+
+      json = send_request(params)
+      json['publicipaddress'] || []
+    end
+
+    ##
+    # Finds the public ip address for a given ip address string.
+
+    def get_public_ip_address(ip_address, project_id = nil)
+      params = {
+          'command' => 'listPublicIpAddresses',
+          'ipaddress' => ip_address
+      }
+      params['projectid'] = project_id if project_id
+      json = send_request(params)
+      ip_address = json['publicipaddress']
+
+      return nil unless ip_address
+      ip_address.first
+    end
+
+
+    ##
+    # Acquires and associates a public IP to an account.
+
+    def associate_ip_address(network_id)
+      params = {
+          'command' => 'associateIpAddress',
+          'networkid' => network_id
+      }
+
+      json = send_async_request(params)
+      json['ipaddress']
+    end
+
+    ##
+    # Disassociates an ip address from the account.
+    #
+    # Returns true if successful, false otherwise.
+
+    def disassociate_ip_address(id)
+      params = {
+          'command' => 'disassociateIpAddress',
+          'id' => id
+      }
+      json = send_async_request(params)
+      json['success']
+    end
+
+	end
+
+end