Merge pull request #124 from AndreasTextunes/develop

toto · toto · commit afae991569be · 2014-07-17T12:22:37.000+02:00
Adding custom header in order to provide a POST with custom MIME types
diff --git a/Sources/OAuth2Client/NXOAuth2Account.m b/Sources/OAuth2Client/NXOAuth2Account.m
@@ -92,6 +92,7 @@ - (NXOAuth2Client *)oauthClient;
             NSString *tokenType = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationTokenType];
             NSString *keychainGroup = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationTokenType];
             NSDictionary *additionalQueryParams = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationAdditionalAuthenticationParameters];
+            NSDictionary *customHeaderFields = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationCustomHeaderFields];
 
             oauthClient = [[NXOAuth2Client alloc] initWithClientID:clientID
                                                       clientSecret:clientSecret
@@ -106,6 +107,10 @@ - (NXOAuth2Client *)oauthClient;
                 oauthClient.additionalAuthenticationParameters = additionalQueryParams;
             }
             
+            if (customHeaderFields) {
+                oauthClient.customHeaderFields = customHeaderFields;
+            }
+            
         }
     }
     return oauthClient;
diff --git a/Sources/OAuth2Client/NXOAuth2AccountStore.h b/Sources/OAuth2Client/NXOAuth2AccountStore.h
@@ -36,7 +36,6 @@ extern NSString * const kNXOAuth2AccountStoreConfigurationScope;
 extern NSString * const kNXOAuth2AccountStoreConfigurationTokenType;
 extern NSString * const kNXOAuth2AccountStoreConfigurationTokenRequestHTTPMethod;
 
-
 /* 
  * Requires a NSDictionary as a value.
  * They are passed onto the authentication request as additional query parameters.
@@ -45,6 +44,13 @@ extern NSString * const kNXOAuth2AccountStoreConfigurationTokenRequestHTTPMethod
  */
 extern NSString * const kNXOAuth2AccountStoreConfigurationAdditionalAuthenticationParameters;
 
+/*
+ * Requires a NSDictionary as a value.
+ * They are passed onto the HTTP Header Fields request as additional parameters.
+ * Example of a valid setup: @{ @"Content-type" : @"application/x-www-form-urlencoded" }
+ */
+extern NSString * const kNXOAuth2AccountStoreConfigurationCustomHeaderFields;
+
 
 #pragma mark Account Type
 
diff --git a/Sources/OAuth2Client/NXOAuth2AccountStore.m b/Sources/OAuth2Client/NXOAuth2AccountStore.m
@@ -45,6 +45,7 @@
 NSString * const kNXOAuth2AccountStoreConfigurationTokenRequestHTTPMethod = @"kNXOAuth2AccountStoreConfigurationTokenRequestHTTPMethod";
 NSString * const kNXOAuth2AccountStoreConfigurationKeyChainGroup = @"kNXOAuth2AccountStoreConfigurationKeyChainGroup";
 NSString * const kNXOAuth2AccountStoreConfigurationAdditionalAuthenticationParameters = @"kNXOAuth2AccountStoreConfigurationAdditionalAuthenticationParameters";
+NSString * const kNXOAuth2AccountStoreConfigurationCustomHeaderFields = @"kNXOAuth2AccountStoreConfigurationCustomHeaderFields";
 
 #pragma mark Account Type
 
@@ -404,6 +405,7 @@ - (NXOAuth2Client *)pendingOAuthClientForAccountType:(NSString *)accountType;
             NSString *tokenRequestHTTPMethod = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationTokenRequestHTTPMethod];
             NSString *keychainGroup = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationKeyChainGroup];
             NSDictionary *additionalAuthenticationParameters = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationAdditionalAuthenticationParameters];
+            NSDictionary *customHeaderFields = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationCustomHeaderFields];
 
             client = [[NXOAuth2Client alloc] initWithClientID:clientID
                                                  clientSecret:clientSecret
@@ -424,6 +426,9 @@ - (NXOAuth2Client *)pendingOAuthClientForAccountType:(NSString *)accountType;
                 NSAssert([additionalAuthenticationParameters isKindOfClass:[NSDictionary class]], @"additionalAuthenticationParameters have to be a NSDictionary");
                 client.additionalAuthenticationParameters = additionalAuthenticationParameters;
             }
+            if (customHeaderFields) {
+                client.customHeaderFields = customHeaderFields;
+            }
 
             if (scope != nil) {
                 client.desiredScope = scope;
@@ -606,7 +611,7 @@ + (NSDictionary *)accountsFromDefaultKeychain;
     result = (__bridge_transfer NSDictionary *)cfResult;
 
     if (status != noErr) {
-        NSAssert1(status == errSecItemNotFound, @"Unexpected error while fetching accounts from keychain: %d", (int)status);
+        NSAssert1(status == errSecItemNotFound, @"Unexpected error while fetching accounts from keychain: %zd", status);
         return nil;
     }
 
@@ -627,7 +632,7 @@ + (void)storeAccountsInDefaultKeychain:(NSDictionary *)accounts;
                            data, kSecAttrGeneric,
                            nil];
     OSStatus __attribute__((unused)) err = SecItemAdd((__bridge CFDictionaryRef)query, NULL);
-    NSAssert1(err == noErr, @"Error while adding token to keychain: %d", (int)err);
+    NSAssert1(err == noErr, @"Error while adding token to keychain: %zd", err);
 }
 
 + (void)removeFromDefaultKeychain;
@@ -638,7 +643,7 @@ + (void)removeFromDefaultKeychain;
                            serviceName, kSecAttrService,
                            nil];
     OSStatus __attribute__((unused)) err = SecItemDelete((__bridge CFDictionaryRef)query);
-    NSAssert1((err == noErr || err == errSecItemNotFound), @"Error while deleting token from keychain: ld", (int)err);
+    NSAssert1((err == noErr || err == errSecItemNotFound), @"Error while deleting token from keychain: %zd", err);
 
 }
 
diff --git a/Sources/OAuth2Client/NXOAuth2Client.h b/Sources/OAuth2Client/NXOAuth2Client.h
@@ -65,6 +65,7 @@ extern NSString * const NXOAuth2ClientConnectionContextTokenRefresh;
 @property (nonatomic, copy, readonly) NSString *clientSecret;
 @property (nonatomic, copy, readonly) NSString *tokenType;
 @property (nonatomic, strong, readwrite) NSDictionary *additionalAuthenticationParameters;
+@property (nonatomic, strong, readwrite) NSDictionary *customHeaderFields;
 
 @property (nonatomic, copy) NSSet *desiredScope;
 @property (nonatomic, copy) NSString *tokenRequestHTTPMethod; // defaults to POST
diff --git a/Sources/OAuth2Client/NXOAuth2Client.m b/Sources/OAuth2Client/NXOAuth2Client.m
@@ -330,6 +330,12 @@ - (void)requestTokenWithAuthGrant:(NSString *)authGrant redirectURL:(NSURL *)red
         [parameters setObject:[[self.desiredScope allObjects] componentsJoinedByString:@" "] forKey:@"scope"];
     }
     
+    if (self.customHeaderFields) {
+        [self.customHeaderFields enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *obj, BOOL *stop) {
+            [tokenRequest addValue:obj forHTTPHeaderField:key];
+        }];
+    }
+    
     if (self.additionalAuthenticationParameters) {
         [parameters addEntriesFromDictionary:self.additionalAuthenticationParameters];
     }
@@ -360,6 +366,13 @@ - (void)authenticateWithClientCredentials;
     if (self.desiredScope) {
         [parameters setObject:[[self.desiredScope allObjects] componentsJoinedByString:@" "] forKey:@"scope"];
     }
+    
+    if (self.customHeaderFields) {
+        [self.customHeaderFields enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *obj, BOOL *stop) {
+            [tokenRequest addValue:obj forHTTPHeaderField:key];
+        }];
+    }
+    
     authConnection = [[NXOAuth2Connection alloc] initWithRequest:tokenRequest
                                                requestParameters:parameters
                                                      oauthClient:self
@@ -393,6 +406,12 @@ - (void)authenticateWithUsername:(NSString *)username password:(NSString *)passw
         [parameters addEntriesFromDictionary:self.additionalAuthenticationParameters];
     }
     
+    if (self.customHeaderFields) {
+        [self.customHeaderFields enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *obj, BOOL *stop) {
+            [tokenRequest addValue:obj forHTTPHeaderField:key];
+        }];
+    }
+    
     authConnection = [[NXOAuth2Connection alloc] initWithRequest:tokenRequest
                                                requestParameters:parameters
                                                      oauthClient:self
diff --git a/Sources/OAuth2Client/NXOAuth2Connection.m b/Sources/OAuth2Client/NXOAuth2Connection.m
@@ -223,20 +223,38 @@ - (void)applyParameters:(NSDictionary *)parameters onRequest:(NSMutableURLReques
     NSString *httpMethod = [aRequest HTTPMethod];
     if ([httpMethod caseInsensitiveCompare:@"POST"] != NSOrderedSame
         && [httpMethod caseInsensitiveCompare:@"PUT"] != NSOrderedSame) {
+        
         aRequest.URL = [aRequest.URL nxoauth2_URLByAddingParameters:parameters];
+        
     } else {
-        NSInputStream *postBodyStream = [[NXOAuth2PostBodyStream alloc] initWithParameters:parameters];
         
-        NSString *contentType = [NSString stringWithFormat:@"multipart/form-data; boundary=%@", [(NXOAuth2PostBodyStream *)postBodyStream boundary]];
-        NSString *contentLength = [NSString stringWithFormat:@"%lld", [(NXOAuth2PostBodyStream *)postBodyStream length]];
-        [aRequest setValue:contentType forHTTPHeaderField:@"Content-Type"];
-        [aRequest setValue:contentLength forHTTPHeaderField:@"Content-Length"];
+        NSString *contentType = [aRequest valueForHTTPHeaderField:@"Content-Type"];
+        
+        if (!contentType || [contentType isEqualToString:@"multipart/form-data"]) {
         
-        [aRequest setHTTPBodyStream:postBodyStream];
+            // sends the POST/PUT request as multipart/form-data as default
+            
+            NSInputStream *postBodyStream = [[NXOAuth2PostBodyStream alloc] initWithParameters:parameters];
+            
+            contentType = [NSString stringWithFormat:@"multipart/form-data; boundary=%@",[(NXOAuth2PostBodyStream *)postBodyStream boundary]];
+            NSString *contentLength = [NSString stringWithFormat:@"%lld", [(NXOAuth2PostBodyStream *)postBodyStream length]];
+            [aRequest setValue:contentType forHTTPHeaderField:@"Content-Type"];
+            [aRequest setValue:contentLength forHTTPHeaderField:@"Content-Length"];
+            
+            [aRequest setHTTPBodyStream:postBodyStream];
+            
+        } else if ([contentType isEqualToString:@"application/x-www-form-urlencoded"]) {
+            
+            // sends the POST/PUT request as application/x-www-form-urlencoded
+            
+            NSString *query = [[aRequest.URL nxoauth2_URLByAddingParameters:parameters] query];
+            [aRequest setHTTPBody:[query dataUsingEncoding:NSUTF8StringEncoding]];
+            
+        }
+
     }
 }
 
-
 - (BOOL)trustsAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge
                           forHostname:(NSString *)hostname
                         withTrustMode:(NXOAuth2TrustMode)trustMode;

Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,7 @@ - (NXOAuth2Client *)oauthClient;`
`92`	`92`	`NSString *tokenType = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationTokenType];`
`93`	`93`	`NSString *keychainGroup = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationTokenType];`
`94`	`94`	`NSDictionary *additionalQueryParams = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationAdditionalAuthenticationParameters];`
	`95`	`+ NSDictionary *customHeaderFields = [configuration objectForKey:kNXOAuth2AccountStoreConfigurationCustomHeaderFields];`
`95`	`96`
`96`	`97`	`oauthClient = [[NXOAuth2Client alloc] initWithClientID:clientID`
`97`	`98`	`clientSecret:clientSecret`
`@@ -106,6 +107,10 @@ - (NXOAuth2Client *)oauthClient;`
`106`	`107`	`oauthClient.additionalAuthenticationParameters = additionalQueryParams;`
`107`	`108`	`}`
`108`	`109`
	`110`	`+ if (customHeaderFields) {`
	`111`	`+ oauthClient.customHeaderFields = customHeaderFields;`
	`112`	`+ }`
	`113`	`+`
`109`	`114`	`}`
`110`	`115`	`}`
`111`	`116`	`return oauthClient;`