Merge pull request #816 from geekerzp/develop_2.0_objc_auth

[Objc] Add authentication support (API key, HTTP basic)

Author: fehguy

modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/languages/ObjcClientCodegen.java

@@ -140,6 +140,8 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("SWGFile.m", sourceFolder, "SWGFile.m"));
     supportingFiles.add(new SupportingFile("JSONValueTransformer+ISO8601.m", sourceFolder, "JSONValueTransformer+ISO8601.m"));
     supportingFiles.add(new SupportingFile("JSONValueTransformer+ISO8601.h", sourceFolder, "JSONValueTransformer+ISO8601.h"));
+    supportingFiles.add(new SupportingFile("SWGConfiguration-body.mustache", sourceFolder, "SWGConfiguration.m"));
+    supportingFiles.add(new SupportingFile("SWGConfiguration-header.mustache", sourceFolder, "SWGConfiguration.h"));
     supportingFiles.add(new SupportingFile("Podfile.mustache", "", "Podfile"));
   }
 

modules/swagger-codegen/src/main/resources/objc/SWGApiClient.h

@@ -3,7 +3,7 @@
 
 /**
  * A key for `NSError` user info dictionaries.
- * 
+ *
  * The corresponding value is the parsed response body for an HTTP error.
  */
 extern NSString *const SWGResponseObjectErrorKey;
@@ -20,56 +20,197 @@ extern NSString *const SWGResponseObjectErrorKey;
 @property(nonatomic, assign) BOOL logHTTP;
 @property(nonatomic, readonly) NSOperationQueue* queue;
 
+/**
+ * Get the Api Client instance from pool
+ *
+ * @param baseUrl The base url of api client.
+ *
+ * @return The SWGApiClient instance.
+ */
 +(SWGApiClient *)sharedClientFromPool:(NSString *)baseUrl;
 
+/**
+ * Get the operations queue
+ *
+ * @return The `shardQueue` static variable.
+ */
 +(NSOperationQueue*) sharedQueue;
 
+/**
+ * Turn on logging
+ *
+ * @param state logging state, must be `YES` or `NO`
+ */
 +(void)setLoggingEnabled:(bool) state;
 
+/**
+ * Clear Cache
+ */
 +(void)clearCache;
 
+/**
+ * Turn on cache
+ *
+ * @param enabled If the cached is enable, must be `YES` or `NO`
+ */
 +(void)setCacheEnabled:(BOOL) enabled;
 
+/**
+ * Get the request queue size
+ *
+ * @return The size of `queuedRequests` static variable.
+ */
 +(unsigned long)requestQueueSize;
 
+/**
+ * Set the client unreachable
+ *
+ * @param state off line state, must be `YES` or `NO` 
+ */
 +(void) setOfflineState:(BOOL) state;
 
+/**
+ * Get the client reachability
+ *
+ * @return The client reachability.
+ */
 +(AFNetworkReachabilityStatus) getReachabilityStatus;
 
+/**
+ * Get the next request id
+ *
+ * @return The next executed request id.
+ */
 +(NSNumber*) nextRequestId;
 
+/**
+ * Generate request id and add it to the queue
+ *
+ * @return The next executed request id.
+ */
 +(NSNumber*) queueRequest;
 
+/**
+ * Remove request id from the queue
+ *
+ * @param requestId The request which will be removed.
+ */
 +(void) cancelRequest:(NSNumber*)requestId;
 
+/**
+ * URL encode NSString
+ *
+ * @param unescaped The string which will be escaped.
+ *
+ * @return The escaped string.
+ */
 +(NSString*) escape:(id)unescaped;
 
+/**
+ * Customize the behavior when the reachability changed
+ *
+ * @param changeBlock The block will be executed when the reachability changed.
+ */
 +(void) setReachabilityChangeBlock:(void(^)(int))changeBlock;
 
+/**
+ * Set the client reachability strategy
+ *
+ * @param host The host of SWGApiClient.
+ */
 +(void) configureCacheReachibilityForHost:(NSString*)host;
 
+/**
+ * Detect Accept header from accepts NSArray
+ *
+ * @param accepts NSArray of header
+ *
+ * @return The Accept header
+ */
 +(NSString *) selectHeaderAccept:(NSArray *)accepts;
+
+/**
+ * Detect Content-Type header from contentTypes NSArray
+ *
+ * @param contentTypes NSArray of header
+ *
+ * @return The Content-Type header
+ */
 +(NSString *) selectHeaderContentType:(NSArray *)contentTypes;
 
+/**
+ * Set header for request
+ *
+ * @param value The header value
+ * @param forKey The header key
+ */
 -(void)setHeaderValue:(NSString*) value
-                forKey:(NSString*) forKey;
+               forKey:(NSString*) forKey;
+
+/**
+ * Update header parameters and query parameters for authentication
+ *
+ * @param headers The header parameter will be udpated, passed by pointer to pointer.
+ * @param querys The query parameters will be updated, passed by pointer to pointer.
+ * @param authSettings The authentication names NSArray.
+ */
+- (void) updateHeaderParams:(NSDictionary **)headers
+                queryParams:(NSDictionary **)querys
+           WithAuthSettings:(NSArray *)authSettings;
 
+/**
+ * Perform request
+ *
+ * Request with non-empty response
+ *
+ * @param path Request url.
+ * @param method Request method.
+ * @param queryParams Request query parameters.
+ * @param body Request body.
+ * @param headerParams Request header parameters.
+ * @param authSettings Request authentication names.
+ * @param requestContentType Request content-type.
+ * @param responseContentType Response content-type.
+ * @param completionBlock The block will be executed when the request completed. 
+ *
+ * @return The request id.
+ */
 -(NSNumber*)  dictionary:(NSString*) path
                   method:(NSString*) method
              queryParams:(NSDictionary*) queryParams
                     body:(id) body
             headerParams:(NSDictionary*) headerParams
+            authSettings: (NSArray *) authSettings
       requestContentType:(NSString*) requestContentType
      responseContentType:(NSString*) responseContentType
          completionBlock:(void (^)(NSDictionary*, NSError *))completionBlock;
 
+/**
+ * Perform request
+ *
+ * Request with empty response
+ *
+ * @param path Request url.
+ * @param method Request method.
+ * @param queryParams Request query parameters.
+ * @param body Request body.
+ * @param headerParams Request header parameters.
+ * @param authSettings Request authentication names.
+ * @param requestContentType Request content-type.
+ * @param responseContentType Response content-type.
+ * @param completionBlock The block will be executed when the request completed. 
+ *
+ * @return The request id.
+ */
 -(NSNumber*)  stringWithCompletionBlock:(NSString*) path
                                  method:(NSString*) method
                             queryParams:(NSDictionary*) queryParams
                                    body:(id) body
                            headerParams:(NSDictionary*) headerParams
+                           authSettings: (NSArray *) authSettings
                      requestContentType:(NSString*) requestContentType
                     responseContentType:(NSString*) responseContentType
                         completionBlock:(void (^)(NSString*, NSError *))completionBlock;
 @end
 
+

modules/swagger-codegen/src/main/resources/objc/SWGApiClient.m

@@ -1,6 +1,7 @@
 #import "SWGApiClient.h"
 #import "SWGFile.h"
 #import "SWGQueryParamCollection.h"
+#import "SWGConfiguration.h"
 
 @implementation SWGApiClient
 
@@ -15,10 +16,22 @@ @implementation SWGApiClient
 static void (^reachabilityChangeBlock)(int);
 static bool loggingEnabled = true;
 
+#pragma mark - Log Methods
+
 +(void)setLoggingEnabled:(bool) state {
     loggingEnabled = state;
 }
 
+- (void)logRequest:(NSURLRequest*)request {
+    NSLog(@"request: %@", [self descriptionForRequest:request]);
+}
+
+- (void)logResponse:(id)data forRequest:(NSURLRequest*)request error:(NSError*)error {
+    NSLog(@"request: %@  response: %@ ",  [self descriptionForRequest:request], data );
+}
+
+#pragma mark -
+
 +(void)clearCache {
     [[NSURLCache sharedURLCache] removeAllCachedResponses];
 }
@@ -305,19 +318,47 @@ - (NSString*)descriptionForRequest:(NSURLRequest*)request {
     return [[request URL] absoluteString];
 }
 
-- (void)logRequest:(NSURLRequest*)request {
-    NSLog(@"request: %@", [self descriptionForRequest:request]);
-}
 
-- (void)logResponse:(id)data forRequest:(NSURLRequest*)request error:(NSError*)error {
-    NSLog(@"request: %@  response: %@ ",  [self descriptionForRequest:request], data );
+/**
+ * Update header and query params based on authentication settings
+ */
+- (void) updateHeaderParams:(NSDictionary *__autoreleasing *)headers
+                queryParams:(NSDictionary *__autoreleasing *)querys
+           WithAuthSettings:(NSArray *)authSettings {
+    
+    if (!authSettings || [authSettings count] == 0) {
+        return;
+    }
+    
+    NSMutableDictionary *headersWithAuth = [NSMutableDictionary dictionaryWithDictionary:*headers];
+    NSMutableDictionary *querysWithAuth = [NSMutableDictionary dictionaryWithDictionary:*querys];
+    
+    SWGConfiguration *config = [SWGConfiguration sharedConfig];
+    for (NSString *auth in authSettings) {
+        NSDictionary *authSetting = [[config authSettings] objectForKey:auth];
+        
+        if (authSetting) {
+            if ([authSetting[@"in"] isEqualToString:@"header"]) {
+                [headersWithAuth setObject:authSetting[@"value"] forKey:authSetting[@"key"]];
+            }
+            else if ([authSetting[@"in"] isEqualToString:@"query"]) {
+                [querysWithAuth setObject:authSetting[@"value"] forKey:authSetting[@"key"]];
+            }
+        }
+    }
+    
+    *headers = [NSDictionary dictionaryWithDictionary:headersWithAuth];
+    *querys = [NSDictionary dictionaryWithDictionary:querysWithAuth];
 }
 
+#pragma mark - Perform Request Methods
+
 -(NSNumber*)  dictionary: (NSString*) path
                   method: (NSString*) method
              queryParams: (NSDictionary*) queryParams
                     body: (id) body
             headerParams: (NSDictionary*) headerParams
+            authSettings: (NSArray *) authSettings
       requestContentType: (NSString*) requestContentType
      responseContentType: (NSString*) responseContentType
          completionBlock: (void (^)(NSDictionary*, NSError *))completionBlock {
@@ -342,6 +383,9 @@ -(NSNumber*)  dictionary: (NSString*) path
     else {
         self.responseSerializer = [AFHTTPResponseSerializer serializer];
     }
+    
+    // auth setting
+    [self updateHeaderParams:&headerParams queryParams:&queryParams WithAuthSettings:authSettings];
 
     NSMutableURLRequest * request = nil;
     if (body != nil && [body isKindOfClass:[NSArray class]]){
@@ -476,6 +520,7 @@ -(NSNumber*)  stringWithCompletionBlock: (NSString*) path
                             queryParams: (NSDictionary*) queryParams
                                    body: (id) body
                            headerParams: (NSDictionary*) headerParams
+                           authSettings: (NSArray *) authSettings
                      requestContentType: (NSString*) requestContentType
                     responseContentType: (NSString*) responseContentType
                         completionBlock: (void (^)(NSString*, NSError *))completionBlock {
@@ -500,6 +545,9 @@ -(NSNumber*)  stringWithCompletionBlock: (NSString*) path
     else {
         self.responseSerializer = [AFHTTPResponseSerializer serializer];
     }
+    
+    // auth setting
+    [self updateHeaderParams:&headerParams queryParams:&queryParams WithAuthSettings:authSettings];
 
     NSMutableURLRequest * request = nil;
     if (body != nil && [body isKindOfClass:[NSArray class]]){