python-terminusgps 1.2.2__tar.gz → 1.4.0__tar.gz

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.2.2
+Version: 1.4.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
 Author-email: Blake Nall <blake@terminusgps.com>
+License-File: COPYING
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.2.2"
+version = "1.4.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" } ]

python_terminusgps-1.4.0/terminusgps/wialon/constants.py

@@ -0,0 +1,76 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from terminusgps.wialon import flags
+
+
+class WialonCommandName(models.TextChoices):
+    SUB_BASIC = "Basic", _("Basic Subscription")
+    SUB_STANDARD = "Standard", _("Standard Subscription")
+    SUB_PREMIUM = "Premium", _("Premium Subscription")
+    STARTER_DISABLED = "Starter Disable On", _("Disable Starter")
+    STARTER_ENABLED = "Starter Disable Off", _("Enable Starter")
+    ENABLE = "On", _("Enable")
+    DISABLE = "Off", _("Disable")
+
+
+class WialonCommandType(models.TextChoices):
+    ENGINE_BLOCK = "block_engine", _("Block Engine")
+    ENGINE_UNBLOCK = "unblock_engine", _("Unblock Engine")
+    CUSTOM_MSG = "custom_msg", _("Custom Message")
+    DRIVER_MSG = "driver_msg", _("Message to Driver")
+    DOWNLOAD_MSG = "download_msgs", _("Download messages")
+    QUERY_POS = "query_pos", _("Query Position")
+    QUERY_PHOTO = "query_photo", _("Query Snapshot")
+    OUTPUT_ON = "output_on", _("Activate Output")
+    OUTPUT_OFF = "output_off", _("Deactive Output")
+    SEND_POS = "send_position", _("Send Coordinates")
+    SET_REPORT_INT = "set_report_interval", _("Set Data Transfer Interval")
+    UPLOAD_CFG = "upload_cfg", _("Upload Configuration")
+    UPLOAD_SW = "upload_sw", _("Upload Firmware")
+
+
+class WialonCommandLink(models.TextChoices):
+    AUTO = "", _("Auto")
+    TCP = "tcp", _("TCP")
+    UDP = "udp", _("UDP")
+    VRT = "vrt", _("Virtual")
+    GSM = "gsm", _("SMS")
+
+
+ACCESSMASK_UNIT_BASIC: int = sum(
+    [
+        flags.ACCESSFLAG_VIEW_ITEM_BASIC,
+        flags.ACCESSFLAG_VIEW_ITEM_DETAILED,
+        flags.ACCESSFLAG_RENAME_ITEM,
+        flags.ACCESSFLAG_VIEW_CUSTOM_FIELDS,
+        flags.ACCESSFLAG_MANAGE_CUSTOM_FIELDS,
+        flags.ACCESSFLAG_MANAGE_ICON,
+        flags.ACCESSFLAG_QUERY_REPORTS,
+        flags.ACCESSFLAG_VIEW_ATTACHED_FILES,
+        flags.ACCESSFLAG_UNIT_EXECUTE_COMMANDS,
+        flags.ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS,
+        flags.ACCESSFLAG_UNIT_REGISTER_EVENTS,
+        flags.ACCESSFLAG_UNIT_IMPORT_MESSAGES,
+        flags.ACCESSFLAG_UNIT_EXPORT_MESSAGES,
+    ]
+)
+
+ACCESSMASK_UNIT_SUPER: int = sum(
+    [
+        flags.ACCESSFLAG_VIEW_ITEM_BASIC,
+        flags.ACCESSFLAG_VIEW_ITEM_DETAILED,
+        flags.ACCESSFLAG_RENAME_ITEM,
+        flags.ACCESSFLAG_VIEW_CUSTOM_FIELDS,
+        flags.ACCESSFLAG_MANAGE_CUSTOM_FIELDS,
+        flags.ACCESSFLAG_MANAGE_ICON,
+        flags.ACCESSFLAG_QUERY_REPORTS,
+        flags.ACCESSFLAG_VIEW_ATTACHED_FILES,
+        flags.ACCESSFLAG_UNIT_EXECUTE_COMMANDS,
+        flags.ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS,
+        flags.ACCESSFLAG_UNIT_REGISTER_EVENTS,
+        flags.ACCESSFLAG_UNIT_IMPORT_MESSAGES,
+        flags.ACCESSFLAG_UNIT_EXPORT_MESSAGES,
+    ]
+)
+
+ACCESSMASK_UNIT_FULL: int = sum([flags.ACCESSFLAG_FULL_ACCESS])

python_terminusgps-1.4.0/terminusgps/wialon/items/account.py

@@ -0,0 +1,25 @@
+from terminusgps.wialon.items.base import WialonBase
+from terminusgps.wialon.items import WialonResource, WialonUser
+
+
+class WialonAccount(WialonBase):
+    def __init__(
+        self, billing_plan: str = "terminusgps_ext_hist", *args, **kwargs
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self.billing_plan = billing_plan
+
+    def create(self, **kwargs) -> int | None:
+        if not kwargs.get("creator_id"):
+            raise ValueError("'creator_id' is required for creation.")
+
+        user = WialonUser(id=str(kwargs["creator_id"]), session=self.session)
+        resource = WialonResource(
+            creator_id=kwargs["creator_id"],
+            name=f"super_{user.name}",
+            session=self.session,
+        )
+        self.session.wialon_api.account_create_account(
+            **{"itemId": resource.id, "plan": kwargs.get("plan", self.billing_plan)}
+        )
+        return int(kwargs["resource_id"])

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/base.py

@@ -1,5 +1,3 @@
-from typing import Any
-
 import terminusgps.wialon.flags as flags
 from terminusgps.wialon.session import WialonSession
 from terminusgps.wialon.utils import repopulate

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/resource.py

@@ -4,16 +4,18 @@ from terminusgps.wialon.items.base import WialonBase
 
 class WialonResource(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("creator_id"):
+            raise ValueError("'creator_id' is required for creation.")
         if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
+            raise ValueError("'name' is required for creation.")
+        if not kwargs.get("flags"):
+            kwargs["flags"] = flags.DATAFLAG_UNIT_BASE
 
         response = self.session.wialon_api.core_create_resource(
             **{
-                "creatorId": kwargs["owner_id"],
+                "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
-                "dataFlags": flags.DATAFLAG_UNIT_BASE,
+                "dataFlags": kwargs["flags"],
                 "skipCreatorCheck": True,
             }
         )

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/retranslator.py

@@ -4,8 +4,8 @@ from terminusgps.wialon.items.base import WialonBase
 
 class WialonRetranslator(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("creator_id"):
+            raise ValueError("'creator_id' is required on creation.")
         if not kwargs.get("name"):
             raise ValueError("'name' is required on creation.")
         if not kwargs.get("config"):
@@ -13,7 +13,7 @@ class WialonRetranslator(WialonBase):
 
         response = self.session.wialon_api.core_create_retranslator(
             **{
-                "creatorId": kwargs["owner_id"],
+                "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
                 "config": kwargs["config"],
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/route.py

@@ -4,16 +4,18 @@ from terminusgps.wialon.items.base import WialonBase
 
 class WialonRoute(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("creator_id"):
+            raise ValueError("'creator_id' is required on creation.")
         if not kwargs.get("name"):
             raise ValueError("'name' is required on creation.")
+        if not kwargs.get("flags"):
+            kwargs["flags"] = flags.DATAFLAG_UNIT_BASE
 
         response = self.session.wialon_api.core_create_route(
             **{
-                "creatorId": kwargs["owner_id"],
+                "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
-                "dataFlags": flags.DATAFLAG_UNIT_BASE,
+                "dataFlags": kwargs["flags"],
             }
         )
         return response.get("item", {}).get("id")

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/unit.py

@@ -6,8 +6,8 @@ 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("creator_id"):
+            raise ValueError("'creator_id' is required on creation.")
         if not kwargs.get("name"):
             raise ValueError("'name' is required on creation.")
         if not kwargs.get("hw_type"):
@@ -15,7 +15,7 @@ class WialonUnit(WialonBase):
 
         response = self.session.wialon_api.core_create_unit(
             **{
-                "creatorId": kwargs["owner_id"],
+                "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
                 "hwTypeId": kwargs["hw_type"],
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/unit_group.py

@@ -3,33 +3,32 @@ 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("creator_id"):
+            raise ValueError("'creator_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"],
+                "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
         return response.get("item", {}).get("id")
 
+    def _update_items(self, new_items: list[str]) -> None:
+        self.session.wialon_api.unit_group_update_units(
+            **{"itemId": self.id, "units": new_items}
+        )
+
     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
-
+    def grant_access(
+        self, item: WialonBase, access_mask: int = constants.ACCESSMASK_UNIT_BASIC
+    ) -> None:
         self.session.wialon_api.user_update_item_access(
             **{"userId": item.id, "itemId": self.id, "accessMask": access_mask}
         )
@@ -40,18 +39,17 @@ class WialonUnitGroup(WialonBase):
         )
 
     def add_item(self, item: WialonBase) -> None:
-        new_items: list[str] = self.items + [str(item.id)]
+        new_items: list[str] = self.items.copy() + [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
+        assert self.is_member(item), f"Cannot remove {item.name}, it's not in the group"
+        new_items: list[str] = self.items.copy()
         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": {

{python_terminusgps-1.2.2 → python_terminusgps-1.4.0}/terminusgps/wialon/items/user.py

@@ -7,8 +7,8 @@ from terminusgps.wialon import constants
 
 class WialonUser(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("creator_id"):
+            raise ValueError("'creator_id' is required on creation.")
         if not kwargs.get("name"):
             raise ValueError("'name' is required on creation.")
         if not kwargs.get("password"):
@@ -16,7 +16,7 @@ class WialonUser(WialonBase):
 
         response = self.session.wialon_api.core_create_user(
             **{
-                "creatorId": kwargs["owner_id"],
+                "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
                 "password": kwargs["password"],
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,

python_terminusgps-1.2.2/terminusgps/wialon/constants.py

@@ -1,39 +0,0 @@
-from terminusgps.wialon import flags
-
-ACCESSMASK_UNIT_BASIC: int = sum(
-    [
-        flags.ACCESSFLAG_VIEW_ITEM_BASIC,
-        flags.ACCESSFLAG_VIEW_ITEM_DETAILED,
-        flags.ACCESSFLAG_RENAME_ITEM,
-        flags.ACCESSFLAG_VIEW_CUSTOM_FIELDS,
-        flags.ACCESSFLAG_MANAGE_CUSTOM_FIELDS,
-        flags.ACCESSFLAG_MANAGE_ICON,
-        flags.ACCESSFLAG_QUERY_REPORTS,
-        flags.ACCESSFLAG_VIEW_ATTACHED_FILES,
-        flags.ACCESSFLAG_UNIT_EXECUTE_COMMANDS,
-        flags.ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS,
-        flags.ACCESSFLAG_UNIT_REGISTER_EVENTS,
-        flags.ACCESSFLAG_UNIT_IMPORT_MESSAGES,
-        flags.ACCESSFLAG_UNIT_EXPORT_MESSAGES,
-    ]
-)
-
-ACCESSMASK_UNIT_SUPER: int = sum(
-    [
-        flags.ACCESSFLAG_VIEW_ITEM_BASIC,
-        flags.ACCESSFLAG_VIEW_ITEM_DETAILED,
-        flags.ACCESSFLAG_RENAME_ITEM,
-        flags.ACCESSFLAG_VIEW_CUSTOM_FIELDS,
-        flags.ACCESSFLAG_MANAGE_CUSTOM_FIELDS,
-        flags.ACCESSFLAG_MANAGE_ICON,
-        flags.ACCESSFLAG_QUERY_REPORTS,
-        flags.ACCESSFLAG_VIEW_ATTACHED_FILES,
-        flags.ACCESSFLAG_UNIT_EXECUTE_COMMANDS,
-        flags.ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS,
-        flags.ACCESSFLAG_UNIT_REGISTER_EVENTS,
-        flags.ACCESSFLAG_UNIT_IMPORT_MESSAGES,
-        flags.ACCESSFLAG_UNIT_EXPORT_MESSAGES,
-    ]
-)
-
-ACCESSMASK_UNIT_FULL: int = sum([flags.ACCESSFLAG_FULL_ACCESS])