ARConnection.m

Go to the documentation of this file.

// ActiveResourceKit ARConnection.m
//
// Copyright © 2012, Roy Ratcliffe, Pioneering Software, United Kingdom
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the “Software”), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED “AS IS,” WITHOUT WARRANTY OF ANY KIND, EITHER
// EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO
// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
//------------------------------------------------------------------------------

#import "ARConnection.h"
#import "ARConnection+Private.h"

#import "ARJSONFormat.h"
#import "ARHTTPMethods.h"
#import "ARHTTPResponse.h"
#import "ARErrors.h"

@implementation ARConnection

@synthesize site    = _site;
@synthesize format  = _format;
@synthesize timeout = _timeout;

//------------------------------------------------------------------------------
#pragma mark                                                        Initialisers
//------------------------------------------------------------------------------

// designated initialiser
- (id)init
{
    self = [super init];
    if (self)
    {
        [self setTimeout:60.0];
    }
    return self;
}

- (id)initWithSite:(NSURL *)site format:(id<ARFormat>)format
{
    self = [self init];
    if (self)
    {
        [self setSite:site];
        [self setFormat:format];
    }
    return self;
}

- (id)initWithSite:(NSURL *)site
{
    return [self initWithSite:site format:[ARJSONFormat JSONFormat]];
}

- (void)sendRequest:(NSURLRequest *)request completionHandler:(ARConnectionCompletionHandler)completionHandler
{
    ;
}

+ (NSError *)errorForResponse:(ARHTTPResponse *)response
{
    NSInteger errorCode;
    switch ([response code])
    {
        case 301:
        case 302:
        case 303:
        case 307:
            // 301: moved permanently (redirect)
            // 302: found (but redirect)
            // 303: see other (redirect)
            // 307: temporarily redirected (redirect)
            errorCode = ARRedirectionErrorCode;
            break;
        case 400:
            errorCode = ARBadRequestErrorCode;
            break;
        case 401:
            errorCode = ARUnauthorizedAccessErrorCode;
            break;
        case 403:
            errorCode = ARForbiddenAccessErrorCode;
            break;
        case 404:
            errorCode = ARResourceNotFoundErrorCode;
            break;
        case 405:
            errorCode = ARMethodNotAllowedErrorCode;
            break;
        case 409:
            errorCode = ARResourceConflictErrorCode;
            break;
        case 410:
            errorCode = ARResourceGoneErrorCode;
            break;
        case 422:
            errorCode = ARResourceInvalidErrorCode;
            break;
        default:
            if (200 <= [response code] && [response code] < 400)
            {
                errorCode = '    ';
            }
            else if (401 <= [response code] && [response code] < 500)
            {
                errorCode = ARClientErrorCode;
            }
            else if (500 <= [response code] && [response code] < 600)
            {
                errorCode = ARServerErrorCode;
            }
            else
            {
                errorCode = ARConnectionErrorCode;
            }
    }
    NSError *error;
    if (errorCode != '    ')
    {
        NSString *localizedDescription = [NSHTTPURLResponse localizedStringForStatusCode:[response code]];
        NSDictionary *userInfo = [NSDictionary dictionaryWithObjectsAndKeys:response, ARConnectionHTTPResponseKey, localizedDescription, NSLocalizedDescriptionKey, nil];
        error = [NSError errorWithDomain:ARConnectionErrorDomain code:errorCode userInfo:userInfo];
    }
    else
    {
        error = nil;
    }
    return error;
}

//------------------------------------------------------------------------------
#pragma mark                                                   Building Requests
//------------------------------------------------------------------------------

- (NSMutableURLRequest *)requestForHTTPMethod:(NSString *)HTTPMethod path:(NSString *)path headers:(NSDictionary *)headers
{
    NSURL *URL = [NSURL URLWithString:path relativeToURL:[self site]];
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:[self timeout]];
    NSMutableDictionary *headerFields = [NSMutableDictionary dictionaryWithDictionary:[request allHTTPHeaderFields]];
    [headerFields addEntriesFromDictionary:[self buildRequestHeaderFieldsUsingHeaders:headers forHTTPMethod:HTTPMethod]];
    [request setAllHTTPHeaderFields:headerFields];
    [request setHTTPMethod:HTTPMethod];
    return request;
}

@end