iphone/src/objc/WebDriverResponse.m

//
//  WebDriverResponse.m
//  iWebDriver
//
//  Copyright 2009 Google Inc.
//  Copyright 2011 Software Freedom Conservancy.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

#import "WebDriverResponse.h"
#import "HTTPResponse.h"
#import "HTTPJSONResponse.h"
#import "HTTPPNGResponse.h"
#import "NSData+Base64.h"
#import "NSException+WebDriver.h"
#import "errorcodes.h"

@implementation WebDriverResponse

// These need to be dynamic so we can make sure to clear the cached response
// if it exists when these are changed.
@dynamic status, value, sessionId;

- (id)initWithValue:(id)theValue {
  if (![super init])
    return nil;
  
  [self setValue:theValue];

  // The sessionId is set automatically by |Session|.
  [self setSessionId:@"unknown"];

  return self;
}

- (id)initWithError:(id)error {
  NSLog(@"Creating WebDriverResponse with:\n%@", [error description]);
  if (![error isKindOfClass:[NSException class]]) {
    if (![self initWithValue:error]) {
      return nil;
    }
  } else {
    NSDictionary* errorData = [error userInfo];
    if ([error name] == [NSException webdriverExceptionName]) {
      if (![self initWithValue:[errorData objectForKey:@"value"]]) {
        return nil;
      }
      status_ = [[errorData objectForKey:@"status"] intValue];
    } else if (![self initWithValue:errorData]) {
      return nil;
    }
  }
  
  // If we didn't set a status above, go ahead and use a generic now.
  if (status_ == SUCCESS) {
    status_ = EUNHANDLEDERROR;
  }

  return self;
}

+ (WebDriverResponse *)responseWithValue:(id)value {
  return [[[self alloc] initWithValue:value] autorelease];
}

+ (WebDriverResponse *)responseWithError:(id)error {
  return [[[self alloc] initWithError:error] autorelease];
}

- (void)dealloc {
  // Calls the release methods instead of calling setValue:nil because
  // setValue tries to change the response_ object (which it can't) and throws
  // an exception.
  [value_ release];
  [sessionId_ release];
  [response_ release];
  [super dealloc];
}

- (NSDictionary *)convertToDictionary {
  NSMutableDictionary *dict = [NSMutableDictionary dictionary];
  [dict setValue:value_ forKey:@"value"];
  [dict setValue:sessionId_ forKey:@"sessionId"];
  [dict setValue:[NSNumber numberWithInt:status_] forKey:@"status"];
  return dict;
}

// Create the response_ object from the current property set.
- (void)createResponse {
  [response_ release];
  
  if ([value_ isKindOfClass:[UIImage class]]) {
    value_ = [UIImagePNGRepresentation(value_) base64EncodedString];
  }
  NSDictionary *dict = [self convertToDictionary];
  response_ = [[HTTPJSONResponse alloc] initWithObject:(id)dict];
}

// Return the response_ object (create it if necessary).
- (HTTPDataResponse *)response {
  if (response_ == nil)
    [self createResponse];
  
  return response_;
}

// Invalidate the stored response. This usually happens when any of the
// properties change. This will throw an exception if called after its sent
// over the network.
- (void)setResponseDirty {
  if (response_ != nil && [response_ offset] != 0) {
    @throw [NSException exceptionWithName:@"kResponseInUse"
                                   reason:@"Reading has already started on the response. You can't change it now."
                                 userInfo:nil];
  }

  [response_ release];
  response_ = nil;
}

- (void)forwardInvocation:(NSInvocation *)anInvocation {
  [anInvocation setTarget:[self response]];
  [anInvocation invoke];
}

- (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector {
  NSMethodSignature *sig = [super methodSignatureForSelector:aSelector];
  if (sig != nil) {
    return sig;
  } else {
    return [[self response] methodSignatureForSelector:aSelector];
  }
}

- (BOOL)respondsToSelector:(SEL)aSelector {
  if ([super respondsToSelector:aSelector])
    return YES;
  
  return [[self response] respondsToSelector:aSelector];
}

- (NSString *)description {
  return [NSString stringWithFormat:@"{ status: %d, value:%@ }",
          status_, value_];
}

- (int)errorStatusCode {
  if (status_ == SUCCESS) {
    return 200;
  } else if (status_ > 399 && status_ < 500) {
    return status_;
  } else {
    return 500;
  }
}

#pragma mark Properties

- (BOOL)isError {
  return status_ != SUCCESS;
}

- (void)setIsError:(BOOL)newIsError {
  [self setStatus:(newIsError ? EUNHANDLEDERROR : SUCCESS)];
}

- (int)status {
  return [self errorStatusCode];
}

- (void)setStatus:(int)newStatus {
  status_ = newStatus;
  [self setResponseDirty];
}

- (id)value {
  return [[value_ retain] autorelease];
}

- (void)setValue:(id)newValue {
  [newValue retain];
  [value_ release];
  value_ = newValue;
  if (value_ != nil)
    [self setResponseDirty];
}

- (NSString *)sessionId {
  return sessionId_;
}

- (void)setSessionId:(NSString *)newSessionId {
  [sessionId_ release];
  sessionId_ = [newSessionId copy];
  [self setResponseDirty];
}

@end