pyPreservica 2.7.2__py3-none-any.whl → 3.3.4__py3-none-any.whl

pyPreservica/webHooksAPI.py

@@ -8,8 +8,8 @@ author:     James Carr
 licence:    Apache License 2.0
 
 """
-import json
 from http.server import BaseHTTPRequestHandler
+from typing import Generator
 from urllib.parse import urlparse, parse_qs
 import hmac
 from pyPreservica.common import *
@@ -18,6 +18,45 @@ logger = logging.getLogger(__name__)
 
 BASE_ENDPOINT = '/api/webhook'
 
+class FlaskWebhookHandler:
+
+    def __init__(self, request, secret_key: str):
+        from flask import request
+        self.request = request
+        self.secret_key = secret_key
+
+
+    def response_ok(self):
+        return json.dumps({'success':True}), 200, {'ContentType':'application/json'}
+
+    def is_challenge(self) -> bool:
+        challenge_code = self.request.args.get('challengeCode')
+        return challenge_code is not None
+
+    def verify_challenge(self):
+        challenge_code = self.request.args.get('challengeCode')
+        if challenge_code is not None:
+            challenge_response: str = hmac.new(key=bytes(self.secret_key, 'latin-1'), msg=bytes(challenge_code, 'latin-1'),
+                                 digestmod=hashlib.sha256).hexdigest()
+            body = json.dumps({"challengeCode": f"{challenge_code}", "challengeResponse": f"{challenge_response}"})
+            return body, 200, {"application/json": 'text/plain; charset=utf-8'}
+
+        return json.dumps({'success': True}), 200, {'ContentType': 'application/json'}
+
+
+
+    def process_request(self) -> Generator:
+        preservica_signature = self.request.headers.get('Preservica-Signature')
+        if preservica_signature is not None:
+            message_body = data = self.request.data
+            verify_body = f"preservica-webhook-auth{message_body.decode('utf-8')}"
+            digest = hmac.new(key=bytes(self.secret_key, 'latin-1'), msg=bytes(verify_body, 'latin-1'),
+                              digestmod=hashlib.sha256).hexdigest()
+            if preservica_signature == digest:
+                json_body = json.loads(message_body.decode('utf-8'))
+                for event in json_body['events']:
+                    yield event
+
 
 class WebHookHandler(BaseHTTPRequestHandler):
     """
@@ -74,6 +113,8 @@ class TriggerType(Enum):
     MOVED = "MOVED"
     INDEXED = "FULL_TEXT_INDEXED"
     SECURITY_CHANGED = "CHANGED_SECURITY_DESCRIPTOR"
+    INGEST_FAILED = "INGEST_FAILED"
+    CHANGE_ASSET_VISIBILITY  = "CHANGE_ASSET_VISIBILITY"
 
 
 class WebHooksAPI(AuthenticatedAPI):

pyPreservica/workflowAPI.py

@@ -11,6 +11,7 @@ licence:    Apache License 2.0
 
 import uuid
 import datetime
+from typing import Callable
 from xml.etree import ElementTree
 
 from pyPreservica.common import *
@@ -21,7 +22,7 @@ logger = logging.getLogger(__name__)
 class WorkflowInstance:
     """
         Defines a workflow Instance.
-        The workflow Instance is context which has been executed
+        The workflow Instance is a context which has been executed
     """
 
     def __init__(self, instance_id: int):
@@ -79,8 +80,11 @@ class WorkflowAPI(AuthenticatedAPI):
     workflow_types = ['Ingest', 'Access', 'Transformation', 'DataManagement']
 
     def __init__(self, username: str = None, password: str = None, tenant: str = None, server: str = None,
-                 use_shared_secret: bool = False, two_fa_secret_key: str = None, protocol: str = "https"):
-        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key, protocol)
+                 use_shared_secret: bool = False, two_fa_secret_key: str = None,
+                 protocol: str = "https", request_hook: Callable = None, credentials_path: str = 'credentials.properties'):
+
+        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
+                         protocol, request_hook, credentials_path)
         self.base_url = "sdb/rest/workflow"
 
     def get_workflow_contexts_by_type(self, workflow_type: str):
@@ -245,13 +249,13 @@ class WorkflowAPI(AuthenticatedAPI):
             assert instance_id == w_id
             workflow_instance = WorkflowInstance(int(instance_id))
             started_element = entity_response.find(f".//{{{NS_WORKFLOW}}}Started")
-            if started_element:
+            if started_element is not None:
                 if hasattr(started_element, "text"):
                     workflow_instance.started = datetime.datetime.strptime(started_element.text,
                                                                            '%Y-%m-%dT%H:%M:%S.%fZ')
 
             finished_element = entity_response.find(f".//{{{NS_WORKFLOW}}}Finished")
-            if finished_element:
+            if finished_element is not None:
                 if hasattr(finished_element, "text"):
                     workflow_instance.finished = datetime.datetime.strptime(finished_element.text,
                                                                             '%Y-%m-%dT%H:%M:%S.%fZ')
@@ -328,13 +332,13 @@ class WorkflowAPI(AuthenticatedAPI):
             creator = kwargs.get("creator")
             params["creator"] = creator
 
-        if "from" in kwargs:
-            from_date = kwargs.get("from")
-            params["from"] = from_date
+        if "from_date" in kwargs:
+            from_date = kwargs.get("from_date")
+            params["from"] = parse_date_to_iso(from_date)
 
-        if "to" in kwargs:
-            to_date = kwargs.get("to")
-            params["to"] = to_date
+        if "to_date" in kwargs:
+            to_date = kwargs.get("to_date")
+            params["to"] = parse_date_to_iso(to_date)
 
         params["start"] = int(start_value)
         params["max"] = int(maximum)
@@ -353,13 +357,13 @@ class WorkflowAPI(AuthenticatedAPI):
                 workflow_instance = WorkflowInstance(int(instance_id))
 
                 started_element = instance.find(f".//{{{NS_WORKFLOW}}}Started")
-                if started_element:
+                if started_element is not None:
                     if hasattr(started_element, "text"):
                         workflow_instance.started = datetime.datetime.strptime(started_element.text,
                                                                                '%Y-%m-%dT%H:%M:%S.%fZ')
 
                 finished_element = instance.find(f".//{{{NS_WORKFLOW}}}Finished")
-                if finished_element:
+                if finished_element is not None:
                     if hasattr(finished_element, "text"):
                         workflow_instance.finished = datetime.datetime.strptime(finished_element.text,
                                                                                 '%Y-%m-%dT%H:%M:%S.%fZ')

{pyPreservica-2.7.2.dist-info → pypreservica-3.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pyPreservica
-Version: 2.7.2
+Version: 3.3.4
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -15,7 +15,8 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Archiving
 Description-Content-Type: text/markdown
@@ -23,23 +24,33 @@ License-File: LICENSE.txt
 Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: certifi
-Requires-Dist: boto3
-Requires-Dist: botocore
+Requires-Dist: boto3>=1.38.0
+Requires-Dist: botocore>=1.38.0
 Requires-Dist: s3transfer
 Requires-Dist: azure-storage-blob
 Requires-Dist: tqdm
 Requires-Dist: pyotp
+Requires-Dist: python-dateutil
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
 
 
 # pyPreservica
 
 
-<!---
-[![Downloads](https://pepy.tech/badge/pyPreservica/month)](https://pepy.tech/project/pyPreservica/month)
---->
-
 [![Supported Versions](https://img.shields.io/pypi/pyversions/pyPreservica.svg)](https://pypi.org/project/pyPreservica)
 [![CodeQL](https://github.com/carj/pyPreservica/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/carj/pyPreservica/actions/workflows/codeql-analysis.yml)
+![PyPI Downloads](https://static.pepy.tech/badge/pypreservica)
 
 Python language binding for the Preservica API
 

pypreservica-3.3.4.dist-info/RECORD

@@ -0,0 +1,20 @@
+pyPreservica/__init__.py,sha256=erxwOLhS7avD25N_KKBdk6_Uj6N7xMbNZYSY2E7ZkBw,1271
+pyPreservica/adminAPI.py,sha256=_ZTb8T708loYn8UdFgZ4G5RTef9Hd2HHtjKnnrzBAtY,38041
+pyPreservica/authorityAPI.py,sha256=A52sFiAK4E4mlend_dknNIOW2BEwKXcLFI02anZBt3U,9211
+pyPreservica/common.py,sha256=TV4VgO4QI5YDdPYvm9ue1lxqSIf2E2j0_tQbFmwMf0U,39922
+pyPreservica/contentAPI.py,sha256=pVhKNzqDsIKmmHbevuPffl9bjP8o5BrCDXMP6qFJohE,25531
+pyPreservica/entityAPI.py,sha256=kyw03RnxKEveViQvdDy6MdscXOcAZxs9LC7hpKe3B3g,140235
+pyPreservica/mdformsAPI.py,sha256=A2YTT5uh6j1k_kg_33492cplwZc_jYv6zmiIt5Rvx6c,23259
+pyPreservica/monitorAPI.py,sha256=LJOUrynBOWKlNiYpZ1iH8qB1oIIuKX1Ms1SRBcuXohA,6274
+pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
+pyPreservica/parAPI.py,sha256=f0ZUxLd0U-BW6kBx5K7W2Pv7NjG3MkTNydmxQ3U1ZVE,9296
+pyPreservica/retentionAPI.py,sha256=QUTCbN4P3IpqmrebU_wd3n5ZVcyxVLTFAli8Y_GxOW4,24843
+pyPreservica/settingsAPI.py,sha256=jXnMOCq3mimta6E-Os3J1I1if2pYsjLpOazAx8L-ZQI,10721
+pyPreservica/uploadAPI.py,sha256=UVRFcLDH4s0Tik0vWmkQ6WkJX2h5Yk1MnJZX83HtcpQ,82084
+pyPreservica/webHooksAPI.py,sha256=ngNnGZt5tif7Lrdiuhof9y51fAj5uxBkPGF7RdZ7v_s,8671
+pyPreservica/workflowAPI.py,sha256=bIoXNlr8uBQJ9Nkd1EdpN0uVt_UwtELa_YXpX1PEJh4,17619
+pypreservica-3.3.4.dist-info/licenses/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pypreservica-3.3.4.dist-info/METADATA,sha256=EQyrxJjtDIpKccL1Vk26yV2DKHRrDXfYNHo4bkF2Xzs,3077
+pypreservica-3.3.4.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+pypreservica-3.3.4.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
+pypreservica-3.3.4.dist-info/RECORD,,

{pyPreservica-2.7.2.dist-info → pypreservica-3.3.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyPreservica/vocabularyAPI.py

@@ -1,141 +0,0 @@
-"""
-pyPreservica ControlledVocabularyAPI module definition
-
-A client library for the Preservica Repository web services Webhook API
-https://us.preservica.com/api/reference-metadata/documentation.html
-
-author:     James Carr
-licence:    Apache License 2.0
-
-"""
-
-from pyPreservica.common import *
-
-logger = logging.getLogger(__name__)
-
-BASE_ENDPOINT = '/api/reference-metadata'
-
-
-class Table:
-    def __init__(self, reference: str, name: str, security_tag: str, displayField: str, metadataConnections: list):
-        self.reference = reference
-        self.name = name
-        self.security_tag = security_tag
-        self.displayField = displayField
-        self.metadataConnections = metadataConnections
-        self.fields = None
-
-    def __str__(self):
-        return f"Ref:\t\t\t{self.reference}\n" \
-               f"Name:\t\t\t{self.name}\n" \
-               f"Security Tag:\t{self.security_tag}\n" \
-               f"Display Field:\t\t\t{self.displayField}\n" \
-               f"Metadata Connections:\t\t\t{self.metadataConnections}\n" \
-               f"Fields:\t\t\t{self.fields}\n"
-
-
-class ControlledVocabularyAPI(AuthenticatedAPI):
-
-
-    def load_skos(self, uri):
-        """
-        Load a SKOS controlled vocabulary in skos RDF format
-
-        Simple Knowledge Organization System (SKOS)
-
-        :param uri:
-        :return:
-        """
-        pass
-
-    def record(self, reference: str):
-        """
-        Get individual record by its ref.
-        :param reference:
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/records/{reference}',
-                                    headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.record(reference)
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            return json.loads(json_response)
-        else:
-            exception = HTTPException("", response.status_code, response.url, "record",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception
-
-    def records(self, table: Table):
-        """
-        Get all records from a table.
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/tables/{table.reference}/records',
-                                    headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.records(table)
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            return json.loads(json_response)['records']
-        else:
-            exception = HTTPException("", response.status_code, response.url, "records",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception
-
-    def table(self, reference: str):
-        """
-        fetch a metadata table by id
-
-        :param reference:
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/tables/{reference}',
-                                    headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.table(reference)
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            doc = json.loads(json_response)
-            table = Table(doc['ref'], doc['name'], doc['securityDescriptor'], doc['displayField'],
-                          doc['metadataConnections'])
-            table.fields = doc['fields']
-            return table
-        else:
-            exception = HTTPException("", response.status_code, response.url, "table",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception
-
-    def tables(self):
-        """
-        List reference metadata tables, optionally filtering by metadata connections.
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/tables', headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.tables()
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            doc = json.loads(json_response)
-            results = set()
-            for table in doc['tables']:
-                t = Table(table['ref'], table['name'], table['securityDescriptor'], table['displayField'],
-                          table['metadataConnections'])
-                results.add(t)
-            return results
-        else:
-            exception = HTTPException("", response.status_code, response.url, "tables",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception

pyPreservica-2.7.2.dist-info/RECORD

@@ -1,20 +0,0 @@
-pyPreservica/__init__.py,sha256=7niGhdk2fS4pMgHaqr-x-oZMJQg5-Nte_jfMNxZ3Lkk,1117
-pyPreservica/adminAPI.py,sha256=511bc5KtrCAXbDyBk39dmDnxUVDaOu6xaiyu0jYhxa4,37781
-pyPreservica/authorityAPI.py,sha256=Eule8g6LXr8c8SFcJgpRah4lH1FgevUItO5HhHDEaZE,9172
-pyPreservica/common.py,sha256=upTmwvPK9kcgSO3L8mfIMVrCOWJCCYIHi5GK516jOok,36518
-pyPreservica/contentAPI.py,sha256=d6bK7qXFLep8rOs8y-dJGzoFuqanO3fo82G4dW0YWWE,17245
-pyPreservica/entityAPI.py,sha256=qNUjhAAdboBuY319AtyQV1n5N3Yrs1VY1enBxqQf5RQ,114750
-pyPreservica/mdformsAPI.py,sha256=wHRCv5mcvztVFt9zBnUgHeGgSiNIrzR9IQOSV25daJ0,4576
-pyPreservica/monitorAPI.py,sha256=HD-PUPdSI9wGAa07e2_2_-FLINH8PoWUwpFogz7F-j4,6269
-pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
-pyPreservica/parAPI.py,sha256=bgaQvYfWNnzdD7ibKMV3ZV85pNkEdSoLsgVigoiFFfw,10771
-pyPreservica/retentionAPI.py,sha256=Cx1ofz9V31a8c8utEfKYLlfQaHSaaqg_D4R3LUFBEx0,23612
-pyPreservica/uploadAPI.py,sha256=8GCQlofg-fxJEY_djeValbVwBZoTBujJEDFxpS_fEkQ,93894
-pyPreservica/vocabularyAPI.py,sha256=jPl6KDZoBGqlY0oEYjTpZ9kNEPzchDW-gyp-HH-MSKk,5729
-pyPreservica/webHooksAPI.py,sha256=0wP-59mep8gtlIZ9P5vV68-HnNdTuuo2kzGcDWj0bNg,6790
-pyPreservica/workflowAPI.py,sha256=ENFWxcuPW5WX9jG2CAha6UzTywULWvosgTUVsmvs8f8,17323
-pyPreservica-2.7.2.dist-info/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pyPreservica-2.7.2.dist-info/METADATA,sha256=GDQ2AtPbqDpmjxUGGIwq-8EIoOXkz_fsxwkpMf68TDc,2784
-pyPreservica-2.7.2.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-pyPreservica-2.7.2.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
-pyPreservica-2.7.2.dist-info/RECORD,,