python-terminusgps 25.0.3__py3-none-any.whl → 26.0.0__py3-none-any.whl

{python_terminusgps-25.0.3.dist-info → python_terminusgps-26.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 25.0.3
+Version: 26.0.0
 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-25.0.3.dist-info → python_terminusgps-26.0.0.dist-info}/RECORD

@@ -16,21 +16,22 @@ terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,36
 terminusgps/aws/ses.py,sha256=sDca2GjMaZvUt3kUPtGCpcqHiOkij9lMV1ogZofgYUU,2372
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=TiQ4f0TDDC35he1M1iSsBM2vutdGriwtV4pc17T--6I,3552
+terminusgps/twilio/validators.py,sha256=nn7CCBTktNjcln6M4MR0ACxEsClgioSu89LRLgIiBZk,1112
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=n1ux68oWYWnzeZdN811Iw_Lk78KBM0YMJMoonn67uZY,1723
 terminusgps/wialon/flags.py,sha256=_NIL3mrEGhvI5YISVjimjYtUatdgOqhZPJX368MtKSU,13959
 terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=t3d7trBQRxnXFnex73alSSD5n2LDTZQ9VAtzUKIERto,9670
-terminusgps/wialon/utils.py,sha256=Y7fo9a81w84b3N39h1AmVLS-AnC3aRT5R137hIsqCHU,6723
+terminusgps/wialon/session.py,sha256=THl88yfVBfRH8daKh1lmLSR8ro8TbyOokHx1Cev-En8,9638
+terminusgps/wialon/utils.py,sha256=QXBksDJlC0_khuJ6n9HEYlUQB9ArM-Pvh-K0xHORvDs,6917
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=zINd7NWeq4EGQgRhq6bNfEymeyq3uojn8HD71HvhJaQ,6998
+terminusgps/wialon/items/base.py,sha256=5UssVqdAJEReITjh0RKjQ419IS1QA3htjWZAxLXmRbQ,6915
 terminusgps/wialon/items/resource.py,sha256=qmQKEakJa9LH5YkI9-iBDA0hsotc5ctcwdb7kZuXdfQ,14549
 terminusgps/wialon/items/retranslator.py,sha256=8q9EDc92w92MElnHIeEzH3Ra4kiPXrx4t9V5nPDZuRU,3728
 terminusgps/wialon/items/route.py,sha256=PTJx1gmT_PGz7nlSSUS2VzjYD-aAuvkEOIdIFneUSSQ,1148
-terminusgps/wialon/items/unit.py,sha256=uHQrauVkh2556kZp0Dh3WLZvQ6WJIWkibGgPYW1ljPE,9177
+terminusgps/wialon/items/unit.py,sha256=Kn2lq6SJNcvlIjKeRIfZfvGNsHZ1xVVwiyI9WKMzE1M,9164
 terminusgps/wialon/items/unit_group.py,sha256=Stp-WfCGbOqcnxV6FU1AKtV7KIxIwCHa0NwhNJfgRoM,5032
 terminusgps/wialon/items/user.py,sha256=INwAibQVmjNNelepQXMfDevgJqMvIjHHgEjAMLRvhB0,7082
-python_terminusgps-25.0.3.dist-info/METADATA,sha256=wUbbi7rTr9yWRuwoo-MVWZLXE41Dk1QEt3npcZfvl28,946
-python_terminusgps-25.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-25.0.3.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-25.0.3.dist-info/RECORD,,
+python_terminusgps-26.0.0.dist-info/METADATA,sha256=4sdznR0fg1dw8e55_cdmsmmREF9Ul3KzG3Wggo-yBVo,946
+python_terminusgps-26.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-26.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-26.0.0.dist-info/RECORD,,

terminusgps/twilio/validators.py

@@ -0,0 +1,31 @@
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+
+def validate_phone_number(value: str) -> None:
+    min_length, max_length = 12, 19
+
+    if not value.startswith("+"):
+        raise ValidationError(
+            _("Phone number must begin with a '+', got '%(value)s'."),
+            code="invalid",
+            params={"value": value},
+        )
+    if not value[1:].isdigit():
+        raise ValidationError(
+            _("Phone number must be '+' followed by a digit, got '%(value)s'"),
+            code="invalid",
+            params={"value": value},
+        )
+    if len(value) < min_length:
+        raise ValidationError(
+            _("Phone number cannot be less than %(min)s characters, got %(len)s."),
+            code="invalid",
+            params={"min": min_length, "len": len(value)},
+        )
+    if len(value) > max_length:
+        raise ValidationError(
+            _("Phone number cannot be greater than %(max)s characters, got %(len)s."),
+            code="invalid",
+            params={"max": min_length, "len": len(value)},
+        )

terminusgps/wialon/items/base.py

@@ -128,78 +128,71 @@ class WialonBase:
             }
         )
 
-    def add_cfield(self, field: tuple[str, str]) -> None:
+    def add_cfield(self, key: str, value: str) -> None:
         """
         Adds a custom field to the Wialon object.
 
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
+        :param key: A key (name) for the custom field.
+        :type key: :py:obj:`str`
+        :param value: A value for the custom field.
+        :type value: :py:obj:`str`
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
 
         self.session.wialon_api.item_update_custom_field(
-            **{
-                "itemId": self.id,
-                "id": 0,
-                "callMode": "create",
-                "n": field[0],
-                "v": field[1],
-            }
+            **{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
         )
 
-    def update_cfield(self, field_id: int, field: tuple[str, str]) -> None:
+    def update_cfield(self, id: int, key: str, value: str) -> None:
         """
         Updates a custom field by id.
 
-        :param field_id: The admin field id.
-        :type field_id: :py:obj:`int`
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
+        :param id: The admin field id.
+        :type id: :py:obj:`int`
+        :param field: A key (name) for the custom field.
+        :type field: :py:obj:`str`
+        :param field: A value for the custom field.
+        :type field: :py:obj:`str`
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_custom_field(
-            **{
-                "itemId": self.id,
-                "id": field_id,
-                "callMode": "update",
-                "n": field[0],
-                "v": field[1],
-            }
+            **{"itemId": self.id, "id": id, "callMode": "update", "n": key, "v": value}
         )
 
-    def add_cproperty(self, property: tuple[str, str]) -> None:
+    def add_cproperty(self, key: str, value: str) -> None:
         """
         Adds a custom property to the Wialon object.
 
-        :param property: A tuple containing the name of the property and the value of the property.
-        :type property: :py:obj:`tuple`
+        :param key: A key (name) for the custom property.
+        :type key: :py:obj:`str`
+        :param value: A value for the custom property.
+        :type value: :py:obj:`str`
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_custom_property(
-            **{"itemId": self.id, "name": property[0], "value": property[1]}
+            **{"itemId": self.id, "name": key, "value": value}
         )
 
-    def add_profile_field(self, field: tuple[str, str]) -> None:
+    def add_profile_field(self, key: str, value: str) -> None:
         """
         Adds a profile field to the Wialon object.
 
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
+        :param key: A key (name) for the profile field.
+        :type key: :py:obj:`str`
+        :param value: A value for the profile field.
+        :type value: :py:obj:`str`
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_profile_field(
-            **{"itemId": self.id, "n": field[0], "v": field[1]}
+            **{"itemId": self.id, "n": key, "v": value}
         )
 
     def delete(self) -> None:
@@ -211,12 +204,11 @@ class WialonBase:
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_delete_item(**{"itemId": self.id})
 
     @property
-    def cfields(self) -> dict:
-        """Custom fields associated with the Wialon object."""
+    def cfields(self) -> dict[str, str]:
+        """Custom fields for the Wialon object."""
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_UNIT_CUSTOM_FIELDS}
         )
@@ -224,8 +216,8 @@ class WialonBase:
         return {field["n"]: field["v"] for field in fields.values()} if fields else {}
 
     @property
-    def afields(self) -> dict:
-        """Admin fields associated with the Wialon object."""
+    def afields(self) -> dict[str, str]:
+        """Admin fields for the Wialon object."""
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_UNIT_ADMIN_FIELDS}
         )

terminusgps/wialon/items/unit.py

@@ -48,7 +48,7 @@ class WialonUnit(WialonBase):
                 ),
             }
         )
-        if response is not None:
+        if response:
             item = response.get("item", {})
             self._imei_number = item.get("uid")
             self._active = item.get("act", False)
@@ -194,7 +194,7 @@ class WialonUnit(WialonBase):
         """
         Retrieves all phone numbers assigned to the unit.
 
-        This includes any attached drivers, custom/admin fields, or otherwise assigned phone numbers.
+        This includes any attached drivers, custom/admin fields or otherwise assigned phone numbers.
 
         :raises WialonError: If something goes wrong with Wialon.
         :returns: A list of phone numbers.

terminusgps/wialon/session.py

@@ -3,10 +3,9 @@ import datetime
 import logging
 import typing
 
+import wialon.api
 from django.conf import settings
 from django.utils import timezone
-from wialon.api import Wialon as WialonBase
-from wialon.api import WialonError
 
 from terminusgps.wialon.logger import WialonLogger
 
@@ -21,7 +20,7 @@ class WialonAPICall:
     error: Exception | None = None
 
 
-class Wialon(WialonBase):
+class Wialon(wialon.api.Wialon):
     def __init__(self, log_level: int = logging.INFO, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.call_history: list[WialonAPICall] = []
@@ -48,7 +47,7 @@ class Wialon(WialonBase):
             call_record.result = result
             self.logger.debug(f"Executed '{action_name}' successfully.")
             return result
-        except WialonError as e:
+        except wialon.api.WialonError as e:
             call_record.error = e
             self.logger.warning(f"Failed to execute '{action_name}': '{e}'")
             return
@@ -275,7 +274,7 @@ class WialonSession:
             self._set_login_response(response)
             self.logger.debug(f"Logged into Wialon API session '{response.get('eid')}'")
             return response.get("eid")
-        except (WialonError, AssertionError) as e:
+        except (wialon.api.WialonError, AssertionError) as e:
             self.logger.critical(f"Failed to login to Wialon API: '{e}'")
             raise
 

terminusgps/wialon/utils.py

@@ -49,7 +49,7 @@ def get_id_from_imei(imei: str, session: WialonSession) -> str | None:
     if not imei.isdigit():
         raise ValueError(f"'imei' must be a digit, got '{imei}'.")
 
-    results = session.wialon_api.core_search_items(
+    results: dict[str, typing.Any] | None = session.wialon_api.core_search_items(
         **{
             "spec": {
                 "itemsType": "avl_unit",
@@ -66,7 +66,7 @@ def get_id_from_imei(imei: str, session: WialonSession) -> str | None:
         }
     )
 
-    if results.get("totalItemsCount", 0) == 1:
+    if results and results.get("totalItemsCount", 0) == 1:
         return results["items"][0].get("id")
 
 
@@ -88,27 +88,25 @@ def get_id_from_iccid(iccid: str, session: WialonSession) -> str | None:
     return get_id_from_imei(imei=iccid, session=session)
 
 
-def get_wialon_cls(items_type: str) -> typing.Type[WialonBase]:
+def get_wialon_cls(items_type: str) -> typing.Type[WialonBase] | None:
     """
-    Returns a Wialon object class based on items_type.
+    Returns a Wialon object class based on ``items_type``.
+
+    Valid ``items_type`` are ``"user"``, ``"avl_unit"``, ``"avl_unit_group"`` and ``"avl_resource"``.
 
     :param items_type: A Wialon object type.
     :type items_type: :py:obj:`str`
     :returns: A subclass of :py:obj:`~terminusgps.wialon.items.base.WialonBase`.
-    :rtype: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
+    :rtype: :py:obj:`~terminusgps.wialon.items.base.WialonBase` | :py:obj:`None`
 
     """
-    match items_type:
-        case "user":
-            return items.WialonUser
-        case "avl_unit":
-            return items.WialonUnit
-        case "avl_unit_group":
-            return items.WialonUnitGroup
-        case "avl_resource":
-            return items.WialonResource
-        case _:
-            raise ValueError(f"Invalid items_type, got '{items_type}'.")
+    items_map: dict[str, typing.Type[WialonBase]] = {
+        "user": items.WialonUser,
+        "avl_unit": items.WialonUnit,
+        "avl_unit_group": items.WialonUnitGroup,
+        "avl_resource": items.WialonResource,
+    }
+    return items_map.get(items_type)
 
 
 def get_vin_info(vin_number: str, session: WialonSession) -> dict:
@@ -123,15 +121,18 @@ def get_vin_info(vin_number: str, session: WialonSession) -> dict:
     :rtype: :py:obj:`dict`
 
     """
-    response = session.wialon_api.unit_get_vin_info(**{"vin": vin_number}).get(
-        "vin_lookup_result"
-    )
-    return (
-        {field.get("n"): field.get("v") for field in response.get("pflds")}
-        if "error" not in response.keys()
-        else {}
+    response: dict[str, typing.Any] | None = session.wialon_api.unit_get_vin_info(
+        **{"vin": vin_number}
     )
 
+    if response is None or "error" in response.get("vin_lookup_result", {}).keys():
+        return {}
+
+    return {
+        field.get("n"): field.get("v")
+        for field in response.get("vin_lookup_result", {}).get("pflds")
+    }
+
 
 def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit") -> bool:
     """
@@ -148,12 +149,14 @@ def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit")
     :rtype: :py:obj:`bool`
 
     """
-    return not bool(
-        session.wialon_api.core_check_unique(
-            **{"type": items_type, "value": value.strip()}
-        ).get("result")
+    response = session.wialon_api.core_check_unique(
+        **{"type": items_type, "value": value.strip()}
     )
 
+    if not response:
+        return False
+    return bool(response.get("result"))
+
 
 def generate_wialon_password(length: int = 32) -> str:
     """