Version 1.1 Release Candidate

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
         run: python3 setup.py sdist
 
       - name: Install Python module
-        run: pip3 install ./dist/microesb-1.0.tar.gz
+        run: pip3 install ./dist/microesb-1.1.tar.gz
 
       - name: Run tests
         run: pytest --cov --cov-branch --cov-report=xml

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+
+## Version 1.1
+
+- Add user-based service call routing via ServiceRouter class
+- Introduce `property_dict` functionality for flexible property access excluding internal system properties
+- Support recursive class hierarchy object deserialization in ServiceExecuter
+- Improve JSONTransformer robustness with `_SYSClassNames` tracking for hierarchy processing
+- Add property registration feature for internal system properties via `register_property()`
+- Modify Example 02 to use NoSQL MongoDB backend for certificate management
+- Add Example 04 with NLAP proxy integration documentation
+- Add comprehensive unit and integration tests for recursive json_transform()
+- Cleanup recursive hierarchy processing code in `execute_get_hierarchy()`
+- Update documentation for version 1.1 features
+
 ## Version 1.0
 
 - Working pylint checks

README.md

@@ -8,16 +8,16 @@
 
 *Enterprise Service Bus* is still a pretty vague term, first introduced in the Gartner Report of 2002.
 
-It is essential for running a large SOA infrastructure.
+It is essential for maintaining large SOA infrastructures.
 
 ## 2. Features
 
 Our interpretation of what an ESB should consist of:
 
-- ✅ Service Abstraction / Metadata Definition
-- ✅ Centralized Service / API Registry containing clean XML, JSON Model
+- ✅ Service Abstraction / Declarative Metadata Modeling
+- ✅ Centralized Service / API Registry providing clean XML, JSON Models
 - ✅ Centralized Service AAA (Authentication / Authorization / Accounting)
-- ✅ Internal Service XML / (Python) Class Mapping
+- ✅ Service Metadata XML, JSON / Internal (Python) Class Abstraction
 - ✅ Relational Backend OOP / ORM / ODM Mapper
 - ✅ Service Model Documentation / API (Auto)-Generation
 
@@ -40,23 +40,24 @@ pip3 install microesb
 pip3 install pytest pytest-pep8
 ```
 
-## 4. Platform As A Service (PaaS)
-
-Building web applications on PaaS infrastructure also relies on a clean Service Abstraction Model.
+## 4. Platform As A Service (PaaS) / Microservices
 
-> **Note**
-> The Python **micro-esb** module will help.
+The NoSQL conform JSON abstraction / data transformation capabilities make the micro-esb
+suitable for modern, scalable Next-Level applications.
 
 ## 5. Current Features
 
 - ✅ Service Abstraction / Metadata Definition
 - ✅ Internal Code (Python) Class / Service Properties Mapping
 - ✅ Graph-Based / Recursive JSON Result Abstraction
+- ✅ OOP Relational ODM Mapper / MongoDB Integration
 
 ### 5.1. In Progress
 
-- :hourglass: OOP Relational ODM Mapper
 - :hourglass: Service Documentation (Auto)-Generation
+- :hourglass: Service Registry / Encapsulated Service Routing
+- :hourglass: YANG Model Import / Export / Transformation
+- :hourglass: Web-Interface / Dashboard
 
 ## 6. Documentation / Examples
 

doc/source/api.rst

@@ -22,19 +22,59 @@ It provides template functions described in the *Internal Classes / Class Repres
 
 It inherits `transformer.JSONTransformer` to enable a generic, recursive dictionary representation of the class instance hierarchy. This feature allows for efficient assertions on complex object hierarchies.
 
-Example test case (`/test/integration/test_base.py`, test: `test_multi_item_object`):
+Example test case (`/test/integration/test_json_transform.py`, test: `test_list_object`):
 
 .. code-block:: python
 
-    assert shipment.json_dict == {
+    root_object = r[0]['Shipment']['object_instance']
+
+    assert root_object.json_dict == {
         'id': 'testshipment1',
-        'SYSServiceMethod': None,
-        'Palette': [
-            {'id': 1, 'label': 'label1'},
-            {'id': 2, 'label': 'label2'}
-        ]
+        'Palette': {
+            'Palette': [
+                { 'id': 1, 'label': 'label1' },
+                { 'id': 2, 'label': 'label2' }
+            ]
+        }
     }
 
+1.1. Property Dict
+******************
+
+The ``property_dict`` property (decorated with ``@property``) provides access to all class instance
+properties excluding internal system properties like ``SYSServiceMethod`` and class references.
+
+This enables clean property access for serialization, logging, or external API integration without
+exposing internal framework properties.
+
+Example usage:
+
+.. code-block:: python
+
+    # access all user-defined properties
+    properties = instance.property_dict
+    # returns: {'id': 'value', 'name': 'test', ...}
+    # excludes: 'SYSServiceMethod' and internal references
+
+1.2. Property Registration
+***************************
+
+Properties can be registered with metadata using the ``register_property()`` method. This is useful for defining internal system properties that should be handled specially by the framework.
+
+Example from ``/example/02-pki-management/service_implementation.py``:
+
+.. code-block:: python
+
+    self.register_property(
+        property_id='is_ca_cert',
+        property_data={
+            'type': 'bool',
+            'default': True,
+            'required': False,
+            'description': 'Is CA Certificate'
+        }
+    )
+
 2. Class Handler
 ================
 
@@ -81,6 +121,8 @@ Example: Standard `ClassHandler` vs. `MultiClassHandler` implementation:
 
 For an example *service call metadata* (Host properties), see Example 1 (:ref:`example-number1`).
 
+.. _implementation-classes:
+
 4. Implementation Classes
 =========================
 
@@ -165,31 +207,22 @@ All *implementation classes* must be imported into the global Python namespace.
 
     from microesb import microesb
 
-Importing the main `microesb` module will call `import esbconfig` (see the following code, line 14).
+Importing the main `microesb` module will call `import esbconfig` (see the following code, line 5).
 
 .. code-block:: python
     :linenos:
 
-    # ]*[ --------------------------------------------------------------------- ]*[
-    #  .                         Micro ESB Python Module                         .
-    # ]*[ --------------------------------------------------------------------- ]*[
-    #  .                                                                         .
-    #  .  Copyright Claus Prüfer (2016 - 2024)                                   .
-    #  .                                                                         .
-    #  .                                                                         .
-    # ]*[ --------------------------------------------------------------------- ]*[
-
     import abc
     import sys
     import logging
     import importlib
     import esbconfig
 
-The **microesb** standard installation will include an empty `esbconfig.py` in the global Python dist-packages or in the active Python environment.
+The **microesb** default installation will include an empty `esbconfig.py` in the global Python dist-packages for working pytest tests.
 
 .. warning::
 
-    If you do not provide an `esbconfig.py` in your project folder, the default installation file will be used.
+    If you do not provide an `esbconfig.py` in your project folder, the default installation file will be imported.
 
 The following **esbconfig.py** tells the `microesb` importer to use the file **service_classes.py** and import *implementation classes* `Class1`, `Class2`, and `Class3` into the global namespace. These classes will then be usable by `ClassMapper` and `ServiceMapper` during internal processing.
 
@@ -239,7 +272,7 @@ The `ServiceMapper` class is responsible for mapping and populating the existing
 
 It requires the following as input parameters:
 - A reference to the `ClassMapper` instance
-- **Service Call Metadata Dictionary** (see "Configuration / :ref:`service-call-metadata-config`")
+- **Service Call Metadata Dictionary** (Metadata passed to the ServiceExecuter as input data)
 
 Example:
 
@@ -251,3 +284,80 @@ Example:
         class_mapper=class_mapper,
         service_data=service_metadata
     )
+
+7. Service Router
+=================
+
+The `ServiceRouter` class provides user-defined service call routing capabilities. It enables direct routing of service calls to user-defined functions in a ``user_routing.py`` module.
+
+This is particularly useful for:
+
+- Database CRUD operations (MongoDB, PostgreSQL, etc.)
+- External API integrations
+- Custom business logic execution
+- Decoupling service orchestration from implementation
+
+7.1. Usage
+**********
+
+.. code-block:: python
+
+    from microesb.router import ServiceRouter
+
+    router = ServiceRouter()
+    result = router.send('FunctionName', metadata)
+
+The ``send()`` method dynamically invokes the specified function from the ``user_routing`` module
+and passes the metadata as the first argument.
+
+7.2. User Routing Module
+*************************
+
+Create a ``user_routing.py`` file in your project with functions that handle specific routing targets:
+
+.. code-block:: python
+
+    from pymongo import MongoClient
+
+    client = MongoClient('mongodb://127.0.0.1/')
+    mongodb = client.get_database('mydb')
+
+    def GetDataById(metadata):
+        return mongodb.collection.find_one({"id": metadata})
+
+    def StoreData(metadata):
+        mongodb.collection.insert_one(metadata)
+        return True
+
+See the :ref:`routing` section for detailed routing documentation.
+
+8. Service Executer
+===================
+
+The `ServiceExecuter` class handles the execution of service methods and manages recursive class hierarchy object deserialization. This enables complex hierarchical data structures to be properly reconstructed from JSON representations.
+
+8.1. Recursive Deserialization
+*******************************
+
+The framework automatically deserializes nested class hierarchies, ensuring that:
+- Child class instances are properly instantiated
+- Parent-child relationships are maintained
+- JSON data is correctly mapped to class properties
+
+This is particularly useful when working with complex domain models that include multiple levels of nested objects.
+
+Example:
+
+.. code-block:: python
+
+    # hierarchical structure: CertClient -> CertServer -> CertCA
+    # the framework automatically deserializes all levels
+
+    service_executer = microesb.ServiceExecuter(
+        class_mapper=class_mapper,
+        service_mapper=service_mapper
+    )
+
+    result = service_executer.execute_get_hierarchy()
+    root_object = r[0]['RootObjectName']['object_instance']
+    print(root_object.json_dict)

doc/source/conf.py

@@ -12,8 +12,8 @@
 project = 'Python microesb'
 copyright = '2016 - 2024, Claus Prüfer'
 author = 'Claus Prüfer'
-version = '1.0'
-release = '1.0'
+version = '1.1'
+release = '1.1'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration