pyPreservica 2.7.4__py3-none-any.whl → 2.8.0__py3-none-any.whl

pyPreservica/__init__.py

@@ -18,11 +18,11 @@ from .adminAPI import AdminAPI
 from .monitorAPI import MonitorAPI, MonitorCategory, MonitorStatus, MessageStatus
 from .webHooksAPI import WebHooksAPI, TriggerType, WebHookHandler
 from .authorityAPI import AuthorityAPI, Table
-from .mdformsAPI import MDFormsAPI
+from .mdformsAPI import MetadataGroupsAPI, GroupFieldType, GroupField, Group
 
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "2.7.4"
+__version__ = "2.8.0"
 
 __license__ = "Apache License Version 2.0"

pyPreservica/mdformsAPI.py

@@ -10,12 +10,64 @@ licence:    Apache License 2.0
 """
 import json
 import xml.etree.ElementTree
-from typing import Callable
+from typing import Callable, List
 
 from pyPreservica.common import *
 
 
-class MDFormsAPI(AuthenticatedAPI):
+class GroupFieldType(Enum):
+    STRING = "STRING"
+    LONG_STRING = "LONGSTRING"
+    DATE = "DATE"
+    NUMBER = "NUMBER"
+
+
+class GroupField:
+    field_id: str
+    name: str
+    field_type: GroupFieldType
+    maxLength: int
+    default: str
+    visible: bool
+    editable: bool
+    minOccurs: int
+    maxOccurs: int
+    values: List[str]
+    indexed: bool
+
+    def __init__(self, field_id: str, name: str, field_type: GroupFieldType = GroupFieldType.STRING,
+                 maxLength: int = -1, default: str = "", visible: bool = True, editable: bool = True,
+                 minOccurs: int = 0, maxOccurs: int = 1, indexed: bool = True, values: List = None):
+        self.field_id = field_id
+        self.name = name
+        self.field_type = field_type
+        self.maxLength = maxLength
+        self.default = default
+        self.visible = visible
+        self.editable = editable
+        self.minOccurs = minOccurs
+        self.maxOccurs = maxOccurs
+        self.values = values
+        self.indexed = indexed
+
+    def __str__(self):
+        return (f"Field ID: {self.field_id}\n" + f"Field Name: {self.name}\n" + f"Field Type: {self.field_type}\n" +
+                f"Field Visible: {self.visible}\n" + f"Field Editable: {self.editable}\n")
+
+
+class Group:
+    group_id: str
+    name: str
+    description: str
+    schemaUri: str
+    fields: List[GroupField] = []
+
+    def __str__(self):
+        return (f"Group ID: {self.group_id}\n" + f"Group Name: {self.name}\n" +
+                f"Group Description: {self.description}\n" + f"Group Schema URI: {self.schemaUri}")
+
+
+class MetadataGroupsAPI(AuthenticatedAPI):
     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", request_hook: Callable = None):
@@ -26,18 +78,38 @@ class MDFormsAPI(AuthenticatedAPI):
         xml.etree.ElementTree.register_namespace("oai_dc", "http://www.openarchives.org/OAI/2.0/oai_dc/")
         xml.etree.ElementTree.register_namespace("ead", "urn:isbn:1-931666-22-9")
 
-    def delete_group(self, id: str):
+    def delete_group_namespace(self, schema: str):
         """
-        Delete a group
-        :param id: Group ID
-        :return:
+         Delete a new Metadata Group using its schema URI
+
+         :param schema: The Group namespace schema URI
+         :type schema: str
+
+         :return: None
+         :rtype: None
+
+         """
+        for group in self.groups():
+            if group.schemaUri == schema:
+                self.delete_group(group.group_id)
+
+    def delete_group(self, group_id: str):
         """
+         Delete a new Metadata Group using its ID
+
+         :param group_id: Group ID
+         :type group_id: str
+
+         :return: None
+         :rtype: None
+
+         """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json;charset=UTF-8'}
-        url = f'{self.protocol}://{self.server}/api/metadata/groups/{id}'
+        url = f'{self.protocol}://{self.server}/api/metadata/groups/{group_id}'
         with self.session.delete(url, headers=headers) as request:
             if request.status_code == requests.codes.unauthorized:
                 self.token = self.__token__()
-                return self.delete_group(id)
+                return self.delete_group(group_id)
             elif request.status_code == requests.codes.no_content:
                 return None
             else:
@@ -46,60 +118,183 @@ class MDFormsAPI(AuthenticatedAPI):
                 logger.error(exception)
                 raise exception
 
-    def add_group(self, document):
+    def add_group(self, group_name: str, group_description: str, fields: List[GroupField]):
         """
-        Add a new group
-        :return:
+          Create a new Metadata Group GroupFields
+
+          :param group_name: The name of the new Group
+          :type group_name: str
+
+          :param group_description: The description of the new Group
+          :type group_description: str
+
+          :param fields: The list of fields
+          :type fields: List[GroupField]
+
+          :return:  JSON document
+          :rtype: str
+
+          """
+
+        fields_str_list = []
+        for field in fields:
+
+            values = ""
+            if (field.values is not None) and (len(field.values) > 0):
+                values = f"""\n"values" : [ {",".join('"' + item + '"' for item in field.values)} ],
+                """
+
+            fields_str = f"""{{
+            "id" : "{field.field_id}",
+            "name": "{field.name}",
+            "type": "{field.field_type.value}",
+            "minOccurs": "{field.minOccurs}",
+            "maxOccurs": "{field.maxOccurs}",
+            "visible": "{field.visible}", {values}
+            "editable": "{field.editable}",
+            "defaultValue": "{field.default}",
+            "indexed": "{field.indexed}"
+            }}"""
+            
+            fields_str_list.append(fields_str)
+
+        json_doc = f"""{{
+          "name" : "{group_name}",
+          "description" : "{group_description}",
+          "fields" : [ {",".join(fields_str_list)}  ]
+        }}"""
+
+        print(json_doc)
+
+        json_response = self.add_group_json(json_doc)
+        group_id = json_response['id']
+        return self.group(group_id)
+
+    def add_group_json(self, json_document: str) -> str:
         """
+         Create a new Metadata Group using a JSON document
+
+         :param json_document: JSON document
+         :type json_document: str
+
+         :return:  JSON document
+         :rtype: str
+
+         """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json;charset=UTF-8'}
         url = f'{self.protocol}://{self.server}/api/metadata/groups/'
-        with self.session.post(url, headers=headers, json=document) as request:
+        with self.session.post(url, headers=headers, data=json_document) as request:
             if request.status_code == requests.codes.unauthorized:
                 self.token = self.__token__()
-                return self.add_group(document)
+                return self.add_group_json(json_document)
             elif request.status_code == requests.codes.created:
                 return json.loads(str(request.content.decode('utf-8')))
             else:
-                exception = HTTPException(None, request.status_code, request.url, "group",
+                exception = HTTPException(None, request.status_code, request.url, "add_group_json",
                                           request.content.decode('utf-8'))
                 logger.error(exception)
                 raise exception
 
-    def group(self, id: str):
-        """
-        Fetch a metadata Group by its id
-        :param id: The group ID
-        :return: JSON Document
+    def group_json(self, group_id: str) -> str:
         """
+         Return a Group as a JSON document
+
+         :param group_id: The Group id
+         :type group_id: str
+
+         :return:  JSON document
+         :rtype: str
+
+         """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json;charset=UTF-8'}
-        url = f'{self.protocol}://{self.server}/api/metadata/groups/{id}'
+        url = f'{self.protocol}://{self.server}/api/metadata/groups/{group_id}'
         with self.session.get(url, headers=headers) as request:
             if request.status_code == requests.codes.unauthorized:
                 self.token = self.__token__()
-                return self.group(id)
+                return self.group_json(group_id)
             elif request.status_code == requests.codes.ok:
-                return json.loads(str(request.content.decode('utf-8')))
+                return str(request.content.decode('utf-8'))
             else:
-                exception = HTTPException(None, request.status_code, request.url, "group",
+                exception = HTTPException(None, request.status_code, request.url, "group_json",
                                           request.content.decode('utf-8'))
                 logger.error(exception)
                 raise exception
 
-    def groups(self):
+    def group(self, group_id: str) -> Group:
         """
-        Fetch all the Metadata Groups as JSON
-        :return: JSON Document
+         Return a Group object by its id
+
+         :param group_id: The Group id
+         :type group_id: str
+
+         :return: The Group
+         :rtype: Group
+
+         """
+        json_group = json.loads(self.group_json(group_id))
+        group: Group = Group()
+        group.group_id = json_group['id']
+        group.name = json_group['name']
+        group.description = json_group['description']
+        group.schemaUri = json_group['schemaUri']
+
+        for f in json_group['fields']:
+            gf: GroupField = GroupField(f['id'], f['name'])
+            if 'type' in f:
+                gf.field_type = f['type']
+            if 'visible' in f:
+                gf.visible = f['visible']
+            if 'editable' in f:
+                gf.editable = f['editable']
+            if 'indexed' in f:
+                gf.indexed = f['indexed']
+            if 'maxOccurs' in f:
+                gf.maxOccurs = f['maxOccurs']
+            if 'minOccurs' in f:
+                gf.minOccurs = f['minOccurs']
+            if 'values' in f:
+                gf.values = f['values']
+            group.fields.append(gf)
+        return group
+
+    def groups_json(self) -> str:
+        """
+        Return all the groups in the tenancy as a single json document
+
+        :return: JSON document
+        :rtype: str
+
         """
+
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json;charset=UTF-8'}
         url = f'{self.protocol}://{self.server}/api/metadata/groups'
         with self.session.get(url, headers=headers) as request:
             if request.status_code == requests.codes.unauthorized:
                 self.token = self.__token__()
-                return self.groups()
+                return self.groups_json()
             elif request.status_code == requests.codes.ok:
-                return json.loads(str(request.content.decode('utf-8')))['groups']
+                return str(request.content.decode('utf-8'))
             else:
-                exception = HTTPException(None, request.status_code, request.url, "groups",
+                exception = HTTPException(None, request.status_code, request.url, "groups_json",
                                           request.content.decode('utf-8'))
                 logger.error(exception)
                 raise exception
+
+    def groups(self) -> List[Group]:
+        """
+        Return all the groups in the tenancy
+
+        :return: list of Groups
+        :rtype: List[Group]
+
+        """
+        groups = json.loads(self.groups_json())['groups']
+        return_groups = []
+        for g in groups:
+            group: Group = Group()
+            group.group_id = g['id']
+            group.name = g['name']
+            group.description = g['description']
+            group.schemaUri = g['schemaUri']
+            return_groups.append(group)
+        return return_groups

{pyPreservica-2.7.4.dist-info → pyPreservica-2.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyPreservica
-Version: 2.7.4
+Version: 2.8.0
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr

{pyPreservica-2.7.4.dist-info → pyPreservica-2.8.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-pyPreservica/__init__.py,sha256=RmOn1lvHV9iH7Hmz5YQ0F06ASdqetV0_-m1I8S4erqY,1117
+pyPreservica/__init__.py,sha256=n3os4whOUblwQ3BSk4BaWy25gjYuknQXRVyu8C7tG9k,1159
 pyPreservica/adminAPI.py,sha256=511bc5KtrCAXbDyBk39dmDnxUVDaOu6xaiyu0jYhxa4,37781
 pyPreservica/authorityAPI.py,sha256=Eule8g6LXr8c8SFcJgpRah4lH1FgevUItO5HhHDEaZE,9172
 pyPreservica/common.py,sha256=yZNMlq8aOOLSbFS2DDHYBUWyN5ojDjYUYmcePVbUd44,37636
 pyPreservica/contentAPI.py,sha256=F3VwaybSUel0OfhWOckqfM77AVQCD1erHbu-Xrv4cd0,17388
 pyPreservica/entityAPI.py,sha256=f-RlCEtUq0KDB62LuSPy0Kb-lT6Hp2gPOmSiTeomqkM,114853
-pyPreservica/mdformsAPI.py,sha256=As5YN5m1k59N6SpM8fLldVviJ0n4lhlZD8rV5v0Jehs,4698
+pyPreservica/mdformsAPI.py,sha256=QAO7QuuY0emgUCDZGlTMv2AB6ACx0SZjrCTaegbkr9U,10693
 pyPreservica/monitorAPI.py,sha256=HD-PUPdSI9wGAa07e2_2_-FLINH8PoWUwpFogz7F-j4,6269
 pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
 pyPreservica/parAPI.py,sha256=bgaQvYfWNnzdD7ibKMV3ZV85pNkEdSoLsgVigoiFFfw,10771
@@ -12,8 +12,8 @@ pyPreservica/retentionAPI.py,sha256=EmQvmUW_I_sPslCiTZDZ2uqloesjfxmmc5AQImWX2cs,
 pyPreservica/uploadAPI.py,sha256=Nl6Z4h1cW9TmZyrhVLPff3jSAnzCdkfn0xDJ9Q_ZhdI,96444
 pyPreservica/webHooksAPI.py,sha256=0wP-59mep8gtlIZ9P5vV68-HnNdTuuo2kzGcDWj0bNg,6790
 pyPreservica/workflowAPI.py,sha256=wDDR5_CsJ3dhX79E5mJaziAtgYb830J0ZpNJppzgvqk,17493
-pyPreservica-2.7.4.dist-info/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pyPreservica-2.7.4.dist-info/METADATA,sha256=bbipiUj1ByD22LxVh2X7a3ytTLitfSt9GVi_nKfVoXs,2784
-pyPreservica-2.7.4.dist-info/WHEEL,sha256=YiKiUUeZQGmGJoR_0N1Y933DOBowq4AIvDe2-UIy8E4,91
-pyPreservica-2.7.4.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
-pyPreservica-2.7.4.dist-info/RECORD,,
+pyPreservica-2.8.0.dist-info/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pyPreservica-2.8.0.dist-info/METADATA,sha256=m9mNmQ7QyvMrAK7G0jyWKYoJHp79P_ExSmJyCJi62mA,2784
+pyPreservica-2.8.0.dist-info/WHEEL,sha256=YiKiUUeZQGmGJoR_0N1Y933DOBowq4AIvDe2-UIy8E4,91
+pyPreservica-2.8.0.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
+pyPreservica-2.8.0.dist-info/RECORD,,