Updates to the model layer for AFNetworkign 2.0

Author: bengotow

MAPIClient.h

@@ -13,7 +13,7 @@
 #define NOTIF_MODEL_CHANGED         @"m_model_changed"
 #define NOTIF_API_QUEUE_CHANGED     @"m_api_queue_changed"
 
-@interface MAPIClient : AFHTTPClient
+@interface MAPIClient : AFHTTPRequestOperationManager
 {
     NSMutableArray * _transactionsQueue;
     BOOL _hasDisplayedDisconnectionNotice;
@@ -32,8 +32,8 @@
 
 #pragma mark Requesting Object Data
 
-- (void)getModelAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback;
-- (void)getCollectionAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback;
+- (void)dictionaryAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback;
+- (void)arrayAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback;
 - (void)requestPath:(NSString*)path withMethod:(NSString*)method withParameters: params userTriggered:(BOOL)triggered expectedClass:(Class)expectation success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback;
 
 - (MModel*)globalObjectWithID:(NSString*)ID ofClass:(Class)type;
@@ -49,7 +49,7 @@
 
 #pragma mark Handling Request Results
 
-- (void)criticalRequestFailed:(NSError*)err;
+- (void)displayNetworkError:(NSError*)error forOperation:(AFHTTPRequestOperation*)operation withGoal:(NSString*)goal;
 
 
 @end

MAPIClient.m

@@ -30,20 +30,14 @@ - (id)initWithBaseURL:(NSURL *)url
 {
     self = [super initWithBaseURL:url];
     if (self) {
-        [self registerHTTPOperationClass: [AFJSONRequestOperation class]];
-        [self setDefaultHeader:@"Accept" value:@"application/json"];
-        [self setAllowsInvalidSSLCertificate: YES];
-
-        typeof(self) __weak __self = self;
-        [self setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
-            [__self apiReachabilityChanged: status];
-        }];
+        [self setRequestSerializer: [AFJSONRequestSerializer serializer]];
+        [self setResponseSerializer: [AFJSONResponseSerializer serializerWithReadingOptions: NSJSONReadingAllowFragments]];
 
         @try {
             if ([[NSFileManager defaultManager] fileExistsAtPath: PATH_STORE_STATE]) {
                 NSDictionary * dict = [NSKeyedUnarchiver unarchiveObjectWithFile: PATH_STORE_STATE];
                 _globalObjectStore = [dict objectForKey:@"objectStore"];
-                _user = [dict objectForKey:@"user"];
+                [self setUser: [dict objectForKey:@"user"]];
             }
 
             if ([[NSFileManager defaultManager] fileExistsAtPath: PATH_ACTIONS_STATE])
@@ -58,13 +52,12 @@ - (id)initWithBaseURL:(NSURL *)url
         if (!_transactionsQueue)
             _transactionsQueue = [NSMutableArray array];
         [self performNextAction];
-
-        [[AFNetworkActivityIndicatorManager sharedManager] setEnabled:YES];
     }
     return self;
 }
 
-- (void)apiReachabilityChanged:(AFNetworkReachabilityStatus)status {
+- (void)apiReachabilityChanged:(AFNetworkReachabilityStatus)status
+{
     if (status == AFNetworkReachabilityStatusNotReachable) {
         if (!_hasDisplayedDisconnectionNotice) {
             _hasDisplayedDisconnectionNotice = YES;
@@ -104,38 +97,40 @@ - (void)updateDiskCacheDebounced
 
 #pragma mark Requesting Object Data
 
-- (void)getModelAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback
+- (void)dictionaryAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback
 {
     [self requestPath:path withMethod:@"GET" withParameters:nil userTriggered:triggered expectedClass:[NSDictionary class] success:successCallback failure:failureCallback];
 }
 
-- (void)getCollectionAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback
+- (void)arrayAtPath:(NSString*)path userTriggered:(BOOL)triggered success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback
 {
     [self requestPath:path withMethod:@"GET" withParameters:nil userTriggered:triggered expectedClass:[NSArray class] success:successCallback failure:failureCallback];
 }
 
 - (void)requestPath:(NSString*)path withMethod:(NSString*)method withParameters: params userTriggered:(BOOL)triggered expectedClass:(Class)expectation success:(void (^)(id responseObject))successCallback failure:(void (^)(NSError *err))failureCallback
 {
-    NSURLRequest *request = [self requestWithMethod:method path:path parameters:params];
-    AFHTTPRequestOperation *operation = [self HTTPRequestOperationWithRequest:request success:^(AFHTTPRequestOperation *operation, id responseObject) {
+    if (!self.baseURL)
+        @throw [NSException exceptionWithName:@"Cannot make request" reason:@"Base URL is not defined." userInfo:nil];
+        
+    NSMutableURLRequest *request = [self.requestSerializer requestWithMethod:method URLString:[[NSURL URLWithString:path relativeToURL:self.baseURL] absoluteString] parameters:params error:nil];
+    AFHTTPRequestOperation * operation = [self HTTPRequestOperationWithRequest:request success:^(AFHTTPRequestOperation *operation, id responseObject) {
         if (expectation && ([responseObject isKindOfClass: expectation] == NO)) {
-            NSError * err = [NSError errorWithExpectationFailure: [responseObject class]];
+            NSError * error = [NSError errorWithExpectationFailure: [responseObject class]];
             if (triggered)
-                [self criticalRequestFailed: err];
+                [self displayNetworkError:error forOperation:operation withGoal:@"Request"];
             if (failureCallback)
-                failureCallback(err);
+                failureCallback(error);
             return;
         }
         successCallback(responseObject);
-        
-    } failure:^(AFHTTPRequestOperation *operation, NSError *err) {
+
+    } failure:^(AFHTTPRequestOperation *operation, NSError *error) {
         if (triggered)
-            [self criticalRequestFailed: err];
+            [self displayNetworkError:error forOperation:operation withGoal:@"Request"];
         if (failureCallback)
-            failureCallback(err);
+            failureCallback(error);
     }];
-    
-    [self enqueueHTTPRequestOperation:operation];
+    [self.operationQueue addOperation:operation];
 }
 
 - (MModel*)globalObjectWithID:(NSString*)ID ofClass:(Class)type
@@ -158,8 +153,10 @@ - (void)addGlobalObject:(MModel*)model
 - (void)setUser:(MUser *)user
 {
     _user = user;
-    if (user == nil)
-        [self clearAuthorizationHeader];
+    if (user)
+        [[self requestSerializer] setAuthorizationHeaderFieldWithUsername:[user credentialUsername] password:[user credentialPassword]];
+    else
+        [[self requestSerializer] clearAuthorizationHeader];
 
     [self updateDiskCache: YES];
     [[NSNotificationCenter defaultCenter] postNotificationName:NOTIF_USER_CHANGED object:nil];
@@ -179,7 +176,7 @@ - (void)queueAPITransaction:(MAPITransaction*)a
         return;
 
     [_transactionsQueue addObject: a];
-    if (([self networkReachabilityStatus] != AFNetworkReachabilityStatusNotReachable) && (![a started]))
+    if (([[self reachabilityManager] networkReachabilityStatus] != AFNetworkReachabilityStatusNotReachable) && (![a started]))
         [a performDeferred];
 
     NSLog(@"API: Queued API action: %@", [a description]);
@@ -212,7 +209,7 @@ - (void)finishedAPITransaction:(MAPITransaction*)a withError:(NSError*)err
     } else if (err) {
         // TODO: Additional logic was here... Do we always want to throw away the transaction if it fails once?
         [self dequeueAPITransaction: a];
-        [self criticalRequestFailed: err];
+        [self displayNetworkError:err forOperation:nil withGoal:@"Request"];
     }
     [[NSNotificationCenter defaultCenter] postNotificationName:NOTIF_API_QUEUE_CHANGED object:nil];
 }
@@ -226,7 +223,7 @@ - (void)dequeueAPITransaction:(MAPITransaction*)a
 
 - (void)performNextActionIfReconnected
 {
-    if ([self networkReachabilityStatus] != AFNetworkReachabilityStatusNotReachable)
+    if ([[self reachabilityManager] networkReachabilityStatus] != AFNetworkReachabilityStatusNotReachable)
         [self performNextAction];
     else {
         NSString * msg = @"Please connect to the internet and try to sync again.";
@@ -248,24 +245,23 @@ - (void)performNextAction
 
 #pragma mark Handling Request Results
 
-- (void)criticalRequestFailed:(NSError*)err
+- (void)displayNetworkError:(NSError*)error forOperation:(AFHTTPRequestOperation*)operation withGoal:(NSString*)goal
 {
-    NSData * jsonData = [[err.userInfo objectForKey: @"NSLocalizedRecoverySuggestion"] dataUsingEncoding: NSUTF8StringEncoding];
-    NSString * message = err.localizedDescription;
-
-    if (jsonData) {
-        NSDictionary * json = [NSJSONSerialization JSONObjectWithData:jsonData options:NSJSONReadingAllowFragments error:NULL];
-        if (json) message = [json objectForKey: @"error"];
-    }
+    NSString * message = nil;
 
-    if ([err code] == 401)
+    if ([[operation responseObject] objectForKey: @"error"])
+        message = [[operation responseObject] objectForKey: @"error"];
+    
+    else if (([error code] == 401) || ([[operation response] statusCode] == 401))
         message = @"Please check your email address and password.";
 
-    if (message && [message isKindOfClass: [NSString class]])
-        [[[UIAlertView alloc] initWithTitle:@"Error" message:message delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil] show];
+    else
+        message = [error localizedDescription];
 
-    [[NSNotificationCenter defaultCenter] postNotificationName:NOTIF_API_QUEUE_CHANGED object:nil];
+    NSString * title = [goal stringByAppendingString: @" Failed"];
+    [[[UIAlertView alloc] initWithTitle:title message:message delegate:nil cancelButtonTitle:@"OK" otherButtonTitles: nil] show];
 }
 
 
+
 @end

MModel.m

@@ -173,7 +173,7 @@ - (void)save:(MAPITransactionCallback)callback
 
 - (void)reload:(MAPITransactionCallback)callback
 {
-    [[MAPIClient shared] getModelAtPath:[self resourcePath] userTriggered:NO success:^(id responseObject) {
+    [[MAPIClient shared] dictionaryAtPath:[self resourcePath] userTriggered:NO success:^(id responseObject) {
         [self updateWithResourceJSON: responseObject];
         if (callback) callback(YES);
 

MModelCollection.m

@@ -172,7 +172,7 @@ - (void)updateFromPath:(NSString*)path replaceExistingContents:(BOOL)replace wit
 
     _refreshInProgress = YES;
 
-    [[MAPIClient shared] getCollectionAtPath:path userTriggered:NO success:^(id responseObject) {
+    [[MAPIClient shared] arrayAtPath:path userTriggered:NO success:^(id responseObject) {
         _loadReturnedLessThanRequested = ([responseObject count] < _collectionPageSize);
         [self updateWithResourceJSON: responseObject discardMissingModels: replace];
         [self setRefreshDate: [NSDate date]];

MUser.h

@@ -10,4 +10,7 @@
 
 @interface MUser : MModel
 
+- (NSString*)credentialUsername;
+- (NSString*)credentialPassword;
+
 @end

MUser.m

@@ -10,4 +10,14 @@
 
 @implementation MUser
 
+- (NSString*)credentialUsername
+{
+    return nil;
+}
+
+- (NSString*)credentialPassword
+{
+    return nil;
+}
+
 @end

NSObject+AssociatedObjects.m

@@ -31,7 +31,10 @@ - (void)performSelectorOnMainThreadOnce:(SEL)selector
 
     dispatch_async(dispatch_get_main_queue(), ^{
         if ([self associatedValueForKey: (void*)selector]) {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
             [self performSelector: selector];
+#pragma clang diagnostic pop
             [self associateValue:nil withKey:(void*)selector];
         }
     });

UIColor-Expanded.m

@@ -306,7 +306,7 @@ - (NSString *)stringFromColor {
 }
 
 - (NSString *)hexStringFromColor {
-	return [NSString stringWithFormat:@"%0.6X", self.rgbHex];
+	return [NSString stringWithFormat:@"%0.6X", (unsigned int)self.rgbHex];
 }
 
 + (UIColor *)colorWithString:(NSString *)stringToConvert {