iris-pex-embedded-python 3.1.6b1__tar.gz → 3.2.0__tar.gz

{iris_pex_embedded_python-3.1.6b1 → iris_pex_embedded_python-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: iris_pex_embedded_python
-Version: 3.1.6b1
+Version: 3.2.0
 Summary: Iris Interoperability based on Embedded Python
 Author-email: grongier <guillaume.rongier@intersystems.com>
 License: MIT License
@@ -48,6 +48,8 @@ Requires-Dist: dacite>=1.6.0
 Requires-Dist: xmltodict>=0.12.0
 Requires-Dist: iris-embedded-python-wrapper>=0.0.6
 Requires-Dist: setuptools>=40.8.0
+Requires-Dist: dc-schema>=0.0.8
+Requires-Dist: jsonpath-ng>=1.7.0
 
 # IoP (Interoperability On Python)
 

{iris_pex_embedded_python-3.1.6b1 → iris_pex_embedded_python-3.2.0}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "iris_pex_embedded_python"
-version = "3.1.6b1"
+version = "3.2.0"
 description = "Iris Interoperability based on Embedded Python"
 readme = "README.md"
 authors = [
@@ -30,7 +30,9 @@ dependencies = [
     "dacite >=1.6.0",
     "xmltodict>=0.12.0",
     "iris-embedded-python-wrapper>=0.0.6",
-    "setuptools >= 40.8.0"
+    "setuptools>=40.8.0",
+    "dc-schema>=0.0.8",
+    "jsonpath-ng>=1.7.0"
 ]
 
 license = { file = "LICENSE" }

{iris_pex_embedded_python-3.1.6b1 → iris_pex_embedded_python-3.2.0}/src/iop/_message.py

@@ -1,6 +1,6 @@
 class _Message:
     """ The abstract class that is the superclass for persistent messages sent from one component to another.
     This class has no properties or methods. Users subclass Message and add properties.
-    The PEX framework provides the persistence to objects derived from the Message class.
+    The IOP framework provides the persistence to objects derived from the Message class.
     """
     pass

{iris_pex_embedded_python-3.1.6b1 → iris_pex_embedded_python-3.2.0}/src/iop/_utils.py

@@ -6,6 +6,8 @@ import inspect
 import xmltodict
 import pkg_resources
 import importlib
+import json
+from dc_schema import get_schema
 
 class _Utils():
     @staticmethod
@@ -33,6 +35,33 @@ class _Utils():
         if path:
             _Utils.raise_on_error(iris.cls('%SYSTEM.OBJ').LoadDir(path,'cubk',"*.cls",1))
 
+    @staticmethod
+    def register_message_schema(cls):
+        """
+        It takes a class and registers the schema
+        
+        :param cls: The class to register
+        """
+        schema = get_schema(cls)
+        schema_name = cls.__module__ + '.' + cls.__name__
+        schema_str = json.dumps(schema)
+        categories = schema_name
+        _Utils.register_schema(schema_name,schema_str,categories)
+
+    @staticmethod
+    def register_schema(schema_name:str, schema_str:str,categories:str):
+        """
+        It takes a schema name, a schema string, and a category string, and registers the schema
+        
+        :param schema_name: The name of the schema
+        :type schema_name: str
+        :param schema_str: The schema as a string
+        :type schema_str: str
+        :param categories: The categories of the schema
+        :type categories: str
+        """
+        _Utils.raise_on_error(iris.cls('IOP.Message.JSONSchema').Import(schema_str,categories,schema_name))
+
     @staticmethod
     def register_component(module:str,classname:str,path:str,overwrite:int=1,iris_classname:str='Python'):
         """
@@ -128,7 +157,7 @@ class _Utils():
                         extend = klass.bases[0].id
                     else:
                         extend = klass.bases[0].attr
-                if  extend in ('BusinessOperation','BusinessProcess','BusinessService','DuplexService','DuplexProcess','DuplexOperation','InboundAdapter','OutboundAdapter'):
+                if extend in ('BusinessOperation','BusinessProcess','BusinessService','DuplexService','DuplexProcess','DuplexOperation','InboundAdapter','OutboundAdapter'):
                     module = _Utils.filename_to_module(filename)
                     iris_class_name = f"{iris_package_name}.{module}.{klass.name}"
                     # strip "_" for iris class name
@@ -188,6 +217,8 @@ class _Utils():
                 list of dictionaries:
                 * key: the name of the production
                 * value: a dictionary containing the settings for the production
+            * SCHEMAS
+                List of classes
         """
         path = None
         # try to load the settings file
@@ -216,6 +247,12 @@ class _Utils():
             _Utils.set_productions_settings(settings.PRODUCTIONS,path)
         except AttributeError:
             print("No productions to register")
+        try:
+            # set the schemas
+            for cls in settings.SCHEMAS:
+                _Utils.register_message_schema(cls)
+        except AttributeError:
+            print("No schemas to register")
         try:
             sys.path.remove(path)
         except ValueError:

iris_pex_embedded_python-3.2.0/src/iop/cls/IOP/Message/JSONSchema.cls

@@ -0,0 +1,125 @@
+Class IOP.Message.JSONSchema Extends %Persistent
+{
+
+Property Name As %String;
+
+Property Category As %String;
+
+Property JSONSchema As %String(MAXLEN = "");
+
+Index NameIndex On Name [ IdKey, Unique ];
+
+/// Import a JSON Schema from file
+ClassMethod ImportFromFile(
+	pFileName As %String,
+	pCategory As %String = "",
+	pName As %String) As %Status
+{
+    Set pStatus = $$$OK
+    Try {
+        If '##class(%File).Exists(pFileName) {
+            Set pStatus = $$$ERROR($$$GeneralError, "File not found")
+            Return pStatus
+        }
+        Set tFile = ##class(%File).%New(pFileName)
+        $$$ThrowOnError(tFile.Open("R"))
+        Set tSchema = ""
+        While 'tFile.AtEnd {
+            Set tSchema = tSchema _ tFile.ReadLine()
+        }
+        Set pStatus = ..Import(tSchema, pCategory, pName)
+    } Catch ex {
+        Set pStatus = ex.AsStatus()
+    }
+    Return pStatus
+}
+
+/// Store the JSON Schema in this object
+ClassMethod Import(
+	pSchema As %String,
+	pCategory As %String = "",
+	pName As %String) As %Status
+{
+    Set pStatus = $$$OK
+    Try {
+        if ##class(IOP.Message.JSONSchema).%ExistsId(pName) {
+            Set tThis = ##class(IOP.Message.JSONSchema).%OpenId(pName)
+            Set tThis.Category = pCategory
+            Set tThis.JSONSchema = pSchema
+            $$$ThrowOnError(tThis.%Save())
+        } Else {
+            Set tThis = ##class(IOP.Message.JSONSchema).%New()
+            Set tThis.Name = pName
+            Set tThis.Category = pCategory
+            Set tThis.JSONSchema = pSchema
+            $$$ThrowOnError(tThis.%Save())
+        }
+    } Catch ex {
+        Set pStatus = ex.AsStatus()
+    }
+    Quit pStatus
+}
+
+/// Get a stored schema by category and name
+ClassMethod GetSchema(
+	pName As %String = "",
+	Output pSchema As %String) As %Status
+{
+    Set pStatus = $$$OK
+    Try {
+        Set tSql = "SELECT JSONSchema FROM IOP_Message.JSONSchema WHERE Name = ?"
+        Set tStatement = ##class(%SQL.Statement).%New()
+        Do tStatement.%Prepare(tSql)
+        set rs = tStatement.%Execute(pName)
+        If rs.%Next() {
+            Set pSchema = rs.%Get("JSONSchema")
+        } Else {
+            Set pStatus = $$$ERROR($$$GeneralError, "Schema not found")
+        }
+    } Catch ex {
+        Set pStatus = ex.AsStatus()
+    }
+    Return pStatus
+}
+
+/// Validate JSON data against a stored schema
+ClassMethod ValidateJSONSchema(
+	pJSON As %String,
+	pName As %String) As %Status
+{
+    Set tSC = $$$OK
+    Try {
+        Set tSchema = ""
+        Set tSC = ..GetSchema(pName, .tSchema)
+        If $$$ISERR(tSC) Return tSC
+        // Validate JSON data against schema
+        // To be implemented
+        Set tSC = $$$OK
+    } Catch ex {
+        Set tSC = ex.AsStatus()
+    }
+    Return tSC
+}
+
+Storage Default
+{
+<Data name="JSONSchemaDefaultData">
+<Value name="1">
+<Value>%%CLASSNAME</Value>
+</Value>
+<Value name="2">
+<Value>JSONSchema</Value>
+</Value>
+<Value name="3">
+<Value>Category</Value>
+</Value>
+</Data>
+<DataLocation>^IOP.Message.JSONSchemaD</DataLocation>
+<DefaultData>JSONSchemaDefaultData</DefaultData>
+<IdLocation>^IOP.Message.JSONSchemaD</IdLocation>
+<IndexLocation>^IOP.Message.JSONSchemaI</IndexLocation>
+<StreamLocation>^IOP.Message.JSONSchemaS</StreamLocation>
+<Type>%Storage.Persistent</Type>
+}
+
+}