cft_smartcloud 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+2011-11-22 0.3.1:
+ * Support for invocation of commands using key=value syntax
+   Such as: smartcloud display_images name='Red Hat'
+
 2011-11-21 0.3.0:
  * Support for smartcloud import/export api
  * Ability to use -S to save responses and -R to play them back 

data/README.md

@@ -3,7 +3,7 @@ smartcloud
 
 Provides support for interacting with IBM SmartCloud API and CLI tools
 
-installation
+Installation
 ===
 
 from rubygems.org:
@@ -15,7 +15,7 @@ locally:
     rake build
     gem install pkg/[name of generated gem]
 
-setup
+Setup
 ===
 
 Please set up SMARTCLOUD_USERNAME and SMARTCLOUD_PASSWORD in your .bash_profile
@@ -26,12 +26,8 @@ Please set up SMARTCLOUD_USERNAME and SMARTCLOUD_PASSWORD in your .bash_profile
 You can now also supply the username and password on the command line using -u and -p
 Use `smartcloud help` to get a list of all optoins.
 
-screencast
-===
-
-http://www.youtube.com/cohesiveft#p/u/0/-WdSHP2iwDM (somewhat outdated)
 
-using the console
+Using the console
 == 
 
     script/console
@@ -44,43 +40,36 @@ using the console
   from the environment variables SMARTCLOUD_USERNAME and SMARTCLOUD_PASSWORD
   automatically (it's created at the bottom of smartcloud.rb)
 
-using the commandline helper
+Using the commandline 
 == 
 
-    smartcloud [method of smartcloud.rb]
-
-to see a list of methods:
+To see a list of methods:
 
     smartcloud help
 
-examples:
+Examples:
 
       smartcloud display_volumes
+      smartcloud display_volumes Location=82 State=MOUNTED
       smartcloud display_instances
-      smartcloud display_instance 12345
       smartcloud delete_instances 12345 12346 12347
-      smartcloud "describe_instance('12345')"
-      smartcloud "display_instances(:Location => 82, :Name => 'match_this')"
+      smartcloud display_images Name="Red Hat"
+      smartcloud display_instances Name="Red Hat" Location=82
 
-      smartcloud delete_unused_keys # this one will prompt for every key
-
-The 'display_*' methods are intended to generate pretty human readable displays, while the describe methods
-will return pretty-formatted hashes, or singular values.
-
-      smartcloud display_volumes
+The 'display_*' methods are intended to generate pretty human readable 
+displays, while the describe methods will return pretty-formatted hashes,
+or singular values.
 
-get a list of all available methods
-===
+To save time when dealing with large responses, such as the describe_images
+call, you can save a response in its native XML format:
 
-console:
+      smartcloud display_images -S /tmp/images.xml
 
-      >> @smartcloud.help
+You can then replay the response, using filters on it
 
-commandline
+      smartcloud display_images Name='Red Hat' -R /tmp/images.xml
 
-      > smartcloud help
 
-These won't tell you the arguments, you have to look at smartcloud.rb for the args.
 
 RestClient vs CurlHttpClient
 ===
@@ -100,6 +89,15 @@ This project uses the jeweler gem for packaging. See the tasks:
     rake version:bump:...
     rake build
 
+To publish to RubyForge
+
+    rake gemcutter:release
+
+Screencast
+===
+
+http://www.youtube.com/cohesiveft#p/u/0/-WdSHP2iwDM (somewhat outdated)
+
 Copyright
 == 
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/bin/cft_smartcloud

@@ -18,7 +18,7 @@ opts = Slop.new do
   on :U, :api_url=,  "URL of api endpoint"
   on :d, :debug,  "Enable debug logging"
   on :R, :simulated_response_file=, "Pass in a file containing the response (do not hit cloud)"
-  on :S, :save_response, "Save the response in responses/ dir, for later use with -R response file"
+  on :S, :save_response=, "Save the response (supply filename) as xml, for later use with -R response file"
 end
 
 # These are the actual commands appearing after the script name,
@@ -31,11 +31,8 @@ end
 
 if commands.size == 1
   if commands[0] == 'help'
-    puts "#{opts.help}\n\nFunctions:\n"
+    puts "#{opts.help}\n\n"
   end
-  @cmd=commands[0]
-elsif commands.size == 2
-  @cmd="#{commands[0]}('#{commands[1]}')"
 elsif commands.size == 0 
   puts %{
   #{opts.help}
@@ -50,17 +47,45 @@ elsif commands.size == 0
   smartcloud "delete_instance(12345)"
   smartcloud delete_instance 12345
   smartcloud delete_instances 12345 12346 12347
-  smartcloud "delete_instances(12345,12346,12347)"
   smartcloud display_instances
+  smartcloud display_images name="Red Hat"
 }
   exit(0)
+end
+
+# parse out foo=bar values and turn them into a hash
+params=[]
+param_hash={}
+commands[1..-1].each do |item| 
+  if item =~ /=/
+    key,val = item.split('=')
+    param_hash[key]=val
+  else
+    params << item
+  end
+end
+params = params.map {|param| "'#{param}'" }.join(',')
+
+method_invocation = if params.empty? && param_hash.empty?
+  commands[0]
+elsif !params.empty? && param_hash.empty?
+  "#{commands[0]}(#{params})"
+elsif params.empty? && !param_hash.empty?
+  "#{commands[0]}(#{param_hash.inspect})"
 else
-  @cmd="#{commands[0]}(#{commands[1..-1].map {|item| "'#{item}'"}.join(',')})"
+  "#{commands[0]}(#{params}, #{param_hash.inspect})"
 end
 
+puts "Invoking: #{method_invocation}"
   # allows us to send arbitrary commands like
   # smartcloud username password describe_instance("122345")
-  result = eval("@sc.#{@cmd}")
+  begin
+    result = eval("@sc.#{method_invocation}")
+
+  rescue ArgumentError => e
+    puts e.message
+    puts "\nPlease use the following command for more information:\nsmartcloud help #{commands[0]}\n\n"
+  end
 
   if result == true || result.nil?
     # do nothing, the command already logged

data/bin/smartcloud

@@ -18,7 +18,7 @@ opts = Slop.new do
   on :U, :api_url=,  "URL of api endpoint"
   on :d, :debug,  "Enable debug logging"
   on :R, :simulated_response_file=, "Pass in a file containing the response (do not hit cloud)"
-  on :S, :save_response, "Save the response in responses/ dir, for later use with -R response file"
+  on :S, :save_response=, "Save the response (supply filename) as xml, for later use with -R response file"
 end
 
 # These are the actual commands appearing after the script name,
@@ -31,11 +31,8 @@ end
 
 if commands.size == 1
   if commands[0] == 'help'
-    puts "#{opts.help}\n\nFunctions:\n"
+    puts "#{opts.help}\n\n"
   end
-  @cmd=commands[0]
-elsif commands.size == 2
-  @cmd="#{commands[0]}('#{commands[1]}')"
 elsif commands.size == 0 
   puts %{
   #{opts.help}
@@ -50,17 +47,45 @@ elsif commands.size == 0
   smartcloud "delete_instance(12345)"
   smartcloud delete_instance 12345
   smartcloud delete_instances 12345 12346 12347
-  smartcloud "delete_instances(12345,12346,12347)"
   smartcloud display_instances
+  smartcloud display_images name="Red Hat"
 }
   exit(0)
+end
+
+# parse out foo=bar values and turn them into a hash
+params=[]
+param_hash={}
+commands[1..-1].each do |item| 
+  if item =~ /=/
+    key,val = item.split('=')
+    param_hash[key]=val
+  else
+    params << item
+  end
+end
+params = params.map {|param| "'#{param}'" }.join(',')
+
+method_invocation = if params.empty? && param_hash.empty?
+  commands[0]
+elsif !params.empty? && param_hash.empty?
+  "#{commands[0]}(#{params})"
+elsif params.empty? && !param_hash.empty?
+  "#{commands[0]}(#{param_hash.inspect})"
 else
-  @cmd="#{commands[0]}(#{commands[1..-1].map {|item| "'#{item}'"}.join(',')})"
+  "#{commands[0]}(#{params}, #{param_hash.inspect})"
 end
 
+puts "Invoking: #{method_invocation}"
   # allows us to send arbitrary commands like
   # smartcloud username password describe_instance("122345")
-  result = eval("@sc.#{@cmd}")
+  begin
+    result = eval("@sc.#{method_invocation}")
+
+  rescue ArgumentError => e
+    puts e.message
+    puts "\nPlease use the following command for more information:\nsmartcloud help #{commands[0]}\n\n"
+  end
 
   if result == true || result.nil?
     # do nothing, the command already logged

data/cft_smartcloud.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cft_smartcloud}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["yan", "cohesive"]
-  s.date = %q{2011-11-21}
+  s.date = %q{2012-03-12}
   s.description = %q{CohesiveFT Ruby Interface for IBM SmartCloud and 'smartcloud' command line helper.}
   s.email = %q{yan.pritzker@cohesiveft.com}
   s.executables = ["cft_smartcloud", "smartcloud"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "cft_smartcloud.gemspec",
      "lib/config/config.yml",
      "lib/curl_client.rb",
+     "lib/dynamic_help_generator.rb",
      "lib/hash_fix.rb",
      "lib/mime-types-1.16/History.txt",
      "lib/mime-types-1.16/Install.txt",

data/lib/config/config.yml

@@ -1,6 +1,6 @@
 api_url: https://www-147.ibm.com/computecloud/enterprise/api/rest/20100331/
-http_client: CurlHttpClient
-# http_client: RestClient
+# http_client: CurlHttpClient
+http_client: RestClient
 states:
   instance: 
     0: NEW

data/lib/curl_client.rb

@@ -9,7 +9,9 @@ class CurlHttpClient
 
   def self.logger; @logger ||= Logger.new(STDOUT); end
 
-  def self.get(url)
+  # Even though we don't need the options, the REST client does.
+  # So we have this for consistency.
+  def self.get(url, options={})
     handle_output(curl(url))
   end
 

data/lib/dynamic_help_generator.rb

@@ -0,0 +1,88 @@
+module DynamicHelpGenerator
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def help_for(method, args, extra_help="")
+      @method_help||={}
+      @method_help_supplemental||={}
+      @method_help[method.to_s] = args
+      @method_help_supplemental[method.to_s] = extra_help
+    end
+
+    attr_reader :method_help
+    attr_reader :method_help_supplemental
+  end
+
+  def help(method=nil)
+
+    if method
+      args = (self.class.method_help[method.to_s]) 
+      if !(self.respond_to?(method))
+        return "Sorry, I don't know method: #{method}"
+      end
+
+        args = args && args.map do |arg|
+          if arg.is_a?(Hash)
+            # If an argument is required, just list it
+            if arg.values.first==:req
+              arg.keys.first.to_s 
+            # If it's optional, list it in brackets
+            elsif arg.values.first==:opt
+              "[#{arg.keys.first.to_s}]"
+            # If there is an array of options, list them
+            else 
+              "#{arg.keys.first.to_s}=>#{arg.values.first.inspect}"
+            end
+          else
+            arg
+          end
+        end.join(", ")
+
+        extra_help = self.class.method_help_supplemental[method.to_s] || ""
+
+        puts %{  * #{method.to_s}#{'(' + args + ')' if args}#{extra_help}}
+    else
+      # These verbs help us figure out what 'group' the method belongs to
+      verbs = %w(describe display create get allocate clone export attach detach delete generate update remove restart rename)
+      verb_noun = /(#{verbs.join('|')})_(.*)(s|es)?/ # we're going to remove the verb and trailing 's'
+
+      methods = public_methods - Object.public_methods - ['post','get','put','delete','logger','logger=','help']
+
+      # Group methods by the noun they operate on 
+      methods_grouped_by_noun = methods.inject({}) do |h, method| 
+        method_name, verb, noun = *(method.match(verb_noun))
+        if method_name.nil?
+          # match failed
+          method_name = method
+          noun = "misc"
+        end
+        synonyms = {
+          :keypair => :key,
+          :address_offering => :address,
+          :location_by_name => :location,
+          :storage_offering => :storage,
+          :volume => :storage,
+          :volume_offering => :storage,
+        }
+        noun.gsub!(/s$/,'') unless noun =~ /address/
+        if synonyms.keys.include?(noun.to_sym)
+          noun = synonyms[noun.to_sym].to_s
+        end
+        h[noun] ||= []
+        h[noun] << method_name
+        h
+      end
+      methods_grouped_by_noun.keys.sort.each do |noun|
+        methods = methods_grouped_by_noun[noun]
+        next unless methods
+        puts "== #{noun.capitalize} ==\n\n"
+        methods.sort.each {|m| help(m)}
+        puts
+      end
+      nil
+    end
+  end
+end

data/lib/smartcloud.rb

@@ -24,13 +24,14 @@ require 'xmlsimple'
 require 'smartcloud_logger'
 require 'curl_client'
 require 'terminal-table'
+require "dynamic_help_generator"
 
 IBM_TOOLS_HOME=File.join(File.dirname(__FILE__), "cli_tools") unless defined?(IBM_TOOLS_HOME)
 
 # Encapsulates communications with IBM SmartCloud via REST
 
 class IBMSmartCloud
- 
+  include DynamicHelpGenerator
   attr_accessor :logger
 
   def initialize(opts={})
@@ -59,57 +60,22 @@ class IBMSmartCloud
 
   class << self
     @config = YAML.load_file(File.join(File.dirname(__FILE__), "config/config.yml"))
-    attr_reader :method_help
-    attr_reader :method_help_supplemental
     attr_reader :config
   end
 
-  def self.help_for(method, args, extra_help={})
-    @method_help||={}
-    @method_help_supplemental||={}
-    @method_help[method.to_s] = args
-    @method_help_supplemental[method.to_s] = extra_help
-  end
-
-  def help(method=nil)
-    if method
-      args = (self.class.method_help[method.to_s]) 
-      if !(self.respond_to?(method))
-        return "Sorry, I don't know method: #{method}"
-      end
-
-        args = args && args.map do |arg|
-          if arg.is_a?(Hash)
-            # If an argument is required, just list it
-            if arg.values.first==:req
-              arg.keys.first.to_s 
-            # If it's optional, list it in brackets
-            elsif arg.values.first==:opt
-              "[#{arg.keys.first.to_s}]"
-            # If there is an array of options, list them
-            else 
-              "#{arg.keys.first.to_s}=>#{arg.values.first.inspect}"
-            end
-          else
-            arg
-          end
-        end.join(", ")
-
-        extra_help = self.class.method_help_supplemental[method.to_s] || ""
-
-        puts %{  * #{method.to_s}#{'(' + args + ')' if args}#{extra_help + "\n" if extra_help}}
+  # Get a list of data centers
+  help_for :describe_locations, [{:name => :opt}], %{
+    If name is given, will find the location by name
+  }
+  def describe_locations(name=nil)
+    locations = get("/locations").Location
+    if name
+      locations.detect {|loc| loc.Name =~ /#{name}/}
     else
-      methods = public_methods - Object.public_methods - ['post','get','put','delete','logger','logger=','help']
-      methods.sort.each {|m| help(m)}
-      nil
+      locations
     end
   end
 
-  # Get a list of data centers
-  def describe_locations
-    get("/locations").Location
-  end
-
   def describe_location(location_id)
     get("/locations/#{location_id}").Location
   end
@@ -214,21 +180,26 @@ class IBMSmartCloud
     post("/offerings/image/#{image_id}", :name => name, :description => description).ImageID
   end
 
-  # Export an image to a volume
+  # Export an image to a volume - create the volume first
   help_for :export_image, [{:name=>:req}, {:size => ['Small','Medium','Large']}, {:image_id => :req}, {:location => :req}]
   def export_image(name, size, image_id, location)
     # Note we figure out the correct size based on the name and location
     storage_offering=describe_storage_offerings(location, size)
 
-    response = post("/storage", :name => name, :size => storage_offering.Capacity, :format => 'EXT3', :offeringID => storage_offering.ID, :location => location, :imageID => image_id)
+    response = post("/storage", :name => name, :size => storage_offering.Capacity, :format => 'EXT3', :offeringID => storage_offering.ID, :location => location)
+    volumeID = response.Volume.ID
+
+    poll_for_volume_state(volumeID, :unmounted)
+
+    response = put("/storage/#{volumeID}", :imageId => image_id)
     response.Volume.ID
   end
 
   help_for :import_image, [{:name=>:req, :volume_id => :req}] 
   def import_image(name, volume_id)
     # TODO: this is a complete guess as we have no info from IBM as to the URL for this api, only the parameters
-    response = post("/offerings/image", :volumeID => volume_id, :name => name)
-    response.ImageID
+    response = post("/offerings/image", :volumeId => volume_id, :name => name)
+    response.Image.ID
   end
 
   # Launches a clone request and returns ID of new volume
@@ -289,8 +260,6 @@ class IBMSmartCloud
     delete("/keys/#{name}")
     true
   end
-  alias remove_key remove_keypair
-  alias delete_key remove_keypair
 
   help_for :describe_key, [:name]
   def describe_key(name)
@@ -341,10 +310,6 @@ class IBMSmartCloud
     arrayize(get("/keys").PublicKey)
   end
 
-  def describe_unused_keys
-    describe_keys.select {|key| key.Instances == {}}
-  end
-
   def display_keys 
     keys = describe_keys
 
@@ -638,14 +603,13 @@ class IBMSmartCloud
       output = if @simulated_response
         @simulated_response
       else
-        @http_client.get File.join(@api_url, path) 
+        @http_client.get File.join(@api_url, path), :accept => :response, :headers => "User-Agent: cloudapi"
       end
 
       # Save Response for posterity
       if @save_response && !output.empty? 
-        response_file = "responses/#{path.gsub('/','_').gsub(/^_/,'')}.#{Time.now.to_i}"
-        logger.info "Saving response to: #{response_file}"
-        File.open(response_file,'w') {|f| f.write(output)}
+        logger.info "Saving response to: #{@save_response}"
+        File.open(@save_response,'w') {|f| f.write(output)}
       end
 
       if output && !output.empty?
@@ -723,6 +687,7 @@ class IBMSmartCloud
     order_by = filters.delete(:order) 
 
     filters.each do |filter, value|
+      filter = filter.to_sym
       value = value.to_s.upcase if (filter==:status || filter==:state)
       if filter == :name || filter == :Name
         instances = instances.select {|inst| inst.send(filter.to_s.capitalize) =~ /#{value}/}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - yan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-21 00:00:00 -06:00
+date: 2012-03-12 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +41,7 @@ files:
 - cft_smartcloud.gemspec
 - lib/config/config.yml
 - lib/curl_client.rb
+- lib/dynamic_help_generator.rb
 - lib/hash_fix.rb
 - lib/mime-types-1.16/History.txt
 - lib/mime-types-1.16/Install.txt