Source

NSURLConnectionVCR / README.md

NSURLConnectionVCR

NSURLConnectionVCR provides an easy way to record and re-play NSURLConnection requests/responses. By removing the dependency on external web servers, your tests will run fast and deterministic. Don't worry, no need to change your existing NSURLConnection-based code. NSURLConnectionVCR hooks into NSURLConnection by 'swizzling' implementations at run-time.

This project is inspired on Myron Marston's VCR for Ruby on Rails.

Getting Started

First, start the VCR and give it a storage path:

[NSURLConnectionVCR startVCRWithPath:@"fixtures/vcr_cassettes" error:nil];

Then perform a request using NSURLConnection:

NSURL* url = [NSURL URLWithString:@"http://api.example.com/fancy.json"];
NSURLRequest* request = [NSURLRequest requestWithURL:url];
NSHTTPURLResponse* response = nil;
NSData* data = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:nil];

The first time this code is run, it will run the request and store the response in a file at the specified path. Run it again, and VCR will 'play back' the recorded response from disk, without making a call to the web server.

Optionally, stop the VCR once you're done:

[NSURLConnectionVCR stopVCRWithError:nil];

Adding NSURLConnectionVCR to your project

Requirements:

  • Mac OS X 10.7 SDK or later
  • iOS 5.0 SDK or later
  • ARC (Automatic Reference Counting)

Just add NSURLConnectionVCR.m and NSURLConnectionVCR.h to your project. There are no external dependencies, except of course Foundation.framework and the Objective C runtime.

Quicklook plug-in

NSURLConnectionVCR creates one file per unique request and stores it at the specified path. The provided Quicklook plug-in makes basic inspection of these cache files convenient. A cache file is basically an archive containing the NSURLResponse and NSData that were returned when the request was done. The name of the cache file is the MD5 digest of the original NSURLRequest. The Quicklook preview displays the response data and puts the original URL and HTTP status code as title of the preview window.

License

Copyright (c) 2012, Martijn The All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.