python-terminusgps 1.1.4__tar.gz → 1.2.0__tar.gz

{python_terminusgps-1.1.4 → python_terminusgps-1.2.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.3
 Name: python-terminusgps
-Version: 1.1.4
+Version: 1.2.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
+Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps
 Author-email: Blake Nall <blake@terminusgps.com>
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)

{python_terminusgps-1.1.4 → python_terminusgps-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.1.4"
+version = "1.2.0"
 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" } ]
@@ -21,7 +21,7 @@ dependencies = [
 ]
 
 [project.urls]
-Documentation = "https://app.terminusgps.com/docs/apps/python-terminusgps"
+Documentation = "https://app.terminusgps.com/docs/apps/python-terminusgps/index.html"
 Repository = "https://github.com/terminusgps/python-terminusgps"
 
 [build-system]

{python_terminusgps-1.1.4 → python_terminusgps-1.2.0}/terminusgps/wialon/items/base.py

@@ -2,9 +2,11 @@ from typing import Any
 
 import terminusgps.wialon.flags as flags
 from terminusgps.wialon.session import WialonSession
+from terminusgps.wialon.utils import repopulate
 
 
 class WialonBase:
+    @repopulate
     def __init__(
         self, *, id: str | None = None, session: WialonSession, **kwargs
     ) -> None:
@@ -14,7 +16,6 @@ class WialonBase:
             self._id = self.create(**kwargs)
         else:
             self._id = id
-        self.populate()
 
     def __str__(self) -> str:
         return f"{self.__class__}:{self.id}"
@@ -31,9 +32,7 @@ class WialonBase:
         response = self.session.wialon_api.core_check_accessors(
             **{"items": [other_item.id], "flags": False}
         )
-        if self.id in response.keys():
-            return True
-        return False
+        return True if self.id in response.keys() else False
 
     def create(self) -> int | None:
         """Creates a Wialon object and returns the newly created Wialon object's id."""
@@ -48,11 +47,11 @@ class WialonBase:
         self.name = item.get("nm", None)
         self.uid = item.get("uid", None)
 
+    @repopulate
     def rename(self, new_name: str) -> None:
         self.session.wialon_api.item_update_name(
             **{"itemId": self.id, "name": new_name}
         )
-        self.populate()
 
     def add_afield(self, field: tuple[str, str]) -> None:
         self.session.wialon_api.item_update_admin_field(
@@ -111,9 +110,24 @@ class WialonBase:
     def delete(self) -> None:
         self.session.wialon_api.item_delete_item(**{"itemId": self.id})
 
-    @property
-    def cfields(self) -> dict[str, Any]:
+    def _get_cfields(self) -> dict:
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_UNIT_CUSTOM_FIELDS}
         )
-        return response.get("item", {}).get("flds")
+        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()}
+
+    @property
+    def afields(self) -> dict:
+        fields = self._get_afields()
+        return {field["n"]: field["v"] for _, field in fields.items()}

python_terminusgps-1.2.0/terminusgps/wialon/items/unit.py

@@ -0,0 +1,90 @@
+from urllib.parse import quote_plus
+
+from terminusgps.wialon import flags
+from terminusgps.wialon.items.base import WialonBase, repopulate
+
+
+class WialonUnit(WialonBase):
+    def create(self, **kwargs) -> int | None:
+        if not kwargs.get("owner_id"):
+            raise ValueError("'owner_id' is required on creation.")
+        if not kwargs.get("name"):
+            raise ValueError("'name' is required on creation.")
+        if not kwargs.get("hw_type"):
+            raise ValueError("'hw_type' is required on creation.")
+
+        response = self.session.wialon_api.core_create_unit(
+            **{
+                "creatorId": kwargs["owner_id"],
+                "name": kwargs["name"],
+                "hwTypeId": kwargs["hw_type"],
+                "dataFlags": flags.DATAFLAG_UNIT_BASE,
+            }
+        )
+        return response.get("item", {}).get("id")
+
+    def populate(self) -> None:
+        super().populate()
+        unit_data = self.session.wialon_api.core_search_item(
+            **{"id": self.id, "flags": flags.DATAFLAG_UNIT_ADVANCED_PROPERTIES}
+        )
+        self.uid = unit_data.get("uid", "")
+        self.phone = unit_data.get("ph", "")
+        self.is_active = bool(unit_data.get("act", 0))
+
+    def execute_command(
+        self,
+        name: str,
+        link_type: str,
+        timeout: int = 5,
+        flags: int = 0,
+        param: dict | None = None,
+    ) -> None:
+        self.session.wialon_api.unit_exec_cmd(
+            **{
+                "itemId": self.id,
+                "commandName": name,
+                "linkType": link_type,
+                "timeout": timeout,
+                "flags": flags,
+                "param": param if param else {},
+            }
+        )
+
+    def set_access_password(self, password: str) -> None:
+        self.session.wialon_api.unit_update_access_password(
+            **{"itemId": self.id, "accessPassword": password}
+        )
+
+    @repopulate
+    def activate(self) -> None:
+        if self.is_active:
+            return
+
+        self.session.wialon_api.unit_set_active(
+            **{"itemId": self.id, "active": int(True)}
+        )
+
+    @repopulate
+    def deactivate(self) -> None:
+        if not self.is_active:
+            return
+
+        self.session.wialon_api.unit_set_active(
+            **{"itemId": self.id, "active": int(False)}
+        )
+
+    @repopulate
+    def assign_phone(self, phone: str) -> None:
+        self.session.wialon_api.unit_update_phone(
+            **{"itemId": self.id, "phoneNumber": quote_plus(phone)}
+        )
+
+    def get_phone_numbers(self) -> list[str]:
+        phones = []
+        if self.phone:
+            phones.append(self.phone)
+        for field in self.cfields | self.afields:
+            if field["n"] == "to_number":
+                phones.append(field["v"])
+        return phones

python_terminusgps-1.2.0/terminusgps/wialon/items/unit_group.py

@@ -0,0 +1,71 @@
+from terminusgps.wialon import constants, flags
+from terminusgps.wialon.items.base import WialonBase
+
+
+class WialonUnitGroup(WialonBase):
+    def _update_items(self, new_items: list[str]) -> None:
+        self.session.wialon_api.unit_group_update_units(
+            **{"itemId": self.id, "units": new_items}
+        )
+
+    def create(self, **kwargs) -> int | None:
+        if not kwargs.get("owner_id"):
+            raise ValueError("'owner_id' is required on creation.")
+        if not kwargs.get("name"):
+            raise ValueError("'name' is required on creation.")
+
+        response = self.session.wialon_api.core_create_unit_group(
+            **{
+                "creatorId": kwargs["owner_id"],
+                "name": kwargs["name"],
+                "dataFlags": flags.DATAFLAG_UNIT_BASE,
+            }
+        )
+        return response.get("item", {}).get("id")
+
+    def is_member(self, item: WialonBase) -> bool:
+        return True if str(item.id) in self.items else False
+
+    def grant_access(self, item: WialonBase, access_mask: int | None = None) -> None:
+        if not access_mask:
+            access_mask = constants.ACCESSMASK_UNIT_BASIC
+
+        self.session.wialon_api.user_update_item_access(
+            **{"userId": item.id, "itemId": self.id, "accessMask": access_mask}
+        )
+
+    def revoke_access(self, item: WialonBase) -> None:
+        self.session.wialon_api.user_update_item_access(
+            **{"userId": item.id, "itemId": self.id, "accessMask": 0}
+        )
+
+    def add_item(self, item: WialonBase) -> None:
+        new_items: list[str] = self.items + [str(item.id)]
+        self._update_items(new_items)
+
+    def rm_item(self, item: WialonBase) -> None:
+        assert self.is_member(item), "Cannot remove item, it's not in the group"
+        new_items: list[str] = self.items
+        new_items.remove(str(item.id))
+        self._update_items(new_items)
+
+    @property
+    def items(self) -> list[str]:
+        """Calls the Wialon API and returns a list of group member IDs."""
+        response = self.session.wialon_api.core_search_items(
+            **{
+                "spec": {
+                    "itemsType": "avl_unit_group",
+                    "propName": "sys_id",
+                    "propValueMask": str(self.id),
+                    "sortType": "sys_id",
+                    "propType": "property",
+                    "or_logic": 0,
+                },
+                "force": 1,
+                "flags": flags.DATAFLAG_UNIT_BASE,
+                "from": 0,
+                "to": 0,
+            }
+        )
+        return [str(unit_id) for unit_id in response.get("items")[0].get("u", [])]

{python_terminusgps-1.1.4 → python_terminusgps-1.2.0}/terminusgps/wialon/items/user.py

@@ -47,9 +47,7 @@ class WialonUser(WialonBase):
     def has_access(self, other_item: WialonBase) -> bool:
         response = self._get_access_response(hw_type=other_item.hw_type)
         items = [key for key in response.keys()]
-        if str(other_item.id) in items:
-            return True
-        return False
+        return True if str(other_item.id) in items else False
 
     def assign_phone(self, phone: str) -> None:
         self.add_cproperty(("phone", quote_plus(phone)))

{python_terminusgps-1.1.4 → python_terminusgps-1.2.0}/terminusgps/wialon/utils.py

@@ -5,6 +5,15 @@ from .session import WialonSession
 from .flags import DATAFLAG_UNIT_BASE
 
 
+def repopulate(func):
+    def wrapper(self, *args, **kwargs):
+        result = func(self, *args, **kwargs)
+        self.populate()
+        return result
+
+    return wrapper
+
+
 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'."""
     result = session.wialon_api.core_check_unique(

{python_terminusgps-1.1.4 → python_terminusgps-1.2.0}/uv.lock

@@ -176,7 +176,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "1.1.1"
+version = "1.2.0"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

python_terminusgps-1.1.4/terminusgps/wialon/items/unit.py

@@ -1,22 +0,0 @@
-from terminusgps.wialon import flags
-from terminusgps.wialon.items.base import WialonBase
-
-
-class WialonUnit(WialonBase):
-    def create(self, **kwargs) -> int | None:
-        if not kwargs.get("owner_id"):
-            raise ValueError("'owner_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
-        if not kwargs.get("hw_type"):
-            raise ValueError("'hw_type' is required on creation.")
-
-        response = self.session.wialon_api.core_create_unit(
-            **{
-                "creatorId": kwargs["owner_id"],
-                "name": kwargs["name"],
-                "hwTypeId": kwargs["hw_type"],
-                "dataFlags": flags.DATAFLAG_UNIT_BASE,
-            }
-        )
-        return response.get("item", {}).get("id")

python_terminusgps-1.1.4/terminusgps/wialon/items/unit_group.py

@@ -1,19 +0,0 @@
-from terminusgps.wialon import flags
-from terminusgps.wialon.items.base import WialonBase
-
-
-class WialonUnitGroup(WialonBase):
-    def create(self, **kwargs) -> int | None:
-        if not kwargs.get("owner_id"):
-            raise ValueError("'owner_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
-
-        response = self.session.wialon_api.core_create_unit_group(
-            **{
-                "creatorId": kwargs["owner_id"],
-                "name": kwargs["name"],
-                "dataFlags": flags.DATAFLAG_UNIT_BASE,
-            }
-        )
-        return response.get("item", {}).get("id")