Merge pull request #831 from riojosdev/http-options-trace

added HTTP method `OPTIONS` (#822)

Author: animator

doc/dev_guide/api_endpoints_for_testing.md

@@ -11,7 +11,10 @@ A List of API endpoints that can be used for testing API Dash
 
 #### For Testing HTTP PUT, PATCH, DELETE
 - https://reqres.in/
-  
+ 
+#### For Testing HTTP OPTIONS
+- https://reqbin.com/echo/options 
+
 #### For Testing sites with Bad Certificate
 - https://badssl.com/
 - https://www.ssl.com/sample-valid-revoked-and-expired-ssl-tls-certificates/

lib/models/history_meta_model.g.dart

@@ -51,6 +51,7 @@ Color getHTTPMethodColor(HTTPVerb? method) {
     HTTPVerb.put => kColorHttpMethodPut,
     HTTPVerb.patch => kColorHttpMethodPatch,
     HTTPVerb.delete => kColorHttpMethodDelete,
+    HTTPVerb.options => kColorHttpMethodOptions,
     _ => kColorHttpMethodGet,
   };
   return col;

lib/utils/ui_utils.dart

@@ -17,7 +17,8 @@ enum HTTPVerb {
   post("POST"),
   put("PUT"),
   patch("PAT"),
-  delete("DEL");
+  delete("DEL"),
+  options("OPT");
 
   const HTTPVerb(this.abbr);
   final String abbr;

packages/apidash_core/lib/consts.dart

@@ -94,6 +94,7 @@ Future<(HttpResponse?, Duration?, String?)> sendHttpRequest(
           case HTTPVerb.put:
           case HTTPVerb.patch:
           case HTTPVerb.delete:
+          case HTTPVerb.options:
             final request = prepareHttpRequest(
               url: requestUrl,
               method: requestModel.method.name.toUpperCase(),

packages/apidash_core/lib/models/http_request_model.g.dart

@@ -23,6 +23,7 @@ final kColorHttpMethodPost = Colors.blue.shade800;
 final kColorHttpMethodPut = Colors.amber.shade900;
 final kColorHttpMethodPatch = kColorHttpMethodPut;
 final kColorHttpMethodDelete = Colors.red.shade800;
+final kColorHttpMethodOptions = Colors.deepPurple.shade800;
 
 final kColorGQL = Colors.pink.shade600;
 

packages/apidash_core/lib/services/http_service.dart

@@ -466,3 +466,9 @@ const httpRequestModelPost13 = HttpRequestModel(
 "text": "I LOVE Flutter"
 }""",
 );
+
+/// Basic OPTIONS request model
+const httpRequestModelOptions1 = HttpRequestModel(
+  method: HTTPVerb.options,
+  url: 'https://reqbin.com/echo/options',
+);

packages/apidash_design_system/lib/tokens/colors.dart

@@ -253,3 +253,9 @@ const requestModelPost13 = RequestModel(
   apiType: APIType.rest,
   httpRequestModel: httpRequestModelPost13,
 );
+
+const requestModelOptions1 = RequestModel(
+  id: 'options1',
+  apiType: APIType.rest,
+  httpRequestModel: httpRequestModelOptions1,
+);

test/models/http_request_models.dart

@@ -119,4 +119,21 @@ void main() {
   test('Testing hashcode', () {
     expect(responseModel.hashCode, greaterThan(0));
   });
+
+  test('Testing fromResponse for OPTIONS method', () async {
+    var responseRec = await sendHttpRequest(
+      requestModelOptions1.id,
+      requestModelOptions1.apiType,
+      requestModelOptions1.httpRequestModel!,
+      defaultUriScheme: kDefaultUriScheme,
+      noSSL: false,
+    );
+
+    final responseData = responseModel.fromResponse(response: responseRec.$1!);
+    expect(responseData.statusCode, 200);
+    expect(responseData.headers?['access-control-allow-methods'], 'GET,POST,PUT,PATCH,DELETE,HEAD,OPTIONS');
+    expect(responseData.headers?['access-control-allow-methods']?.contains("OPTIONS"), true);
+    expect(responseData.headers?['allow'], 'GET,POST,PUT,PATCH,DELETE,HEAD,OPTIONS');
+    expect(responseData.headers?['allow']?.contains("OPTIONS"), true);
+  });
 }