cloudstack_helper 0.1

data/README.md

@@ -0,0 +1,26 @@
+# cloudstack_helper
+cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier. With cloudstack_helper, you only have to specify the command the parameters for the request and it will handle everything for you.
+
+## Library Usage
+
+```ruby
+     require 'cloudstack_helper'
+
+     API_URL = "http://mycloudstack:8080/client/api"
+     API_KEY = "WiUVlx74PpVE8w7z7hasgJjiOQvMsMWLFL3A054D_IPeSxxcm1PoNlpYlA2ujGSJBGiS2uBcG0GoLwLisosDCA"
+     SECRET_KEY = "uqzgrfMXnYSVvUi2XahgiDgvtXBemILs_npqi90KiYw0OKjyETOvQTtYg093EUrHSLZJEnI3lV1z9PrQmv2SxQ"
+     cs_helper = CloudStackHelper.new(:api_key => API_KEY, :secret_key => SECRET_KEY, :api_url => API_URL)
+
+     params = {:command => "listZones"}
+     puts cs_helper.get(params).body
+
+     params[:response] = "json"
+     puts cs_helper.get(params).body
+     ehelper.request :post, 'http://api.enstratus.com/api/enstratus/2011-02-24/admin/BillingCode', :data => json_data, :header => {'Accept' => 'application/json'}
+```
+
+## Executable Script Usage
+```
+     cloudstack_rb -x listUsers domainid=1
+     cloudstack_rb -x deployVirtualMachine serviceofferingid=12 templateid=4 zoneid=1 displayname=ohyea
+```

data/bin/cloudstack_rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'yaml'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cloudstack_helper'
+
+options = []
+command = nil
+conf_file = "cloudstack.yaml"
+opts = OptionParser.new(nil, 24, '  ')
+opts.banner = 'Usage: cloudstack_rb -c conf -x command param1=value1 param2=value2'
+opts.on('-x', '--execute COMMAND', 'command to execute. See CloudStack API for list of commands.') do |opt|
+  command = opt
+end
+opts.on('-c', '--conf FILE', 'YAML config file that stores api and secret key') do |opt|
+  conf_file = opt
+end
+opts.on_tail('-h', '--help', 'Show this message.') do
+  puts opts
+  exit
+end
+
+params = opts.parse(ARGV)
+
+if ARGV.length == 0
+  puts opts
+  exit
+end
+
+# Read config file for key and api url
+unless File.exists?(conf_file)
+  abort("Unable to read config file")
+end
+conf = YAML.load(File.read(conf_file))
+
+cs_helper = CloudStackHelper.new(:api_key => conf['api_key'], :secret_key => conf['secret_key'], :api_url => conf['api_url'])
+
+params_hash= {:command => command}
+params.each do |param|
+  tokens = param.split("=")
+  next unless tokens.size == 2
+  params_hash[tokens[0]] = tokens[1]
+end
+
+puts cs_helper.get(params_hash).body

data/lib/cloudstack_helper.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'base64'
+require 'rest_client'
+require 'openssl'
+require 'cgi'
+
+class CloudStackHelper
+  CONFIGURABLE_ATTRIBUTES = [
+    :response,
+    :secret_key,
+    :api_key,
+    :api_url
+  ]
+  attr_accessor *CONFIGURABLE_ATTRIBUTES
+
+  def initialize(options = {})
+    CONFIGURABLE_ATTRIBUTES.each do |attribute_name|
+      self.send("#{attribute_name}=", options[attribute_name]) if options.has_key?(attribute_name)
+    end
+  end
+
+  # To generate the signature:
+  # 1. For each field-value pair (as separated by a ‘&’) in the Command String, URL encode each value so that it can be safely sent via HTTP GET.
+  #     NOTE: Make sure all spaces are encoded as “%20” rather than “+”.
+  # 2. Lower case the entire Command String and sort it alphabetically via the field for each field-value pair.  
+  # 3. Take the sorted Command String and run it through the HMAC SHA-1 hashing algorithm 
+  #    with the user’s Secret Key.  
+  # 4. Base64 encode the resulting byte array in UTF-8 so that it can be safely transmitted via HTTP.  
+  def generate_signature(params)
+    params.each { |k,v| params[k] = CGI.escape(v).gsub('+', '%20').downcase }
+    sorted_params = params.sort_by{|key,value| key.to_s}
+
+    data = parameterize(sorted_params, false)
+
+    hash = OpenSSL::HMAC.digest('sha1', @secret_key, data)
+    signature = Base64.b64encode(hash).chomp
+  end
+
+  def parameterize(params, escape=true)
+    params = params.collect do |k,v| 
+      if escape
+        "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+      else
+        "#{k}=#{v}"
+      end
+    end
+    params.join('&')
+  end
+
+  def generate_params_str(params)
+    unless params[:response]
+      params[:response] = @response if @response
+    end
+    params[:apikey] = @api_key
+    params[:signature] = generate_signature(params.clone)
+    str = parameterize(params)
+  end
+
+  def request(params, api_url, method = :get)
+    case method
+    when :get
+      url = api_url + "?" + generate_params_str(params.clone)
+      response = RestClient.send(method, url)
+    else
+      raise "HTTP method #{method} not supported"
+    end
+    response    
+  end
+
+  def get(params, api_url = nil)
+    api_url ||= @api_url
+    request(params, api_url, :get)
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: cloudstack_helper
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Darren Dao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 6
+        - 7
+        version: 1.6.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id002
+description: cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier. With cloudstack_helper, you only have to specify the command the parameters for the request and it will handle everything for you.
+email: 
+- darrendao@gmail.com
+executables: 
+- cloudstack_rb
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- bin/cloudstack_rb
+- lib/cloudstack_helper.rb
+homepage: https://github.com/darrendao/cloudstack_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier.
+test_files: []
+
+has_rdoc: