pyPreservica 3.0.6__tar.gz → 3.1.1__tar.gz

{pypreservica-3.0.6 → pypreservica-3.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: pyPreservica
-Version: 3.0.6
+Version: 3.1.1
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -16,7 +16,6 @@ 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
 Description-Content-Type: text/markdown
@@ -39,6 +38,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-dist
 Dynamic: summary

{pypreservica-3.0.6 → pypreservica-3.1.1}/pyPreservica/__init__.py

@@ -34,6 +34,6 @@ from .mdformsAPI import MetadataGroupsAPI, Group, GroupField, GroupFieldType
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "3.0.6"
+__version__ = "3.1.1"
 
 __license__ = "Apache License Version 2.0"

{pypreservica-3.0.6 → pypreservica-3.1.1}/pyPreservica/common.py

@@ -853,6 +853,7 @@ class AuthenticatedAPI:
                         if self.tenant is None:
                             self.tenant = response.json()['tenant']
                         if self.two_fa_secret_key:
+                            logger.debug("Found Two Factor Token")
                             totp = pyotp.TOTP(self.two_fa_secret_key)
                             data = {'username': self.username,
                                     'continuationToken': response.json()['continuationToken'],
@@ -865,8 +866,8 @@ class AuthenticatedAPI:
                             else:
                                 msg = "Failed to create a 2FA authentication token. Check your credentials are correct"
                                 logger.error(msg)
-                                logger.error(str(response.content))
-                                raise RuntimeError(response.status_code, msg)
+                                logger.error(str(response_2fa.content))
+                                raise RuntimeError(response_2fa.status_code, msg)
                         else:
                             msg = "2FA twoFactorToken required to authenticate against this account using 2FA"
                             logger.error(msg)

{pypreservica-3.0.6 → pypreservica-3.1.1}/pyPreservica/entityAPI.py

@@ -918,7 +918,7 @@ class EntityAPI(AuthenticatedAPI):
                     content.append(tree.getroot())
                 else:
                     raise RuntimeError("Unknown data type")
-                xml_request = xml.etree.ElementTree.tostring(xml_object, encoding='utf-8')
+                xml_request = xml.etree.ElementTree.tostring(xml_object, encoding='utf-8').decode("utf-8")
                 logger.debug(xml_request)
                 request = self.session.put(url, data=xml_request, headers=headers)
                 if request.status_code == requests.codes.ok:
@@ -2126,9 +2126,15 @@ class EntityAPI(AuthenticatedAPI):
             actions = entity_response.findall(f'.//{{{self.xip_ns}}}EventAction')
             result_list = []
             for action in actions:
-                entity_ref = action.findall(f'.//{{{self.xip_ns}}}Entity')
-                for refs in entity_ref:
-                    result_list.append(refs.text)
+                item: dict = {}
+                event = action.find(f'.//{{{self.xip_ns}}}Event')
+                event_type = event.attrib["type"]
+                item['EventType'] = event_type
+                entity_date = action.find(f'.//{{{self.xip_ns}}}Date')
+                item['Date'] = entity_date.text
+                entity_ref = action.find(f'.//{{{self.xip_ns}}}Entity')
+                item['Entity'] = entity_ref.text
+                result_list.append(item)
             next_url = entity_response.find(f'.//{{{self.entity_ns}}}Next')
             total_hits = entity_response.find(f'.//{{{self.entity_ns}}}TotalResults')
             has_more = True
@@ -2162,6 +2168,9 @@ class EntityAPI(AuthenticatedAPI):
             params["from"] = kwargs.get("from_date")
         if "to_date" in kwargs:
             params["to"] = kwargs.get("to_date")
+        if "username" in kwargs:
+            params["username"] = kwargs.get("username")
+
 
         if next_page is None:
             request = self.session.get(f'{self.protocol}://{self.server}/api/entity/events', params=params,

{pypreservica-3.0.6 → pypreservica-3.1.1}/pyPreservica/uploadAPI.py

@@ -911,17 +911,22 @@ def complex_asset_package(preservation_files_list=None, access_files_list=None,
     if has_preservation_files:
         if default_asset_title is None:
             default_asset_title = os.path.splitext(os.path.basename(preservation_files_list[0]))[0]
-
         # create the asset
-        xip, io_ref = __create_io__(file_name=default_asset_title, parent_folder=parent_folder, **kwargs)
+        if io_ref is None:
+            xip, io_ref = __create_io__(file_name=default_asset_title, parent_folder=parent_folder, **kwargs)
 
     if has_access_files:
         if default_asset_title is None:
             default_asset_title = os.path.splitext(os.path.basename(access_files_list[0]))[0]
-
         if io_ref is None:
             xip, io_ref = __create_io__(file_name=default_asset_title, parent_folder=parent_folder, **kwargs)
 
+    if io_ref is None:
+        default_asset_title = kwargs.get('Title', None)
+        if default_asset_title is None:
+            default_asset_title = "New Asset"
+        xip, io_ref = __create_io__(file_name=default_asset_title, parent_folder=parent_folder, **kwargs)
+
     if has_preservation_files:
         # add the content objects
         representation_name = kwargs.get('Preservation_Representation_Name', "Preservation")

{pypreservica-3.0.6 → pypreservica-3.1.1}/pyPreservica.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: pyPreservica
-Version: 3.0.6
+Version: 3.1.1
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -16,7 +16,6 @@ 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
 Description-Content-Type: text/markdown
@@ -39,6 +38,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-dist
 Dynamic: summary

{pypreservica-3.0.6 → pypreservica-3.1.1}/setup.py

@@ -21,7 +21,7 @@ if sys.argv[-1] == 'publish':
 # This call to setup() does all the work
 setup(
     name=PKG,
-    version="3.0.6",
+    version="3.1.1",
     description="Python library for the Preservica API",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -37,7 +37,6 @@ setup(
         '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-3.0.6 → pypreservica-3.1.1}/tests/test_content_api.py

@@ -84,7 +84,7 @@ def test_simple_search_list(setup_data):
     client = ContentAPI()
     results = list(client.simple_search_list(query="pyPreservica"))
     assert len(results) == 5
-    assert results.pop()['xip.reference'] == '9fd239eb-19a3-4a46-9495-40fd9a5d8f93'
+    assert results.pop()['xip.reference'] == '7fbeba9f-8067-46d9-bb00-8c8c7b3b0475'
 
 
 def test_simple_search_list2(setup_data):
@@ -94,7 +94,7 @@ def test_simple_search_list2(setup_data):
 
     results = list(client.simple_search_list("pyPreservica", 25, columns))
     assert len(results) == 5
-    assert results.pop()['xip.reference'] == '9fd239eb-19a3-4a46-9495-40fd9a5d8f93'
+    assert results.pop()['xip.reference'] == '7fbeba9f-8067-46d9-bb00-8c8c7b3b0475'
 
 
 def test_field_search(setup_data):

{pypreservica-3.0.6 → pypreservica-3.1.1}/tests/test_metadata.py

@@ -9,14 +9,25 @@ from pyPreservica import *
 
 FOLDER_ID = "ebd977f6-bebd-4ecf-99be-e054989f9af4"
 ASSET_ID = "683f9db7-ff81-4859-9c03-f68cfa5d9c3d"
-CO_ID = "0f2997f7-728c-4e55-9f92-381ed1260d70"
-
-XML_DOCUMENT = "<person:Person  xmlns:person='https://www.person.com/person'>" \
-               "<person:Name>Name</person:Name>" \
-               "<person:Phone>01234 100 100</person:Phone>" \
-               "<person:Email>test@test.com</person:Email>" \
-               "<person:Address>Abingdon, UK</person:Address>" \
-               "</person:Person>"
+CO_ID =  "0f2997f7-728c-4e55-9f92-381ed1260d70"
+
+XML_DOCUMENT = """
+               <person:Person  xmlns:person="https://www.person.com/person">
+                   <person:Name>Name</person:Name>
+                   <person:Phone>01234 100 100</person:Phone>
+                   <person:Email>test@test.com</person:Email>
+                   <person:Address>Abingdon, UK</person:Address>
+               </person:Person>
+"""
+
+XML_DOCUMENT_NO_PREFIX = """
+               <Person xmlns="https://www.person.com/person">
+                   <Name>Name</Name>
+                   <Phone>01234 100 100</Phone>
+                   <Email>test@test.com</Email>
+                   <Address>Abingdon, UK</Address>
+               </Person>
+"""
 
 
 def test_get_folder_metadata():
@@ -50,6 +61,28 @@ def test_update_folder_metadata():
     folder = client.update_metadata(entity, "http://purl.org/dc/elements/1.1/", xml_string)
 
 
+def test_add_folder_metadata_no_prefix():
+    client = EntityAPI()
+    entity = client.entity(EntityType.FOLDER, FOLDER_ID)
+    folder = client.add_metadata(entity, "https://www.person.com/person", XML_DOCUMENT_NO_PREFIX)
+
+def test_add_folder_metadata_with_ns():
+    client = EntityAPI()
+    entity = client.entity(EntityType.FOLDER, FOLDER_ID)
+    folder = client.add_metadata(entity, "https://www.person.com/person", XML_DOCUMENT)
+
+def test_add_asset_metadata_no_prefix():
+    client = EntityAPI()
+    entity = client.entity(EntityType.ASSET, ASSET_ID)
+    folder = client.add_metadata(entity, "https://www.person.com/person", XML_DOCUMENT_NO_PREFIX)
+
+def test_add_asset_metadata_with_ns():
+    client = EntityAPI()
+    entity = client.entity(EntityType.ASSET, ASSET_ID)
+    folder = client.add_metadata(entity, "https://www.person.com/person", XML_DOCUMENT)
+
+
+
 def test_add_folder_metadata_string():
     client = EntityAPI()
     entity = client.entity(EntityType.FOLDER, FOLDER_ID)
@@ -85,8 +118,8 @@ def test_get_all_asset_metadata():
 
 def test_get_co_metadata():
     client = EntityAPI()
-    entity = client.entity(EntityType.CONTENT_OBJECT, CO_ID)
-    entity = client.delete_metadata(entity, "https://www.person.com/person")
+    entity_object = client.entity(EntityType.CONTENT_OBJECT, CO_ID)
+    entity = client.delete_metadata(entity_object, "https://www.person.com/person")
     xml_string = client.metadata_for_entity(entity, "https://www.person.com/person")
     assert xml_string is None
     co = client.add_metadata(entity, "https://www.person.com/person", XML_DOCUMENT)

{pypreservica-3.0.6 → pypreservica-3.1.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']) == 190
+    assert len(json.loads(document)['formatFamilies']) == 192
 
 
 def test_format():

{pypreservica-3.0.6 → pypreservica-3.1.1}/tests/test_schema.py

@@ -53,16 +53,16 @@ def test_get_xml_document_by_uri():
 
 def test_add_xml_document():
     client = AdminAPI()
-    client.delete_xml_document("http://www.crossref.org/schema/5.3.0")
-    xml = requests.get(
+    client.delete_xml_document("http://www.crossref.org/schema/5.4.0")
+    xml_doc = requests.get(
         "https://gitlab.com/crossref/schema/-/raw/master/best-practice-examples/book5.3.0.xml").content.decode("utf-8")
-    client.add_xml_document("book5.3.0", xml)
-    xml_document = client.xml_document("http://www.crossref.org/schema/5.3.0")
-    assert len(xml_document) == len(xml)
-    client.delete_xml_document("http://www.crossref.org/schema/5.3.0")
+    client.add_xml_document("book5.4.0", xml_doc)
+    xml_document = client.xml_document("http://www.crossref.org/schema/5.4.0")
+    assert len(xml_document) == len(xml_doc)
+    client.delete_xml_document("http://www.crossref.org/schema/5.4.0")
 
     with open("test_data/mods.xml", mode="rb") as fd:
-        client.add_xml_document("mods31", xml)
+        client.add_xml_document("mods31", xml_doc)
 
     xml_document = client.xml_document("http://www.loc.gov/mods/v31")
     client.delete_xml_document("http://www.loc.gov/mods/v31")