aws-s3 0.1.0

data/test/fixtures/errors.yml

@@ -0,0 +1,34 @@
+not_implemented: >
+  <Error>
+    <Code>NotImplemented</Code>
+    <Message>A header you provided implies functionality that is not implemented</Message>
+    <RequestId>D1D13A09AC92427F</RequestId>
+    <Header>Host</Header>
+    <HostId>oNZgzTTmWiovwGGwHXAzz+1vRmAJVAplS9TF7B0cuOGfEwoi7DYSTa/1Qhv90CfW</HostId>
+  </Error>
+  
+access_denied: >
+  <Error>
+    <Code>AccessDenied</Code>
+    <Message>Access Denied</Message>
+    <RequestId>F99F6D58B96C98E0</RequestId>
+    <HostId>XwCF7k3llrcEwtoHR7MusZ6ilCdF5DKDmwYpglvjKNjvwo24INCeXlEpo1M03Wxm</HostId>
+  </Error>
+  
+internal_error: >
+  <Error>
+    <Code>InternalError</Code>
+    <Message>Internal Error</Message>
+    <RequestId>F99F6D223B96C98E0</RequestId>
+    <HostId>XwCF7k3llrcEwtoHR7MusZ6ilCdF5DKDmwYpglvjKNjvwo24INCeXlEpo1M03Wxm</HostId>
+  </Error>
+  
+error_with_no_message: >
+  <Error>
+    <Code>InvalidArgument</Code>
+    <Message></Message>
+    <ArgumentValue>READ</ArgumentValue>
+    <RequestId>74A377B1C0FA2BCF</RequestId>
+    <HostId>cP4rqsAEtHpN6Ckv08Hr3LXjLzx15/YgyoSqzs779vMR8MrAFSodxZp96wtuMQuI</HostId>
+    <ArgumentName>x-amz-acl</ArgumentName>
+  </Error>

data/test/fixtures/headers.yml

@@ -0,0 +1,3 @@
+headers_including_one_piece_of_metadata:
+  x-amz-meta-test: foo
+  content_type: text/plain

data/test/fixtures/logging.yml

@@ -0,0 +1,15 @@
+logging_enabled: >
+  <BucketLoggingStatus xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+    <LoggingEnabled>
+      <TargetBucket>mylogs</TargetBucket>
+      <TargetPrefix>access_log-</TargetPrefix>
+    </LoggingEnabled>
+  </BucketLoggingStatus>
+  
+logging_disabled: >
+  <BucketLoggingStatus xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+    <!--<LoggingEnabled>
+      <TargetBucket>myLogsBucket</TargetBucket>
+      <TargetPrefix>add/this/prefix/to/my/log/files/access_log-</TargetPrefix>
+    </LoggingEnabled>-->
+  </BucketLoggingStatus>

data/test/fixtures/policies.yml

@@ -0,0 +1,16 @@
+policy_with_one_grant: >
+  <AccessControlPolicy>
+    <Owner>
+      <ID>bb2041a25975c3d4ce9775fe9e93e5b77a6a9fad97dc7e00686191f3790b13f1</ID>
+      <DisplayName>mmolina@onramp.net</DisplayName>
+    </Owner>
+    <AccessControlList>
+      <Grant>
+        <Grantee xsi:type="CanonicalUser" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+          <ID>bb2041a25975c3d4ce9775fe9e93e5b77a6a9fad97dc7e00686191f3790b13f1</ID>
+          <DisplayName>mmolina@onramp.net</DisplayName>
+        </Grantee>
+        <Permission>FULL_CONTROL</Permission>
+      </Grant>
+    </AccessControlList>
+  </AccessControlPolicy>

data/test/logging_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class LoggingStatusReadingTest < Test::Unit::TestCase
+  
+  def setup
+    @disabled   = logging_status(:logging_disabled)
+    @enabled    = logging_status(:logging_enabled)
+    @new_status = Logging::Status.new('target_bucket' => 'foo', 'target_prefix' => 'access-log-')
+  end
+  
+  def test_logging_enabled?
+    assert !@disabled.logging_enabled?
+    assert !@new_status.logging_enabled?
+    assert @enabled.logging_enabled?
+  end
+  
+  def test_passing_in_prefix_and_bucket
+    assert_equal 'foo', @new_status.target_bucket
+    assert_equal 'access-log-', @new_status.target_prefix
+    assert !@new_status.logging_enabled?
+  end
+  
+  private
+    def logging_status(fixture)
+      Logging::Status.new(Parsing::XmlParser.new(Fixtures::Logging[fixture.to_s]))
+    end
+end
+
+class LoggingStatusWritingTest < LoggingStatusReadingTest
+  
+  def setup
+    super
+    @disabled = Logging::Status.new(Parsing::XmlParser.new(@disabled.to_xml))
+    @enabled  = Logging::Status.new(Parsing::XmlParser.new(@enabled.to_xml))
+  end
+end

data/test/mocks/base.rb

@@ -0,0 +1,89 @@
+require_library_or_gem 'flexmock'
+
+module AWS
+  module S3
+    class FakeResponse < String
+      attr_reader :code, :body, :headers
+      def initialize(options = {})
+        @code    = options.delete(:code)  || 200 
+        @body    = options.delete(:body)  || ''
+        @headers = {'content-type' => 'application/xml'}.merge(options.delete(:headers) || {})
+        super(@body)
+      end
+
+      # For ErrorResponse
+      def response
+        self
+      end
+      
+      def [](header)
+        headers[header]
+      end
+      
+      def each(&block)
+        headers.each(&block)
+      end
+      alias_method :each_header, :each
+    end
+    
+    class Base
+      class << self
+        @@responses          = []
+        @@in_test_mode       = false
+        @@catch_all_response = nil
+        
+        def in_test_mode=(boolean)
+          @@in_test_mode = boolean
+        end
+        
+        def responses
+          @@responses
+        end
+        
+        def catch_all_response
+          @@catch_all_response
+        end
+
+        def reset!
+          responses.clear
+        end
+        
+        def request_returns(response_data)
+          responses.concat [response_data].flatten.map {|data| FakeResponse.new(data)}
+        end
+        
+        def request_always_returns(response_data, &block)
+          in_test_mode do
+            @@catch_all_response = FakeResponse.new(response_data)
+            yield
+            @@catch_all_response = nil
+          end
+        end
+        
+        def in_test_mode(&block)
+          self.in_test_mode = true
+          yield
+        ensure
+          self.in_test_mode = false
+        end
+        
+        alias_method :old_connection, :connection
+        def connection
+          if @@in_test_mode
+            @mock_connection ||= 
+              begin
+                mock_connection = FlexMock.new
+                mock_connection.mock_handle(:request) do
+                  raise 'No responses left' unless response = catch_all_response || responses.shift
+                  response
+                end
+                mock_connection
+              end
+          else
+            old_connection
+          end
+        end
+      end
+    end
+  end
+end

data/test/object_test.rb

@@ -0,0 +1,177 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ObjectTest < Test::Unit::TestCase
+  def setup
+    bucket  = Bucket.new(Parsing::XmlParser.new(Fixtures::Buckets.bucket_with_one_key))
+    @object = bucket.objects.first
+  end
+  
+  def test_header_settings_reader_and_writer
+    S3Object.in_test_mode do
+      headers = {'content-type' => 'text/plain'}
+      S3Object.request_returns :headers => headers
+      
+      assert_nothing_raised do
+        @object.content_type
+      end
+    
+      assert_equal 'text/plain', @object.content_type
+    
+      assert_nothing_raised do
+        @object.content_type = 'image/jpg'
+      end
+    
+      assert_equal 'image/jpg', @object.content_type
+    
+      assert_raises(NoMethodError) do
+        @object.non_existant_header_setting
+      end
+    end
+  end
+  
+  def test_key_name_validation
+    assert_raises(InvalidKeyName) do
+      S3Object.create(nil, '', 'marcel')
+    end
+    
+    assert_raises(InvalidKeyName) do
+      huge_name = 'a' * 1500
+      S3Object.create(huge_name, '', 'marcel')
+    end
+  end
+  
+  def test_object_has_owner
+    assert_kind_of Owner, @object.owner 
+  end
+  
+  def test_owner_attributes_are_accessible
+    owner = @object.owner
+    assert owner.id
+    assert owner.display_name
+    assert_equal 'bb2041a25975c3d4ce9775fe9e93e5b77a6a9fad97dc7e00686191f3790b13f1', owner.id
+    assert_equal 'mmolina@onramp.net', owner.display_name
+  end
+  
+  def test_only_valid_attributes_accessible
+    assert_raises(NoMethodError) do
+      @object.owner.foo
+    end
+  end
+  
+  def test_fetching_object_value_generates_value_object
+    S3Object.in_test_mode do
+      S3Object.request_returns :body => 'hello!'
+      value = S3Object.value('foo', 'bar')
+      assert_kind_of S3Object::Value, value
+      assert_equal 'hello!', value
+    end
+  end
+  
+  def test_fetching_file_by_name_raises_when_heuristic_fails
+    S3Object.request_always_returns :body => Fixtures::Buckets.bucket_with_one_key do
+      assert_raises(NoSuchKey) do
+        S3Object.find('not_tongue_overload.jpg', 'marcel_molina')
+      end
+      
+      object = nil # Block scoping
+      assert_nothing_raised do
+        object = S3Object.find('tongue_overload.jpg', 'marcel_molina')
+      end
+      assert_kind_of S3Object, object
+      assert_equal 'tongue_overload.jpg', object.key
+    end
+  end
+  
+  def test_about
+    S3Object.in_test_mode do
+      headers = {'content-size' => '12345', 'date' => Time.now.httpdate, 'content-type' => 'application/xml'}
+      S3Object.request_returns :headers => headers
+      about = S3Object.about('foo', 'bar')
+      assert_kind_of S3Object::About, about
+      assert_equal headers, about
+    end
+  end
+  
+  def test_s3object_equality
+    Bucket.in_test_mode do
+      Bucket.request_returns :body => Fixtures::Buckets.bucket_with_more_than_one_key
+      file1, file2 = Bucket.objects('does not matter')
+      assert file1 == file1
+      assert file2 == file2
+      assert !(file1 == file2) # /!\ Parens required /!\
+    end
+  end
+  
+  def test_inspect
+    S3Object.in_test_mode do
+      S3Object.request_returns :body => Fixtures::Buckets.bucket_with_one_key
+      object = S3Object.find('tongue_overload.jpg', 'bucket does not matter')
+      assert object.path
+      assert_nothing_raised { object.inspect }
+      assert object.inspect[object.path]
+   end
+ end
+ 
+ def test_etag
+  S3Object.in_test_mode do
+    S3Object.request_returns :body => Fixtures::Buckets.bucket_with_one_key
+    file = S3Object.find('tongue_overload.jpg', 'bucket does not matter')
+    assert file.etag
+    assert_equal 'f21f7c4e8ea6e34b268887b07d6da745', file.etag
+  end
+ end
+end
+
+class MetadataTest < Test::Unit::TestCase
+  def setup
+    @metadata = S3Object::Metadata.new(Fixtures::Headers.headers_including_one_piece_of_metadata)
+  end
+    
+  def test_only_metadata_is_extracted
+    assert @metadata.to_headers.size == 1
+    assert @metadata.to_headers['x-amz-meta-test']
+    assert_equal 'foo', @metadata.to_headers['x-amz-meta-test']
+  end
+  
+  def test_setting_new_metadata_normalizes_name
+    @metadata[:bar] = 'baz'
+    assert @metadata.to_headers.include?('x-amz-meta-bar')
+    @metadata['baz'] = 'quux'
+    assert @metadata.to_headers.include?('x-amz-meta-baz')
+    @metadata['x-amz-meta-quux'] = 'whatever'
+    assert @metadata.to_headers.include?('x-amz-meta-quux')
+  end
+  
+  def test_clobbering_existing_header
+    @metadata[:bar] = 'baz'
+    assert_equal 'baz', @metadata.to_headers['x-amz-meta-bar']
+    @metadata[:bar] = 'quux'
+    assert_equal 'quux', @metadata.to_headers['x-amz-meta-bar']
+    @metadata['bar'] = 'foo'
+    assert_equal 'foo', @metadata.to_headers['x-amz-meta-bar']
+    @metadata['x-amz-meta-bar'] = 'bar'
+    assert_equal 'bar', @metadata.to_headers['x-amz-meta-bar']
+  end
+  
+  def test_invalid_metadata
+    @metadata[:invalid_header] = ' ' * (S3Object::Metadata::SIZE_LIMIT + 1)
+    assert_raises InvalidMetadataValue do
+      @metadata.to_headers
+    end
+  end
+end
+
+class ValueTest < Test::Unit::TestCase
+  def setup
+    @response = FakeResponse.new(:body => 'hello there')
+    @value    = S3Object::Value.new(@response)
+  end
+  
+  def test_value_is_set_to_response_body
+    assert_equal @response.body, @value
+  end
+  
+  def test_response_is_accessible_from_value_object
+    assert_equal @response, @value.response
+  end
+end

data/test/parsing_test.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/test_helper'
+class CoercibleStringTest < Test::Unit::TestCase  
+  
+  def test_coerce
+    coercions = [
+      ['1', 1],
+      ['false', false],
+      ['true',  true],
+      ['2006-10-29T23:14:47.000Z', Time.parse('2006-10-29T23:14:47.000Z')],
+      ['Hello!', 'Hello!'],
+      ['false23', 'false23'],
+      ['03 1-2-3-Apple-Tree.mp3', '03 1-2-3-Apple-Tree.mp3']
+    ]
+    
+    coercions.each do |before, after|
+      assert_nothing_raised do
+        assert_equal after, Parsing::CoercibleString.coerce(before)
+      end
+    end
+  end
+end
+
+class TypecastingTest < Test::Unit::TestCase
+  # Make it easier to call methods in tests
+  Parsing::Typecasting.public_instance_methods.each do |method|
+    Parsing::Typecasting.send(:module_function, method)
+  end
+  
+  def test_array_with_one_element_that_is_a_hash
+    value = [{'Available' => 'true'}]
+    assert_equal [{'available' => true}], Parsing::Typecasting.typecast(value)
+  end
+  
+  def test_hash_with_one_key_whose_value_is_an_array
+    value = {
+      'Bucket' => 
+        [ 
+          {'Available' => 'true'} 
+        ] 
+    }
+    
+    expected = {
+      'bucket' => 
+        [
+          {'available' => true}
+        ]
+    }
+    assert_equal expected, Parsing::Typecasting.typecast(value)
+  end
+  
+end
+
+class XmlParserTest < Test::Unit::TestCase
+  def test_bucket_is_always_forced_to_be_an_array_unless_empty
+    one_bucket    = Parsing::XmlParser.new(Fixtures::Buckets.bucket_list_with_one_bucket)
+    more_than_one = Parsing::XmlParser.new(Fixtures::Buckets.bucket_list_with_more_than_one_bucket)
+    
+    [one_bucket, more_than_one].each do |bucket_list|
+      assert_kind_of Array, bucket_list['buckets']['bucket']
+    end
+    
+    no_buckets    = Parsing::XmlParser.new(Fixtures::Buckets.empty_bucket_list)
+    assert no_buckets.has_key?('buckets')
+    assert_nil no_buckets['buckets']
+  end
+  
+  def test_bucket_contents_are_forced_to_be_an_array_unless_empty
+    one_key       = Parsing::XmlParser.new(Fixtures::Buckets.bucket_with_one_key)
+    more_than_one = Parsing::XmlParser.new(Fixtures::Buckets.bucket_with_more_than_one_key)
+    [one_key, more_than_one].each do |bucket_with_contents|
+      assert_kind_of Array, bucket_with_contents['contents']
+    end
+    
+    no_keys = Parsing::XmlParser.new(Fixtures::Buckets.empty_bucket)
+    assert !no_keys.has_key?('contents')
+  end
+  
+  def test_policy_grants_are_always_an_array
+    policy = Parsing::XmlParser.new(Fixtures::Policies.policy_with_one_grant)
+    assert_kind_of Array, policy['access_control_list']['grant']
+  end
+end