ds-caselaw-marklogic-api-client 18.0.0__tar.gz → 19.0.0__tar.gz

{ds_caselaw_marklogic_api_client-18.0.0 → ds_caselaw_marklogic_api_client-19.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 18.0.0
+Version: 19.0.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw

{ds_caselaw_marklogic_api_client-18.0.0 → ds_caselaw_marklogic_api_client-19.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ds-caselaw-marklogic-api-client"
-version = "18.0.0"
+version = "19.0.0"
 description = "An API client for interacting with the underlying data in Find Caselaw."
 authors = ["The National Archives"]
 homepage = "https://github.com/nationalarchives/ds-caselaw-custom-api-client"

{ds_caselaw_marklogic_api_client-18.0.0 → ds_caselaw_marklogic_api_client-19.0.0}/src/caselawclient/Client.py

@@ -795,7 +795,7 @@ class MarklogicApiClient:
         return content == "true"
 
     def set_published(
-        self, judgment_uri: DocumentURIString, published: bool = False
+        self, judgment_uri: DocumentURIString, published: bool
     ) -> requests.Response:
         return self.set_boolean_property(judgment_uri, "published", published)
 
@@ -951,3 +951,21 @@ class MarklogicApiClient:
         )
 
         return results
+
+    def get_pending_enrichment_for_version(
+        self, target_version: int
+    ) -> list[list[Any]]:
+        """Retrieve documents which are not yet enriched with a given version."""
+        vars: query_dicts.GetPendingEnrichmentForVersionDict = {
+            "target_version": target_version
+        }
+        results: list[list[Any]] = json.loads(
+            get_single_string_from_marklogic_response(
+                self._send_to_eval(
+                    vars,
+                    "get_pending_enrichment_for_version.xqy",
+                )
+            )
+        )
+
+        return results

{ds_caselaw_marklogic_api_client-18.0.0 → ds_caselaw_marklogic_api_client-19.0.0}/src/caselawclient/models/documents.py

@@ -458,8 +458,13 @@ class Document:
 
     def enrich(self) -> None:
         """
-        Announces to the ANNOUNCE SNS that the document is waiting to be enriched.
+        Request enrichment of the document
         """
+
+        self.api_client.set_property(
+            self.uri, "last_sent_to_enrichment", datetime.datetime.now().isoformat()
+        )
+
         announce_document_event(
             uri=self.uri,
             status="enrich",

ds_caselaw_marklogic_api_client-19.0.0/src/caselawclient/xquery/get_pending_enrichment_for_version.xqy

@@ -0,0 +1,18 @@
+xquery version "1.0-ml";
+
+declare variable $target_version as xs:int external;
+
+xdmp:to-json(xdmp:sql(
+  "SELECT process_data.uri, enrich_version_string, minutes_since_enrichment_request
+  FROM (
+    SELECT process_data.uri, enrich_version_string, enrich_major_version, DATEDIFF('minute', last_sent_to_enrichment, CURRENT_TIMESTAMP) AS minutes_since_enrichment_request
+    FROM documents.process_data
+    JOIN documents.process_property_data ON process_data.uri = process_property_data.uri
+  )
+  WHERE ((enrich_version_string IS NULL) OR (enrich_major_version < @target_version))
+  AND (minutes_since_enrichment_request > 43200 OR minutes_since_enrichment_request IS NULL)
+  ORDER BY enrich_major_version ASC NULLS FIRST",
+  "array",
+  map:new(map:entry("target_version", $target_version))
+))
+

{ds_caselaw_marklogic_api_client-18.0.0 → ds_caselaw_marklogic_api_client-19.0.0}/src/caselawclient/xquery_type_dicts.py

@@ -78,6 +78,11 @@ class GetLastModifiedDict(MarkLogicAPIDict):
     uri: MarkLogicDocumentURIString
 
 
+# get_pending_enrichment_for_version.xqy
+class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
+    target_version: int
+
+
 # get_properties_for_search_results.xqy
 class GetPropertiesForSearchResultsDict(MarkLogicAPIDict):
     uris: list[Any]