mms-client 1.5.0__tar.gz → 1.5.1__tar.gz

{mms_client-1.5.0 → mms_client-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mms-client
-Version: 1.5.0
+Version: 1.5.1
 Summary: API client for accessing the MMS
 Home-page: https://github.com/ElectroRoute-Japan/mms-client
 Author: Ryan Wood

{mms_client-1.5.0 → mms_client-1.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mms_client"
-version = "v1.5.0"
+version = "v1.5.1"
 description = "API client for accessing the MMS"
 authors = ["Ryan Wood <ryan.wood@electroroute.co.jp>"]
 readme = "README.md"

{mms_client-1.5.0 → mms_client-1.5.1}/src/mms_client/utils/auditing.py

@@ -7,6 +7,7 @@ from logging import getLogger
 from lxml.etree import _Element as Element
 from lxml.etree import tostring
 from zeep import Plugin
+from zeep.wsdl.definitions import Operation
 
 # Set the default logger for the MMS client
 logger = getLogger(__name__)
@@ -15,7 +16,7 @@ logger = getLogger(__name__)
 class AuditPlugin(ABC, Plugin):
     """Base class for audit plugins."""
 
-    def egress(self, envelope: Element, http_headers: dict, operation, binding_options):
+    def egress(self, envelope: Element, http_headers: dict, operation: Operation, binding_options):
         """Handle the MMS request before it is sent.
 
         Arguments are the same as in the egress method of the Plugin class.
@@ -25,10 +26,10 @@ class AuditPlugin(ABC, Plugin):
         dict:               The HTTP headers to send.
         """
         data = tostring(envelope, encoding="UTF-8", xml_declaration=True)
-        self.audit_request(data)
+        self.audit_request(operation.name, data)
         return envelope, http_headers
 
-    def ingress(self, envelope: Element, http_headers: dict, operation):
+    def ingress(self, envelope: Element, http_headers: dict, operation: Operation):
         """Handle the MMS response before it is processed.
 
         Arguments are the same as in the ingress method of the Plugin class.
@@ -38,21 +39,23 @@ class AuditPlugin(ABC, Plugin):
         dict:               The HTTP headers to process.
         """
         data = tostring(envelope, encoding="UTF-8", xml_declaration=True)
-        self.audit_response(data)
+        self.audit_response(operation.name, data)
         return envelope, http_headers
 
     @abstractmethod
-    def audit_request(self, mms_request: bytes) -> None:
+    def audit_request(self, operation: str, mms_request: bytes) -> None:
         """Audit an MMS request.
 
         Arguments:
+        operation (str):        The SOAP operation being called.
         mms_request (bytes):    The MMS request XML to audit.
         """
 
     @abstractmethod
-    def audit_response(self, mms_response: bytes) -> None:
+    def audit_response(self, operation: str, mms_response: bytes) -> None:
         """Audit an MMS response.
 
         Arguments:
+        operation (str):        The SOAP operation being called.
         mms_response (bytes):   The MMS response XML to audit.
         """

{mms_client-1.5.0 → mms_client-1.5.1}/src/mms_client/utils/web.py

@@ -200,7 +200,13 @@ class ZWrapper:
 
     @on_exception(expo, TransportError, max_tries=3, giveup=fatal_code, logger=logger)  # type: ignore[arg-type]
     def submit(self, req: MmsRequest) -> MmsResponse:
-        """Submit the given request to the MMS server and return the response."""
+        """Submit the given request to the MMS server and return the response.
+
+        Arguments:
+        req (MmsRequest):   The MMS request to submit.
+
+        Returns:    The MMS response.
+        """
         try:
             logger.debug(f"Submitting MMS request request to {self._interface.name} service")