aas-http-client 0.2.0__tar.gz → 0.2.2__tar.gz

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.0
-Summary: Generic HTTP client for communicating with various types of AAS servers
+Version: 0.2.2
+Summary: Generic python HTTP client for communication with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: # :em engineering methods AG Software License
         
@@ -155,6 +155,8 @@ For a detailed introduction, please read [Getting Started](docs/getting_started.
 pip install aas-http-client
 ````
 
+### Client
+
 ```python
 from aas_http_client import create_client_by_url
 
@@ -164,3 +166,15 @@ client = create_client_by_url(
 
 print(client.get_shells())
 ```
+
+### SDK Wrapper
+
+```python
+from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config
+
+wrapper = create_wrapper_by_config(
+    base_url="http://myaasserver:5043/"
+)
+
+print(wrapper.get_shells())
+```

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/README.md

@@ -43,6 +43,8 @@ For a detailed introduction, please read [Getting Started](docs/getting_started.
 pip install aas-http-client
 ````
 
+### Client
+
 ```python
 from aas_http_client import create_client_by_url
 
@@ -51,4 +53,16 @@ client = create_client_by_url(
 )
 
 print(client.get_shells())
+```
+
+### SDK Wrapper
+
+```python
+from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config
+
+wrapper = create_wrapper_by_config(
+    base_url="http://myaasserver:5043/"
+)
+
+print(wrapper.get_shells())
 ```

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/aas_http_client/client.py

@@ -20,6 +20,7 @@ STATUS_CODE_200 = 200
 STATUS_CODE_201 = 201
 STATUS_CODE_202 = 202
 STATUS_CODE_204 = 204
+STATUS_CODE_404 = 404
 HEADERS = {"Content-Type": "application/json"}
 
 
@@ -54,6 +55,9 @@ def log_response_errors(response: Response):
                     result_error_messages.append(str(message))
         elif "error" in response_content_dict:
             result_error_messages.append(response_content_dict.get("error", ""))
+        
+        if len(result_error_messages) == 0 and response.text:
+            result_error_messages.append(response.text)
 
     except json.JSONDecodeError:
         result_error_messages.append(response.content)
@@ -484,13 +488,14 @@ def create_client_by_config(config_file: Path, password: str = "") -> AasHttpCli
     :param password: password for the BaSyx server interface client, defaults to ""_
     :return: An instance of HttpClient initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx server interface client from config file '{config_file}'")
+    config_file = config_file.resolve()
+    logger.info(f"Create AAS HTTP client from Configuration file '{config_file}'")
     if not config_file.exists():
         config_string = "{}"
-        logger.warning(f"Server config file '{config_file}' not found. Using default config.")
+        logger.warning(f"Configuration file '{config_file}' not found. Using default configuration.")
     else:
         config_string = config_file.read_text(encoding="utf-8")
-        logger.debug(f"Server config  file '{config_file}' found.")
+        logger.debug(f"Configuration  file '{config_file}' found.")
 
     return _create_client(config_string, password)
 
@@ -529,12 +534,12 @@ def _connect_to_api(client: AasHttpClient) -> bool:
         try:
             root = client.get_root()
             if root:
-                logger.info(f"Connected to REST API at '{client.base_url}' successfully.")
+                logger.info(f"Connected to server API at '{client.base_url}' successfully.")
                 return True
         except requests.exceptions.ConnectionError:
             pass
         if time.time() - start_time > client.connection_time_out:
-            raise TimeoutError(f"Connection to REST API timed out after {client.connection_time_out} seconds.")
+            raise TimeoutError(f"Connection to server API timed out after {client.connection_time_out} seconds.")
 
         counter += 1
         logger.warning(f"Retrying connection (attempt: {counter})")

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/aas_http_client/demo/demo_process.py

@@ -16,15 +16,23 @@ def start():
     aas_2 = _create_shell()
     
     client = _create_client()
-    sdk_wrapper = _create_sdk_wrapper()
+    java_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/java_server_config.json"))
+    dotnet_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/dotnet_server_config.json"))
 
-    exist_shells = sdk_wrapper.get_shells()
+    java_sdk_wrapper.get_shells_by_id(aas_1.id)
+    dotnet_sdk_wrapper.get_shells_by_id(aas_1.id)
+    
+    java_sdk_wrapper.get_submodels_by_id(aas_1.id)
+    dotnet_sdk_wrapper.get_submodels_by_id(aas_1.id)
+    
+    exist_shells = java_sdk_wrapper.get_shells()
+    exist_shells = dotnet_sdk_wrapper.get_shells()
     
     for shell in exist_shells:
         logger.warning(f"Delete shell '{shell.id}'")
-        sdk_wrapper.delete_shells_by_id(shell.id)
+        java_sdk_wrapper.delete_shells_by_id(shell.id)
 
-    sdk_wrapper.post_shells(aas_1)
+    java_sdk_wrapper.post_shells(aas_1)
 
 
     aas_dict_string = json.dumps(aas_2, cls=basyx.aas.adapter.json.AASToJsonEncoder)
@@ -53,7 +61,7 @@ def _create_client() -> AasHttpClient:
     """Create client for java servers."""
 
     try:
-        file = Path("./demo/server_config.json")
+        file = Path("./aas_http_client/demo/java_server_config.json")
         client = create_client_by_config(file, password="")
     except Exception as e:
         logger.error(f"Failed to create client for {file}: {e}")
@@ -61,11 +69,11 @@ def _create_client() -> AasHttpClient:
 
     return client
         
-def _create_sdk_wrapper() -> SdkWrapper:
+def _create_sdk_wrapper(config: Path) -> SdkWrapper:
     """Create client for java servers."""
 
     try:
-        file = Path("./demo/server_config.json")
+        file = config
         client = create_wrapper_by_config(file, password="")
     except Exception as e:
         logger.error(f"Failed to create client for {file}: {e}")

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/aas_http_client/wrapper/sdk_wrapper.py

@@ -3,6 +3,7 @@
 import json
 import logging
 from pathlib import Path
+from typing import Any
 
 import basyx.aas.adapter.json
 
@@ -20,9 +21,7 @@ class SdkWrapper():
         :param aas: Asset Administration Shell to post
         :return: Response data as a dictionary or None if an error occurred
         """
-        aas_data_string = json.dumps(aas, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        aas_data = json.loads(aas_data_string)
-
+        aas_data = _to_dict(aas)
         return self._client.post_shells(aas_data)
 
     def put_shells(self, identifier: str, aas: AssetAdministrationShell) -> bool:
@@ -32,9 +31,7 @@ class SdkWrapper():
         :param aas: Asset Administration Shell data to update
         :return: True if the update was successful, False otherwise
         """
-        aas_data_string = json.dumps(aas, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        aas_data = json.loads(aas_data_string)
-
+        aas_data = _to_dict(aas)
         return self._client.put_shells(identifier, aas_data)
 
     def put_shells_submodels_by_id(self, aas_id: str, submodel_id: str, submodel: Submodel) -> bool:
@@ -44,9 +41,7 @@ class SdkWrapper():
         :param submodel: Submodel data to update
         :return: True if the update was successful, False otherwise
         """
-        sm_data_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        sm_data = json.loads(sm_data_string)
-
+        sm_data = _to_dict(submodel)
         return self._client.put_shells_submodels_by_id(aas_id, submodel_id, sm_data)
 
     def get_shells(self) -> list[AssetAdministrationShell] | None:
@@ -57,24 +52,24 @@ class SdkWrapper():
         content: dict = self._client.get_shells()
         
         if not content:
-            logger.warning("No AAS found in the REST API.")
-            return []
+            return None
 
         results: list = content.get("result", [])
         if not results:
-            logger.warning("No AAS found in the REST API results.")
+            logger.warning("No shells found on server.")
             return []
 
         aas_list: list[AssetAdministrationShell] = []
 
         for result in results:
             if not isinstance(result, dict):
-                logger.error(f"Invalid AAS data: {result}")
+                logger.error(f"Invalid shell data: {result}")
                 return None
 
-            aas_dict_string = json.dumps(result)
-            aas = json.loads(aas_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
-            aas_list.append(aas)
+            aas = _to_object(result)
+
+            if aas:
+                aas_list.append(aas)
 
         return aas_list
 
@@ -85,8 +80,12 @@ class SdkWrapper():
         :return: AAS object or None if an error occurred
         """
         content: dict = self._client.get_shells_by_id(aas_id)
-        aas_dict_string = json.dumps(content)
-        return json.loads(aas_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+        
+        if not content:
+            logger.warning(f"No shell found with ID '{aas_id}' on server.")
+            return None
+        
+        return _to_object(content)
 
     def get_shells_reference_by_id(self, aas_id: str) -> Reference | None:
         #workaround because serialization not working
@@ -104,8 +103,7 @@ class SdkWrapper():
         :return: Submodel object or None if an error occurred
         """
         content: dict = self._client.get_shells_submodels_by_id(aas_id, submodel_id)
-        sm_dict_string = json.dumps(content)
-        return json.loads(sm_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+        return _to_object(content)
 
     def delete_shells_by_id(self, aas_id: str) -> bool:
         """Get an Asset Administration Shell (AAS) by its ID from the REST API.
@@ -121,9 +119,7 @@ class SdkWrapper():
         :param submodel: submodel data as a dictionary
         :return: Response data as a dictionary or None if an error occurred
         """
-        sm_data_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        sm_data = json.loads(sm_data_string)
-
+        sm_data = _to_dict(submodel)
         return self._client.post_submodels(sm_data)
 
     def put_submodels_by_id(self, identifier: str, submodel: Submodel) -> bool:
@@ -133,9 +129,7 @@ class SdkWrapper():
         :param submodel: Submodel data to update
         :return: True if the update was successful, False otherwise
         """
-        sm_data_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        sm_data = json.loads(sm_data_string)
-
+        sm_data = _to_dict(submodel)
         return self._client.put_submodels_by_id(identifier, sm_data)
 
     def get_submodels(self) -> list[Submodel] | None:
@@ -146,12 +140,11 @@ class SdkWrapper():
         content: list = self._client.get_submodels()
 
         if not content:
-            logger.warning("No submodels found in the REST API.")
             return []
 
         results: list = content.get("result", [])
         if not results:
-            logger.warning("No submodels found in the REST API results.")
+            logger.warning("No submodels found on server.")
             return []
 
         submodels: list[Submodel] = []
@@ -161,9 +154,10 @@ class SdkWrapper():
                 logger.error(f"Invalid submodel data: {result}")
                 return None
 
-            sm_dict_string = json.dumps(result)
-            submodel = json.loads(sm_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
-            submodels.append(submodel)
+            submodel = _to_object(result)
+
+            if submodel:
+                submodels.append(submodel)
 
         return submodels
 
@@ -176,21 +170,14 @@ class SdkWrapper():
         content = self._client.get_submodels_by_id(submodel_id)
 
         if not content:
-            logger.warning(f"No submodel found with ID '{submodel_id}' in the REST API.")
-            return None
-        
-        if not isinstance(content, dict):
-            logger.error(f"Invalid submodel data: {content}")
+            logger.warning(f"No submodel found with ID '{submodel_id}' on server.")
             return None
         
-        sm_dict_string = json.dumps(content)
-        return json.loads(sm_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+        return _to_object(content)
 
     def patch_submodel_by_id(self, submodel_id: str, submodel: Submodel):
-        sm_dict_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        sm_dict = json.loads(sm_dict_string)
-
-        return self._client.patch_submodel_by_id(submodel_id, sm_dict)
+        sm_data = _to_dict(submodel)
+        return self._client.patch_submodel_by_id(submodel_id, sm_data)
 
     def delete_submodels_by_id(self, submodel_id: str) -> bool:
         """Delete a submodel by its ID from the REST API.
@@ -200,6 +187,24 @@ class SdkWrapper():
         """
         return self._client.delete_submodels_by_id(submodel_id)
 
+def _to_object(content: dict) -> Any | None:
+    try:
+        dict_string = json.dumps(content)
+        return json.loads(dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+    except Exception as e:
+        logger.error(f"Decoding error: {e}")
+        logger.error(f"In JSON: {content}")
+        return None
+    
+def _to_dict(object: Any) -> dict | None:
+    try:
+        data_string = json.dumps(object, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        return json.loads(data_string)
+    except Exception as e:
+        logger.error(f"Encoding error: {e}")
+        logger.error(f"In object: {object}")
+        return None    
+
 def create_wrapper_by_url(
     base_url: str,
     username: str = "",
@@ -234,7 +239,12 @@ def create_wrapper_by_url(
     config_string = json.dumps(config_dict, indent=4)
     
     wrapper = SdkWrapper()
-    wrapper._client = _create_client(config_string, password)                           
+    client = _create_client(config_string, password)      
+    
+    if not client:
+        return None
+    
+    wrapper._client = client          
     return wrapper
     
 
@@ -246,13 +256,13 @@ def create_wrapper_by_config(config_file: Path, password: str = "") -> AasHttpCl
     :param password: password for the BaSyx server interface client, defaults to ""_
     :return: An instance of HttpClient initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx server interface client from config file '{config_file}'")
+    logger.info(f"Create BaSyx Python SDK wrapper from configuration file '{config_file}'")
     if not config_file.exists():
         config_string = "{}"
-        logger.warning(f"Server config file '{config_file}' not found. Using default config.")
+        logger.warning(f"Configuration file '{config_file}' not found. Using default config.")
     else:
         config_string = config_file.read_text(encoding="utf-8")
-        logger.debug(f"Server config  file '{config_file}' found.")
+        logger.debug(f"Configuration file '{config_file}' found.")
 
     wrapper = SdkWrapper()
     client = _create_client(config_string, password)
@@ -260,5 +270,5 @@ def create_wrapper_by_config(config_file: Path, password: str = "") -> AasHttpCl
     if not client:
         return None
     
-    wrapper._client = _create_client(config_string, password)       
+    wrapper._client = client       
     return wrapper

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/aas_http_client.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.0
-Summary: Generic HTTP client for communicating with various types of AAS servers
+Version: 0.2.2
+Summary: Generic python HTTP client for communication with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: # :em engineering methods AG Software License
         
@@ -155,6 +155,8 @@ For a detailed introduction, please read [Getting Started](docs/getting_started.
 pip install aas-http-client
 ````
 
+### Client
+
 ```python
 from aas_http_client import create_client_by_url
 
@@ -164,3 +166,15 @@ client = create_client_by_url(
 
 print(client.get_shells())
 ```
+
+### SDK Wrapper
+
+```python
+from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config
+
+wrapper = create_wrapper_by_config(
+    base_url="http://myaasserver:5043/"
+)
+
+print(wrapper.get_shells())
+```

{aas_http_client-0.2.0 → aas_http_client-0.2.2}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aas-http-client"
-version = "0.2.00"
-description = "Generic HTTP client for communicating with various types of AAS servers"
+version = "0.2.2"
+description = "Generic python HTTP client for communication with various types of AAS servers"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [