aws-s3 0.2.0 → 0.2.1

data/INSTALL

@@ -26,9 +26,15 @@ Then add the following line, save and exit:
 
   aws svn://rubyforge.org/var/svn/amazon/s3/trunk
   
+If you go the svn route, be sure that you have all the dependencies installed. The list of dependencies follow.
+  
 == Dependencies
 
-=== XML parsing
+  sudo gem i xml-simple -ry
+  sudo gem i builder    -ry
+  sudo gem i mime-types -ry
+
+=== XML parsing (xml-simple)
 
 AWS::S3 depends on XmlSimple (http://xml-simple.rubyforge.org/). When installing aws/s3 with
 Rubygems, this dependency will be taken care of for you. Otherwise, installation instructions are listed on the xml-simple
@@ -36,10 +42,10 @@ site.
 
 If your system has the Ruby libxml bindings installed (http://libxml.rubyforge.org/) they will be used instead of REXML (which is what XmlSimple uses). For those concerned with speed and efficiency, it would behoove you to install libxml (instructions here: http://libxml.rubyforge.org/install.html) as it is considerably faster and less expensive than REXML.
 
-=== XML generation
+=== XML generation (builder)
 
 AWS::S3 also depends on the Builder library (http://builder.rubyforge.org/ and http://rubyforge.org/projects/builder/). This will also automatically be installed for you when using Rubygems.
 
-=== Content type inference
+=== Content type inference (mime-types)
 
 AWS::S3 depends on the MIME::Types library (http://mime-types.rubyforge.org/) to infer the content type of an object that does not explicitly specify it. This library will automatically be installed for you when using Rubygems.

data/README

@@ -135,7 +135,7 @@ You can store an object on S3 by specifying a key, its data and the name of the
     'photos'
   )
 
-The content type of the object will be infered by its extension. If the appropriate content type can not be infered, S3 defaults
+The content type of the object will be inferred by its extension. If the appropriate content type can not be inferred, S3 defaults
 to <tt>binary/octect-stream</tt>.
 
 If you want to override this, you can explicitly indicate what content type the object should have with the <tt>:content_type</tt> option:
@@ -279,7 +279,7 @@ This time we didn't have to explicitly pass in the bucket name, as the JukeBoxSo
 always use the 'jukebox' bucket. 
 
 "Astute readers", as they say, may have noticed that we used the third parameter to pass in the content type,
-rather than the fourth parameter as we had the last time we created an object. If the bucket can be infered, or
+rather than the fourth parameter as we had the last time we created an object. If the bucket can be inferred, or
 is explicitly set, as we've done in the JukeBoxSong class, then the third argument can be used to pass in
 options.
 

data/Rakefile

@@ -129,10 +129,12 @@ namespace :dist do
     sh %(svn ci CHANGELOG -m "Bump changelog version marker for release")
   end
   
+  package_name = lambda {|specification| File.join('pkg', "#{specification.name}-#{specification.version}")}
+  
   desc 'Push a release to rubyforge'
   task :release => [:confirm_release, :clean, :add_release_marker_to_changelog, :package, :commit_changelog, :tag] do 
     require 'rubyforge'
-    package = File.join('pkg', "#{spec.name}-#{spec.version}")
+    package = package_name[spec]
 
     rubyforge = RubyForge.new
     rubyforge.login
@@ -151,6 +153,12 @@ namespace :dist do
     end
   end
   
+  desc 'Upload a beta gem'
+  task :push_beta_gem => [:clobber_package, :package] do
+    beta_gem = package_name[spec]
+    sh %(scp #{beta_gem}.gem  marcel@rubyforge.org:/var/www/gforge-projects/amazon/beta)
+  end
+  
   task :spec do
     puts spec.to_ruby
   end

data/bin/s3sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-s3_lib = File.dirname(__FILE__) + '/../lib/aws/s3'
-setup  = File.dirname(__FILE__) + '/setup'
-exec "irb -r #{s3_lib} -r #{setup} --simple-prompt"
+s3_lib   = File.dirname(__FILE__) + '/../lib/aws/s3'
+setup    = File.dirname(__FILE__) + '/setup'
+irb_name = RUBY_PLATFORM =~ /mswin32/ ? 'irb.bat' : 'irb'
+
+exec "#{irb_name} -r #{s3_lib} -r #{setup} --simple-prompt"

data/lib/aws/s3/base.rb

@@ -121,7 +121,7 @@ module AWS #:nodoc:
         # always use the 'jukebox' bucket. 
         # 
         # "Astute readers", as they say, may have noticed that we used the third parameter to pass in the content type,
-        # rather than the fourth parameter as we had the last time we created an object. If the bucket can be infered, or
+        # rather than the fourth parameter as we had the last time we created an object. If the bucket can be inferred, or
         # is explicitly set, as we've done in the JukeBoxSong class, then the third argument can be used to pass in
         # options.
         # 

data/lib/aws/s3/bucket.rb

@@ -175,10 +175,14 @@ module AWS
         
         private
           def validate_name!(name)
-            raise InvalidBucketName.new(name) unless name =~ /^[-\w]{3,255}$/
+            raise InvalidBucketName.new(name) unless name =~ /^[-\w.]{3,255}$/
           end
           
           def path(name, options = {})
+            if name.is_a?(Hash)
+              options = name
+              name    = nil
+            end
             "/#{bucket_name(name)}#{RequestOptions.process(options).to_query_string}"
           end
       end
@@ -279,7 +283,7 @@ module AWS
       end
       alias_method :clear, :delete_all
       
-      # Buckets observer their objects and have this method called when one of their objects
+      # Buckets observe their objects and have this method called when one of their objects
       # is either stored or deleted.
       def update(action, object) #:nodoc:        
         case action

data/lib/aws/s3/connection.rb

@@ -22,12 +22,14 @@ module AWS
         http.start do
           request = request_method(verb).new(path, headers)
           authenticate!(request)
-          case body
-          when String then request.body = body
-          when IO     then
-            request.body_stream    = body
-            request.content_length = body.lstat.size
-          end if body
+          if body
+            if body.respond_to?(:read)                                                                
+              request.body_stream    = body                                                           
+              request.content_length = body.respond_to?(:lstat) ? body.lstat.size : body.size         
+            else                                                                                      
+              request.body = body                                                                     
+            end                                                                                       
+          end
           http.request(request, &block)
         end
       end
@@ -82,7 +84,8 @@ module AWS
         
       module Management #:nodoc:
         def self.included(base)
-          base.send(:class_variable_set, :@@connections, {})
+          base.cattr_accessor :connections
+          base.connections = {}
           base.extend ClassMethods
         end
         
@@ -154,10 +157,6 @@ module AWS
           end
 
           private
-            def connections
-              class_variable_get(:@@connections)
-            end
-
             def connection_name
               name
             end

data/lib/aws/s3/exceptions.rb

@@ -88,7 +88,7 @@ module AWS
       end
     end
     
-    # Raised if the current bucket can not be infered when not explicitly specifying the target bucket in the calling
+    # Raised if the current bucket can not be inferred when not explicitly specifying the target bucket in the calling
     # method's arguments.
     class CurrentBucketNotSpecified < S3Exception
       def initialize(address)

data/lib/aws/s3/extensions.rb

@@ -6,7 +6,7 @@ class Hash
     query_string = ''
     query_string << '?' if include_question_mark
     query_string << inject([]) do |parameters, (key, value)|
-      parameters << [key, value].map {|element| CGI.escape(element.to_s)}.join('=')
+      parameters << [key, value].map {|element| element.to_s}.join('=')
     end.join('&')
   end
   
@@ -123,21 +123,60 @@ class Module
   alias_method :const_missing, :const_missing_from_s3_library
 end
 
+
+class Class # :nodoc:
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+
+  def cattr_writer(*syms)
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+  end
+
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end if Class.instance_methods(false).grep(/^cattr_(?:reader|writer|accessor)$/).empty?
+
 module SelectiveAttributeProxy
   def self.included(klass)
     klass.extend(ClassMethods)
     klass.class_eval(<<-EVAL, __FILE__, __LINE__)
-      # Default name for attribute storage
-      @@attribute_proxy         = :attributes
-      @@attribute_proxy_options = {:exclusively => true}
-      
-      def self.attribute_proxy
-        @@attribute_proxy
-      end
+      cattr_accessor :attribute_proxy
+      cattr_accessor :attribute_proxy_options
       
-      def self.attribute_proxy_options
-        @@attribute_proxy_options
-      end
+      # Default name for attribute storage
+      self.attribute_proxy         = :attributes
+      self.attribute_proxy_options = {:exclusively => true}
       
       private
         # By default proxy all attributes
@@ -168,9 +207,9 @@ module SelectiveAttributeProxy
       if attribute_name.is_a?(Hash)
         options = attribute_name
       else
-        class_variable_set(:@@attribute_proxy, attribute_name)
+        self.attribute_proxy = attribute_name
       end
-      class_variable_set(:@@attribute_proxy_options, options)
+      self.attribute_proxy_options = options
     end
   end
 end

data/lib/aws/s3/object.rb

@@ -11,7 +11,7 @@ module AWS
     #     'photos'
     #   )
     #
-    # The content type of the object will be infered by its extension. If the appropriate content type can not be infered, S3 defaults
+    # The content type of the object will be inferred by its extension. If the appropriate content type can not be inferred, S3 defaults
     # to <tt>binary/octect-stream</tt>.
     #
     # If you want to override this, you can explicitly indicate what content type the object should have with the <tt>:content_type</tt> option:
@@ -191,8 +191,15 @@ module AWS
         
         # Fetch information about the key with <tt>name</tt> from <tt>bucket</tt>. Information includes content type, content length,
         # last modified time, and others.
+        #
+        # If the specified key does not exist, NoSuchKey is raised.
         def about(key, bucket = nil, options = {})
-          About.new(head(path!(bucket, key, options), options).headers)
+          response = head(path!(bucket, key, options), options)
+          if response.client_error?
+            raise NoSuchKey.new("No such key `#{key}'", bucket)
+          else
+            About.new(response.headers)
+          end
         end
       
         # Delete object with <tt>key</tt> from <tt>bucket</tt>.

data/lib/aws/s3/parsing.rb

@@ -80,9 +80,11 @@ module AWS
         
         def initialize(body)
           @body = body
-          parse
-          set_root
-          typecast_xml_in
+          unless body.strip.empty?
+            parse
+            set_root
+            typecast_xml_in
+          end
         end
       
         private

data/lib/aws/s3/service.rb

@@ -8,7 +8,15 @@ module AWS
       @@response = nil #:nodoc:
       
       class << self
-        # List all your buckets
+        # List all your buckets.
+        #
+        #   Service.buckets
+        #   # => []
+        #
+        # For performance reasons, the bucket list will be cached. If you want avoid all caching, pass the <tt>:reload</tt> 
+        # as an argument:
+        #
+        #   Service.buckets(:reload)
         def buckets
           response = get('/')
           if response.empty?

data/lib/aws/s3/version.rb

@@ -3,7 +3,7 @@ module AWS
     module VERSION #:nodoc:
       MAJOR    = '0'
       MINOR    = '2'
-      TINY     = '0' 
+      TINY     = '1' 
       BETA     = nil # Time.now.to_i.to_s
     end
     

data/test/base_test.rb

@@ -85,7 +85,7 @@ class MultiConnectionsTest < Test::Unit::TestCase
   end
 
   def setup
-    Base.send(:class_variable_get, :@@connections).clear
+    Base.send(:connections).clear
   end
   alias_method :teardown, :setup
   

data/test/bucket_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/test_helper'
 
 class BucketTest < Test::Unit::TestCase  
   def test_bucket_name_validation
-    valid_names   = %w(123 joe step-one step_two step3 step_4 step-5)
+    valid_names   = %w(123 joe step-one step_two step3 step_4 step-5 step.six)
     invalid_names = ['12', 'jo', 'kevin spacey', 'larry@wall', '', 'a' * 256]
     validate_name = Proc.new {|name| Bucket.send(:validate_name!, name)}
     valid_names.each do |valid_name|

data/test/extensions_test.rb

@@ -27,11 +27,6 @@ class HashExtensionsTest < Test::Unit::TestCase
     assert qs['one=1&two=2'] || qs['two=2&one=1']
   end
   
-  def test_keys_and_values_are_url_encoded
-    hash = {'key with spaces' => 'value with spaces'}
-    assert_equal '?key+with+spaces=value+with+spaces', hash.to_query_string
-  end
-  
   def test_normalized_options
     expectations = [
       [{:foo_bar  => 1}, {'foo-bar' => '1'}],

data/test/object_test.rb

@@ -136,6 +136,15 @@ class ObjectTest < Test::Unit::TestCase
     assert_equal 'f21f7c4e8ea6e34b268887b07d6da745', file.etag
   end
  end
+ 
+ def test_fetching_information_about_an_object_that_does_not_exist_raises_no_such_key
+   S3Object.in_test_mode do
+     S3Object.request_returns :body => '', :code => 404
+     assert_raises(NoSuchKey) do
+       S3Object.about('asdfasdfasdfas-this-does-not-exist', 'bucket does not matter')
+     end
+   end
+ end
 end
 
 class MetadataTest < Test::Unit::TestCase

data/test/parsing_test.rb

@@ -79,4 +79,8 @@ class XmlParserTest < Test::Unit::TestCase
     policy = Parsing::XmlParser.new(Fixtures::Policies.policy_with_one_grant)
     assert_kind_of Array, policy['access_control_list']['grant']
   end
+  
+  def test_empty_xml_response_is_not_parsed
+    assert_equal({}, Parsing::XmlParser.new(''))
+  end
 end

data/test/remote/bucket_test.rb

@@ -123,5 +123,24 @@ class RemoteBucketTest < Test::Unit::TestCase
     
     assert bucket.empty?    
   end
-      
+  
+  def test_bucket_name_is_switched_with_options_when_bucket_is_implicit_and_options_are_passed
+    Object.const_set(:ImplicitlyNamedBucket, Class.new(Bucket))
+    ImplicitlyNamedBucket.current_bucket = TEST_BUCKET
+    assert ImplicitlyNamedBucket.objects.empty?
+    
+    %w(a b c).each {|key| S3Object.store(key, 'value does not matter', TEST_BUCKET)}
+    
+    assert_equal 3, ImplicitlyNamedBucket.objects.size
+    
+    objects = nil
+    assert_nothing_raised do
+      objects = ImplicitlyNamedBucket.objects(:max_keys => 1)
+    end
+    
+    assert objects
+    assert_equal 1, objects.size
+  ensure
+    %w(a b c).each {|key| S3Object.delete(key, TEST_BUCKET)}
+  end
 end

data/test/remote/object_test.rb

@@ -13,7 +13,6 @@ class RemoteS3ObjectTest < Test::Unit::TestCase
     key                 = 'testing_s3objects'
     value               = 'testing'
     content_type        = 'text/plain'
-    fetch_object_at     = Proc.new {|url| Net::HTTP.get_response(URI.parse(url))}
     unauthenticated_url = ['http:/', Base.connection.http.address, TEST_BUCKET, key].join('/')
     
     # Create an object
@@ -103,7 +102,7 @@ class RemoteS3ObjectTest < Test::Unit::TestCase
     
     # Test that it is publicly readable
     
-    response = fetch_object_at[unauthenticated_url]
+    response = fetch_object_at(unauthenticated_url)
     assert (200..299).include?(response.code.to_i)
     
     # Confirm that it has no meta data
@@ -151,12 +150,12 @@ class RemoteS3ObjectTest < Test::Unit::TestCase
     
     # Confirm object is no longer publicly readable
     
-    response = fetch_object_at[unauthenticated_url]
+    response = fetch_object_at(unauthenticated_url)
     assert (400..499).include?(response.code.to_i)
     
     # Confirm object is accessible from its authenticated url
     
-    response = fetch_object_at[object.url]
+    response = fetch_object_at(object.url)
     assert (200..299).include?(response.code.to_i)
     
     # Copy the object
@@ -234,39 +233,10 @@ class RemoteS3ObjectTest < Test::Unit::TestCase
     end
     
     assert result
-    
-    # Confirm we can create an object with spaces in its key
-    
-    object = S3Object.new(:value => 'just some text')
-    object.key = 'name with spaces'
-    object.bucket = Bucket.find(TEST_BUCKET)
-    
-    assert_nothing_raised do
-      object.store
-    end
-    
-    object = nil
-    assert_nothing_raised do
-      object = S3Object.find('name with spaces', TEST_BUCKET)
-    end
-    
-    assert object
-    assert_equal 'name with spaces', object.key
-    
-    # Confirm authenticated url is generated correctly despite space in file name
-    
-    response = fetch_object_at[object.url]
-    assert (200..299).include?(response.code.to_i)
-    
-    # Confirm we can delete objects with spaces in their key
-    
-    assert_nothing_raised do
-      object.delete
-    end
   end
     
   def test_content_type_inference
-    # Confirm appropriate content type is infered when not specified
+    # Confirm appropriate content type is inferred when not specified
 
     content_type_objects = {'foo.jpg' => 'image/jpeg', 'no-extension-specified' => 'binary/octet-stream', 'foo.txt' => 'text/plain'}
     content_type_objects.each_key  do |key|
@@ -291,4 +261,63 @@ class RemoteS3ObjectTest < Test::Unit::TestCase
     # Get rid of objects we just created
     content_type_objects.each_key {|key| S3Object.delete(key, TEST_BUCKET) }
   end
+  
+  def test_body_can_be_more_than_just_string_or_io
+    require 'stringio'
+    key = 'testing-body-as-string-io'
+    io = StringIO.new('hello there')
+    S3Object.store(key, io, TEST_BUCKET)
+    assert_equal 'hello there', S3Object.value(key, TEST_BUCKET)
+  ensure
+    S3Object.delete(key, TEST_BUCKET)
+  end
+  
+  def test_fetching_information_about_an_object_that_does_not_exist_raises_no_such_key
+    assert_raises(NoSuchKey) do
+      S3Object.about('asdfasdfasdfas-this-does-not-exist', TEST_BUCKET)
+    end
+  end
+  
+  # Regression test for http://developer.amazonwebservices.com/connect/thread.jspa?messageID=49152&tstart=0#49152
+  def test_finding_an_object_with_slashes_in_its_name_does_not_escape_the_slash
+    S3Object.store('rails/1', 'value does not matter', TEST_BUCKET)
+    S3Object.store('rails/1.html', 'value does not matter', TEST_BUCKET)
+    
+    object = nil
+    assert_nothing_raised do
+      object = S3Object.find('rails/1.html', TEST_BUCKET)
+    end
+    
+    assert_equal 'rails/1.html', object.key
+  ensure
+    %w(rails/1 rails/1.html).each {|key| S3Object.delete(key, TEST_BUCKET)}
+  end
+  
+  def test_finding_an_object_with_spaces_in_its_name    
+    assert_nothing_raised do
+      S3Object.store('name with spaces', 'value does not matter', TEST_BUCKET)
+    end
+    
+    object = nil
+    assert_nothing_raised do
+      object = S3Object.find('name with spaces', TEST_BUCKET)
+    end
+    
+    assert object
+    assert_equal 'name with spaces', object.key
+    
+    # Confirm authenticated url is generated correctly despite space in file name
+    
+    response = fetch_object_at(object.url)
+    assert (200..299).include?(response.code.to_i)
+    
+  ensure
+    S3Object.delete('name with spaces', TEST_BUCKET)
+  end
+  
+  private
+    def fetch_object_at(url)
+      Net::HTTP.get_response(URI.parse(url))
+    end
+    
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: aws-s3
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-11-30 00:00:00 -06:00
+  version: 0.2.1
+date: 2006-12-04 00:00:00 -06:00
 summary: Client library for Amazon's Simple Storage Service's REST API
 require_paths: 
 - lib