removed public reviews (v1) endpoint (#293)

Author: HazalCiplak

data_hub_api/main.py

@@ -2,15 +2,12 @@
 
 from fastapi import FastAPI
 from fastapi.responses import HTMLResponse
-from data_hub_api.config import ADDITIONAL_MANUSCRIPT_IDS
-from data_hub_api.docmaps.v1.api_router import create_docmaps_router as create_docmaps_router_v1
 from data_hub_api.docmaps.v2.api_router import create_docmaps_router
 from data_hub_api.kotahi_docmaps.v1.api_router import (
     create_docmaps_router as create_docmaps_router_for_kotahi
 )
 
 from data_hub_api.utils.cache import InMemorySingleObjectCache
-from data_hub_api.docmaps.v1.provider import DocmapsProviderV1
 from data_hub_api.docmaps.v2.provider import DocmapsProvider
 from data_hub_api.kotahi_docmaps.v1.provider import DocmapsProvider as KotahiDocmapsProvider
 
@@ -21,19 +18,9 @@
 def create_app():
     app = FastAPI()
 
-    docmaps_v1_max_age_in_seconds = 60 * 60  # 1 hour
     docmaps_v2_max_age_in_seconds = 10 * 60  # 10 minutes
     kotahi_docmaps_max_age_in_seconds = 60 * 60  # 1 hour
 
-    enhanced_preprints_docmaps_provider_v1 = DocmapsProviderV1(
-        only_include_reviewed_preprint_type=True,
-        only_include_evaluated_preprints=False,
-        additionally_include_manuscript_ids=ADDITIONAL_MANUSCRIPT_IDS,
-        query_results_cache=InMemorySingleObjectCache(
-            max_age_in_seconds=docmaps_v2_max_age_in_seconds
-        )
-    )
-
     enhanced_preprints_docmaps_provider = DocmapsProvider(
         query_results_cache=InMemorySingleObjectCache(
             max_age_in_seconds=docmaps_v2_max_age_in_seconds
@@ -46,27 +33,12 @@ def create_app():
         )
     )
 
-    public_reviews_docmaps_provider = DocmapsProviderV1(
-        only_include_reviewed_preprint_type=False,
-        only_include_evaluated_preprints=True,
-        query_results_cache=InMemorySingleObjectCache(
-            max_age_in_seconds=docmaps_v1_max_age_in_seconds
-        )
-    )
-
     @app.get("/")
     def get_root():
         with open("data_hub_api/index.html", "r", encoding='utf-8') as file:
             html_content = file.read()
         return HTMLResponse(content=html_content, status_code=200)
 
-    app.include_router(
-        create_docmaps_router_v1(
-            enhanced_preprints_docmaps_provider_v1
-        ),
-        prefix='/enhanced-preprints/docmaps'
-    )
-
     app.include_router(
         create_docmaps_router(
             enhanced_preprints_docmaps_provider
@@ -81,11 +53,4 @@ def get_root():
         prefix='/kotahi/docmaps'
     )
 
-    app.include_router(
-        create_docmaps_router_v1(
-            public_reviews_docmaps_provider
-        ),
-        prefix='/public-reviews/docmaps'
-    )
-
     return app

tests/unit_tests/main_test.py

@@ -1,12 +1,11 @@
-from unittest.mock import ANY, call, patch, MagicMock
+from unittest.mock import patch, MagicMock
 from typing import Iterable, Sequence
 
 import pytest
 
 from fastapi.testclient import TestClient
 
 from data_hub_api import main as main_module
-from data_hub_api.config import ADDITIONAL_MANUSCRIPT_IDS
 from data_hub_api.main import create_app
 
 
@@ -16,7 +15,7 @@
 
 @pytest.fixture(name='enhanced_preprints_docmaps_provider_class_mock', autouse=True)
 def _enhanced_preprints_docmaps_provider_class_mock() -> Iterable[MagicMock]:
-    with patch.object(main_module, 'DocmapsProviderV1') as mock:
+    with patch.object(main_module, 'DocmapsProvider') as mock:
         yield mock
 
 
@@ -36,13 +35,6 @@ def _enhanced_preprints_docmaps_provider_mock(
     return docmaps_provider_mock_list[0]
 
 
-@pytest.fixture(name='public_reviews_docmaps_provider_mock')
-def _public_reviews_docmaps_provider_mock(
-    docmaps_provider_mock_list: Sequence[MagicMock]
-) -> MagicMock:
-    return docmaps_provider_mock_list[1]
-
-
 def test_read_main():
     client = TestClient(create_app())
     response = client.get("/")
@@ -57,7 +49,7 @@ def test_should_return_json_with_docmaps_list_from_enhanced_preprint_provider(
         docmaps_index = [{'docmaps': [{'id': 'docmap_1'}, {'id': 'docmap_2'}]}]
         enhanced_preprints_docmaps_provider_mock.get_docmaps_index.return_value = docmaps_index
         client = TestClient(create_app())
-        response = client.get('/enhanced-preprints/docmaps/v1/index')
+        response = client.get('/enhanced-preprints/docmaps/v2/index')
         assert response.json() == docmaps_index
 
     def test_should_return_not_available_message_for_invalid_manuscript_id_by_elife(
@@ -67,7 +59,7 @@ def test_should_return_not_available_message_for_invalid_manuscript_id_by_elife(
         enhanced_preprints_docmaps_provider_mock.get_docmaps_by_manuscript_id.return_value = []
         client = TestClient(create_app())
         response = client.get(
-            '/enhanced-preprints/docmaps/v1/by-publisher/elife/get-by-manuscript-id',
+            '/enhanced-preprints/docmaps/v2/by-publisher/elife/get-by-manuscript-id',
             params={'manuscript_id': MANUSCRIPT_ID}
         )
         assert response.status_code == 404
@@ -85,43 +77,11 @@ def test_should_docmap_from_epp_provider_for_individual_by_publisher_manuscript_
         )
         client = TestClient(create_app())
         response = client.get(
-            '/enhanced-preprints/docmaps/v1/by-publisher/elife/get-by-manuscript-id',
+            '/enhanced-preprints/docmaps/v2/by-publisher/elife/get-by-manuscript-id',
             params={'manuscript_id': MANUSCRIPT_ID}
         )
         enhanced_preprints_docmaps_provider_mock.get_docmaps_by_manuscript_id.assert_called_with(
             MANUSCRIPT_ID
         )
         assert response.status_code == 200
         assert response.json() == article_docmap_list[0]
-
-    def test_should_return_json_with_docmaps_list_from_public_review_provider(
-        self,
-        public_reviews_docmaps_provider_mock: MagicMock
-    ):
-        docmaps_index = [{'docmaps': [{'id': 'docmap_1'}, {'id': 'docmap_2'}]}]
-        public_reviews_docmaps_provider_mock.get_docmaps_index.return_value = docmaps_index
-        client = TestClient(create_app())
-        response = client.get('/public-reviews/docmaps/v1/index')
-        assert response.json() == docmaps_index
-
-    def test_should_pass_correct_parameters_to_provider_class(
-        self,
-        enhanced_preprints_docmaps_provider_class_mock: MagicMock
-    ):
-        create_app()
-        enhanced_preprints_docmaps_provider_class_mock.assert_has_calls(
-            [
-                call(
-                    only_include_reviewed_preprint_type=True,
-                    only_include_evaluated_preprints=False,
-                    additionally_include_manuscript_ids=ADDITIONAL_MANUSCRIPT_IDS,
-                    query_results_cache=ANY
-                ),
-                call(
-                    only_include_reviewed_preprint_type=False,
-                    only_include_evaluated_preprints=True,
-                    query_results_cache=ANY
-                )
-            ],
-            any_order=False
-        )