python-terminusgps 1.9.8__py3-none-any.whl → 1.9.9__py3-none-any.whl

{python_terminusgps-1.9.8.dist-info → python_terminusgps-1.9.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.9.8
+Version: 1.9.9
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-1.9.8.dist-info → python_terminusgps-1.9.9.dist-info}/RECORD

@@ -13,17 +13,17 @@ terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 terminusgps/wialon/constants.py,sha256=aybYcNcHyar2lz_6BlQbMWpbcHW6eyJeq05QwuiqZQ0,3078
 terminusgps/wialon/errors.py,sha256=SV9pVwU6FZ_zGlGP6zJN6aLE2auF4TfHFISQLiPMKrI,1758
 terminusgps/wialon/flags.py,sha256=-OoH-eZM54yjRqxsAXL8VImdQu_7C0OAxCrFqaCEuko,13510
-terminusgps/wialon/session.py,sha256=segEjyt-K9AAlMq_OYLVtxFBp_jE5c3KL-AJQhOVa9U,9936
-terminusgps/wialon/utils.py,sha256=9xJq5eAWm-vu0nJVJ7eUcwhJhMCrGjS1p__4CIBXYm4,3407
+terminusgps/wialon/session.py,sha256=AntMZQA7g5FAnEHzPCVopmfDgigP1JFp-zYv8_H7xEg,9792
+terminusgps/wialon/utils.py,sha256=vo5-md05VzyFtM98AxG7_gI2TVgOecqY9K78tQErxDU,3429
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=Z6aGEC2_m5CPHYCa1rgAvkGtSegbrvZ68mifCqo-07A,6617
+terminusgps/wialon/items/base.py,sha256=CuDctBbR0NwW9Fo--05iozSx7GkNysvAFXvdidggJjg,6693
 terminusgps/wialon/items/resource.py,sha256=xElMYSMyKA5y8rIP0EeF429MBV2hbLZcS6SokftvrOs,5641
 terminusgps/wialon/items/retranslator.py,sha256=zsQXqOhH1zFe5_e8DROPu60z3v6xPWOEPyMCi2IqJAo,3861
 terminusgps/wialon/items/route.py,sha256=qOHPN_rejwiGqvwWzlwmUIAIyc3lKavCalf8ki66rx0,760
-terminusgps/wialon/items/unit.py,sha256=wzcLa0adMTKX6rtO4Vz6ntaxgY50rLk2KK_VBXlW_lQ,4680
+terminusgps/wialon/items/unit.py,sha256=mEYQRpICELQPR3dyDJVRzoKeIuFRnPgkqK-Oo6xuIP4,6306
 terminusgps/wialon/items/unit_group.py,sha256=1yc7ldPIgGbtiTj0djRDWmt6Q9K_VT9sxOaioasbbLY,5212
 terminusgps/wialon/items/user.py,sha256=bkcMw_YiocaMuhP_pBfB7apjAZwnsOzGScnGkn8Ybbw,6107
-python_terminusgps-1.9.8.dist-info/METADATA,sha256=LuMGvDMdgCMd1dCFqaXQDHGSd0YRkS_1S_PEe561X2c,882
-python_terminusgps-1.9.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-1.9.8.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-1.9.8.dist-info/RECORD,,
+python_terminusgps-1.9.9.dist-info/METADATA,sha256=tbP74Vv0X3nKIuyECKlcHHKVsoQJ4mp4BHRsP1Rj7V4,882
+python_terminusgps-1.9.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-1.9.9.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-1.9.9.dist-info/RECORD,,

terminusgps/wialon/items/base.py

@@ -1,17 +1,15 @@
-import terminusgps.wialon.flags as flags
+from abc import abstractmethod
+from terminusgps.wialon import flags
 from terminusgps.wialon.session import WialonSession
 
 
 class WialonBase:
-    def __init__(
-        self, *, id: str | None = None, session: WialonSession, **kwargs
-    ) -> None:
-        self._session = session
+    def __init__(self, id: str | int, session: WialonSession, **kwargs) -> None:
+        if isinstance(id, str) and not id.isdigit():
+            raise ValueError(f"'id' must be a digit. Got '{id}'.")
 
-        if not id:
-            self._id = self.create(**kwargs)
-        else:
-            self._id = id
+        self._session = session
+        self._id = str(id if id else self.create(**kwargs))
         self.populate()
 
     def __str__(self) -> str:
@@ -20,7 +18,7 @@ class WialonBase:
     def populate(self) -> None:
         response = self.session.wialon_api.core_search_item(
             **{"id": str(self.id), "flags": 0x1}
-        )["item"]
+        ).get("item", {})
         self.name = response.get("nm")
         self.hw_type = response.get("cls")
         self.access_lvl = response.get("uacl")
@@ -59,8 +57,9 @@ class WialonBase:
         )
         return True if self.id in response.keys() else False
 
+    @abstractmethod
     def create(self) -> int | None:
-        """Creates a Wialon object and returns the newly created Wialon object's id."""
+        """Creates a Wialon object and returns its id."""
         raise NotImplementedError("Subclasses must implement this method.")
 
     def rename(self, new_name: str) -> None:

terminusgps/wialon/items/unit.py

@@ -133,11 +133,20 @@ class WialonUnit(WialonBase):
             **{"itemId": self.id, "phoneNumber": quote_plus(phone)}
         )
 
+    def clean_phone_numbers(self, phones: list[str]) -> list[str]:
+        cleaned_phones = []
+        for num in phones:
+            if "," in num:
+                cleaned_phones.extend(num.split(","))
+            else:
+                cleaned_phones.append(num)
+        return cleaned_phones
+
     def get_phone_numbers(self) -> list[str]:
         """
         Retrieves all phone numbers assigned to this Wialon unit.
 
-        This includes the usually assigned phone number + custom/admin fields labeled ``to_number``.
+        This includes any attached drivers, custom fields, and normally assigned unit phone numbers.
 
         :raises WialonError: If something goes wrong with Wialon.
         :returns: A list of phone numbers.
@@ -145,8 +154,41 @@ class WialonUnit(WialonBase):
 
         """
 
-        phones = []
-        for field in self.cfields | self.afields:
-            if field["n"] == "to_number":
-                phones.append(field["v"])
-        return phones
+        phone_numbers = []
+        phones_0 = self._get_driver_phone_numbers()
+        phones_1 = self._get_cfield_phone_numbers()
+
+        if phones_0:
+            phone_numbers.extend(phones_0)
+        if phones_1:
+            phone_numbers.extend(phones_1)
+        return list(dict.fromkeys(phone_numbers))  # Removes duplicate phone numbers
+
+    def _get_cfield_phone_numbers(self) -> list[str] | None:
+        """
+        Retrives any phone numbers saved in the unit's custom 'to_number' field.
+
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: A list of phone numbers, if the unit has custom phone number fields.
+        :rtype: :py:obj:`list` | :py:obj:`None`
+
+        """
+        for key, value in self.cfields.items():
+            if key == "to_number":
+                return self.clean_phone_numbers([value])
+
+    def _get_driver_phone_numbers(self) -> list[str] | None:
+        """
+        Retrieves any phone numbers assigned to drivers attached to the unit.
+
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: A list of phone numbers, if the unit has attached drivers with phone numbers.
+        :rtype: :py:obj:`list` | :py:obj:`None`
+
+        """
+        response = self.session.wialon_api.resource_get_unit_drivers(
+            **{"unitId": self.id}
+        )
+        if response:
+            dirty_phones = [driver[0].get("ph") for _, driver in response.items()]
+            return self.clean_phone_numbers(dirty_phones)

terminusgps/wialon/session.py

@@ -50,7 +50,7 @@ class WialonSession:
 
     def __enter__(self) -> "WialonSession":
         assert self.token, "Wialon API token was not set"
-        self.login(self.token, self.login_id)
+        self.login(self.token)
         return self
 
     def __exit__(self, *args, **kwargs) -> None:
@@ -321,9 +321,6 @@ class WialonSessionManager:
         return cls._instance
 
     def get_session(self, sid: str | None = None) -> WialonSession:
-        if not hasattr(settings, "WIALON_TOKEN"):
-            raise ImproperlyConfigured("'WIALON_TOKEN' setting is required.")
-
         with self._lock:
             if not self._session or not self._session.active:
                 self._session = WialonSession(sid=sid)

terminusgps/wialon/utils.py

@@ -1,3 +1,4 @@
+from enum import Enum
 import secrets
 import string