ds-caselaw-marklogic-api-client 29.1.1__py3-none-any.whl → 29.2.0__py3-none-any.whl

caselawclient/models/documents/__init__.py

@@ -29,7 +29,6 @@ from caselawclient.models.utilities.aws import (
     publish_documents,
     request_parse,
     unpublish_documents,
-    uri_for_s3,
 )
 
 from .body import DocumentBody
@@ -216,11 +215,11 @@ class Document:
 
     @property
     def docx_url(self) -> str:
-        return generate_docx_url(uri_for_s3(self.uri))
+        return generate_docx_url(self.uri)
 
     @property
     def pdf_url(self) -> str:
-        return generate_pdf_url(uri_for_s3(self.uri))
+        return generate_pdf_url(self.uri)
 
     @cached_property
     def assigned_to(self) -> str:
@@ -438,7 +437,7 @@ class Document:
             self.identifiers.add(document_fclid)
             self.save_identifiers()
 
-        publish_documents(uri_for_s3(self.uri))
+        publish_documents(self.uri)
         self.api_client.set_published(self.uri, True)
         announce_document_event(
             uri=self.uri,
@@ -448,7 +447,7 @@ class Document:
 
     def unpublish(self) -> None:
         self.api_client.break_checkout(self.uri)
-        unpublish_documents(uri_for_s3(self.uri))
+        unpublish_documents(self.uri)
         self.api_client.set_published(self.uri, False)
         announce_document_event(
             uri=self.uri,

caselawclient/models/neutral_citation_mixin.py

@@ -23,11 +23,6 @@ class NeutralCitationMixin(ABC):
 
     def __init__(self, document_noun: str, *args: Any, **kwargs: Any) -> None:
         self.attributes_to_validate: list[tuple[str, bool, str]] = self.attributes_to_validate + [
-            (
-                "has_ncn",
-                True,
-                f"This {document_noun} has no neutral citation number",
-            ),
             (
                 "has_valid_ncn",
                 True,
@@ -50,4 +45,6 @@ class NeutralCitationMixin(ABC):
     @cached_property
     @deprecated("Legacy usage of NCNs is deprecated; you should be moving to the Identifiers framework")
     def has_valid_ncn(self) -> bool:
-        return self.neutral_citation is not None and neutral_url(self.neutral_citation) is not None
+        if self.neutral_citation is None:
+            return True
+        return neutral_url(self.neutral_citation) is not None

caselawclient/models/utilities/aws.py

@@ -2,7 +2,7 @@ import datetime
 import json
 import logging
 import uuid
-from typing import Any, Literal, Optional, TypedDict, overload
+from typing import TYPE_CHECKING, Any, Literal, Optional, TypedDict, overload
 
 import boto3
 import botocore.client
@@ -13,9 +13,21 @@ from mypy_boto3_sns.client import SNSClient
 from mypy_boto3_sns.type_defs import MessageAttributeValueTypeDef
 from typing_extensions import NotRequired
 
+if TYPE_CHECKING:
+    from caselawclient.models.documents import DocumentURIString
+else:
+    DocumentURIString = None
+
 env = environ.Env()
 
 
+class S3PrefixString(str):
+    def __new__(cls, content: str) -> "S3PrefixString":
+        if content[-1] != "/":
+            raise RuntimeError("S3 Prefixes must end in / so they behave like directories")
+        return str.__new__(cls, content)
+
+
 class ParserInstructionsMetadataDict(TypedDict):
     name: Optional[str]
     cite: Optional[str]
@@ -58,8 +70,9 @@ def create_sns_client() -> SNSClient:
     return create_aws_client("sns")
 
 
-def uri_for_s3(uri: str) -> str:
-    return uri.lstrip("/")
+def uri_for_s3(uri: DocumentURIString) -> S3PrefixString:
+    """An S3 Prefix must end with / to avoid uksc/2004/1 matching uksc/2004/1000"""
+    return S3PrefixString(uri + "/")
 
 
 def generate_signed_asset_url(key: str) -> str:
@@ -79,7 +92,7 @@ def generate_signed_asset_url(key: str) -> str:
     )
 
 
-def check_docx_exists(uri: str) -> bool:
+def check_docx_exists(uri: DocumentURIString) -> bool:
     """Does the docx for a document URI actually exist?"""
     bucket = env("PRIVATE_ASSET_BUCKET", None)
     s3_key = generate_docx_key(uri)
@@ -93,25 +106,25 @@ def check_docx_exists(uri: str) -> bool:
         raise
 
 
-def generate_docx_key(uri: str) -> str:
+def generate_docx_key(uri: DocumentURIString) -> str:
     """from a canonical caselaw URI (eat/2022/1) return the S3 key of the associated docx"""
     return f"{uri}/{uri.replace('/', '_')}.docx"
 
 
-def generate_docx_url(uri: str) -> str:
+def generate_docx_url(uri: DocumentURIString) -> str:
     """from a canonical caselaw URI (eat/2022/1) return a signed S3 link for the front end"""
     return generate_signed_asset_url(generate_docx_key(uri))
 
 
-def generate_pdf_url(uri: str) -> str:
+def generate_pdf_url(uri: DocumentURIString) -> str:
     key = f"{uri}/{uri.replace('/', '_')}.pdf"
 
     return generate_signed_asset_url(key)
 
 
-def delete_from_bucket(uri: str, bucket: str) -> None:
+def delete_from_bucket(uri: DocumentURIString, bucket: str) -> None:
     client = create_s3_client()
-    response = client.list_objects(Bucket=bucket, Prefix=uri)
+    response = client.list_objects(Bucket=bucket, Prefix=uri_for_s3(uri))
 
     if response.get("Contents"):
         objects_to_delete: list[ObjectIdentifierTypeDef] = [{"Key": obj["Key"]} for obj in response.get("Contents", [])]
@@ -123,7 +136,7 @@ def delete_from_bucket(uri: str, bucket: str) -> None:
         )
 
 
-def publish_documents(uri: str) -> None:
+def publish_documents(uri: DocumentURIString) -> None:
     """
     Copy assets from the unpublished bucket to the published one.
     Don't copy parser logs and package tar gz.
@@ -134,7 +147,7 @@ def publish_documents(uri: str) -> None:
     public_bucket = env("PUBLIC_ASSET_BUCKET")
     private_bucket = env("PRIVATE_ASSET_BUCKET")
 
-    response = client.list_objects(Bucket=private_bucket, Prefix=uri)
+    response = client.list_objects(Bucket=private_bucket, Prefix=uri_for_s3(uri))
 
     for result in response.get("Contents", []):
         print(f"Contemplating copying {result!r}")
@@ -152,15 +165,15 @@ def publish_documents(uri: str) -> None:
                 )
 
 
-def unpublish_documents(uri: str) -> None:
+def unpublish_documents(uri: DocumentURIString) -> None:
     delete_from_bucket(uri, env("PUBLIC_ASSET_BUCKET"))
 
 
-def delete_documents_from_private_bucket(uri: str) -> None:
+def delete_documents_from_private_bucket(uri: DocumentURIString) -> None:
     delete_from_bucket(uri, env("PRIVATE_ASSET_BUCKET"))
 
 
-def announce_document_event(uri: str, status: str, enrich: bool = False) -> None:
+def announce_document_event(uri: DocumentURIString, status: str, enrich: bool = False) -> None:
     client = create_sns_client()
 
     message_attributes: dict[str, MessageAttributeValueTypeDef] = {}
@@ -186,17 +199,14 @@ def announce_document_event(uri: str, status: str, enrich: bool = False) -> None
     )
 
 
-def copy_assets(old_uri: str, new_uri: str) -> None:
+def copy_assets(old_uri: DocumentURIString, new_uri: DocumentURIString) -> None:
     """
     Copy *unpublished* assets from one path to another,
     renaming DOCX and PDF files as appropriate.
     """
     client = create_s3_client()
     bucket = env("PRIVATE_ASSET_BUCKET")
-    old_uri = uri_for_s3(old_uri)
-    new_uri = uri_for_s3(new_uri)
-
-    response = client.list_objects(Bucket=bucket, Prefix=old_uri)
+    response = client.list_objects(Bucket=bucket, Prefix=uri_for_s3(old_uri))
 
     for result in response.get("Contents", []):
         old_key = str(result["Key"])
@@ -212,7 +222,7 @@ def copy_assets(old_uri: str, new_uri: str) -> None:
             )
 
 
-def build_new_key(old_key: str, new_uri: str) -> str:
+def build_new_key(old_key: str, new_uri: DocumentURIString) -> str:
     """Ensure that DOCX and PDF filenames are modified to reflect their new home
     as we get the name of the new S3 path"""
     old_filename = old_key.rsplit("/", 1)[-1]
@@ -224,7 +234,7 @@ def build_new_key(old_key: str, new_uri: str) -> str:
 
 
 def request_parse(
-    uri: str,
+    uri: DocumentURIString,
     reference: Optional[str],
     parser_instructions: Optional[ParserInstructionsDict] = None,
 ) -> None:

{ds_caselaw_marklogic_api_client-29.1.1.dist-info → ds_caselaw_marklogic_api_client-29.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 29.1.1
+Version: 29.2.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-29.1.1.dist-info → ds_caselaw_marklogic_api_client-29.2.0.dist-info}/RECORD

@@ -7,7 +7,7 @@ caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
 caselawclient/factories.py,sha256=6-xZMVmvtXA8AnyWJgJTums1EWfM6lPIhrWQu0NopJo,4472
 caselawclient/identifier_resolution.py,sha256=IOqrZcIHoHhNOCAkNveOBcWddBNpkOB8cz1r0zFa8mQ,1829
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=Lzb18MyCPLlG0Y4EdnjZvnGFSSpsNs_BUgJA6BQqL28,19520
+caselawclient/models/documents/__init__.py,sha256=huZ-aQ-tsfuWScqSPkBAAQ9dhYa98fdd5eHwO85s_BQ,19456
 caselawclient/models/documents/body.py,sha256=7Sj6lnddcAM8VAeecAS2VEhQHR9CB3G0fL8TAXz7EXw,5588
 caselawclient/models/documents/exceptions.py,sha256=rw1xId16vBKvBImgFmFUpeFgKqU7VTNtVLIEVBPGKyk,374
 caselawclient/models/documents/statuses.py,sha256=Cp4dTQmJOtsU41EJcxy5dV1841pGD2PNWH0VrkDEv4Q,579
@@ -19,10 +19,10 @@ caselawclient/models/identifiers/neutral_citation.py,sha256=3Jw1_-NmGfGmrWGFSzLd
 caselawclient/models/identifiers/press_summary_ncn.py,sha256=r55-qgi9LDnGxY8vTKijzotGknA6mNLpu55QQTV8Lxo,652
 caselawclient/models/identifiers/unpacker.py,sha256=xvp480QESbN36NEc6qeo-orqOBq6WchnLI7thY7A1qs,2156
 caselawclient/models/judgments.py,sha256=xFjfOspa9ZL29gvvGVNq11JC7h-LKebFMrQYvVIIoEI,1868
-caselawclient/models/neutral_citation_mixin.py,sha256=LDaxNndLcTKsjJCyEKO1kGTJ6YD6h-6SzQVE0-gwPSI,2208
+caselawclient/models/neutral_citation_mixin.py,sha256=jAac3PPuWyPdj9N-n-U_JfwkbgbSIXaqFVQahfu95do,2086
 caselawclient/models/press_summaries.py,sha256=bEqJxu-7eBLhwulOsDXYDl2ptIp3RkkMpOcdVvWB5ds,1836
 caselawclient/models/utilities/__init__.py,sha256=u3yIhbTjFQ1JJyAm5wsMEBswWl4t6Z7UMORF5FqC2xQ,1257
-caselawclient/models/utilities/aws.py,sha256=d-7puHSW8lFLLhaXhAStzNai4_NEMAiPGCNEFUt0Elg,8191
+caselawclient/models/utilities/aws.py,sha256=5UJhxdGwYwH0bswi3q9nzmXcioPz9t_lNWYmP45RyK4,8842
 caselawclient/models/utilities/dates.py,sha256=WwORxVjUHM1ZFcBF6Qtwo3Cj0sATsnSECkUZ6ls1N1Q,492
 caselawclient/models/utilities/move.py,sha256=Rsx1eGHVjbGz0WMVDjy8b_5t4Ig8aP55sLudL07MVUs,3621
 caselawclient/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -78,7 +78,7 @@ caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21q
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=smyFFxqmtkuOzBd2l7uw6K2oAsYctudrP8omdv_XNAM,2463
 caselawclient/xquery_type_dicts.py,sha256=kybL-YzwK34Fr6MeWfqVOJHYrs0ZNeDWXDsp8o2Yb1U,6114
-ds_caselaw_marklogic_api_client-29.1.1.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-29.1.1.dist-info/METADATA,sha256=SaMj0ydb-vZeW6cnwnwr94lGc_XkADBIDeUdWtDlEjM,4264
-ds_caselaw_marklogic_api_client-29.1.1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-29.1.1.dist-info/RECORD,,
+ds_caselaw_marklogic_api_client-29.2.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-29.2.0.dist-info/METADATA,sha256=ALbG5q-13rqmY9R-1lUB7LLUnZppeBT4A9xssTV5skM,4264
+ds_caselaw_marklogic_api_client-29.2.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-29.2.0.dist-info/RECORD,,