ds-caselaw-marklogic-api-client 8.0.0__tar.gz → 10.0.0__tar.gz

{ds_caselaw_marklogic_api_client-8.0.0 → ds_caselaw_marklogic_api_client-10.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 8.0.0
+Version: 10.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-8.0.0 → ds_caselaw_marklogic_api_client-10.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ds-caselaw-marklogic-api-client"
-version = "8.0.0"
+version = "10.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"

{ds_caselaw_marklogic_api_client-8.0.0 → ds_caselaw_marklogic_api_client-10.0.0}/src/caselawclient/Client.py

@@ -327,18 +327,18 @@ class MarklogicApiClient:
 
         return self._send_to_eval(vars, "update_judgment.xqy")
 
-    def insert_judgment_xml(
-        self, judgment_uri: str, judgment_xml: Element
+    def insert_document_xml(
+        self, document_uri: str, document_xml: Element
     ) -> requests.Response:
-        xml = ElementTree.tostring(judgment_xml)
+        xml = ElementTree.tostring(document_xml)
 
-        uri = self._format_uri_for_marklogic(judgment_uri)
-        vars: query_dicts.InsertJudgmentDict = {
+        uri = self._format_uri_for_marklogic(document_uri)
+        vars: query_dicts.InsertDocumentDict = {
             "uri": uri,
-            "judgment": xml.decode("utf-8"),
+            "document": xml.decode("utf-8"),
         }
 
-        return self._send_to_eval(vars, "insert_judgment.xqy")
+        return self._send_to_eval(vars, "insert_document.xqy")
 
     def list_judgment_versions(self, judgment_uri: str) -> requests.Response:
         uri = self._format_uri_for_marklogic(judgment_uri)
@@ -437,7 +437,7 @@ class MarklogicApiClient:
         """
         Performs a search on the entire document set.
 
-        :param q:
+        :param query:
         :param court:
         :param judge:
         :param party:

ds_caselaw_marklogic_api_client-10.0.0/src/caselawclient/client_helpers/search_helpers.py

@@ -0,0 +1,39 @@
+from caselawclient.Client import MarklogicApiClient
+from caselawclient.responses.search_response import SearchResponse
+from caselawclient.search_parameters import SearchParameters
+
+
+def search_judgments_and_parse_response(
+    api_client: MarklogicApiClient, search_parameters: SearchParameters
+) -> SearchResponse:
+    """
+    Search for judgments using the given search parameters and parse the response into a SearchResponse object.
+
+    Args:
+        api_client (MarklogicApiClient): An instance of MarklogicApiClient used to make the search request.
+        search_parameters (SearchParameters): An instance of SearchParameters containing the search parameters.
+
+    Returns:
+        SearchResponse: The parsed search response as a SearchResponse object.
+    """
+    return SearchResponse.from_response_string(
+        api_client.search_judgments_and_decode_response(search_parameters)
+    )
+
+
+def search_and_parse_response(
+    api_client: MarklogicApiClient, search_parameters: SearchParameters
+) -> SearchResponse:
+    """
+    Search using the given search parameters and parse the response into a SearchResponse object.
+
+    Args:
+        api_client (MarklogicApiClient): An instance of MarklogicApiClient used to make the search request.
+        search_parameters (SearchParameters): An instance of SearchParameters containing the search parameters.
+
+    Returns:
+        SearchResponse: The parsed search response as a SearchResponse object.
+    """
+    return SearchResponse.from_response_string(
+        api_client.search_and_decode_response(search_parameters)
+    )

{ds_caselaw_marklogic_api_client-8.0.0 → ds_caselaw_marklogic_api_client-10.0.0}/src/caselawclient/search_parameters.py

@@ -8,7 +8,7 @@ RESULTS_PER_PAGE = 10
 class SearchParameters:
     """Represents search parameters for a case law search."""
 
-    q: Optional[str] = None
+    query: Optional[str] = None
     court: Optional[str] = None
     judge: Optional[str] = None
     party: Optional[str] = None
@@ -33,7 +33,7 @@ class SearchParameters:
             "judge": str(self.judge or ""),
             "page": max(1, int(self.page)),
             "page-size": int(self.page_size),
-            "q": str(self.q or ""),
+            "q": str(self.query or ""),
             "party": str(self.party or ""),
             "neutral_citation": str(self.neutral_citation or ""),
             "specific_keyword": str(self.specific_keyword or ""),

ds_caselaw_marklogic_api_client-10.0.0/src/caselawclient/xquery/insert_document.xqy

@@ -0,0 +1,15 @@
+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 $document as xs:string external;
+
+let $document_xml := xdmp:unquote($document)
+
+let $collections :=
+  if (fn:contains($uri, 'press_summary'))
+  then ("press_summary")
+  else ("judgment")
+
+return dls:document-insert-and-manage($uri, fn:true(), $document_xml, (), (), $collections)

{ds_caselaw_marklogic_api_client-8.0.0 → ds_caselaw_marklogic_api_client-10.0.0}/src/caselawclient/xquery_type_dicts.py

@@ -90,9 +90,9 @@ class GetPropertyDict(MarkLogicAPIDict):
     uri: str
 
 
-# insert_judgment.xqy
-class InsertJudgmentDict(MarkLogicAPIDict):
-    judgment: str
+# insert_document.xqy
+class InsertDocumentDict(MarkLogicAPIDict):
+    document: str
     uri: str
 
 

ds_caselaw_marklogic_api_client-8.0.0/src/caselawclient/xquery/insert_judgment.xqy

@@ -1,10 +0,0 @@
-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 $judgment as xs:string external;
-
-let $judgment_xml := xdmp:unquote($judgment)
-
-return dls:document-insert-and-manage($uri, fn:true(), $judgment_xml)