cft_smartcloud 0.2.2 → 0.3.0

data/.gitignore

@@ -1,2 +1,3 @@
 pkg/*
 lib/cli_tools/logs/*
+tags

data/CHANGELOG

@@ -1,3 +1,14 @@
+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 
+	 for offline testing
+ * Cleaner output display using ascii tables
+
+2011-11-16 0.2.5: 
+ * Better help display
+ * Support for -u, -p, -U (username, password, api url)
+ * Removed delete_unused_keys method (was not working correctly / not needed)
+
 2011-09-21 0.2.1:
  * Added sleep/retry logic for intermittent 500 errors returned by cloud
 

data/README.md

@@ -0,0 +1,106 @@
+smartcloud
+===
+
+Provides support for interacting with IBM SmartCloud API and CLI tools
+
+installation
+===
+
+from rubygems.org:
+
+    gem install cft_smartcloud
+
+locally:
+
+    rake build
+    gem install pkg/[name of generated gem]
+
+setup
+===
+
+Please set up SMARTCLOUD_USERNAME and SMARTCLOUD_PASSWORD in your .bash_profile
+
+    export SMARTCLOUD_USERNAME=[your username]
+    export SMARTCLOUD_PASSWORD=[your password]
+
+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
+== 
+
+    script/console
+    >> @smartcloud.display_instances
+    >> @smartcloud.display_volumes(:Location => 101)
+    >> @smartcloud.display_instances(:Location => 82, :Name => "namematch")
+    >> @smartcloud.poll_for_volume_state(12345, :unmounted)
+
+  The console predefines the @smartcloud instance variable that is set up
+  from the environment variables SMARTCLOUD_USERNAME and SMARTCLOUD_PASSWORD
+  automatically (it's created at the bottom of smartcloud.rb)
+
+using the commandline helper
+== 
+
+    smartcloud [method of smartcloud.rb]
+
+to see a list of methods:
+
+    smartcloud help
+
+examples:
+
+      smartcloud display_volumes
+      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 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
+
+get a list of all available methods
+===
+
+console:
+
+      >> @smartcloud.help
+
+commandline
+
+      > smartcloud help
+
+These won't tell you the arguments, you have to look at smartcloud.rb for the args.
+
+RestClient vs CurlHttpClient
+===
+Sometimes RestClient and friends have trouble communicating with certain API's such as 
+IBM SmartCloud, returning 500 errors. We found in some cases the only thing that truly
+works is pure curl (not even libcurl ruby wrappers). Therefore there is a provided 
+simple CurlHttpClient library which emulates the RestClient interface, and wraps 
+command line calls to curl.
+
+The choice of client is determined inside of config.yml
+
+Versioning
+== 
+
+This project uses the jeweler gem for packaging. See the tasks:
+
+    rake version:bump:...
+    rake build
+
+Copyright
+== 
+
+Copyright (c) 2011 CohesiveFT. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/bin/cft_smartcloud

@@ -2,18 +2,44 @@
 
 require File.join(File.dirname(__FILE__), '../lib/smartcloud')
 require 'pp'
+require 'slop'
 
 if !ENV['SMARTCLOUD_USERNAME'] || !ENV['SMARTCLOUD_PASSWORD']
   puts "Please set environment variables SMARTCLOUD_PASSWORD and SMARTCLOUD_USERNAME in your environment."
   exit(1)
 end
 
-if ARGV.size == 1
-  @cmd=ARGV[0]
-elsif ARGV.size == 2
-  @cmd="#{ARGV[0]}('#{ARGV[1]}')"
-elsif ARGV.size == 0 
+# These are the options we can pass in
+opts = Slop.new do
+  on :u, :username=, :optional => true
+  on :p, :password=, :optional => true
+  on :r, :retries=,  "How many retries if the server is down"
+  on :s, :sleep_interval=,  "How long to sleep between retries (s)"
+  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"
+end
+
+# These are the actual commands appearing after the script name,
+# such as "smartcloud display_instances ... "
+commands = []
+opts.parse do |nonarg|
+  commands << nonarg
+end
+@sc = IBMSmartCloud.new(opts)
+
+if commands.size == 1
+  if commands[0] == 'help'
+    puts "#{opts.help}\n\nFunctions:\n"
+  end
+  @cmd=commands[0]
+elsif commands.size == 2
+  @cmd="#{commands[0]}('#{commands[1]}')"
+elsif commands.size == 0 
   puts %{
+  #{opts.help}
+  
   Usage: 
   smartcloud help
   smartcloud help [command]
@@ -29,12 +55,12 @@ elsif ARGV.size == 0
 }
   exit(0)
 else
-  @cmd="#{ARGV[0]}(#{ARGV[1..-1].map {|item| "'#{item}'"}.join(',')})"
+  @cmd="#{commands[0]}(#{commands[1..-1].map {|item| "'#{item}'"}.join(',')})"
 end
 
   # allows us to send arbitrary commands like
   # smartcloud username password describe_instance("122345")
-  result = eval("@smartcloud.#{@cmd}")
+  result = eval("@sc.#{@cmd}")
 
   if result == true || result.nil?
     # do nothing, the command already logged

data/bin/smartcloud

@@ -2,18 +2,44 @@
 
 require File.join(File.dirname(__FILE__), '../lib/smartcloud')
 require 'pp'
+require 'slop'
 
 if !ENV['SMARTCLOUD_USERNAME'] || !ENV['SMARTCLOUD_PASSWORD']
   puts "Please set environment variables SMARTCLOUD_PASSWORD and SMARTCLOUD_USERNAME in your environment."
   exit(1)
 end
 
-if ARGV.size == 1
-  @cmd=ARGV[0]
-elsif ARGV.size == 2
-  @cmd="#{ARGV[0]}('#{ARGV[1]}')"
-elsif ARGV.size == 0 
+# These are the options we can pass in
+opts = Slop.new do
+  on :u, :username=, :optional => true
+  on :p, :password=, :optional => true
+  on :r, :retries=,  "How many retries if the server is down"
+  on :s, :sleep_interval=,  "How long to sleep between retries (s)"
+  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"
+end
+
+# These are the actual commands appearing after the script name,
+# such as "smartcloud display_instances ... "
+commands = []
+opts.parse do |nonarg|
+  commands << nonarg
+end
+@sc = IBMSmartCloud.new(opts)
+
+if commands.size == 1
+  if commands[0] == 'help'
+    puts "#{opts.help}\n\nFunctions:\n"
+  end
+  @cmd=commands[0]
+elsif commands.size == 2
+  @cmd="#{commands[0]}('#{commands[1]}')"
+elsif commands.size == 0 
   puts %{
+  #{opts.help}
+  
   Usage: 
   smartcloud help
   smartcloud help [command]
@@ -29,12 +55,12 @@ elsif ARGV.size == 0
 }
   exit(0)
 else
-  @cmd="#{ARGV[0]}(#{ARGV[1..-1].map {|item| "'#{item}'"}.join(',')})"
+  @cmd="#{commands[0]}(#{commands[1..-1].map {|item| "'#{item}'"}.join(',')})"
 end
 
   # allows us to send arbitrary commands like
   # smartcloud username password describe_instance("122345")
-  result = eval("@smartcloud.#{@cmd}")
+  result = eval("@sc.#{@cmd}")
 
   if result == true || result.nil?
     # do nothing, the command already logged

data/cft_smartcloud.gemspec

@@ -5,29 +5,30 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cft_smartcloud}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["yan", "cohesive"]
-  s.date = %q{2011-10-17}
+  s.date = %q{2011-11-21}
   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"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".gitignore",
      "CHANGELOG",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "bin/cft_smartcloud",
      "bin/smartcloud",
      "cft_smartcloud.gemspec",
      "lib/config/config.yml",
+     "lib/curl_client.rb",
      "lib/hash_fix.rb",
      "lib/mime-types-1.16/History.txt",
      "lib/mime-types-1.16/Install.txt",
@@ -42,25 +43,81 @@ Gem::Specification.new do |s|
      "lib/mime-types-1.16/test/test_mime_type.rb",
      "lib/mime-types-1.16/test/test_mime_types.rb",
      "lib/mock_smartcloud.rb",
-     "lib/rest-client-1.6.3/README.rdoc",
-     "lib/rest-client-1.6.3/Rakefile",
-     "lib/rest-client-1.6.3/VERSION",
-     "lib/rest-client-1.6.3/bin/restclient",
-     "lib/rest-client-1.6.3/history.md",
-     "lib/rest-client-1.6.3/lib/rest-client.rb",
-     "lib/rest-client-1.6.3/lib/rest_client.rb",
-     "lib/rest-client-1.6.3/lib/restclient.rb",
-     "lib/rest-client-1.6.3/lib/restclient/abstract_response.rb",
-     "lib/rest-client-1.6.3/lib/restclient/exceptions.rb",
-     "lib/rest-client-1.6.3/lib/restclient/net_http_ext.rb",
-     "lib/rest-client-1.6.3/lib/restclient/payload.rb",
-     "lib/rest-client-1.6.3/lib/restclient/raw_response.rb",
-     "lib/rest-client-1.6.3/lib/restclient/request.rb",
-     "lib/rest-client-1.6.3/lib/restclient/resource.rb",
-     "lib/rest-client-1.6.3/lib/restclient/response.rb",
+     "lib/rest-client-1.6.6-master/.gitignore",
+     "lib/rest-client-1.6.6-master/README.rdoc",
+     "lib/rest-client-1.6.6-master/Rakefile",
+     "lib/rest-client-1.6.6-master/VERSION",
+     "lib/rest-client-1.6.6-master/bin/restclient",
+     "lib/rest-client-1.6.6-master/history.md",
+     "lib/rest-client-1.6.6-master/lib/rest-client.rb",
+     "lib/rest-client-1.6.6-master/lib/rest_client.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/abstract_response.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/exceptions.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/net_http_ext.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/payload.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/raw_response.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/request.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/resource.rb",
+     "lib/rest-client-1.6.6-master/lib/restclient/response.rb",
+     "lib/rest-client-1.6.6-master/rest-client.gemspec",
+     "lib/rest-client-1.6.6-master/spec/abstract_response_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/base.rb",
+     "lib/rest-client-1.6.6-master/spec/exceptions_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/integration/certs/equifax.crt",
+     "lib/rest-client-1.6.6-master/spec/integration/certs/verisign.crt",
+     "lib/rest-client-1.6.6-master/spec/integration/request_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/integration_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/master_shake.jpg",
+     "lib/rest-client-1.6.6-master/spec/payload_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/raw_response_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/request2_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/request_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/resource_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/response_spec.rb",
+     "lib/rest-client-1.6.6-master/spec/restclient_spec.rb",
      "lib/restclient_fix.rb",
+     "lib/slop-2.3.1/.gemtest",
+     "lib/slop-2.3.1/.gitignore",
+     "lib/slop-2.3.1/.yardopts",
+     "lib/slop-2.3.1/CHANGES.md",
+     "lib/slop-2.3.1/LICENSE",
+     "lib/slop-2.3.1/README.md",
+     "lib/slop-2.3.1/Rakefile",
+     "lib/slop-2.3.1/lib/slop.rb",
+     "lib/slop-2.3.1/slop.gemspec",
+     "lib/slop-2.3.1/test/commands_test.rb",
+     "lib/slop-2.3.1/test/helper.rb",
+     "lib/slop-2.3.1/test/option_test.rb",
+     "lib/slop-2.3.1/test/slop_test.rb",
      "lib/smartcloud.rb",
      "lib/smartcloud_logger.rb",
+     "lib/terminal-table-1.4.4/History.rdoc",
+     "lib/terminal-table-1.4.4/Manifest",
+     "lib/terminal-table-1.4.4/README.rdoc",
+     "lib/terminal-table-1.4.4/Rakefile",
+     "lib/terminal-table-1.4.4/Todo.rdoc",
+     "lib/terminal-table-1.4.4/examples/examples.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/cell.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/core_ext.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/import.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/row.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/separator.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/style.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/table.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/table_helper.rb",
+     "lib/terminal-table-1.4.4/lib/terminal-table/version.rb",
+     "lib/terminal-table-1.4.4/spec/cell_spec.rb",
+     "lib/terminal-table-1.4.4/spec/core_ext_spec.rb",
+     "lib/terminal-table-1.4.4/spec/import_spec.rb",
+     "lib/terminal-table-1.4.4/spec/spec.opts",
+     "lib/terminal-table-1.4.4/spec/spec_helper.rb",
+     "lib/terminal-table-1.4.4/spec/table_spec.rb",
+     "lib/terminal-table-1.4.4/tasks/docs.rake",
+     "lib/terminal-table-1.4.4/tasks/gemspec.rake",
+     "lib/terminal-table-1.4.4/tasks/spec.rake",
+     "lib/terminal-table-1.4.4/terminal-table.gemspec",
      "lib/xml-simple-1.0.12/lib/xmlsimple.rb",
      "rdoc/classes/ConfigTable.html",
      "rdoc/classes/ConfigTable/BoolItem.html",
@@ -143,6 +200,13 @@ Gem::Specification.new do |s|
      "rdoc/fr_method_index.html",
      "rdoc/index.html",
      "rdoc/rdoc-style.css",
+     "responses/addresses",
+     "responses/addresses.blank",
+     "responses/instances",
+     "responses/keys",
+     "responses/locations",
+     "responses/offerings_image",
+     "responses/storage",
      "script/console",
      "test/helper.rb"
   ]

data/lib/config/config.yml

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

data/lib/curl_client.rb

@@ -0,0 +1,42 @@
+class CurlHttpClient
+  # For compatibility with RestClient
+  class << self
+    attr_accessor :timeout
+    attr_accessor :log
+
+    @timeout ||= 120
+  end
+
+  def self.logger; @logger ||= Logger.new(STDOUT); end
+
+  def self.get(url)
+    handle_output(curl(url))
+  end
+
+  def self.post(url, data, options={}) 
+    handle_output(curl(%{ #{url} -d "#{data}" }))
+  end
+
+  def self.put(url, data, options={}) 
+    handle_output(curl(%{ #{url} -XPUT -d #{data} }))
+  end
+
+  def self.delete(url, options={}) 
+    handle_output(curl(%{ #{url} -XDELETE}))
+  end
+
+  def self.curl(cmd)
+    cmd = "curl -s --insecure --connect-timeout #{@timeout} #{cmd} 2>&1"
+    @log.debug cmd if @log
+    `#{cmd}`
+  end
+
+  def self.handle_output(output)
+    if output =~ /^Error/
+      logger.error output
+      raise output
+    else
+      output
+    end
+  end
+end

data/lib/rest-client-1.6.6-master/.gitignore

@@ -0,0 +1,6 @@
+.idea
+doc
+rdoc
+pkg
+*.gem
+scratchpad.rb

data/lib/{rest-client-1.6.3 → rest-client-1.6.6-master}/README.rdoc

@@ -57,7 +57,7 @@ This does two things for you:
 
 If you are sending params that do not contain a File object but the payload needs to be multipart then:
 
-  RestClient.post '/data', :foo => 'bar', :multipart => true
+  RestClient.post '/data', {:foo => 'bar', :multipart => true}
 
 == Usage: ActiveResource-Style
 
@@ -217,6 +217,15 @@ use whatever proxy the system is configured to use:
 
   RestClient.proxy = ENV['http_proxy']
 
+== Query parameters
+
+Request objects know about query parameters and will automatically add them to
+the url for GET, HEAD and DELETE requests and escape the keys and values as 
+needed:
+
+  RestClient.get 'http://example.com/resource', :params => {:foo => 'bar', :baz => 'qux'}
+  # will GET http://example.com/resource?foo=bar&baz=qux
+
 == Cookies
 
 Request and Response objects know about HTTP cookies, and will automatically

data/lib/rest-client-1.6.6-master/VERSION

@@ -0,0 +1 @@
+1.6.7

data/lib/{rest-client-1.6.3 → rest-client-1.6.6-master}/bin/restclient

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 
 $:.unshift File.dirname(__FILE__) + "/../lib"
-require 'restclient'
 
-require "yaml"
+require 'rubygems'
+require 'restclient'
+require 'yaml'
 
 def usage(why = nil)
   puts "failed for reason: #{why}" if why
@@ -56,8 +57,8 @@ end
 
 POSSIBLE_VERBS.each do |m|
   eval <<-end_eval
-def  #{m} (path, *args, &b)
-	r[path]. #{m} (*args, &b)
+def  #{m}(path, *args, &b)
+	r[path].#{m}(*args, &b)
 end
   end_eval
 end

data/lib/{rest-client-1.6.3 → rest-client-1.6.6-master}/history.md

@@ -1,4 +1,26 @@
+# 1.6.7
+
+- rebuild with 1.8.7 to avoid https://github.com/rubygems/rubygems/pull/57
+
+# 1.6.6
+
+- 1.6.5 was yanked
+
+# 1.6.5
+
+- RFC6265 requires single SP after ';' for separating parameters pairs in the 'Cookie:' header (patch provided by Hiroshi Nakamura)
+- enable url parameters for all actions
+- detect file parameters in arrays
+- allow disabling the timeouts by passing -1 (patch provided by Sven Böhm)
+
+# 1.6.4
+
+- fix restclient script compatibility with 1.9.2
+- fix unlinking temp file (patch provided by Evan Smith)
+- monkeypatching ruby for http patch method (patch provided by Syl Turner)
+
 # 1.6.3
+
 - 1.6.2 was yanked
 
 # 1.6.2

data/lib/rest-client-1.6.6-master/lib/restclient/net_http_ext.rb

@@ -0,0 +1,55 @@
+module Net
+  class HTTP    
+    
+  # Adding the patch method if it doesn't exist (rest-client issue: https://github.com/archiloque/rest-client/issues/79)
+  if !defined?(Net::HTTP::Patch)
+    # Code taken from this commit: https://github.com/ruby/ruby/commit/ab70e53ac3b5102d4ecbe8f38d4f76afad29d37d#lib/net/http.rb
+    class Protocol
+      # Sends a PATCH request to the +path+ and gets a response,
+      # as an HTTPResponse object.
+      def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
+        send_entity(path, data, initheader, dest, Patch, &block)
+      end
+      
+      # Executes a request which uses a representation
+      # and returns its body.
+      def send_entity(path, data, initheader, dest, type, &block)
+        res = nil
+        request(type.new(path, initheader), data) {|r|
+          r.read_body dest, &block
+          res = r
+        }
+        unless @newimpl
+          res.value
+          return res, res.body
+        end
+        res
+      end
+    end
+    
+    class Patch < HTTPRequest
+      METHOD = 'PATCH'
+      REQUEST_HAS_BODY = true
+      RESPONSE_HAS_BODY = true
+    end
+  end
+
+    #
+    # Replace the request method in Net::HTTP to sniff the body type
+    # and set the stream if appropriate
+    #
+    # Taken from:	
+    # http://www.missiondata.com/blog/ruby/29/streaming-data-to-s3-with-ruby/
+
+    alias __request__ request
+
+    def request(req, body=nil, &block)
+      if body != nil && body.respond_to?(:read)
+        req.body_stream = body
+        return __request__(req, nil, &block)
+      else
+        return __request__(req, body, &block)
+      end
+    end
+  end
+end

data/lib/{rest-client-1.6.3 → rest-client-1.6.6-master}/lib/restclient/payload.rb

@@ -27,12 +27,27 @@ module RestClient
         case v
           when Hash
             has_file?(v)
+          when Array
+            has_file_array?(v)
           else
             v.respond_to?(:path) && v.respond_to?(:read)
         end
       end
     end
 
+    def has_file_array?(params)
+      params.any? do |v|
+        case v
+          when Hash
+            has_file?(v)
+          when Array
+            has_file_array?(v)
+          else
+            v.respond_to?(:path) && v.respond_to?(:read)
+          end
+      end
+    end
+
     class Base
       def initialize(params)
         build_stream(params)
@@ -70,7 +85,7 @@ module RestClient
         result = []
         value.each do |elem|
           if elem.is_a? Hash
-            result +=  flatten_params(elem, calculated_key)
+            result += flatten_params(elem, calculated_key)
           elsif elem.is_a? Array
             result += flatten_params_array(elem, calculated_key)
           else
@@ -91,7 +106,7 @@ module RestClient
       alias :length :size
 
       def close
-        @stream.close
+        @stream.close unless @stream.closed?
       end
 
       def inspect