Process authorization response and token fetch.

GoogleSignIn/Sources/GIDAuthFlow.h

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "GoogleSignIn/Sources/GIDCallbackQueue.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class OIDAuthState;
+@class GIDProfileData;
+
+/// The callback queue used for authentication flow.
+@interface GIDAuthFlow : GIDCallbackQueue
+
+/// A representation of the state of the OAuth session for this instance.
+@property(nonatomic, strong, nullable) OIDAuthState *authState;
+
+/// The error thrown from the OAuth session encountered for this instance.
+@property(nonatomic, strong, nullable) NSError *error;
+
+/// The EMM support version.
+@property(nonatomic, copy, nullable) NSString *emmSupport;
+
+/// The profile data extracted from the ID token.
+@property(nonatomic, nullable) GIDProfileData *profileData;
+
+/// Initialize a `GIDAuthFlow` object by specifying all available properties.
+///
+/// @param authState The configuration to be used.
+/// @param error The configuration to be used.
+/// @param emmSupport The configuration to be used.
+/// @param profileData The configuration to be used.
+/// @return An initialized `GIDAuthFlow` instance.
+- (instancetype)initWithAuthState:(nullable OIDAuthState *)authState
+                            error:(nullable NSError *)error
+                       emmSupport:(nullable NSString *)emmSupport
+                      profileData:(nullable GIDProfileData *)profileData
+    NS_DESIGNATED_INITIALIZER;
+
+/// Initialize a `GIDAuthFlow` object by calling the designated initializer with `nil` values.
+///
+/// @return An initialized `GIDAuthFlow` instance.
+- (instancetype)init;
+
+@end
+
+NS_ASSUME_NONNULL_END

GoogleSignIn/Sources/GIDAuthFlow.m

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#import "GoogleSignIn/Sources/GIDAuthFlow.h"
+
+@implementation GIDAuthFlow
+
+- (instancetype)initWithAuthState:(nullable OIDAuthState *)authState
+                            error:(nullable NSError *)error
+                       emmSupport:(nullable NSString *)emmSupport
+                      profileData:(nullable GIDProfileData *)profileData {
+  self = [super init];
+  if (self) {
+    _authState = authState;
+    _error = error;
+    _emmSupport = emmSupport;
+    _profileData = profileData;
+  }
+  return self;
+}
+
+- (instancetype)init {
+  return [self initWithAuthState:nil
+                           error:nil
+                      emmSupport:nil
+                     profileData:nil];
+}
+
+@end

GoogleSignIn/Sources/GIDAuthorizationResponse/API/GIDAuthorizationResponseHandling.h

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+@class GIDAuthFlow;
+@class GIDConfiguration;
+@class OIDAuthorizationResponse;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// A list of potential current flow names.
+typedef NS_ENUM(NSInteger, GIDFlowName) {
+  /// The Sign In flow.
+  GIDFlowNameSignIn = 0,
+  /// The Verify flow.
+  GIDFlowNameVerifyAccountDetail = 1,
+};
+
+@protocol GIDAuthorizationResponseHandling
+
+/// Initializes a new instance of the `GIDAuthorizationResponseHandling` class with the provided fields.
+///
+/// @param authorizationResponse The authorization response to be processed.
+/// @param emmSupport The EMM support version.
+/// @param flowName The name of the current flow.
+/// @param configuration The configuration.
+/// @param error The error thrown if there's no authorization response.
+/// @return A new initialized instance of the `GIDAuthorizationResponseHandling` class.
+- (instancetype)
+    initWithAuthorizationResponse:(nullable OIDAuthorizationResponse *)authorizationResponse
+                       emmSupport:(nullable NSString *)emmSupport
+                         flowName:(enum GIDFlowName)flowName
+                    configuration:(nullable GIDConfiguration *)configuration
+                            error:(nullable NSError *)error;
+
+/// Fetches the access token if necessary as part of the auth flow.
+///
+/// @param authFlow The auth flow to either fetch tokens or error.
+- (void)maybeFetchToken:(GIDAuthFlow *)authFlow;
+
+/// Processes the authorization response and returns an auth flow.
+///
+/// @return An instance of `GIDAuthFlow`.
+- (GIDAuthFlow *)generateAuthFlowFromAuthorizationResponse;
+
+@end
+
+NS_ASSUME_NONNULL_END

GoogleSignIn/Sources/GIDAuthorizationResponse/Fake/GIDAuthorizationResponseHandlingFake.h

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "GoogleSignIn/Sources/GIDAuthorizationResponse/API/GIDAuthorizationResponseHandling.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class OIDAuthState;
+
+/// A fake implementation of `GIDAuthorizationResponseHandling` for testing purposes.
+@interface GIDAuthorizationResponseHandlingFake : NSObject <GIDAuthorizationResponseHandling>
+
+/// The auth state to be used to fetch tokens.
+@property (nonatomic, nullable) OIDAuthState *authState;
+
+/// The error to be passed into the completion.
+@property (nonatomic, nullable) NSError *error;
+
+/// Creates an instance conforming to `GIDAuthorizationResponseHandling` with the provided
+/// auth state and error.
+///
+/// @param authState The `OIDAuthState` instance to access tokens.
+/// @param error The `NSError` to pass into the completion.
+- (instancetype)initWithAuthState:(nullable OIDAuthState *)authState
+                            error:(nullable NSError *)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

GoogleSignIn/Sources/GIDAuthorizationResponse/Fake/GIDAuthorizationResponseHandlingFake.m

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "GoogleSignIn/Sources/GIDAuthorizationResponse/Fake/GIDAuthorizationResponseHandlingFake.h"
+
+#import "GoogleSignIn/Sources/GIDAuthorizationResponse/API/GIDAuthorizationResponseHandling.h"
+
+#import "GoogleSignIn/Sources/GIDAuthFlow.h"
+#import "GoogleSignIn/Sources/GIDSignInConstants.h"
+
+#ifdef SWIFT_PACKAGE
+@import AppAuth;
+#else
+#import <AppAuth/OIDAuthState.h>
+#import <AppAuth/OIDTokenResponse.h>
+#endif
+
+@implementation GIDAuthorizationResponseHandlingFake
+
+- (instancetype)initWithAuthorizationResponse:(OIDAuthorizationResponse *)authorizationResponse 
+                                   emmSupport:(NSString *)emmSupport
+                                     flowName:(enum GIDFlowName)flowName
+                                configuration:(GIDConfiguration *)configuration
+                                        error:(NSError *)error {
+  self = [super init];
+  if (self) {
+    NSAssert(false, @"This class is only to be used in testing. Do not use.");
+  }
+  return self;
+}
+
+- (instancetype)initWithAuthState:(nullable OIDAuthState *)authState
+                            error:(nullable NSError *)error {
+  self = [super init];
+  if (self) {
+    _authState = authState;
+    _error = error;
+  }
+  return self;
+}
+
+- (GIDAuthFlow *)generateAuthFlowFromAuthorizationResponse {
+  GIDAuthFlow *authFlow = [[GIDAuthFlow alloc] initWithAuthState:self.authState
+                                                           error:self.error
+                                                      emmSupport:nil
+                                                     profileData:nil];
+  return authFlow;
+}
+
+- (void)maybeFetchToken:(GIDAuthFlow *)authFlow {
+  if (authFlow.error ||
+      (_authState.lastTokenResponse.accessToken &&
+       [_authState.lastTokenResponse.accessTokenExpirationDate timeIntervalSinceNow] >
+       kMinimumRestoredAccessTokenTimeToExpire)) {
+    return;
+  }
+
+  authFlow.authState = self.authState;
+  authFlow.error = self.error;
+}
+
+@end
+

GoogleSignIn/Sources/GIDAuthorizationResponse/GIDAuthorizationResponseHelper.h

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "GoogleSignIn/Sources/GIDAuthorizationResponse/API/GIDAuthorizationResponseHandling.h"
+
+@class GIDAuthFlow;
+@class GIDConfiguration;
+@class OIDAuthorizationResponse;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// A helper class to process the authorization response.
+@interface GIDAuthorizationResponseHelper : NSObject
+
+/// The response handler used to process the authorization response.
+@property (nonatomic, readonly) id<GIDAuthorizationResponseHandling> responseHandler;
+
+/// Initializes a new instance of the `GIDAuthorizationResponseHelper` class with the provided field.
+///
+/// @param responseHandler The response handler with the authorization response to process.
+/// @return A new initialized instance of the `GIDAuthorizationResponseHelper` class.
+- (instancetype)
+initWithAuthorizationResponseHandler:(id<GIDAuthorizationResponseHandling>)responseHandler;
+
+/// Fetches the access token if necessary using the response handler as part of the auth flow.
+///
+/// @param authFlow The auth flow to either fetch tokens or error.
+- (void)fetchTokenWithAuthFlow:(GIDAuthFlow *)authFlow;
+
+
+/// Processes the initialized authorization response and returns a filled `GIDAuthFlow` instance.
+///
+/// @return An instance of `GIDAuthFlow`  to either fetch tokens or error.
+- (GIDAuthFlow *)fetchAuthFlowFromProcessedResponse;
+
+@end
+
+NS_ASSUME_NONNULL_END