ds-caselaw-marklogic-api-client 20.0.0__py3-none-any.whl → 21.0.0__py3-none-any.whl

caselawclient/Client.py

@@ -446,6 +446,24 @@ class MarklogicApiClient:
 
         return self._send_to_eval(vars, "set_metadata_court.xqy")
 
+    def set_document_jurisdiction(
+        self, document_uri: DocumentURIString, content: str
+    ) -> requests.Response:
+        uri = self._format_uri_for_marklogic(document_uri)
+        vars: query_dicts.SetMetadataJurisdictionDict = {"uri": uri, "content": content}
+        return self._send_to_eval(vars, "set_metadata_jurisdiction.xqy")
+
+    def set_document_court_and_jurisdiction(
+        self, document_uri: DocumentURIString, content: str
+    ) -> requests.Response:
+        if "/" in content:
+            court, jurisdiction = re.split("\\s*/\\s*", content)
+            self.set_document_court(document_uri, court)
+            return self.set_document_jurisdiction(document_uri, jurisdiction)
+        else:
+            self.set_document_court(document_uri, content)
+            return self.set_document_jurisdiction(document_uri, "")
+
     def set_judgment_this_uri(
         self, judgment_uri: DocumentURIString
     ) -> requests.Response:
@@ -968,12 +986,16 @@ class MarklogicApiClient:
         return (int(table[1][1]), int(table[1][2]))
 
     def get_pending_enrichment_for_version(
-        self, target_version: tuple[int, int]
+        self,
+        target_enrichment_version: tuple[int, int],
+        target_parser_version: tuple[int, int],
     ) -> list[list[Any]]:
         """Retrieve documents which are not yet enriched with a given version."""
         vars: query_dicts.GetPendingEnrichmentForVersionDict = {
-            "target_major_version": target_version[0],
-            "target_minor_version": target_version[1],
+            "target_enrichment_major_version": target_enrichment_version[0],
+            "target_enrichment_minor_version": target_enrichment_version[1],
+            "target_parser_major_version": target_parser_version[0],
+            "target_parser_minor_version": target_parser_version[1],
         }
         results: list[list[Any]] = json.loads(
             get_single_string_from_marklogic_response(

caselawclient/models/documents.py

@@ -198,6 +198,20 @@ class Document:
             },
         )
 
+    @cached_property
+    def jurisdiction(self) -> str:
+        return self.xml.get_xpath_match_string(
+            "/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:jurisdiction/text()",
+            {
+                "uk": "https://caselaw.nationalarchives.gov.uk/akn",
+                "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
+            },
+        )
+
+    @property
+    def court_and_jurisdiction(self) -> str:
+        return "/".join((self.court, self.jurisdiction))
+
     @cached_property
     def document_date_as_string(self) -> str:
         return self.xml.get_xpath_match_string(
@@ -464,9 +478,9 @@ class Document:
         """
         Request enrichment of the document
         """
-
+        now = datetime.datetime.now(datetime.timezone.utc)
         self.api_client.set_property(
-            self.uri, "last_sent_to_enrichment", datetime.datetime.now().isoformat()
+            self.uri, "last_sent_to_enrichment", now.isoformat()
         )
 
         announce_document_event(
@@ -536,6 +550,9 @@ class Document:
     def reparse(self) -> None:
         "Send an SNS notification that triggers reparsing, also sending all editor-modifiable metadata and URI"
 
+        now = datetime.datetime.now(datetime.timezone.utc)
+        self.api_client.set_property(self.uri, "last_sent_to_parser", now.isoformat())
+
         parser_type_noun = {"judgment": "judgment", "press summary": "pressSummary"}[
             self.document_noun
         ]
@@ -550,13 +567,14 @@ class Document:
         # values are "" from the API, we should pass None instead in this case.
 
         parser_instructions: ParserInstructionsDict = {
-            "name": self.name or None,
-            "cite": self.best_human_identifier or None,
-            "court": self.court or None,
-            "date": checked_date,
-            "uri": self.uri,
             "documentType": parser_type_noun,
-            "published": self.is_published,
+            "metadata": {
+                "name": self.name or None,
+                "cite": self.best_human_identifier or None,
+                "court": self.court or None,
+                "date": checked_date,
+                "uri": self.uri,
+            },
         }
 
         request_parse(

caselawclient/models/neutral_citation_mixin.py

@@ -19,20 +19,21 @@ class NeutralCitationMixin:
     """
 
     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,
-                f"The neutral citation number of this {document_noun} is not valid",
-            ),
-        ]
+        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,
+                    f"The neutral citation number of this {document_noun} is not valid",
+                ),
+            ]
+        )
 
         super(NeutralCitationMixin, self).__init__(*args, **kwargs)
 

caselawclient/models/utilities/aws.py

@@ -16,24 +16,25 @@ from typing_extensions import NotRequired
 env = environ.Env()
 
 
+class ParserInstructionsMetadataDict(TypedDict):
+    name: Optional[str]
+    cite: Optional[str]
+    court: Optional[str]
+    date: Optional[str]
+    uri: Optional[str]
+
+
 class ParserInstructionsDict(TypedDict):
-    name: NotRequired[Optional[str]]
-    cite: NotRequired[Optional[str]]
-    court: NotRequired[Optional[str]]
-    date: NotRequired[Optional[str]]
-    uri: NotRequired[Optional[str]]
     documentType: NotRequired[Optional[str]]
-    published: NotRequired[bool]
+    metadata: NotRequired[ParserInstructionsMetadataDict]
 
 
 @overload
-def create_aws_client(service: Literal["s3"]) -> S3Client:
-    ...
+def create_aws_client(service: Literal["s3"]) -> S3Client: ...
 
 
 @overload
-def create_aws_client(service: Literal["sns"]) -> SNSClient:
-    ...
+def create_aws_client(service: Literal["sns"]) -> SNSClient: ...
 
 
 def create_aws_client(service: Union[Literal["s3"], Literal["sns"]]) -> Any:

caselawclient/xquery/get_pending_enrichment_for_version.xqy

@@ -1,7 +1,9 @@
 xquery version "1.0-ml";
 
-declare variable $target_major_version as xs:int external;
-declare variable $target_minor_version as xs:int external;
+declare variable $target_enrichment_major_version as xs:int external;
+declare variable $target_enrichment_minor_version as xs:int external;
+declare variable $target_parser_major_version as xs:int external;
+declare variable $target_parser_minor_version as xs:int external;
 
 xdmp:to-json(xdmp:sql(
   "SELECT process_data.uri, enrich_version_string, minutes_since_enrichment_request
@@ -9,20 +11,25 @@ xdmp:to-json(xdmp:sql(
     SELECT
       process_data.uri,
       enrich_version_string, enrich_major_version, enrich_minor_version,
+      parser_major_version, parser_minor_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_major_version AND enrich_minor_version < @target_minor_version)
+    (enrich_major_version <= @target_enrichment_major_version AND enrich_minor_version < @target_enrichment_minor_version)
+  ) AND (
+    (parser_major_version = @target_parser_major_version AND parser_minor_version = @target_parser_minor_version)
   )
   AND (minutes_since_enrichment_request > 43200 OR minutes_since_enrichment_request IS NULL)
   ORDER BY enrich_major_version ASC NULLS FIRST, enrich_minor_version ASC",
   "array",
   map:new((
-    map:entry("target_major_version", $target_major_version),
-    map:entry("target_minor_version", $target_minor_version)
+    map:entry("target_enrichment_major_version", $target_enrichment_major_version),
+    map:entry("target_enrichment_minor_version", $target_enrichment_minor_version),
+    map:entry("target_parser_major_version", $target_parser_major_version),
+    map:entry("target_parser_minor_version", $target_parser_minor_version)
   ))
 ))
 

caselawclient/xquery/set_metadata_jurisdiction.xqy

@@ -0,0 +1,37 @@
+xquery version "1.0-ml";
+
+declare namespace akn = "http://docs.oasis-open.org/legaldocml/ns/akn/3.0";
+declare namespace uk = "https://caselaw.nationalarchives.gov.uk/akn";
+
+declare variable $uri as xs:string external;
+declare variable $content as xs:string external;
+declare variable $proprietary-node := document($uri)/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary;
+declare variable $jurisdiction-node := $proprietary-node/uk:jurisdiction;
+
+declare function local:delete($uri)
+{
+   xdmp:node-delete($jurisdiction-node)
+};
+
+declare function local:edit($uri, $content)
+{
+   xdmp:node-replace(
+      $jurisdiction-node,
+     <uk:jurisdiction>{$content}</uk:jurisdiction>
+   )
+};
+
+declare function local:add($uri, $content)
+{
+   xdmp:node-insert-child(
+     $proprietary-node,
+     <uk:jurisdiction>{$content}</uk:jurisdiction>
+   )
+};
+
+if (fn:boolean(
+cts:search(doc($uri),
+cts:element-query(xs:QName('uk:jurisdiction'),cts:and-query(()))))) then
+    if ($content = "") then local:delete($uri) else local:edit($uri, $content)
+else
+    local:add($uri, $content)

caselawclient/xquery_type_dicts.py

@@ -80,8 +80,10 @@ class GetLastModifiedDict(MarkLogicAPIDict):
 
 # get_pending_enrichment_for_version.xqy
 class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
-    target_major_version: int
-    target_minor_version: int
+    target_enrichment_major_version: int
+    target_enrichment_minor_version: int
+    target_parser_major_version: int
+    target_parser_minor_version: int
 
 
 # get_pending_parse_for_version.xqy
@@ -142,6 +144,12 @@ class SetMetadataCourtDict(MarkLogicAPIDict):
     uri: MarkLogicDocumentURIString
 
 
+# set_metadata_jurisdiction.xqy
+class SetMetadataJurisdictionDict(MarkLogicAPIDict):
+    content: str
+    uri: MarkLogicDocumentURIString
+
+
 # set_metadata_name.xqy
 class SetMetadataNameDict(MarkLogicAPIDict):
     content: str

{ds_caselaw_marklogic_api_client-20.0.0.dist-info → ds_caselaw_marklogic_api_client-21.0.0.dist-info}/METADATA

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

@@ -1,16 +1,16 @@
-caselawclient/Client.py,sha256=PKyGcRi9rNMHF17Gbj5_LWAo6HTQ8JbmNOPLp8bd7KI,37002
+caselawclient/Client.py,sha256=JmDrsC678sj2REAasJZCA_ujeUsGYI0X6C5tA9iaijI,38099
 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=WTZc5FrbTeL3fhSoTRJVaHpRiYFP7bSySu1nEgWsqFk,19673
+caselawclient/models/documents.py,sha256=6w_U3Lwuve0ffJLJW78Lt5uojIbzD6I3PKWGWWLYFUU,20365
 caselawclient/models/judgments.py,sha256=TcAsn27K--QQAfaaUZ8biybB9OeVS__91FRlwaG16HY,1020
-caselawclient/models/neutral_citation_mixin.py,sha256=qqB1K4IHVy0XvdY40sfVywZ6VGaZ9ojHcVOQRyi0Vhc,1752
+caselawclient/models/neutral_citation_mixin.py,sha256=G9QS5XZ0tf_VXTxt4Uryy_gZ4eBDsmChqEClLAntIwI,1810
 caselawclient/models/press_summaries.py,sha256=5c1jpVhVtmIMN8AeHMywGXvz4H55kKAIUaaaVims6Tw,994
 caselawclient/models/utilities/__init__.py,sha256=aL1a2nDacPxninETeaVZKwOxZemgvm73IcpWgMNXoGc,1100
-caselawclient/models/utilities/aws.py,sha256=HxmcoDXPpkDfxDH-tm3HtxnMCfOC2qIuy6PZs46OveY,7645
+caselawclient/models/utilities/aws.py,sha256=6J6dOhyNzSHkIpAFseJDDNBQTXkTs63qS1W-oXZaqG8,7648
 caselawclient/models/utilities/move.py,sha256=_SKzO1UVXHFIVvWfT4nuCwdov7acp8tYzzEg-vVfUyg,5372
 caselawclient/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 caselawclient/responses/__init__.py,sha256=2-5NJn_PXPTje_W4dHeHYaNRN6vXK4UcB9eLLNUAKa4,67
@@ -34,7 +34,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=8B9prPDQXj5-gd8XY7UedOyIX6jsRy0ZWOSLjz6UE0I,1077
+caselawclient/xquery/get_pending_enrichment_for_version.xqy,sha256=jYc2OPnAIU4kfRsyhCam9RtrxOB2KhKX40CALFc2Rwo,1623
 caselawclient/xquery/get_pending_parse_for_version.xqy,sha256=1HRQ3Mwljgp1QbVTiesJrV5HuuMCyKPDMzBOzrT_oQM,1054
 caselawclient/xquery/get_properties_for_search_results.xqy,sha256=Tlv3EKwVV_q-JyQyhjWVHIleicPDpucxP4ScuQjpgSw,625
 caselawclient/xquery/get_property.xqy,sha256=RHlOTrK0aH-S7s_ykYzGmUeKOJxXlI4vE5sKRt556NY,209
@@ -45,6 +45,7 @@ caselawclient/xquery/list_judgment_versions.xqy,sha256=WShga8igeD21hSLfVSvCOiDMP
 caselawclient/xquery/set_boolean_property.xqy,sha256=8Vg3yDWqeDynUJQHw2OF4daDIKTnp8ARol1_OCqY0Dk,355
 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
 caselawclient/xquery/set_metadata_name.xqy,sha256=7UeCo13ePNPxXcz9v7o1Pw7MoL6b5voOS6STmy-ROf4,752
 caselawclient/xquery/set_metadata_this_uri.xqy,sha256=lBHk2EJxcRcxu1JqNdBlSzUZmFvVaSs0vu2cVrt84c8,1762
 caselawclient/xquery/set_metadata_work_expression_date.xqy,sha256=eN4VvRA5FqP3aKrlvnqwa7e9mcuuNXqLH5_yHWvrjrU,1017
@@ -56,8 +57,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=LpD5p7D-9kclSE15zGcCLqVl090xklqAR6n99onidrg,5042
-ds_caselaw_marklogic_api_client-20.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-20.0.0.dist-info/METADATA,sha256=b5cVU1HXx6AkLkyRKXw2U3qjGOZm9dgVE9aUCG7bG64,4006
-ds_caselaw_marklogic_api_client-20.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-20.0.0.dist-info/RECORD,,
+caselawclient/xquery_type_dicts.py,sha256=A7yNusrb3lMKg6tmMrTOPZcjuJEijWHiBk4hk6eKCMM,5278
+ds_caselaw_marklogic_api_client-21.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-21.0.0.dist-info/METADATA,sha256=OTHWjjgvwMlUUY-YxoHCgoSBclZSlwjYs6FfXf-xrgc,4006
+ds_caselaw_marklogic_api_client-21.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-21.0.0.dist-info/RECORD,,