Merge pull request #58 from nimblehq/feature/15-backend-survey-list

nkhanh44 · web-flow · commit 3a1cc91ee25e · 2023-08-18T14:31:52.000+07:00
[#15] [Backend] As a logged-in user, I can see the survey list on the Home screen
diff --git a/lib/api/response_decoder.dart b/lib/api/response_decoder.dart
@@ -1,7 +1,10 @@
 import 'package:japx/japx.dart';
 
 class ResponseDecoder {
-  static Map<String, dynamic> decode(Map<String, dynamic> json) {
+  static Map<String, dynamic> decodeData(Map<String, dynamic> json) {
     return Japx.decode(json)['data'];
   }
+
+  static Map<String, dynamic> decode(Map<String, dynamic> json) =>
+      Japx.decode(json);
 }
diff --git a/lib/api/survey_api_service.dart b/lib/api/survey_api_service.dart
@@ -0,0 +1,16 @@
+import 'package:dio/dio.dart';
+import 'package:retrofit/http.dart';
+import 'package:survey_flutter/model/response/surveys_container_response.dart';
+
+part 'survey_api_service.g.dart';
+
+@RestApi()
+abstract class SurveyApiService {
+  factory SurveyApiService(Dio dio, {String baseUrl}) = _SurveyApiService;
+
+  @GET('/surveys')
+  Future<SurveysContainerResponse> getSurveys(
+    @Query('page[number]') int pageNumber,
+    @Query('page[size]') int pageSize,
+  );
+}
diff --git a/lib/model/meta_model.dart b/lib/model/meta_model.dart
@@ -0,0 +1,31 @@
+import 'package:equatable/equatable.dart';
+
+class MetaModel extends Equatable {
+  final int page;
+  final int pages;
+  final int pageSize;
+  final int records;
+
+  const MetaModel({
+    required this.page,
+    required this.pages,
+    required this.pageSize,
+    required this.records,
+  });
+
+  const MetaModel.dummy()
+      : this(
+          page: 0,
+          pages: 0,
+          pageSize: 0,
+          records: 0,
+        );
+
+  @override
+  List<Object?> get props => [
+        page,
+        pages,
+        pageSize,
+        records,
+      ];
+}
diff --git a/lib/model/response/login_response.dart b/lib/model/response/login_response.dart
@@ -23,7 +23,7 @@ class LoginResponse {
   });
 
   factory LoginResponse.fromJson(Map<String, dynamic> json) =>
-      _$LoginResponseFromJson(ResponseDecoder.decode(json));
+      _$LoginResponseFromJson(ResponseDecoder.decodeData(json));
 
   LoginModel toLoginModel() => LoginModel(
         id: id,
diff --git a/lib/model/response/meta_response.dart b/lib/model/response/meta_response.dart
@@ -0,0 +1,39 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:survey_flutter/api/response_decoder.dart';
+import 'package:survey_flutter/model/meta_model.dart';
+
+part 'meta_response.g.dart';
+
+@JsonSerializable()
+class MetaResponse {
+  final int? page;
+  final int? pages;
+  final int? pageSize;
+  final int? records;
+
+  MetaResponse({
+    required this.page,
+    required this.pages,
+    required this.pageSize,
+    required this.records,
+  });
+
+  factory MetaResponse.fromJson(Map<String, dynamic> json) =>
+      _$MetaResponseFromJson(ResponseDecoder.decode(json));
+
+  static MetaResponse dummy() {
+    return MetaResponse(
+      page: 0,
+      pages: 0,
+      pageSize: 0,
+      records: 0,
+    );
+  }
+
+  MetaModel toMetaModel() => MetaModel(
+        page: page ?? 0,
+        pages: pages ?? 0,
+        pageSize: pageSize ?? 0,
+        records: records ?? 0,
+      );
+}
diff --git a/lib/model/response/survey_response.dart b/lib/model/response/survey_response.dart
@@ -0,0 +1,31 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:json_annotation/json_annotation.dart';
+import 'package:survey_flutter/api/response_decoder.dart';
+import 'package:survey_flutter/model/survey_model.dart';
+
+part 'survey_response.g.dart';
+
+@JsonSerializable()
+class SurveyResponse {
+  final String? id;
+  final String? title;
+  final String? description;
+  final String? coverImageUrl;
+
+  SurveyResponse({
+    required this.id,
+    required this.title,
+    required this.description,
+    required this.coverImageUrl,
+  });
+
+  factory SurveyResponse.fromJson(Map<String, dynamic> json) =>
+      _$SurveyResponseFromJson(ResponseDecoder.decodeData(json));
+
+  SurveyModel toSurveyModel() => SurveyModel(
+        id: id ?? '',
+        title: title ?? '',
+        description: description ?? '',
+        coverImageUrl: coverImageUrl ?? '',
+      );
+}
diff --git a/lib/model/response/surveys_container_response.dart b/lib/model/response/surveys_container_response.dart
@@ -0,0 +1,29 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:survey_flutter/api/response_decoder.dart';
+import 'package:survey_flutter/model/meta_model.dart';
+import 'package:survey_flutter/model/response/meta_response.dart';
+import 'package:survey_flutter/model/response/survey_response.dart';
+import 'package:survey_flutter/model/surveys_container_model.dart';
+
+part 'surveys_container_response.g.dart';
+
+@JsonSerializable()
+class SurveysContainerResponse {
+  final List<SurveyResponse>? data;
+  final MetaResponse? meta;
+
+  const SurveysContainerResponse({
+    required this.data,
+    required this.meta,
+  });
+
+  factory SurveysContainerResponse.fromJson(Map<String, dynamic> json) {
+    return _$SurveysContainerResponseFromJson(ResponseDecoder.decode(json));
+  }
+
+  SurveysContainerModel toSurveysContainerModel() => SurveysContainerModel(
+        surveys:
+            data?.map((item) => item.toSurveyModel()).toList() ?? List.empty(),
+        meta: meta?.toMetaModel() ?? const MetaModel.dummy(),
+      );
+}
diff --git a/lib/model/survey_model.dart b/lib/model/survey_model.dart
@@ -0,0 +1,23 @@
+import 'package:equatable/equatable.dart';
+
+class SurveyModel extends Equatable {
+  final String id;
+  final String title;
+  final String description;
+  final String coverImageUrl;
+
+  const SurveyModel({
+    required this.id,
+    required this.title,
+    required this.description,
+    required this.coverImageUrl,
+  });
+
+  @override
+  List<Object?> get props => [
+        id,
+        title,
+        description,
+        coverImageUrl,
+      ];
+}
diff --git a/lib/model/surveys_container_model.dart b/lib/model/surveys_container_model.dart
@@ -0,0 +1,25 @@
+import 'package:equatable/equatable.dart';
+import 'package:survey_flutter/model/meta_model.dart';
+import 'package:survey_flutter/model/survey_model.dart';
+
+class SurveysContainerModel extends Equatable {
+  final List<SurveyModel> surveys;
+  final MetaModel meta;
+
+  const SurveysContainerModel({
+    required this.surveys,
+    required this.meta,
+  });
+
+  SurveysContainerModel.dummy()
+      : this(
+          surveys: List.empty(),
+          meta: const MetaModel.dummy(),
+        );
+
+  @override
+  List<Object?> get props => [
+        surveys,
+        meta,
+      ];
+}
diff --git a/lib/repositories/survey_repository.dart b/lib/repositories/survey_repository.dart
@@ -0,0 +1,29 @@
+import 'package:survey_flutter/api/exception/network_exceptions.dart';
+import 'package:survey_flutter/api/survey_api_service.dart';
+import 'package:survey_flutter/model/surveys_container_model.dart';
+
+abstract class SurveyRepository {
+  Future<SurveysContainerModel> getSurveys({
+    required int pageNumber,
+    required int pageSize,
+  });
+}
+
+class SurveyRepositoryImpl extends SurveyRepository {
+  final SurveyApiService _apiService;
+
+  SurveyRepositoryImpl(this._apiService);
+
+  @override
+  Future<SurveysContainerModel> getSurveys({
+    required int pageNumber,
+    required int pageSize,
+  }) async {
+    try {
+      final result = await _apiService.getSurveys(pageNumber, pageSize);
+      return result.toSurveysContainerModel();
+    } catch (exception) {
+      throw NetworkExceptions.fromDioException(exception);
+    }
+  }
+}
diff --git a/lib/usecases/get_surveys_use_case.dart b/lib/usecases/get_surveys_use_case.dart
@@ -0,0 +1,31 @@
+import 'package:survey_flutter/model/surveys_container_model.dart';
+import 'package:survey_flutter/repositories/survey_repository.dart';
+
+import 'base/base_use_case.dart';
+
+class SurveysParams {
+  final int pageNumber;
+  final int pageSize;
+
+  SurveysParams({
+    required this.pageNumber,
+    required this.pageSize,
+  });
+}
+
+class GetSurveysUseCase extends UseCase<SurveysContainerModel, SurveysParams> {
+  final SurveyRepository _repository;
+
+  const GetSurveysUseCase(this._repository);
+
+  @override
+  Future<Result<SurveysContainerModel>> call(SurveysParams params) async {
+    try {
+      final result = await _repository.getSurveys(
+          pageNumber: params.pageNumber, pageSize: params.pageSize);
+      return Success(result);
+    } catch (exception) {
+      return Failed(UseCaseException(exception));
+    }
+  }
+}
diff --git a/test/api/repositories/survey_repository_test.dart b/test/api/repositories/survey_repository_test.dart
@@ -0,0 +1,44 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mockito/mockito.dart';
+import 'package:survey_flutter/api/exception/network_exceptions.dart';
+import 'package:survey_flutter/model/response/meta_response.dart';
+import 'package:survey_flutter/model/response/surveys_container_response.dart';
+import 'package:survey_flutter/repositories/survey_repository.dart';
+
+import '../../mocks/generate_mocks.mocks.dart';
+
+void main() {
+  group('SurveyRepository', () {
+    late MockSurveyApiService mockSurveyApiService;
+    late SurveyRepositoryImpl surveyRepository;
+
+    setUp(() {
+      mockSurveyApiService = MockSurveyApiService();
+      surveyRepository = SurveyRepositoryImpl(mockSurveyApiService);
+    });
+
+    test('when getting surveys is successful returns SurveysContainerModel',
+        () async {
+      final surveysResponse = SurveysContainerResponse(
+        data: List.empty(),
+        meta: MetaResponse.dummy(),
+      );
+      when(mockSurveyApiService.getSurveys(any, any))
+          .thenAnswer((_) async => surveysResponse);
+
+      final result =
+          await surveyRepository.getSurveys(pageSize: 0, pageNumber: 0);
+      expect(result, surveysResponse.toSurveysContainerModel());
+    });
+
+    test('when getting surveys fails throws NetworkExceptions', () async {
+      when(mockSurveyApiService.getSurveys(any, any)).thenThrow(Exception());
+
+      expect(
+        () async =>
+            await surveyRepository.getSurveys(pageSize: 0, pageNumber: 0),
+        throwsA(isInstanceOf<NetworkExceptions>()),
+      );
+    });
+  });
+}
diff --git a/test/api/usecases/get_surveys_user_case_test.dart b/test/api/usecases/get_surveys_user_case_test.dart
@@ -0,0 +1,40 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mockito/mockito.dart';
+import 'package:survey_flutter/model/surveys_container_model.dart';
+import 'package:survey_flutter/usecases/base/base_use_case.dart';
+import 'package:survey_flutter/usecases/get_surveys_use_case.dart';
+
+import '../../mocks/generate_mocks.mocks.dart';
+
+void main() {
+  group('GetSurveysUseCase', () {
+    late MockSurveyRepository mockRepository;
+    late GetSurveysUseCase getSurveysUseCase;
+
+    setUp(() {
+      mockRepository = MockSurveyRepository();
+      getSurveysUseCase = GetSurveysUseCase(mockRepository);
+    });
+
+    test('When getting surveys is successful returns Success ', () async {
+      final surveysContainerModel = SurveysContainerModel.dummy();
+      final surveysParams = SurveysParams(pageNumber: 0, pageSize: 10);
+      when(mockRepository.getSurveys(pageNumber: 0, pageSize: 10))
+          .thenAnswer((_) async => surveysContainerModel);
+
+      final result = await getSurveysUseCase(surveysParams);
+
+      expect(result, isA<Success<SurveysContainerModel>>());
+    });
+
+    test('returns Failed when getting surveys fails', () async {
+      final surveysParams = SurveysParams(pageNumber: 0, pageSize: 10);
+
+      when(mockRepository.getSurveys(pageNumber: 0, pageSize: 10))
+          .thenThrow(Exception());
+      final result = await getSurveysUseCase(surveysParams);
+
+      expect(result, isA<Failed<SurveysContainerModel>>());
+    });
+  });
+}
diff --git a/test/mocks/generate_mocks.dart b/test/mocks/generate_mocks.dart
@@ -1,9 +1,11 @@
 import 'package:dio/dio.dart';
 import 'package:mockito/annotations.dart';
 import 'package:survey_flutter/api/authentication_api_service.dart';
+import 'package:survey_flutter/api/survey_api_service.dart';
 import 'package:survey_flutter/repositories/authentication_repository.dart';
 import 'package:survey_flutter/usecases/login_use_case.dart';
 import 'package:survey_flutter/utils/internet_connection_manager.dart';
+import 'package:survey_flutter/repositories/survey_repository.dart';
 
 import '../utils/async_listener.dart';
 
@@ -14,6 +16,8 @@ import '../utils/async_listener.dart';
   DioError,
   InternetConnectionManager,
   LoginUseCase,
+  SurveyRepository,
+  SurveyApiService,
 ])
 main() {
   // empty class to generate mock repository classes

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,10 @@`
`1`	`1`	`import 'package:japx/japx.dart';`
`2`	`2`
`3`	`3`	`class ResponseDecoder {`
`4`		`- static Map<String, dynamic> decode(Map<String, dynamic> json) {`
	`4`	`+ static Map<String, dynamic> decodeData(Map<String, dynamic> json) {`
`5`	`5`	`return Japx.decode(json)['data'];`
`6`	`6`	`}`
	`7`	`+`
	`8`	`+ static Map<String, dynamic> decode(Map<String, dynamic> json) =>`
	`9`	`+ Japx.decode(json);`
`7`	`10`	`}`