Add message handling

mitel_ommclient2/messages/__init__.py

@@ -0,0 +1,142 @@
+#!/usr/bin/env python3
+
+from xml.dom.minidom import getDOMImplementation, parseString
+
+
+class Request:
+    """
+        Request message class
+
+        :param name: Name of the message
+        :param seq: Unique sequence number to associate responses
+
+        Usage::
+            >>> req = Request("Ping")
+    """
+
+    def __init__(self, name, seq=None):
+        self.name = name
+        self.attrs = {}
+        self.childs = {}
+
+        if seq is not None:
+            self.attrs["seq"] = seq
+
+    @property
+    def seq(self):
+        return self.attrs.get("seq")
+
+
+class DictRequest(Request):
+    """
+        Create a message by dict attributes
+
+        :param name: Name of the message
+        :param attrs: Message attributes
+        :param childs: Message children
+
+        Usage::
+            >>> req = DictRequest("Ping", {"timeStamp": 2342})
+    """
+
+    def __init__(self, name, attrs={}, childs={}):
+        self.name = name
+        self.attrs = attrs
+        self.childs = attrs
+
+
+class Response:
+    """
+        Response message class
+
+        :param name: Name of the message
+        :param attrs: Message attributes
+        :param childs: Message children
+    """
+    def __init__(self, name, attrs={}, childs={}):
+        self.name = name
+        self.attrs = attrs
+        self.childs = childs
+
+    @property
+    def seq(self):
+        return self.attrs.get("seq")
+
+    @property
+    def errCode(self):
+        return self.attrs.get("errCode")
+
+    @property
+    def info(self):
+        return self.attrs.get("info")
+
+    @property
+    def bad(self):
+        return self.attrs.get("bad")
+
+    @property
+    def maxLen(self):
+        return self.attrs.get("maxLen")
+
+
+from .ping import Ping, PingResp
+
+
+def construct(request):
+    """
+        Builds the XML message DOM and returns as string
+    """
+    impl = getDOMImplementation()
+    message = impl.createDocument(None, request.name, None)
+    root = message.documentElement
+
+    for k, v in request.attrs.items():
+        root.setAttribute(str(k), str(v))
+
+
+    for k, v in request.childs.items():
+        child = message.createElement(k)
+        if v is not None:
+            for c_k, c_v in v.items():
+                child.setAttribute(str(c_k), str(c_v))
+        root.appendChild(child)
+    return root.toxml()
+
+def _response_type_by_name(name):
+    response_types = [
+        PingResp,
+    ]
+
+    response_types_dict = {r.__name__: r for r in response_types}
+
+    return response_types_dict.get(name, Response)
+
+def parse(message):
+    message = parseString(message)
+    root = message.documentElement
+
+    name = root.tagName
+    attrs = {}
+    childs = {}
+
+    for i in range(0, root.attributes.length):
+        item = root.attributes.item(i)
+        attrs[item.name] = item.value
+
+    child = root.firstChild
+    while child is not None:
+        new_child = {}
+        for i in range(0, child.attributes.length):
+            item = child.attributes.item(i)
+            new_child[item.name] = item.value
+
+        childname = child.tagName
+        if childname in childs:
+            childs[childname].append(new_child)
+        else:
+            childs[childname] = [new_child]
+
+        child = child.nextSibling
+
+
+    return _response_type_by_name(name)(name, attrs, childs)

mitel_ommclient2/messages/open.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+
+from . import Request, Response
+
+
+class Open(Request):
+    def __init__(self, username, password, **kwargs):
+        super().__init__("Open", **kwargs)
+
+        self.attrs["username"] = username
+        self.attrs["password"] = password
+
+    @property
+    def username(self):
+        return self.attrs.get("username")
+
+    @property
+    def password(self):
+        return self.attrs.get("password")
+
+class OpenResp(Response):
+    @property
+    def protocolVersion(self):
+        return self.attrs.get("protocolVersion")
+
+    @property
+    def minPPSwVersion1(self):
+        return self.attrs.get("minPPSwVersion1")
+
+    @property
+    def minPPSwVersion2(self):
+        return self.attrs.get("minPPSwVersion2")
+
+    @property
+    def ommStbState(self):
+        return self.attrs.get("ommStbState")
+
+    @property
+    def publicKey(self):
+        return self.attrs.get("publicKey")

mitel_ommclient2/messages/ping.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python3
+
+from . import Request, Response
+
+
+class Ping(Request):
+    def __init__(self, timeStamp=None, **kwargs):
+        super().__init__("Ping", **kwargs)
+
+        if timeStamp is not None:
+            self.attrs["timeStamp"] = timeStamp
+
+    @property
+    def timeStamp(self):
+        return self.attrs.get("timeStamp")
+
+class PingResp(Response):
+    @property
+    def timeStamp(self):
+        return self.attrs.get("timeStamp")