ds-caselaw-marklogic-api-client 39.2.1__py3-none-any.whl → 40.0.0__py3-none-any.whl

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,

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,12 +426,25 @@ 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",
         )
+
+        ## Send the document off for enrichment, but accept if we can't for any reason
         self.enrich(accept_failures=True)
 
     def unpublish(self) -> None:

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:

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)

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

{ds_caselaw_marklogic_api_client-39.2.1.dist-info → ds_caselaw_marklogic_api_client-40.0.0.dist-info}/METADATA

@@ -1,13 +1,11 @@
 Metadata-Version: 2.3
 Name: ds-caselaw-marklogic-api-client
-Version: 39.2.1
+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.1.dist-info → ds_caselaw_marklogic_api_client-40.0.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-caselawclient/Client.py,sha256=rcdgfEJ5N_Ajryf8CFHBlEWqvRB7J5IxqE1tCcudTqU,45496
+caselawclient/Client.py,sha256=tof_riZN5c1x3_cYScfIDiGaPIYt1EuAtKOpg3qI_cg,46880
 caselawclient/__init__.py,sha256=QZtsOB_GR5XfFnWMJ6E9_fBany-JXFIrQmzs1mD_KVg,1225
 caselawclient/client_helpers/__init__.py,sha256=eucyUXwUqI72TPw-C5zLcHlMu4GtFY507a6lQc03lQY,5053
 caselawclient/client_helpers/search_helpers.py,sha256=R99HyRLeYHgsw2L3DOidEqlKLLvs6Tga5rKTuWQViig,1525
@@ -7,7 +7,7 @@ caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
 caselawclient/factories.py,sha256=eGj9TiZpmF3todW-08Ps7bHNMvByHqwEbgujRhvU_Yc,7382
 caselawclient/identifier_resolution.py,sha256=B5I1sD7o7YjzsXMECjbKjgiGLDda5bGhejsJ-lYpTIg,2429
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=5hnKWzuj6fXCHf7jGKg_uolI_iKt6yLb9FMl_yWQ84o,21681
+caselawclient/models/documents/__init__.py,sha256=ugbklabbI1LcoN5mE6rffYDApUOtkTXBzYH3Rv2fhBE,22667
 caselawclient/models/documents/body.py,sha256=O1ZTV3KHo-YNi7Syd4oCV1CVSuRF7mcLXojwshyY4jg,6601
 caselawclient/models/documents/comparison.py,sha256=KwFZQByOcYcZKe8csjAntttACKq4BZb28n2VeV5rK54,1355
 caselawclient/models/documents/exceptions.py,sha256=te7PPQTDHjZ9EYVg5pVaiZfF00lMBFy333PHj8_mkC4,443
@@ -32,7 +32,7 @@ caselawclient/models/utilities/move.py,sha256=MXdUqkSiyqRb8YKs_66B6ICWn8EWM6DiJV
 caselawclient/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 caselawclient/responses/__init__.py,sha256=2-5NJn_PXPTje_W4dHeHYaNRN6vXK4UcB9eLLNUAKa4,67
 caselawclient/responses/search_response.py,sha256=Z76Zj4VvM-EV_vdiehv2-Jfkr9HZD3SvCTlRrUB_cyE,1951
-caselawclient/responses/search_result.py,sha256=gjSpnfygw9mEgKa3_sL-6O8JkGYSyxmrPpwwMMuf-ZQ,9416
+caselawclient/responses/search_result.py,sha256=glcoCeo2xO-17aV2pcpyfgl0_UjjEUqHfm2kVylXCwk,9782
 caselawclient/responses/xsl/search_match.xsl,sha256=4Sv--MrwBd7J48E9aI7jlFSXGlNi4dBqgzJ3bdMJ_ZU,1018
 caselawclient/search_parameters.py,sha256=A-9icXdyFYLDACjUaRQF8mrnaVRlFJ9XCPtu5uZ-_Lo,3484
 caselawclient/types.py,sha256=5lE_0kRd7ZMUkr53Rh4ooo74Ab8JTXnMo8rNrwn_HUo,2578
@@ -68,6 +68,7 @@ caselawclient/xquery/list_judgment_versions.xqy,sha256=WShga8igeD21hSLfVSvCOiDMP
 caselawclient/xquery/resolve_from_identifier_slug.xqy,sha256=jMaOugdG1XVQIk9AR5NOth8D2RS8VEUJuBwjO9j4MFM,485
 caselawclient/xquery/resolve_from_identifier_value.xqy,sha256=7uP3DnRi67qSp0aUhW6Cv_GA8BQGw6GuvtAghjrT7Z4,493
 caselawclient/xquery/set_boolean_property.xqy,sha256=8Vg3yDWqeDynUJQHw2OF4daDIKTnp8ARol1_OCqY0Dk,355
+caselawclient/xquery/set_datetime_property.xqy,sha256=61NuWft1DlpROwdkDLHJ2rcHDqKAFoD45XQ_nmdBkLY,356
 caselawclient/xquery/set_metadata_citation.xqy,sha256=ImwijXowvOCiH_br_LepnKsEpys9tg4Cf3uz6MoC5-c,659
 caselawclient/xquery/set_metadata_court.xqy,sha256=xQGR3e4pdJuDPMlzdAdzrBDSeQbEFiLVIm2z_KQI_Ds,996
 caselawclient/xquery/set_metadata_jurisdiction.xqy,sha256=7iG1uFZOme0_d1hkzLJ870ot_ioFnSwDROfA-_yGtN8,1059
@@ -84,10 +85,10 @@ caselawclient/xquery/validate_all_documents.xqy,sha256=z_0YEXmRcZ-FaJM0ouKiTjdI4
 caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21qkJrvY1RtNP7eA,140
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=cccaFiGkCcvSfDv007UriZ3I4ak2nTLP1trRZdbOoS8,2462
-caselawclient/xquery_type_dicts.py,sha256=zuyDGTkcN6voOXCm3APXItZ-Ey6tZ2hdZummZWzjl50,6489
+caselawclient/xquery_type_dicts.py,sha256=ROwV-BpQYDOrtW6aKx5MXVi85SW5J5oGgyQT7-Ra1sA,6633
 caselawclient/xslt/modify_xml_live.xsl,sha256=gNjwBun2-UzOeeuf0wNjFtN3jXm1yrwqv_KT8r1slXw,2370
 caselawclient/xslt/sample.xsl,sha256=IG-v77stjwqiw25pguh391K-5DTKiX651WqILDZixm0,825
-ds_caselaw_marklogic_api_client-39.2.1.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-39.2.1.dist-info/METADATA,sha256=EiKB1ULoiBebeYY-lr9xAJ8UQUpH9K0DdvL1zZK0w0E,4466
-ds_caselaw_marklogic_api_client-39.2.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-ds_caselaw_marklogic_api_client-39.2.1.dist-info/RECORD,,
+ds_caselaw_marklogic_api_client-40.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-40.0.0.dist-info/METADATA,sha256=Nxrgxi6sCKcfetI5h5k0PcwLkkkUQYs2e8nbtj-PUQY,4364
+ds_caselaw_marklogic_api_client-40.0.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ds_caselaw_marklogic_api_client-40.0.0.dist-info/RECORD,,