fix: TT-206 return 404 when a time entry is not running (#274)

* fix: TT-206 return 404 when a time entry is not running

* fix typo

* fix: TT-206 solve PR comments

Author: eduardisrael

tests/time_tracker_api/time_entries/time_entries_namespace_test.py

@@ -594,7 +594,7 @@ def test_get_running_should_call_find_running(
     repository_update_mock.assert_called_once_with(tenant_id, owner_id)
 
 
-def test_get_running_should_return_not_found_if_StopIteration(
+def test_get_running_should_return_no_content_if_StopIteration(
     client: FlaskClient,
     mocker: MockFixture,
     valid_header: dict,
@@ -610,7 +610,7 @@ def test_get_running_should_return_not_found_if_StopIteration(
         "/time-entries/running", headers=valid_header, follow_redirects=True
     )
 
-    assert HTTPStatus.NOT_FOUND == response.status_code
+    assert HTTPStatus.NO_CONTENT == response.status_code
     repository_update_mock.assert_called_once_with(tenant_id, owner_id)
 
 

time_tracker_api/api.py

@@ -172,3 +172,9 @@ def default_error_handler(error):
         {'message': 'An unhandled exception occurred.'},
         HTTPStatus.INTERNAL_SERVER_ERROR,
     )
+
+
+@api.errorhandler(StopIteration)
+def handle_no_content(error):
+    app.logger.error(error)
+    return {'message': 'No Content'}, HTTPStatus.NO_CONTENT

time_tracker_api/time_entries/time_entries_namespace.py

@@ -334,7 +334,7 @@ def post(self, id):
 
 @ns.route('/running')
 @ns.response(HTTPStatus.OK, 'The time entry that is active: currently running')
-@ns.response(HTTPStatus.NOT_FOUND, 'There is no time entry running right now')
+@ns.response(HTTPStatus.NO_CONTENT, 'There is no time entry running right now')
 class ActiveTimeEntry(Resource):
     @ns.doc('running_time_entry')
     @ns.marshal_with(time_entry)

time_tracker_api/time_entries/time_entries_repository.py

@@ -324,7 +324,10 @@ def find_running(
         )
 
         function_mapper = self.get_mapper_or_dict(mapper)
-        return function_mapper(next(result))
+        try:
+            return function_mapper(next(result))
+        except StopIteration as no_result:
+            raise CustomError(HTTPStatus.NO_CONTENT)
 
     def validate_data(self, data, event_context: EventContext):
         start_date = data.get('start_date')