@@ -1,2 +1 @@ pkg/* - .gitignore @@ -43,10 +43,10 @@ Now it looks like: require 'xmlsimple' unless defined? XmlSimple === 0.2.3 2007-07-06 - * Updated gem to work with new official release of AWS API version 2007-03-01 which occurred + * Updated gem to work with new official release of AWS API version 2007-03-01 which occurred on July 6, 2007. - * Added support for primary new feature which supports Paid AMI's and the product codes - associated with them. Modified several methods to support this change, updated the test + * Added support for primary new feature which supports Paid AMI's and the product codes + associated with them. Modified several methods to support this change, updated the test cases, and added a new method EC2#confirm_product_instance. === 0.2.2 2007-07-03 @@ -57,47 +57,47 @@ === 0.2.0 2007-07-03 - * MAJOR library changes : THESE CHANGES ARE NOT BACKWARD COMPATIBLE!! You will need to update - the way in which you make calls, handle responses, and rescue exceptions from this library. - If you prefer not to make these changes you can feel free to continue to use the older version + * MAJOR library changes : THESE CHANGES ARE NOT BACKWARD COMPATIBLE!! You will need to update + the way in which you make calls, handle responses, and rescue exceptions from this library. + If you prefer not to make these changes you can feel free to continue to use the older version of the gem. These older versions however will no longer be maintained. - + * MAJOR refactoring of how methods calls are made. Now all methods are called with a simple hash of arguments and none of them are positional. This feels much more "Ruby'ish". - - * MAJOR refactoring of how responses are returned to users. No longer do you have to call the - .parse method, and no longer are you getting back simple arrays of information. Responses - now come in the form of OpenStruct objects that contain all of the data for an object in + + * MAJOR refactoring of how responses are returned to users. No longer do you have to call the + .parse method, and no longer are you getting back simple arrays of information. Responses + now come in the form of OpenStruct objects that contain all of the data for an object in Enumerable form so you can use iterators (.each, .each_pair, etc). All methods return an EC2::Response object which inherits from OpenStruct. The return data from EC2, which is in XML form, is parsed with XmlSimple and is used to directly construct the return data structure. This allows us to know with some confidence that the data structure returned from AWS will always be consistent - with this library's responses. There is also an .xml attribute for each response object that lets you + with this library's responses. There is also an .xml attribute for each response object that lets you see the full and complete XML response from AWS if that is useful to you. - + * Added an exception framework which will now throw appropriate Ruby exceptions that match those handed to us by Amazon EC2. ArgumentError exceptions will also - be thrown if you are making calls we know to be illegal or malformed. You should rescue - these exceptions in your application instead of parsing text responses. All exceptions + be thrown if you are making calls we know to be illegal or malformed. You should rescue + these exceptions in your application instead of parsing text responses. All exceptions descend from EC2::Error. You can see them all in exceptions.rb in the gem install. - + * Added a full suite of test/spec unit tests which currently cover 100% of the public methods - in this library. We have abot 92% code coverage according to rcov. This has greatly enhanced - the reliability of the library as well as our confidence in the code. - We used to have 0% test coverage. :-/ - + in this library. We have abot 92% code coverage according to rcov. This has greatly enhanced + the reliability of the library as well as our confidence in the code. + We used to have 0% test coverage. :-/ + * Added an EC2 command shell : 'ec2sh' which can be called from anywhere and gives you - an interactive irb session with an EC2 connection pre-made for you as @ec2. You can use this - to interactively execute any command on EC2 that this library supports. Try @ec2.methods.sort + an interactive irb session with an EC2 connection pre-made for you as @ec2. You can use this + to interactively execute any command on EC2 that this library supports. Try @ec2.methods.sort or @ec2.describe_images to test it out. You must first setup two shell environment variables which contain your ACCESS_KEY_ID and SECRET_ACCESS_KEY for this to work. Otherwise an error - will be thrown when you try to start it. This is way cool and shamelessly borrowed from + will be thrown when you try to start it. This is way cool and shamelessly borrowed from Marcel Molina's fine AWS::S3 library. - + * Updated API version in the query API request to 2007-01-19, and added all known method calls - in this version of the API to the gem (including reboot, viewing console output, NAT addressing + in this version of the API to the gem (including reboot, viewing console output, NAT addressing and more!) - + * Removed .parse method as it is no longer needed or wanted. * Removed 'verbose' attribute writer and a couple of related debug 'puts' calls in EC2.rb. @@ -119,43 +119,43 @@ * 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 + + 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 + + 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 + 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 + + 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% + + 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 + + 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: --- @@ -165,9 +165,9 @@ require 'rubygems' require_gem 'amazon-ec2' require 'getoptlong' - puts Base64.encode64 + puts Base64.encode64 ("012345678901234567890123456789012345678901234567890123456789") - + [randyb@master randyb] /tmp/foo.rb MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0 NTY3ODkwMTIzNDU2Nzg5 @@ -178,28 +178,28 @@ === 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 + * 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 + * 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. + * 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 + * 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 + 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 @@ -209,23 +209,23 @@ === 0.0.3 2006-12-16 - * API CHANGE : Changed method name 'authorize' to 'authorize_security_group_ingress' to ensure consistent + * 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. + * 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 + * 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. @@ -237,7 +237,7 @@ === 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 + * 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 CHANGELOG @@ -27,4 +27,3 @@ Rake::RDocTask.new do |rd| rd.rdoc_dir = 'doc' rd.options = spec.rdoc_options end - Rakefile @@ -15,9 +15,9 @@ require 'pp' # pull these from the local shell environment variables set in ~/.bash_login # or using appropriate methods specific to your login shell. -# +# # e.g. in ~/.bash_login -# +# # # For amazon-ec2 and amazon s3 ruby gems # export AMAZON_ACCESS_KEY_ID="FOO" # export AMAZON_SECRET_ACCESS_KEY="BAR" @@ -38,7 +38,7 @@ p ec2.methods.sort puts "----- listing images owned by 'amazon' -----" ec2.describe_images(:owner_id => "amazon").imagesSet.item.each do |image| image.keys.each do |key| - puts "#{key} => #{image[key]}" + puts "#{key} => #{image[key]}" end end @@ -56,4 +56,3 @@ pp ec2.delete_security_group(:group_name => "ec2-example-rb-test-group") puts "----- listing my keypairs (verbose mode) -----" pp ec2.describe_keypairs() - bin/ec2-gem-example.rb @@ -10,10 +10,10 @@ #++ if ENV['AMAZON_ACCESS_KEY_ID'] && ENV['AMAZON_SECRET_ACCESS_KEY'] - @ec2 = EC2::Base.new( + @ec2 = EC2::Base.new( :access_key_id => ENV['AMAZON_ACCESS_KEY_ID'], - :secret_access_key => ENV['AMAZON_SECRET_ACCESS_KEY'] + :secret_access_key => ENV['AMAZON_SECRET_ACCESS_KEY'] ) end -include EC2 +include EC2 bin/setup.rb @@ -14,8 +14,8 @@ module EC2 #Amazon Developer Guide Docs: # - # The DescribeAvailabilityZones operation describes availability zones that are currently - # available to the account and their states. + # The DescribeAvailabilityZones operation describes availability zones that are currently + # available to the account and their states. # # An optional list of zone names can be passed. # @@ -39,4 +39,3 @@ module EC2 end end end - lib/EC2/availability_zones.rb @@ -41,4 +41,4 @@ module EC2 end end -end \ No newline at end of file +end lib/EC2/console.rb @@ -40,4 +40,4 @@ module EC2 end end -end \ No newline at end of file +end lib/EC2/products.rb @@ -49,13 +49,13 @@ module EC2 :xml => "", :parse_options => { 'ForceArray' => ['item'], 'SuppressEmpty' => nil } }.merge(options) - + # NOTE: Parsing the response as a nested set of Response objects was extremely # memory intensive and appeared to leak (the memory was not freed on subsequent requests). # It was changed to return the raw XmlSimple response. - + response = XmlSimple.xml_in(options[:xml], options[:parse_options]) - + return response end lib/EC2/responses.rb @@ -34,7 +34,7 @@ module EC2 return response_generator(:action => "DescribeSnapshots", :params => params) end - + #Amazon Developer Guide Docs: # # The CreateSnapshot operation creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to launch instances from identical snapshots, and to save data before shutting down an instance. @@ -47,12 +47,12 @@ module EC2 # # none # - + def create_snapshot( options = {} ) # defaults options = { :volume_id => '' }.merge(options) - + raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty? params = { @@ -60,9 +60,9 @@ module EC2 } return response_generator(:action => "CreateSnapshot", :params => params) - + end - + #Amazon Developer Guide Docs: # # The DeleteSnapshot operation deletes a snapshot of an Amazon EBS volume that is stored in Amazon S3. @@ -75,11 +75,11 @@ module EC2 # # none # - + def delete_snapshot( options = {} ) options = { :snapshot_id => '' }.merge(options) - + raise ArgumentError, "No :snapshot_id provided" if options[:snapshot_id].nil? || options[:snapshot_id].empty? params = { @@ -87,9 +87,8 @@ module EC2 } return response_generator(:action => "DeleteSnapshot", :params => params) - + end - + end end - lib/EC2/snapshots.rb @@ -34,7 +34,7 @@ module EC2 return response_generator(:action => "DescribeVolumes", :params => params) end - + #Amazon Developer Guide Docs: # # The CreateVolume operation creates a new Amazon EBS volume that you can mount from any Amazon EC2 instance. @@ -48,14 +48,14 @@ module EC2 # :size => String (default : '') # :snapshot_id => String (default : '') # - + def create_volume( options = {} ) # defaults options = { :availability_zone => '' }.merge(options) - + raise ArgumentError, "No :availability_zone provided" if options[:availability_zone].nil? || options[:availability_zone].empty? - + options = { :size => '' }.merge(options) options = { :snapshot_id => '' }.merge(options) @@ -66,9 +66,9 @@ module EC2 } return response_generator(:action => "CreateVolume", :params => params) - + end - + #Amazon Developer Guide Docs: # # The DeleteVolume operation deletes an Amazon EBS volume. @@ -81,11 +81,11 @@ module EC2 # # none # - + def delete_volume( options = {} ) options = { :volume_id => '' }.merge(options) - + raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty? params = { @@ -93,9 +93,9 @@ module EC2 } return response_generator(:action => "DeleteVolume", :params => params) - + end - + #Amazon Developer Guide Docs: # # The AttachVolume operation attaches an Amazon EBS volume to an instance. @@ -110,17 +110,17 @@ module EC2 # # none # - + def attach_volume( options = {} ) options = { :volume_id => '' }.merge(options) options = { :instance_id => '' }.merge(options) options = { :device => '' }.merge(options) - + raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty? raise ArgumentError, "No :instance_id provided" if options[:instance_id].nil? || options[:instance_id].empty? raise ArgumentError, "No :volume_id provided" if options[:device].nil? || options[:device].empty? - + params = { "VolumeId" => options[:volume_id], "InstanceId" => options[:instance_id], @@ -128,9 +128,9 @@ module EC2 } return response_generator(:action => "AttachVolume", :params => params) - + end - + #Amazon Developer Guide Docs: # # The DetachVolume operation detaches an Amazon EBS volume from an instance. @@ -145,17 +145,17 @@ module EC2 # :device => String (default : '') # :force => Boolean (default : '') # - + def detach_volume( options = {} ) options = { :volume_id => '' }.merge(options) - + raise ArgumentError, "No :volume_id provided" if options[:volume_id].nil? || options[:volume_id].empty? - + options = { :instance_id => '' }.merge(options) options = { :device => '' }.merge(options) options = { :force => '' }.merge(options) - + params = { "VolumeId" => options[:volume_id], "InstanceId" => options[:instance_id], @@ -164,8 +164,7 @@ module EC2 } return response_generator(:action => "DetachVolume", :params => params) - + end end end - lib/EC2/volumes.rb @@ -28,7 +28,7 @@ context "EC2 availability zones" do </item> </availabilityZoneInfo> </DescribeAvailabilityZonesResponse> - RESPONSE + RESPONSE end test/test_EC2_availability_zones.rb @@ -51,4 +51,4 @@ context "The EC2 console " do end -end \ No newline at end of file +end test/test_EC2_console.rb @@ -235,4 +235,4 @@ context "EC2 image_attributes " do end -end \ No newline at end of file +end test/test_EC2_image_attributes.rb @@ -30,7 +30,7 @@ context "EC2 instances " do <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> - <name>pending</name> + <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> @@ -44,7 +44,7 @@ context "EC2 instances " do <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> - <name>pending</name> + <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> @@ -58,7 +58,7 @@ context "EC2 instances " do <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> - <name>pending</name> + <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> test/test_EC2_instances.rb @@ -45,4 +45,4 @@ context "An EC2 instance " do end -end \ No newline at end of file +end test/test_EC2_products.rb @@ -17,4 +17,3 @@ } require File.dirname(__FILE__) + '/../lib/EC2' - test/test_helper.rb 5e79febd4129b3b92335f99d699a1fca4c19c528 Glenn Rempe glenn@rempe.us http://github.com/grempe/amazon-ec2/commit/b353b03e8a7d081b3dc370502075ddeecd9d05c9 b353b03e8a7d081b3dc370502075ddeecd9d05c9 2008-08-24T11:43:03-07:00 2008-08-24T11:43:03-07:00 sake strip e677c0f502d7142bfab293081060c9de5599fd21 Glenn Rempe glenn@rempe.us