pyPreservica 2.8.2__tar.gz → 2.9.1__tar.gz

{pypreservica-2.8.2 → pypreservica-2.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyPreservica
-Version: 2.8.2
+Version: 2.9.1
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -15,6 +15,7 @@ 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: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Archiving
@@ -34,12 +35,9 @@ Requires-Dist: pyotp
 # 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-2.8.2 → pypreservica-2.9.1}/README.md

@@ -2,12 +2,9 @@
 # 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-2.8.2 → pypreservica-2.9.1}/pyPreservica/__init__.py

@@ -7,7 +7,7 @@ licence:    Apache License 2.0
 
 """
 from .common import *
-from .contentAPI import ContentAPI
+from .contentAPI import ContentAPI, Field, SortOrder
 from .entityAPI import EntityAPI
 from .uploadAPI import UploadAPI, simple_asset_package, complex_asset_package, cvs_to_xsd, cvs_to_xml, \
                     cvs_to_cmis_xslt, csv_to_search_xml, generic_asset_package, upload_config, multi_asset_package
@@ -23,6 +23,6 @@ from .mdformsAPI import MetadataGroupsAPI, Group, GroupField, GroupFieldType
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "2.8.2"
+__version__ = "2.9.1"
 
 __license__ = "Apache License Version 2.0"

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica/contentAPI.py

@@ -10,11 +10,28 @@ licence:    Apache License 2.0
 """
 
 import csv
-from typing import Generator, Callable
+from typing import Generator, Callable, Optional
 from pyPreservica.common import *
 
 logger = logging.getLogger(__name__)
 
+class SortOrder(Enum):
+    asc = 1
+    desc = 2
+
+class Field:
+    name: str
+    value: Optional[str]
+    operator: Optional[str]
+    sort_order: Optional[SortOrder]
+
+    def __init__(self, name: str, value: str, operator: Optional[str]=None, sort_order: Optional[SortOrder]=None):
+        self.name = name
+        self.value = value
+        self.operator = operator
+        self.sort_order = sort_order
+
+
 
 class ContentAPI(AuthenticatedAPI):
 
@@ -212,6 +229,93 @@ class ContentAPI(AuthenticatedAPI):
             writer.writeheader()
             writer.writerows(self.search_index_filter_list(query, page_size, filter_values, sort_values))
 
+    def search_fields(self, query: str = "%",  fields: list[Field]=None,  page_size: int = 25) -> Generator:
+        """
+        Run a search query with multiple fields
+
+        :param query: The main search query.
+        :param fields:  List of search fields
+        :param page_size:  The default search page size
+        :return: search result
+        """
+        search_result = self._search_fields(query=query, fields=fields, start_index=0, page_size=page_size)
+        for e in search_result.results_list:
+            yield e
+        found = len(search_result.results_list)
+        while search_result.hits > found:
+            search_result = self._search_fields(query=query, fields=fields, start_index=found, page_size=page_size)
+            for e in search_result.results_list:
+                yield e
+            found = found + len(search_result.results_list)
+
+    def _search_fields(self, query: str = "%", fields: list[Field]=None, start_index: int = 0, page_size: int = 25):
+
+        start_from = str(start_index)
+        headers = {'Content-Type': 'application/x-www-form-urlencoded', HEADER_TOKEN: self.token}
+
+        if fields is None:
+            fields = []
+
+        field_list = []
+        sort_list = []
+        metadata_elements = []
+        for field in fields:
+            metadata_elements.append(field.name)
+            if field.value is None or field.value == "":
+                field_list.append('{' f' "name": "{field.name}", "values": [] ' + '}')
+            elif field.operator == "NOT":
+                field_list.append('{' f' "name": "{field.name}", "values": ["{field.value}"], "operator": "NOT" ' + '}')
+            else:
+                field_list.append('{' f' "name": "{field.name}", "values": ["{field.value}"] ' + '}')
+
+            if field.sort_order is not None:
+                sort_list.append(f'{{"sortFields": ["{field.name}"], "sortOrder": "{field.sort_order.name}"}}')
+
+
+        filter_terms = ','.join(field_list)
+
+        if len(sort_list) == 0:
+            query_term = ('{ "q":  "%s",  "fields":  [ %s ] }' % (query, filter_terms))
+        else:
+            sort_terms = ','.join(sort_list)
+            query_term = ('{ "q":  "%s",  "fields":  [ %s ],  "sort": [ %s ]}' % (query, filter_terms, sort_terms))
+
+        if len(metadata_elements) == 0:
+            metadata_elements.append("xip.title")
+
+
+        payload = {'start': start_from, 'max': str(page_size), 'metadata': list(metadata_elements), 'q': query_term}
+        logger.debug(payload)
+        results = self.session.post(f'{self.protocol}://{self.server}/api/content/search', data=payload,
+                                    headers=headers)
+        results_list = []
+        if results.status_code == requests.codes.ok:
+            json_doc = results.json()
+            metadata = json_doc['value']['metadata']
+            refs = list(json_doc['value']['objectIds'])
+            refs = list(map(lambda x: content_api_identifier_to_type(x), refs))
+            hits = int(json_doc['value']['totalHits'])
+
+            for m_row, r_row in zip(metadata, refs):
+                results_map = {'xip.reference': r_row[1]}
+                for li in m_row:
+                    results_map[li['name']] = li['value']
+                results_list.append(results_map)
+            next_start = start_index + page_size
+
+            if self.callback is not None:
+                value = str(f'{len(results_list) + start_index}:{hits}')
+                self.callback(value)
+
+            search_results = self.SearchResult(metadata, refs, hits, results_list, next_start)
+            return search_results
+        elif results.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
+            return self._search_predicates(query, predicates, start_index, page_size)
+        else:
+            logger.error(f"search failed with error code: {results.status_code}")
+            raise RuntimeError(results.status_code, f"search_index_filter failed")
+
     def search_index_filter_list(self, query: str = "%", page_size: int = 25, filter_values: dict = None,
                                  sort_values: dict = None) -> Generator:
         """

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica/entityAPI.py

@@ -572,6 +572,76 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
+    def update_identifiers(self, entity: Entity, identifier_type: str = None, identifier_value: str = None):
+        """
+             Update external identifiers based on Entity and Type
+
+             Returns the internal identifier DB Key
+
+             :param entity: The entity to delete identifiers from
+             :param identifier_type: The type of the identifier to delete.
+             :param identifier_value: The value of the identifier to delete.
+          """
+
+        if (self.major_version < 7) and (self.minor_version < 1):
+            raise RuntimeError("update_identifiers API call is not available when connected to a v6.0 System")
+
+        headers = {HEADER_TOKEN: self.token}
+        response = self.session.get(
+            f'{self.protocol}://{self.server}/api/entity/{entity.path}/{entity.reference}/identifiers',
+            headers=headers)
+
+        if response.status_code == requests.codes.ok:
+            xml_response = str(response.content.decode('utf-8'))
+            entity_response = xml.etree.ElementTree.fromstring(xml_response)
+            identifier_list = entity_response.findall(f'.//{{{self.xip_ns}}}Identifier')
+            for identifier_element in identifier_list:
+                _ref = _type = _value = _aipid = None
+                for identifier in identifier_element:
+                    if identifier.tag.endswith("Entity"):
+                        _ref = identifier.text
+                    if identifier.tag.endswith("Type") and identifier_type is not None:
+                        _type = identifier.text
+                    if identifier.tag.endswith("Value") and identifier_value is not None:
+                        _value = identifier.text
+                    if identifier.tag.endswith("ApiId"):
+                        _aipid = identifier.text
+                if _ref == entity.reference and _type == identifier_type:
+
+                    headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/xml;charset=UTF-8'}
+
+                    xml_object = xml.etree.ElementTree.Element('Identifier', {"xmlns": self.xip_ns})
+                    xml.etree.ElementTree.SubElement(xml_object, "Type").text = identifier_type
+                    xml.etree.ElementTree.SubElement(xml_object, "Value").text = identifier_value
+                    xml.etree.ElementTree.SubElement(xml_object, "Entity").text = entity.reference
+                    xml_request = xml.etree.ElementTree.tostring(xml_object, encoding='utf-8')
+
+                    put_response = self.session.put(
+                        f'{self.protocol}://{self.server}/api/entity/{entity.path}/{entity.reference}/identifiers/{_aipid}',
+                        headers=headers, data=xml_request)
+                    if put_response.status_code == requests.codes.ok:
+                        xml_string = str(put_response.content.decode("utf-8"))
+                        identifier_response = xml.etree.ElementTree.fromstring(xml_string)
+                        aip_id = identifier_response.find(f'.//{{{self.xip_ns}}}ApiId')
+                        if hasattr(aip_id, 'text'):
+                            return aip_id.text
+                        else:
+                            return None
+                    if put_response.status_code == requests.codes.unauthorized:
+                        self.token = self.__token__()
+                        return self.update_identifiers(entity, identifier_type, identifier_value)
+                    if put_response.status_code == requests.codes.no_content:
+                        pass
+                    else:
+                        return None
+            return entity
+        elif response.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
+            return self.update_identifiers(entity, identifier_type, identifier_value)
+        else:
+            logger.error(response)
+            raise RuntimeError(response.status_code, "update_identifiers failed")
+
     def delete_relationships(self, entity: Entity, relationship_type: str = None):
         """
         Delete a relationship between two entities by its internal id
@@ -2275,6 +2345,8 @@ class EntityAPI(AuthenticatedAPI):
                     entity_response = xml.etree.ElementTree.fromstring(req.content.decode("utf-8"))
                     status = entity_response.find(".//{http://status.preservica.com}Status")
                     if hasattr(status, 'text'):
+                        if status.text == "COMPLETED":
+                            return entity.reference
                         if status.text == "PENDING":
                             headers = {HEADER_TOKEN: self.manager_token(manager_username, manager_password),
                                        'Content-Type': 'application/xml;charset=UTF-8'}

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica/mdformsAPI.py

@@ -96,6 +96,8 @@ def _object_from_json_(json_doc: dict) -> Group:
                 gf.editable = bool(field['editable'])
             if 'values' in field:
                 for v in field['values']:
+                    if gf.values is None:
+                        gf.values = []
                     gf.values.append(str(v))
             if 'defaultValue' in field:
                 gf.default = str(field['defaultValue'])

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica/retentionAPI.py

@@ -9,7 +9,6 @@ licence:    Apache License 2.0
 
 """
 
-
 import xml.etree.ElementTree
 from typing import Set, Callable
 
@@ -60,7 +59,6 @@ class RetentionAPI(AuthenticatedAPI):
 
     def __init__(self, username=None, password=None, tenant=None, server=None, use_shared_secret=False,
                  two_fa_secret_key: str = None, protocol: str = "https", request_hook: Callable = None):
-
         super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
                          protocol, request_hook)
         if self.major_version < 7 and self.minor_version < 2:
@@ -78,7 +76,8 @@ class RetentionAPI(AuthenticatedAPI):
 
          """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/xml;charset=UTF-8'}
-        request = self.session.get(f'{self.protocol}://{self.server}/api/entity/retention-policies/{reference}', headers=headers)
+        request = self.session.get(f'{self.protocol}://{self.server}/api/entity/retention-policies/{reference}',
+                                   headers=headers)
         if request.status_code == requests.codes.ok:
             xml_response = str(request.content.decode('utf-8'))
             logger.debug(xml_response)
@@ -92,14 +91,22 @@ class RetentionAPI(AuthenticatedAPI):
             security_tag = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}SecurityTag').text
             rp.security_tag = security_tag
             start_date_field = entity_response.find(
-                f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}StartDateField').text
-            rp.start_date_field = start_date_field
-            period = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}Period').text
-            rp.period = period
-            period_unit = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}PeriodUnit').text
-            rp.period_unit = period_unit
-            expiry_action = entity_response.find(
-                f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}ExpiryAction')
+                f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}StartDateField')
+            if start_date_field is not None:
+                rp.start_date_field = start_date_field.text
+            else:
+                start_date_field = None
+            period = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}Period')
+            if period is not None:
+                rp.period = period.text
+            else:
+                rp.period = None
+            period_unit = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}PeriodUnit')
+            if period_unit is not None:
+                rp.period_unit = period_unit.text
+            else:
+                rp.period_unit = None
+            expiry_action = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy/{{{self.rm_ns}}}ExpiryAction')
             if expiry_action is not None:
                 rp.expiry_action = expiry_action.text
             else:
@@ -134,8 +141,9 @@ class RetentionAPI(AuthenticatedAPI):
         """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'text/plain;charset=UTF-8'}
         data = str(status)
-        request = self.session.put(f'{self.protocol}://{self.server}/api/entity/retention-policies/{reference}/assignable',
-                                   headers=headers, data=data)
+        request = self.session.put(
+            f'{self.protocol}://{self.server}/api/entity/retention-policies/{reference}/assignable',
+            headers=headers, data=data)
         if request.status_code == requests.codes.ok:
             pass
         elif request.status_code == requests.codes.unauthorized:
@@ -230,7 +238,8 @@ class RetentionAPI(AuthenticatedAPI):
 
         xml_request = xml.etree.ElementTree.tostring(retention_policy, encoding='utf-8')
 
-        request = self.session.put(f'{self.protocol}://{self.server}/api/entity/retention-policies/{reference}', data=xml_request,
+        request = self.session.put(f'{self.protocol}://{self.server}/api/entity/retention-policies/{reference}',
+                                   data=xml_request,
                                    headers=headers)
         if request.status_code == requests.codes.ok:
             return self.policy(reference)
@@ -374,7 +383,8 @@ class RetentionAPI(AuthenticatedAPI):
          """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/xml;charset=UTF-8'}
         data = {'start': str(0), 'max': "250"}
-        request = self.session.get(f'{self.protocol}://{self.server}/api/entity/retention-policies', data=data, headers=headers)
+        request = self.session.get(f'{self.protocol}://{self.server}/api/entity/retention-policies', data=data,
+                                   headers=headers)
         if request.status_code == requests.codes.ok:
             xml_response = str(request.content.decode('utf-8'))
             logger.debug(xml_response)
@@ -390,10 +400,10 @@ class RetentionAPI(AuthenticatedAPI):
         else:
             raise RuntimeError(request.status_code, "policies failed")
 
-    def policies(self) -> Set[RetentionPolicy]:
+    def policies(self, maximum: int = 250, next_page: str = None) -> PagedSet:
         """
         Return a list of all retention policies
-        Only returns the first 250 policies in the system
+        Returns a maxmium of 250 policies by default
 
 
         :return: Set of retention policies
@@ -401,22 +411,33 @@ class RetentionAPI(AuthenticatedAPI):
 
         """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/xml;charset=UTF-8'}
-        data = {'start': str(0), 'max': "250"}
-        request = self.session.get(f'{self.protocol}://{self.server}/api/entity/retention-policies', data=data, headers=headers)
+
+        if next_page is None:
+            params = {'start': '0', 'max': str(maximum)}
+            request = self.session.get(f'{self.protocol}://{self.server}/api/entity/retention-policies', params=params,
+                                       headers=headers)
+        else:
+            request = self.session.get(next_page, headers=headers)
+
         if request.status_code == requests.codes.ok:
             xml_response = str(request.content.decode('utf-8'))
             entity_response = xml.etree.ElementTree.fromstring(xml_response)
             logger.debug(xml_response)
             result = set()
+            next_url = entity_response.find(f'.//{{{self.entity_ns}}}Paging/{{{self.entity_ns}}}Next')
             total_results = int(entity_response.find(
                 f'.//{{{self.entity_ns}}}TotalResults').text)
-            if total_results > 250:
-                logger.error("Not all retention policies have been returned.")
             for assignment in entity_response.findall(f'.//{{{self.entity_ns}}}RetentionPolicy'):
                 ref = assignment.attrib['ref']
                 name = assignment.attrib['name']
                 result.add(self.policy(reference=ref))
-            return result
+            has_more = True
+            url = None
+            if next_url is None:
+                has_more = False
+            else:
+                url = next_url.text
+            return PagedSet(result, has_more, total_results, url)
         elif request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()
             return self.policies()
@@ -455,7 +476,11 @@ class RetentionAPI(AuthenticatedAPI):
             api_id = entity_response.find(f'.//{{{self.rm_ns}}}ApiId').text
             policy_ref = entity_response.find(f'.//{{{self.rm_ns}}}RetentionPolicy').text
             entity_ref = entity_response.find(f'.//{{{self.rm_ns}}}Entity').text
-            start_date = entity_response.find(f'.//{{{self.rm_ns}}}StartDate').text
+            start_date = entity_response.find(f'.//{{{self.rm_ns}}}StartDate')
+            if start_date is not None:
+                start_date = start_date.text
+            else:
+                start_date = None
             assert entity_ref == entity.reference
             assert policy_ref == policy.reference
             return RetentionAssignment(entity_ref, policy_ref, api_id, start_date)
@@ -516,7 +541,11 @@ class RetentionAPI(AuthenticatedAPI):
                 entity_ref = assignment.find(f'.//{{{self.rm_ns}}}Entity').text
                 assert entity_ref == entity.reference
                 policy = assignment.find(f'.//{{{self.rm_ns}}}RetentionPolicy').text
-                start_date = assignment.find(f'.//{{{self.rm_ns}}}StartDate').text
+                start_date = assignment.find(f'.//{{{self.rm_ns}}}StartDate')
+                if start_date is not None:
+                    start_date = start_date.text
+                else:
+                    start_date = None
                 expired = bool(assignment.find(f'.//{{{self.rm_ns}}}Expired').text == 'true')
                 api_id = assignment.find(f'.//{{{self.rm_ns}}}ApiId').text
                 ra = RetentionAssignment(entity_ref, policy, api_id, start_date, expired)

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica/uploadAPI.py

@@ -1421,7 +1421,7 @@ class UploadAPI(AuthenticatedAPI):
         try:
             auth = tweepy.AppAuthHandler(twitter_consumer_key, twitter_secret_key)
             api = tweepy.API(auth, wait_on_rate_limit=True)
-        except TweepError:
+        except RuntimeError:
             logger.error("No valid Twitter API keys. Could not authenticate")
             raise RuntimeError("No valid Twitter API keys. Could not authenticate")
         if api is not None:
@@ -1734,8 +1734,8 @@ class UploadAPI(AuthenticatedAPI):
                     self.upload_zip_package(path_to_zip_package=package, callback=progress_display,
                                             delete_after_upload=delete_after_upload)
                 else:
-                    self.upload_zip_package_to_S3(path_to_zip_package=package, bucket_name=bucket_name,
-                                                  callback=progress_display,
+                    self.upload_zip_to_Source(path_to_zip_package=package, container_name=bucket_name,
+                                                  show_progress= bool(progress_display is not None),
                                                   delete_after_upload=delete_after_upload)
 
                 logger.info(f"Uploaded " + "{:.1f}".format(bytes_ingested / (1024 * 1024)) + " MB")

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica/webHooksAPI.py

@@ -74,6 +74,7 @@ class TriggerType(Enum):
     MOVED = "MOVED"
     INDEXED = "FULL_TEXT_INDEXED"
     SECURITY_CHANGED = "CHANGED_SECURITY_DESCRIPTOR"
+    INGEST_FAILED = "INGEST_FAILED"
 
 
 class WebHooksAPI(AuthenticatedAPI):

{pypreservica-2.8.2 → pypreservica-2.9.1}/pyPreservica.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyPreservica
-Version: 2.8.2
+Version: 2.9.1
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -15,6 +15,7 @@ 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: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Archiving
@@ -34,12 +35,9 @@ Requires-Dist: pyotp
 # 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-2.8.2 → pypreservica-2.9.1}/setup.py

@@ -21,7 +21,7 @@ if sys.argv[-1] == 'publish':
 # This call to setup() does all the work
 setup(
     name=PKG,
-    version="2.8.2",
+    version="2.9.1",
     description="Python library for the Preservica API",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -36,6 +36,7 @@ setup(
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
         "License :: OSI Approved :: Apache Software License",
         "Operating System :: OS Independent",
         "Topic :: System :: Archiving",

pypreservica-2.9.1/tests/test_authority_records.py

@@ -0,0 +1,38 @@
+import pytest
+from pyPreservica import *
+
+
+def setup():
+    pass
+
+def tear_down():
+    pass
+
+
+@pytest.fixture
+def setup_data():
+    print("\nSetting up resources...")
+
+    setup()
+
+    yield
+
+    print("\nTearing down resources...")
+
+    tear_down()
+
+
+def test_get_tables(setup_data):
+    client = AuthorityAPI()
+    results = client.tables()
+    assert isinstance(results, set)
+    for table in results:
+        assert isinstance(table, Table)
+        assert table.name in ["Countries", 'Physical Storage']
+
+
+def test_get_records(setup_data):
+    client = AuthorityAPI()
+    tables = client.tables()
+    for tab in tables:
+        records = client.records(tab)

{pypreservica-2.8.2 → pypreservica-2.9.1}/tests/test_bitstream.py

@@ -3,10 +3,32 @@ from pathlib import Path
 import pytest
 from pyPreservica import *
 
+
+def setup():
+    pass
+
+
+def tear_down():
+    pass
+
+
+@pytest.fixture
+def setup_data():
+    print("\nSetting up resources...")
+
+    setup()
+
+    yield
+
+    print("\nTearing down resources...")
+
+    tear_down()
+
+
 ASSET_ID = "b14848b5-4c4d-4d8a-b394-3b764069ee93"
 
 
-def test_get_representations():
+def test_get_representations(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
     assert asset is not None
@@ -20,7 +42,7 @@ def test_get_representations():
     assert representation.name == "Preservation-1"
 
 
-def test_get_generations():
+def test_get_generations(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
     assert asset is not None
@@ -60,7 +82,7 @@ def test_get_generations():
     assert generation.format_group == "jpeg"
 
 
-def test_get_bitstream_content():
+def test_get_bitstream_content(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
     preservation_representations = list(filter(lambda x: x.rep_type == "Preservation", client.representations(asset)))

{pypreservica-2.8.2 → pypreservica-2.9.1}/tests/test_children.py

@@ -8,7 +8,30 @@ ASSET_ID = "683f9db7-ff81-4859-9c03-f68cfa5d9c3d"
 CO_ID = "0f2997f7-728c-4e55-9f92-381ed1260d70"
 
 
-def test_get_root_folders():
+
+def setup():
+    pass
+
+
+def tear_down():
+    pass
+
+
+@pytest.fixture
+def setup_data():
+    print("\nSetting up resources...")
+
+    setup()
+
+    yield
+
+    print("\nTearing down resources...")
+
+    tear_down()
+
+
+
+def test_get_root_folders(setup_data):
     client = EntityAPI()
     paged_set = client.children(None)
     assert paged_set.total > 0
@@ -20,14 +43,14 @@ def test_get_root_folders():
     assert len(objs) == paged_set.total
 
 
-def test_get_root_folders_descendants():
+def test_get_root_folders_descendants(setup_data):
     client = EntityAPI()
     for f in client.descendants(None):
         assert f.entity_type == EntityType.FOLDER
         assert f.parent is None
 
 
-def test_get_root_folder1():
+def test_get_root_folder1(setup_data):
     client = EntityAPI()
     paged_set = client.children()
     assert paged_set.total > 0
@@ -39,7 +62,7 @@ def test_get_root_folder1():
     assert len(objs) == paged_set.total
 
 
-def test_get_root_folders_paged():
+def test_get_root_folders_paged(setup_data):
     client = EntityAPI()
     objs = set()
     url = None
@@ -56,7 +79,7 @@ def test_get_root_folders_paged():
     assert len(objs) == paged_set.total
 
 
-def test_get_children_of_folder():
+def test_get_children_of_folder(setup_data):
     client = EntityAPI()
     paged_set = client.children(FOLDER_ID)
     assert paged_set.total == 171
@@ -65,7 +88,7 @@ def test_get_children_of_folder():
         assert f.parent == FOLDER_ID
 
 
-def test_get_children_of_folder_descendants():
+def test_get_children_of_folder_descendants(setup_data):
     client = EntityAPI()
     objs = set()
     for f in client.descendants(FOLDER_ID):

{pypreservica-2.8.2 → pypreservica-2.9.1}/tests/test_content_api.py

@@ -7,7 +7,30 @@ ASSET_ID = "683f9db7-ff81-4859-9c03-f68cfa5d9c3d"
 CO_ID = "0f2997f7-728c-4e55-9f92-381ed1260d70"
 
 
-def test_get_asset_details():
+
+
+def setup():
+    pass
+
+
+def tear_down():
+    pass
+
+
+@pytest.fixture
+def setup_data():
+    print("\nSetting up resources...")
+
+    setup()
+
+    yield
+
+    print("\nTearing down resources...")
+
+    tear_down()
+
+
+def test_get_asset_details(setup_data):
     client = ContentAPI()
     json_dict = client.object_details(EntityType.ASSET, ASSET_ID)
     assert json_dict is not None
@@ -15,41 +38,41 @@ def test_get_asset_details():
     assert json_dict['name'] == 'LC-USZ62-20901'
 
 
-def test_download_asset():
+def test_download_asset(setup_data):
     client = ContentAPI()
     filename = client.download(ASSET_ID, "filename.img")
     assert os.path.exists(filename)
     os.remove(filename)
 
 
-def test_download_folder():
+def test_download_folder(setup_data):
     client = ContentAPI()
     with pytest.raises(RuntimeError):
         filename = client.download(FOLDER_ID, "filename.img")
 
 
-def test_get_thumbnail_small():
+def test_get_thumbnail_small(setup_data):
     client = ContentAPI()
     small = client.thumbnail("IO", "464444f7-8a6e-40f3-86c3-1dd2a51cfeeb", "filename.img", Thumbnail.SMALL)
     assert os.path.exists(small)
     os.remove(small)
 
 
-def test_get_thumbnail_med():
+def test_get_thumbnail_med(setup_data):
     client = ContentAPI()
     med = client.thumbnail("IO", "8d268bed-93d7-449b-91e4-2e7e86562a07", "filename.img", Thumbnail.MEDIUM)
     assert os.path.exists(med)
     os.remove(med)
 
 
-def test_get_thumbnail_large():
+def test_get_thumbnail_large(setup_data):
     client = ContentAPI()
     large = client.thumbnail("IO", "d5048e76-79c5-4ca7-99c9-a202c8f6dc8b", "filename.img", Thumbnail.LARGE)
     assert os.path.exists(large)
     os.remove(large)
 
 
-def test_get_indexed_fields():
+def test_get_indexed_fields(setup_data):
     client = ContentAPI()
     fields = client.indexed_fields()
     assert fields is not None
@@ -57,24 +80,24 @@ def test_get_indexed_fields():
     assert 'xip.description' in fields
 
 
-def test_simple_search_list():
+def test_simple_search_list(setup_data):
     client = ContentAPI()
     results = list(client.simple_search_list(query="pyPreservica"))
-    assert len(results) == 2
+    assert len(results) == 5
     assert results.pop()['xip.reference'] == '9fd239eb-19a3-4a46-9495-40fd9a5d8f93'
 
 
-def test_simple_search_list2():
+def test_simple_search_list2(setup_data):
     client = ContentAPI()
 
     columns = ["xip.reference", "xip.title", "xip.description", "xip.document_type"]
 
     results = list(client.simple_search_list("pyPreservica", 25, columns))
-    assert len(results) == 2
+    assert len(results) == 5
     assert results.pop()['xip.reference'] == '9fd239eb-19a3-4a46-9495-40fd9a5d8f93'
 
 
-def test_field_search():
+def test_field_search(setup_data):
     search = ContentAPI()
     for result in search.search_index_filter_list(query="%", filter_values={"xip.security_descriptor": "open",
                                                                          "xip.document_type": "IO",

{pypreservica-2.8.2 → pypreservica-2.9.1}/tests/test_identifier.py

@@ -6,7 +6,40 @@ ASSET_ID = "683f9db7-ff81-4859-9c03-f68cfa5d9c3d"
 CO_ID = "0f2997f7-728c-4e55-9f92-381ed1260d70"
 
 
-def test_get_entity_by_identifier():
+def delete_identifiers():
+    client = EntityAPI()
+    folder = client.folder(FOLDER_ID)
+    for i in client.identifiers_for_entity(folder):
+        client.delete_identifiers(folder, i[0], i[1])
+
+    asset = client.asset(ASSET_ID)
+    for i in client.identifiers_for_entity(asset):
+        client.delete_identifiers(asset, i[0], i[1])
+
+    co = client.content_object(CO_ID)
+    for i in client.identifiers_for_entity(co):
+        client.delete_identifiers(co, i[0], i[1])
+
+
+@pytest.fixture
+def setup_data():
+    print("\nSetting up resources...")
+
+    client = EntityAPI()
+    folder = client.folder(FOLDER_ID)
+
+    delete_identifiers()
+
+    client.add_identifier(folder, "code", "Amelia Earhart")
+
+    yield
+
+    print("\nTearing down resources...")
+
+    delete_identifiers()
+
+
+def test_get_entity_by_identifier(setup_data):
     client = EntityAPI()
     list_of_objects = client.identifier("code", "Amelia Earhart")
     assert len(list_of_objects) == 1
@@ -16,7 +49,7 @@ def test_get_entity_by_identifier():
     assert entity.reference == FOLDER_ID
 
 
-def test_add_identifier_folder():
+def test_add_identifier_folder(setup_data):
     client = EntityAPI()
     folder = client.folder(FOLDER_ID)
     client.add_identifier(folder, "ISBN", "1234567890")
@@ -26,7 +59,7 @@ def test_add_identifier_folder():
     assert entity.reference == folder.reference
 
 
-def test_add_identifier_asset():
+def test_add_identifier_asset(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
     client.add_identifier(asset, "ARK", "1234567890")
@@ -37,7 +70,7 @@ def test_add_identifier_asset():
     assert len(client.identifiers_for_entity(asset)) == 1
 
 
-def test_add_identifier_content_obj():
+def test_add_identifier_content_obj(setup_data):
     client = EntityAPI()
     content_object = client.content_object(CO_ID)
     client.add_identifier(content_object, "CO", "12333")
@@ -48,11 +81,15 @@ def test_add_identifier_content_obj():
     assert len(client.identifiers_for_entity(content_object)) == 1
 
 
-def test_get_identifier_folder():
+def test_get_identifier_folder(setup_data):
     client = EntityAPI()
     folder = client.folder(FOLDER_ID)
+
+    client.add_identifier(folder, "ISBN", "1234567890")
+    client.add_identifier(folder, "ARK", "1234567890")
+
     identifiers = client.identifiers_for_entity(folder)
-    assert len(identifiers) == 2
+    assert len(identifiers) == 3
     test_pass = False
     for identifier in identifiers:
         if "ISBN" in identifier:
@@ -61,9 +98,12 @@ def test_get_identifier_folder():
     assert test_pass
 
 
-def test_get_identifier_asset():
+def test_get_identifier_asset(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
+
+    client.add_identifier(asset, "ARK", "1234567890")
+
     identifiers = client.identifiers_for_entity(asset)
     assert len(identifiers) == 1
     test_pass = False
@@ -74,9 +114,12 @@ def test_get_identifier_asset():
     assert test_pass
 
 
-def test_delete_identifier_folder():
+def test_delete_identifier_folder(setup_data):
     client = EntityAPI()
     folder = client.folder(FOLDER_ID)
+
+    client.add_identifier(folder, "ISBN", "1234567890")
+
     entity_set = client.identifier("ISBN", "1234567890")
     assert len(entity_set) == 1
     entity = entity_set.pop()
@@ -89,9 +132,12 @@ def test_delete_identifier_folder():
     assert len(identifiers) == 1
 
 
-def test_delete_identifier_asset():
+def test_delete_identifier_asset(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
+
+    client.add_identifier(asset, "ARK", "1234567890")
+
     entity_set = client.identifier("ARK", "1234567890")
     assert len(entity_set) == 1
     entity = entity_set.pop()
@@ -101,9 +147,12 @@ def test_delete_identifier_asset():
     assert len(entity_set) == 0
 
 
-def test_delete_identifier_co():
+def test_delete_identifier_co(setup_data):
     client = EntityAPI()
     content_object = client.content_object(CO_ID)
+
+    client.add_identifier(content_object, "CO", "12333")
+
     entity_set = client.identifier("CO", "12333")
     assert len(entity_set) == 1
     entity = entity_set.pop()
@@ -113,7 +162,7 @@ def test_delete_identifier_co():
     assert len(entity_set) == 0
 
 
-def test_add_same_id_to_asset_folder():
+def test_add_same_id_to_asset_folder(setup_data):
     client = EntityAPI()
     asset = client.asset(ASSET_ID)
     folder = client.folder(FOLDER_ID)
@@ -129,3 +178,19 @@ def test_add_same_id_to_asset_folder():
     client.delete_identifiers(folder, "DOI", "123456:98776")
     entity_set = client.identifier("DOI", "123456:98776")
     assert len(entity_set) == 0
+
+
+def test_can_update_identifier(setup_data):
+    client = EntityAPI()
+    folder = client.folder(FOLDER_ID)
+    client.add_identifier(folder, "ISBN", "ISBN_0001")
+    entity_set = client.identifier("ISBN", "ISBN_0001")
+    assert len(entity_set) == 1
+    entity = entity_set.pop()
+    assert entity.reference == folder.reference
+    client.update_identifiers(folder, "ISBN", "ISBN_0002")
+    entity_set = client.identifier("ISBN", "ISBN_0002")
+    assert len(entity_set) == 1
+    entity = entity_set.pop()
+    assert entity.reference == folder.reference
+    client.delete_identifiers(folder, "ISBN", "ISBN_0002")

{pypreservica-2.8.2 → pypreservica-2.9.1}/tests/test_par.py

@@ -6,7 +6,7 @@ from pyPreservica import *
 def test_format_families():
     par = PreservationActionRegistry()
     document = par.format_families()
-    assert len(json.loads(document)['formatFamilies']) == 185
+    assert len(json.loads(document)['formatFamilies']) == 190
 
 
 def test_format():

{pypreservica-2.8.2 → pypreservica-2.9.1}/tests/test_retention.py

@@ -14,7 +14,7 @@ def test_get_policy_by_name():
 
 def test_get_policies():
     retention = RetentionAPI()
-    for p in retention.policies():
+    for p in retention.policies().results:
         print(p.name)
         print(p.reference)
         print(p.description)
@@ -106,7 +106,7 @@ def test_add_assignments():
 
     assert len(retention_assignments) == 0
 
-    policy = retention.policies().pop()
+    policy = retention.policies().results.pop()
 
     if not policy.assignable:
         retention.assignable_policy(policy.reference, True)
@@ -126,7 +126,7 @@ def test_add_assignments():
 
 def test_zdelete_policy():
     retention = RetentionAPI()
-    for policy in retention.policies():
+    for policy in retention.policies().results:
         if policy.name == "API Created Policy1":
             retention.delete_policy(policy.reference)
 

pypreservica-2.8.2/tests/test_authority_records.py

@@ -1,20 +0,0 @@
-import pytest
-from pyPreservica import *
-
-
-def test_get_tables():
-    client = AuthorityAPI()
-    results = client.tables()
-    assert isinstance(results, set)
-    for table in results:
-        assert isinstance(table, Table)
-        assert table.name in ["Countries",  'Physical Storage']
-
-
-def test_get_records():
-    client = AuthorityAPI()
-    tables = client.tables()
-    for tab in tables:
-        records = client.records(tab)
-
-