Merge pull request #855 from Udhay-Adithya/basic-auth

add basic authentication features

Author: animator

doc/dev_guide/api_endpoints_for_testing.md

@@ -47,3 +47,14 @@ A List of API endpoints that can be used for testing API Dash
 ## SSE
 
 - https://sse.dev
+
+## Auth
+ - **Bearer**
+    - https://httpbin.org/bearer
+
+ - **Basic Auth**
+    - https://httpbin.org/basic-auth/{username}/{password}
+
+ - **Digest Auth**
+    - https://httpbin.org/digest-auth/{qop}/{usenamer}/{password}/{algorithm}
+

lib/consts.dart

@@ -448,6 +448,7 @@ const kLabelURLParams = "Params";
 const kLabelHeaders = "Headers";
 const kLabelBody = "Body";
 const kLabelScripts = "Scripts";
+const kLabelAuth = "Auth";
 const kLabelQuery = "Query";
 const kNameCheckbox = "Checkbox";
 const kNameURLParam = "URL Parameter";

lib/models/history_request_model.dart

@@ -18,6 +18,7 @@ class HistoryRequestModel with _$HistoryRequestModel {
     required HttpResponseModel httpResponseModel,
     String? preRequestScript,
     String? postRequestScript,
+    AuthModel? authModel,
   }) = _HistoryRequestModel;
 
   factory HistoryRequestModel.fromJson(Map<String, Object?> json) =>

lib/models/history_request_model.freezed.dart

@@ -26,6 +26,7 @@ mixin _$HistoryRequestModel {
   HttpResponseModel get httpResponseModel => throw _privateConstructorUsedError;
   String? get preRequestScript => throw _privateConstructorUsedError;
   String? get postRequestScript => throw _privateConstructorUsedError;
+  AuthModel? get authModel => throw _privateConstructorUsedError;
 
   /// Serializes this HistoryRequestModel to a JSON map.
   Map<String, dynamic> toJson() => throw _privateConstructorUsedError;
@@ -49,11 +50,13 @@ abstract class $HistoryRequestModelCopyWith<$Res> {
       HttpRequestModel httpRequestModel,
       HttpResponseModel httpResponseModel,
       String? preRequestScript,
-      String? postRequestScript});
+      String? postRequestScript,
+      AuthModel? authModel});
 
   $HistoryMetaModelCopyWith<$Res> get metaData;
   $HttpRequestModelCopyWith<$Res> get httpRequestModel;
   $HttpResponseModelCopyWith<$Res> get httpResponseModel;
+  $AuthModelCopyWith<$Res>? get authModel;
 }
 
 /// @nodoc
@@ -77,6 +80,7 @@ class _$HistoryRequestModelCopyWithImpl<$Res, $Val extends HistoryRequestModel>
     Object? httpResponseModel = null,
     Object? preRequestScript = freezed,
     Object? postRequestScript = freezed,
+    Object? authModel = freezed,
   }) {
     return _then(_value.copyWith(
       historyId: null == historyId
@@ -103,6 +107,10 @@ class _$HistoryRequestModelCopyWithImpl<$Res, $Val extends HistoryRequestModel>
           ? _value.postRequestScript
           : postRequestScript // ignore: cast_nullable_to_non_nullable
               as String?,
+      authModel: freezed == authModel
+          ? _value.authModel
+          : authModel // ignore: cast_nullable_to_non_nullable
+              as AuthModel?,
     ) as $Val);
   }
 
@@ -135,6 +143,20 @@ class _$HistoryRequestModelCopyWithImpl<$Res, $Val extends HistoryRequestModel>
       return _then(_value.copyWith(httpResponseModel: value) as $Val);
     });
   }
+
+  /// Create a copy of HistoryRequestModel
+  /// with the given fields replaced by the non-null parameter values.
+  @override
+  @pragma('vm:prefer-inline')
+  $AuthModelCopyWith<$Res>? get authModel {
+    if (_value.authModel == null) {
+      return null;
+    }
+
+    return $AuthModelCopyWith<$Res>(_value.authModel!, (value) {
+      return _then(_value.copyWith(authModel: value) as $Val);
+    });
+  }
 }
 
 /// @nodoc
@@ -151,14 +173,17 @@ abstract class _$$HistoryRequestModelImplCopyWith<$Res>
       HttpRequestModel httpRequestModel,
       HttpResponseModel httpResponseModel,
       String? preRequestScript,
-      String? postRequestScript});
+      String? postRequestScript,
+      AuthModel? authModel});
 
   @override
   $HistoryMetaModelCopyWith<$Res> get metaData;
   @override
   $HttpRequestModelCopyWith<$Res> get httpRequestModel;
   @override
   $HttpResponseModelCopyWith<$Res> get httpResponseModel;
+  @override
+  $AuthModelCopyWith<$Res>? get authModel;
 }
 
 /// @nodoc
@@ -180,6 +205,7 @@ class __$$HistoryRequestModelImplCopyWithImpl<$Res>
     Object? httpResponseModel = null,
     Object? preRequestScript = freezed,
     Object? postRequestScript = freezed,
+    Object? authModel = freezed,
   }) {
     return _then(_$HistoryRequestModelImpl(
       historyId: null == historyId
@@ -206,6 +232,10 @@ class __$$HistoryRequestModelImplCopyWithImpl<$Res>
           ? _value.postRequestScript
           : postRequestScript // ignore: cast_nullable_to_non_nullable
               as String?,
+      authModel: freezed == authModel
+          ? _value.authModel
+          : authModel // ignore: cast_nullable_to_non_nullable
+              as AuthModel?,
     ));
   }
 }
@@ -220,7 +250,8 @@ class _$HistoryRequestModelImpl implements _HistoryRequestModel {
       required this.httpRequestModel,
       required this.httpResponseModel,
       this.preRequestScript,
-      this.postRequestScript});
+      this.postRequestScript,
+      this.authModel});
 
   factory _$HistoryRequestModelImpl.fromJson(Map<String, dynamic> json) =>
       _$$HistoryRequestModelImplFromJson(json);
@@ -237,10 +268,12 @@ class _$HistoryRequestModelImpl implements _HistoryRequestModel {
   final String? preRequestScript;
   @override
   final String? postRequestScript;
+  @override
+  final AuthModel? authModel;
 
   @override
   String toString() {
-    return 'HistoryRequestModel(historyId: $historyId, metaData: $metaData, httpRequestModel: $httpRequestModel, httpResponseModel: $httpResponseModel, preRequestScript: $preRequestScript, postRequestScript: $postRequestScript)';
+    return 'HistoryRequestModel(historyId: $historyId, metaData: $metaData, httpRequestModel: $httpRequestModel, httpResponseModel: $httpResponseModel, preRequestScript: $preRequestScript, postRequestScript: $postRequestScript, authModel: $authModel)';
   }
 
   @override
@@ -259,13 +292,22 @@ class _$HistoryRequestModelImpl implements _HistoryRequestModel {
             (identical(other.preRequestScript, preRequestScript) ||
                 other.preRequestScript == preRequestScript) &&
             (identical(other.postRequestScript, postRequestScript) ||
-                other.postRequestScript == postRequestScript));
+                other.postRequestScript == postRequestScript) &&
+            (identical(other.authModel, authModel) ||
+                other.authModel == authModel));
   }
 
   @JsonKey(includeFromJson: false, includeToJson: false)
   @override
-  int get hashCode => Object.hash(runtimeType, historyId, metaData,
-      httpRequestModel, httpResponseModel, preRequestScript, postRequestScript);
+  int get hashCode => Object.hash(
+      runtimeType,
+      historyId,
+      metaData,
+      httpRequestModel,
+      httpResponseModel,
+      preRequestScript,
+      postRequestScript,
+      authModel);
 
   /// Create a copy of HistoryRequestModel
   /// with the given fields replaced by the non-null parameter values.
@@ -291,7 +333,8 @@ abstract class _HistoryRequestModel implements HistoryRequestModel {
       required final HttpRequestModel httpRequestModel,
       required final HttpResponseModel httpResponseModel,
       final String? preRequestScript,
-      final String? postRequestScript}) = _$HistoryRequestModelImpl;
+      final String? postRequestScript,
+      final AuthModel? authModel}) = _$HistoryRequestModelImpl;
 
   factory _HistoryRequestModel.fromJson(Map<String, dynamic> json) =
       _$HistoryRequestModelImpl.fromJson;
@@ -308,6 +351,8 @@ abstract class _HistoryRequestModel implements HistoryRequestModel {
   String? get preRequestScript;
   @override
   String? get postRequestScript;
+  @override
+  AuthModel? get authModel;
 
   /// Create a copy of HistoryRequestModel
   /// with the given fields replaced by the non-null parameter values.

lib/models/history_request_model.g.dart

@@ -207,6 +207,7 @@ class CollectionStateNotifier
     String? id,
     HTTPVerb? method,
     APIType? apiType,
+    AuthModel? authModel,
     String? url,
     String? name,
     String? description,
@@ -242,6 +243,7 @@ class CollectionStateNotifier
         url: url ?? currentHttpRequestModel.url,
         headers: headers ?? currentHttpRequestModel.headers,
         params: params ?? currentHttpRequestModel.params,
+        authModel: authModel ?? currentHttpRequestModel.authModel,
         isHeaderEnabledList:
             isHeaderEnabledList ?? currentHttpRequestModel.isHeaderEnabledList,
         isParamEnabledList:
@@ -315,6 +317,7 @@ class CollectionStateNotifier
     var responseRec = await sendHttpRequest(
       requestId,
       apiType,
+      requestModel.httpRequestModel?.authModel,
       substitutedHttpRequestModel,
       defaultUriScheme: defaultUriScheme,
       noSSL: noSSL,
@@ -356,8 +359,11 @@ class CollectionStateNotifier
         httpResponseModel: httpResponseModel,
         preRequestScript: requestModel.preRequestScript,
         postRequestScript: requestModel.postRequestScript,
+        authModel: requestModel.httpRequestModel?.authModel,
       );
 
+      ref.read(historyMetaStateNotifier.notifier).addHistoryRequest(model);
+
       if (!requestModel.postRequestScript.isNullOrEmpty()) {
         newRequestModel = await handlePostResponseScript(
           newRequestModel,
@@ -373,7 +379,6 @@ class CollectionStateNotifier
           },
         );
       }
-      ref.read(historyMetaStateNotifier.notifier).addHistoryRequest(model);
     }
 
     // update state with response data
@@ -444,6 +449,7 @@ class CollectionStateNotifier
             : (state?[id]?.copyWith(httpResponseModel: null))?.toJson(),
       );
     }
+
     await hiveHandler.removeUnused();
     ref.read(saveDataStateProvider.notifier).state = false;
     ref.read(hasUnsavedChangesProvider.notifier).state = false;

lib/providers/collection_providers.dart

@@ -0,0 +1,103 @@
+import 'package:flutter/material.dart';
+import 'package:apidash_core/apidash_core.dart';
+import 'package:apidash_design_system/apidash_design_system.dart';
+import 'package:apidash/widgets/widgets.dart';
+import 'consts.dart';
+
+class ApiKeyAuthFields extends StatefulWidget {
+  final AuthModel? authData;
+  final bool readOnly;
+  final Function(AuthModel?)? updateAuth;
+
+  const ApiKeyAuthFields(
+      {super.key,
+      required this.authData,
+      this.updateAuth,
+      this.readOnly = false});
+
+  @override
+  State<ApiKeyAuthFields> createState() => _ApiKeyAuthFieldsState();
+}
+
+class _ApiKeyAuthFieldsState extends State<ApiKeyAuthFields> {
+  late TextEditingController _keyController;
+  late TextEditingController _nameController;
+  late String _addKeyTo;
+
+  @override
+  void initState() {
+    super.initState();
+    final apiAuth = widget.authData?.apikey;
+    _keyController = TextEditingController(text: apiAuth?.key ?? '');
+    _nameController =
+        TextEditingController(text: apiAuth?.name ?? kApiKeyHeaderName);
+    _addKeyTo = apiAuth?.location ?? kAddToDefaultLocation;
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Column(
+      crossAxisAlignment: CrossAxisAlignment.start,
+      children: [
+        Text(
+          kLabelAddTo,
+          style: TextStyle(
+            fontWeight: FontWeight.normal,
+            fontSize: 14,
+          ),
+        ),
+        SizedBox(
+          height: 4,
+        ),
+        ADPopupMenu<String>(
+          value: kAddToLocationsMap[_addKeyTo],
+          values: kAddToLocations,
+          tooltip: kTooltipApiKeyAuth,
+          isOutlined: true,
+          onChanged: widget.readOnly
+              ? null
+              : (String? newLocation) {
+                  if (newLocation != null) {
+                    setState(() {
+                      _addKeyTo = newLocation;
+                    });
+                    _updateApiKeyAuth();
+                  }
+                },
+        ),
+        const SizedBox(height: 16),
+        AuthTextField(
+          readOnly: widget.readOnly,
+          controller: _nameController,
+          hintText: kHintTextFieldName,
+          onChanged: (value) => _updateApiKeyAuth(),
+        ),
+        const SizedBox(height: 16),
+        AuthTextField(
+          readOnly: widget.readOnly,
+          controller: _keyController,
+          title: kLabelApiKey,
+          hintText: kHintTextKey,
+          isObscureText: true,
+          onChanged: (value) => _updateApiKeyAuth(),
+        ),
+      ],
+    );
+  }
+
+  void _updateApiKeyAuth() {
+    final apiKey = AuthApiKeyModel(
+      key: _keyController.text.trim(),
+      name: _nameController.text.trim(),
+      location: _addKeyTo,
+    );
+    widget.updateAuth?.call(widget.authData?.copyWith(
+          type: APIAuthType.apiKey,
+          apikey: apiKey,
+        ) ??
+        AuthModel(
+          type: APIAuthType.apiKey,
+          apikey: apiKey,
+        ));
+  }
+}

lib/screens/common_widgets/auth/api_key_auth_fields.dart

@@ -0,0 +1,6 @@
+export 'api_key_auth_fields.dart';
+export 'auth_page.dart';
+export 'basic_auth_fields.dart';
+export 'bearer_auth_fields.dart';
+export 'digest_auth_fields.dart';
+export 'jwt_auth_fields.dart';