s33r 0.5.3 → 0.5.4

data/examples/fores33r/log/production.log

@@ -0,0 +1 @@
+# Logfile created on Thu Feb 01 10:15:18 +0000 2007 by logger.rb/1.5.2.9

data/examples/fores33r/tmp/fores33r.pid

@@ -0,0 +1 @@
+5232

data/lib/s33r/bucket.rb

@@ -97,5 +97,10 @@ module S33r
     def log_receiver(state=:on)
       change_log_target_status(name, state)
     end
+
+    # Get logging status for bucket
+    def logging
+      super(:bucket => name)
+    end
   end
-end
+end

data/lib/s33r/bucket_listing.rb

@@ -41,7 +41,7 @@ module S33r
         self.send("#{prop}=", node.content) if node
       end
 
-      # metadata
+      # metadata on the bucket
       prop_setter.call(:name, 'Name')
       prop_setter.call(:delimiter, 'Delimiter')
       prop_setter.call(:prefix, 'Prefix')

data/lib/s33r/client.rb

@@ -10,6 +10,9 @@ module S33r
     
     # Use SSL for requests.
     attr_accessor :use_ssl
+
+    # Use subdomains (set on host header)
+    attr_accessor :subdomain
     
     # Default expiry for authenticated URLs.
     attr_accessor :expires
@@ -24,6 +27,7 @@ module S33r
     def request_defaults
       defaults = {}
       defaults[:use_ssl] = @use_ssl
+      defaults[:subdomain] = @subdomain
       defaults[:expires] = @expires
       defaults[:access] = @access
       defaults[:secret] = @secret
@@ -63,6 +67,7 @@ module S33r
     #   option when generating authenticated URLs. Should be parseable by S33r.parse_expiry.
     # * <tt>:canned_acl => 'public-read'</tt>: set a default canned acl to apply to all put 
     #   requests.
+    # * <tt>:subdomain => false</tt>: set to true to use subdomains in URLs
     #
     # These options change the behaviour of the HTTP client which actually sends the request:
     # * <tt>:chunk_size => Integer</tt>: use a non-standard chunk size; 
@@ -74,6 +79,8 @@ module S33r
       # General client options.
       @access = options[:access]
       @secret = options[:secret]
+      @subdomain = false
+      @subdomain = true if (true == options[:subdomain])
       @use_ssl = true
       @use_ssl = false if (false == options[:use_ssl])
       @expires = options[:expires] || 'never'
@@ -190,7 +197,7 @@ module S33r
       end
       
       options[:querystring] = querystring
-    
+
       resp = do_get(options)
       
       if resp.ok?
@@ -375,7 +382,7 @@ module S33r
     #   otherwise 'log-<bucket name>-' is used
     def logs_to(target_bucket, options={})
       target_bucket_name = target_bucket.is_a?(Bucket) ? target_bucket.name : target_bucket
-      log_prefix = options[:prefix] || "log-#{bucket_name}-"
+      log_prefix = options[:prefix] || "log-#{target_bucket_name}-"
       options[:bucket] ||= options[:for_bucket]
       
       target_bucket_acl = get_acl(:bucket => target_bucket_name)
@@ -397,4 +404,4 @@ module S33r
       put(LoggingResource.new, options)
     end
   end
-end
+end

data/lib/s33r/networking.rb

@@ -72,8 +72,11 @@ module S33r
       # Generate the S3 authorization header if the client has 
       # the appropriate instance variable getters.
       unless (false == url_options[:authenticated])
+        subdomain = nil
+        subdomain = url_options[:bucket] if url_options[:subdomain]
+
         headers['Authorization'] = generate_auth_header_value(method, path, headers,
-        url_options[:access], url_options[:secret])
+        url_options[:access], url_options[:secret], subdomain)
       end
 
       # Insert the headers into the request object.
@@ -106,7 +109,7 @@ module S33r
         data = nil
       end
       
-      puts req.to_s if @dump_requests
+      puts req.dump(uri.host) if @dump_requests
       
       # Set up the request.
       ### <snip> start shameless stealing from Marcel Molina
@@ -180,4 +183,4 @@ module S33r
       do_request('HEAD', options, headers)
     end
   end
-end
+end

data/lib/s33r/s33r_http.rb

@@ -54,10 +54,10 @@ class Net::HTTPGenericRequest
   # 
   # Switch on request debugging by passing <tt>:dump_requests => true</tt> to S33r::Client
   # constructor.
-  def to_s
+  def dump(host)
     str = "*******\n" +
     "#{self.class::METHOD} #{@path} HTTP/1.1\n" +
-    "Host: #{S33r::HOST}\n"
+    "Host: #{host}\n"
 
     self.each_capitalized do |key, value|
       str += "#{key}: #{value}\n"
@@ -84,8 +84,9 @@ class Net::HTTPGenericRequest
       sock.write "0\r\n\r\n"
     else
       while s = f.read(@chunk_size)
+        puts "Writing " + @chunk_size.to_s + " bytes to network stream"
         sock.write s
       end
     end
   end
-end
+end

data/lib/s33r/s3_logging.rb

@@ -10,7 +10,7 @@ module S33r
     # To set a Bucket up for logging, create a LoggingResource with the correct log_target and 
     # log_prefix settings and put that to the ?logging URL for a bucket.
     class LoggingResource
-      attr_reader :log_target, :log_prefix
+      attr_accessor :log_target, :log_prefix
     
       # +log_target+ is the bucket to put logs into.
       # +log_prefix+ is the prefix for log files put into the +log_target+ bucket.
@@ -109,4 +109,4 @@ module S33r
       end
     end
   end
-end
+end

data/lib/s33r/utility.rb

@@ -99,7 +99,8 @@ module S33r
   # * +headers+ is a hash of headers which are going to be sent with the request.
   # * +expires+ is the expiry time set in the querystring for authenticated URLs: 
   #   if supplied, it is used for the +date+ header.
-  def generate_canonical_string(method, path, headers={}, expires=nil)
+  # * +subdomain+ is the bucket name if using "virtual hosts"
+  def generate_canonical_string(method, path, headers={}, expires=nil, subdomain=nil)
     interesting_headers = {}
     headers.each do |key, value|
       lk = key.downcase
@@ -117,7 +118,9 @@ module S33r
       interesting_headers['date'] = expires
     end
 
-    buf = "#{method}\n"
+    buf = ''
+
+    buf << "#{method}\n"
     interesting_headers.sort { |a, b| a[0] <=> b[0] }.each do |key, value|
       if key =~ /^#{AWS_HEADER_PREFIX}/o
         buf << "#{key}:#{value}\n"
@@ -126,6 +129,8 @@ module S33r
       end
     end
 
+    buf << '/' + subdomain unless subdomain.nil?
+
     # Ignore everything after the question mark...
     buf << path.gsub(/\?.*$/, '')
 
@@ -142,7 +147,7 @@ module S33r
   end
 
   # Get the value for the AWS authentication header.
-  def generate_auth_header_value(method, path, headers, aws_access_key, aws_secret_access_key)
+  def generate_auth_header_value(method, path, headers, aws_access_key, aws_secret_access_key, subdomain)
     raise MethodNotAllowed, "Method %s not available" % method if !METHOD_VERBS.include?(method)
 
     # check the headers needed for authentication have been set
@@ -156,7 +161,7 @@ module S33r
     if aws_access_key.nil? or aws_secret_access_key.nil?
 
     # get the AWS header
-    canonical_string = generate_canonical_string(method, path, headers)
+    canonical_string = generate_canonical_string(method, path, headers, nil, subdomain)
     signature = generate_signature(aws_secret_access_key, canonical_string)
     AWS_AUTH_HEADER_VALUE % [aws_access_key, signature]
   end
@@ -367,7 +372,7 @@ module S33r
     path = options[:path]
     path ||= s3_path(options)
     host = HOST
-    host = (options[:bucket] + "." + host ) if options[:subdomain]
+    host = (options[:bucket] + "." + host ) if options[:subdomain] and options[:bucket]
     "#{scheme}://" + host + path
   end
   
@@ -439,4 +444,4 @@ module S33r
     namespace = S33r::RESPONSE_NAMESPACE_URI.gsub('/', '\/')
     xml_in.gsub(/ xmlns="#{namespace}"/, '')
   end
-end
+end

data/test/cases/spec_acl.rb

@@ -68,12 +68,12 @@ context 'S33r ACL functions' do
   specify 'needs equality method for grantees' do
     test_grantee = Group.new(:all_users)
     test_grantee.should == @group_grantee
-    test_grantee.should.not.equal @amazon_grantee
+    test_grantee.should_not equal @amazon_grantee
   end
   
   specify 'should only accept valid permission specifiers' do
-    lambda { Grant.new(@group_grantee, nil) }.should.raise InvalidPermission
-    lambda { Grant.new(@group_grantee, :broken) }.should.raise InvalidPermission
+    lambda { Grant.new(@group_grantee, nil) }.should raise_error InvalidPermission
+    lambda { Grant.new(@group_grantee, :broken) }.should raise_error InvalidPermission
   end
   
   specify 'should correctly create AmazonCustomer grantee from XML node' do
@@ -111,6 +111,6 @@ context 'S33r ACL functions' do
     @full_acl_doc.grants.each do |g|
       acl_doc_from_xml.grants = acl_doc_from_xml.grants.delete_if { |i| i == g }
     end
-    acl_doc_from_xml.grants.should.be.empty
+    acl_doc_from_xml.grants.size.should == 0
   end
-end
+end

data/test/cases/spec_bucket_listing.rb

@@ -15,15 +15,15 @@ context 'S33r bucket listing' do
   end
 
   specify 'can only be created if bucket listing XML supplied' do
-    lambda { BucketListing.new }.should.raise ArgumentError
+    lambda { BucketListing.new }.should raise_error ArgumentError
   end
 
   specify 'cannot be created from invalid XML' do
-    lambda { BucketListing.new(nil) }.should.raise S3Exception::InvalidBucketListing
+    lambda { BucketListing.new(nil) }.should raise_error S3Exception::InvalidBucketListing
   end
 
   specify 'should recover gracefully from broken bucket listing XML' do
-    lambda { BucketListing.new(@with_broken_bucket_listing_xml) }.should.raise S3Exception::InvalidBucketListing
+    lambda { BucketListing.new(@with_broken_bucket_listing_xml) }.should raise_error S3Exception::InvalidBucketListing
   end
 
   specify 'should cope if bucket is empty (i.e. no <Contents> elements)' do
@@ -40,7 +40,7 @@ context 'S33r bucket listing' do
     @bucket_listing.marker.should ==('')
     @bucket_listing.max_keys.should ==(1000)
     @bucket_listing.is_truncated.should ==(false)
-    @bucket_listing.delimiter.should.be nil
+    @bucket_listing.delimiter.should be nil
   end
 
   specify 'when listing XML is reset, should update all properties correctly' do
@@ -63,16 +63,16 @@ context 'S33r bucket listing' do
   end
 
   specify 'should store resources (<Contents> elements) in a hash' do
-    @bucket_listing.size.should_be 10
+    @bucket_listing.size.should be 10
     first_obj = @bucket_listing['/home/ell/dir1/four.txt']
-    first_obj.should_be_instance_of S3Object
+    first_obj.should be_instance_of S3Object
   end
   
   # attempting to fix ListBucketResult errors reported by Alex Payne
   specify 'should handle suspect bucket listing' do
     puts @with_suspect_bl_xml
     bl = BucketListing.new(@with_suspect_bl_xml)
-    bl.size.should_be 1
-    bl.keys.should.include 'orly.jpg'
+    bl.size.should be 1
+    bl.keys.should include 'orly.jpg'
   end
-end
+end

data/test/cases/spec_logging.rb

@@ -29,19 +29,19 @@ context 'S33r logging' do
   end
   
   specify 'should represent LogDelivery grants so buckets can act as logging targets' do
-    @logging_acl_doc.grants.should.include @log_delivery_write
-    @logging_acl_doc.grants.should.include @log_delivery_read_acl
+    @logging_acl_doc.grants.should include @log_delivery_write
+    @logging_acl_doc.grants.should include @log_delivery_read_acl
   end
   
   specify 'should be able to report whether an ACL indicates bucket is a logging target' do
-    @logging_acl_doc.log_targetable?.should.be true
+    @logging_acl_doc.log_targetable?.should be true
     
     # check the variant where the grants have been removed
-    @logging_acl_doc_no_grants.log_targetable?.should.be false
+    @logging_acl_doc_no_grants.log_targetable?.should be false
   end
   
   specify 'should be able to simply add logging target grants to an ACL' do
     @logging_acl_doc_no_grants.add_log_target_grants
     clean_xml(@logging_acl_doc_no_grants.to_xml).should == @logging_acl_xml
   end
-end
+end

data/test/cases/spec_s3_object.rb

@@ -34,27 +34,11 @@ context 'S3 object' do
     @s3obj2.bucket.name.should == 'quotes'
   end
   
-  specify 'can be created from a file' do
-    todo
-  end
-
   specify 'should treat the owner as an object in his/her own right' do
     [@s3obj.owner.user_id, @s3obj.owner.display_name].should == \
     ['56efddfead5aa65da942f156fb2b294f44d78fd932d701331edc5fba19620fd4', 'elliotsmith3']
     @s3obj.owner.should_be_instance_of S3ACL::CanonicalUser
   end
-
-  specify 'can be saved' do
-    todo
-  end
-  
-  specify 'can be renamed' do
-    todo
-  end
-  
-  specify 'can be deleted' do
-    todo
-  end
   
   specify 'should return authenticated URL' do
     @s3obj2.url(:authenticated => true, :expires => 1141889120).should == @correct_authenticated_url
@@ -71,4 +55,4 @@ context 'S3 object' do
   specify 'should optionally return URL with domain name set to bucket name' do
     @s3obj2.url(:subdomain => true).should == @correct_public_url_with_subdomain
   end
-end
+end

data/test/cases/spec_utility.rb

@@ -63,7 +63,7 @@ context 'S33r utility' do
     config, options = S33r.load_config(@yaml_file)
     options[:email_to].should == Testing::EMAIL
     # Make sure the 'options' section has not been included in the general config..
-    config.keys.should.not.include :options
+    config.keys.should_not include :options
   end
 
   specify 'should generate correct canonical strings' do
@@ -78,17 +78,17 @@ context 'S33r utility' do
 
   specify 'should generate correct auth headers' do
     generate_auth_header_value(@for_request_method, @for_request_path, @for_request_headers,
-    Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY).should == @correct_auth_header
+    Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY, nil).should == @correct_auth_header
   end
 
   specify 'should not generate auth header if bad HTTP method passed' do
-    lambda { generate_auth_header_value('duff', nil, nil, nil, nil) }.should.raise \
+    lambda { generate_auth_header_value('duff', nil, nil, nil, nil, nil) }.should raise_error \
     MethodNotAllowed
   end
 
   specify 'should not generate auth header if required headers missing' do
     lambda { generate_auth_header_value('PUT', '/', @for_incomplete_headers,
-    nil, nil) }.should.raise MissingRequiredHeaders
+    nil, nil, nil) }.should raise_error MissingRequiredHeaders
   end
 
   specify 'when generating auth header, should allow addition of Date and Content-Type headers' do
@@ -104,28 +104,28 @@ context 'S33r utility' do
   specify 'should generate correct x-amz-meta- headers from a hash' do
     meta = {'myname' => 'elliot', 'myage' => 36}
     headers = metadata_headers(meta)
-    headers.should.include 'x-amz-meta-myname'
-    headers.should.include 'x-amz-meta-myage'
+    headers.should include 'x-amz-meta-myname'
+    headers.should include 'x-amz-meta-myage'
     headers['x-amz-meta-myname'].should == 'elliot'
     headers['x-amz-meta-myage'].should == '36'
   end
 
   specify 'should not generate canned ACL header if invalid canned ACL supplied' do
-    lambda { canned_acl_header('duff') }.should.raise \
+    lambda { canned_acl_header('duff') }.should raise_error \
     UnsupportedCannedACL
   end
 
   specify 'should correctly add canned ACL headers' do
     new_headers = canned_acl_header('private')
-    new_headers.should.have(1).keys
-    new_headers.keys.should.include 'x-amz-acl'
+    new_headers.should have(1).keys
+    new_headers.keys.should include 'x-amz-acl'
     new_headers['x-amz-acl'].should == 'private'
   end
 
   specify 'should set sensible defaults for missing Content-Type and Date headers' do
     fixed_headers = default_headers(@for_incomplete_headers)
     fixed_headers['Content-Type'].should == ''
-    fixed_headers.include?('Date').should.not.be nil
+    fixed_headers.include?('Date').should_not === nil
   end
 
   specify 'should default to text/plain mimetype for unknown file types' do
@@ -144,9 +144,9 @@ context 'S33r utility' do
   end
 
   specify 'should recognise invalid bucket names' do
-    lambda { bucket_name_valid?(@with_invalid_bucket_name) }.should.raise \
+    lambda { bucket_name_valid?(@with_invalid_bucket_name) }.should raise_error \
     MalformedBucketName
-    lambda { bucket_name_valid?(@with_invalid_bucket_name2) }.should.raise \
+    lambda { bucket_name_valid?(@with_invalid_bucket_name2) }.should raise_error \
     MalformedBucketName
   end
 
@@ -234,14 +234,14 @@ context 'S33r utility' do
     expected_expiry = Time.now.to_i + DEFAULT_EXPIRY_SECS
     expires = S33r.parse_expiry
     expires.should == expected_expiry
-    expires.should_be_kind_of Integer
+    expires.class.should == Bignum
     
     # If :far_flung_future is passed, default to 20 years from now.
     expected_expiry = Time.now.to_i + 
     (60 * 60 * 24 * 365.25 * 20).to_i
     expires = S33r.parse_expiry(:far_flung_future)
     expires.should == expected_expiry
-    expires.should_be_kind_of Integer
+    expires.class.should == Bignum
     
     class Time
       remove_method(:to_i)
@@ -254,7 +254,7 @@ context 'S33r utility' do
     expected_expiry = Time.parse(datetime_str).to_i
     expires = S33r.parse_expiry(datetime_str)
     expires.should == expected_expiry
-    expires.should_be_kind_of Integer
+    expires.class.should == Bignum
   end
   
   specify 'should provide a method for converting string keys of a hash into symbols' do
@@ -268,4 +268,4 @@ context 'S33r utility' do
     s3_url(:bucket => 'quotes', :key => 'some key').should == @url_with_unescaped_key
   end
 
-end
+end