forked from joserodolfofreitas/aerogear-ios-integration
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AGPagingBody_Reddit.m
486 lines (363 loc) · 15.3 KB
/
AGPagingBody_Reddit.m
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
/*
* JBoss, Home of Professional Open Source
* Copyright Red Hat, Inc., and individual contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import "AGAbstractBaseTestClass.h"
#import "AGAuthenticationModuleAdapter.h"
#import "AGHttpClient.h"
/*
* A custom Authentication Module that goes against Reddit service.
*
*/
@interface AGRedditAuthenticationModule : NSObject <AGAuthenticationModuleAdapter>
@end
@implementation AGRedditAuthenticationModule {
// as all other custom auth modules, (eg. AGRestAuthentication) we
// internally use the AGHttpClient to perform http communication. This
// allows us to have full access to the underlying http setup.
// (e.g. setting custom headers etc.)
AGHttpClient* _restClient;
}
@synthesize type = _type;
@synthesize baseURL = _baseURL;
@synthesize loginEndpoint = _loginEndpoint;
@synthesize logoutEndpoint = _logoutEndpoint;
@synthesize enrollEndpoint = _enrollEndpoint;
@synthesize authTokens = _authTokens;
-(id)init {
self = [super init];
if (self) {
_type = @"REDDIT";
_baseURL = @"http://www.reddit.com";
_loginEndpoint = @"/api/login";
_logoutEndpoint = @"/api/logout";
_restClient = [AGHttpClient clientFor:[NSURL URLWithString:_baseURL]];
_restClient.parameterEncoding = AFFormURLParameterEncoding;
}
return self;
}
-(NSString*) loginEndpoint {
return [_baseURL stringByAppendingString:_loginEndpoint];
}
-(NSString*) logoutEndpoint {
return [_baseURL stringByAppendingString:_logoutEndpoint];
}
-(NSString*) enrollEndpoint {
return [_baseURL stringByAppendingString:_enrollEndpoint];
}
-(void) enroll:(id) userData
success:(void (^)(id object))success
failure:(void (^)(NSError *error))failure {
@throw [NSException exceptionWithName:@"InvalidMessage"
reason:@"enroll not applicable."
userInfo:nil];
}
-(void) login:(NSString*) username
password:(NSString*) password
success:(void (^)(id object))success
failure:(void (^)(NSError *error))failure {
NSString* loginURL = [NSString stringWithFormat:@"%@", _loginEndpoint];
[_restClient setDefaultHeader:@"User-Agent" value:[@"AeroGear iOS /u/" stringByAppendingString:username]];
NSDictionary* loginData = [NSDictionary
dictionaryWithObjectsAndKeys:@"json", @"api_type",
username, @"user",
password, @"passwd", nil];
[_restClient postPath:loginURL parameters:loginData success:^(AFHTTPRequestOperation *operation, id responseObject) {
// stash the auth token...:
[self readAndStashToken:responseObject];
if (success) {
success(responseObject);
}
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
if (failure) {
failure(error);
}
}];
}
-(void) logout:(void (^)())success
failure:(void (^)(NSError *error))failure {
@throw [NSException exceptionWithName:@"InvalidMessage"
reason:@"logout not applicable."
userInfo:nil];
}
-(void) cancel {
// cancel all running http operations
[_restClient.operationQueue cancelAllOperations];
}
// private method
-(void) readAndStashToken:(id) responseObject {
_authTokens = [[NSMutableDictionary alloc] init];
NSDictionary* data = [[responseObject objectForKey:@"json"] objectForKey:@"data"];
// extract reddit authentication headers
NSString* authToken = [data objectForKey:@"cookie"];
NSString* modhash = [data objectForKey:@"modhash"];
[_authTokens setObject:[@"reddit_session=" stringByAppendingString:authToken] forKey:@"Cookie"];
[_authTokens setObject:modhash forKey:@"modhash"];
}
- (BOOL)isAuthenticated {
return (nil != _authTokens);
}
- (void)deauthorize {
_authTokens = nil;
}
@end
// Custom AGPageParameterExtractor for Reddit
@interface RedditPageParameterExtractor : NSObject<AGPageParameterExtractor>
@end
@implementation RedditPageParameterExtractor
- (NSDictionary*) parse:(id)response
headers:(NSDictionary*)headers
next:(NSString*)nextIdentifier
prev:(NSString*)prevIdentifier {
id element;
NSMutableDictionary *mapOfLink = [NSMutableDictionary dictionary];
// extract "next page" identifier
element = [response copy];
NSArray* nextIdentifiers = [nextIdentifier componentsSeparatedByString:@"."];
for (NSString* identifier in nextIdentifiers) {
element = [element objectForKey:identifier];
}
if (element && ![element isKindOfClass:[NSNull class]]) {
[mapOfLink setObject:[NSDictionary dictionaryWithObjectsAndKeys:element, @"after",
[NSNumber numberWithInt:25], @"limit", nil] forKey:@"AG-next-key"];
}
// extract "previous page" identifier
element = [response copy];
NSArray* prevIdentifiers = [prevIdentifier componentsSeparatedByString:@"."];
for (NSString* identifier in prevIdentifiers) {
element = [element objectForKey:identifier];
}
if (element && ![element isKindOfClass:[NSNull class]]) {
[mapOfLink setObject:[NSDictionary dictionaryWithObjectsAndKeys:element, @"before",
[NSNumber numberWithInt:25], @"limit", nil] forKey:@"AG-prev-key"];
}
return mapOfLink;
}
@end
@interface AGPagingBody_Reddit : AGAbstractBaseTestClass
@end
@implementation AGPagingBody_Reddit {
AGPipeline* _rdtPipeline;
id<AGPipe> _rdt;
id<AGAuthenticationModule> _rdtAuth;
}
-(void)setUp {
[super setUp];
// setting up the pipeline for the Reddit pipe
NSURL* baseURL = [NSURL URLWithString:@"http://www.reddit.com"];
_rdtAuth = [[AGRedditAuthenticationModule alloc] init];
[_rdtAuth login:@"aerogear" password:@"123456" success:^(id object) {
_rdtPipeline = [AGPipeline pipelineWithBaseURL:baseURL];
_rdt = [_rdtPipeline pipe:^(id<AGPipeConfig> config) {
[config setAuthModule:_rdtAuth];
[config setName:@".json"];
[config setLimit:[NSNumber numberWithInt:25]];
[config setNextIdentifier:@"data.after"];
[config setPreviousIdentifier:@"data.before"];
[config setPageExtractor:[[RedditPageParameterExtractor alloc] init]];
}];
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
[self setFinishRunLoop:NO];
}
-(void)tearDown {
[super tearDown];
}
-(void)testNext {
__block NSMutableArray *pagedResultSet;
// fetch the first page
[_rdt read:^(id responseObject) {
pagedResultSet = responseObject; // page 1
// hold the "post id" from the first page, so that
// we can match with the result when we move
// to the next page down in the test. (hopefully ;-))
NSString* post_id = [self extractPostId:responseObject];
// move to the next page
[pagedResultSet next:^(id responseObject) {
STAssertFalse([post_id isEqualToString:[self extractPostId:responseObject]], @"id's should not match.");
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
}
-(void)testPreviousFromFirstPage {
__block NSMutableArray *pagedResultSet;
// fetch the first page
[_rdt read:^(id responseObject) {
pagedResultSet = responseObject; // page 1
// move back to an invalid page
[pagedResultSet previous:^(id responseObject) {
// Note: although success is called
// and we ask a non existing page
// (prev identifier was missing from the response)
// reddit responded with a list of results.
// Some apis such as github respond even on the
// invalid page but others may throw an error
// (see Twitter and AGController case).
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
}
-(void)testMoveNextAndPrevious {
__block NSMutableArray *pagedResultSet;
// fetch the first page
[_rdt read:^(id responseObject) {
pagedResultSet = responseObject; // page 1
// hold the "post id" from the first page, so that
// we can match with the result when we move
// to the next page down in the test. (hopefully ;-))
NSString* post_id = [self extractPostId:responseObject];
// move to the next page
[pagedResultSet next:^(id responseObject) {
// move backwards (aka. page 1)
[pagedResultSet previous:^(id responseObject) {
STAssertEqualObjects(post_id, [self extractPostId:responseObject], @"id's must match.");
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
NSLog(@"end");
}
-(void)testParameterProvider {
id<AGPipe> rdt = [_rdtPipeline pipe:^(id<AGPipeConfig> config) {
[config setName:@".json"];
[config setAuthModule:_rdtAuth];
[config setParameterProvider:@{@"limit" : @"10"}];
[config setNextIdentifier:@"data.after"];
[config setPreviousIdentifier:@"data.before"];
[config setPageExtractor:[[RedditPageParameterExtractor alloc] init]];
}];
// giving nil, should use the global (see above)
[rdt readWithParams:nil success:^(id responseObject) {
NSArray* results = [[[responseObject objectAtIndex:0] objectForKey:@"data"] objectForKey:@"children"];
STAssertTrue([results count] == 10, @"size should be 10");
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
}
-(void)testBogusNextIdentifier {
id<AGPipe> rdt = [_rdtPipeline pipe:^(id<AGPipeConfig> config) {
[config setName:@".json"];
[config setAuthModule:_rdtAuth];
[config setParameterProvider:@{@"limit" : @"25"}];
// bogus identifier
[config setNextIdentifier:@"foo"];
[config setPreviousIdentifier:@"data.before"];
[config setPageExtractor:[[RedditPageParameterExtractor alloc] init]];
}];
__block NSMutableArray *pagedResultSet;
[rdt read:^(id responseObject) {
pagedResultSet = responseObject;
[pagedResultSet next:^(id responseObject) {
// Note: succces is called here with default
// response of currently 25 elements. This is the default
// behaviour of reddit if invalid params are
// passed. Note this is not always the case as seen in
// the Twitter/AGController test case.
// Reddit behaviour is an exception here.
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
}];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
}
-(void)testBogusPreviousIdentifier {
id<AGPipe> rdt = [_rdtPipeline pipe:^(id<AGPipeConfig> config) {
[config setName:@".json"];
[config setAuthModule:_rdtAuth];
[config setParameterProvider:@{@"limit" : @"25"}];
[config setNextIdentifier:@"data.after"];
// bogus identifier
[config setPreviousIdentifier:@"foo"];
[config setPageExtractor:[[RedditPageParameterExtractor alloc] init]];
}];
__block NSMutableArray *pagedResultSet;
[rdt read:^(id responseObject) {
pagedResultSet = responseObject;
[pagedResultSet previous:^(id responseObject) {
// Note: succces is called here with default
// response of currently 25 elements. This is the default
// behaviour of reddit if invalid params are
// passed. Note this is not always the case as seen in
// the Twitter/AGController test case.
// Reddit behaviour is an exception here.
[self setFinishRunLoop:YES];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
}];
} failure:^(NSError *error) {
[self setFinishRunLoop:YES];
STFail(@"%@", error);
}];
// keep the run loop going
while(![self finishRunLoop]) {
[[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
}
}
// helper method to extract the post id from the result set
-(NSString*)extractPostId:(NSArray*) responseObject {
NSArray* results = [[[responseObject objectAtIndex:0] objectForKey:@"data"] objectForKey:@"children"];
return [[[results objectAtIndex:0] objectForKey:@"data"] objectForKey:@"id"];
}
@end