s33r 0.2 → 0.3

data/lib/s33r/sync.rb

@@ -1,7 +1,9 @@
-module S3
+module S33r
+  # Woefully incomplete module for performing sync operations.
+  # Aim is to enable s33r to compare files on the filesystem to S3 objects.
   module Sync
 
-    # get the MD5 checksum for a file (comparable to the ETag on S3 objects)
+    # Get the MD5 checksum for a file (comparable to the ETag on S3 objects).
     def md5sum(filename)
       f = File.open(filename).binmode
       OpenSSL::Digest::MD5.hexdigest(f.read)

data/test/cases/spec_bucket_listing.rb

@@ -1,8 +1,8 @@
 base = File.dirname(__FILE__)
-require base + '/../s3_test_constants'
+require base + '/../test_setup'
 require 'set'
 
-context 'S3 bucket listing' do
+context 'S33r bucket listing' do
   setup do
     xml_file = File.join(base, '../files/bucket_listing.xml')
     @with_bucket_listing_xml = File.open(xml_file) { |f| f.read }
@@ -12,6 +12,7 @@ context 'S3 bucket listing' do
     @with_empty_bucket_listing_xml = File.open(xml_file3) { |f| f.read }
     xml_file4 = File.join(base, '../files/bucket_listing_broken.xml')
     @with_broken_bucket_listing_xml = File.open(xml_file4) { |f| f.read }
+    
     @bucket_listing = BucketListing.new(@with_bucket_listing_xml)
     @bucket_properties = %w(name prefix marker max_keys is_truncated)
     @bucket_property_setters = @bucket_properties.map { |prop| prop + "=" }
@@ -22,21 +23,17 @@ context 'S3 bucket listing' do
   end
 
   specify 'cannot be created from invalid XML' do
-    lambda { BucketListing.new(nil) }.should.raise S3Exception::InvalidBucketListing
+    lambda { BucketListing.new(nil) }.should.raise S33rException::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 S33rException::InvalidBucketListing
   end
 
   specify 'should cope if bucket is empty (i.e. no <Contents> elements)' do
     @bucket_listing.set_listing_xml(@with_empty_bucket_listing_xml)
   end
 
-  specify 'can return the raw XML used to initialise it' do
-    @bucket_listing.listing_xml.should.equal(@with_bucket_listing_xml)
-  end
-
   specify 'can have the bucket listing XML reset' do
     @bucket_listing.should.respond_to :set_listing_xml
   end
@@ -82,11 +79,11 @@ context 'S3 bucket listing' do
   end
   
   specify 'should be able to build a full representation given full object XML from GET on resource key' do
-    fix
+    todo
   end
 
   specify 'should provide easy access to <CommonPrefixes> elements as a hash' do
-    fix
+    todo
   end
 end
 
@@ -112,14 +109,14 @@ context 'S3 object' do
   end
 
   specify 'can be associated with a NamedBucket' do
-    fix
+    todo
   end
 
   specify 'can be saved by proxing through the NamedBucket it is associated with' do
-    fix
+    todo
   end
 
   specify 'cannot be saved unless associated with a NamedBucket' do
-    fix
+    todo
   end
 end

data/test/cases/spec_client.rb

@@ -0,0 +1,65 @@
+base = File.dirname(__FILE__)
+require File.join(base, '../test_setup')
+
+require 'rubygems'
+require_gem 'FakeWeb'
+
+context 'S33r Client' do
+  setup do
+    @base = File.dirname(__FILE__)
+    @client = Client.new(Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY, :use_ssl => false, :dump_requests => true)
+    @client2 = Client.new(Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY)
+    @bucket = 'testingtesting'
+    @url = url_join('http://', HOST, @bucket)
+    
+    @plain_config_file = File.join(@base, '../files/client_config.yml')
+    @custom_config_file = File.join(@base, '../files/namedbucket_config.yml')
+    
+    xml_file = File.join(@base, '../files/bucket_listing.xml')
+    @bucket_listing_xml = File.open(xml_file) { |f| f.read }
+    
+    listbucket_response = Net::HTTPResponse.new('1.1', '200', 'OK')
+    listbucket_response.body = @bucket_listing_xml
+    
+    FakeWeb.register_uri(@url, :status => 200, :response => listbucket_response)
+  end
+
+  specify 'should return use_ssl setting correctly' do
+    @client.use_ssl?.should.not.be true
+    @client2.use_ssl?.should.be true
+  end
+
+  specify 'should trap max_keys too high in bucket listing request' do
+    lambda { @client.list_bucket('duff', :max_keys => (BUCKET_LIST_MAX_MAX_KEYS + 1)) }.should.raise \
+    BucketListingMaxKeysError
+  end
+
+  specify 'should fetch bucket listing ok' do
+    resp, _ = @client.list_bucket(@bucket)
+    resp.ok?.should.be true
+  end
+  
+  specify 'can be initialised from plain config file' do
+    c = Client.init(@plain_config_file)
+    c.aws_access_key.should.equal 'youraccesskey'
+    c.aws_secret_access_key.should.equal 'yoursecretkey'
+  end
+
+  specify 'should be able to convert paths to keys' do
+    todo
+  end
+
+  specify 'should attach BucketListing instance to ListBucketResult response' do
+    todo
+  end
+  
+  specify 'should retain leading slashes on keys when constructing request URLs' do
+    todo
+  end
+  
+  specify 'should recognise custom config variables passed to configuration file loader' do
+    _, _, _, custom = Client.load_config(@custom_config_file)
+    custom[:from_email].should.equal 'you@example.com'
+    custom[:to_email].should.equal 'me@example.com'
+  end
+end

data/test/cases/spec_core.rb

@@ -1,6 +1,7 @@
-require File.dirname(__FILE__) + '/../s3_test_constants'
+base = File.dirname(__FILE__)
+require File.join(base, '../test_setup')
 
-context 'S3 core' do
+context 'S33r core' do
 
   setup do
     @for_request_method = 'PUT'
@@ -22,7 +23,7 @@ context 'S3 core' do
     "text/html\nThu, 17 Nov 2005 18:49:58 GMT\nx-amz-magic:abracadabra\n" +
     "x-amz-meta-author:foo@bar.com\n/quotes/nelson"
     @correct_signature = "jZNOcbfWmD/A/f3hSvVzXZjM2HU="
-    @correct_auth_header = "AWS #{S3Testing::ACCESS_KEY}:#{@correct_signature}"
+    @correct_auth_header = "AWS #{Testing::ACCESS_KEY}:#{@correct_signature}"
 
     @with_invalid_bucket_name = '/badbucket'
     @with_invalid_bucket_name2 = 'badbucket/'
@@ -37,23 +38,23 @@ context 'S3 core' do
   end
 
   specify 'should generate correct signatures' do
-    generate_signature(S3Testing::SECRET_ACCESS_KEY,
+    generate_signature(Testing::SECRET_ACCESS_KEY,
     @correct_canonical_string).should.equal @correct_signature
   end
 
   specify 'should generate correct auth headers' do
     generate_auth_header_value(@for_request_method, @for_request_path, @for_request_headers,
-    S3Testing::ACCESS_KEY, S3Testing::SECRET_ACCESS_KEY).should.equal @correct_auth_header
+    Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY).should.equal @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 \
-    S3Exception::MethodNotAvailable
+    MethodNotAvailable
   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 S3Exception::MissingRequiredHeaders
+    nil, nil) }.should.raise MissingRequiredHeaders
   end
 
   specify 'when generating auth header, should allow addition of Date and Content-Type headers' do
@@ -68,7 +69,7 @@ context 'S3 core' do
 
   specify 'should not generate canned ACL header if invalid canned ACL supplied' do
     lambda { canned_acl_header('duff') }.should.raise \
-    S3Exception::UnsupportedCannedACL
+    UnsupportedCannedACL
   end
 
   specify 'should correctly add canned ACL headers' do
@@ -91,9 +92,9 @@ context 'S3 core' do
 
   specify 'should recognise invalid bucket names' do
     lambda { bucket_name_valid?(@with_invalid_bucket_name) }.should.raise \
-    S3Exception::MalformedBucketName
+    MalformedBucketName
     lambda { bucket_name_valid?(@with_invalid_bucket_name2) }.should.raise \
-    S3Exception::MalformedBucketName
+    MalformedBucketName
   end
 
   specify 'should return empty string if generating querystring with no key/value pairs' do
@@ -123,8 +124,12 @@ context 'S3 core' do
   end
   
   specify 'should generate URLs with authentication parameters' do
-    s3_authenticated_url(S3Testing::ACCESS_KEY, S3Testing::SECRET_ACCESS_KEY, 'quotes', 'nelson', \
+    s3_authenticated_url(Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY, 'quotes', 'nelson', \
     1141889120).should.equal @correct_authenticated_url
   end
+  
+  specify 'should generate correct public URLs' do
+    todo
+  end
 
 end

data/test/cases/spec_namedbucket.rb

@@ -0,0 +1,32 @@
+base = File.dirname(__FILE__)
+require File.join(base, '../test_setup')
+
+require 'rubygems'
+require_gem 'FakeWeb'
+
+context 'NamedBucket client' do
+  setup do
+    @base = File.dirname(__FILE__)
+    @config_filename = @base + '/../files/namedbucket_config.yml'
+  end
+  
+  specify 'should keep a copy of the current bucket listing inside as a property' do
+    todo
+  end
+
+  specify 'should enable prefix, marker etc. to be reset from NamedBucket and refresh wrapped bucket listing object' do
+    todo
+  end
+  
+  specify 'should be able to load config from a file' do
+    FakeWeb.register_uri('http://s3.amazonaws.com/nobucket', :status => 200)
+    client = NamedBucket.init(@config_filename)
+    
+    client.aws_access_key.should.equal 'youraccesskey'
+    client.aws_secret_access_key.should.equal 'yoursecretkey'
+    client.bucket_name.should.equal 'nobucket'
+    client.strict?.should.be false
+    client.public_contents?.should.be true
+    client.use_ssl?.should.be false
+  end
+end

data/test/cases/spec_sync.rb

@@ -1,6 +1,7 @@
-require File.dirname(__FILE__) + '/../s3_test_constants'
+base = File.dirname(__FILE__)
+require File.join(base, '../test_setup')
 
-context 'S3 sync methods' do
+context 'S33r sync methods' do
   setup do
     @base_dir = File.dirname(__FILE__)
     @text_filename =  @base_dir + '/../files/textfile.txt'
@@ -16,14 +17,14 @@ context 'S3 sync methods' do
   end
 
   specify 'should be able to map a directory structure to S3 bucket keys' do
-    fix
+    todo
   end
 
   specify 'should return an array of local files to put to S3 based on differences between MD5 checksums' do
-    fix
+    todo
   end
 
   specify 'should convert S3 bucket keys into a "virtual" directory and file structure' do
-    fix
+    todo
   end
 end

data/test/cases/spec_xml.rb

@@ -1,5 +1,5 @@
 base = File.dirname(__FILE__)
-require File.join(base, '../s3_test_constants')
+require File.join(base, '../test_setup')
 
 context 'LibXML extensions' do
   setup do

data/test/files/client_config.yml

@@ -0,0 +1,6 @@
+# TODO: check can init Client from basic config. file
+aws_access_key: 'youraccesskey'
+aws_secret_access_key: 'yoursecretkey'
+options:
+  use_ssl: false
+  dump_requests: true

data/test/files/namedbucket_config.yml

@@ -0,0 +1,12 @@
+aws_access_key: 'youraccesskey'
+aws_secret_access_key: 'yoursecretkey'
+## options for Client or NamedBucket instances
+options:
+  strict: false
+  public_contents: true
+  use_ssl: false
+  default_bucket: 'nobucket'
+## extensions used in your own program
+custom:
+  to_email: 'me@example.com'
+  from_email: 'you@example.com'

data/test/{s3_test_constants.rb → test_setup.rb}

@@ -3,18 +3,19 @@ require 'rubygems'
 require_gem 'rspec'
 
 require File.dirname(__FILE__) + '/../lib/s33r'
-include S3
-include S3::Sync
+include S33r
+include S33r::S33rException
+include S33r::Sync
 
 # set up some constants
-module S3Testing
+module Testing
   ACCESS_KEY = '44CF9590006BF252F707'
   SECRET_ACCESS_KEY = 'OtxrzxIsfpFjA7SwPzILwy8Bw21TLhquhboDYROV'
 end
 
-# convenience for highlighting todos
-def fix
-  fail 'todo'
+# convenience for highlighting tasks
+def todo
+  fail
 end
 
 # clean newlines and tabs from XML to make comparisons easier

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: s33r
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2006-08-23 00:00:00 +01:00
+  version: "0.3"
+date: 2006-09-26 00:00:00 +01:00
 summary: A library for accessing Amazon S3
 require_paths: 
 - lib
@@ -30,21 +30,20 @@ authors:
 - Elliot Smith
 files: 
 - bin/s3cli.rb
-- bin/config.yml
 - lib/s33r
 - lib/s33r.rb
 - lib/s33r/sync.rb
 - lib/s33r/client.rb
 - lib/s33r/mimetypes.rb
-- lib/s33r/net_http_overrides.rb
+- lib/s33r/s33r_http.rb
 - lib/s33r/bucket_listing.rb
-- lib/s33r/s3_exception.rb
 - lib/s33r/core.rb
 - lib/s33r/named_bucket.rb
 - lib/s33r/libxml_extensions.rb
+- lib/s33r/s33r_exception.rb
 - test/files
 - test/test_bucket_setup.rb
-- test/s3_test_constants.rb
+- test/test_setup.rb
 - test/cases
 - test/files/wave.jpg
 - test/files/textfile.txt
@@ -53,15 +52,68 @@ files:
 - test/files/bucket_listing_broken.xml
 - test/files/bucket_listing2.xml
 - test/files/bucket_listing3.xml
+- test/files/namedbucket_config.yml
+- test/files/client_config.yml
 - test/cases/spec_core.rb
 - test/cases/spec_sync.rb
-- test/cases/unit_client.rb
 - test/cases/spec_bucket_listing.rb
-- test/cases/unit_named_bucket.rb
 - test/cases/spec_xml.rb
-- LICENSE.txt
-- README.txt
-- MIT-LICENSE
+- test/cases/spec_client.rb
+- test/cases/spec_namedbucket.rb
+- html/created.rid
+- html/rdoc-style.css
+- html/files
+- html/classes
+- html/fr_file_index.html
+- html/fr_class_index.html
+- html/fr_method_index.html
+- html/index.html
+- html/files/README_txt.html
+- html/files/MIT-LICENSE.html
+- html/files/CHANGELOG.html
+- html/files/lib
+- html/files/lib/s33r_rb.html
+- html/files/lib/s33r
+- html/files/lib/s33r/sync_rb.html
+- html/files/lib/s33r/client_rb.html
+- html/files/lib/s33r/mimetypes_rb.html
+- html/files/lib/s33r/s33r_http_rb.html
+- html/files/lib/s33r/bucket_listing_rb.html
+- html/files/lib/s33r/core_rb.html
+- html/files/lib/s33r/named_bucket_rb.html
+- html/files/lib/s33r/libxml_extensions_rb.html
+- html/files/lib/s33r/s33r_exception_rb.html
+- html/classes/XML.html
+- html/classes/XML
+- html/classes/Net.html
+- html/classes/Net
+- html/classes/MIME.html
+- html/classes/MIME
+- html/classes/S33r.html
+- html/classes/S33r
+- html/classes/XML/Node.html
+- html/classes/XML/Document.html
+- html/classes/Net/HTTPGenericRequest.html
+- html/classes/Net/HTTPResponse.html
+- html/classes/MIME/Types.html
+- html/classes/MIME/InvalidContentType.html
+- html/classes/MIME/Type.html
+- html/classes/S33r/S33rException.html
+- html/classes/S33r/S33rException
+- html/classes/S33r/Sync.html
+- html/classes/S33r/S3User.html
+- html/classes/S33r/S3Object.html
+- html/classes/S33r/NamedBucket.html
+- html/classes/S33r/BucketListing.html
+- html/classes/S33r/Client.html
+- html/classes/S33r/S33rException/MissingResource.html
+- html/classes/S33r/S33rException/InvalidBucketListing.html
+- html/classes/S33r/S33rException/BucketListingMaxKeysError.html
+- html/classes/S33r/S33rException/MalformedBucketName.html
+- html/classes/S33r/S33rException/MissingRequiredHeaders.html
+- html/classes/S33r/S33rException/MethodNotAvailable.html
+- html/classes/S33r/S33rException/UnsupportedCannedACL.html
+- html/classes/S33r/S33rException/UnsupportedHTTPMethod.html
 test_files: []
 
 rdoc_options: []