Merge lp:~nick-craig-wood/goamz/list-buckets2 into lp:goamz

[Nick Craig-Wood]

Implement S3.List to list all Buckets

This allows the user to discover all S3 buckets that they have

https://codereview.appspot.com/10684043/

[Nick Craig-Wood (nick-craig-wood)]

See https://code.launchpad.net/~nick-craig-wood/goamz/list-buckets/+merge/146925 for old code review.

I've messed up that branch somehow so here is a new one

[lp:~nick-craig-wood/goamz/list-buckets2]

39. By Nick Craig-Wood on 2013-06-29

s3: ListBuckets: Fix signpath which was causing authentication errors

Unmerged revisions

39. By Nick Craig-Wood on 2013-06-29

s3: ListBuckets: Fix signpath which was causing authentication errors

38. By Nick Craig-Wood on 2013-06-27

Implement S3.List to list all Buckets

=== modified file 's3/responses_test.go'
--- s3/responses_test.go	2013-02-12 04:50:11 +0000
+++ s3/responses_test.go	2013-06-29 10:57:22 +0000
@@ -196,3 +196,22 @@
   <HostId>kjhwqk</HostId>
 </Error>
 `
+
+var GetBucketsListResultDump = `
+<ListAllMyBucketsResult xmlns="http://doc.s3.amazonaws.com/2006-03-01">
+  <Owner>
+    <ID>bcaf1ffd86f461ca5fb16fd081034f</ID>
+    <DisplayName>webfile</DisplayName>
+  </Owner>
+  <Buckets>
+    <Bucket>
+      <Name>quotes</Name>
+      <CreationDate>2006-02-03T16:45:09.000Z</CreationDate>
+    </Bucket>
+    <Bucket>
+      <Name>samples</Name>
+      <CreationDate>2006-02-03T16:41:58.000Z</CreationDate>
+    </Bucket>
+  </Buckets>
+</ListAllMyBucketsResult>
+`
 
=== modified file 's3/s3.go'
--- s3/s3.go	2013-05-21 14:39:01 +0000
+++ s3/s3.go	2013-06-29 10:57:22 +0000
@@ -40,6 +40,9 @@
 type Bucket struct {
 	*S3
 	Name string
+	// The following fields are only set on buckets returned from the ListBuckets call
+	Owner        Owner     // Owner of the bucket
+	CreationDate time.Time // When the bucket was created
 }
 
 // The Owner type represents the owner of the object in an S3 bucket.
@@ -64,7 +67,44 @@
 	if s3.Region.S3BucketEndpoint != "" || s3.Region.S3LowercaseBucket {
 		name = strings.ToLower(name)
 	}
-	return &Bucket{s3, name}
+	return &Bucket{S3: s3, Name: name}
+}
+
+// bucketsResp is returned by S3.Buckets
+type bucketsResp struct {
+	Owner   Owner
+	Buckets []struct {
+		Name         string
+		CreationDate string // Date the bucket was created, e.g., 2009-02-03T16:45:09.000Z
+	} `xml:"Buckets>Bucket"`
+}
+
+// List returns a list of all buckets owned by the sender
+//
+// See http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
+func (s3 *S3) ListBuckets() (buckets []*Bucket, err error) {
+	req := &request{
+		method: "GET",
+		bucket: "",
+		path:   "",
+	}
+	result := &bucketsResp{}
+	err = s3.query(req, result)
+	if err != nil {
+		return nil, err
+	}
+	buckets = make([]*Bucket, len(result.Buckets))
+	for i := range buckets {
+		info := result.Buckets[i]
+		b := s3.Bucket(info.Name)
+		b.CreationDate, err = time.Parse(time.RFC3339Nano, info.CreationDate)
+		if err != nil {
+			return nil, err
+		}
+		b.Owner = result.Owner
+		buckets[i] = b
+	}
+	return buckets, nil
 }
 
 var createBucketConfiguration = `<CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> 
@@ -418,19 +458,21 @@
 			req.path = "/" + req.path
 		}
 		req.signpath = req.path
+		req.baseurl = s3.Region.S3BucketEndpoint
+		if req.baseurl == "" {
+			// Use the path method to address the bucket.
+			req.baseurl = s3.Region.S3Endpoint
+			if req.bucket != "" {
+				req.path = "/" + req.bucket + req.path
+			}
+		} else {
+			// Just in case, prevent injection.
+			if strings.IndexAny(req.bucket, "/:@") >= 0 {
+				return fmt.Errorf("bad S3 bucket: %q", req.bucket)
+			}
+			req.baseurl = strings.Replace(req.baseurl, "${bucket}", req.bucket, -1)
+		}
 		if req.bucket != "" {
-			req.baseurl = s3.Region.S3BucketEndpoint
-			if req.baseurl == "" {
-				// Use the path method to address the bucket.
-				req.baseurl = s3.Region.S3Endpoint
-				req.path = "/" + req.bucket + req.path
-			} else {
-				// Just in case, prevent injection.
-				if strings.IndexAny(req.bucket, "/:@") >= 0 {
-					return fmt.Errorf("bad S3 bucket: %q", req.bucket)
-				}
-				req.baseurl = strings.Replace(req.baseurl, "${bucket}", req.bucket, -1)
-			}
 			req.signpath = "/" + req.bucket + req.signpath
 		}
 	}
 
=== modified file 's3/s3_test.go'
--- s3/s3_test.go	2013-05-23 02:56:41 +0000
+++ s3/s3_test.go	2013-06-29 10:57:22 +0000
@@ -4,6 +4,7 @@
 	"bytes"
 	"io/ioutil"
 	"net/http"
+	"net/url"
 	"testing"
 
 	"launchpad.net/goamz/aws"
@@ -276,3 +277,31 @@
 	c.Assert(len(data.Contents), Equals, 0)
 	c.Assert(data.CommonPrefixes, DeepEquals, []string{"photos/2006/feb/", "photos/2006/jan/"})
 }
+
+// List buckets docs: See http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
+
+func (s *S) TestListBuckets(c *C) {
+	testServer.Response(200, nil, GetBucketsListResultDump)
+
+	buckets, err := s.s3.ListBuckets()
+	c.Assert(err, IsNil)
+
+	req := testServer.WaitRequest()
+	c.Assert(req.Method, Equals, "GET")
+	c.Assert(req.URL.Path, Equals, "/")
+	c.Assert(req.Header["Date"], Not(Equals), "")
+	c.Assert(req.Form, DeepEquals, url.Values{})
+
+	c.Assert(len(buckets), Equals, 2)
+
+	c.Assert(buckets[0].Name, Equals, "quotes")
+	c.Assert(buckets[0].CreationDate, Equals, time.Date(2006, 2, 3, 16, 45, 9, 0, time.UTC))
+	c.Assert(buckets[0].Owner.ID, Equals, "bcaf1ffd86f461ca5fb16fd081034f")
+	c.Assert(buckets[0].Owner.DisplayName, Equals, "webfile")
+
+	c.Assert(buckets[1].Name, Equals, "samples")
+	c.Assert(buckets[1].CreationDate, Equals, time.Date(2006, 2, 3, 16, 41, 58, 0, time.UTC))
+	c.Assert(buckets[1].Owner.ID, Equals, "bcaf1ffd86f461ca5fb16fd081034f")
+	c.Assert(buckets[1].Owner.DisplayName, Equals, "webfile")
+
+}