refactor: TT-352 refactoring of the use case and endpoint to obtain activities

Author: JosueOb

V2/source/entry_points/flask_api/activities_endpoints.py

@@ -5,12 +5,14 @@
 
 class Activities(Resource):
     def get(self):
-        return [activity.__dict__ for activity in use_cases.get_list_activities()]
+        activities = use_cases.GetActivitiesUseCase()
+        return [activity.__dict__ for activity in activities.get_activities()]
 
 
 class Activity(Resource):
     def get(self, activity_id: str):
         try:
-            return use_cases.get_activity_by_id(activity_id).__dict__
+            activity = use_cases.GetActivityUseCase()
+            return activity.get_activity_by_id(activity_id).__dict__
         except AttributeError:
             return {'message': 'Activity not found'}, HTTPStatus.NOT_FOUND

V2/source/use_cases/__init__.py

@@ -1,2 +1,2 @@
-from ._get_activities_use_case import get_list_activities
-from ._get_activity_by_id_use_case import get_activity_by_id
+from ._get_activities_use_case import GetActivitiesUseCase
+from ._get_activity_by_id_use_case import GetActivityUseCase

V2/source/use_cases/_get_activities_use_case.py

@@ -4,8 +4,8 @@
 import typing
 
 
-def get_list_activities() -> typing.List[Activity]:
-    activity_json = ActivitiesJsonDao('./V2/source/activities_data.json')
-    activities = ActivityService(activity_json)
-
-    return activities.get_all()
+class GetActivitiesUseCase:
+    def get_activities(self) -> typing.List[Activity]:
+        activity_json = ActivitiesJsonDao('./V2/source/activities_data.json')
+        activities = ActivityService(activity_json)
+        return activities.get_all()

V2/source/use_cases/_get_activity_by_id_use_case.py

@@ -3,8 +3,8 @@
 from V2.source.dtos.activity import Activity
 
 
-def get_activity_by_id(id: str) -> Activity:
-    activity_json = ActivitiesJsonDao('./V2/source/activities_data.json')
-    activity = ActivityService(activity_json)
-
-    return activity.get_by_id(id)
+class GetActivityUseCase:
+    def get_activity_by_id(self, id: str) -> Activity:
+        activity_json = ActivitiesJsonDao('./V2/source/activities_data.json')
+        activity = ActivityService(activity_json)
+        return activity.get_by_id(id)

V2/tests/unit/entry_points/flask/activity_class_endpoint_test.py

@@ -26,25 +26,30 @@
 def test__activities_class__uses_the_get_activities_use_case__to_retrieve_activities(
     mocker: MockFixture,
 ):
-    mocker.patch('V2.source.use_cases.get_list_activities', return_value=[])
+    mocker.patch.object(
+        use_cases.GetActivitiesUseCase,
+        'get_activities',
+        return_value=[],
+    )
 
     activities_class_endpoint = Activities()
     activities = activities_class_endpoint.get()
 
-    assert use_cases.get_list_activities.called
+    assert use_cases.GetActivitiesUseCase.get_activities.called
     assert [] == activities
 
 
 def test__activity_class__uses_the_get_activity_by_id_use_case__to_retrieve__an_activity(
     mocker: MockFixture,
 ):
-    mocker.patch(
-        'V2.source.use_cases.get_activity_by_id',
+    mocker.patch.object(
+        use_cases.GetActivityUseCase,
+        'get_activity_by_id',
         return_value=fake_activity_dto,
     )
 
     activity_class_endpoint = Activity()
     activity = activity_class_endpoint.get(valid_id)
 
-    assert use_cases.get_activity_by_id.called
+    assert use_cases.GetActivityUseCase.get_activity_by_id.called
     assert fake_activity == activity

V2/tests/unit/use_cases/activities_use_case_test.py

@@ -9,27 +9,31 @@ def test__get_list_activities_function__uses_the_activities_service__to_retrieve
     mocker: MockFixture,
 ):
     expected_activities = mocker.Mock()
-    mocker.patch(
-        'V2.source.use_cases.get_list_activities',
+    mocker.patch.object(
+        use_cases.GetActivitiesUseCase,
+        'get_activities',
         return_value=expected_activities,
     )
 
-    actual_activities = use_cases.get_list_activities()
+    activities_use_case = use_cases.GetActivitiesUseCase()
+    actual_activities = activities_use_case.get_activities()
 
-    assert use_cases.get_list_activities.called
+    assert activities_use_case.get_activities.called
     assert expected_activities == actual_activities
 
 
 def test__get_activity_by_id_function__uses_the_activities_service__to_retrieve_activity(
     mocker: MockFixture,
 ):
     expected_activity = mocker.Mock()
-    mocker.patch(
-        'V2.source.use_cases.get_activity_by_id',
+    mocker.patch.object(
+        use_cases.GetActivityUseCase,
+        'get_activity_by_id',
         return_value=expected_activity,
     )
 
-    actual_activity = use_cases.get_activity_by_id(fake.uuid4())
+    activity_use_case = use_cases.GetActivityUseCase()
+    actual_activity = activity_use_case.get_activity_by_id(fake.uuid4())
 
-    assert use_cases.get_activity_by_id.called
+    assert activity_use_case.get_activity_by_id.called
     assert expected_activity == actual_activity