fix for #11 and updates for serialization to and from dict

src/pysiaalarm/account.py

@@ -1,6 +1,7 @@
 """Class for SIA Accounts."""
 import logging
-from dataclasses import dataclass
+from dataclasses import dataclass, field
+from dataclasses_json import dataclass_json, config, Exclude
 from typing import Optional, Tuple
 
 from .errors import (
@@ -13,14 +14,17 @@
 _LOGGER = logging.getLogger(__name__)
 
 
+@dataclass_json
 @dataclass
 class SIAAccount:
     """Class for SIA Accounts."""
 
     account_id: str
     key: Optional[str] = None
     allowed_timeband: Tuple[int, int] = (40, 20)
-    key_b: Optional[bytes] = None
+    key_b: Optional[bytes] = field(
+        repr=False, default=None, metadata=config(exclude=Exclude.ALWAYS)  # type: ignore
+    )
 
     def __post_init__(self) -> None:
         """Rewrite the key as bytes."""

src/pysiaalarm/data/data.py

@@ -1,6 +1,7 @@
 """Data related utils for pysiaalarm."""
 import json
 from dataclasses import dataclass
+from dataclasses_json import dataclass_json
 from typing import Dict, Optional
 
 import pkg_resources
@@ -10,6 +11,7 @@
 FILE_ADM_MAPPING = "adm_mapping.json"
 
 
+@dataclass_json
 @dataclass
 class SIACode:
     """Class for SIACodes."""
@@ -20,6 +22,7 @@ class SIACode:
     concerns: str
 
 
+@dataclass_json
 @dataclass
 class SIAXData:
     """Class for Xdata."""

src/pysiaalarm/event.py

@@ -1,10 +1,10 @@
 """This is a class for SIA Events."""
 from __future__ import annotations
-
+import copy
 import logging
 from abc import ABC, abstractmethod, abstractproperty
-from dataclasses import dataclass
-from dataclasses_json import dataclass_json
+from dataclasses import dataclass, field
+from dataclasses_json import dataclass_json, config, Exclude
 from datetime import datetime, timedelta
 from typing import Dict, Optional, Union
 
@@ -30,7 +30,7 @@
 _LOGGER = logging.getLogger(__name__)
 
 
-@dataclass_json
+@dataclass_json()
 @dataclass  # type: ignore
 class BaseEvent(ABC):
     """Base class for Events."""
@@ -67,7 +67,9 @@ class BaseEvent(ABC):
     # Parsed fields
     calc_crc: Optional[str] = None
     extended_data: Optional[SIAXData] = None
-    sia_account: Optional[SIAAccount] = None
+    sia_account: Optional[SIAAccount] = field(
+        metadata=config(exclude=Exclude.ALWAYS), default=None  # type: ignore
+    )
     sia_code: Optional[SIACode] = None
 
     @property
@@ -188,6 +190,7 @@ def _crc_calc(msg: str) -> str:
         return ("%x" % crc).upper().zfill(4)
 
 
+@dataclass_json
 @dataclass
 class SIAEvent(BaseEvent):
     """Class for SIAEvents."""
@@ -418,7 +421,15 @@ def __str__(self) -> str:
 Encrypted Content: {self.encrypted_content}, \
 Full Message: {self.full_message}."
 
+    # def to_dict(self, clear_account=False, **kwargs) -> dict:
+    #     """Return the event as a dict."""
+    #     ev: BaseEvent = copy.deepcopy(self)
+    #     if clear_account and ev.sia_account:
+    #         ev.sia_account = None
+    #     return super().to_dict(ev, **kwargs)  # type: ignore # pylint: disable=no-member
 
+
+@dataclass_json
 @dataclass
 class OHEvent(SIAEvent):
     """Class for OH events."""
@@ -444,6 +455,7 @@ def create_response(self) -> bytes:
         return '"ACK"'.encode("ascii")  # pragma: no cover
 
 
+@dataclass_json
 @dataclass
 class NAKEvent(BaseEvent):
     """Class for NAK Events."""

src/pysiaalarm/utils/regexes.py

@@ -36,9 +36,9 @@
 (?:id)?(?:(?<=id)(?P<id>\d*))?\/?
 (?:ri)?(?:(?<=ri)(?P<ri>\d*))?\/?
 (?P<code>[a-zA-Z]{2})?
-(?P<message>\w*)
+(?P<message>[\w\s\^]*)
 [\]]
-(?:\[(?:(?<=\[)(?P<xdata>\w*)(?=\]))\])?
+(?:\[(?:(?<=\[)(?P<xdata>[\w\s\^]*)(?=\]))\])?
 [_]?
 (?P<timestamp>[0-9:,-]*)?$
 """
@@ -57,7 +57,7 @@
 \s
 (?P<ri>\d{3})
 [\]]
-(?:\[(?:(?<=\[)(?P<xdata>\w*)(?=\]))\])?
+(?:\[(?:(?<=\[)(?P<xdata>[\w\s\^]*)(?=\]))\])?
 [_]?
 (?P<timestamp>[0-9:,-]*)?$
 """

tests/test_sia_package.py

@@ -130,6 +130,29 @@ class testSIA(object):
 
     pytestmark = pytest.mark.asyncio
 
+    @parametrize_with_cases("cl, dic, clear_account", cases=ToFromDict)
+    def test_to_from_dict(self, cl, dic, clear_account):
+        """Test the to and from dict methods."""
+        _LOGGER.warning("Dict before: %s", dic)
+        instance = cl.from_dict(dic)
+        _LOGGER.warning("Class instance %s", instance)
+        if cl == SIAAccount:
+            assert instance.account_id == dic["account_id"]
+            assert instance.key == dic["key"]
+            dic2 = instance.to_dict()
+        else:
+            assert instance.account == dic["account"]
+            assert instance.code == dic["code"]
+            dic2 = instance.to_dict(encode_json=True)
+
+        _LOGGER.warning("Dict after: %s", dic2)
+        for key, value in dic.items():
+            if key != "sia_account":
+                assert dic2[key] == value
+            else:
+                if dic[key]:
+                    assert instance.sia_account is not None
+
     @parametrize_with_cases(
         "line, account_id, type, code, error_type, extended_data_flag",
         cases=EventParsing,
@@ -140,8 +163,8 @@ def test_event_parsing(
         """Test event parsing methods."""
         try:
             event = SIAEvent.from_line(line)
-            _LOGGER.warning(asdict(event))
-            _LOGGER.warning(event.to_dict())
+            # _LOGGER.warning(asdict(event))
+            # _LOGGER.warning(event.to_dict())
             # assert False
             assert event.code == code
             if code:

tests/test_sia_package_cases.py

@@ -7,6 +7,8 @@
     InvalidKeyFormatError,
     InvalidKeyLengthError,
     CommunicationsProtocol,
+    SIAAccount,
+    SIAEvent,
 )
 from pysiaalarm.errors import EventFormatError
 from pysiaalarm.utils import ResponseType
@@ -112,6 +114,17 @@ class EventParsing:
 
     """
 
+    def case_bug(self):
+        """Test case from #11."""
+        return (
+            r'9618004D"SIA-DCS"7960L0#123456[#123456|Nri1CL0^VX FRONTE ^]_22:40:48,04-11-2021',
+            "123456",
+            "Closing Report",
+            "CL",
+            None,
+            False
+        )
+
     def case_dc04(self):
         """Test case DC04 format - NOT SUPPORTED so throws an error."""
         return (
@@ -326,3 +339,123 @@ def case_wrong_event(self):
     def case_non_existent_code(self):
         """Test parsing for non existing code."""
         return ("ZX", False, False, ResponseType.DUH)
+
+
+class ToFromDict:
+    """Test the event serialization to and from dict.
+
+    Emits the class and a dict of that class.
+
+    """
+
+    def case_sia_event(self):
+        """Test event from dict."""
+        d_ev = {
+            "full_message": '"SIA-DCS"5268L0#AAA[Nri1/WA000]_08:40:47,07-08-2020',
+            "msg_crc": "C416",
+            "length": "0279",
+            "encrypted": False,
+            "message_type": "SIA-DCS",
+            "receiver": None,
+            "line": "L0",
+            "account": "AAA",
+            "sequence": "5268",
+            "content": "Nri1/WA000]_08:40:47,07-08-2020",
+            "encrypted_content": None,
+            "ti": None,
+            "id": None,
+            "ri": "1",
+            "code": "WA",
+            "message": "000",
+            "x_data": None,
+            "timestamp": 1594197647.0,
+            "event_qualifier": None,
+            "event_type": None,
+            "partition": None,
+            "calc_crc": "E9A4",
+            "extended_data": None,
+            "sia_account": None,
+            "sia_code": {
+                "code": "WA",
+                "type": "Water Alarm",
+                "description": "Water detected at protected premises",
+                "concerns": "Zone or point",
+            },
+        }
+        return SIAEvent, d_ev, False
+
+    def case_sia_event_with_account(self):
+        """Test event from dict."""
+        d_ev = {
+            "full_message": '"SIA-DCS"5268L0#AAA[Nri1/WA000]_08:40:47,07-08-2020',
+            "msg_crc": "C416",
+            "length": "0279",
+            "encrypted": False,
+            "message_type": "SIA-DCS",
+            "receiver": None,
+            "line": "L0",
+            "account": "AAA",
+            "sequence": "5268",
+            "content": "Nri1/WA000]_08:40:47,07-08-2020",
+            "encrypted_content": None,
+            "ti": None,
+            "id": None,
+            "ri": "1",
+            "code": "WA",
+            "message": "000",
+            "x_data": None,
+            "timestamp": 1594197647.0,
+            "event_qualifier": None,
+            "event_type": None,
+            "partition": None,
+            "calc_crc": "E9A4",
+            "extended_data": None,
+            "sia_account": {"account_id": ACCOUNT, "key": KEY},
+            "sia_code": {
+                "code": "WA",
+                "type": "Water Alarm",
+                "description": "Water detected at protected premises",
+                "concerns": "Zone or point",
+            },
+        }
+        return SIAEvent, d_ev, False
+
+    def case_sia_event_with_account_clear(self):
+        """Test event from dict."""
+        d_ev = {
+            "full_message": '"SIA-DCS"5268L0#AAA[Nri1/WA000]_08:40:47,07-08-2020',
+            "msg_crc": "C416",
+            "length": "0279",
+            "encrypted": False,
+            "message_type": "SIA-DCS",
+            "receiver": None,
+            "line": "L0",
+            "account": "AAA",
+            "sequence": "5268",
+            "content": "Nri1/WA000]_08:40:47,07-08-2020",
+            "encrypted_content": None,
+            "ti": None,
+            "id": None,
+            "ri": "1",
+            "code": "WA",
+            "message": "000",
+            "x_data": None,
+            "timestamp": 1594197647.0,
+            "event_qualifier": None,
+            "event_type": None,
+            "partition": None,
+            "calc_crc": "E9A4",
+            "extended_data": None,
+            "sia_account": {"account_id": ACCOUNT, "key": KEY},
+            "sia_code": {
+                "code": "WA",
+                "type": "Water Alarm",
+                "description": "Water detected at protected premises",
+                "concerns": "Zone or point",
+            },
+        }
+        return SIAEvent, d_ev, True
+
+    def case_sia_account(self):
+        """Test account to and from dict."""
+        return SIAAccount, {"account_id": ACCOUNT, "key": KEY}, False