s33r 0.4.2 → 0.5

data/lib/s33r/sync.rb

@@ -1,13 +0,0 @@
-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 local file (comparable to the ETag on S3 objects).
-    def md5sum(filename)
-      f = File.open(filename).binmode
-      OpenSSL::Digest::MD5.hexdigest(f.read)
-    end
-
-  end
-end

data/test/cases/spec_all_buckets.rb

@@ -1,28 +0,0 @@
-base = File.dirname(__FILE__)
-require base + '/../test_setup'
-
-require 'rubygems'
-require_gem 'FakeWeb'
-
-context 'S33r list of all buckets' do
-  setup do
-    @client = Client.new(Testing::ACCESS_KEY, Testing::SECRET_ACCESS_KEY, :use_ssl => false, :dump_requests => true)
-
-    xml_file = File.join(File.dirname(__FILE__), '../files/all_buckets.xml')
-    @list_all_buckets_result = File.open(xml_file) { |f| f.read }
-    
-    listallbuckets_response = Net::HTTPResponse.new('1.1', '200', 'OK')
-    listallbuckets_response.body = @list_all_buckets_result
-    
-    base_url = s3_url('/')
-    FakeWeb.register_uri(base_url, :status => 200, :response => listallbuckets_response)
-    FakeWeb.register_uri(base_url + 'elliotsmith-backup', :status => 200)
-    FakeWeb.register_uri(base_url + 'elliotsmith-helloworld', :status => 200)
-    FakeWeb.register_uri(base_url + 'elliotsmith-herbert', :status => 200)
-  end
-  
-  specify 'should parse ListAllMyBucketsResult and get right number of buckets' do
-    buckets = @client.list_buckets
-    buckets.size.should.be 3
-  end
-end

data/test/cases/spec_client.rb

@@ -1,101 +0,0 @@
-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 for testing: one without SSL, one with
-    @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)
-    
-    # test config. files
-    @plain_config_file = File.join(@base, '../files/client_config.yml')
-    @custom_config_file = File.join(@base, '../files/namedbucket_config.yml')
-    
-    # OK bucket with attached response
-    @bucket = 'testingtesting'
-    @url = s3_public_url(@bucket)
-    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)
-    
-    # broken bucket: for testing behaviour if S3 is unavailable
-    @bucket2 = 's3broken'
-    @url2 = s3_public_url(@bucket2)
-    FakeWeb.register_uri(@url2, :status => 503)
-    
-    # OK resource
-    @resource_key = 'iamhere'
-    @url3 = s3_public_url(@bucket, @resource_key)
-    FakeWeb.register_uri(@url3, :status => 200)
-    
-    # missing resource
-    @missing_resource = 'iammissing'
-    @url4 = s3_public_url(@bucket, @missing_resource)
-    FakeWeb.register_uri(@url4, :status => 404)
-    
-    # missing bucket
-    @missing_bucket = 'iamamissingbucket'
-    @url5 = s3_public_url(@missing_bucket)
-    FakeWeb.register_uri(@url5, :status => 404)
-  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, listing = @client.list_bucket(@bucket)
-    resp.ok?.should.be true
-  end
-  
-  # NB tests for content of BucketListing in depth are done in spec_bucket_listing
-  specify 'should attach BucketListing instance to ListBucketResult responses' do
-    resp, listing = @client.list_bucket(@bucket)
-    listing.should.be.an_instance_of BucketListing
-    listing.contents.size.should.be 10
-  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 retain leading slashes on keys when constructing request URLs' do
-    todo
-  end
-  
-  specify 'should raise an error if S3 is down' do
-    lambda { @client.list_bucket(@bucket2) }.should.raise S3FallenOver
-  end
-  
-  specify 'should return S3Object with metadata properties when getting a resource key' do
-    todo
-  end
-  
-  specify 'should identify whether resources exist' do
-    # resource_exists? should work just with a bucket name
-    @client.resource_exists?(@bucket).should.be true
-    
-    # these ones exist
-    @client.bucket_exists?(@bucket).should.be true
-    @client.resource_exists?(@bucket, @resource_key).should.be true
-    
-    # the missing ones
-    @client.resource_exists?(@bucket, @missing_resource).should.be false
-    @client.bucket_exists?(@missing_bucket).should.be false
-  end
-end

data/test/cases/spec_core.rb

@@ -1,128 +0,0 @@
-base = File.dirname(__FILE__)
-require File.join(base, '../test_setup')
-
-context 'S33r core' do
-
-  setup do
-    @for_request_method = 'PUT'
-    @for_request_path = "/quotes/nelson"
-    @for_request_headers = {
-    "Content-Md5" => "c8fdb181845a4ca6b8fec737b3581d76",
-    "Content-Type" => "text/html",
-    "Date" => "Thu, 17 Nov 2005 18:49:58 GMT",
-    "X-Amz-Meta-Author" => "foo@bar.com",
-    "X-Amz-Magic" => "abracadabra"
-    }
-
-    # create broken request header hash
-    @for_incomplete_headers = @for_request_headers.clone.delete_if do |key,value|
-      'Content-Type' == key or 'Date' == key
-    end
-
-    @correct_canonical_string = "PUT\nc8fdb181845a4ca6b8fec737b3581d76\n" +
-    "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 #{Testing::ACCESS_KEY}:#{@correct_signature}"
-
-    @with_invalid_bucket_name = '/badbucket'
-    @with_invalid_bucket_name2 = 'badbucket/'
-    
-    @correct_authenticated_url = "http://s3.amazonaws.com/quotes/nelson?Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D&"+
-    "AWSAccessKeyId=44CF9590006BF252F707&Expires=1141889120"
-    
-    @correct_public_url = "http://s3.amazonaws.com/quotes/nelson"
-  end
-
-  specify 'should generate correct canonical strings' do
-    generate_canonical_string(@for_request_method, @for_request_path,
-    @for_request_headers).should.equal @correct_canonical_string
-  end
-
-  specify 'should generate correct signatures' do
-    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,
-    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 \
-    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 MissingRequiredHeaders
-  end
-
-  specify 'when generating auth header, should allow addition of Date and Content-Type headers' do
-    now = Time.now
-
-    fixed_headers = add_default_headers(@for_incomplete_headers, :date => now,
-    :content_type => 'text/html')
-
-    fixed_headers['Date'].should.equal now.httpdate
-    fixed_headers['Content-Type'].should.equal 'text/html'
-  end
-
-  specify 'should not generate canned ACL header if invalid canned ACL supplied' do
-    lambda { canned_acl_header('duff') }.should.raise \
-    UnsupportedCannedACL
-  end
-
-  specify 'should correctly add canned ACL headers' do
-    new_headers = canned_acl_header('private', { 'Content-Type' => 'text/html' })
-    new_headers.should.have(2).keys
-    new_headers.keys.should.include 'Content-Type'
-    new_headers.keys.should.include 'x-amz-acl'
-    new_headers['x-amz-acl'].should.equal 'private'
-  end
-
-  specify 'should set sensible defaults for missing Content-Type and Date headers' do
-    fixed_headers = add_default_headers(@for_incomplete_headers)
-    fixed_headers['Content-Type'].should.equal ''
-    fixed_headers.include?('Date').should.not.be nil
-  end
-
-  specify 'should default to text/plain mimetype for unknown file types' do
-    guess_mime_type('hello.madeup').should.equal('text/plain')
-  end
-
-  specify 'should recognise invalid bucket names' do
-    lambda { bucket_name_valid?(@with_invalid_bucket_name) }.should.raise \
-    MalformedBucketName
-    lambda { bucket_name_valid?(@with_invalid_bucket_name2) }.should.raise \
-    MalformedBucketName
-  end
-
-  specify 'should return empty string if generating querystring with no key/value pairs' do
-    generate_querystring({}).should_equal ''
-  end
-
-  specify 'should correctly format querystring key/value pairs' do
-    generate_querystring({'message' => 'Hello world', 'id' => 1, 'page' => '[2,4]'}).should_equal \
-    '?message=Hello+world&id=1&page=%5B2%2C4%5D'
-  end
-
-  specify 'should allow symbols as names for querystring variables when generating querystrings' do
-    generate_querystring({ :prefix => '/home/ell' }).should.equal('?prefix=%2Fhome%2Fell')
-  end
-
-  specify 'should convert integers to strings when generating querystrings' do
-    generate_querystring({ 'max-keys' => 400 }).should.equal('?max-keys=400')
-  end
-  
-  specify 'should generate URLs with authentication parameters' do
-    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
-    s3_public_url('quotes', 'nelson').should.equal @correct_public_url
-  end
-
-end

data/test/cases/spec_namedbucket.rb

@@ -1,46 +0,0 @@
-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'
-    @config_filename2 = @base + '/../files/namedbucket_config2.yml'
-    @url = s3_public_url('nobucket')
-  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 enable checking for existence of a resource by key' do
-    FakeWeb.register_uri(@url + '/existing_key', :status => 200)
-    FakeWeb.register_uri(@url + '/broken', :status => 404)
-    client = NamedBucket.init(@config_filename)
-    client.key_exists?('existing_key').should.be true
-    client.key_exists?('broken').should.be false
-  end
-  
-  specify 'should be able to load config from a file' do
-    FakeWeb.register_uri(@url, :status => 200)
-    client = NamedBucket.init(@config_filename)
-    client.aws_access_key.should.equal 'youraccesskey'
-    client.aws_secret_access_key.should.equal 'yoursecretkey'
-    client.name.should.equal 'nobucket'
-    client.strict?.should.be false
-    client.public_contents?.should.be true
-    client.use_ssl.should.be false
-  end
-  
-  specify 'cannot be initialised for non-existent bucket' do
-    FakeWeb.register_uri(@url, :status => 404)
-    lambda { client = NamedBucket.init(@config_filename2) }.should.raise MissingResource
-  end
-end

data/test/cases/spec_sync.rb

@@ -1,34 +0,0 @@
-base = File.dirname(__FILE__)
-require File.join(base, '../test_setup')
-
-context 'S33r sync methods' do
-  setup do
-    @base_dir = File.dirname(__FILE__)
-    @text_filename =  @base_dir + '/../files/textfile.txt'
-    @graphic_filename = @base_dir + '/../files/wave.jpg'
-  end
-
-  specify 'should return MD5 checksum for text files' do
-    md5sum(@text_filename).should.equal('bbf560d44f092d22a30d3a562436ad8c')
-  end
-
-  specify 'should return MD5 checksum for graphic files' do
-    md5sum(@graphic_filename).should.equal('80b669f252257eedd8a2606cb1a0df6a')
-  end
-
-  specify 'should be able to map a directory structure to S3 bucket keys' do
-    todo
-  end
-  
-  specify 'should be able to convert paths to keys' do
-    todo
-  end
-
-  specify 'should return an array of local files to put to S3 based on differences between MD5 checksums' do
-    todo
-  end
-
-  specify 'should convert S3 bucket keys into a "virtual" directory and file structure' do
-    todo
-  end
-end

data/test/files/all_buckets.xml

@@ -1,21 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
-<Owner>
-<ID>56efddfead5aa65da942f156fb2 b294f44d78fd932d701331edc5fba19620fd4</ID>
-<DisplayName>elliotsmith3</DisplayName>
-</Owner>
-<Buckets>
-<Bucket>
-<Name>elliotsmith-backup</Name>
-<CreationDate>2006-07-2 0T13:25:47.000Z</CreationDate>
-</Bucket>
-<Bucket>
-<Name>elliotsmith-helloworld</Name>
-<CreationDate>2006-09-06T14:35:36.000Z</CreationDate>
-</Bucket>
-<Bucket>
-<Name>elliotsmith-herbert</Name>
-<CreationDate>2006-04-18T22:37:06.000Z</CreationDate>
-</Bucket>
-</Buckets>
-</ListAllMyBucketsResult>

data/test/files/client_config.yml

@@ -1,5 +0,0 @@
-aws_access_key: 'youraccesskey'
-aws_secret_access_key: 'yoursecretkey'
-options:
-  use_ssl: false
-  dump_requests: true

data/test/files/namedbucket_config.yml

@@ -1,8 +0,0 @@
-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'

data/test/files/namedbucket_config2.yml

@@ -1,8 +0,0 @@
-aws_access_key: 'youraccesskey'
-aws_secret_access_key: 'yoursecretkey'
-## options for Client or NamedBucket instances
-options:
-  strict: true
-  public_contents: true
-  use_ssl: false
-  default_bucket: 'nobucket'

data/test/test_bucket_setup.rb

@@ -1,41 +0,0 @@
-# for setting up test bucket, so can gather responses from the real S3
-require 'yaml'
-require File.dirname(__FILE__) + '/../lib/s33r.rb'
-
-config_file = '/home/ell/.s33r'
-
-options = YAML::load_file(config_file)
-access_key = options['access_key']
-secret_key = options['secret_key']
-
-bucket = 'elliotsmith-testing'
-
-def bucketeer(client, bucket)
-  lambda do |key, text|
-    client.put_text bucket, '/home/ell/' + key, text
-  end
-end
-
-S3::Client.new(access_key, secret_key) do |client|
-
-  if !client.bucket_exists?(bucket)
-    client.create_bucket(bucket)
-
-    b = bucketeer(client, bucket)
-    b.call 'one.txt', 'one text file'
-    b.call 'two.txt', 'two text file'
-    b.call 'dir1/three.txt', 'three text file'
-    b.call 'dir1/four.txt', 'four text file'
-    b.call 'dir2/five.txt', 'five text file'
-    b.call 'dir2/six.txt', 'six text file'
-    b.call 'dir2/subdir21/seven.txt', 'seven text file'
-    b.call 'dir2/subdir22/eight.txt', 'eight text file'
-    b.call 'dir2/subdir22/subdir221/nine.txt', 'nine text file'
-    b.call 'dir2/subdir22/subdir221/ten.txt', 'ten text file'
-
-  end
-
-#  p client.list_bucket(bucket, :prefix => '/home/ell/dir1').body
-#  p client.list_bucket(bucket, :marker => '/home/ell/dir2/six.txt').body
-   p client.list_bucket(bucket).body
-end