Repository navigation
Expand file tree
/
Copy pathIRWebAPIEngine.m
More file actions
562 lines (290 loc) · 17.8 KB
/
Copy pathIRWebAPIEngine.m
File metadata and controls
562 lines (290 loc) · 17.8 KB
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
//
// IRWebAPIEngine.m
// IRWebAPIKit
//
// Created by Evadne Wu on 11/19/10.
// Copyright 2010 Iridia Productions. All rights reserved.
//
#import <objc/runtime.h>
#import "IRWebAPIEngine.h"
NSString * const kIRWebAPIEngineResponseDictionaryIncomingData = @"kIRWebAPIEngineResponseDictionaryIncomingData";
NSString * const kIRWebAPIEngineResponseDictionaryOutgoingContext = @"kIRWebAPIEngineResponseDictionaryOutgoingContext";
NSString * const kIRWebAPIEngineAssociatedDataStore = @"kIRWebAPIEngineAssociatedDataStore";
NSString * const kIRWebAPIEngineAssociatedResponseContext = @"kIRWebAPIEngineAssociatedResponseContext";
NSString * const kIRWebAPIEngineAssociatedSuccessHandler = @"kIRWebAPIEngineAssociatedSuccessHandler";
NSString * const kIRWebAPIEngineAssociatedFailureHandler = @"kIRWebAPIEngineAssociatedFailureHandler";
@interface IRWebAPIEngine ()
@property (nonatomic, readwrite, retain) IRWebAPIContext *context;
@property (nonatomic, readwrite, retain) NSMutableArray *globalRequestPreTransformers;
@property (nonatomic, readwrite, retain) NSMutableDictionary *requestTransformers;
@property (nonatomic, readwrite, retain) NSMutableArray *globalRequestPostTransformers;
@property (nonatomic, readwrite, retain) NSMutableArray *globalResponsePreTransformers;
@property (nonatomic, readwrite, retain) NSMutableDictionary *responseTransformers;
@property (nonatomic, readwrite, retain) NSMutableArray *globalResponsePostTransformers;
@property (nonatomic, readwrite, assign) dispatch_queue_t sharedDispatchQueue;
- (void) setInternalDataStore:(NSMutableData *)inDataStore forConnection:(NSURLConnection *)inConnection;
- (NSMutableData *) internalDataStoreForConnection:(NSURLConnection *)inConnection;
- (void) setInternalResponseContext:(NSMutableDictionary *)inResponseContext forConnection:(NSURLConnection *)inConnection;
- (NSMutableDictionary *) internalResponseContextForConnection:(NSURLConnection *)inConnection;
- (void) setInternalSuccessHandler:(void (^)(NSData *inResponse))inSuccessHandler forConnection:(NSURLConnection *)inConnection;
- (void (^)(NSData *inResponse)) internalSuccessHandlerForConnection:(NSURLConnection *)inConnection;
- (void) setInternalFailureHandler:(void (^)(void))inFailureHandler forConnection:(NSURLConnection *)inConnection;
- (void (^)(void)) internalFailureHandlerForConnection:(NSURLConnection *)inConnection;
- (IRWebAPIEngineExecutionBlock) executionBlockForAPIRequestNamed:(NSString *)inMethodName withArguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil validator:(IRWebAPIResposeValidator)inValidator successHandler:(IRWebAPICallback)inSuccessHandler failureHandler:(IRWebAPICallback)inFailureHandler;
- (void) ensureResponseParserExistence;
- (NSDictionary *) baseRequestContextWithMethodName:(NSString *)inMethodName arguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil;
- (NSDictionary *) requestContextByTransformingContext:(NSDictionary *)inContext forMethodNamed:(NSString *)inMethodName;
- (NSURLRequest *) requestWithContext:(NSDictionary *)inContext;
- (NSDictionary *) parsedResponseForData:(NSData *)inData withContext:(NSDictionary *)inContext;
- (void) handleUnparsableResponseForData:(NSData *)inData context:(NSDictionary *)inContext;
- (NSDictionary *) responseByTransformingResponse:(NSDictionary *)inResponse forMethodNamed:(NSString *)inMethodName;
- (void) cleanUpForConnection:(NSURLConnection *)inConnection;
@end
@implementation IRWebAPIEngine
# pragma mark -
# pragma mark Initializationand Memory Management
- (id) initWithContext:(IRWebAPIContext *)inContext {
self = [super init]; if (!self) return nil;
context = [inContext retain];
self.globalRequestPreTransformers = [NSMutableArray array];
self.requestTransformers = [NSMutableDictionary dictionary];
self.globalRequestPostTransformers = [NSMutableArray array];
self.globalResponsePreTransformers = [NSMutableArray array];
self.responseTransformers = [NSMutableDictionary dictionary];
self.globalResponsePostTransformers = [NSMutableArray array];
self.sharedDispatchQueue = dispatch_queue_create("com.iridia.WebAPIEngine.queue.main", NULL);
return self;
}
- (id) init {
return [self initWithContext:nil];
}
- (void) dealloc {
self.parser = nil;
self.context = nil;
self.globalRequestPreTransformers = nil;
self.requestTransformers = nil;
self.globalRequestPostTransformers = nil;
self.globalRequestPostTransformers = nil;
self.responseTransformers = nil;
self.globalRequestPostTransformers = nil;
dispatch_release(self.sharedDispatchQueue);
self.sharedDispatchQueue = nil;
[super dealloc];
}
# pragma mark -
# pragma mark Helpers
- (void) ensureResponseParserExistence {
if (self.parser) return;
NSLog(@"Warning: IRWebAPIEngine is designed to work with a parser. Without one, the response will be sent as a default dictionary.");
self.parser = IRWebAPIResponseDefaultParserMake();
}
- (NSDictionary *) parsedResponseForData:(NSData *)inData withContext:(NSDictionary *)inContext {
IRWebAPIResponseParser parserBlock = [inContext objectForKey:kIRWebAPIEngineParser];
NSDictionary *parsedResponse = parserBlock(inData);
if (parsedResponse)
return parsedResponse;
[self handleUnparsableResponseForData:inData context:inContext];
return [NSDictionary dictionaryWithObjectsAndKeys:
inData, kIRWebAPIEngineResponseDictionaryIncomingData,
inContext, kIRWebAPIEngineResponseDictionaryOutgoingContext,
nil];
}
- (void) handleUnparsableResponseForData:(NSData *)inData context:(NSDictionary *)inContext {
NSLog(@"%@ %s Warning: unparsable response. Resetting returned response to an empty dictionary.", self, __PRETTY_FUNCTION__);
NSLog(@"Context: %@", inContext);
// This can potentially clog up the wirings
// IRWebAPIResponseParser defaultParser = IRWebAPIResponseDefaultParserMake();
// NSDictionary *debugOutput = defaultParser(inData);
// NSLog(@"Default parser returns %@.", debugOutput ? (id<NSObject>)debugOutput : (id<NSObject>)@"- null -");
}
- (void) fireAPIRequestNamed:(NSString *)inMethodName withArguments:(NSDictionary *)inArgumentsOrNil successHandler:(IRWebAPICallback)inSuccessHandler failureHandler:(IRWebAPICallback)inFailureHandler {
dispatch_async(self.sharedDispatchQueue, ^ {
dispatch_async(dispatch_get_current_queue(), [self executionBlockForAPIRequestNamed:inMethodName withArguments:inArgumentsOrNil options:nil validator:nil successHandler:inSuccessHandler failureHandler:inFailureHandler]);
});
}
- (void) fireAPIRequestNamed:(NSString *)inMethodName withArguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil validator:(IRWebAPIResposeValidator)inValidator successHandler:(IRWebAPICallback)inSuccessHandler failureHandler:(IRWebAPICallback)inFailureHandler {
dispatch_async(self.sharedDispatchQueue, ^ {
dispatch_async(dispatch_get_current_queue(), [self executionBlockForAPIRequestNamed:inMethodName withArguments:inArgumentsOrNil options:inOptionsOrNil validator:inValidator successHandler:inSuccessHandler failureHandler:inFailureHandler]);
});
}
- (void) fireAPIRequestNamed:(NSString *)inMethodName withArguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil successHandler:(IRWebAPICallback)inSuccessHandler failureHandler:(IRWebAPICallback)inFailureHandler {
dispatch_async(self.sharedDispatchQueue, ^ {
dispatch_async(dispatch_get_current_queue(), [self executionBlockForAPIRequestNamed:inMethodName withArguments:inArgumentsOrNil options:inOptionsOrNil validator:nil successHandler:inSuccessHandler failureHandler:inFailureHandler]);
});
}
- (void) enqueueAPIRequestNamed:(NSString *)inMethodName withArguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil successHandler:(IRWebAPICallback)inSuccessHandler failureHandler:(IRWebAPICallback)inFailureHandler {
dispatch_async(self.sharedDispatchQueue, ^ {
dispatch_async(self.sharedDispatchQueue, [self executionBlockForAPIRequestNamed:inMethodName withArguments:inArgumentsOrNil options:inOptionsOrNil validator:nil successHandler:inSuccessHandler failureHandler:inFailureHandler]);
});
}
# pragma mark -
# pragma mark Core
- (IRWebAPIEngineExecutionBlock) executionBlockForAPIRequestNamed:(NSString *)inMethodName withArguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil validator:(IRWebAPIResposeValidator)inValidator successHandler:(IRWebAPICallback)inSuccessHandler failureHandler:(IRWebAPICallback)inFailureHandler {
[self ensureResponseParserExistence];
void (^retryHandler)(void) = ^ {
// FIXME: Actually, the block doesn’t know if it is enqueued or fired
[self enqueueAPIRequestNamed:inMethodName withArguments:inArgumentsOrNil options:inOptionsOrNil successHandler:inSuccessHandler failureHandler:inFailureHandler];
};
void (^notifyDelegateHandler)(void) = ^ {
NSLog(@"Notifying delegate of connection finalization");
};
NSDictionary *finalizedContext = [self requestContextByTransformingContext:[self baseRequestContextWithMethodName:inMethodName arguments:inArgumentsOrNil options:inOptionsOrNil] forMethodNamed:inMethodName];
NSURLRequest *request = [self requestWithContext:finalizedContext];
void (^returnedBlock) (void) = ^ {
dispatch_async(dispatch_get_main_queue(), ^{
// dispatch_async(self.sharedDispatchQueue, ^{
NSURLConnection *connection = [[[NSURLConnection alloc] initWithRequest:request delegate:self] autorelease];
[self setInternalSuccessHandler: ^ (NSData *inResponse) {
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
BOOL shouldRetry = NO, notifyDelegate = NO;
NSDictionary *parsedResponse = [self parsedResponseForData:inResponse withContext:finalizedContext];
NSDictionary *transformedResponse = [self responseByTransformingResponse:parsedResponse forMethodNamed:inMethodName];
NSDictionary *responseContext = [self internalResponseContextForConnection:connection];
if ((inValidator != nil) && (!inValidator(transformedResponse))) {
if (inFailureHandler)
inFailureHandler(transformedResponse, responseContext, ¬ifyDelegate, &shouldRetry);
} else {
if (inSuccessHandler)
inSuccessHandler(transformedResponse, responseContext, ¬ifyDelegate, &shouldRetry);
}
if (shouldRetry) retryHandler();
if (notifyDelegate) notifyDelegateHandler();
[self cleanUpForConnection:connection];
[pool drain];
} forConnection:connection];
[self setInternalFailureHandler: ^ {
BOOL shouldRetry = NO, notifyDelegate = NO;
NSDictionary *responseContext = [self internalResponseContextForConnection:connection];
if (inFailureHandler)
inFailureHandler([NSDictionary dictionary], responseContext, ¬ifyDelegate, &shouldRetry);
if (shouldRetry) retryHandler();
if (notifyDelegate) notifyDelegateHandler();
[self cleanUpForConnection:connection];
} forConnection:connection];
[self setInternalDataStore:[NSMutableData data] forConnection:connection];
[self setInternalResponseContext:[NSMutableDictionary dictionary] forConnection:connection];
[connection start];
});
};
return [[returnedBlock copy] autorelease];
}
# pragma mark -
# pragma mark Connection Delegation
- (void) connection:(NSURLConnection *)inConnection didReceiveData:(NSData *)inData {
dispatch_async(self.sharedDispatchQueue, ^{
[[self internalDataStoreForConnection:inConnection] appendData:inData];
});
}
- (void) connection:(NSURLConnection *)connection didReceiveResponse:(NSURLResponse *)response {
NSLog(@"Connection %@ did receive response %@", connection, response);
NSMutableDictionary *responseContext = [self internalResponseContextForConnection:connection];
[responseContext setObject:response forKey:kIRWebAPIEngineResponseContextURLResponseName];
}
- (void) connectionDidFinishLoading:(NSURLConnection *)inConnection {
dispatch_async(self.sharedDispatchQueue, ^{
[self internalSuccessHandlerForConnection:inConnection]([self internalDataStoreForConnection:inConnection]);
});
}
- (void) connection:(NSURLConnection *)inConnection didFailWithError:(NSError *)error {
NSLog(@"Connection did fail with error %@", error);
dispatch_async(self.sharedDispatchQueue, ^{
[self internalFailureHandlerForConnection:inConnection]();
});
}
# pragma mark -
# pragma mark Associated Objects
// Notice that blocks are made on the stack so they must be copied before being stored away
- (void) setInternalSuccessHandler:(void (^)(NSData *inResponse))inSuccessHandler forConnection:(NSURLConnection *)inConnection {
objc_setAssociatedObject(inConnection, kIRWebAPIEngineAssociatedSuccessHandler, inSuccessHandler, OBJC_ASSOCIATION_COPY);
}
- (void (^)(NSData *inResponse)) internalSuccessHandlerForConnection:(NSURLConnection *)inConnection {
return objc_getAssociatedObject(inConnection, kIRWebAPIEngineAssociatedSuccessHandler);
}
- (void) setInternalFailureHandler:(void (^)(void))inFailureHandler forConnection:(NSURLConnection *)inConnection {
objc_setAssociatedObject(inConnection, kIRWebAPIEngineAssociatedFailureHandler, inFailureHandler, OBJC_ASSOCIATION_COPY);
}
- (void (^)(void)) internalFailureHandlerForConnection:(NSURLConnection *)inConnection {
return objc_getAssociatedObject(inConnection, kIRWebAPIEngineAssociatedFailureHandler);
}
- (void) setInternalDataStore:(NSMutableData *)inDataStore forConnection:(NSURLConnection *)inConnection {
objc_setAssociatedObject(inConnection, kIRWebAPIEngineAssociatedDataStore, inDataStore, OBJC_ASSOCIATION_RETAIN);
}
- (NSMutableData *) internalDataStoreForConnection:(NSURLConnection *)inConnection {
return objc_getAssociatedObject(inConnection, kIRWebAPIEngineAssociatedDataStore);
}
- (void) setInternalResponseContext:(NSMutableDictionary *)inResponseContext forConnection:(NSURLConnection *)inConnection {
objc_setAssociatedObject(inConnection, kIRWebAPIEngineAssociatedResponseContext, inResponseContext, OBJC_ASSOCIATION_RETAIN);
}
- (NSMutableDictionary *) internalResponseContextForConnection:(NSURLConnection *)inConnection {
return objc_getAssociatedObject(inConnection, kIRWebAPIEngineAssociatedResponseContext);
}
- (void) cleanUpForConnection:(NSURLConnection *)inConnection {
dispatch_async(dispatch_get_main_queue(), ^{
objc_removeAssociatedObjects(inConnection);
});
}
- (NSMutableArray *) requestTransformersForMethodNamed:(NSString *)inMethodName {
NSMutableArray *returnedArray = [self.requestTransformers objectForKey:inMethodName];
if (!returnedArray) {
returnedArray = [NSMutableArray array];
[self.requestTransformers setObject:returnedArray forKey:inMethodName];
}
return returnedArray;
}
- (NSMutableArray *) responseTransformersForMethodNamed:(NSString *)inMethodName {
NSMutableArray *returnedArray = [self.responseTransformers objectForKey:inMethodName];
if (!returnedArray) {
returnedArray = [NSMutableArray array];
[self.responseTransformers setObject:returnedArray forKey:inMethodName];
}
return returnedArray;
}
- (NSDictionary *) baseRequestContextWithMethodName:(NSString *)inMethodName arguments:(NSDictionary *)inArgumentsOrNil options:(NSDictionary *)inOptionsOrNil {
NSMutableDictionary *arguments = [NSMutableDictionary dictionary];
if (inArgumentsOrNil) for (id argumentKey in [inArgumentsOrNil keysOfEntriesPassingTest:^(id key, id object, BOOL *stop) {
if ([object isEqual:@""]) return NO;
if ([object isEqual:[NSNull null]]) return NO;
return YES;
}]) [arguments setObject:[inArgumentsOrNil objectForKey:argumentKey] forKey:argumentKey];
NSMutableDictionary *transformedContext = [NSMutableDictionary dictionaryWithObjectsAndKeys:
[self.context baseURLForMethodNamed:inMethodName], kIRWebAPIEngineRequestHTTPBaseURL,
[NSMutableDictionary dictionary], kIRWebAPIEngineRequestHTTPHeaderFields,
arguments, kIRWebAPIEngineRequestHTTPQueryParameters,
[NSNull null], kIRWebAPIEngineRequestHTTPBody,
@"GET", kIRWebAPIEngineRequestHTTPMethod,
self.parser, kIRWebAPIEngineParser,
nil];
for (id optionValueKey in inOptionsOrNil)
[transformedContext setValue:[inOptionsOrNil valueForKey:optionValueKey] forKey:optionValueKey];
return [[transformedContext copy] autorelease];
}
- (NSDictionary *) requestContextByTransformingContext:(NSDictionary *)inContext forMethodNamed:(NSString *)inMethodName {
return IRWebAPITransformedContextFromTransformerArraysGet(inContext, [NSArray arrayWithObjects:
self.globalRequestPreTransformers,
[self requestTransformersForMethodNamed:inMethodName],
self.globalRequestPostTransformers,
nil]);
}
- (NSDictionary *) responseByTransformingResponse:(NSDictionary *)inResponse forMethodNamed:(NSString *)inMethodName {
return IRWebAPITransformedContextFromTransformerArraysGet(inResponse, [NSArray arrayWithObjects:
self.globalResponsePreTransformers,
[self responseTransformersForMethodNamed:inMethodName],
self.globalResponsePostTransformers,
nil]);
}
- (NSURLRequest *) requestWithContext:(NSDictionary *)inContext {
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:IRWebAPIRequestURLWithQueryParameters(
(NSURL *)[inContext objectForKey:kIRWebAPIEngineRequestHTTPBaseURL],
[inContext objectForKey:kIRWebAPIEngineRequestHTTPQueryParameters]
) cachePolicy:NSURLRequestUseProtocolCachePolicy timeoutInterval:10.0];
NSDictionary *headerFields;
if ((headerFields = [inContext objectForKey:kIRWebAPIEngineRequestHTTPHeaderFields]))
for (NSString *headerFieldKey in headerFields)
[request setValue:[headerFields objectForKey:headerFieldKey] forHTTPHeaderField:headerFieldKey];
NSData *httpBody = [inContext objectForKey:kIRWebAPIEngineRequestHTTPBody];
if (![httpBody isEqual:[NSNull null]])
[request setHTTPBody:httpBody];
[request setHTTPMethod:[inContext objectForKey:kIRWebAPIEngineRequestHTTPMethod]];
return [[request copy] autorelease];
}
@end