Merge pull request #25 from microsoftgraph/vidadhee/AuthProviderOptions

Add authentication provider options protocol and auth handler options

Author: dadheech115

MSGraphClientSDK/MSGraphClientSDK.xcodeproj/project.pbxproj

@@ -43,6 +43,10 @@
 		E54D1237226472FB00EB517A /* MSLargeFileUploadTaskTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E54D1236226472FB00EB517A /* MSLargeFileUploadTaskTests.m */; };
 		E54D123B2264858100EB517A /* LargeFileUploadResource.bmp in Resources */ = {isa = PBXBuildFile; fileRef = E54D123A2264858100EB517A /* LargeFileUploadResource.bmp */; };
 		E54D123D2264AEBD00EB517A /* MSGraphOneDriveLargeFileUploadTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E54D123C2264AEBD00EB517A /* MSGraphOneDriveLargeFileUploadTests.m */; };
+		E54D12772270A39200EB517A /* MSAuthenticationHandlerOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = E54D12752270A39200EB517A /* MSAuthenticationHandlerOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		E54D12782270A39200EB517A /* MSAuthenticationHandlerOptions.m in Sources */ = {isa = PBXBuildFile; fileRef = E54D12762270A39200EB517A /* MSAuthenticationHandlerOptions.m */; };
+		E54D12892271C91D00EB517A /* MSAuthenticationProviderOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = E54D123E226EF79C00EB517A /* MSAuthenticationProviderOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		E54D128F22733FCD00EB517A /* MSAuthenticationHandlerOptionsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E54D128E22733FCD00EB517A /* MSAuthenticationHandlerOptionsTests.m */; };
 		E566782E2150BC4F00C6B7AE /* MSRedirectHandlerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E566782D2150BC4F00C6B7AE /* MSRedirectHandlerTests.m */; };
 		E56678302150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E566782F2150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m */; };
 		E56B101C2220086300ED640F /* MSRedirectHandlerOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = E56B101A2220086300ED640F /* MSRedirectHandlerOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -135,6 +139,10 @@
 		E54D1236226472FB00EB517A /* MSLargeFileUploadTaskTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSLargeFileUploadTaskTests.m; sourceTree = "<group>"; };
 		E54D123A2264858100EB517A /* LargeFileUploadResource.bmp */ = {isa = PBXFileReference; lastKnownFileType = image.bmp; path = LargeFileUploadResource.bmp; sourceTree = "<group>"; };
 		E54D123C2264AEBD00EB517A /* MSGraphOneDriveLargeFileUploadTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSGraphOneDriveLargeFileUploadTests.m; sourceTree = "<group>"; };
+		E54D123E226EF79C00EB517A /* MSAuthenticationProviderOptions.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSAuthenticationProviderOptions.h; sourceTree = "<group>"; };
+		E54D12752270A39200EB517A /* MSAuthenticationHandlerOptions.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSAuthenticationHandlerOptions.h; sourceTree = "<group>"; };
+		E54D12762270A39200EB517A /* MSAuthenticationHandlerOptions.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSAuthenticationHandlerOptions.m; sourceTree = "<group>"; };
+		E54D128E22733FCD00EB517A /* MSAuthenticationHandlerOptionsTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MSAuthenticationHandlerOptionsTests.m; sourceTree = "<group>"; };
 		E566782D2150BC4F00C6B7AE /* MSRedirectHandlerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSRedirectHandlerTests.m; sourceTree = "<group>"; };
 		E566782F2150E1AF00C6B7AE /* MSAuthenticationHandlerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSAuthenticationHandlerTests.m; sourceTree = "<group>"; };
 		E56B101A2220086300ED640F /* MSRedirectHandlerOptions.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSRedirectHandlerOptions.h; sourceTree = "<group>"; };
@@ -215,6 +223,7 @@
 			isa = PBXGroup;
 			children = (
 				E5DC73F6211418040040BAB6 /* MSAuthenticationProvider.h */,
+				E54D123E226EF79C00EB517A /* MSAuthenticationProviderOptions.h */,
 			);
 			path = Authentication;
 			sourceTree = "<group>";
@@ -363,6 +372,7 @@
 		E56B101E22237F3900ED640F /* Options */ = {
 			isa = PBXGroup;
 			children = (
+				E54D128E22733FCD00EB517A /* MSAuthenticationHandlerOptionsTests.m */,
 				E56B101F22237F6500ED640F /* MSRetryHandlerOptionsTests.m */,
 				E56B1021222382E400ED640F /* MSRedirectHandlerOptionsTests.m */,
 			);
@@ -425,6 +435,8 @@
 				E59EBFED221D3B6700B4B279 /* MSRetryHandlerOptions.m */,
 				E56B101A2220086300ED640F /* MSRedirectHandlerOptions.h */,
 				E56B101B2220086300ED640F /* MSRedirectHandlerOptions.m */,
+				E54D12752270A39200EB517A /* MSAuthenticationHandlerOptions.h */,
+				E54D12762270A39200EB517A /* MSAuthenticationHandlerOptions.m */,
 			);
 			path = Options;
 			sourceTree = "<group>";
@@ -557,6 +569,7 @@
 			files = (
 				E5DC7407211418050040BAB6 /* MSURLSessionManager.h in Headers */,
 				E5DC741C21142C430040BAB6 /* MSClientFactory.h in Headers */,
+				E54D12892271C91D00EB517A /* MSAuthenticationProviderOptions.h in Headers */,
 				E5DC740E211418050040BAB6 /* MSHttpProvider.h in Headers */,
 				E5DC740C211418050040BAB6 /* MSAuthenticationProvider.h in Headers */,
 				E5DC7410211418050040BAB6 /* MSGraphMiddleware.h in Headers */,
@@ -580,6 +593,7 @@
 				E56B101C2220086300ED640F /* MSRedirectHandlerOptions.h in Headers */,
 				E54D123222646CA900EB517A /* MSGraphOneDriveLargeFileUploadTask.h in Headers */,
 				E54D123322646CA900EB517A /* MSLargeFileUploadTask.h in Headers */,
+				E54D12772270A39200EB517A /* MSAuthenticationHandlerOptions.h in Headers */,
 				E54D1220225B59B300EB517A /* MSPageIterator.h in Headers */,
 				E5DC73DF211412BF0040BAB6 /* MSGraphClientSDK.h in Headers */,
 			);
@@ -692,6 +706,7 @@
 				E5204FFF2173A7C200E64160 /* MSBatchRequestStepTests.m in Sources */,
 				E52050042174C1DB00E64160 /* MSBatchResponseContentTests.m in Sources */,
 				E51E616F216E073F00F1B3C0 /* MSRetryHandlerTests.m in Sources */,
+				E54D128F22733FCD00EB517A /* MSAuthenticationHandlerOptionsTests.m in Sources */,
 				E54D123D2264AEBD00EB517A /* MSGraphOneDriveLargeFileUploadTests.m in Sources */,
 				E56B1022222382E400ED640F /* MSRedirectHandlerOptionsTests.m in Sources */,
 				E573EE072133FFF200C5E884 /* MSHTTPClientTests.m in Sources */,
@@ -724,6 +739,7 @@
 				E56B101D2220086300ED640F /* MSRedirectHandlerOptions.m in Sources */,
 				E5DC741A21142C430040BAB6 /* MSClientFactory.m in Sources */,
 				E5069AC9211AAEC900432372 /* MSConstants.m in Sources */,
+				E54D12782270A39200EB517A /* MSAuthenticationHandlerOptions.m in Sources */,
 				E56FDB9821D36A98001DFE68 /* MSURLSessionDownloadTask.m in Sources */,
 				E56FDB9921D36A98001DFE68 /* MSURLSessionUploadTask.m in Sources */,
 				E5ECE0A52146657900A289C2 /* MSRedirectHandler.m in Sources */,

MSGraphClientSDK/MSGraphClientSDK/Authentication/MSAuthenticationProvider.h

@@ -3,6 +3,7 @@
 //
 
 #import <Foundation/Foundation.h>
+#import "MSAuthenticationProviderOptions.h"
 
 typedef void(^MSAuthenticationCompletion)(NSMutableURLRequest *request, NSError *error);
 
@@ -14,9 +15,10 @@ typedef void(^MSAuthenticationCompletion)(NSMutableURLRequest *request, NSError
 
 /**
  Gets the access token. This method should be implemented by a class which should provide the capability of providing the access token.
+ @param authProviderOptions Options which can be used to control the behaviour of AuthenticationProvider
  @param completion The completion handler to be called when access token or an error can be returned.
  */
 
-- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion;
+- (void) getAccessTokenForProviderOptions:(id<MSAuthenticationProviderOptions>)authProviderOptions andCompletion:(void (^)(NSString *accessToken, NSError *error))completion;
 
 @end

MSGraphClientSDK/MSGraphClientSDK/Authentication/MSAuthenticationProviderOptions.h

@@ -0,0 +1,18 @@
+//
+// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
+//
+
+#import <Foundation/Foundation.h>
+
+/**
+ The `MSAuthenticationProviderOptions` is a protocol that is used to define the contract for the options required by AuthenticationProvider */
+@protocol MSAuthenticationProviderOptions <NSObject>
+
+@required
+
+/*
+ This property is added to ensure that every option class sets the type of it so that during execution middlewares can pick up the option which is requried by it's implementation.
+ */
+@property NSArray<NSString *> *scopesArray;
+
+@end

MSGraphClientSDK/MSGraphClientSDK/HTTPClient/MSClientFactory.m

@@ -19,7 +19,7 @@ +(MSHTTPClient *)createHTTPClientWithAuthenticationProvider:(id<MSAuthentication
 
     //Initializing different default middlewares
     MSAuthenticationHandler *authenticationHandler = (MSAuthenticationHandler *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeAuthentication];
-    authenticationHandler.authProvider = authenticationProvider;
+    authenticationHandler.authenticationProvider = authenticationProvider;
     MSRedirectHandler *redirectHandler = (MSRedirectHandler *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeRedirect];
     MSRetryHandler *retryHandler = (MSRetryHandler *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeRetry];
     MSURLSessionManager *sessionManager = (MSURLSessionManager *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeHTTP];
@@ -40,10 +40,10 @@ +(MSHTTPClient *)createHTTPClientWithAuthenticationProvider:(id<MSAuthentication
 
     //Initializing different default middlewares
     MSAuthenticationHandler *authenticationHandler = (MSAuthenticationHandler *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeAuthentication];
-    authenticationHandler.authProvider = authenticationProvider;
+    authenticationHandler.authenticationProvider = authenticationProvider;
     MSRedirectHandler *redirectHandler = (MSRedirectHandler *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeRedirect];
     MSRetryHandler *retryHandler = (MSRetryHandler *)[MSMiddlewareFactory createMiddleware:MSMiddlewareTypeRetry];
-
+    
     //Create session manager with custom session configuration
     MSURLSessionManager *sessionManager = [[MSURLSessionManager alloc] initWithSessionConfiguration:sessionConfiguration];
 

MSGraphClientSDK/MSGraphClientSDK/MSGraphClientSDK.h

@@ -18,6 +18,7 @@ FOUNDATION_EXPORT const unsigned char MSGraphClientSDKVersionString[];
 #define MSSDK_h
 
 #import "MSGraphClientSDK/MSAuthenticationProvider.h"
+#import "MSGraphClientSDK/MSAuthenticationProviderOptions.h"
 #import "MSGraphClientSDK/MSHttpProvider.h"
 #import "MSGraphClientSDK/MSGraphMiddleware.h"
 #import "MSGraphClientSDK/MSMiddlewareOptions.h"
@@ -43,6 +44,7 @@ FOUNDATION_EXPORT const unsigned char MSGraphClientSDKVersionString[];
 
 #import "MSGraphClientSDK/MSRetryHandlerOptions.h"
 #import "MSGraphClientSDK/MSRedirectHandlerOptions.h"
+#import "MSGraphClientSDK/MSAuthenticationHandlerOptions.h"
 
 #import "MSGraphClientSDK/MSPageIterator.h"
 #import "MSGraphClientSDK/MSLargeFileUploadTask.h"

MSGraphClientSDK/MSGraphClientSDK/Middleware/Implementations/Authentication/MSAuthenticationHandler.h

@@ -6,8 +6,20 @@
 #import "MSAuthenticationProvider.h"
 #import "MSGraphMiddleware.h"
 
+/*
+ This class provides the mechanism to communicate with authentication provider. It is implmented as a middleware so it will be called during the execution of network calls.
+ */
+
 @interface MSAuthenticationHandler : NSObject<MSGraphMiddleware>
 
-@property (nonatomic, strong) id<MSAuthenticationProvider> authProvider;
+//Authentication provider which will be used to get access token
+@property (nonatomic, strong) id<MSAuthenticationProvider> authenticationProvider;
+
+/*
+ This method creates and returns an instance of MSAuthenticationHandler
+ @param authProvider Authentication Provider instance
+ @return An instance of MSAuthenticationHandler
+ */
+- (instancetype)initWithAuthenticationProvider:(id<MSAuthenticationProvider>)authProvider;
 
 @end

MSGraphClientSDK/MSGraphClientSDK/Middleware/Implementations/Authentication/MSAuthenticationHandler.m

@@ -4,6 +4,7 @@
 
 #import "MSAuthenticationHandler.h"
 #import "MSURLSessionTask.h"
+#import "MSAuthenticationHandlerOptions.h"
 
 @interface MSURLSessionTask()
 
@@ -20,9 +21,28 @@ @interface MSAuthenticationHandler()
 
 @implementation MSAuthenticationHandler
 
+- (instancetype)initWithAuthenticationProvider:(id<MSAuthenticationProvider>)authProvider
+{
+    self = [super init];
+    if(self)
+    {
+        _authenticationProvider = authProvider;
+    }
+    return self;
+}
+
+- (void)setAuthenticationProvider:(id<MSAuthenticationProvider>)authProvider
+{
+    _authenticationProvider = authProvider;
+}
+
 - (void)execute:(MSURLSessionTask *)task withCompletionHandler:(HTTPRequestCompletionHandler)completionHandler
 {
-    [self.authProvider getAccessTokenWithCompletion:^(NSString *accessToken, NSError *error) {
+    MSAuthenticationHandlerOptions *authHandlerOptions = [task getMiddlewareOptionWithType:MSMiddlewareOptionsTypeAuth];
+
+    id<MSAuthenticationProvider> authProvider = authHandlerOptions.authenticationProvider?authHandlerOptions.authenticationProvider:_authenticationProvider;
+
+    [authProvider getAccessTokenForProviderOptions:authHandlerOptions.authenticationProviderOptions andCompletion:^(NSString *accessToken, NSError *error) {
         if(!error)
         {
             NSMutableURLRequest *urlRequest = [task request];

MSGraphClientSDK/MSGraphClientSDK/Middleware/Options/MSAuthenticationHandlerOptions.h

@@ -0,0 +1,30 @@
+//
+// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
+//
+
+#import <Foundation/Foundation.h>
+#import "MSMiddlewareOptions.h"
+#import "MSAuthenticationProvider.h"
+#import "MSAuthenticationProviderOptions.h"
+/*
+ This class provides options to control the behaviour of Authentication Handler.
+ */
+
+@interface MSAuthenticationHandlerOptions : NSObject <MSMiddlewareOptions>
+
+/*
+  Authentication Provider instance which will be used to authenticate the ongoing requests.
+ */
+@property (nonatomic, strong, readonly) id<MSAuthenticationProvider> authenticationProvider;
+
+@property (nonatomic, strong, readonly) id<MSAuthenticationProviderOptions> authenticationProviderOptions;
+
+/*
+ This method initializes an instance of MSAuthenticationHandlerOptions with the provided parameter.
+ @param authProvider The authentication provider instance which will be used to authenticate the ongoing requests.
+ @param authProviderOptions The authentication provider options which will be used to control the behaviour of authentication provider being used to authenticate the ongoing requests.
+ @return The MSAuthenticationHandlerOptions instance with the provided value.
+ */
+- (instancetype)initWithAuthenticationProvider:(id<MSAuthenticationProvider>)authProvider andAuthProviderOptions:(id<MSAuthenticationProviderOptions>)authProviderOptions;
+
+@end

MSGraphClientSDK/MSGraphClientSDK/Middleware/Options/MSAuthenticationHandlerOptions.m

@@ -0,0 +1,25 @@
+//
+// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
+//
+
+
+#import "MSAuthenticationHandlerOptions.h"
+
+@implementation MSAuthenticationHandlerOptions
+
+@synthesize middlewareOptionsType;
+
+- (instancetype)initWithAuthenticationProvider:(id<MSAuthenticationProvider>)authProvider andAuthProviderOptions:(id<MSAuthenticationProviderOptions>)authProviderOptions
+{
+    self = [super init];
+    if(self)
+    {
+        _authenticationProvider = authProvider;
+        _authenticationProviderOptions = authProviderOptions;
+        middlewareOptionsType = MSMiddlewareOptionsTypeAuth;
+    }
+    return self;
+}
+
+
+@end

MSGraphClientSDK/MSGraphClientSDKTests/MSGraphWorkloadsTests.m

@@ -30,19 +30,19 @@ @implementation MSGraphWorkloadsTests
 
 - (void)setUp {
     [super setUp];
-    OCMStub([self.mockAuthProvider getAccessTokenWithCompletion:[OCMArg any]])
+    OCMStub([self.mockAuthProvider getAccessTokenForProviderOptions:[OCMArg any] andCompletion:[OCMArg any]])
     .andDo(^(NSInvocation *invocation){
         void (^completionHandler)(NSString *accessToken, NSError *error);
-        [invocation getArgument:&completionHandler atIndex:2];
+        [invocation getArgument:&completionHandler atIndex:3];
         completionHandler(@"abcdefg",nil);
     });
      _OKresponse = [[NSHTTPURLResponse alloc] initWithURL:[NSURL URLWithString:MSGraphBaseURL] statusCode:MSExpectedResponseCodesOK HTTPVersion:@"foo" headerFields:nil];
 
     MSURLSessionManager *sessionManager = [[MSURLSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];
     MSRedirectHandler *redirectHandler = [[MSRedirectHandler alloc] init];
     MSRetryHandler *retryHandler = [[MSRetryHandler alloc] init];
-    MSAuthenticationHandler *authHandler = [[MSAuthenticationHandler alloc] init];
-    authHandler.authProvider = self.mockAuthProvider;
+
+    MSAuthenticationHandler *authHandler = [[MSAuthenticationHandler alloc] initWithAuthenticationProvider:self.mockAuthProvider];
     [authHandler setNext:redirectHandler];
     [redirectHandler setNext:retryHandler];
     [retryHandler setNext:sessionManager];