-
Notifications
You must be signed in to change notification settings - Fork 4
/
ARResource+Private.h
84 lines (69 loc) · 3.22 KB
/
ARResource+Private.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// ActiveResourceKit ARResource+Private.h
//
// Copyright © 2011–2013, 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 <ActiveResourceKit/ARResource.h>
@class ARHTTPResponse;
/**
* Extracts the resource identifier from the given HTTP response.
*
* The HTTP response includes a Location header field specifying the
* resource's full resource location. Rails places the resource ID at the last
* element in the location path. The implementation extracts this element using
* a regular expression.
* @result Answers an NSNumber numerical identifier based on the response
* location field. Answers `nil` if the response does not contain a Location
* header, or if the Location field does not match the format `"/foo/bar/1"`.
*/
NSNumber *ARIDFromResponse(ARHTTPResponse *response);
/**
* Determines whether the HTTP 1.1 specification allows a response to
* have a body (see section 4.4.1 of the specification).
*/
BOOL ARResponseCodeAllowsBody(NSInteger code);
@interface ARResource(Private)
- (void)updateWithCompletionHandler:(void (^)(ARHTTPResponse *response, NSError *error))completionHandler;
- (void)createWithCompletionHandler:(void (^)(ARHTTPResponse *response, NSError *error))completionHandler;
/**
* @param response A HTTP response wrapper.
* @param attributes Set of attributes decoded from the response body.
*/
- (void)loadAttributesFromResponse:(ARHTTPResponse *)response attributes:(NSDictionary *)attributes;
/**
* Answers this resource's element path.
* @param options Prefix and query options for overriding the existing resource
* prefix options if any.
*/
- (NSString *)elementPathWithOptions:(NSDictionary *)options;
- (NSString *)newElementPath;
- (NSString *)collectionPathWithOptions:(NSDictionary *)options;
//----------------------------------------------------- Active Model Conversions
/**
* Enumerates all key attributes.
*
* @result Only answers key attributes if the resource persists. Answers `nil`
* otherwise since key attributes only logically exist when the resource begins
* to persist.
*/
- (NSArray *)toKey;
- (NSString *)toParam;
@end