Merge pull request #8 from hmalik144/retrofit_interceptor_implementation

Retrofit classes implemented with interceptor and base features

lib/Utils/currencyUtils.dart

@@ -1,5 +1,6 @@
 extension CurrencyExtension on String {
-
+  /// Convert currency string into currency code
+  /// eg. "AUD - Australian Dollar" to "AUD"
   String getCurrencyCode(){
     return substring(0,3);
   }

lib/data/model/Currency.dart

@@ -6,6 +6,7 @@ class Currency {
   Currency(this.from, this.to, this.rate);
 }
 
-abstract class Mapper {
+/// Mapper class to convert any object to [Currency]
+abstract class CurrencyMapper {
   Currency convert();
 }

lib/data/network/app_dio.dart

@@ -0,0 +1,15 @@
+import 'package:dio/dio.dart';
+
+class AppDio {
+  static Dio createDio() {
+    Dio dio = Dio(
+        BaseOptions(
+            receiveTimeout: 60000,
+            connectTimeout: 120000,
+        )
+    );
+    dio.interceptors.add(LogInterceptor());
+
+    return dio;
+  }
+}

lib/data/network/backupCurrencyApi.dart

@@ -3,6 +3,7 @@ import 'package:json_annotation/json_annotation.dart';
 import 'package:retrofit/retrofit.dart';
 
 import '../model/Currency.dart';
+import 'app_dio.dart';
 
 part 'backupCurrencyApi.g.dart';
 
@@ -10,13 +11,18 @@ part 'backupCurrencyApi.g.dart';
 abstract class BackupCurrencyApi {
   factory BackupCurrencyApi(Dio dio, {String baseUrl}) = _BackupCurrencyApi;
 
+  static BackupCurrencyApi create() {
+    final dio = AppDio.createDio();
+    return _BackupCurrencyApi(dio);
+  }
+
   @GET("latest?")
   Future<HttpResponse<CurrencyResponse>> getCurrencyRate(@Query("from") String currencyFrom,
       @Query("to") String currencyTo);
 }
 
 @JsonSerializable()
-class CurrencyResponse implements Mapper{
+class CurrencyResponse implements CurrencyMapper{
   String? data;
   double amount;
   Map<String, double>? rates;

lib/data/network/currencyApi.dart

@@ -1,4 +1,6 @@
 import 'package:dio/dio.dart';
+import 'package:easy_cc_flutter/data/network/app_dio.dart';
+import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:retrofit/retrofit.dart';
 
@@ -8,14 +10,21 @@ part 'currencyApi.g.dart';
 
 @RestApi(baseUrl: "https://free.currencyconverterapi.com/api/v3/")
 abstract class CurrencyApi {
-  factory CurrencyApi(Dio dio, {String baseUrl}) = _CurrencyApi;
+  factory CurrencyApi(Dio dio) = _CurrencyApi;
+  
+  static CurrencyApi create() {
+    final dio = AppDio.createDio();
+    dio.options.queryParameters.addAll({"apiKey": dotenv.env['apiKey']!});
+
+    return _CurrencyApi(dio);
+  }
 
   @GET("/convert?")
-  Future<HttpResponse<ResponseObject>> getConversion(@Query("apiKey") String apiKey, @Query("q") String currency);
+  Future<HttpResponse<ResponseObject>> getConversion(@Query("q") String currency);
 }
 
 @JsonSerializable()
-class ResponseObject implements Mapper{
+class ResponseObject implements CurrencyMapper{
   dynamic query;
   Map<String, CurrencyObject>? results;
 

lib/data/network/safeApiCall.dart

@@ -11,7 +11,7 @@ mixin SafeApiCall {
       HttpResponse<T> httpResponse = await apiCall;
       return httpResponse.data;
     } on DioError catch(dioError) {
-      Map<String, dynamic>? errorResponse = dioError.response?.data;
+      Map<String, dynamic>? errorResponse = dioError.response?.data?["error"];
       String error;
 
       if (errorResponse?["error"] != null){
@@ -21,7 +21,6 @@ mixin SafeApiCall {
       } else {
         error = "Failed to retrieve data from api";
       }
-
       logger.e(dioError.error);
 
       throw HttpException(error);

lib/data/repository/RepositoryImpl.dart

@@ -4,7 +4,6 @@ import 'package:easy_cc_flutter/Utils/currencyUtils.dart';
 import 'package:easy_cc_flutter/data/model/Currency.dart';
 import 'package:easy_cc_flutter/data/prefs/CurrencyPair.dart';
 import 'package:easy_cc_flutter/data/prefs/PreferenceProvider.dart';
-import 'package:flutter_dotenv/flutter_dotenv.dart';
 
 import '../../locator.dart';
 import '../../main.dart';
@@ -36,7 +35,7 @@ class RepositoryImpl extends Repository with SafeApiCall {
     String currency = "${from}_$to";
 
     try {
-      ResponseObject responseObject = await getDataFromApiCall(_api.getConversion(dotenv.env['apiKey']!, currency));
+      ResponseObject responseObject = await getDataFromApiCall(_api.getConversion(currency));
       return responseObject.convert();
     } on HttpException catch(error) {
       logger.e(error);

lib/locator.dart

@@ -10,12 +10,9 @@ import 'data/prefs/PreferenceProvider.dart';
 GetIt locator = GetIt.instance;
 
 void setupLocator() {
-  final dio = Dio();
-
   locator.registerLazySingleton(() => PreferenceProvider());
-  locator.registerLazySingleton(() => CurrencyApi(dio));
-  locator.registerLazySingleton(() => BackupCurrencyApi(dio));
+  locator.registerLazySingleton(() => CurrencyApi.create());
+  locator.registerLazySingleton(() => BackupCurrencyApi.create());
   locator.registerLazySingleton(() => RepositoryImpl());
   locator.registerFactory(() => MainViewModel());
-
 }

test/unit_test/repository_test.dart

@@ -73,7 +73,7 @@ void main() {
 
     // When
     when(mockResponse.data).thenReturn(responseObject);
-    when(currencyApi.getConversion(dotenv.env['apiKey']!, currency))
+    when(currencyApi.getConversion(currency))
         .thenAnswer((_) async => mockResponse);
 
     // Then
@@ -91,7 +91,7 @@ void main() {
     String currency = "AUD_GBP";
 
     // When
-    when(currencyApi.getConversion(dotenv.env['apiKey']!, currency))
+    when(currencyApi.getConversion(currency))
         .thenAnswer((_) async => Future.error(MockDioError()));
     when(mockResponse.data).thenReturn(currencyResponse);
     when(backupCurrencyApi.getCurrencyRate("AUD", "GBP"))
@@ -110,7 +110,7 @@ void main() {
 
     // When
     when(backUpError.error).thenReturn("Error message");
-    when(currencyApi.getConversion(dotenv.env['apiKey']!, currency))
+    when(currencyApi.getConversion(currency))
         .thenAnswer((_) async => Future.error(MockDioError()));
     when(backupCurrencyApi.getCurrencyRate("AUD", "GBP"))
         .thenAnswer((_) async => Future.error(backUpError));