feat: Add basic services implementing Dio and Hive.

Author: BURG3R5

lib/data/config/config.dart

@@ -1,3 +1,10 @@
 class Environment {
+  /// URL that is common to most outgoing requests.
+  static const String baseUrl = String.fromEnvironment(
+    'BASE_URL',
+    defaultValue: 'https://codephile.mdg.iitr.ac.in/v1/',
+  );
+
+  /// Project identifier for Sentry error logging.
   static const String sentryDSN = String.fromEnvironment('SENTRY_DSN');
 }

lib/data/constants/strings.dart

@@ -1,3 +1,5 @@
 class AppStrings {
   static const String hiveBoxName = 'app_box';
+
+  static const String authTokenKey = 'auth_token';
 }

lib/data/services/local/SAMPLE

@@ -0,0 +1,42 @@
+import 'package:hive_flutter/hive_flutter.dart';
+
+import '../../constants/strings.dart';
+
+class StorageService {
+  /// Service initializer
+  static void init() => _box = Hive.box(AppStrings.hiveBoxName);
+
+  // Data
+  /// The Hive [Box] which contains all data stored by the app.
+  static late final Box _box;
+
+  // CRUD methods
+  static T? _get<T>(String key) => _box.get(key);
+
+  static void _set<T>(String key, T? value) => _box.put(key, value);
+
+  /// Remove a key from storage.
+  static T? delete<T>(String key) {
+    final T? value = _box.get(key);
+    _box.delete(key);
+    return value;
+  }
+
+  /// Safely check whether a key exists in storage.
+  /// Optionally check if the value is non-null.
+  static bool exists(String key, {bool checkForNull = false}) {
+    if (!_box.containsKey(key)) return false;
+    return !checkForNull || _box.get(key) != null;
+  }
+
+  /// Get a stream of [BoxEvent]s performed on a particular [key].
+  static Stream<BoxEvent> stream(String key) => _box.watch(key: key);
+
+  // Specific getters and setters
+  /// Authorization token for API requests.
+  static String? get authToken => _get<String>(AppStrings.authTokenKey);
+
+  /// Authorization token for API requests.
+  static set authToken(String? token) =>
+      _set<String>(AppStrings.authTokenKey, token);
+}

lib/data/services/local/storage_service.dart

@@ -0,0 +1,116 @@
+import 'package:dio/dio.dart';
+import 'package:flutter/foundation.dart';
+
+import '../../config/config.dart';
+import '../local/storage_service.dart';
+
+class ApiService {
+  /// Service initializer
+  static void init() => _channel = Dio();
+
+  // Data
+  /// The [Dio] channel through which all requests will be routed.
+  static late final Dio _channel;
+
+  /// Safe method to send GET request to an endpoint **below** [Environment.baseUrl].
+  static Future<Map<String, dynamic>> get(
+    String endpoint, {
+    Map<String, dynamic>? query,
+  }) async {
+    Response? response;
+    try {
+      response = await _channel.get(
+        Environment.baseUrl + endpoint,
+        queryParameters: query,
+        options: Options(
+          validateStatus: (status) {
+            return status! < 500;
+          },
+          headers: {'authorization': StorageService.authToken},
+        ),
+      );
+      return {
+        'status_code': response.statusCode ?? 0,
+        'data': response.data ?? 'null',
+      };
+    } on Exception catch (exception, stacktrace) {
+      debugPrint(
+        'ERROR: Failed during a GET request.\n'
+        'Endpoint: $endpoint\nQuery: $query\n'
+        'Exception: $exception\nStacktrace: $stacktrace',
+      );
+    }
+    return {
+      'status_code': response?.statusCode ?? 0,
+      'data': response?.data ?? 'null',
+    };
+  }
+
+  /// Safe method to send POST request to an endpoint **below** [Environment.baseUrl].
+  static Future<Map<String, dynamic>> post(
+    String endpoint, {
+    required Map<String, dynamic> data,
+  }) async {
+    Response? response;
+    try {
+      response = await _channel.post(
+        Environment.baseUrl + endpoint,
+        data: data,
+        options: Options(
+          validateStatus: (status) {
+            return status! < 500;
+          },
+          headers: {'authorization': StorageService.authToken},
+        ),
+      );
+      return {
+        'status_code': response.statusCode ?? 0,
+        'data': response.data ?? 'null',
+      };
+    } on Exception catch (exception, stacktrace) {
+      debugPrint(
+        'ERROR: Failed during a POST request.\n'
+        'Endpoint: $endpoint\nData: $data\n'
+        'Exception: $exception\nStacktrace: $stacktrace',
+      );
+    }
+    return {
+      'status_code': response?.statusCode ?? 0,
+      'data': response?.data ?? 'null',
+    };
+  }
+
+  /// Safe method to send PUT request to an endpoint **below** [Environment.baseUrl].
+  static Future<Map<String, dynamic>> put(
+    String endpoint, {
+    required Map<String, dynamic> data,
+  }) async {
+    Response? response;
+    try {
+      response = await _channel.put(
+        Environment.baseUrl + endpoint,
+        data: data,
+        options: Options(
+          validateStatus: (status) {
+            return status! < 500;
+          },
+          headers: {'authorization': StorageService.authToken},
+        ),
+      );
+      return {
+        'status_code': response.statusCode ?? 0,
+        'data': response.data ?? 'null',
+      };
+    } on Exception catch (exception, stacktrace) {
+      debugPrint(
+        'ERROR: Failed during a POST request.\n'
+        'Endpoint: $endpoint\nData: $data\n'
+        'Exception: $exception\nStacktrace: $stacktrace',
+      );
+    }
+    return {
+      'status_code': response?.statusCode ?? 0,
+      'data': response?.data ?? 'null',
+    };
+  }
+}

lib/data/services/remote/SAMPLE

@@ -169,6 +169,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.2.1"
+  dio:
+    dependency: "direct main"
+    description:
+      name: dio
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "4.0.4"
   fake_async:
     dependency: transitive
     description:

lib/data/services/remote/api_service.dart

@@ -9,6 +9,7 @@ environment:
   sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
+  dio: ^4.0.4
   firebase_core: ^1.11.0
   firebase_crashlytics: ^2.4.5
   firebase_messaging: ^11.2.5