ds-caselaw-marklogic-api-client 39.2.0__tar.gz → 40.0.0__tar.gz

{ds_caselaw_marklogic_api_client-39.2.0 → ds_caselaw_marklogic_api_client-40.0.0}/PKG-INFO

@@ -1,13 +1,11 @@
 Metadata-Version: 2.3
 Name: ds-caselaw-marklogic-api-client
-Version: 39.2.0
+Version: 40.0.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Keywords: national archives,caselaw
 Author: The National Archives
-Requires-Python: >=3.10.0,<4.0.0
+Requires-Python: >=3.12.0,<4.0.0
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: boto3 (>=1.26.112,<2.0.0)

{ds_caselaw_marklogic_api_client-39.2.0 → ds_caselaw_marklogic_api_client-40.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ds-caselaw-marklogic-api-client"
-version = "39.2.0"
+version = "40.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"
@@ -11,7 +11,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.10.0"
+python = "^3.12.0"
 certifi = ">=2025.8.3,<2025.9.0"
 charset-normalizer = "^3.0.0"
 django-environ = ">=0.12.0"
@@ -32,14 +32,14 @@ sqids = "^0.5.0"
 defusedxml = "^0.7.1"
 
 [tool.poetry.group.dev.dependencies]
-coverage = "7.10.3"
+coverage = "7.10.4"
 pytest = "8.4.1"
 pytest-cov = "6.2.1"
 beautifulsoup4 = "4.13.4"
 responses = "0.25.8"
 python-dotenv = "1.1.1"
 time-machine = "2.17.0"
-moto = {version = "5.1.9", extras = ["all"]}
+moto = {version = "5.1.10", extras = ["all"]}
 
 [tool.poetry.group.docs]
 optional = true

{ds_caselaw_marklogic_api_client-39.2.0 → ds_caselaw_marklogic_api_client-40.0.0}/src/caselawclient/Client.py

@@ -11,6 +11,7 @@ from xml.etree.ElementTree import Element
 
 import environ
 import requests
+from dateutil.parser import isoparse
 from defusedxml import ElementTree
 from defusedxml.ElementTree import ParseError, fromstring
 from ds_caselaw_utils.types import NeutralCitationString
@@ -948,12 +949,50 @@ class MarklogicApiClient:
             "value": string_value,
             "name": name,
         }
+        """
+        Set a property within MarkLogic which is specifically a boolean.
+
+        Since XML has no concept of boolean, the actual value in the database is set to `"true"` or `"false"`.
+        """
         return self._send_to_eval(vars, "set_boolean_property.xqy")
 
     def get_boolean_property(self, judgment_uri: DocumentURIString, name: str) -> bool:
+        """
+        Get a property from MarkLogic which is specifically a boolean.
+
+        :return: `True` if the property exists and has a value of `"true"`, otherwise `False`
+        """
         content = self.get_property(judgment_uri, name)
         return content == "true"
 
+    def set_datetime_property(
+        self,
+        judgment_uri: DocumentURIString,
+        name: str,
+        value: datetime,
+    ) -> requests.Response:
+        """Set a property within MarkLogic which is specifically a datetime."""
+        uri = self._format_uri_for_marklogic(judgment_uri)
+        vars: query_dicts.SetDatetimePropertyDict = {
+            "uri": uri,
+            "value": value.isoformat(),
+            "name": name,
+        }
+        return self._send_to_eval(vars, "set_datetime_property.xqy")
+
+    def get_datetime_property(self, judgment_uri: DocumentURIString, name: str) -> Optional[datetime]:
+        """
+        Get a property from MarkLogic which is specifically a datetime.
+
+        :return: A datetime with the value of the property, or `None` if it does not exist
+        """
+        content = self.get_property(judgment_uri, name)
+
+        if content:
+            return isoparse(content)
+
+        return None
+
     def set_published(
         self,
         judgment_uri: DocumentURIString,

{ds_caselaw_marklogic_api_client-39.2.0 → ds_caselaw_marklogic_api_client-40.0.0}/src/caselawclient/models/documents/__init__.py

@@ -305,6 +305,14 @@ class Document:
         # An empty list (which is falsy) therefore means the judgment can be published safely.
         return not self.validation_failure_messages
 
+    @cached_property
+    def first_published_datetime(self) -> Optional[datetime.datetime]:
+        return self.api_client.get_datetime_property(self.uri, "first_published_datetime")
+
+    @cached_property
+    def has_ever_been_published(self) -> bool:
+        return self.is_published or self.first_published_datetime is not None
+
     @cached_property
     def validation_failure_messages(self) -> list[str]:
         exception_list = []
@@ -407,6 +415,8 @@ class Document:
 
     def publish(self) -> None:
         """
+        Assuming that a document passes pre-publish checks, perform all necessary operations to put it into a published state.
+
         :raises CannotPublishUnpublishableDocument: This document has not passed the checks in `is_publishable`, and as
         such cannot be published.
         """
@@ -416,13 +426,26 @@ class Document:
         ## Make sure the document has an FCLID
         self.assign_fclid_if_missing()
 
+        ## Copy the document assets into the appropriate place in S3
         publish_documents(self.uri)
+
+        ## Set the fact the document is published
         self.api_client.set_published(self.uri, True)
+
+        ## If necessary, set the first published date
+        if not self.first_published_datetime:
+            self.api_client.set_datetime_property(
+                self.uri, "first_published_datetime", datetime.datetime.now(datetime.timezone.utc)
+            )
+
+        ## Announce the publication on the event bus
         announce_document_event(
             uri=self.uri,
             status="publish",
         )
-        self.enrich()
+
+        ## Send the document off for enrichment, but accept if we can't for any reason
+        self.enrich(accept_failures=True)
 
     def unpublish(self) -> None:
         self.api_client.break_checkout(self.uri)

{ds_caselaw_marklogic_api_client-39.2.0 → ds_caselaw_marklogic_api_client-40.0.0}/src/caselawclient/responses/search_result.py

@@ -13,6 +13,8 @@ from lxml import etree
 
 from caselawclient.Client import MarklogicApiClient
 from caselawclient.models.identifiers.collection import IdentifiersCollection
+from caselawclient.models.identifiers.neutral_citation import NeutralCitationNumber
+from caselawclient.models.identifiers.press_summary_ncn import PressSummaryRelatedNCNIdentifier
 from caselawclient.models.identifiers.unpacker import unpack_all_identifiers_from_etree
 from caselawclient.types import DocumentURIString
 from caselawclient.xml_helpers import get_xpath_match_string
@@ -196,14 +198,18 @@ class SearchResult:
         return str(preferred.url_slug)
 
     @property
-    def neutral_citation(self) -> str:
+    def neutral_citation(self) -> Optional[str]:
         """
-        :return: The neutral citation of the search result, or the judgment it is a press summary of.
+        :return: If present, the value of preferred neutral citation of the document.
         """
 
-        return self._get_xpath_match_string(
-            "search:extracted/uk:cite/text()",
-        ) or self._get_xpath_match_string("search:extracted/akn:neutralCitation/text()")
+        preferred_ncn = self.identifiers.preferred(type=NeutralCitationNumber)
+
+        # If the result doesn't have a preferred NCN, maybe it has a preferred press summary related NCN?
+        if not preferred_ncn:
+            preferred_ncn = self.identifiers.preferred(type=PressSummaryRelatedNCNIdentifier)
+
+        return preferred_ncn.value if preferred_ncn else None
 
     @property
     def name(self) -> str:

ds_caselaw_marklogic_api_client-40.0.0/src/caselawclient/xquery/set_datetime_property.xqy

@@ -0,0 +1,11 @@
+xquery version "1.0-ml";
+
+import module namespace dls = "http://marklogic.com/xdmp/dls" at "/MarkLogic/dls.xqy";
+
+declare variable $uri as xs:string external;
+declare variable $value as xs:string external;
+declare variable $name as xs:string external;
+
+let $props := ( element {$name}{xs:dateTime($value)} )
+
+return dls:document-set-property($uri, $props)

{ds_caselaw_marklogic_api_client-39.2.0 → ds_caselaw_marklogic_api_client-40.0.0}/src/caselawclient/xquery_type_dicts.py

@@ -166,6 +166,13 @@ class SetBooleanPropertyDict(MarkLogicAPIDict):
     value: str
 
 
+# set_datetime_property.xqy
+class SetDatetimePropertyDict(MarkLogicAPIDict):
+    name: str
+    uri: MarkLogicDocumentURIString
+    value: str
+
+
 # set_metadata_citation.xqy
 class SetMetadataCitationDict(MarkLogicAPIDict):
     content: str