amazon-ec2 0.3.2 → 0.3.4

data/CHANGELOG

@@ -1,3 +1,10 @@
+=== 0.3.4 2009-01-31
+ * Added support in the helper binaries for EC2_URL server url for Euro servers
+
+=== 0.3.3 2009-01-24
+  * Removed docs related to the ability to get Response#xml which is deprecated
+  * Fixed conflict when aws/s3 gem was included in user code
+
 === 0.3.2 2008-12-11
  * Updated API version to 2008-12-01
  * Note : The new European EC2 zone should just work if you specify ':server => "eu-west-1.ec2.amazonaws.com"' when initializing EC2::Base.new().  Please report any issues you have with using this new service.

data/README.rdoc

@@ -74,6 +74,12 @@ Edit the file ~/.bash_login and add the following to the existing contents:
   export AMAZON_ACCESS_KEY_ID="YOUR_ACCESS_KEY_ID"
   export AMAZON_SECRET_ACCESS_KEY="YOUR_SECRET_ACCESS_KEY_ID"
 
+If you are using EC2 in the EU region, make sure you also set:
+
+  export EC2_URL="https://eu-west-1.ec2.amazonaws.com"
+
+(which you have already if you configured standard EC2 command line tools to work with this region).
+
 Once you save the file you should close and re-open your terminal so the new variables are made available. You’ll need to do this close/re-open step for each terminal window you have open (or issue the ‘source ~/.bash_login’ command in each). Make sure that this file is only readable by your user so you don’t inadvertently expose your credentials to other users on your system.
 
 You can verify that this setup is complete by running the ‘set’ in a command window and seeing that your credentials are in the list of shell variables.
@@ -141,12 +147,6 @@ If you're not in front of a terminal shell now (perhaps you’re browsing this s
         >> @ec2.describe_images.imagesSet.item[0] (an OpenStruct of a single item in that array)
         >> @ec2.describe_images.imagesSet.item[0].to_s (a String representation of that OpenStruct item)
 
-        returns : an XML representation of all images
-        >> puts @ec2.describe_images.xml
-
-        returns : an XML representation of all images owned by Amazon
-        >> puts @ec2.describe_images(:owner_id => 'amazon').xml
-
   >> @ec2.describe_images.imagesSet.item[0].to_s
   => "#<EC2::Response:0x100A465B4 imageId=\"ami-018e6b68\" imageLocation=\"rbuilder-online/phonehome-1.5.6-x86_10132.img.manifest.xml\" imageOwnerId=\"099034111737\" imageState=\"available\" isPublic=\"true\" parent=#<EC2::Response:0x100A469A6 ...>>"
 
@@ -240,10 +240,7 @@ Try out the following bit of code. This should walk through each image returned
 
 === Important notes regarding the structure of EC2::Response Objects
 
-One of the key benefits of this new version of the library is that all responses from EC2 are bundled up in a real data structure and no longer require parsing of text. EC2::Response inherits from the OpenStruct class and we populate it directly from the XML given to us by EC2 in response to any command we issue. This means that future changes to the API and what is returned by EC2 will largely be handled transparently by the gem. This is a huge benefit. What this means though, is that you may have to do a little homework on what actually gets returned by EC2 as XML. For example, when you make a #describe_images call in 'ec2sh' what you will get back will look like:
-
-  $ ec2sh
-  >> puts @ec2.describe_images(:owner_id => 'amazon').xml
+One of the key benefits of this new version of the library is that all responses from EC2 are bundled up in a real data structure and no longer require parsing of text. The hash returned is populated directly from the XML given to us by EC2 in response to any command we issue. This means that future changes to the API and what is returned by EC2 will largely be handled transparently by the gem. This is a huge benefit. What this means though, is that you may have to do a little homework on what actually gets returned by EC2 as XML. For example, when you make a #describe_images call in 'ec2sh' what AWS returns behind the scenes looks like:
 
   <?xml version="1.0"?>
   <DescribeImagesResponse xmlns="http://ec2.amazonaws.com/doc/2007-01-19/">
@@ -293,14 +290,14 @@ One of the key benefits of this new version of the library is that all responses
       </imagesSet>
   </DescribeImagesResponse>
 
-You can see in the XML the structure that you will need to follow when constructing queries for information and parsing responses from EC2.
+You can see here the XML the structure that you will need to follow when constructing queries for information and parsing responses from EC2.
 
 So, for example, if you wanted to get the image ID of the third image listed in the response above you would need to do:
 
   >> puts @ec2.describe_images(:owner_id => 'amazon').imagesSet.item[2].imageId
   ami-23b6534a
 
-EC2 will typically return sets of things (imagesSet, reservationSet, etc.) which we map to ruby Arrays (.imagesSet.item in the example above). If you want to iterate over a response set you will need to iterate over this array. The Arrays will typically contain additional EC2::Response objects that represent each individual item. You’ll find that you can use the 'ec2sh' to help you understand the structure more completely if you try issuing commands there as a way to practice seeing what will be returned and making sure you get exactly what you want. You can always call the EC2::Response#xml method like I did above to see the exact XML returned which allows you to easily derive the structure for the Ruby OpenStruct object.
+EC2 will typically return sets of things (imagesSet, reservationSet, etc.) which we map to ruby Arrays (.imagesSet.item in the example above). If you want to iterate over a response set you will need to iterate over this array. The Arrays will typically contain additional EC2::Response objects that represent each individual item. You’ll find that you can use the 'ec2sh' to help you understand the structure more completely if you try issuing commands there as a way to practice seeing what will be returned and making sure you get exactly what you want.
 
 
 == Additional Resources

data/Rakefile

@@ -11,8 +11,9 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
+desc "Package and then install the gem locally"
 task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM}-#{VERSION}}
+  sh %{sudo gem install pkg/#{GEM}-#{VER}}
 end
 
 Rake::TestTask.new do |t|

data/bin/ec2sh

@@ -9,15 +9,15 @@
 # Home::      http://github.com/grempe/amazon-ec2/tree/master
 #++
 
-# CREDITS : Credit for this bit of shameful ripoff coolness 
+# CREDITS : Credit for this bit of shameful ripoff coolness
 # goes to Marcel Molina and his AWS::S3 gem.  Thanks!
 
-# Usage : running this starts up an irb session and 
+# Usage : running this starts up an irb session and
 # sets up the connection to EC2 as a class variable called
-# '@ec2'.  So just do something like the following on the 
+# '@ec2'.  So just do something like the following on the
 # shell command line:
 
-#   macbook-pro:~ glenn$ ec2sh 
+#   macbook-pro:~ glenn$ ec2sh
 #   >> @ec2.describe_images
 #   => [#<EC2::Item image_location...
 
@@ -26,46 +26,35 @@ setup = File.dirname(__FILE__) + '/setup'
 irb_name = RUBY_PLATFORM =~ /mswin32/ ? 'irb.bat' : 'irb'
 
 if ( ENV['AMAZON_ACCESS_KEY_ID'] && ENV['AMAZON_SECRET_ACCESS_KEY'] )
-  
+
   welcome_message = <<-MESSAGE
-  
+
   'ec2sh' usage :
-  This is an interactive 'irb' command shell that allows you to use all 
+  This is an interactive 'irb' command shell that allows you to use all
   commands available to the amazon-ec2 gem.  You'll find this to be a
   great tool to help you debug issues and practice running commands
   against the live EC2 servers prior to putting them in your code.
-  
-  The EC2 connection is wired to the class instance '@ec2'.  Make method calls 
-  on this to execute commands on EC2.  Adding a #to_s 
+
+  The EC2 connection is wired to the class instance '@ec2'.  Make method calls
+  on this to execute commands on EC2.  Adding a #to_s
   at the end of any command should give you a full String representation of the
-  response.  The #xml data is available for each response
-  which allows you to view the full and complete XML response returned by
-  EC2 without any parsing applied.  This is useful for viewing the 
-  hierarchy of an entire response in a friendly way (if XML is friendly
-  to you!).  Understanding the hierarchy of the XML response is critical
-  to making effective use of this library.
-    
+  response.
+
     Examples to try:
-      
+
       returns : all ec2 public methods
       >> @ec2.methods.sort
-      
+
       returns : a string representation of ALL images
       >> @ec2.describe_images.to_s
-      
+
       returns : an Array of EC2::Response objects, each an EC2 image and its data
       >> @ec2.describe_images.imagesSet.item
       >> @ec2.describe_images.imagesSet.item[0] (an OpenStruct of a single item in that array)
       >> @ec2.describe_images.imagesSet.item[0].to_s (a String representation of that OpenStruct item)
-      
-      returns : an XML representation of all images
-      >> puts @ec2.describe_images.xml
-      
-      returns : an XML representation of all images owned by Amazon
-      >> puts @ec2.describe_images(:owner_id => 'amazon').xml
-    
+
   MESSAGE
-  
+
   puts welcome_message
   exec "#{irb_name} -r #{ec2_lib} -r #{setup} --simple-prompt"
 else

data/bin/setup.rb

@@ -10,10 +10,17 @@
 #++
 
 if ENV['AMAZON_ACCESS_KEY_ID'] && ENV['AMAZON_SECRET_ACCESS_KEY']
-  @ec2 = EC2::Base.new(
+  opts = {
     :access_key_id => ENV['AMAZON_ACCESS_KEY_ID'],
     :secret_access_key => ENV['AMAZON_SECRET_ACCESS_KEY']
-  )
+  }
+  if ENV['EC2_URL']
+    opts[:server] = URI.parse(ENV['EC2_URL']).host
+  end
+  @ec2 = EC2::Base.new(opts)
 end
 
+puts "Current Options:"
+pp opts
+
 include EC2

data/lib/EC2.rb

@@ -28,12 +28,24 @@ module EC2
   # from the query string to be signed.
   #   Note:  The parameters in the path passed in must already be sorted in
   #   case-insensitive alphabetical order and must not be url encoded.
-  def EC2.canonical_string(path)
-    buf = ""
-    path.split('&').each { |field|
-      buf << field.gsub(/\&|\?/,"").sub(/=/,"")
-    }
-    return buf
+  def EC2.canonical_string(params, host = DEFAULT_HOST, method="POST", base="/")
+    # Sort, and encode parameters into a canonical string.
+    sorted_params = params.sort {|x,y| x[0] <=> y[0]}
+    encoded_params = sorted_params.collect do |p|
+      encoded = (CGI::escape(p[0].to_s) + 
+                 "=" + CGI::escape(p[1].to_s))
+      # Ensure spaces are encoded as '%20', not '+'
+      encoded.gsub('+', '%20')
+    end
+    sigquery = encoded_params.join("&")
+
+    # Generate the request description string
+    req_desc = 
+      method + "\n" + 
+      host + "\n" + 
+      base + "\n" + 
+      sigquery
+
   end
 
   # Encodes the given string with the secret_access_key, by taking the
@@ -44,7 +56,7 @@ module EC2
     digest = OpenSSL::Digest::Digest.new('sha1')
     b64_hmac =
       Base64.encode64(
-        OpenSSL::HMAC.digest(digest, secret_access_key, str)).strip
+        OpenSSL::HMAC.digest(digest, secret_access_key, str)).gsub("\n","")
 
     if urlencode
       return CGI::escape(b64_hmac)
@@ -152,14 +164,13 @@ module EC2
           params.reject! { |key, value| value.nil? or value.empty?}
 
           params.merge!( {"Action" => action,
-                          "SignatureVersion" => "1",
+                          "SignatureVersion" => "2",
+                          "SignatureMethod" => 'HmacSHA1',
                           "AWSAccessKeyId" => @access_key_id,
                           "Version" => API_VERSION,
                           "Timestamp"=>Time.now.getutc.iso8601} )
 
-          sigquery = params.sort_by { |param| param[0].downcase }.collect { |param| param.join("=") }.join("&")
-
-          sig = get_aws_auth_param(sigquery, @secret_access_key)
+          sig = get_aws_auth_param(params, @secret_access_key)
 
           query = params.sort.collect do |param|
             CGI::escape(param[0]) + "=" + CGI::escape(param[1])
@@ -182,8 +193,8 @@ module EC2
       end
 
       # Set the Authorization header using AWS signed header authentication
-      def get_aws_auth_param(path, secret_access_key)
-        canonical_string =  EC2.canonical_string(path)
+      def get_aws_auth_param(params, secret_access_key)
+        canonical_string =  EC2.canonical_string(params)
         encoded_canonical = EC2.encode(secret_access_key, canonical_string)
       end
 

data/lib/EC2/responses.rb

@@ -47,7 +47,7 @@ module EC2
     def self.parse(options = {})
       options = {
         :xml => "",
-        :parse_options => { 'ForceArray' => ['item'], 'SuppressEmpty' => nil }
+        :parse_options => { 'forcearray' => ['item'], 'suppressempty' => nil, 'keeproot' => false }
       }.merge(options)
 
       # NOTE: Parsing the response as a nested set of Response objects was extremely

data/test/test_EC2.rb

@@ -39,9 +39,9 @@ context "The EC2 method " do
   end
 
 
-  specify "EC2.canonical_string(path) should data that is stripped of ?,&,= " do
-    path = "?name1=value1&name2=value2&name3=value3"
-    EC2.canonical_string(path).should.equal "name1value1name2value2name3value3"
+  specify "EC2.canonical_string(path) should conform to Amazon's requirements " do
+    path = {"name1" => "value1", "name2" => "value2", "name3" => "value3"}
+    EC2.canonical_string(path).should.equal "POST\nec2.amazonaws.com\n/\nname1=value1&name2=value2&name3=value3"
   end
 
   specify "EC2.encode should return the expected string" do

data/test/test_EC2_instances.rb

@@ -91,13 +91,13 @@ context "EC2 instances " do
                 <name>running</name>
               </instanceState>
               <privateDnsName>domU-12-31-35-00-1E-01.z-2.compute-1.internal</privateDnsName>
-        <dnsName>ec2-72-44-33-4.z-2.compute-1.amazonaws.com</dnsName>
+              <dnsName>ec2-72-44-33-4.z-2.compute-1.amazonaws.com</dnsName>
               <keyName>example-key-name</keyName>
               <productCodesSet>
                 <item><productCode>774F4FF8</productCode></item>
               </productCodesSet>
               <instanceType>m1.small</instanceType>
-        <launchTime>2007-08-07T11:54:42.000Z</launchTime>
+              <launchTime>2007-08-07T11:54:42.000Z</launchTime>
             </item>
           </instancesSet>
         </item>

data/test/test_EC2_s3_xmlsimple.rb

@@ -0,0 +1,80 @@
+#--
+# Amazon Web Services EC2 Query API Ruby library
+#
+# Ruby Gem Name::  amazon-ec2
+# Author::    Glenn Rempe  (mailto:glenn@rempe.us)
+# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
+# License::   Distributes under the same terms as Ruby
+# Home::      http://github.com/grempe/amazon-ec2/tree/master
+#++
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+# NOTE : These tests exercise amazon-ec2 when used with the aws/s3 gem
+# which was demonstrating some breaking behavior.  The fix was to
+# add the XmlSimple option "'keeproot' => false" in responses.rb
+
+context "EC2 aws-s3 compat test" do
+
+  setup do
+    @ec2 = EC2::Base.new( :access_key_id => "not a key", :secret_access_key => "not a secret" )
+
+    @describe_instances_response_body = <<-RESPONSE
+    <DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2007-08-29">
+      <reservationSet>
+        <item>
+          <reservationId>r-44a5402d</reservationId>
+          <ownerId>UYY3TLBUXIEON5NQVUUX6OMPWBZIQNFM</ownerId>
+          <groupSet>
+            <item>
+              <groupId>default</groupId>
+            </item>
+          </groupSet>
+          <instancesSet>
+            <item>
+              <instanceId>i-28a64341</instanceId>
+              <imageId>ami-6ea54007</imageId>
+              <instanceState>
+                <code>0</code>
+                <name>running</name>
+              </instanceState>
+              <privateDnsName>domU-12-31-35-00-1E-01.z-2.compute-1.internal</privateDnsName>
+              <dnsName>ec2-72-44-33-4.z-2.compute-1.amazonaws.com</dnsName>
+              <keyName>example-key-name</keyName>
+              <productCodesSet>
+                <item><productCode>774F4FF8</productCode></item>
+              </productCodesSet>
+              <instanceType>m1.small</instanceType>
+              <launchTime>2007-08-07T11:54:42.000Z</launchTime>
+            </item>
+          </instancesSet>
+        </item>
+      </reservationSet>
+    </DescribeInstancesResponse>
+    RESPONSE
+
+ end
+
+ specify "should be able to be described and return the correct Ruby response class" do
+   @ec2.stubs(:make_request).with('DescribeInstances', {}).
+     returns stub(:body => @describe_instances_response_body, :is_a? => true)
+   @ec2.describe_instances.should.be.an.instance_of Hash
+   response = @ec2.describe_instances
+   response.reservationSet.item[0].reservationId.should.equal "r-44a5402d"
+ end
+
+ specify "should be able to be described and return the correct Ruby response class when the aws/s3 lib is required" do
+   begin
+     require 'aws/s3s'
+     @ec2.stubs(:make_request).with('DescribeInstances', {}).
+       returns stub(:body => @describe_instances_response_body, :is_a? => true)
+     @ec2.describe_instances.should.be.an.instance_of Hash
+     response = @ec2.describe_instances
+     response.reservationSet.item[0].reservationId.should.equal "r-44a5402d"
+   rescue LoadError
+     # do nothing.  no aws/s3 gem installed to test against
+   end
+ end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: amazon-ec2
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors: 
 - Glenn Rempe
@@ -9,7 +9,7 @@ autorequire: EC2
 bindir: bin
 cert_chain: []
 
-date: 2008-12-11 00:00:00 -08:00
+date: 2009-01-31 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,6 +113,7 @@ test_files:
 - test/test_EC2_keypairs.rb
 - test/test_EC2_products.rb
 - test/test_EC2_responses.rb
+- test/test_EC2_s3_xmlsimple.rb
 - test/test_EC2_security_groups.rb
 - test/test_EC2_snapshots.rb
 - test/test_EC2_volumes.rb