python-terminusgps 1.15.3__tar.gz → 1.17.1__tar.gz

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.15.3
+Version: 1.17.1
 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.15.3 → python_terminusgps-1.17.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.15.3"
+version = "1.17.1"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/terminusgps/wialon/items/__init__.py

@@ -1,3 +1,4 @@
+from .notification import WialonNotification
 from .resource import WialonResource
 from .retranslator import WialonRetranslator
 from .route import WialonRoute

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/terminusgps/wialon/items/base.py

@@ -1,4 +1,5 @@
 from abc import abstractmethod
+from typing import Type
 
 from terminusgps.wialon import flags
 from terminusgps.wialon.session import WialonSession
@@ -24,6 +25,7 @@ class WialonBase:
         return str(self.id)
 
     def populate(self) -> None:
+        """Retrieves and saves the latest data for the item from Wialon."""
         response = self.session.wialon_api.core_search_item(
             **{"id": str(self.id), "flags": 0x1}
         ).get("item", {})
@@ -53,7 +55,7 @@ class WialonBase:
 
         return int(self._id) if self._id else None
 
-    def has_access(self, other: "WialonBase") -> bool:
+    def has_access(self, other: Type["WialonBase"]) -> bool:
         """
         Checks if this Wialon object has access to ``other``.
 
@@ -74,7 +76,7 @@ class WialonBase:
         """
         Renames the Wialon object to the new name.
 
-        :param new_name: A new name for this object.
+        :param new_name: A new name.
         :type new_name: :py:obj:`str`
         :returns: Nothing.
         :rtype: :py:obj:`None`
@@ -215,24 +217,27 @@ class WialonBase:
 
         self.session.wialon_api.item_delete_item(**{"itemId": self.id})
 
-    def _get_cfields(self) -> dict:
-        response = self.session.wialon_api.core_search_item(
-            **{"id": self.id, "flags": flags.DATAFLAG_UNIT_CUSTOM_FIELDS}
-        )
-        return response["item"]["flds"]
-
-    def _get_afields(self) -> dict:
-        response = self.session.wialon_api.core_search_item(
-            **{"id": self.id, "flags": flags.DATAFLAG_UNIT_ADMIN_FIELDS}
-        )
-        return response["item"]["aflds"]
-
     @property
     def cfields(self) -> dict:
-        fields = self._get_cfields()
-        return {field["n"]: field["v"] for _, field in fields.items()}
+        """Custom fields associated with the Wialon object."""
+        fields = (
+            self.session.wialon_api.core_search_item(
+                **{"id": self.id, "flags": flags.DATAFLAG_UNIT_CUSTOM_FIELDS}
+            )
+            .get("item", {})
+            .get("cfields")
+        )
+
+        return {field["n"]: field["v"] for _, field in fields.items()} if fields else {}
 
     @property
     def afields(self) -> dict:
-        fields = self._get_afields()
-        return {field["n"]: field["v"] for _, field in fields.items()}
+        """Admin fields associated with the Wialon object."""
+        fields = (
+            self.session.wialon_api.core_search_item(
+                **{"id": self.id, "flags": flags.DATAFLAG_UNIT_ADMIN_FIELDS}
+            )
+            .get("item", {})
+            .get("afields")
+        )
+        return {field["n"]: field["v"] for _, field in fields.items()} if fields else {}

python_terminusgps-1.17.1/terminusgps/wialon/items/notification.py

@@ -0,0 +1,4 @@
+from terminusgps.wialon.items.base import WialonBase
+
+
+class WialonNotification(WialonBase): ...

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/terminusgps/wialon/items/unit_group.py

@@ -1,4 +1,5 @@
-from terminusgps.wialon import constants, flags
+from typing import Type
+from terminusgps.wialon import flags
 from terminusgps.wialon.items.base import WialonBase
 
 
@@ -31,7 +32,7 @@ class WialonUnitGroup(WialonBase):
         )
         return response.get("item", {}).get("id")
 
-    def _update_items(self, new_items: list[str]) -> None:
+    def set_items(self, new_items: list[str]) -> None:
         """
         Sets this group's members to a list of Wialon unit ids.
 
@@ -47,7 +48,7 @@ class WialonUnitGroup(WialonBase):
             **{"itemId": self.id, "units": new_items}
         )
 
-    def is_member(self, item: WialonBase) -> bool:
+    def is_member(self, item: Type[WialonBase]) -> bool:
         """
         Determines whether or not ``item`` is a member of the group.
 
@@ -60,43 +61,9 @@ class WialonUnitGroup(WialonBase):
         """
         return True if str(item.id) in self.items else False
 
-    def grant_access(
-        self, item: WialonBase, access_mask: int = constants.ACCESSMASK_UNIT_BASIC
-    ) -> None:
+    def add_item(self, item: Type[WialonBase]) -> None:
         """
-        Grants ``item`` access to the group, if it didn't already have access.
-
-        :param item: A Wialon object.
-        :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :param access_mask: A Wialon access mask.
-        :type access_mask: :py:obj:`int`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        self.session.wialon_api.user_update_item_access(
-            **{"userId": item.id, "itemId": self.id, "accessMask": access_mask}
-        )
-
-    def revoke_access(self, item: WialonBase) -> None:
-        """
-        Revokes ``item``'s access from the group, if it had access.
-
-        :param item: A Wialon object.
-        :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        self.session.wialon_api.user_update_item_access(
-            **{"userId": item.id, "itemId": self.id, "accessMask": 0}
-        )
-
-    def add_item(self, item: WialonBase) -> None:
-        """
-        Adds a Wialon unit to the group.
+        Adds a Wialon item to the group.
 
         :param item: A Wialon object.
         :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
@@ -106,9 +73,9 @@ class WialonUnitGroup(WialonBase):
 
         """
         new_items: list[str] = self.items.copy() + [str(item.id)]
-        self._update_items(new_items)
+        self.set_items(new_items)
 
-    def rm_item(self, item: WialonBase) -> None:
+    def rm_item(self, item: Type[WialonBase]) -> None:
         """
         Removes a Wialon unit from the group, if it's a member of the group.
 
@@ -123,7 +90,7 @@ class WialonUnitGroup(WialonBase):
         assert self.is_member(item), f"Cannot remove {item}, it's not in the group"
         new_items: list[str] = self.items.copy()
         new_items.remove(str(item.id))
-        self._update_items(new_items)
+        self.set_items(new_items)
 
     @property
     def items(self) -> list[str]:
@@ -149,4 +116,4 @@ class WialonUnitGroup(WialonBase):
                 "to": 0,
             }
         )
-        return [str(unit_id) for unit_id in response.get("items")[0].get("u", [])]
+        return [unit_id for unit_id in response.get("items")[0].get("u", [])]

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/terminusgps/wialon/session.py

@@ -1,25 +1,24 @@
 import threading
 import logging
-
-from typing import Any
-from dataclasses import dataclass
-from datetime import datetime
+import typing
+import dataclasses
+import datetime
 
 from wialon.api import WialonError
 from wialon.api import Wialon as WialonAPI
 from django.conf import settings
 from django.utils import timezone
 
-from .errors import WialonLogoutError, WialonLoginError
+from terminusgps.wialon.errors import WialonLogoutError, WialonLoginError
 
 
-@dataclass
+@dataclasses.dataclass
 class WialonAPICall:
     action: str
-    timestamp: datetime
+    timestamp: datetime.datetime
     args: tuple
     kwargs: dict
-    result: Any = None
+    result: typing.Any = None
     error: Exception | None = None
 
 
@@ -45,7 +44,7 @@ class Wialon(WialonAPI):
     def failure_rate(self) -> float:
         return len(self.failed_calls) / self.total_calls
 
-    def call(self, action_name: str, *argc, **kwargs) -> Any:
+    def call(self, action_name: str, *argc, **kwargs) -> typing.Any:
         self.logger.info(f"Executing '{action_name}'...")
         self.logger.debug(f"Executing '{action_name}' using: '{kwargs}'")
         call_record = WialonAPICall(
@@ -368,16 +367,3 @@ class WialonSessionManager:
             if not self._session:
                 self._session = WialonSession(sid=sid, log_level=log_level)
         return self._session
-
-
-def main() -> None:
-    from terminusgps.wialon.items import WialonUnit
-
-    with WialonSession(log_level=logging.DEBUG) as session:
-        unit = WialonUnit(id="28082258", session=session)
-        unit.add_cfield(("to_number", "+17133049421"))
-    return
-
-
-if __name__ == "__main__":
-    main()

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/terminusgps/wialon/utils.py

@@ -1,7 +1,7 @@
 import secrets
 import string
 import warnings
-from typing import Type
+import typing
 
 from terminusgps.wialon import items, flags
 from terminusgps.wialon.items.base import WialonBase
@@ -67,7 +67,7 @@ def get_id_from_iccid(iccid: str, session: WialonSession) -> str | None:
         return response["items"][0].get("id")
 
 
-def get_wialon_cls(items_type: str) -> Type[WialonBase]:
+def get_wialon_cls(items_type: str) -> typing.Type[WialonBase]:
     """
     Returns a Wialon object class based on items_type.
 
@@ -91,6 +91,29 @@ def get_wialon_cls(items_type: str) -> Type[WialonBase]:
     return wialon_cls
 
 
+def get_vin_info(vin_number: str, session: WialonSession) -> dict:
+    """
+    Retrieves vehicle data from a VIN number.
+
+    :param value: A vehicle's VIN number.
+    :type value: :py:obj:`str`
+    :param session: A valid Wialon API session.
+    :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
+    :returns: A dictionary of vehicle information, if any was found.
+    :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 {}
+    )
+
+
 def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit") -> bool:
     """
     Determines if the value is unique among Wialon objects of type 'items_type'.
@@ -104,7 +127,6 @@ def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit")
     :returns: Whether or not the value is unique among 'items_type'.
     :rtype: :py:obj:`bool`
 
-
     """
     result = session.wialon_api.core_check_unique(
         **{"type": items_type, "value": value.strip()}
@@ -112,29 +134,6 @@ def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit")
     return not bool(result)
 
 
-def gen_wialon_password(length: int = 32) -> str:
-    """
-    DEPRECATED: Use :py:func:`~terminusgps.wialon.utils.generate_wialon_password` instead.
-
-    Generates a Wialon compliant password of random characters.
-
-    Password length can be between ``8`` and ``64`` characters.
-
-    :param length: Length of the generated password. Default is ``32``.
-    :type length: :py:obj:`int`
-    :raises ValueError: If the provided length is invalid.
-    :returns: A Wialon compliant password.
-    :rtype: :py:obj:`str`
-
-    """
-    warnings.warn(
-        "gen_wialon_password is deprecated and will be removed in a future version. Use generate_wialon_password instead.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-    return generate_wialon_password(length)
-
-
 def generate_wialon_password(length: int = 32) -> str:
     """
     Generates a Wialon compliant password of random characters.
@@ -173,3 +172,26 @@ def generate_wialon_password(length: int = 32) -> str:
         ):
             break
     return password
+
+
+def gen_wialon_password(length: int = 32) -> str:
+    """
+    DEPRECATED: Use :py:func:`~terminusgps.wialon.utils.generate_wialon_password` instead.
+
+    Generates a Wialon compliant password of random characters.
+
+    Password length can be between ``8`` and ``64`` characters.
+
+    :param length: Length of the generated password. Default is ``32``.
+    :type length: :py:obj:`int`
+    :raises ValueError: If the provided length is invalid.
+    :returns: A Wialon compliant password.
+    :rtype: :py:obj:`str`
+
+    """
+    warnings.warn(
+        "gen_wialon_password is deprecated and will be removed in a future version. Use generate_wialon_password instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return generate_wialon_password(length)

{python_terminusgps-1.15.3 → python_terminusgps-1.17.1}/uv.lock

@@ -504,7 +504,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "1.15.3"
+version = "1.17.1"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

python_terminusgps-1.15.3/terminusgps/wialon/items/notification.py

@@ -1,33 +0,0 @@
-from terminusgps.wialon.items.base import WialonBase
-
-
-class WialonNotification(WialonBase):
-    def create(
-        self,
-        resource_id: str | int,
-        name: str,
-        activation_time: int,
-        deactivation_time: int,
-        text: str | None = None,
-        max_alarms: int = 0,
-        interval: int = 0,
-        lang: str = "en",
-    ) -> int | None:
-        if isinstance(resource_id, str) and not resource_id.isdigit():
-            raise ValueError(f"'resource_id' must be a digit, got '{resource_id}'.")
-
-        response = self.session.wialon_api.resource_update_notification(
-            **{
-                "itemId": resource_id,
-                "id": 0,
-                "callMode": "create",
-                "n": name,
-                "txt": text if text else name,
-                "ta": activation_time,
-                "td": deactivation_time,
-                "ma": max_alarms,
-                "mmtd": interval,
-                "la": lang,
-            }
-        )
-        return int(response[0].get("id")) if response else None