amazon-ec2 0.0.7 → 0.0.8

data/History.txt

@@ -1,3 +1,116 @@
-=History.txt : Amazon Elastic Compute Cloud (EC2) Ruby Gem
+=== 0.0.8 2007-05-30
+* Repackaged with updated newgem generator v. 0.10.3 from http://newgem.rubyforge.org/ to take advantage of new deployment goodness.
 
-* See CHANGELOG.txt for version and change information.
+=== 0.0.7 2007-03-15
+* Applied patch from Kevin Clark which does the following:
+  * New method to the instances.rb to allow for issuing a reboot command to an EC2 instance.
+  * New Mocha based tests (Mocha test suite must be installed to run tests.  'sudo gem install mocha')
+  * Cleanup of the test directory.
+* Applied patch from Randy Bias related to CGI escaping error.  From his notes:
+
+I finally figured out what was going on.  It was a compound problem.  The first being that you can't CGI::encode the UserData early.  You have to just Base64 encode it.  Unfortunately, when you Base64 encode it, it means that some encodings will be padded with extra chars, specifically the '=', but &, ? and = get stripped by EC2.canonial_string.  So if a Base64 encoding has trailing ='s for padding, these get stripped and then you sign the UserData Base64 payload sans the padding.  But it looks like Amazon's side is doing the right thing and is signing the padding.  So, the signatures mis-match.
+
+I've got the complete patch here and it's about as elegant/clean as I could make it in a short period of time.  It's a little tough to strip those equal signs when there are so many in the URI.  I think this works pretty well, though.  I'm splitting the URI on '&', then for each field ripping out all '&' and '?' and only the first '='.  Then stitching it back together.
+
+
+=== 0.0.6 2007-03-02
+* Patched instances.rb with a bugfix and patch provided by Randy Bias (Thanks Randy!).
+Only minimally tested so please let me know if this causes any problems for anyone.
+
+From his notes:
+I wanted to let you know that there appears to be a bug in how user data is passed.  In  
+instances.rb the line that creates the base64 encoded package of user data is as follows:
+
+userData = CGI::escape(Base64.encode64(in_params[:userData]).strip())
+
+This may have worked prior, but at least right now the  
+CGI::escape appears to cause a breakage.  More specifically it  
+turns something like this (the actual base64 encoded string):
+
+YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh
+eHh4eHh4eHh4eHh4eHh4eHh4eHgg
+
+  Into this:
+
+YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh% 
+0AeHh4eHh4eHh4eHh4eHh4eHh4eHgg
+
+And it looks like EC2 chokes on the %0, which is CGI::escape's  
+way for handling an EOL.  Unfortunately, the Base64.encode64 (at  
+least in my 1.8.5 version of Ruby) inserts a EOL at every 47 chars,  
+no matter what:
+
+---
+[randyb@master randyb] cat /tmp/foo.rb
+#!/usr/bin/env ruby
+#
+require 'rubygems'
+require_gem 'amazon-ec2'
+require 'getoptlong'
+puts Base64.encode64 
+("012345678901234567890123456789012345678901234567890123456789")
+
+[randyb@master randyb] /tmp/foo.rb
+MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0
+NTY3ODkwMTIzNDU2Nzg5
+---
+
+The best way to handle this is to strip the CRLFs/EOLs before passing to CGI.escape.
+
+
+=== 0.0.5 2006-12-21
+* Changes to home page documentation and example files to indicate that you 
+  should use 'require_gem' instead of a simple require.  Not sure if this 
+  is a result of something I am doing in the packaging of the gem that is 
+  incorrect or if this is right and proper.  I will investigate further.
+* Patched instances.rb run_instances method to allow for submission of 
+  user data with the command to start an instance.  Patch submitted 
+  anonymously on RubyForge.  This had not been functionally implemented
+  in the Amazon Web Services sample library prior to this patch.
+* Added simple framework for adding unit tests for the library under test dir.  
+  No functional unit tests exist yet.
+
+=== 0.0.4 2006-12-21
+* Applied patch from Kevin Clark to svn version 7.  Thanks for the 
+  patch and the description Kevin!  Please report if you 
+  encounter any issues with this patched version.  Here is Kevin's 
+  description which I requested :  "It helps me to think of modules as boxes full of classes and 
+  methods.  REXML is a module which holds various classes related to parsing XML
+  including REXML::Node, REXML::Document and REXML::XPath. When you
+  include a module it takes everything out of the box and places it in
+  the local context.  So, when you include REXML in the global namespace 
+  on line 27 of EC2.rb, it includes classes called Node, Document and XPath in the
+  global object space. This means that I can't have a class called Node
+  in my own project (which I do). The library would be a much better
+  neighbor if it instead accessed the REXML::Document and REXML::XPath
+  classes explicitly through the module."
+
+=== 0.0.3 2006-12-16
+* API CHANGE : Changed method name 'authorize' to 'authorize_security_group_ingress' to ensure consistent 
+  naming of Ruby library methods to match AWS EC2 API actions. Alias to 'authorize' for backwards compatibility.
+* API CHANGE : Changed method name 'revoke' to 'revoke_security_group_ingress' to ensure consistent 
+	naming of Ruby library methods to match AWS EC2 API actions. Alias to 'revoke' for backwards compatibility.
+* API CHANGE : Changed method name 'delete_securitygroup' to 'delete_security_group' to ensure consistent 
+	naming of Ruby library methods to match AWS EC2 API actions. Alias to 'delete_securitygroup' for backwards compatibility.
+* API CHANGE : Changed method name 'describe_securitygroups' to 'describe_security_group' to ensure consistent 
+	naming of Ruby library methods to match AWS EC2 API actions. Alias to 'describe_securitygroups' for backwards compatibility.
+* API CHANGE : Changed method name 'create_securitygroup' to 'create_security_group' to ensure consistent 
+	naming of Ruby library methods to match AWS EC2 API actions. Alias to 'create_securitygroup' for backwards compatibility.
+* Added many API rdoc's, some method descriptions copied from Amazon Query API Developer Guide.
+* Extracted some parts of the formerly monolithic EC2 library out into separate files for manageability.
+* Changed the HTTP 'User-Agent' string used for each request so that we have our own user agent
+  to identify this library's calls.  Now set the version # in the user agent string based on the
+  master version number for this library which is stored in lib/EC2/version.rb and should only
+  be defined in one place.
+* Set @http.verify_mode = OpenSSL::SSL::VERIFY_NONE to avoid seeing SSL Cert warning 
+  "warning: peer certificate won't be verified in this SSL session". File EC2.rb:96
+* Make 'pathlist' utility method a private method (EC2.rb:111).  No reason I can see for this to be exposed.
+
+=== 0.0.2 2006-12-14
+* Bugfix in run_instances method.  Method works now.  Patch submitted by Stephen Caudill on AWS forums.  Thanks!
+
+=== 0.0.1 2006-12-13
+* Initial release of the Ruby Gem.  This includes the version of the library exactly as provided by 
+  Amazon Web Services as example code.  No changes or enhancements to that code were made other than 
+  packaging it as a Ruby Gem.
+* RubyForge project created.  http://amazon-ec2.rubyforge.org

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Glenn Rempe
+
+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/Manifest.txt

@@ -1,9 +1,9 @@
+examples/ec2-example.rb
 History.txt
+License.txt
 Manifest.txt
 README.txt
-CHANGELOG.txt
 Rakefile
-setup.rb
 lib/EC2.rb
 lib/EC2/version.rb
 lib/EC2/responses.rb
@@ -12,9 +12,13 @@ lib/EC2/instances.rb
 lib/EC2/keypairs.rb
 lib/EC2/image_attributes.rb
 lib/EC2/security_groups.rb
-
-test/test_ec2.rb
+scripts/txt2html
+setup.rb
+test/test_EC2.rb
 test/test_helper.rb
 test/test_responses.rb
-
-examples/ec2-example.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/Rakefile

@@ -8,6 +8,7 @@ require 'rake/rdoctask'
 require 'rake/contrib/rubyforgepublisher'
 require 'fileutils'
 require 'hoe'
+
 include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'EC2', 'version')
 
@@ -15,21 +16,48 @@ AUTHOR = ["Amazon Web Services LLC", "Glenn Rempe"]  # can also be an array of A
 EMAIL = "grempe@rubyforge.org"
 DESCRIPTION = "An interface library that allows Ruby or Ruby on Rails applications to easily connect to the HTTP 'Query API' for the Amazon Web Services Elastic Compute Cloud (EC2) and manipulate server instances."
 GEM_NAME = "amazon-ec2" # what ppl will type to install your gem
-RUBYFORGE_PROJECT = "amazon-ec2" # The unix name for your project
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'amazon-ec2' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
 
-
 NAME = "amazon-ec2"
-REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (EC2::VERSION::STRING + (REV ? ".#{REV}" : ""))
-CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "AWS EC2 documentation",
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = EC2::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'Amazon EC2 documentation',
     "--opname", "index.html",
     "--line-numbers", 
     "--main", "README.txt",
     "--inline-source"]
 
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 hoe = Hoe.new(GEM_NAME, VERS) do |p|
@@ -41,17 +69,64 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.summary = DESCRIPTION
   p.url = HOMEPATH
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/*_test.rb"]
+  p.test_globs = ["test/**/test_*.rb"]
   p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
   
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
   p.spec_extras = {
-    :extra_rdoc_files => ["README.txt", "History.txt", "CHANGELOG.txt"],
+    :extra_rdoc_files => ["README.txt", "History.txt"],
     :rdoc_options => RDOC_OPTS,
     :autorequire => "EC2"
   }
   
-  # == Optional
-  #p.changes        - A description of the release's latest changes.
-  #p.extra_deps     - An array of rubygem dependencies.
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
 end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+

data/examples/ec2-example.rb

@@ -23,6 +23,9 @@ SECURITY_GROUP_NAME = "ec2-example-rb-test-group"
 
 conn = EC2::AWSAuthConnection.new(AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
 
+puts "----- GEM Version -----"
+puts EC2::VERSION::STRING
+
 puts "----- listing images -----"
 puts conn.describe_images()
 

data/lib/EC2.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/image_attributes.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/images.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/instances.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/keypairs.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/responses.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/security_groups.rb

@@ -1,6 +1,6 @@
 # Amazon Web Services EC2 Query API Ruby Library
 # This library has been packaged as a Ruby Gem 
-# by Glenn Rempe ( glenn @nospam@ elasticworkbench.com ).
+# by Glenn Rempe ( grempe @nospam@ rubyforge.org ).
 # 
 # Source code and gem hosted on RubyForge
 # under the Ruby License as of 12/14/2006:

data/lib/EC2/version.rb

@@ -2,7 +2,7 @@ module EC2 #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 7 
+    TINY  = 8
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/scripts/txt2html

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/EC2/version.rb'
+
+version  = EC2::VERSION::STRING
+download = 'http://rubyforge.org/projects/amazon-ec2'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</
>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)