ds-caselaw-marklogic-api-client 18.0.0__py3-none-any.whl → 19.0.0__py3-none-any.whl

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

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",

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))
+))
+

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]

{ds_caselaw_marklogic_api_client-18.0.0.dist-info → ds_caselaw_marklogic_api_client-19.0.0.dist-info}/METADATA

@@ -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.dist-info → ds_caselaw_marklogic_api_client-19.0.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
-caselawclient/Client.py,sha256=c8DvbUAhBGpraD5oj1sVOtkco-j6Vq1zG5zshAOiuHI,34589
+caselawclient/Client.py,sha256=ta7VC6xxC9zLmcZvjcf-V8HonvC60G4WMfppYctXKq0,35180
 caselawclient/__init__.py,sha256=DY-caubLDQWWingSdsBWgovDNXh8KcnkI6kwz08eIFk,612
 caselawclient/client_helpers/__init__.py,sha256=6vUjIwi777iaNDBUYwWmpzgAXeFHeXnmmMBniVmjUP8,3830
 caselawclient/client_helpers/search_helpers.py,sha256=DYgUltPq8fFI2KkLRqH1-8zpbb8_swBFyBvvgBbinig,1514
 caselawclient/content_hash.py,sha256=DF7ujrQPNf1bTSbK0mIIaC5qx6CmF5I0xlQ7uIG0zYI,2236
 caselawclient/errors.py,sha256=3rsbOQ11hIhm7-UABcHNMcs9XgcrIzytAP0koyZBLWM,3195
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents.py,sha256=qiIb2sKBL_sbrAOwRI62MWM6V0GRXndzxWbfx4XbQbA,19447
+caselawclient/models/documents.py,sha256=gZGXBBzuTQdOAiQ86yn_v91ycUisMEAAa5lQvz821j0,19542
 caselawclient/models/judgments.py,sha256=TcAsn27K--QQAfaaUZ8biybB9OeVS__91FRlwaG16HY,1020
 caselawclient/models/neutral_citation_mixin.py,sha256=qqB1K4IHVy0XvdY40sfVywZ6VGaZ9ojHcVOQRyi0Vhc,1752
 caselawclient/models/press_summaries.py,sha256=5c1jpVhVtmIMN8AeHMywGXvz4H55kKAIUaaaVims6Tw,994
@@ -32,6 +32,7 @@ caselawclient/xquery/get_judgment.xqy,sha256=xg66A1xslgwds670gu_9DFcOmxYGoo8sA2E
 caselawclient/xquery/get_judgment_checkout_status.xqy,sha256=mdY9UXLyzQdB7byEERPqentlr0YDLbXRVqH0h4UuZTQ,193
 caselawclient/xquery/get_judgment_version.xqy,sha256=wF9k9-CBrqo8VbxxyTrD-AGzR3-3jMm25tRVCjxPLrU,292
 caselawclient/xquery/get_last_modified.xqy,sha256=8fCm_7o_kkytCEmEeSTLWzLP7iOjuPV01IfHDgf6HaQ,172
+caselawclient/xquery/get_pending_enrichment_for_version.xqy,sha256=z4_I9qdPJOi03zWpkWNb5uHWchco-tl9i9S_6UmQMiU,794
 caselawclient/xquery/get_properties_for_search_results.xqy,sha256=Tlv3EKwVV_q-JyQyhjWVHIleicPDpucxP4ScuQjpgSw,625
 caselawclient/xquery/get_property.xqy,sha256=RHlOTrK0aH-S7s_ykYzGmUeKOJxXlI4vE5sKRt556NY,209
 caselawclient/xquery/get_version_annotation.xqy,sha256=pFDMGA9SxI59iUPaoAeUsq23kUp4Op7cUg-PFNFqxcI,262
@@ -52,8 +53,8 @@ caselawclient/xquery/user_has_role.xqy,sha256=52YuFZnXqaDDJs-j_UanpqcLNEiw_m9xb0
 caselawclient/xquery/validate_all_documents.xqy,sha256=z_0YEXmRcZ-FaJM0ouKiTjdI4tLKQ4FTssRihR07qFk,156
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=smyFFxqmtkuOzBd2l7uw6K2oAsYctudrP8omdv_XNAM,2463
-caselawclient/xquery_type_dicts.py,sha256=MZwjEURV_s-USIeX_qr_5VXcfswwoBgFQdw1ITVmtwQ,4726
-ds_caselaw_marklogic_api_client-18.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-18.0.0.dist-info/METADATA,sha256=mXQ4jemxpauxmDZMzRDXYgN0_Qc-dyWfxWCZl7bVY-A,4006
-ds_caselaw_marklogic_api_client-18.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-18.0.0.dist-info/RECORD,,
+caselawclient/xquery_type_dicts.py,sha256=F2kXvXuLUzBK0ZQqZfvYean9WftlNQcLaQj1hfAHNa0,4853
+ds_caselaw_marklogic_api_client-19.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-19.0.0.dist-info/METADATA,sha256=S7gaZixMqntVtAPgBDMcKfSEgTHEs2ZYWP-Tkl36FiU,4006
+ds_caselaw_marklogic_api_client-19.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-19.0.0.dist-info/RECORD,,