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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/***********************************************************************************
*
* Copyright (c) 2015 Jinlian (Sunny) Wang
*
* 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, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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 <OHHTTPStubs/OHHTTPStubs+Mocktail.h>
NSString* const MocktailErrorDomain = @"Mocktail";
@implementation OHHTTPStubs (Mocktail)
+(NSArray *)stubRequestsUsingMocktailsAtPath:(NSString *)path inBundle:(nullable NSBundle*)bundleOrNil error:(NSError **)error
{
NSURL *dirURL = [bundleOrNil?:[NSBundle bundleForClass:self.class] URLForResource:path withExtension:nil];
if (!dirURL)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathDoesNotExist userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Path '%@' does not exist.", path]}];
}
return nil;
}
// Make sure path points to a directory
NSNumber *isDirectory;
BOOL success = [dirURL getResourceValue:&isDirectory forKey:NSURLIsDirectoryKey error:nil];
BOOL isDir = (success && [isDirectory boolValue]);
if (!isDir)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathIsNotFolder userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Path '%@' is not a folder.", path]}];
}
return nil;
}
// Read the content of the directory
NSError *bError = nil;
NSFileManager *fileManager = [NSFileManager defaultManager];
NSArray *fileURLs = [fileManager contentsOfDirectoryAtURL:dirURL includingPropertiesForKeys:nil options:0 error:&bError];
if (bError)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathFailedToRead userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error reading path '%@'.", dirURL.absoluteString]}];
}
return nil;
}
//stub the Mocktail-formatted requests
NSMutableArray *descriptorArray = [[NSMutableArray alloc] initWithCapacity:fileURLs.count];
for (NSURL *fileURL in fileURLs)
{
if (![fileURL.absoluteString hasSuffix:@".tail"])
{
continue;
}
id<OHHTTPStubsDescriptor> descriptor = [[self class] stubRequestsUsingMocktail:fileURL error: &bError];
if (descriptor && !bError)
{
[descriptorArray addObject:descriptor];
}
}
return descriptorArray;
}
+(id<OHHTTPStubsDescriptor>)stubRequestsUsingMocktailNamed:(NSString *)fileName inBundle:(nullable NSBundle*)bundleOrNil error:(NSError **)error
{
NSURL *responseURL = [bundleOrNil?:[NSBundle bundleForClass:self.class] URLForResource:fileName withExtension:@"tail"];
if (!responseURL)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathDoesNotExist userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' does not exist.", fileName]}];
}
return nil;
}
else
{
return [[self class] stubRequestsUsingMocktail:responseURL error:error];
}
}
+(id<OHHTTPStubsDescriptor>)stubRequestsUsingMocktail:(NSURL *)fileURL error:(NSError **)error
{
NSError *bError = nil;
NSStringEncoding originalEncoding;
NSString *contentsOfFile = [NSString stringWithContentsOfURL:fileURL usedEncoding:&originalEncoding error:&bError];
if (!contentsOfFile || bError)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorPathFailedToRead userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' does not read.", fileURL.absoluteString]}];
}
return nil;
}
NSScanner *scanner = [NSScanner scannerWithString:contentsOfFile];
NSString *headerMatter = nil;
[scanner scanUpToString:@"\n\n" intoString:&headerMatter];
NSArray *lines = [headerMatter componentsSeparatedByString:@"\n"];
if (lines.count < 4)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileFormat userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid amount of lines:%u.", fileURL.absoluteString, (unsigned)lines.count]}];
}
return nil;
}
/* Handle Mocktail format, adapted from Mocktail implementation
For more details on the file format, check out: https://github.com/square/objc-Mocktail */
NSRegularExpression *methodRegex = [NSRegularExpression regularExpressionWithPattern:lines[0] options:NSRegularExpressionCaseInsensitive error:&bError];
if (bError)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileFormat userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid method regular expression pattern: %@.", fileURL.absoluteString, lines[0]]}];
}
return nil;
}
NSRegularExpression *absoluteURLRegex = [NSRegularExpression regularExpressionWithPattern:lines[1] options:NSRegularExpressionCaseInsensitive error:&bError];
if (bError)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileFormat userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid URL regular expression pattern: %@.", fileURL.absoluteString, lines[1]]}];
}
return nil;
}
NSInteger statusCode = [lines[2] integerValue];
NSMutableDictionary *headers = @{@"Content-Type":lines[3]}.mutableCopy;
// From line 5 to '\n\n', expect HTTP response headers.
NSRegularExpression *headerPattern = [NSRegularExpression regularExpressionWithPattern:@"^([^:]+):\\s+(.*)" options:0 error:&bError];
if (bError)
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInternalError userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Internal error while stubbing file '%@'.", fileURL.absoluteString]}];
}
return nil;
}
for (NSUInteger line = 4; line < lines.count; line ++) {
NSString *headerLine = lines[line];
NSTextCheckingResult *match = [headerPattern firstMatchInString:headerLine options:0 range:NSMakeRange(0, headerLine.length)];
if (match)
{
NSString *key = [headerLine substringWithRange:[match rangeAtIndex:1]];
NSString *value = [headerLine substringWithRange:[match rangeAtIndex:2]];
headers[key] = value;
}
else
{
if (error)
{
*error = [NSError errorWithDomain:MocktailErrorDomain code:OHHTTPStubsMocktailErrorInvalidFileHeader userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"File '%@' has invalid header: %@.", fileURL.absoluteString, headerLine]}];
}
return nil;
}
}
// Handle binary which is base64 encoded
NSUInteger bodyOffset = [headerMatter dataUsingEncoding:NSUTF8StringEncoding].length + 2;
return [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
NSString *absoluteURL = (request.URL).absoluteString;
NSString *method = request.HTTPMethod;
if ([absoluteURLRegex numberOfMatchesInString:absoluteURL options:0 range:NSMakeRange(0, absoluteURL.length)] > 0)
{
if ([methodRegex numberOfMatchesInString:method options:0 range:NSMakeRange(0, method.length)] > 0)
{
return YES;
}
}
return NO;
} withStubResponse:^OHHTTPStubsResponse*(NSURLRequest *request) {
if([headers[@"Content-Type"] hasSuffix:@";base64"])
{
NSString *type = headers[@"Content-Type"];
NSString *newType = [type substringWithRange:NSMakeRange(0, type.length - 7)];
headers[@"Content-Type"] = newType;
NSData *body = [NSData dataWithContentsOfURL:fileURL];
body = [body subdataWithRange:NSMakeRange(bodyOffset, body.length - bodyOffset)];
body = [[NSData alloc] initWithBase64EncodedData:body options:NSDataBase64DecodingIgnoreUnknownCharacters];
OHHTTPStubsResponse *response = [OHHTTPStubsResponse responseWithData:body statusCode:(int)statusCode headers:headers];
return response;
}
else
{
OHHTTPStubsResponse *response = [OHHTTPStubsResponse responseWithFileAtPath:fileURL.path
statusCode:(int)statusCode headers:headers];
[response.inputStream setProperty:@(bodyOffset) forKey:NSStreamFileCurrentOffsetKey];
return response;
}
}];
}
@end
|
