Start work on major S3 refactor, adding support for bucket and service requests

@@ -21,7 +21,7 @@
 #import "ASIInputStream.h"
 #import "ASIInputStream.h"
 
 
 // Automatically set on build
 // Automatically set on build
-NSString *ASIHTTPRequestVersion = @"v1.6-4 2010-03-16";
+NSString *ASIHTTPRequestVersion = @"v1.6-5 2010-03-16";
 
 
 NSString* const NetworkRequestErrorDomain = @"ASIHTTPRequestErrorDomain";
 NSString* const NetworkRequestErrorDomain = @"ASIHTTPRequestErrorDomain";
 
 

 //
 //
-//  ASIS3ListRequest.h
+//  ASIS3BucketRequest.h
 //  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
 //  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
 //
 //
-//  Created by Ben Copsey on 13/07/2009.
-//  Copyright 2009 All-Seeing Interactive. All rights reserved.
+//  Created by Ben Copsey on 16/03/2010.
+//  Copyright 2010 All-Seeing Interactive. All rights reserved.
 //
 //
+//  Use this class to create buckets, fetch a list of their contents, and delete buckets
 
 
 #import <Foundation/Foundation.h>
 #import <Foundation/Foundation.h>
 #import "ASIS3Request.h"
 #import "ASIS3Request.h"
+
 @class ASIS3BucketObject;
 @class ASIS3BucketObject;
 
 
-@interface ASIS3ListRequest : ASIS3Request <NSCopying> {
+@interface ASIS3BucketRequest : ASIS3Request {
+	// Name of the bucket to talk to
+	NSString *bucket;
+	NSString *subResource;
 	
 	
-	// Options for filtering list requests
+	// Options for filtering GET requests
 	// See http://docs.amazonwebservices.com/AmazonS3/2006-03-01/index.html?RESTBucketGET.html
 	// See http://docs.amazonwebservices.com/AmazonS3/2006-03-01/index.html?RESTBucketGET.html
 	NSString *prefix;
 	NSString *prefix;
 	NSString *marker;
 	NSString *marker;
 	int maxResultCount;
 	int maxResultCount;
-	NSString *delimiter;	
+	NSString *delimiter;
 	
 	
 	// Internally used while parsing the response
 	// Internally used while parsing the response
 	NSString *currentContent;
 	NSString *currentContent;
@@ -25,9 +30,25 @@
 	ASIS3BucketObject *currentObject;
 	ASIS3BucketObject *currentObject;
 	NSMutableArray *objects;	
 	NSMutableArray *objects;	
 }
 }
-// Create a list request
-+ (id)listRequestWithBucket:(NSString *)bucket;
 
 
+// Fetch a bucket
++ (id)requestWithBucket:(NSString *)bucket;
+
+// Create a bucket request, passing a parameter in the query string
+// You'll need to parse the response XML yourself
+// Examples:
+// Fetch ACL:
+// ASIS3BucketRequest *request = [ASIS3BucketRequest requestWithBucket:@"mybucket" parameter:@"acl"];
+// Fetch Location:
+// ASIS3BucketRequest *request = [ASIS3BucketRequest requestWithBucket:@"mybucket" parameter:@"location"];
+// See the S3 REST API docs for more information about the parameters you can pass
++ (id)requestWithBucket:(NSString *)bucket subResource:(NSString *)subResource;
+
+// Use for creating new buckets
++ (id)PUTRequestWithBucket:(NSString *)bucket;
+
+// Use for deleting buckets (CAREFULL!)
++ (id)DELETERequestWithBucket:(NSString *)bucket;
 
 
 // Returns an array of ASIS3BucketObjects created from the XML response
 // Returns an array of ASIS3BucketObjects created from the XML response
 - (NSArray *)bucketObjects;
 - (NSArray *)bucketObjects;
@@ -35,6 +56,13 @@
 //Builds a query string out of the list parameters we supplied
 //Builds a query string out of the list parameters we supplied
 - (void)createQueryString;
 - (void)createQueryString;
 
 
+
+// Returns a date formatter than can be used to parse a date from S3
++ (NSDateFormatter *)dateFormatter;
+
+
+@property (retain) NSString *bucket;
+@property (retain) NSString *subResource;
 @property (retain) NSString *prefix;
 @property (retain) NSString *prefix;
 @property (retain) NSString *marker;
 @property (retain) NSString *marker;
 @property (assign) int maxResultCount;
 @property (assign) int maxResultCount;

 //
 //
-//  ASIS3ListRequest.m
+//  ASIS3BucketRequest.m
 //  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
 //  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
 //
 //
-//  Created by Ben Copsey on 13/07/2009.
-//  Copyright 2009 All-Seeing Interactive. All rights reserved.
+//  Created by Ben Copsey on 16/03/2010.
+//  Copyright 2010 All-Seeing Interactive. All rights reserved.
 //
 //
-#import "ASIS3ListRequest.h"
-#import "ASIS3BucketObject.h"
 
 
+#import "ASIS3BucketRequest.h"
+#import "ASIS3BucketObject.h"
 
 
 static NSDateFormatter *dateFormatter = nil;
 static NSDateFormatter *dateFormatter = nil;
 
 
+
 // Private stuff
 // Private stuff
-@interface ASIS3ListRequest ()
-	@property (retain, nonatomic) NSString *currentContent;
-	@property (retain, nonatomic) NSString *currentElement;
-	@property (retain, nonatomic) ASIS3BucketObject *currentObject;
-	@property (retain, nonatomic) NSMutableArray *objects;
+@interface ASIS3BucketRequest ()
+@property (retain, nonatomic) NSString *currentContent;
+@property (retain, nonatomic) NSString *currentElement;
+@property (retain, nonatomic) ASIS3BucketObject *currentObject;
+@property (retain, nonatomic) NSMutableArray *objects;
 @end
 @end
 
 
-@implementation ASIS3ListRequest
+@implementation ASIS3BucketRequest
+
++ (NSDateFormatter *)dateFormatter
+{
+	if (!dateFormatter) {
+		dateFormatter = [[NSDateFormatter alloc] init];
+		[dateFormatter setLocale:[[[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"] autorelease]];
+		[dateFormatter setTimeZone:[NSTimeZone timeZoneWithAbbreviation:@"UTC"]];
+		[dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss'.000Z'"];
+	}
+	return dateFormatter;
+}
+
 
 
-+ (void)initialize
++ (id)requestWithBucket:(NSString *)bucket
 {
 {
-	dateFormatter = [[NSDateFormatter alloc] init];
-	[dateFormatter setLocale:[[[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"] autorelease]];
-	[dateFormatter setTimeZone:[NSTimeZone timeZoneWithAbbreviation:@"UTC"]];
-	[dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss'.000Z'"];
+	ASIS3ObjectRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com",bucket]]] autorelease];
+	[request setBucket:bucket];
+	return request;
 }
 }
 
 
-+ (id)listRequestWithBucket:(NSString *)bucket
++ (id)requestWithBucket:(NSString *)bucket subResource:(NSString *)subResource
 {
 {
-	ASIS3ListRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com",bucket]]] autorelease];
+	ASIS3ObjectRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com/?%@",bucket,subResource]]] autorelease];
 	[request setBucket:bucket];
 	[request setBucket:bucket];
+	[request setSubResource:subResource];
+	return request;
+}
+
+
++ (id)PUTRequestWithBucket:(NSString *)bucket
+{
+	ASIS3BucketRequest *request = [self requestWithBucket:bucket];
+	[request setRequestMethod:@"PUT"];
+	return request;
+}
+
+
++ (id)DELETERequestWithBucket:(NSString *)bucket
+{
+	ASIS3BucketRequest *request = [self requestWithBucket:bucket];
+	[request setRequestMethod:@"DELETE"];
 	return request;
 	return request;
 }
 }
 
 
@@ -45,9 +74,22 @@ static NSDateFormatter *dateFormatter = nil;
 	[prefix release];
 	[prefix release];
 	[marker release];
 	[marker release];
 	[delimiter release];
 	[delimiter release];
+	[subResource release];
+	[bucket release];
 	[super dealloc];
 	[super dealloc];
 }
 }
 
 
+- (NSString *)canonicalizedResource
+{
+	if ([self subResource]) {
+		return [NSString stringWithFormat:@"/%@/?%@",[self bucket],[self subResource]];
+	} 
+	return [NSString stringWithFormat:@"/%@/",[self bucket]];
+}
+
+
+
+
 - (void)createQueryString
 - (void)createQueryString
 {
 {
 	NSMutableArray *queryParts = [[[NSMutableArray alloc] init] autorelease];
 	NSMutableArray *queryParts = [[[NSMutableArray alloc] init] autorelease];
@@ -128,7 +170,9 @@ static NSDateFormatter *dateFormatter = nil;
 
 
 - (id)copyWithZone:(NSZone *)zone
 - (id)copyWithZone:(NSZone *)zone
 {
 {
-	ASIS3ListRequest *newRequest = [super copyWithZone:zone];
+	ASIS3BucketRequest *newRequest = [super copyWithZone:zone];
+	[newRequest setBucket:[self bucket]];
+	[newRequest setSubResource:[self subResource]];
 	[newRequest setPrefix:[self prefix]];
 	[newRequest setPrefix:[self prefix]];
 	[newRequest setMarker:[self marker]];
 	[newRequest setMarker:[self marker]];
 	[newRequest setMaxResultCount:[self maxResultCount]];
 	[newRequest setMaxResultCount:[self maxResultCount]];
@@ -136,7 +180,8 @@ static NSDateFormatter *dateFormatter = nil;
 	return newRequest;
 	return newRequest;
 }
 }
 
 
-
+@synthesize bucket;
+@synthesize subResource;
 @synthesize currentContent;
 @synthesize currentContent;
 @synthesize currentElement;
 @synthesize currentElement;
 @synthesize currentObject;
 @synthesize currentObject;

+//
+//  ASIS3ObjectRequest.h
+//  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
+//
+//  Created by Ben Copsey on 16/03/2010.
+//  Copyright 2010 All-Seeing Interactive. All rights reserved.
+//
+//  Use this class to fetch, upload, copy and delete objects on Amazon S3
+
+#import <Foundation/Foundation.h>
+#import "ASIS3Request.h"
+
+
+@interface ASIS3ObjectRequest : ASIS3Request {
+
+	// Name of the bucket to talk to
+	NSString *bucket;
+	
+	// Key of the resource you want to access on S3
+	NSString *key;
+	
+	// The bucket + path of the object to be copied (used with COPYRequestFromBucket:path:toBucket:path:)
+	NSString *sourceBucket;
+	NSString *sourceKey;
+	
+	// The mime type of the content for PUT requests
+	// Set this if having the correct mime type returned to you when you GET the data is important (eg it will be served by a web-server)
+	// Will be set to 'application/octet-stream' otherwise in iPhone apps, or autodetected on Mac OS X
+	NSString *mimeType;
+}
+
+// Create a request, building an appropriate url
++ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key;
+
+// Create a request for an object, passing a parameter in the query string
+// You'll need to parse the response XML yourself
+// Examples:
+// Fetch ACL:
+// ASIS3ObjectRequest *request = [ASIS3ObjectRequest requestWithBucket:@"mybucket" key:@"my-key" parameter:@"acl"];
+// Get object torret:
+// ASIS3ObjectRequest *request = [ASIS3ObjectRequest requestWithBucket:@"mybucket" key:@"my-key" parameter:@"torrent"];
+// See the S3 REST API docs for more information about the parameters you can pass
++ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key subResource:(NSString *)subResource;
+
+
+// Create a PUT request using the file at filePath as the body
++ (id)PUTRequestForFile:(NSString *)filePath withBucket:(NSString *)bucket key:(NSString *)key;
+
+// Create a PUT request using the supplied NSData as the body (set the mime-type manually with setMimeType: if necessary)
++ (id)PUTRequestForData:(NSData *)data withBucket:(NSString *)bucket key:(NSString *)key;
+
+// Create a DELETE request for the object at path
++ (id)DELETERequestWithBucket:(NSString *)bucket key:(NSString *)key;
+
+// Create a PUT request to copy an object from one location to another
+// Clang will complain because it thinks this method should return an object with +1 retain :(
++ (id)COPYRequestFromBucket:(NSString *)sourceBucket key:(NSString *)sourceKey toBucket:(NSString *)bucket key:(NSString *)key;
+
+// Creates a HEAD request for the object at path
++ (id)HEADRequestWithBucket:(NSString *)bucket key:(NSString *)key;
+
+@property (retain) NSString *bucket;
+@property (retain) NSString *key;
+@property (retain) NSString *sourceBucket;
+@property (retain) NSString *sourceKey;
+@property (retain) NSString *mimeType;
+
+@end

+//
+//  ASIS3ObjectRequest.m
+//  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
+//
+//  Created by Ben Copsey on 16/03/2010.
+//  Copyright 2010 All-Seeing Interactive. All rights reserved.
+//
+
+#import "ASIS3ObjectRequest.h"
+
+
+@implementation ASIS3ObjectRequest
+
+- (ASIHTTPRequest *)HEADRequest
+{
+	ASIS3ObjectRequest *headRequest = (ASIS3ObjectRequest *)[super HEADRequest];
+	[headRequest setKey:[self key]];
+	[headRequest setBucket:[self bucket]];
+	return headRequest;
+}
+
++ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key
+{
+	NSString *path = [ASIS3Request stringByURLEncodingForS3Path:key];
+	ASIS3ObjectRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com%@",bucket,path]]] autorelease];
+	[request setBucket:bucket];
+	[request setKey:key];
+	return request;
+}
+
++ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key subResource:(NSString *)subResource
+{
+	NSString *path = [ASIS3Request stringByURLEncodingForS3Path:key];
+	ASIS3ObjectRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com%@?",bucket,path,subResource]]] autorelease];
+	[request setBucket:bucket];
+	[request setKey:key];
+	return request;
+}
+
++ (id)PUTRequestForData:(NSData *)data withBucket:(NSString *)bucket key:(NSString *)key
+{
+	ASIS3ObjectRequest *request = [self requestWithBucket:bucket key:key];
+	[request appendPostData:data];
+	[request setRequestMethod:@"PUT"];
+	return request;
+}
+
++ (id)PUTRequestForFile:(NSString *)filePath withBucket:(NSString *)bucket key:(NSString *)key
+{
+	ASIS3ObjectRequest *request = [self requestWithBucket:bucket key:key];
+	[request setPostBodyFilePath:filePath];
+	[request setShouldStreamPostDataFromDisk:YES];
+	[request setRequestMethod:@"PUT"];
+	[request setMimeType:[ASIHTTPRequest mimeTypeForFileAtPath:filePath]];
+	return request;
+}
+
++ (id)DELETERequestWithBucket:(NSString *)bucket key:(NSString *)key
+{
+	ASIS3ObjectRequest *request = [self requestWithBucket:bucket key:key];
+	[request setRequestMethod:@"DELETE"];
+	return request;
+}
+
++ (id)COPYRequestFromBucket:(NSString *)sourceBucket key:(NSString *)sourceKey toBucket:(NSString *)bucket key:(NSString *)key
+{
+	ASIS3ObjectRequest *request = [self requestWithBucket:bucket key:key];
+	[request setRequestMethod:@"PUT"];
+	[request setSourceBucket:sourceBucket];
+	[request setSourceKey:sourceKey];
+	return request;
+}
+
++ (id)HEADRequestWithBucket:(NSString *)bucket key:(NSString *)key
+{
+	ASIS3ObjectRequest *request = [self requestWithBucket:bucket key:key];
+	[request setRequestMethod:@"HEAD"];
+	return request;
+}
+
+
+
+- (id)copyWithZone:(NSZone *)zone
+{
+	ASIS3ObjectRequest *newRequest = [super copyWithZone:zone];
+	[newRequest setBucket:[self bucket]];
+	[newRequest setKey:[self key]];
+	[newRequest setMimeType:[self mimeType]];
+	[newRequest setSourceBucket:[self sourceBucket]];
+	[newRequest setSourceKey:[self sourceKey]];
+	[newRequest setAccessPolicy:[self accessPolicy]];
+	return newRequest;
+}
+
+- (void)dealloc
+{
+	[bucket release];
+	[key release];
+	[mimeType release];
+	[sourceKey release];
+	[sourceBucket release];
+	[accessPolicy release];
+	[super dealloc];
+}
+
+- (void)requestFinished
+{
+	// COPY requests return a 200 whether they succeed or fail, so we need to look at the XML to see if we were successful.
+	if ([self responseStatusCode] == 200 && [self sourceKey] && [self sourceBucket]) {
+		[self parseResponseXML];
+		return;
+	}
+	[super requestFinished];
+}
+
+- (NSString *)canonicalizedResource
+{
+	return [NSString stringWithFormat:@"/%@%@",[self bucket],[ASIS3Request stringByURLEncodingForS3Path:[self key]]];
+}
+
+- (NSMutableDictionary *)S3Headers
+{
+	NSMutableDictionary *headers = [NSMutableDictionary dictionary];
+	if ([self accessPolicy]) {
+		[headers setObject:[self accessPolicy] forKey:@"x-amz-acl"];
+	}
+	if ([self sourceKey]) {
+		NSString *path = [ASIS3Request stringByURLEncodingForS3Path:[self sourceKey]];
+		[headers setObject:[[self sourceBucket] stringByAppendingString:path] forKey:@"x-amz-copy-source"];
+	}
+	return headers;
+}
+
+- (NSString *)stringToSignForHeaders:(NSString *)canonicalizedAmzHeaders resource:(NSString *)canonicalizedResource
+{
+	if ([[self requestMethod] isEqualToString:@"PUT"] && ![self sourceKey]) {
+		[self addRequestHeader:@"Content-Type" value:[self mimeType]];
+		return [NSString stringWithFormat:@"PUT\n\n%@\n%@\n%@%@",[self mimeType],dateString,canonicalizedAmzHeaders,canonicalizedResource];
+	} 
+	return [super stringToSignForHeaders:canonicalizedAmzHeaders resource:canonicalizedResource];
+}
+
+
+@synthesize bucket;
+@synthesize key;
+@synthesize sourceBucket;
+@synthesize sourceKey;
+@synthesize mimeType;
+@synthesize accessPolicy;
+@end

+//
+//  ASIS3ServiceRequest.h
+//  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
+//
+//  Created by Ben Copsey on 16/03/2010.
+//  Copyright 2010 All-Seeing Interactive. All rights reserved.
+//
+//  Create an ASIS3ServiceRequest to obtain a list of your buckets
+
+#import <Foundation/Foundation.h>
+#import "ASIS3Request.h"
+
+@interface ASIS3ServiceRequest : ASIS3Request {
+
+}
+
++ (id)serviceRequest;
+
+@end

+//
+//  ASIS3ServiceRequest.m
+//  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest
+//
+//  Created by Ben Copsey on 16/03/2010.
+//  Copyright 2010 All-Seeing Interactive. All rights reserved.
+//
+
+#import "ASIS3ServiceRequest.h"
+
+
+@implementation ASIS3ServiceRequest
+
++ (id)serviceRequest
+{
+	return [[[self alloc] initWithURL:[NSURL URLWithString:@"http://s3.amazonaws.com"]] autorelease];
+}
+
+
+@end

@@ -5,9 +5,11 @@
 //  Created by Ben Copsey on 13/07/2009.
 //  Created by Ben Copsey on 13/07/2009.
 //  Copyright 2009 All-Seeing Interactive. All rights reserved.
 //  Copyright 2009 All-Seeing Interactive. All rights reserved.
 //
 //
+//  Instances of this class represent objects stored in a bucket on S3
+//  ASIS3BucketRequests return an array of ASIS3BucketObject when you perform a list query
 
 
 #import <Foundation/Foundation.h>
 #import <Foundation/Foundation.h>
-@class ASIS3Request;
+@class ASIS3ObjectRequest;
 
 
 @interface ASIS3BucketObject : NSObject <NSCopying> {
 @interface ASIS3BucketObject : NSObject <NSCopying> {
 	
 	
@@ -34,13 +36,13 @@
 + (id)objectWithBucket:(NSString *)bucket;
 + (id)objectWithBucket:(NSString *)bucket;
 
 
 // Returns a request that will fetch this object when run
 // Returns a request that will fetch this object when run
-- (ASIS3Request *)GETRequest;
+- (ASIS3ObjectRequest *)GETRequest;
 
 
 // Returns a request that will replace this object with the contents of the file at filePath when run
 // Returns a request that will replace this object with the contents of the file at filePath when run
-- (ASIS3Request *)PUTRequestWithFile:(NSString *)filePath;
+- (ASIS3ObjectRequest *)PUTRequestWithFile:(NSString *)filePath;
 
 
 // Returns a request that will delete this object when run
 // Returns a request that will delete this object when run
-- (ASIS3Request *)DELETERequest;
+- (ASIS3ObjectRequest *)DELETERequest;
 
 
 @property (retain) NSString *bucket;
 @property (retain) NSString *bucket;
 @property (retain) NSString *key;
 @property (retain) NSString *key;

@@ -7,7 +7,7 @@
 //
 //
 
 
 #import "ASIS3BucketObject.h"
 #import "ASIS3BucketObject.h"
-#import "ASIS3Request.h"
+#import "ASIS3ObjectRequest.h"
 
 
 @implementation ASIS3BucketObject
 @implementation ASIS3BucketObject
 
 
@@ -28,19 +28,19 @@
 	[super dealloc];
 	[super dealloc];
 }
 }
 
 
-- (ASIS3Request *)GETRequest
+- (ASIS3ObjectRequest *)GETRequest
 {
 {
-	return [ASIS3Request requestWithBucket:[self bucket] key:[self key]];
+	return [ASIS3ObjectRequest requestWithBucket:[self bucket] key:[self key]];
 }
 }
 
 
-- (ASIS3Request *)PUTRequestWithFile:(NSString *)filePath
+- (ASIS3ObjectRequest *)PUTRequestWithFile:(NSString *)filePath
 {
 {
-	return [ASIS3Request PUTRequestForFile:filePath withBucket:[self bucket] key:[self key]];
+	return [ASIS3ObjectRequest PUTRequestForFile:filePath withBucket:[self bucket] key:[self key]];
 }
 }
 
 
-- (ASIS3Request *)DELETERequest
+- (ASIS3ObjectRequest *)DELETERequest
 {
 {
-	ASIS3Request *request = [ASIS3Request requestWithBucket:[self bucket] key:[self key]];
+	ASIS3ObjectRequest *request = [ASIS3ObjectRequest requestWithBucket:[self bucket] key:[self key]];
 	[request setRequestMethod:@"DELETE"];
 	[request setRequestMethod:@"DELETE"];
 	return request;
 	return request;
 }
 }

@@ -5,7 +5,8 @@
 //  Created by Ben Copsey on 30/06/2009.
 //  Created by Ben Copsey on 30/06/2009.
 //  Copyright 2009 All-Seeing Interactive. All rights reserved.
 //  Copyright 2009 All-Seeing Interactive. All rights reserved.
 //
 //
-// A (basic) class for accessing data stored on Amazon's Simple Storage Service (http://aws.amazon.com/s3/) using the REST API
+// A class for accessing data stored on Amazon's Simple Storage Service (http://aws.amazon.com/s3/) using the REST API
+// While you can use this class directly, the included subclasses make typical operations easier
 
 
 #import <Foundation/Foundation.h>
 #import <Foundation/Foundation.h>
 #import "ASIHTTPRequest.h"
 #import "ASIHTTPRequest.h"
@@ -34,27 +35,12 @@ typedef enum _ASIS3ErrorType {
 	// Your S3 secret access key. Set it on the request, or set it globally using [ASIS3Request setSharedSecretAccessKey:]
 	// Your S3 secret access key. Set it on the request, or set it globally using [ASIS3Request setSharedSecretAccessKey:]
 	NSString *secretAccessKey;
 	NSString *secretAccessKey;
 	
 	
-	// Name of the bucket to talk to
-	NSString *bucket;
-	
-	// Key of the resource you want to access on S3. Leave empty for the bucket root
-	NSString *key;
-	
 	// The string that will be used in the HTTP date header. Generally you'll want to ignore this and let the class add the current date for you, but the accessor is used by the tests
 	// The string that will be used in the HTTP date header. Generally you'll want to ignore this and let the class add the current date for you, but the accessor is used by the tests
 	NSString *dateString;
 	NSString *dateString;
-	
-	// The mime type of the content for PUT requests
-	// Set this if having the correct mime type returned to you when you GET the data is important (eg it will be served by a web-server)
-	// Will be set to 'application/octet-stream' otherwise in iPhone apps, or autodetected on Mac OS X
-	NSString *mimeType;
-	
-	// The access policy to use when PUTting a file (see the string constants at the top of this header)
+
+	// The access policy to use when PUTting a file (see the string constants at the top ASIS3Request.h for details on what the possible options are)
 	NSString *accessPolicy;
 	NSString *accessPolicy;
-	
-	// The bucket + path of the object to be copied (used with COPYRequestFromBucket:path:toBucket:path:)
-	NSString *sourceBucket;
-	NSString *sourceKey;
-	
+
 	// Internally used while parsing errors
 	// Internally used while parsing errors
 	NSString *currentErrorString;
 	NSString *currentErrorString;
 	
 	
@@ -62,29 +48,16 @@ typedef enum _ASIS3ErrorType {
 
 
 #pragma mark Constructors
 #pragma mark Constructors
 
 
-// Create a request, building an appropriate url
-+ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key;
-
-// Create a PUT request using the file at filePath as the body
-+ (id)PUTRequestForFile:(NSString *)filePath withBucket:(NSString *)bucket key:(NSString *)key;
-
-// Create a PUT request using the supplied NSData as the body (set the mime-type manually with setMimeType: if necessary)
-+ (id)PUTRequestForData:(NSData *)data withBucket:(NSString *)bucket key:(NSString *)key;
-	
-// Create a DELETE request for the object at path
-+ (id)DELETERequestWithBucket:(NSString *)bucket key:(NSString *)key;
-
-// Create a PUT request to copy an object from one location to another
-// Clang will complain because it thinks this method should return an object with +1 retain :(
-+ (id)COPYRequestFromBucket:(NSString *)sourceBucket key:(NSString *)sourceKey toBucket:(NSString *)bucket key:(NSString *)key;
-
-// Creates a HEAD request for the object at path
-+ (id)HEADRequestWithBucket:(NSString *)bucket key:(NSString *)key;
-
 
 
 // Uses the supplied date to create a Date header string
 // Uses the supplied date to create a Date header string
 - (void)setDate:(NSDate *)date;
 - (void)setDate:(NSDate *)date;
 
 
+- (NSMutableDictionary *)S3Headers;
+- (NSString *)stringToSignForHeaders:(NSString *)canonicalizedAmzHeaders resource:(NSString *)canonicalizedResource;
+
+	
+# pragma mark encoding S3 key
+	
 + (NSString *)stringByURLEncodingForS3Path:(NSString *)key;
 + (NSString *)stringByURLEncodingForS3Path:(NSString *)key;
 	
 	
 #pragma mark Shared access keys
 #pragma mark Shared access keys
@@ -94,15 +67,10 @@ typedef enum _ASIS3ErrorType {
 + (void)setSharedAccessKey:(NSString *)newAccessKey;
 + (void)setSharedAccessKey:(NSString *)newAccessKey;
 + (NSString *)sharedSecretAccessKey;
 + (NSString *)sharedSecretAccessKey;
 + (void)setSharedSecretAccessKey:(NSString *)newAccessKey;
 + (void)setSharedSecretAccessKey:(NSString *)newAccessKey;
-
-
-@property (retain) NSString *bucket;
-@property (retain) NSString *key;
+- (void)parseResponseXML;
+	
 @property (retain) NSString *dateString;
 @property (retain) NSString *dateString;
-@property (retain) NSString *mimeType;
 @property (retain) NSString *accessKey;
 @property (retain) NSString *accessKey;
 @property (retain) NSString *secretAccessKey;
 @property (retain) NSString *secretAccessKey;
 @property (retain) NSString *accessPolicy;
 @property (retain) NSString *accessPolicy;
-@property (retain) NSString *sourceBucket;
-@property (retain) NSString *sourceKey;
 @end
 @end

@@ -19,9 +19,7 @@ static NSString *sharedSecretAccessKey = nil;
 
 
 // Private stuff
 // Private stuff
 @interface ASIS3Request ()
 @interface ASIS3Request ()
-	- (void)parseError;
 	+ (NSData *)HMACSHA1withKey:(NSString *)key forString:(NSString *)string;
 	+ (NSData *)HMACSHA1withKey:(NSString *)key forString:(NSString *)string;
-	
 	@property (retain, nonatomic) NSString *currentErrorString;
 	@property (retain, nonatomic) NSString *currentErrorString;
 @end
 @end
 
 
@@ -41,66 +39,11 @@ static NSString *sharedSecretAccessKey = nil;
 	return path;
 	return path;
 }
 }
 
 
-+ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key
-{
-	NSString *path = [ASIS3Request stringByURLEncodingForS3Path:key];
-	ASIS3Request *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com%@",bucket,path]]] autorelease];
-	[request setBucket:bucket];
-	[request setKey:key];
-	return request;
-}
-
-+ (id)PUTRequestForData:(NSData *)data withBucket:(NSString *)bucket key:(NSString *)key
-{
-	ASIS3Request *request = [self requestWithBucket:bucket key:key];
-	[request appendPostData:data];
-	[request setRequestMethod:@"PUT"];
-	return request;
-}
-
-+ (id)PUTRequestForFile:(NSString *)filePath withBucket:(NSString *)bucket key:(NSString *)key
-{
-	ASIS3Request *request = [self requestWithBucket:bucket key:key];
-	[request setPostBodyFilePath:filePath];
-	[request setShouldStreamPostDataFromDisk:YES];
-	[request setRequestMethod:@"PUT"];
-	[request setMimeType:[ASIHTTPRequest mimeTypeForFileAtPath:filePath]];
-	return request;
-}
-
-+ (id)DELETERequestWithBucket:(NSString *)bucket key:(NSString *)key
-{
-	ASIS3Request *request = [self requestWithBucket:bucket key:key];
-	[request setRequestMethod:@"DELETE"];
-	return request;
-}
-
-+ (id)COPYRequestFromBucket:(NSString *)sourceBucket key:(NSString *)sourceKey toBucket:(NSString *)bucket key:(NSString *)key
-{
-	ASIS3Request *request = [self requestWithBucket:bucket key:key];
-	[request setRequestMethod:@"PUT"];
-	[request setSourceBucket:sourceBucket];
-	[request setSourceKey:sourceKey];
-	return request;
-}
-
-+ (id)HEADRequestWithBucket:(NSString *)bucket key:(NSString *)key
-{
-	ASIS3Request *request = [self requestWithBucket:bucket key:key];
-	[request setRequestMethod:@"HEAD"];
-	return request;
-}
-
 - (void)dealloc
 - (void)dealloc
 {
 {
-	[bucket release];
-	[key release];
 	[dateString release];
 	[dateString release];
-	[mimeType release];
 	[accessKey release];
 	[accessKey release];
 	[secretAccessKey release];
 	[secretAccessKey release];
-	[sourceKey release];
-	[sourceBucket release];
 	[super dealloc];
 	[super dealloc];
 }
 }
 
 
@@ -119,11 +62,23 @@ static NSString *sharedSecretAccessKey = nil;
 	ASIS3Request *headRequest = (ASIS3Request *)[super HEADRequest];
 	ASIS3Request *headRequest = (ASIS3Request *)[super HEADRequest];
 	[headRequest setAccessKey:[self accessKey]];
 	[headRequest setAccessKey:[self accessKey]];
 	[headRequest setSecretAccessKey:[self secretAccessKey]];
 	[headRequest setSecretAccessKey:[self secretAccessKey]];
-	[headRequest setKey:[self key]];
-	[headRequest setBucket:[self bucket]];
 	return headRequest;
 	return headRequest;
 }
 }
 
 
+- (NSMutableDictionary *)S3Headers
+{
+	return [NSMutableDictionary dictionary];
+}
+
+- (NSString *)canonicalizedResource
+{
+	return @"/";
+}
+
+- (NSString *)stringToSignForHeaders:(NSString *)canonicalizedAmzHeaders resource:(NSString *)canonicalizedResource
+{
+	return [NSString stringWithFormat:@"%@\n\n\n%@\n%@%@",[self requestMethod],[self dateString],canonicalizedAmzHeaders,canonicalizedResource];
+}
 
 
 - (void)buildRequestHeaders
 - (void)buildRequestHeaders
 {
 {
@@ -143,32 +98,19 @@ static NSString *sharedSecretAccessKey = nil;
 	[self addRequestHeader:@"Date" value:[self dateString]];
 	[self addRequestHeader:@"Date" value:[self dateString]];
 	
 	
 	// Ensure our formatted string doesn't use '(null)' for the empty path
 	// Ensure our formatted string doesn't use '(null)' for the empty path
-	NSString *canonicalizedResource = [NSString stringWithFormat:@"/%@%@",[self bucket],[ASIS3Request stringByURLEncodingForS3Path:[self key]]];
+	NSString *canonicalizedResource = [self canonicalizedResource];
 	
 	
 	// Add a header for the access policy if one was set, otherwise we won't add one (and S3 will default to private)
 	// Add a header for the access policy if one was set, otherwise we won't add one (and S3 will default to private)
-	NSMutableDictionary *amzHeaders = [[[NSMutableDictionary alloc] init] autorelease];
+	NSMutableDictionary *amzHeaders = [self S3Headers];
 	NSString *canonicalizedAmzHeaders = @"";
 	NSString *canonicalizedAmzHeaders = @"";
-	if ([self accessPolicy]) {
-		[amzHeaders setObject:[self accessPolicy] forKey:@"x-amz-acl"];
-	}
-	if ([self sourceKey]) {
-		NSString *path = [ASIS3Request stringByURLEncodingForS3Path:[self sourceKey]];
-		[amzHeaders setObject:[[self sourceBucket] stringByAppendingString:path] forKey:@"x-amz-copy-source"];
-	}
 	for (NSString *header in [amzHeaders keyEnumerator]) {
 	for (NSString *header in [amzHeaders keyEnumerator]) {
 		canonicalizedAmzHeaders = [NSString stringWithFormat:@"%@%@:%@\n",canonicalizedAmzHeaders,[header lowercaseString],[amzHeaders objectForKey:header]];
 		canonicalizedAmzHeaders = [NSString stringWithFormat:@"%@%@:%@\n",canonicalizedAmzHeaders,[header lowercaseString],[amzHeaders objectForKey:header]];
-		[self addRequestHeader:key value:[amzHeaders objectForKey:key]];
+		[self addRequestHeader:header value:[amzHeaders objectForKey:header]];
 	}
 	}
 	
 	
 	
 	
 	// Jump through hoops while eating hot food
 	// Jump through hoops while eating hot food
-	NSString *stringToSign;
-	if ([[self requestMethod] isEqualToString:@"PUT"] && ![self sourceKey]) {
-		[self addRequestHeader:@"Content-Type" value:[self mimeType]];
-		stringToSign = [NSString stringWithFormat:@"PUT\n\n%@\n%@\n%@%@",[self mimeType],dateString,canonicalizedAmzHeaders,canonicalizedResource];
-	} else {
-		stringToSign = [NSString stringWithFormat:@"%@\n\n\n%@\n%@%@",[self requestMethod],dateString,canonicalizedAmzHeaders,canonicalizedResource];
-	}
+	NSString *stringToSign = [self stringToSignForHeaders:canonicalizedAmzHeaders resource:canonicalizedResource];
 	NSString *signature = [ASIHTTPRequest base64forData:[ASIS3Request HMACSHA1withKey:[self secretAccessKey] forString:stringToSign]];
 	NSString *signature = [ASIHTTPRequest base64forData:[ASIS3Request HMACSHA1withKey:[self secretAccessKey] forString:stringToSign]];
 	NSString *authorizationString = [NSString stringWithFormat:@"AWS %@:%@",[self accessKey],signature];
 	NSString *authorizationString = [NSString stringWithFormat:@"AWS %@:%@",[self accessKey],signature];
 	[self addRequestHeader:@"Authorization" value:authorizationString];
 	[self addRequestHeader:@"Authorization" value:authorizationString];
@@ -179,21 +121,16 @@ static NSString *sharedSecretAccessKey = nil;
 
 
 - (void)requestFinished
 - (void)requestFinished
 {
 {
-	// COPY requests return a 200 whether they succeed or fail, so we need to look at the XML to see if we were successful.
-	if ([self responseStatusCode] == 200 && [self sourceKey] && [self sourceBucket]) {
-		[self parseError];
-		return;
-	}
 	if ([self responseStatusCode] < 207) {
 	if ([self responseStatusCode] < 207) {
 		[super requestFinished];
 		[super requestFinished];
 		return;
 		return;
 	}
 	}
-	[self parseError];
+	[self parseResponseXML];
 }
 }
 
 
 #pragma mark Error XML parsing
 #pragma mark Error XML parsing
 
 
-- (void)parseError
+- (void)parseResponseXML
 {
 {
 	NSXMLParser *parser = [[[NSXMLParser alloc] initWithData:[self responseData]] autorelease];
 	NSXMLParser *parser = [[[NSXMLParser alloc] initWithData:[self responseData]] autorelease];
 	[parser setDelegate:self];
 	[parser setDelegate:self];
@@ -231,12 +168,6 @@ static NSString *sharedSecretAccessKey = nil;
 	ASIS3Request *newRequest = [super copyWithZone:zone];
 	ASIS3Request *newRequest = [super copyWithZone:zone];
 	[newRequest setAccessKey:[self accessKey]];
 	[newRequest setAccessKey:[self accessKey]];
 	[newRequest setSecretAccessKey:[self secretAccessKey]];
 	[newRequest setSecretAccessKey:[self secretAccessKey]];
-	[newRequest setBucket:[self bucket]];
-	[newRequest setKey:[self key]];
-	[newRequest setMimeType:[self mimeType]];
-	[newRequest setAccessPolicy:[self accessPolicy]];
-	[newRequest setSourceBucket:[self sourceBucket]];
-	[newRequest setSourceKey:[self sourceKey]];
 	return newRequest;
 	return newRequest;
 }
 }
 
 
@@ -266,7 +197,6 @@ static NSString *sharedSecretAccessKey = nil;
 }
 }
 
 
 
 
-
 #pragma mark S3 Authentication helpers
 #pragma mark S3 Authentication helpers
 
 
 // From: http://stackoverflow.com/questions/476455/is-there-a-library-for-iphone-to-work-with-hmac-sha-1-encoding
 // From: http://stackoverflow.com/questions/476455/is-there-a-library-for-iphone-to-work-with-hmac-sha-1-encoding
@@ -286,14 +216,10 @@ static NSString *sharedSecretAccessKey = nil;
 	return [NSData dataWithBytes:digest length:CC_SHA1_DIGEST_LENGTH];
 	return [NSData dataWithBytes:digest length:CC_SHA1_DIGEST_LENGTH];
 }
 }
 
 
-@synthesize bucket;
-@synthesize key;
+
 @synthesize dateString;
 @synthesize dateString;
-@synthesize mimeType;
 @synthesize accessKey;
 @synthesize accessKey;
 @synthesize secretAccessKey;
 @synthesize secretAccessKey;
-@synthesize accessPolicy;
 @synthesize currentErrorString;
 @synthesize currentErrorString;
-@synthesize sourceBucket;
-@synthesize sourceKey;
+@synthesize accessPolicy;
 @end
 @end