RKTestHelpers Class Reference
| Inherits from | NSObject |
| Declared in | RKTestHelpers.h |
Overview
The RKTestHelpers class provides a number of helpful utility methods for use in unit or integration tests for RestKit applications.
Tasks
Stubbing Routes
-
+ stubRouteForClass:method:withPathPattern:onObjectManager:Stubs the route with the given class and method with a given path pattern.
-
+ stubRouteNamed:withPathPattern:onObjectManager:Stubs the route with the given name with a given path pattern.
-
+ stubRouteForRelationship:ofClass:pathPattern:onObjectManager:Stubs the relationship route for a given class with a given path pattern.
-
+ copyFetchRequestBlocksMatchingPathPattern:toBlocksMatchingRelativeString:onObjectManager:Finds all registered fetch request blocks matching the given path pattern and adds a new fetch request block that returns the same value as the origin block that matches the given relative string portion of a URL object.
Working with the Cache
-
+ disableCachingDisables caching by setting a new
[NSURLCache sharedURLCache]instance in which the memory and disk limits have been set to zero. -
+ cacheResponseForRequest:withResponseData:Creates, stores, and returns a
NSCachedURLResponseobject containing anNSHTTPURLResponsefor the given request with a 200 (OK) status code. -
+ cacheResponseForURL:HTTPMethod:headers:withData:Creates, stores, and returns a
NSCachedURLResponseobject containing anNSHTTPURLResponsefor the given URL and HTTP method with the given response data and a 200 (OK) status code.
Class Methods
cacheResponseForRequest:withResponseData:
Creates, stores, and returns a NSCachedURLResponse object containing an NSHTTPURLResponse for the given request with a 200 (OK) status code.
+ (NSCachedURLResponse *)cacheResponseForRequest:(NSURLRequest *)request withResponseData:(NSData *)responseDataParameters
- request
The request to cache the response for.
- responseData
The response data to be stored in the cache.
Return Value
The cached URL response that was stored to the cache.
Declared In
RKTestHelpers.hcacheResponseForURL:HTTPMethod:headers:withData:
Creates, stores, and returns a NSCachedURLResponse object containing an NSHTTPURLResponse for the given URL and HTTP method with the given response data and a 200 (OK) status code.
+ (NSCachedURLResponse *)cacheResponseForURL:(NSURL *)URL HTTPMethod:(NSString *)HTTPMethod headers:(NSDictionary *)requestHeaders withData:(NSData *)responseDataParameters
- URL
The URL to cache the response for.
- HTTPMethod
The HTTP method of the request (i.e. ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, or ‘DELETE’).
- responseData
The response data to be stored in the cache.
Return Value
The cached URL response that was stored to the cache.
Declared In
RKTestHelpers.hcopyFetchRequestBlocksMatchingPathPattern:toBlocksMatchingRelativeString:onObjectManager:
Finds all registered fetch request blocks matching the given path pattern and adds a new fetch request block that returns the same value as the origin block that matches the given relative string portion of a URL object.
+ (void)copyFetchRequestBlocksMatchingPathPattern:(NSString *)pathPattern toBlocksMatchingRelativeString:(NSString *)relativeString onObjectManager:(RKObjectManager *)nilOrObjectManagerParameters
- pathPattern
The path pattern that matches the fetch request blocks to be copied.
- relativeString
The relative string portion of the NSURL objects that the new blocks will match exactly.
- nilOrObjectManager
The object manager to stub the route on. If
nil, the shared object manager be be used.
Declared In
RKTestHelpers.hdisableCaching
Disables caching by setting a new [NSURLCache sharedURLCache] instance in which the memory and disk limits have been set to zero.
+ (void)disableCachingDeclared In
RKTestHelpers.hstubRouteForClass:method:withPathPattern:onObjectManager:
Stubs the route with the given class and method with a given path pattern.
+ (RKRoute *)stubRouteForClass:(Class)objectClass method:(RKRequestMethod)method withPathPattern:(NSString *)pathPattern onObjectManager:(RKObjectManager *)nilOrObjectManagerParameters
- objectClass
The class of the route to stub.
- method
The method of the route to stub.
- pathPattern
The path pattern to return instead in place of the current route’s value.
- nilOrObjectManager
The object manager to stub the route on. If
nil, the shared object manager be be used.
Return Value
The new stubbed route object that was added to the route set of the target object manager.
Declared In
RKTestHelpers.hstubRouteForRelationship:ofClass:pathPattern:onObjectManager:
Stubs the relationship route for a given class with a given path pattern.
+ (RKRoute *)stubRouteForRelationship:(NSString *)relationshipName ofClass:(Class)objectClass pathPattern:(NSString *)pathPattern onObjectManager:(RKObjectManager *)nilOrObjectManagerParameters
- relationshipName
The name of the relationship to stub the route of.
- objectClass
The class of the route to stub.
- pathPattern
The path pattern to return instead in place of the current route’s value.
- nilOrObjectManager
The object manager to stub the route on. If
nil, the shared object manager be be used.
Return Value
The new stubbed route object that was added to the route set of the target object manager.
Declared In
RKTestHelpers.hstubRouteNamed:withPathPattern:onObjectManager:
Stubs the route with the given name with a given path pattern.
+ (RKRoute *)stubRouteNamed:(NSString *)routeName withPathPattern:(NSString *)pathPattern onObjectManager:(RKObjectManager *)nilOrObjectManagerParameters
- routeName
The name of the route to stub.
- pathPattern
The path pattern to return instead in place of the current route’s value.
- nilOrObjectManager
The object manager to stub the route on. If
nil, the shared object manager be be used.
Return Value
The new stubbed route object that was added to the route set of the target object manager.
Declared In
RKTestHelpers.h