Merge lp:~rockstar/ubuntuoneauthkit/oauth into lp:ubuntuoneauthkit

[Paul Hummer]

Store the OAuth data using the UOKeyManager. Add interfaces for checking those tokens. Add the accompanying tests.

Store the OAuth data using the UOKeyManager. Add interfaces for checking those tokens. Add the accompanying tests.

[Zachery Bir (urbanape)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The prerequisite https://code.launchpad.net/~rockstar/ubuntuoneauthkit/more-cleanup has not yet been merged into https://code.launchpad.net/~ubuntuone-ios-client-team/ubuntuoneauthkit/trunk.

=== modified file 'UbuntuOneAuthKit.xcodeproj/project.pbxproj'
--- UbuntuOneAuthKit.xcodeproj/project.pbxproj	2012-09-26 03:53:18 +0000
+++ UbuntuOneAuthKit.xcodeproj/project.pbxproj	2012-09-26 03:53:18 +0000
@@ -192,10 +192,29 @@
 			children = (
 				523CC104160B6B7000B36474 /* UOKeyManager.h */,
 				523CC105160B6B7000B36474 /* UOKeyManager.m */,
+				52527AFD16050BA7000F9A90 /* UONetworkStatusCoordinator.h */,
+				52527AFE16050BA7000F9A90 /* UONetworkStatusCoordinator.m */,
+				52B57DF116057F590031E95C /* UOURLQueryStringParser.h */,
+				52B57DF216057F590031E95C /* UOURLQueryStringParser.m */,
 			);
 			name = Utilities;
 			sourceTree = "<group>";
 		};
+		523CC13D161285F900B36474 /* Operations */ = {
+			isa = PBXGroup;
+			children = (
+				528515AE1605034A004A1F7C /* UOAbstractNetworkOperation.h */,
+				528515AF1605034A004A1F7C /* UOAbstractNetworkOperation.m */,
+				52B57DE916052C700031E95C /* UOHTTPFetchOperation.h */,
+				52B57DEA16052C700031E95C /* UOHTTPFetchOperation.m */,
+				528515AA160502AB004A1F7C /* UOJSONFetchOperation.h */,
+				528515AB160502AB004A1F7C /* UOJSONFetchOperation.m */,
+				52B57DED16057DD80031E95C /* UOSSOMusicCredsFetchOperation.h */,
+				52B57DEE16057DD80031E95C /* UOSSOMusicCredsFetchOperation.m */,
+			);
+			name = Operations;
+			sourceTree = "<group>";
+		};
 		52527B0216052179000F9A90 /* Dependencies */ = {
 			isa = PBXGroup;
 			children = (
@@ -250,21 +269,10 @@
 		528515681604F16B004A1F7C /* UbuntuOneAuthKit */ = {
 			isa = PBXGroup;
 			children = (
+				523CC13D161285F900B36474 /* Operations */,
 				523CC0FE160B697E00B36474 /* Utilities */,
-				528515AE1605034A004A1F7C /* UOAbstractNetworkOperation.h */,
-				528515AF1605034A004A1F7C /* UOAbstractNetworkOperation.m */,
 				5285159A1604F473004A1F7C /* UOAuthManager.h */,
 				5285159B1604F473004A1F7C /* UOAuthManager.m */,
-				52B57DE916052C700031E95C /* UOHTTPFetchOperation.h */,
-				52B57DEA16052C700031E95C /* UOHTTPFetchOperation.m */,
-				528515AA160502AB004A1F7C /* UOJSONFetchOperation.h */,
-				528515AB160502AB004A1F7C /* UOJSONFetchOperation.m */,
-				52527AFD16050BA7000F9A90 /* UONetworkStatusCoordinator.h */,
-				52527AFE16050BA7000F9A90 /* UONetworkStatusCoordinator.m */,
-				52B57DED16057DD80031E95C /* UOSSOMusicCredsFetchOperation.h */,
-				52B57DEE16057DD80031E95C /* UOSSOMusicCredsFetchOperation.m */,
-				52B57DF116057F590031E95C /* UOURLQueryStringParser.h */,
-				52B57DF216057F590031E95C /* UOURLQueryStringParser.m */,
 				528515691604F16B004A1F7C /* Supporting Files */,
 			);
 			path = UbuntuOneAuthKit;

=== modified file 'UbuntuOneAuthKit/UOAuthManager.h'
--- UbuntuOneAuthKit/UOAuthManager.h	2012-09-26 03:53:18 +0000
+++ UbuntuOneAuthKit/UOAuthManager.h	2012-09-26 03:53:18 +0000
@@ -8,6 +8,10 @@
 
 #import <Foundation/Foundation.h>
 
+static NSString *UOOAuthConsumerKey = @"UOOAuthConsumerKey";
+static NSString *UOOAuthConsumerSecret = @"UOOAuthConsumerSecret";
+static NSString *UOOAuthToken = @"UOOAuthToken";
+static NSString *UOOAuthTokenSecret = @"UOOAuthTokenSecret";
 static NSString *UOSubsonicUsernameKey = @"UOSubsonicUsername";
 static NSString *UOSubsonicPasswordKey = @"UOSubsonicPassword";
 
@@ -16,7 +20,11 @@
 @interface UOAuthManager : NSObject
 + (UOAuthManager *)sharedAuthManager;
 - (void)loginWithUsername:(NSString *)username andPassword:(NSString *)password tokenName:(NSString *)tokenName completionBlock:(void(^)())completionBlock errorBlock:(void(^)(NSError *))errorBlock;
+- (void)logout;
+- (BOOL)hasCredentials;
+
 - (void)fetchSubsonicCredentials:(void(^)(NSString *))completionBlock errorBlock:(void(^)(NSError *))errorBlock;
+- (BOOL)hasSubsonicCredentials;
 - (NSString *)subsonicUsername;
 - (NSString *)subsonicPassword;
 - (void)clearSubsonicCredentials;

=== modified file 'UbuntuOneAuthKit/UOAuthManager.m'
--- UbuntuOneAuthKit/UOAuthManager.m	2012-09-26 03:53:18 +0000
+++ UbuntuOneAuthKit/UOAuthManager.m	2012-09-26 03:53:18 +0000
@@ -32,14 +32,6 @@
 
 @interface UOAuthManager () {
     NSOperationQueue *operationQueue;
-    
-    /* rockstar (16 Sept 2012) - I don't like this interface. It does not persist,
-     * and is not reusable across different runs (so it's required to run again, which
-     * is craziness...
-     */
-    OAConsumer *consumer;
-    OAToken *token;
-    OAPlaintextSignatureProvider *signatureProvider;
 }
 @end
 
@@ -82,36 +74,42 @@
         
         /* New token needs to be imported into Ubuntu One from SSO */
         NSDictionary *response = (NSDictionary *)jsonResult;
-        NSString *encodedUsername = [username urlParameterEncodedString];
-        NSURL *tokenURL = [NSURL URLWithString:[NSString stringWithFormat:@"https://one.ubuntu.com/oauth/sso-finished-so-get-tokens/%@", encodedUsername]];
-        
-        consumer = [[OAConsumer alloc] initWithKey:[response objectForKey:@"consumer_key"] secret:[response objectForKey:@"consumer_secret"]];
-        token = [[OAToken alloc] initWithKey:[response objectForKey:@"token"] secret:[response objectForKey:@"token_secret"]];
-        signatureProvider = [[OAPlaintextSignatureProvider alloc] init];
-        OAMutableURLRequest *oauthRequest = [[OAMutableURLRequest alloc] initWithURL:tokenURL consumer:consumer token:token realm:nil signatureProvider:signatureProvider];
-        [oauthRequest prepare];
-        
-        UOHTTPFetchOperation *tokenSyncOperation = [UOHTTPFetchOperation httpOperationWithRequest:oauthRequest action:^(NSString *responseBody, NSError *error) {
-            if (error) {
-                if (errorBlock) {
-                    errorBlock(error);
-                }
-                return;
-            }
-            if (completionBlock) {
-                completionBlock();
-            }
-        }];
-        [operationQueue addOperation:tokenSyncOperation];
+        
+        UOKeyManager *keyManager = [UOKeyManager sharedManager];
+        [keyManager createKey:UOOAuthConsumerKey withValue:[response objectForKey:@"consumer_key"]];
+        [keyManager createKey:UOOAuthConsumerSecret withValue:[response objectForKey:@"consumer_secret"]];
+        [keyManager createKey:UOOAuthToken withValue:[response objectForKey:@"token"]];
+        [keyManager createKey:UOOAuthTokenSecret withValue:[response objectForKey:@"token_secret"]];
+        
+        [self syncUbuntuSSOTokens:username completionBlock:completionBlock errorBlock:errorBlock];
 	}];
 	tokenCreationOperation.credential = credential;
 	[operationQueue addOperation:tokenCreationOperation];
 }
 
+- (void)logout {
+    UOKeyManager *keyManager = [UOKeyManager sharedManager];
+    [keyManager deleteKey:UOOAuthConsumerKey];
+    [keyManager deleteKey:UOOAuthConsumerSecret];
+    [keyManager deleteKey:UOOAuthToken];
+    [keyManager deleteKey:UOOAuthTokenSecret];
+    
+    [self clearSubsonicCredentials];
+}
+
+- (BOOL)hasCredentials {
+    UOKeyManager *keyManager = [UOKeyManager sharedManager];
+    return (BOOL)[keyManager readKey:UOOAuthConsumerKey];
+}
+
 #pragma mark
 #pragma mark Subsonic specific methods
 
 -(void)fetchSubsonicCredentials:(void (^)(NSString *))completionBlock errorBlock:(void (^)(NSError *))errorBlock {
+    UOKeyManager *keyManager = [UOKeyManager sharedManager];
+    OAConsumer *consumer = [[OAConsumer alloc] initWithKey:[keyManager readKey:UOOAuthConsumerKey] secret:[keyManager readKey:UOOAuthConsumerSecret]];
+    OAToken *token = [[OAToken alloc] initWithKey:[keyManager readKey:UOOAuthToken] secret:[keyManager readKey:UOOAuthTokenSecret]];
+    OAPlaintextSignatureProvider *signatureProvider = [[OAPlaintextSignatureProvider alloc] init];
     
     NSURL *credsURL = [NSURL URLWithString:@"https://one.ubuntu.com/phones/creds/ios?scheme=x-ubuntuone-music"];
     OAMutableURLRequest *credsRequest = [[OAMutableURLRequest alloc] initWithURL:credsURL consumer:consumer token:token realm:nil signatureProvider:signatureProvider];
@@ -171,4 +169,36 @@
     [manager deleteKey:UOSubsonicPasswordKey];
 }
 
+-(BOOL)hasSubsonicCredentials {
+    return (BOOL)[[UOKeyManager sharedManager] readKey:UOSubsonicUsernameKey];
+}
+
+#pragma mark
+#pragma mark Private methods
+
+-(void)syncUbuntuSSOTokens:(NSString *)username completionBlock:(void (^)())completionBlock errorBlock:(void (^)(NSError *))errorBlock {
+    UOKeyManager *keyManager = [UOKeyManager sharedManager];
+    NSString *encodedUsername = [username urlParameterEncodedString];
+    NSURL *tokenURL = [NSURL URLWithString:[NSString stringWithFormat:@"https://one.ubuntu.com/oauth/sso-finished-so-get-tokens/%@", encodedUsername]];
+    
+    OAConsumer *consumer = [[OAConsumer alloc] initWithKey:[keyManager readKey:UOOAuthConsumerKey] secret:[keyManager readKey:UOOAuthConsumerSecret]];
+    OAToken *token = [[OAToken alloc] initWithKey:[keyManager readKey:UOOAuthToken] secret:[keyManager readKey:UOOAuthTokenSecret]];
+    OAPlaintextSignatureProvider *signatureProvider = [[OAPlaintextSignatureProvider alloc] init];
+    OAMutableURLRequest *oauthRequest = [[OAMutableURLRequest alloc] initWithURL:tokenURL consumer:consumer token:token realm:nil signatureProvider:signatureProvider];
+    [oauthRequest prepare];
+    
+    UOHTTPFetchOperation *tokenSyncOperation = [UOHTTPFetchOperation httpOperationWithRequest:oauthRequest action:^(NSString *responseBody, NSError *error) {
+        if (error) {
+            if (errorBlock) {
+                errorBlock(error);
+            }
+            return;
+        }
+        if (completionBlock) {
+            completionBlock();
+        }
+    }];
+    [operationQueue addOperation:tokenSyncOperation];
+}
+
 @end

=== modified file 'UbuntuOneAuthKitTests/UbuntuOneAuthKitTests.m'
--- UbuntuOneAuthKitTests/UbuntuOneAuthKitTests.m	2012-09-26 03:53:18 +0000
+++ UbuntuOneAuthKitTests/UbuntuOneAuthKitTests.m	2012-09-26 03:53:18 +0000
@@ -26,7 +26,7 @@
 - (void)tearDown
 {
     UOKeyManager *manager = [UOKeyManager sharedManager];
-    NSArray *keys = [NSArray arrayWithObjects:TestKey, UOSubsonicUsernameKey, UOSubsonicPasswordKey, nil];
+    NSArray *keys = [NSArray arrayWithObjects:TestKey, UOOAuthConsumerKey, UOOAuthConsumerSecret, UOOAuthToken, UOOAuthTokenSecret, UOSubsonicUsernameKey, UOSubsonicPasswordKey, nil];
     for (NSString *key in keys) {
         [manager deleteKey:key];
     }
@@ -81,4 +81,30 @@
     STAssertNil([[UOKeyManager sharedManager] readKey:UOSubsonicPasswordKey], nil);
 }
 
+-(void)testUOAuthManagerLogout {
+    [[UOKeyManager sharedManager] createKey:UOOAuthConsumerKey withValue:@"myConsumerKey"];
+    [[UOKeyManager sharedManager] createKey:UOOAuthConsumerSecret withValue:@"myConsumerSecret"];
+    [[UOKeyManager sharedManager] createKey:UOOAuthToken withValue:@"myToken"];
+    [[UOKeyManager sharedManager] createKey:UOOAuthTokenSecret withValue:@"myTokenSecret"];
+    
+    [[UOAuthManager sharedAuthManager] logout];
+    
+    STAssertNil([[UOKeyManager sharedManager] readKey:UOOAuthConsumerKey], nil);
+    STAssertNil([[UOKeyManager sharedManager] readKey:UOOAuthConsumerSecret], nil);
+    STAssertNil([[UOKeyManager sharedManager] readKey:UOOAuthToken], nil);
+    STAssertNil([[UOKeyManager sharedManager] readKey:UOOAuthTokenSecret], nil);
+}
+
+-(void)testUOAuthManagerHasCredentials {
+    STAssertFalse([[UOAuthManager sharedAuthManager] hasCredentials], nil);
+    [[UOKeyManager sharedManager] createKey:UOOAuthConsumerKey withValue:@"myConsumerKey"];
+    STAssertTrue([[UOAuthManager sharedAuthManager] hasCredentials], nil);
+}
+
+-(void)testUOAuthManagerHasSubsonicCredentials {
+    STAssertFalse([[UOAuthManager sharedAuthManager] hasSubsonicCredentials], nil);
+    [[UOKeyManager sharedManager] createKey:UOSubsonicUsernameKey withValue:@"Test User"];
+    STAssertTrue([[UOAuthManager sharedAuthManager] hasSubsonicCredentials], nil);
+}
+
 @end