refactor(api): update apigateway (#38)

.env.sample

@@ -1,4 +1,4 @@
 SENTRY_DSN=
 ENABLE_SENTRY=false
 # Select one of the following: debug, info, warning, error
-LOG_LEVEL=debug
+LOG_LEVEL=info

.github/workflows/ci.yaml

@@ -0,0 +1,46 @@
+name: Dart Tests
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Flutter
+      uses: subosito/flutter-action@v2
+      with:
+        channel: stable
+        flutter-version: ${{ env.flutter_version }}
+        cache: true
+        # optional parameters follow
+        cache-key: "flutter-:os:-:channel:-:version:-:arch:-:hash:" # optional, change this to force refresh cache
+        cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:" # optional, change this to specify the cache path
+        pub-cache-key: "flutter-pub:os:-:channel:-:version:-:arch:-:hash:" # optional, change this to force refresh cache of dart pub get dependencies
+        pub-cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:" # optional, change this to specify the cache path
+
+    - name: Install dependencies
+      run: flutter pub get
+
+    - name: Prepare env file
+      run: cp .env.sample .env
+
+    - name: Run tests
+      run: flutter test --coverage
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -50,4 +50,6 @@ app.*.map.json
 untranslated.txt
 
 # Env file
-.env
+.env
+
+coverage/

lib/base.dart

@@ -3,6 +3,7 @@
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:animations/animations.dart';
+import 'package:pi_hole_client/models/gateways.dart';
 import 'package:provider/provider.dart';
 
 import 'package:pi_hole_client/widgets/navigation_rail.dart';
@@ -54,11 +55,15 @@ class _BaseState extends State<Base> with WidgetsBindingObserver {
     final result = await Future.wait(
         [apiGateway!.realtimeStatus(), apiGateway.fetchOverTimeData()]);
 
-    if (result[0]['result'] == 'success' && result[1]['result'] == 'success') {
-      statusProvider.setRealtimeStatus(result[0]['data']);
-      statusProvider.setOvertimeData(result[1]['data']);
+    final realtimeStatusResponse = result[0] as RealtimeStatusResponse;
+    final overTimeDataResponse = result[1] as FetchOverTimeDataResponse;
+
+    if (realtimeStatusResponse.result == APiResponseType.success &&
+        overTimeDataResponse.result == APiResponseType.success) {
+      statusProvider.setRealtimeStatus(realtimeStatusResponse.data!);
+      statusProvider.setOvertimeData(overTimeDataResponse.data!);
       serversProvider.updateselectedServerStatus(
-          result[0]['data'].status == 'enabled' ? true : false);
+          realtimeStatusResponse.data!.status == 'enabled' ? true : false);
 
       statusProvider.setOvertimeDataLoadingStatus(1);
       statusProvider.setStatusLoading(LoadStatus.loaded);

lib/constants/api_versions.dart

@@ -0,0 +1,4 @@
+class SupportedApiVersions {
+  static const String v5 = 'v5';
+  static const String v6 = 'v6';
+}

lib/functions/convert.dart

@@ -0,0 +1,7 @@
+import 'package:pi_hole_client/models/domain.dart';
+
+List<Domain> parseDomainList(dynamic jsonList) {
+  return (jsonList as List<dynamic>)
+      .map((item) => Domain.fromJson(item as Map<String, dynamic>))
+      .toList();
+}

lib/functions/refresh_server_status.dart

@@ -1,6 +1,7 @@
 // ignore_for_file: use_build_context_synchronously
 
 import 'package:flutter/material.dart';
+import 'package:pi_hole_client/models/gateways.dart';
 import 'package:provider/provider.dart';
 import 'package:flutter_gen/gen_l10n/app_localizations.dart';
 
@@ -19,12 +20,12 @@ Future refreshServerStatus(BuildContext context) async {
 
   final result = await apiGateway?.realtimeStatus();
   if (!context.mounted) return;
-  if (result['result'] == "success") {
+  if (result?.result == APiResponseType.success) {
     serversProvider.updateselectedServerStatus(
-        result['data'].status == 'enabled' ? true : false);
+        result!.data?.status == 'enabled' ? true : false);
     statusProvider.setIsServerConnected(true);
-    statusProvider.setRealtimeStatus(result['data']);
-  } else if (result['result'] == 'ssl_error') {
+    statusProvider.setRealtimeStatus(result.data!);
+  } else if (result?.result == APiResponseType.sslError) {
     statusProvider.setIsServerConnected(false);
     if (statusProvider.getStatusLoading == LoadStatus.loading) {
       statusProvider.setStatusLoading(LoadStatus.error);

lib/functions/server_management.dart

@@ -1,6 +1,7 @@
 // ignore_for_file: use_build_context_synchronously
 
 import 'package:flutter/material.dart';
+import 'package:pi_hole_client/models/gateways.dart';
 import 'package:provider/provider.dart';
 import 'package:flutter_gen/gen_l10n/app_localizations.dart';
 
@@ -19,7 +20,7 @@ void enableServer(BuildContext context) async {
   process.open(AppLocalizations.of(context)!.enablingServer);
   final result = await apiGateway?.enableServerRequest();
   process.close();
-  if (result['result'] == 'success') {
+  if (result?.result == APiResponseType.success) {
     serversProvider.updateselectedServerStatus(true);
     showSnackBar(
         appConfigProvider: appConfigProvider,
@@ -44,7 +45,7 @@ void disableServer(int time, BuildContext context) async {
   final result = await apiGateway?.disableServerRequest(time);
   process.close();
   if (!context.mounted) return;
-  if (result['result'] == 'success') {
+  if (result?.result == APiResponseType.success) {
     serversProvider.updateselectedServerStatus(false);
     showSnackBar(
         appConfigProvider: appConfigProvider,

lib/functions/status_updater.dart

@@ -1,5 +1,6 @@
 import 'dart:async';
 
+import 'package:pi_hole_client/models/gateways.dart';
 import 'package:pi_hole_client/providers/status_provider.dart';
 import 'package:flutter/material.dart';
 import 'package:provider/provider.dart';
@@ -36,10 +37,10 @@ class StatusUpdater {
           final apiGateway = serversProvider.selectedApiGateway;
           String selectedUrlBefore = serversProvider.selectedServer!.address;
           final statusResult = await apiGateway?.realtimeStatus();
-          if (statusResult['result'] == 'success') {
+          if (statusResult?.result == APiResponseType.success) {
             serversProvider.updateselectedServerStatus(
-                statusResult['data'].status == 'enabled' ? true : false);
-            statusProvider.setRealtimeStatus(statusResult['data']);
+                statusResult!.data!.status == 'enabled' ? true : false);
+            statusProvider.setRealtimeStatus(statusResult.data!);
             if (statusProvider.isServerConnected == false) {
               statusProvider.setIsServerConnected(true);
             }
@@ -73,9 +74,9 @@ class StatusUpdater {
         final apiGateway = serversProvider.selectedApiGateway;
         String statusUrlBefore = serversProvider.selectedServer!.address;
         final statusResult = await apiGateway?.fetchOverTimeData();
-        if (statusResult['result'] == 'success') {
-          statusProvider.setOvertimeData(statusResult['data']);
-          List<dynamic> clients = statusResult['data'].clients.map((client) {
+        if (statusResult?.result == APiResponseType.success) {
+          statusProvider.setOvertimeData(statusResult!.data!);
+          List<dynamic> clients = statusResult.data!.clients.map((client) {
             if (client.name != '') {
               return client.name.toString();
             } else {

lib/gateways/api_gateway_factory.dart

@@ -0,0 +1,18 @@
+import 'package:pi_hole_client/gateways/api_gateway_interface.dart';
+import 'package:pi_hole_client/gateways/v5/api_gateway_v5.dart';
+// import 'package:pi_hole_client/gateways/v5/api_gateway_v6.dart';
+import 'package:pi_hole_client/models/server.dart';
+
+class ApiGatewayFactory {
+  static ApiGateway create(Server server) {
+    final version = server.apiVersion;
+    if (version == 'v5') {
+      return ApiGatewayV5(server);
+    } else if (version == 'v6') {
+      // return ApiGatewayV6(server);
+      throw Exception('Not implemented yet');
+    } else {
+      throw Exception('Unsupported server version: $version');
+    }
+  }
+}