ds-caselaw-marklogic-api-client 37.0.2__py3-none-any.whl → 37.1.0__py3-none-any.whl

caselawclient/Client.py

@@ -1198,6 +1198,24 @@ class MarklogicApiClient:
 
         return results
 
+    def get_missing_fclid(
+        self,
+        maximum_records: int = 50,
+    ) -> list[str]:
+        """Retrieve the URIs of published documents which do not have an identifier in the `fclid` schema."""
+        vars: query_dicts.GetMissingFclidDict = {
+            "maximum_records": maximum_records,
+        }
+
+        results: list[str] = get_multipart_strings_from_marklogic_response(
+            self._send_to_eval(
+                vars,
+                "get_missing_fclid.xqy",
+            )
+        )
+
+        return results
+
     def resolve_from_identifier_slug(
         self, identifier_slug: DocumentIdentifierSlug, published_only: bool = True
     ) -> IdentifierResolutions:

caselawclient/models/documents/__init__.py

@@ -378,6 +378,16 @@ class Document:
         """
         return self.api_client.validate_document(self.uri)
 
+    def assign_fclid_if_missing(self) -> Optional[FindCaseLawIdentifier]:
+        """If the document does not have an FCLID already, mint a new one and save it."""
+        if len(self.identifiers.of_type(FindCaseLawIdentifier)) == 0:
+            document_fclid = FindCaseLawIdentifierSchema.mint(self.api_client)
+            self.identifiers.add(document_fclid)
+            self.save_identifiers()
+            return document_fclid
+
+        return None
+
     def publish(self) -> None:
         """
         :raises CannotPublishUnpublishableDocument: This document has not passed the checks in `is_publishable`, and as
@@ -386,11 +396,8 @@ class Document:
         if not self.is_publishable:
             raise CannotPublishUnpublishableDocument
 
-        ## If it doesn't already have one, get a new FCLID for this document and assign
-        if len(self.identifiers.of_type(FindCaseLawIdentifier)) < 1:
-            document_fclid = FindCaseLawIdentifierSchema.mint(self.api_client)
-            self.identifiers.add(document_fclid)
-            self.save_identifiers()
+        ## Make sure the document has an FCLID
+        self.assign_fclid_if_missing()
 
         publish_documents(self.uri)
         self.api_client.set_published(self.uri, True)

caselawclient/xquery/get_missing_fclid.xqy

@@ -0,0 +1,25 @@
+xquery version "1.0-ml";
+
+declare variable $maximum_records as xs:int? external := 1000;
+
+for $doc in fn:subsequence(
+  cts:search(
+    fn:collection(),
+    cts:and-query(
+      (
+        cts:properties-fragment-query(
+          cts:element-value-query(xs:QName("published"), "true")
+        ),
+        cts:not-query(
+          cts:properties-fragment-query(
+            cts:element-value-query(xs:QName("namespace"), "fclid")
+          )
+        )
+      )
+    )
+  ),
+  1,
+  $maximum_records
+)
+
+return fn:base-uri($doc)

caselawclient/xquery_type_dicts.py

@@ -86,6 +86,11 @@ class GetLastModifiedDict(MarkLogicAPIDict):
     uri: MarkLogicDocumentURIString
 
 
+# get_missing_fclid.xqy
+class GetMissingFclidDict(MarkLogicAPIDict):
+    maximum_records: Optional[int]
+
+
 # get_pending_enrichment_for_version.xqy
 class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
     maximum_records: Optional[int]

{ds_caselaw_marklogic_api_client-37.0.2.dist-info → ds_caselaw_marklogic_api_client-37.1.0.dist-info}/METADATA

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

@@ -1,4 +1,4 @@
-caselawclient/Client.py,sha256=HaVEhYB3emW6o6ERJ1UpfNDqEir98Ou8nT4Rl2keiJI,44658
+caselawclient/Client.py,sha256=AGF7ud4x2hZFm6H--IUXa-n5woOWYmWz2yDzbPPCGdA,45193
 caselawclient/__init__.py,sha256=DY-caubLDQWWingSdsBWgovDNXh8KcnkI6kwz08eIFk,612
 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=tAZQ8RfWQwdZsqc6qScXyaXV6nk5lScB3Chx8fwRRro,6949
 caselawclient/identifier_resolution.py,sha256=B5I1sD7o7YjzsXMECjbKjgiGLDda5bGhejsJ-lYpTIg,2429
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=TatleqbzvvNYa9el9NauiB0g9b7VhmdRSzL-tskrqXA,19241
+caselawclient/models/documents/__init__.py,sha256=4o6-8Iy5ZA8KEaqOt8xkpbqc7vwOzm8IoHvI8897mPk,19460
 caselawclient/models/documents/body.py,sha256=IVcuSbgA7SvCvii_VE8MZy_54enDZY8VPoESkUDgfKU,6114
 caselawclient/models/documents/exceptions.py,sha256=Mz1P8uNqf5w6uLnRwJt6xK7efsVqtd5VA-WXUUH7QLk,285
 caselawclient/models/documents/statuses.py,sha256=Cp4dTQmJOtsU41EJcxy5dV1841pGD2PNWH0VrkDEv4Q,579
@@ -50,6 +50,7 @@ caselawclient/xquery/get_judgment.xqy,sha256=34fMHSBNPcXY3u3QIX3Bul8DMuWyGGHrhuY
 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_missing_fclid.xqy,sha256=FAZZMtqow0VAf1D9LjBydT9kcOxiEIQC7GQgs4o68sA,520
 caselawclient/xquery/get_next_document_sequence_number.xqy,sha256=LkGoaS7jZfaKDuZLi0apP5qHP1rpcM1HbqX3RUwquKY,450
 caselawclient/xquery/get_pending_enrichment_for_version.xqy,sha256=8J5Pi-jMXJd_BgtpK4g6C9uR99HP57JpFv5WkoPfNuo,2016
 caselawclient/xquery/get_pending_parse_for_version.xqy,sha256=9cjVZtHeBBjm-a7RMsn1PVJt_Ug78YFlmp5CN8VJ1jQ,1197
@@ -81,8 +82,8 @@ 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=21V6PJ0a8lPZuwzQCWeHNo914hdCbCJtOvnqdHcTpKk,6383
-ds_caselaw_marklogic_api_client-37.0.2.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-37.0.2.dist-info/METADATA,sha256=you12Jote5NzqVaPA27-meGTcOfNYRhPRcx6QkhTOtA,4206
-ds_caselaw_marklogic_api_client-37.0.2.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-37.0.2.dist-info/RECORD,,
+caselawclient/xquery_type_dicts.py,sha256=zuyDGTkcN6voOXCm3APXItZ-Ey6tZ2hdZummZWzjl50,6489
+ds_caselaw_marklogic_api_client-37.1.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-37.1.0.dist-info/METADATA,sha256=rwN7JhdRezJIDek5Vq-u2_C6sPf4zDQ4GXhVnezYzg8,4206
+ds_caselaw_marklogic_api_client-37.1.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-37.1.0.dist-info/RECORD,,