Merge branch 'main' of github.com:DutchCodingCompany/oauth_chopper into feature/update-dependencies

# Conflicts:
#	CHANGELOG.md
#	example/oauth_chopper_example.dart
#	pubspec.yaml
#	test/oauth_authenticator_test.dart
#	test/oauth_interceptor_test.dart

Author: Guldem

CHANGELOG.md

@@ -4,6 +4,22 @@
 - Added basic github action checks.
 - Removed mockito in favor of mocktail.
 
+## 0.1.2
+
+- Add ID token to OAuth token
+
+## 0.1.1
+
+- Export OauthToken class
+
+## 0.1.0
+
+- Add support for AuthorizationCodeGrant
+
+## 0.0.5
+
+- Update Chopper
+
 ## 0.0.4
 
 - Removed import for HttpStatus because platform support

README.md

@@ -28,7 +28,7 @@ This can be override by providing a custom storage implementation.
 
 - ✅ ResourceOwnerPasswordGrant
 - ✅ ClientCredentialsGrant
-- ❌ AuthorizationCodeGrant (*TODO*)
+- ✅ AuthorizationCodeGrant
 
 ## Usage
 
@@ -62,6 +62,15 @@ Example:
       password: 'password',
     ),
   );
+
+// Authorization Cod eGrant
+  oauth_chopper.AuthorizationCodeGrant grant = oauth_chopper.AuthorizationCodeGrant(
+    tokenEndpoint: Uri.parse("tokenEndpoint"),
+    scopes: ["scope1", "scope2"],
+    redirectUrl: Uri.parse("redirectUrl"),
+    redirect: redirect,
+    listen: listen,
+  );
 ```   
 
 If you want to persist the OAuth2 credential information you can provide a custom OAuthStorage

lib/oauth_chopper.dart

@@ -8,4 +8,5 @@ export 'package:oauth2/src/expiration_exception.dart';
 
 export 'src/oauth_chopper.dart';
 export 'src/oauth_grant.dart';
+export 'src/oauth_token.dart';
 export 'src/storage/oauth_storage.dart';

lib/src/oauth_chopper.dart

@@ -22,6 +22,9 @@ class OAuthChopper {
   /// OAuth authorization endpoint.
   final Uri authorizationEndpoint;
 
+  /// OAuth endpoint to end session.
+  final Uri? endSessionEndpoint;
+
   /// OAuth identifier
   final String identifier;
 
@@ -37,6 +40,7 @@ class OAuthChopper {
     required this.authorizationEndpoint,
     required this.identifier,
     required this.secret,
+    this.endSessionEndpoint,
 
     /// OAuth storage for storing credentials.
     /// By default it will use a in memory storage [MemoryStorage]. For persisting the credentials implement a custom [OAuthStorage].
@@ -47,9 +51,7 @@ class OAuthChopper {
   /// Get stored [OAuthToken].
   Future<OAuthToken?> get token async {
     final credentialsJson = await _storage.fetchCredentials();
-    return credentialsJson != null
-        ? OAuthToken.fromJson(credentialsJson)
-        : null;
+    return credentialsJson != null ? OAuthToken.fromJson(credentialsJson) : null;
   }
 
   /// Provides an [OAuthAuthenticator] instance.
@@ -70,8 +72,7 @@ class OAuthChopper {
     if (credentialsJson == null) return null;
     final credentials = Credentials.fromJson(credentialsJson);
     try {
-      final newCredentials =
-          await credentials.refresh(identifier: identifier, secret: secret);
+      final newCredentials = await credentials.refresh(identifier: identifier, secret: secret);
       await _storage.saveCredentials(newCredentials.toJson());
       return OAuthToken.fromCredentials(newCredentials);
     } catch (e) {
@@ -87,8 +88,7 @@ class OAuthChopper {
   ///
   /// Throws an exception if the grant fails.
   Future<OAuthToken> requestGrant(OAuthGrant grant) async {
-    final credentials =
-        await grant.handle(authorizationEndpoint, identifier, secret);
+    final credentials = await grant.handle(authorizationEndpoint, identifier, secret);
 
     await _storage.saveCredentials(credentials);
 

lib/src/oauth_grant.dart

@@ -45,4 +45,37 @@ class ClientCredentialsGrant extends OAuthGrant {
   }
 }
 
-//TODO: Add AuthorizationCodeGrant
+/// Obtains credentials using a [authorization code grant](https://tools.ietf.org/html/rfc6749#section-1.3.1).
+class AuthorizationCodeGrant extends OAuthGrant {
+  const AuthorizationCodeGrant({
+    required this.tokenEndpoint,
+    required this.scopes,
+    required this.redirectUrl,
+    required this.redirect,
+    required this.listen,
+  });
+
+  final Uri tokenEndpoint;
+  final Uri redirectUrl;
+  final List<String> scopes;
+  final Future<void> Function(Uri authorizationUri) redirect;
+  final Future<Uri> Function(Uri redirectUri) listen;
+
+  @override
+  Future<String> handle(
+      Uri authorizationEndpoint, String identifier, String secret) async {
+    final grant = oauth.AuthorizationCodeGrant(
+      identifier,
+      authorizationEndpoint,
+      tokenEndpoint,
+    );
+    var authorizationUrl =
+        grant.getAuthorizationUrl(redirectUrl, scopes: scopes);
+    await redirect(authorizationUrl);
+    var responseUrl = await listen(redirectUrl);
+    oauth.Client client =
+        await grant.handleAuthorizationResponse(responseUrl.queryParameters);
+
+    return client.credentials.toJson();
+  }
+}

lib/src/oauth_token.dart

@@ -4,14 +4,15 @@ class OAuthToken {
   final String accessToken;
   final String? refreshToken;
   final DateTime? expiration;
+  final String? idToken;
 
-  bool get isExpired =>
-      expiration != null && DateTime.now().isAfter(expiration!);
+  bool get isExpired => expiration != null && DateTime.now().isAfter(expiration!);
 
   const OAuthToken._(
     this.accessToken,
     this.refreshToken,
     this.expiration,
+    this.idToken,
   );
 
   factory OAuthToken.fromJson(String json) {
@@ -23,5 +24,6 @@ class OAuthToken {
         credentials.accessToken,
         credentials.refreshToken,
         credentials.expiration,
+        credentials.idToken,
       );
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: oauth_chopper
 description: Add and manage OAuth2 authentication for your Chopper client.
-version: 0.1.0
+version: 0.1.2
 homepage: https://github.com/DutchCodingCompany/oauth_chopper
 
 environment:

test/oauth_chopper_test.dart

@@ -17,7 +17,7 @@ void main() {
    {
  	"accessToken": "accesToken",
  	"refreshToken": "refreshToken",
- 	"idToken": null,
+ 	"idToken": "idToken",
  	"tokenEndpoint": "https://test.test/oauth/token",
  	"scopes": [],
  	"expiration": 1664359530234
@@ -60,6 +60,7 @@ void main() {
     // assert
     expect(token?.accessToken, 'accesToken');
     expect(token?.refreshToken, 'refreshToken');
+    expect(token?.idToken, 'idToken');
   });
 
   test('Returns no token if not in storage', () async {
@@ -89,6 +90,7 @@ void main() {
     verify(() => grantMock.handle(any(), 'identifier', 'secret')).called(1);
     verify(() => storageMock.saveCredentials(testJson)).called(1);
     expect(token.accessToken, 'accesToken');
+    expect(token?.idToken, 'idToken');
     expect(token.refreshToken, 'refreshToken');
   });
 }

test/oauth_interceptor_test.dart

@@ -3,7 +3,6 @@ import 'package:mocktail/mocktail.dart';
 import 'package:oauth2/oauth2.dart';
 import 'package:oauth_chopper/oauth_chopper.dart';
 import 'package:oauth_chopper/src/oauth_interceptor.dart';
-import 'package:oauth_chopper/src/oauth_token.dart';
 import 'package:test/test.dart';
 
 class MockOAuthChopper extends Mock implements OAuthChopper {}
@@ -18,7 +17,16 @@ void main() {
     ),
   );
 
-  final testRequest = Request('GET', Uri.parse('test'), Uri.parse('test'));
+  final testIDtoken = OAuthToken.fromCredentials(
+    Credentials(
+      'token',
+      refreshToken: 'refresh',
+      idToken: 'idToken',
+      expiration: DateTime(2022, 9, 1),
+    ),
+  );
+
+  final testRequest = Request('GET', Uri(host: 'test'), Uri(host: 'test'));
 
   test('HeaderInterceptor adds available token to headers', () async {
     // arrange
@@ -32,6 +40,20 @@ void main() {
     // assert
     expect(result.headers, expected);
   });
+
+  test('HeaderInterceptor does not add IDToken when available to headers', () async {
+    // arrange
+    when(mockOAuthChopper.token).thenAnswer((_) async => testIDtoken);
+    final interceptor = OAuthInterceptor(mockOAuthChopper);
+    final expected = {'Authorization': 'Bearer token'};
+
+    // act
+    final result = await interceptor.onRequest(testRequest);
+
+    // assert
+    expect(result.headers, expected);
+  });
+
   test('HeaderInterceptor adds no token to headers', () async {
     // arrange
     when(()=>mockOAuthChopper.token).thenAnswer((_) async => null);