/Volumes/ATTACHE/Droppler/DropKit/DropIO.m

Go to the documentation of this file.

//
//  DropIO.m
//  DropIO
//
//  Created by Chris Patterson on 11/11/08.
//  Copyright 2008 Chris Patterson. All rights reserved.
//

#import "DropIO.h"
#import "XMLToObjectParser.h"

@implementation NSString (httpFormEncoding)

- (NSString*)stringUsingHTTPFormEncoding
{
        NSString *result = (NSString *) CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault, (CFStringRef)self, NULL, CFSTR("?=&+"), kCFStringEncodingUTF8);
        return [result autorelease];
}

@end

@implementation NSMutableURLRequest (httpFormEncoding)

- (void) setHTTPPostBody:(NSDictionary*)postParams
{
        NSMutableString* postBody = [[NSMutableString alloc] init];
        NSUInteger keyCount = [postParams count];
        NSUInteger k = 0;
        for (id key in postParams)
        {
                [postBody appendFormat:@"%@=%@", key, [[postParams objectForKey:key] stringUsingHTTPFormEncoding]];
                if (++k != keyCount)
                        [postBody appendString:@"&"];
        }
        
        NSLog(@"HTTP POST Data: %@", postBody);
        
        NSData*   postData   = [postBody dataUsingEncoding:NSASCIIStringEncoding];
        NSString* postLength = [NSString stringWithFormat:@"%d", [postData length]];
        [self setHTTPBody:postData];
        [self setValue:postLength forHTTPHeaderField:@"Content-Length"];
        [self setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
        
        [postBody release];
}

@end

@implementation DropIO

static NSString*        apiKey = nil;           
static NSError*         lastError = nil;        
+ (void) setAPIKey:(NSString*)aKey
{
        [aKey retain];
        [apiKey release];
        apiKey = aKey;
}

+ (NSString*) APIKey
{
        return apiKey;
}

+ (BOOL) checkAPIKey
{
        if (apiKey == nil)
        {
                NSLog(@"Error: DropIO API key not set.");
                return false;
        }
        return true;
}

+ (NSError*) lastError
{
        return lastError;
}

+ (void) setLastError:(NSError*)dropioError
{
        if (dropioError != lastError)
        {
                [dropioError retain];
                [lastError release];
                lastError = dropioError;
        }
}

+ (void) errorHandler:(NSError*)error
{
        if (error != nil)
        {
                [DropIO setLastError:error];
                
                if (![[[error userInfo] objectForKey:kDropIOErrorResult] isEqualToString:kDropIOErrorResult_Success])
                {
                        NSLog(@"Error: %@", error);
                        for (id key in [error userInfo])
                        {
                                NSLog(@"  %@: %@", key, [[error userInfo] valueForKey:key]);
                        }
                }
        }
}

+ (NSArray*) parseResponseFromURL:(NSURL*)url
                                         fromNodeName:(NSString *)nodeName
                                                 toObject:(NSString *)className 
                                           parseError:(NSError **)error
{
        // clear any previous DropIOError
        [DropIO setLastError:nil];
        
        XMLToObjectParser* x2o = [[XMLToObjectParser alloc] init];
        [x2o parseXMLAtURL:url
                  fromNodeName:nodeName
                          toObject:className
                    parseError:error];
        if (error != nil && (*error) != nil)
        {
                [DropIO errorHandler:*error];
        }
        
        NSArray* result = [x2o items];
        [[result retain] autorelease];
        [x2o release];
        return result;
}

+ (NSArray*) parseResponse:(NSData*)responseData
                          fromNodeName:(NSString *)nodeName
                                  toObject:(NSString *)className 
                                parseError:(NSError **)error
{
        // clear any previous DropIOError
        [DropIO setLastError:nil];
        
        XMLToObjectParser* x2o = [[XMLToObjectParser alloc] init];
        [x2o parseXMLData:responseData
                 fromNodeName:nodeName
                         toObject:className
                   parseError:error];
        if (error != nil && (*error) != nil)
        {
                [DropIO errorHandler:*error];
        }
        
        NSArray* result = [x2o items];
        [[result retain] autorelease];
        [x2o release];
        return result;
}

+ (DropIODrop*) dropOperation:(NSString*)opString atUrl:(NSString*)urlStr withParameters:(NSDictionary*)params
{
        // clear any previous DropIOError
        [DropIO setLastError:nil];
        
        if (![DropIO checkAPIKey])
                return nil;
        
        // Create an HTTP POST URL request pointing to the drop.io API URL.
        NSMutableURLRequest* dropReq = [[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:urlStr]];
        [dropReq setHTTPMethod:opString];
        [dropReq setHTTPPostBody:params];       // Method added by NSMutableURLRequest(httpFormEncoding) category, defined above.
        
        // Send the request and get the drop XML response synchronously (for now).
        NSURLResponse* dropResp = nil;
        NSError* error = nil;
        NSData* dropXmlData = [NSURLConnection sendSynchronousRequest:dropReq 
                                                                                                returningResponse:&dropResp 
                                                                                                                        error:&error];
        if (error != nil)
        {
                NSLog(@"HTTP %@ Error: %@", opString, error);
                [DropIO setLastError:error];
                return nil;
        }
        
        // Got a response, so parse the XML into DropIODrop objects
        DropIODrop* drop = nil;
        NSArray* dropArray = [self parseResponse:dropXmlData
                                                                fromNodeName:@"drop"
                                                                        toObject:@"DropIODrop"
                                                                  parseError:&error];
        if ((dropArray == nil) || ([dropArray count] == 0))
                return nil;
        
        drop = [dropArray objectAtIndex:0];
        return [[drop retain] autorelease];
}

+ (DropIODrop*) dropWithParameters:(NSDictionary*)params
{
        return [DropIO dropOperation:@"POST" 
                                                   atUrl:kDropIONewDropUrl 
                                  withParameters:params];
}

+ (void) updateDropNamed:(NSString*)dropName withParameters:(NSDictionary*)params
{
        [DropIO dropOperation:@"PUT" 
                                        atUrl:[NSString stringWithFormat:kDropIOUpdateDropUrlFormat, dropName] 
                   withParameters:params];
}

+ (void) deleteDropNamed:(NSString*)dropName withParameters:(NSDictionary*)params
{
        [DropIO dropOperation:@"DELETE" 
                                        atUrl:[NSString stringWithFormat:kDropIOUpdateDropUrlFormat, dropName] 
                   withParameters:params];
}

+ (DropIODrop*) dropWithRandomName
{
        if (![DropIO checkAPIKey])
                return nil;
        
        NSMutableDictionary* params = [NSMutableDictionary dictionaryWithCapacity:3];
        [params setObject:kDropIOParamValue_Format_XML          forKey:kDropIOParamKey_Format];
        [params setObject:kDropIOParamValue_Version_Latest      forKey:kDropIOParamKey_Version];
        [params setObject:apiKey                                                        forKey:kDropIOParamKey_APIKey];
        
        return [DropIO dropWithParameters:params];
}

+ (DropIODrop*) dropWithName:(NSString*)aName
{
        if (![DropIO checkAPIKey])
                return nil;
        
        NSMutableDictionary* params = [NSMutableDictionary dictionaryWithCapacity:4];
        [params setObject:kDropIOParamValue_Format_XML          forKey:kDropIOParamKey_Format];
        [params setObject:kDropIOParamValue_Version_Latest      forKey:kDropIOParamKey_Version];
        [params setObject:apiKey                                                        forKey:kDropIOParamKey_APIKey];
        [params setObject:aName                                                         forKey:kDropIOParamKey_Name];
        
        return [DropIO dropWithParameters:params];
}

+ (DropIODrop*) dropWithName:(NSString*)aName andPassword:(NSString*)aPassword
{
        if (![DropIO checkAPIKey])
                return nil;
        
        NSMutableDictionary* params = [NSMutableDictionary dictionaryWithCapacity:5];
        [params setObject:kDropIOParamValue_Format_XML          forKey:kDropIOParamKey_Format];
        [params setObject:kDropIOParamValue_Version_Latest      forKey:kDropIOParamKey_Version];
        [params setObject:apiKey                                                        forKey:kDropIOParamKey_APIKey];
        [params setObject:aName                                                         forKey:kDropIOParamKey_Name];
        [params setObject:aPassword                                                     forKey:kDropIOParamKey_AdminPassword];
        
        return [DropIO dropWithParameters:params];
}

+ (NSURL*) URLForDropNamed:(NSString*)dropName withToken:(NSString*)aToken
{
        if (![DropIO checkAPIKey])
                return nil;
        
        NSString* urlStr = [NSString stringWithFormat:kDropIODropUrlFormat, 
                                                dropName, 
                                                kDropIOParamKey_APIKey,  [DropIO APIKey], 
                                                kDropIOParamKey_Format,  kDropIOParamValue_Format_XML,
                                                kDropIOParamKey_Version, kDropIOParamValue_Version_Latest,
                                                kDropIOParamKey_Token,   aToken];
        return [NSURL URLWithString:urlStr];
}

+ (DropIODrop*) findDropNamed:(NSString*)aName error:(NSError**)pError
{
        return [DropIO findDropNamed:aName withToken:@"" error:pError];
}

+ (DropIODrop*) findDropNamed:(NSString*)aName withToken:(NSString*)aToken error:(NSError**)pError
{
        return [DropIO findDropAtAPIURL:[DropIO URLForDropNamed:aName withToken:aToken] error:pError];
}

+ (DropIODrop*) findDropAtAPIURL:(NSURL*)dropAPIURL error:(NSError**)pError
{
        DropIODrop* drop = nil;
        NSArray* dropArray = [self parseResponseFromURL:dropAPIURL
                                                                           fromNodeName:@"drop"
                                                                                   toObject:@"DropIODrop"
                                                                                 parseError:pError];
        if ((dropArray == nil) || ([dropArray count] == 0))
                return nil;
        
        drop = [dropArray objectAtIndex:0];
        return [[drop retain] autorelease];
}

+ (DropIODrop*) findDropAtDropURL:(NSURL*)dropURL error:(NSError**)pError
{
        NSString* dropUrlStr = [dropURL absoluteString];
        NSRange r = [dropUrlStr rangeOfString:@"http://drop.io/"];
        if (r.location == NSNotFound)
                r = [dropUrlStr rangeOfString:@"http://www.drop.io/"];
        
        if (r.location != NSNotFound)
        {
                NSRange nameRange = NSMakeRange(r.location + r.length, 0);
                NSRange qRange = [dropUrlStr rangeOfString:@"?"];
                if (qRange.location != NSNotFound)
                        nameRange.length = qRange.location - nameRange.location;
                else
                        nameRange.length = [dropUrlStr length] - nameRange.location;
                NSString* dropName = [dropUrlStr substringWithRange:nameRange];
                
                // For some reason the FAQ drop is not available through the API, 
                // so don't treat it as a drop link.
                if (![dropName isEqualToString:@"faq"]) 
                        return [DropIO findDropNamed:dropName error:pError];
        }
        
        if (pError != nil)
        {
                NSDictionary* dict = [NSDictionary dictionaryWithObjectsAndKeys:
                                                          @"Given URL is not a Drop.io drop URL", NSLocalizedFailureReasonErrorKey,
                                                          dropURL, kDropIOErrorAPIURL,
                                                          nil];
                *pError = [NSError errorWithDomain:kDropIOErrorDomain code:kDropIOErrorCode_NotDropURL userInfo:dict];
        }
        return nil; // not a drop URL
}

@end

---