ec2-signature 0.0.4 → 0.0.5

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+lib/sample.rb

data/README

@@ -1,6 +1,6 @@
 Code borrowed from fog (https://github.com/geemus/fog).
 
-This gem will simply generate the AWS EC2 signature so that you can use your own HTTP methods and libraries to POST to your choice of AWS/EC2 compatible API servers such as Eucalyptus, OpenNebula, OpenAuth.  Apparently, most of the AWS/EC2 API gems out there are not compatible with the aforementioned cloud frameworks, due to running on a custom port they do not account for that when generating the signature.  Fog had implemented a compatible signature method, however, I did not want to use the EXCON http library implemented in it so I extracted the signature method only for use with my own choice of HTTP library.
+This gem will simply generate the AWS EC2 signature so that you can use your own HTTP methods and libraries to POST/GET to your choice of AWS/EC2 compatible API servers such as Eucalyptus, OpenNebula, OpenStack.  Apparently, most of the AWS/EC2 API gems out there are not compatible with the aforementioned cloud frameworks, due to running on a custom port they do not account for that when generating the signature.  Fog had implemented a compatible signature method, however, I did not want to use the EXCON http library implemented in it so I extracted the signature method only for use with my own choice of HTTP library.
 
 ##############################
 ####  OpenStack Example 1 ####
@@ -13,11 +13,11 @@ mysig = EC2Signature.new( {
             :awssecretkey => '1380adj13j43jklj32a',
             :ec2url => 'http://myec2server:8773/services/Cloud'
           } )
-# generate the signature provided the query action you want to issue to your ec2 provider
+# to generate a signature only, provide the query action you want to issue to your ec2 provider
 mysig.sign 'DescribeImages'
 signature = mysig.signature
-# use the example net/http post method to post your signature to the ec2_url specified above
-mysig.submit 
+# OR use the example net/http post method to post your signature to the ec2_url specified above
+mysig.submit 'DescribeImages'   # will parse the xml body and return a data hash
 
 
 ##############################
@@ -25,5 +25,8 @@ mysig.submit
 ##############################
 # opennebula's aws/ec2 api implementation has a diff path for admin cmds
 mysig.path = '/services/Admin'
-signature = mysig.sign 'DescribeUser', {'Name' => 'jsmith', }
-mysig.submit
+# generate only the signature if you want:
+mysig.sign 'DescribeUser', {'Name' => 'jsmith', }
+signature = mysig.signature
+# OR use the example net/http post method to post your signature to the ec2_url specified above
+mysig.submit 'DescribeUser', {'Name' => 'jsmith', }

data/lib/ec2-signature.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'openssl'
 require 'base64'
 require 'cgi'
+require 'net/http'
 
 class EC2Signature
 
@@ -25,7 +26,7 @@ class EC2Signature
     self.method = method
   end
 
-  def sign action='DescribeInstances', actionparams={}
+  def sign action='DescribeInstances', actionparams={}, timestamp=Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
     raise 'actionparams needs to be a Hash' unless actionparams.kind_of?(Hash)
     # openstack requires project names added to end of awssecretkey to change project context
     newaccessid = ( project ? awsaccessid+':'+project : awsaccessid )
@@ -34,7 +35,7 @@ class EC2Signature
       'AWSAccessKeyId'    => newaccessid,
       'SignatureMethod'   => 'HmacSHA256',
       'SignatureVersion'  => '2',
-      'Timestamp'         => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
+      'Timestamp'         => timestamp,
       'Version'           => '2010-08-31'
     })
 
@@ -52,14 +53,15 @@ class EC2Signature
     self
   end
 
-  def submit signature=signature
-    require 'net/http'
+  def submit action='DescribeInstances', actionparams={}, timestamp=Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"), raw=false
+    require 'crack' 
+    sign action, actionparams, timestamp
     http = Net::HTTP.new host, port
     resp = case method
-      when 'GET' then http.get path+'?'+signature
+      when 'GET' then http.get path.concat('?'+signature)
       when 'POST' then http.post path, signature
     end
-    resp.body
+    raw ? resp.body : Crack::XML.parse(resp.body)[action.concat('Response')]
   end
 
 end

data/lib/ec2-signature/version.rb

@@ -1,5 +1,5 @@
 module EC2
   module Signature
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/test/test_ec2_signature.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+require 'cgi'
+
+$creds = {:awsaccessid => 'abc123', :awssecretkey => '12i3jfae138', :ec2url => 'http://blah.com:112/some/yo'}
+$timestamp = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+
+describe EC2Signature do
+  describe '#new' do
+    it 'should accept :awsaccessid, :awssecretkey, :ec2url' do 
+      assert EC2Signature.new $creds
+    end
+    it 'should throw an error if missing :ec2url' do
+      tmpcreds = $creds.dup.delete :ec2url
+      proc { EC2Signature.new tmpcreds }.must_raise RuntimeError
+    end
+    it 'should throw an error if missing :awssecretkey' do
+      tmpcreds = $creds.dup.delete :awssecretkey
+      proc {EC2Signature.new tmpcreds }.must_raise RuntimeError
+    end
+     it 'should throw an error if missing :awsaccessid' do
+      tmpcreds = $creds.dup.delete :awsaccessid
+      proc {EC2Signature.new tmpcreds}.must_raise RuntimeError
+    end
+    it 'should create an EC2Signature class obj' do
+      EC2Signature.new($creds).must_be_kind_of EC2Signature
+    end
+    it 'should only allow GET or POST methods' do
+      proc {EC2Signature.new $creds, 'PUT' }.must_raise RuntimeError
+      assert EC2Signature.new $creds, 'GET'
+    end
+  end # describe '#new' do
+
+  describe 'the instance' do
+    before do 
+      @ec2 = EC2Signature.new $creds
+    end
+    it 'should have an :awsaccessid attribute' do
+      assert @ec2.awsaccessid
+      assert_equal @ec2.awsaccessid, $creds[:awsaccessid]
+    end
+    it 'should have an :awssecretkey attribute' do
+      assert_equal @ec2.awssecretkey, $creds[:awssecretkey]
+    end
+    it 'should have an :ec2url attribute' do
+      assert_equal @ec2.ec2url, $creds[:ec2url]
+    end
+    it 'should have a :host attribute parsed from the ec2url' do
+      assert_equal @ec2.host, 'blah.com'
+    end
+    it 'should have a :port attribute parsed from the ec2url' do
+      assert_equal @ec2.port, 112
+    end
+    it 'should have a :path attribute parsed from the ec2url' do 
+      assert_equal @ec2.path, '/some/yo'
+    end
+    it 'should have a :scheme attribute parsed from the ec2url' do 
+      assert_equal @ec2.scheme, 'http'
+    end
+    it 'should have a :method attribute and default value should be POST' do
+      assert_equal @ec2.method, 'POST'
+    end
+    it 'should start with a nil project' do
+      @ec2.project.must_be_nil
+    end
+    it 'should allow you to set a project' do
+      @ec2.project='testproject'.must_equal 'testproject'
+    end
+    it 'should start with a nil signature' do
+      @ec2.signature.must_be_nil
+    end
+  end # describe 'the instance' do
+
+  describe '#sign' do
+    before do 
+      @ec2 = EC2Signature.new $creds
+    end
+
+    it 'should require no args' do
+      @ec2.sign.must_be_kind_of EC2Signature
+      @ec2.signature.wont_be_nil
+    end
+    it 'should default to DescribeInstances action param' do
+      @ec2.sign.signature.must_match /Action=DescribeInstances/
+    end
+    it 'should allow custom ec2 action string' do
+      @ec2.sign('DescribeImages').signature.must_match /Action=DescribeImages/
+    end
+    it 'should allow custom ec2 action strings that have more than one query param' do
+      actionparams = {'Name' => 'ami1390'}
+      @ec2.sign('DescribeImage', actionparams).signature.must_match /Action=DescribeImage&Name=ami1390/
+    end
+    it 'should allow specify a timestamp' do
+      @ec2.sign('DescribeInstances',{},$timestamp).signature.must_match /Timestamp=#{CGI::escape $timestamp}/
+    end
+    it 'should return an ec2 compatible signature' do
+      known_timestamp = '2011-02-20T06:25:50Z'
+      known_signature = 'AWSAccessKeyId=abc123&Action=DescribeInstances&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2011-02-20T06%3A25%3A50Z&Version=2010-08-31&Signature=0fuHYXhygt2osdqtnRww1WFR2nHMwk0wvhiCOxuS3AY%3D'
+      @ec2.sign('DescribeInstances',{},known_timestamp).signature.must_equal known_signature
+    end
+    it 'should append the ":project" string to awsaccessid in the signature (cgi escaped)' do
+      @ec2.sign.signature.must_match /KeyId=#{$creds[:awsaccessid]}&Action/ # before specifying project
+      @ec2.project = 'someproj'
+      @ec2.sign.signature.must_match /KeyId=#{CGI::escape $creds[:awsaccessid]+':someproj'}/
+    end
+  end # describe '#sign' do
+
+  describe '#submit' do
+    $xml = "<?xml version=\"1.0\" ?><DescribeInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2010-08-31/\"><requestId>G4DU2RXB59NMIX84UW9F</requestId><reservationSet><item><ownerId>jsmith</ownerId><groupSet><item><groupId>default</groupId></item></groupSet><reservationId>r-5oexkoz1</reservationId><instancesSet><item><displayDescription/><displayName>Server 198</displayName><keyName>None (jsmith, cm-02)</keyName><instanceId>i-000000c6</instanceId><instanceState><code>1</code><name>running</name></instanceState><publicDnsName/><imageId>ami-usc3oydl</imageId><productCodesSet/><privateDnsName>10.1.1.17</privateDnsName><dnsName>10.1.1.17</dnsName><launchTime>2011-02-20 07:17:03</launchTime><placement><availabilityZone>nova</availabilityZone></placement><amiLaunchIndex>0</amiLaunchIndex><instanceType>m1.small</instanceType></item></instancesSet></item></reservationSet></DescribeInstancesResponse>"
+
+    before do
+      FakeWeb.register_uri(:post, $creds[:ec2url], :body => $xml)
+      @ec2 = EC2Signature.new $creds
+    end
+
+    it 'by default should submit via POST' do
+      @ec2.submit.must_be_kind_of Hash
+    end
+    it 'should allow you to also submit via GET' do
+      FakeWeb.register_uri(:get, %r|#{$creds[:ec2url]}|, :body => $xml)
+      @ec2.method = 'GET'
+      @ec2.submit.must_be_kind_of Hash
+    end
+    it 'by default should return a Hash' do
+      @ec2.submit.must_be_kind_of Hash
+    end
+    it 'should allow you to return the raw xml instead of Hash' do
+      # the catch is that you won't be able to use the default arg param values
+      raw = @ec2.submit('DescribeInstances', {}, $timestamp, true)
+      raw.must_be_kind_of String
+      raw.must_match /<?xml version=\"1.0\"/
+    end
+  end # describe '#submit' do
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
+require 'ec2-signature'
+require 'fakeweb'

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ec2-signature
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - John Tran
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -08:00
+date: 2011-02-20 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +36,8 @@ files:
 - ec2-signature.gemspec
 - lib/ec2-signature.rb
 - lib/ec2-signature/version.rb
+- test/test_ec2_signature.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/ec2-signature
 licenses: []
@@ -45,25 +48,30 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ec2-signature
-rubygems_version: 1.3.6
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: generate a signature to be posted to any EC2 compatible API
-test_files: []
-
+test_files: 
+- test/test_ec2_signature.rb
+- test/test_helper.rb