s3 0.2.4 → 0.2.5

data/lib/s3/signature.rb

@@ -5,24 +5,22 @@ module S3
   # Implements algorithm defined by Amazon Web Services to sign
   # request with secret private credentials
   #
-  # === See:
+  # === See
   # http://docs.amazonwebservices.com/AmazonS3/latest/index.html?RESTAuthentication.html
 
   class Signature
 
     # Generates signature for given parameters
     #
-    # ==== Parameters:
-    # +options+: a hash that contains options listed below
+    # ==== Options
+    # * <tt>:host</tt> - Hostname
+    # * <tt>:request</tt> - Net::HTTPRequest object with correct
+    #   headers
+    # * <tt>:access_key_id</tt> - Access key id
+    # * <tt>:secret_access_key</tt> - Secret access key
     #
-    # ==== Options:
-    # +host+: hostname
-    # +request+: Net::HTTPRequest object with correct headers
-    # +access_key_id+: access key id
-    # +secret_access_key+: secret access key
-    #
-    # ==== Returns:
-    # Generated signature for given hostname and request
+    # ==== Returns
+    # Generated signature string for given hostname and request
     def self.generate(options)
       request = options[:request]
       host = options[:host]
@@ -56,16 +54,43 @@ module S3
       "AWS #{access_key_id}:#{signature}"
     end
 
+    # Generates temporary URL for given resource
+    #
+    # ==== Options
+    # * <tt>:bucket</tt> - Bucket in which the resource resides
+    # * <tt>:resource</tt> - Path to the resouce you want to create
+    #   a teporary link to
+    # * <tt>:secret_access_key</tt> - Secret access key
+    # * <tt>:expires_on</tt> - Unix time stamp of when the resouce
+    #   link will expire
+    def self.generate_temporary_url_signature(options)
+      bucket = options[:bucket]
+      resource = options[:resource]
+      secret_access_key = options[:secret_access_key]
+      expires = options[:expires_on]
+
+      string_to_sign = "GET\n\n\n#{expires}\n/#{bucket}/#{resource}";
+
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.digest(digest, secret_access_key, string_to_sign)
+      base64 = Base64.encode64(hmac)
+      signature = base64.chomp
+
+      CGI.escape(signature)
+    end
+
     private
 
-    # Helper method for extracting header fields from Net::HTTPRequest and
-    # preparing them for singing in #generate method
+    # Helper method for extracting header fields from Net::HTTPRequest
+    # and preparing them for singing in #generate method
     #
-    # ==== Parameters:
-    # +request+: Net::HTTPRequest object with header fields filled in
+    # ==== Parameters
+    # * <tt>request</tt> - Net::HTTPRequest object with header fields
+    #   filled in
     #
-    # ==== Returns:
-    # String containing interesting header fields in suitable order and form
+    # ==== Returns
+    # String containing interesting header fields in suitable order
+    # and form
     def self.canonicalized_amz_headers(request)
       headers = []
 
@@ -123,11 +148,12 @@ module S3
 
     # Helper methods for extracting caninocalized resource address
     #
-    # ==== Parameters:
-    # +host+: hostname
-    # +request+: Net::HTTPRequest object with headers filealds filled in
+    # ==== Parameters
+    # * <tt>host</tt> - Hostname
+    # * <tt>request</tt> - Net::HTTPRequest object with header fields
+    #   filled in
     #
-    # ==== Returns:
+    # ==== Returns
     # String containing extracted canonicalized resource
     def self.canonicalized_resource(host, request)
       # 1. Start with the empty string ("").

data/test/bucket_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 
 class BucketTest < Test::Unit::TestCase
   def setup
@@ -6,49 +6,54 @@ class BucketTest < Test::Unit::TestCase
     @bucket_path = S3::Bucket.send(:new, nil, "Data_Bucket")
     @bucket = @bucket_vhost
 
-    @response_location = Net::HTTPOK.new("1.1", "200", "OK")
-    stub(@response_location).body { @bucket_location_body }
     @bucket_location = "EU"
     @bucket_location_body = <<-EOLocation
     <?xml version="1.0" encoding="UTF-8"?>\n<LocationConstraint xmlns="http://s3.amazonaws.com/doc/2006-03-01/">EU</LocationConstraint>
     EOLocation
 
-    @reponse_owned_by_you = Net::HTTPConflict.new("1.1", "409", "Conflict")
-    stub(@reponse_owned_by_you).body { @bucket_owned_by_you_body }
+    @response_location = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_location.stubs(:body).returns(@bucket_location_body)
+
     @bucket_owned_by_you_body = <<-EOOwnedByYou
     <?xml version="1.0" encoding="UTF-8"?>\n<Error> <Code>BucketAlreadyOwnedByYou</Code> <Message>Your previous request to create the named bucket succeeded and you already own it.</Message> <BucketName>bucket</BucketName> <RequestId>117D08EA0EC6E860</RequestId> <HostId>4VpMSvmJ+G5+DLtVox6O5cZNgdPlYcjCu3l0n4HjDe01vPxxuk5eTAtcAkUynRyV</HostId> </Error>
     EOOwnedByYou
 
-    @reponse_already_exists = Net::HTTPConflict.new("1.1", "409", "Conflict")
-    stub(@response_already_exists).body { @bucket_already_exists_body }
+    @reponse_owned_by_you = Net::HTTPConflict.new("1.1", "409", "Conflict")
+    @reponse_owned_by_you.stubs(:body).returns(@bucket_owned_by_you_body)
+
     @bucket_already_exists_body = <<-EOAlreadyExists
     <?xml version="1.0" encoding="UTF-8"?>\n<Error> <Code>BucketAlreadyExists</Code> <Message>The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.</Message> <BucketName>bucket</BucketName> <RequestId>4C154D32807C92BD</RequestId> <HostId>/xyHQgXcUXTZQhoO+NUBzbaxbFrIhKlyuaRHFnmcId0bMePvY9Zwg+dyk2LYE4g5</HostId> </Error>
     EOAlreadyExists
 
+    @reponse_already_exists = Net::HTTPConflict.new("1.1", "409", "Conflict")
+    @response_already_exists.stubs(:body).returns(@bucket_already_exists_body)
+
     @objects_list_empty = []
     @objects_list = [
       S3::Object.send(:new, @bucket, :key => "obj1"),
       S3::Object.send(:new, @bucket, :key => "obj2")
     ]
 
-    @response_objects_list_empty = Net::HTTPOK.new("1.1", "200", "OK")
-    stub(@response_objects_list_empty).body { @response_objects_list_empty_body }
     @response_objects_list_empty_body = <<-EOEmpty
     <?xml version="1.0" encoding="UTF-8"?>\n<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>bucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> </ListBucketResult>
     EOEmpty
 
-    @response_objects_list = Net::HTTPOK.new("1.1", "200", "OK")
-    stub(@response_objects_list).body { @response_objects_list_body }
+    @response_objects_list_empty = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_objects_list_empty.stubs(:body).returns(@response_objects_list_empty_body)
+
     @response_objects_list_body = <<-EOObjects
     <?xml version="1.0" encoding="UTF-8"?>\n<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>bucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>obj1</Key> <LastModified>2009-07-03T10:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e580e1b7bca85a458c&quot;</ETag> <Size>1729</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f15e245b035a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>obj2</Key> <LastModified>2009-07-03T11:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e586e1b12bca85a458c&quot;</ETag> <Size>179</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f17e247b037a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> </ListBucketResult>
     EOObjects
+
+    @response_objects_list = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_objects_list.stubs(:body).returns(@response_objects_list_body)
   end
 
-  def test_name_valid
+  test "name valid" do
     assert_raise ArgumentError do S3::Bucket.send(:new, nil, "") end # should not be valid with empty name
     assert_raise ArgumentError do S3::Bucket.send(:new, nil, "10.0.0.1") end # should not be valid with IP as name
     assert_raise ArgumentError do S3::Bucket.send(:new, nil, "as") end # should not be valid with name shorter than 3 characters
-    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "a"*256) end # should not be valid with name longer than 255 characters
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "a" * 256) end # should not be valid with name longer than 255 characters
     assert_raise ArgumentError do S3::Bucket.send(:new, nil, ".asdf") end # should not allow special characters as first character
     assert_raise ArgumentError do S3::Bucket.send(:new, nil, "-asdf") end # should not allow special characters as first character
     assert_raise ArgumentError do S3::Bucket.send(:new, nil, "_asdf") end # should not allow special characters as first character
@@ -60,7 +65,7 @@ class BucketTest < Test::Unit::TestCase
     end
   end
 
-  def test_path_prefix
+  test "path prefix" do
     expected = ""
     actual = @bucket_vhost.path_prefix
     assert_equal expected, actual
@@ -70,7 +75,7 @@ class BucketTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_host
+  test "host" do
     expected = "Data-Bucket.s3.amazonaws.com"
     actual = @bucket_vhost.host
     assert_equal expected, actual
@@ -80,85 +85,85 @@ class BucketTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_vhost
+  test "vhost" do
     assert @bucket_vhost.vhost?
     assert ! @bucket_path.vhost?
   end
 
-  def test_exists
-    mock(@bucket).retrieve { @bucket_vhost }
+  test "exists" do
+    @bucket.expects(:retrieve).returns(@bucket_vhost)
     assert @bucket.exists?
 
-    mock(@bucket).retrieve { raise S3::Error::NoSuchBucket.new(nil, nil) }
+    @bucket.expects(:retrieve).raises(S3::Error::NoSuchBucket.new(nil, nil))
     assert ! @bucket.exists?
   end
 
-  def test_location_and_parse_location
-    mock(@bucket).bucket_request(:get, {:params=>{:location=>nil}}) { @response_location }
+  test "location and parse location" do
+    @bucket.expects(:bucket_request).with(:get, { :params => { :location => nil } }).returns(@response_location)
 
     expected = @bucket_location
     actual = @bucket.location
     assert_equal expected, actual
 
-    stub(@bucket).bucket_request(:get, {:params=>{:location=>nil}}) { flunk "should deliver from cached result" }
+    @bucket.stubs(:bucket_request).with(:get, { :params => { :location => nil } })
     actual = @bucket.location
     assert_equal expected, actual
   end
 
-  def test_save
-    mock(@bucket).bucket_request(:put, {:headers=>{}}) { }
+  test "save" do
+    @bucket.expects(:bucket_request).with(:put, { :headers => {} })
     assert @bucket.save
     # mock ensures that bucket_request was called
   end
 
-  def test_save_failure_owned_by_you
-    mock(@bucket).bucket_request(:put, {:headers=>{}}) { raise S3::Error::BucketAlreadyOwnedByYou.new(409, @response_owned_by_you) }
+  test "save failure owned by you" do
+    @bucket.expects(:bucket_request).with(:put, { :headers => {} }).raises(S3::Error::BucketAlreadyOwnedByYou.new(409, @response_owned_by_you))
     assert_raise S3::Error::BucketAlreadyOwnedByYou do
       @bucket.save
     end
 
-    mock(@bucket).bucket_request(:put, {:headers=>{}}) { raise S3::Error::BucketAlreadyExists.new(409, @response_already_exists) }
+    @bucket.expects(:bucket_request).with(:put, { :headers => {} }).raises(S3::Error::BucketAlreadyExists.new(409, @response_already_exists))
     assert_raise S3::Error::BucketAlreadyExists do
       @bucket.save
     end
   end
 
-  def test_objects
-    mock(@bucket).list_bucket { @objects_list_empty }
+  test "objects" do
+    @bucket.expects(:list_bucket).returns(@objects_list_empty)
     expected = @objects_list_empty
     actual = @bucket.objects
     assert_equal expected, actual
 
-    stub(@bucket).list_bucket { flunk "should load objects from cache" }
+    @bucket.stubs(:list_bucket)
     actual = @bucket.objects
     assert_equal expected, actual
 
-    stub(@bucket).list_bucket { @objects_list }
+    @bucket.stubs(:list_bucket).returns(@objects_list)
 
     expected = @objects_list
     actual = @bucket.objects(true)
     assert_equal expected, actual
   end
 
-  def test_list_bucket_and_parse_objects
-    mock(@bucket).bucket_request(:get, :params => { :test=>true }) { @response_objects_list_empty }
+  test "list bucket and parse objects" do
+    @bucket.expects(:bucket_request).with(:get, :params => { :test=>true }).returns(@response_objects_list_empty)
     expected = @objects_list_empty
     actual = @bucket.objects.find_all(:test => true)
     assert_equal expected, actual
 
-    mock(@bucket).bucket_request(:get, :params => { :test=>true }) { @response_objects_list }
+    @bucket.expects(:bucket_request).with(:get, :params => { :test => true }).returns(@response_objects_list)
     expected = @objects_list
     actual = @bucket.objects.find_all(:test => true)
     assert_equal expected, actual
   end
 
-  def test_destroy
-    mock(@bucket).bucket_request(:delete) { }
+  test "destroy" do
+    @bucket.expects(:bucket_request).with(:delete)
     assert @bucket.destroy
   end
 
-  def test_objects_build
-    stub(@bucket).bucket_request { flunk "should not connect to server" }
+  test "objects build" do
+    @bucket.stubs(:bucket_request)
 
     expected = "object_name"
     actual = @bucket.objects.build("object_name")
@@ -166,24 +171,24 @@ class BucketTest < Test::Unit::TestCase
     assert_equal expected, actual.key
   end
 
-  def test_objects_find_first
+  test "objects find first" do
     assert_nothing_raised do
-      stub.instance_of(S3::Object).retrieve { S3::Object.send(:new, nil, :key => "obj2") }
+      S3::Object.any_instance.stubs(:retrieve).returns(S3::Object.send(:new, nil, :key => "obj2"))
       expected = "obj2"
       actual = @bucket.objects.find_first("obj2")
       assert_equal "obj2", actual.key
     end
   end
 
-  def test_objects_find_first_fail
+  test "objects find first fail" do
     assert_raise S3::Error::NoSuchKey do
-      stub.instance_of(S3::Object).retrieve { raise S3::Error::NoSuchKey.new(404, nil) }
+      S3::Object.any_instance.stubs(:retrieve).raises(S3::Error::NoSuchKey.new(404, nil))
       @bucket.objects.find_first("obj3")
     end
   end
 
-  def test_objects_find_all_on_empty_list
-    stub(@bucket).list_bucket { @objects_list_empty }
+  test "objects find all on empty list" do
+    @bucket.stubs(:list_bucket).returns(@objects_list_empty)
     assert_nothing_raised do
       expected = @objects_list_empty
       actual = @bucket.objects.find_all
@@ -191,8 +196,8 @@ class BucketTest < Test::Unit::TestCase
     end
   end
 
-  def test_objects_find_all
-    stub(@bucket).list_bucket { @objects_list }
+  test "objects find all" do
+    @bucket.stubs(:list_bucket).returns(@objects_list)
     assert_nothing_raised do
       expected = @objects_list
       actual = @bucket.objects.find_all
@@ -200,13 +205,13 @@ class BucketTest < Test::Unit::TestCase
     end
   end
 
-  def test_objects_reload
-    stub(@bucket).list_bucket { @objects_list_empty }
+  test "objects reload" do
+    @bucket.stubs(:list_bucket).returns(@objects_list_empty)
     expected = @objects_list_empty
     actual = @bucket.objects
     assert_equal expected, actual
 
-    stub(@bucket).list_bucket { @objects_list }
+    @bucket.stubs(:list_bucket).returns(@objects_list)
     expected = @objects_list_empty
     actual = @bucket.objects
     assert_equal expected, actual
@@ -218,14 +223,11 @@ class BucketTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_objects_destroy_all
-    @counter = 0
-    stub(@bucket).list_bucket { @objects_list }
+  test "objects destroy all" do
+    @bucket.stubs(:list_bucket).returns(@objects_list)
     @bucket.objects.each do |obj|
-      mock(obj).destroy { @counter += 1 }
+      obj.expects(:destroy)
     end
-
     @bucket.objects.destroy_all
-    assert_equal @objects_list.length, @counter
   end
 end

data/test/connection_test.rb

@@ -9,11 +9,12 @@ class ConnectionTest < Test::Unit::TestCase
     @http_request = Net::HTTP.new("")
     @response_ok = Net::HTTPOK.new("1.1", "200", "OK")
     @response_not_found = Net::HTTPNotFound.new("1.1", "404", "Not Found")
-    stub(@connection).http { @http_request }
-    stub(@http_request).start { @response_ok }
+    @connection.stubs(:http).returns(@http_request)
+
+    @http_request.stubs(:start).returns(@response_ok)
   end
 
-  def test_handle_response_not_modify_response_when_ok
+  test "handle response not modify response when ok" do
     assert_nothing_raised do
       response = @connection.request(
         :get,
@@ -24,7 +25,7 @@ class ConnectionTest < Test::Unit::TestCase
     end
   end
 
-  def test_handle_response_throws_exception_when_not_ok
+  test "handle response throws exception when error" do
     response_body = <<-EOFakeBody
     <?xml version=\"1.0\" encoding=\"UTF-8\"?>
     <Error>
@@ -33,8 +34,8 @@ class ConnectionTest < Test::Unit::TestCase
     </Error>
     EOFakeBody
 
-    stub(@http_request).start { @response_not_found }
-    stub(@response_not_found).body { response_body }
+    @http_request.stubs(:start).returns(@response_not_found)
+    @response_not_found.stubs(:body).returns(response_body)
 
     assert_raise S3::Error::NoSuchBucket do
       response = @connection.request(
@@ -45,9 +46,9 @@ class ConnectionTest < Test::Unit::TestCase
     end
   end
 
-  def test_handle_response_throws_standard_exception_when_not_ok
-    stub(@http_request).start { @response_not_found }
-    stub(@response_not_found).body { nil }
+  test "handle response throws standard exception when error" do
+    @http_request.stubs(:start).returns(@response_not_found)
+    @response_not_found.stubs(:body)
     assert_raise S3::Error::ResponseError do
       response = @connection.request(
         :get,
@@ -56,7 +57,7 @@ class ConnectionTest < Test::Unit::TestCase
       )
     end
 
-    stub(@response_not_found).body { "" }
+    @response_not_found.stubs(:body).returns("")
     assert_raise S3::Error::ResponseError do
       response = @connection.request(
         :get,
@@ -66,37 +67,37 @@ class ConnectionTest < Test::Unit::TestCase
     end
   end
 
-  def test_parse_params_empty
+  test "parse params empty" do
     expected = ""
     actual = S3::Connection.parse_params({})
     assert_equal expected, actual
   end
 
-  def test_parse_params_only_interesting_params
+  test "parse params only interesting params" do
     expected = ""
     actual = S3::Connection.parse_params(:param1 => "1", :maxkeys => "2")
     assert_equal expected, actual
   end
 
-  def test_parse_params_remove_underscore
+  test "parse params remove underscore" do
     expected = "max-keys=100"
     actual = S3::Connection.parse_params(:max_keys => 100)
     assert_equal expected, actual
   end
 
-  def test_parse_params_with_and_without_values
+  test "parse params with and without values" do
     expected = "max-keys=100&prefix"
     actual = S3::Connection.parse_params(:max_keys => 100, :prefix => nil)
     assert_equal expected, actual
   end
 
-  def test_headers_headers_empty
+  test "headers empty" do
     expected = {}
     actual = S3::Connection.parse_headers({})
     assert_equal expected, actual
   end
 
-  def test_parse_headers_only_interesting_headers
+  test "parse only interesting headers" do
     expected = {}
     actual = S3::Connection.parse_headers(
       :accept => "text/*, text/html, text/html;level=1, */*",
@@ -105,7 +106,7 @@ class ConnectionTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_parse_headers_remove_underscore
+  test "parse headers remove underscore" do
     expected = {
       "content-type" => nil,
       "x-amz-acl" => nil,
@@ -129,7 +130,7 @@ class ConnectionTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_parse_headers_with_values
+  test "parse headers with values" do
     expected = {
       "content-type" => "text/html",
       "x-amz-acl" => "public-read",
@@ -153,7 +154,7 @@ class ConnectionTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_parse_headers_with_range
+  test "parse headers with range" do
     expected = {
       "range" => "bytes=0-100"
     }