Feature-authorized-scopes-updater (#560)

* support Determinative type for transliteration * Implemented API for updating authorized_scopes of the fragment * Type check and reformatting * Type check fixed * Added test for authorized scopes * Refactorring * Adjusted tests * Fixed type check * Fixed Lint * Authorized scopes are included in Fragment Schema * Removed excluding of authorizedScopes in Fragment Schema * Reformatting * Fix provenance resource (#562) * adapt on_get to return provenance parents in square brackets * reformatting * Fixed test for provenance * Exclude restricted fragments from the latest addition list (#563) * Remove user scopes from latest addition aggregation Only include "open for all" fragments * add test_query_latest_skips_restricted_fragments * Correct AfO Register query * Correct format of AfO Register Query * Add Chicago numbers to Fragment (#564) * Add Aro Folios (#565) * remove push to old registry (#566) * genres add Qutāru (#567) * Update Scope format (#570) * update ScopeField * update function call * update test data * update match_user_scopes * Reformatting * add connection limit * Switch to ruff (#571) * install ruff * reformat files * fix mocking calls to user profile * suppress "Unable to concatenate tuple [60]" error * fix formatting error * refactor * update tasks * use ruff for linting and formatting * remove old config file * bugfix * add ruff * replace tuple() with () * remove C408 from ignored rules * replace `tuple()` with literal `()` and reformat * Adapted tests * Reformatting --------- Co-authored-by: fsimonjetz <[email protected]> Co-authored-by: Enrique Jiménez <[email protected]> Co-authored-by: Enrique Jiménez <[email protected]> Co-authored-by: zsomborfoldi <[email protected]> Co-authored-by: fsimonjetz <[email protected]>
ElectronicBabylonianLiterature · Aug 6, 2024 · b46c5ee · b46c5ee
1 parent 759e74c
commit b46c5ee
Show file tree

Hide file tree

Showing 11 changed files with 143 additions and 5 deletions.
diff --git a/ebl/fragmentarium/application/fragment_schema.py b/ebl/fragmentarium/application/fragment_schema.py
@@ -237,7 +237,4 @@ def make_fragment(self, data, **kwargs):
 
     @post_dump
     def filter_none(self, data, **kwargs) -> dict:
-        scope = data.get("authorizedScopes")
-        if scope is not None and len(scope) == 0:
-            data.pop("authorizedScopes")
         return pydash.omit_by(data, pydash.is_none)
diff --git a/ebl/fragmentarium/application/fragment_updater.py b/ebl/fragmentarium/application/fragment_updater.py
@@ -1,3 +1,4 @@
+from enum import Enum
 from typing import Sequence, Tuple, Optional
 
 from ebl.bibliography.application.bibliography import Bibliography
@@ -117,6 +118,14 @@ def update_genres(
 
         return self._create_result(updated_fragment)
 
+    def update_scopes(
+        self, number: MuseumNumber, scopes: Sequence[Enum]
+    ) -> Tuple[Fragment, bool]:
+        fragment = self._repository.query_by_museum_number(number)
+        updated_fragment = fragment.set_scopes(scopes)
+        self._repository.update_field("authorized_scopes", updated_fragment)
+        return self._create_result(updated_fragment)
+
     def update_lemmatization(
         self, number: MuseumNumber, lemmatization: Lemmatization, user: User
     ) -> Tuple[Fragment, bool]:

diff --git a/ebl/fragmentarium/domain/fragment.py b/ebl/fragmentarium/domain/fragment.py
@@ -1,3 +1,4 @@
+from enum import Enum
 from itertools import groupby
 from typing import Optional, Sequence, Tuple
 
@@ -209,6 +210,9 @@ def update_transliteration(
     def set_genres(self, genres_new: Sequence[Genre]) -> "Fragment":
         return attr.evolve(self, genres=tuple(genres_new))
 
+    def set_scopes(self, scopes_new: Sequence[Enum]) -> "Fragment":
+        return attr.evolve(self, authorized_scopes=list(scopes_new))
+
     def set_date(self, date_new: Optional[Date]) -> "Fragment":
         return attr.evolve(self, date=date_new)
 

diff --git a/ebl/fragmentarium/infrastructure/mongo_fragment_repository.py b/ebl/fragmentarium/infrastructure/mongo_fragment_repository.py
@@ -89,6 +89,9 @@ def update_field(self, field, fragment):
             "date": ("date",),
             "dates_in_text": ("dates_in_text",),
             "colophon": ("colophon",),
+            "authorized_scopes": [
+                "authorized_scopes",
+            ],
         }
 
         if field not in fields_to_update:

diff --git a/ebl/fragmentarium/web/bootstrap.py b/ebl/fragmentarium/web/bootstrap.py
@@ -20,6 +20,7 @@
 from ebl.fragmentarium.web.fragment_pager import make_fragment_pager_resource
 from ebl.fragmentarium.web.fragment_search import FragmentSearch
 from ebl.fragmentarium.web.fragments import (
+    FragmentAuthorizedScopesResource,
     FragmentsQueryResource,
     FragmentsResource,
     FragmentsListResource,
@@ -112,6 +113,9 @@ def create_fragmentarium_routes(api: falcon.App, context: Context):
     transliteration = TransliterationResource(
         updater, context.get_transliteration_update_factory()
     )
+    scopes = FragmentAuthorizedScopesResource(
+        context.fragment_repository, finder, updater
+    )
     introduction = IntroductionResource(updater)
     archaeology = ArchaeologyResource(updater)
     colophon = ColophonResource(updater)
@@ -164,6 +168,7 @@ def create_fragmentarium_routes(api: falcon.App, context: Context):
         ("/fragments/all-signs", all_signs),
         ("/fragments/colophon-names", colophon_names),
         ("/findspots", findspots),
+        ("/fragments/{number}/scopes", scopes),
     ]
 
     for uri, resource in routes:

diff --git a/ebl/fragmentarium/web/fragments.py b/ebl/fragmentarium/web/fragments.py
@@ -18,7 +18,9 @@
 from ebl.files.application.file_repository import FileRepository
 from ebl.fragmentarium.application.fragment_finder import FragmentFinder
 from ebl.fragmentarium.application.fragment_repository import FragmentRepository
+from ebl.fragmentarium.application.fragment_updater import FragmentUpdater
 from ebl.fragmentarium.web.dtos import create_response_dto, parse_museum_number
+from ebl.schemas import ScopeField
 from ebl.transliteration.application.museum_number_schema import MuseumNumberSchema
 from ebl.transliteration.application.text_schema import TextSchema
 from ebl.transliteration.application.transliteration_query_factory import (
@@ -107,6 +109,34 @@ def on_get(self, req: Request, resp: Response):
         )
 
 
+class FragmentAuthorizedScopesResource:
+    def __init__(
+        self,
+        repository: FragmentRepository,
+        finder: FragmentFinder,
+        updater: FragmentUpdater,
+    ):
+        self._repository = repository
+        self._finder = finder
+        self._updater = updater
+
+    @falcon.before(require_fragment_read_scope)
+    def on_post(self, req: Request, resp: Response, number: str) -> None:
+        try:
+            user = req.context.user
+            updated_fragment, has_photo = self._updater.update_scopes(
+                parse_museum_number(number),
+                [
+                    ScopeField()._deserialize_enum(scope)
+                    for scope in req.media["authorized_scopes"]
+                ],
+            )
+            resp.status = falcon.HTTP_200
+            resp.media = create_response_dto(updated_fragment, user, has_photo)
+        except ValueError as error:
+            raise DataError(error)
+
+
 class FragmentsListResource:
     def __init__(
         self,

diff --git a/ebl/tests/fragmentarium/test_dtos.py b/ebl/tests/fragmentarium/test_dtos.py
@@ -116,6 +116,7 @@ def expected_dto(lemmatized_fragment, has_photo):
             "projects": [ResearchProject["CAIC"].abbreviation],
             "archaeology": ArchaeologySchema().dump(lemmatized_fragment.archaeology),
             "colophon": ColophonSchema().dump(lemmatized_fragment.colophon),
+            "authorizedScopes": [],
         },
         pydash.is_none,
     )

diff --git a/ebl/tests/fragmentarium/test_fragment_repository.py b/ebl/tests/fragmentarium/test_fragment_repository.py
@@ -385,6 +385,18 @@ def test_update_genres(fragment_repository):
     assert result == updated_fragment
 
 
+def test_update_scopes(
+    fragment_repository,
+):
+    fragment = FragmentFactory.build(authorized_scopes=[])
+    fragment_repository.create(fragment)
+    scopes = [Scope.READ_CAIC_FRAGMENTS]
+    updated_fragment = fragment.set_scopes(scopes)
+    fragment_repository.update_field("authorized_scopes", updated_fragment)
+    result = fragment_repository.query_by_museum_number(fragment.number)
+    assert result == updated_fragment
+
+
 def test_update_date(fragment_repository):
     fragment = FragmentFactory.build(date=None)
     fragment_repository.create(fragment)

diff --git a/ebl/tests/fragmentarium/test_fragment_scope.py b/ebl/tests/fragmentarium/test_fragment_scope.py
@@ -0,0 +1,57 @@
+import json
+
+import falcon
+import pytest
+
+from ebl.common.domain.scopes import Scope
+from ebl.schemas import ScopeField
+from ebl.fragmentarium.web.dtos import create_response_dto
+from ebl.tests.factories.fragment import FragmentFactory
+
+
+@pytest.mark.parametrize(
+    "parameters",
+    [
+        {
+            "currentScopes": [],
+            "newScopes": [Scope.READ_CAIC_FRAGMENTS],
+        },
+        {
+            "currentScopes": [Scope.READ_CAIC_FRAGMENTS],
+            "newScopes": [
+                Scope.READ_ITALIANNINEVEH_FRAGMENTS,
+                Scope.READ_CAIC_FRAGMENTS,
+            ],
+        },
+        {
+            "currentScopes": [Scope.READ_CAIC_FRAGMENTS],
+            "newScopes": [],
+        },
+    ],
+)
+def test_update_scopes(client, fragmentarium, user, parameters):
+    fragment = FragmentFactory.build(authorized_scopes=parameters["currentScopes"])
+    fragment_number = fragmentarium.create(fragment)
+    updates = {"authorized_scopes": parameters["newScopes"]}
+    json_updates = {
+        "authorized_scopes": [
+            ScopeField()._serialize_enum(scope)
+            for scope in parameters["newScopes"]
+            if scope
+        ]
+    }
+    post_result = client.simulate_post(
+        f"/fragments/{fragment_number}/scopes", body=json.dumps(json_updates)
+    )
+    expected_json = {
+        **create_response_dto(
+            fragment.set_scopes(updates["authorized_scopes"]),
+            user,
+            fragment.number == "K.1",
+        )
+    }
+    assert post_result.status == falcon.HTTP_OK
+    assert post_result.json == expected_json
+
+    get_result = client.simulate_get(f"/fragments/{fragment_number}")
+    assert get_result.json == expected_json
diff --git a/ebl/tests/fragmentarium/test_fragment_updater.py b/ebl/tests/fragmentarium/test_fragment_updater.py
@@ -1,3 +1,4 @@
+from ebl.common.domain.scopes import Scope
 from freezegun import freeze_time
 import pytest
 
@@ -136,6 +137,25 @@ def test_update_genres(
     assert result == (injected_fragment, False)
 
 
+def test_update_scopes(
+    fragment_updater, fragment_repository, user, parallel_line_injector, when
+):
+    fragment = FragmentFactory.build()
+    number = fragment.number
+    scopes = [Scope.READ_CAIC_FRAGMENTS]
+    updated_fragment = fragment.set_scopes(scopes)
+    injected_fragment = updated_fragment.set_text(
+        parallel_line_injector.inject_transliteration(updated_fragment.text)
+    )
+    when(fragment_repository).query_by_museum_number(number).thenReturn(fragment)
+    when(fragment_repository).update_field(
+        "authorized_scopes", updated_fragment
+    ).thenReturn()
+    result = fragment_updater.update_scopes(number, scopes)
+
+    assert result == (injected_fragment, False)
+
+
 def test_update_date(
     fragment_updater, user, fragment_repository, parallel_line_injector, changelog, when
 ):

diff --git a/ebl/tests/fragmentarium/test_fragments_route.py b/ebl/tests/fragmentarium/test_fragments_route.py
@@ -114,5 +114,5 @@ def test_fragments_retrieve_all(guest_client, fragmentarium):
         fragmentarium.create(fragment)
     result = guest_client.simulate_get("/fragments/retrieve-all?skip=0")
     assert result.status == falcon.HTTP_OK
-    assert len(result.json["fragments"]) == 5
-    assert result.json["totalCount"] == 5
+    assert len(result.json["fragments"]) == 0
+    assert result.json["totalCount"] == 0