python-terminusgps 1.9.8__tar.gz → 1.10.0__tar.gz

{python_terminusgps-1.9.8 → python_terminusgps-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.9.8
+Version: 1.10.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
@@ -17,3 +17,4 @@ Requires-Dist: authorizenet>=1.1.5
 Requires-Dist: boto3>=1.34.144
 Requires-Dist: django>=5.1.5
 Requires-Dist: python-wialon>=1.2.4
+Requires-Dist: twilio>=9.4.5

{python_terminusgps-1.9.8 → python_terminusgps-1.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.9.8"
+version = "1.10.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" } ]
@@ -18,6 +18,7 @@ dependencies = [
     "boto3>=1.34.144",
     "django>=5.1.5",
     "python-wialon>=1.2.4",
+    "twilio>=9.4.5",
 ]
 
 [project.urls]

python_terminusgps-1.10.0/terminusgps/settings.py

@@ -0,0 +1,12 @@
+import os
+
+DEBUG = True
+MERCHANT_AUTH_LOGIN_ID = os.getenv("MERCHANT_AUTH_LOGIN_ID")
+MERCHANT_AUTH_TRANSACTION_KEY = os.getenv("MERCHANT_AUTH_TRANSACTION_KEY")
+SECRET_KEY = "xem*6no%8d9%^qzt2f3x3ar-uq4_+7h9myc$t0!+4%bj5us6f)"
+TWILIO_FROM_NUMBER = os.getenv("TWILIO_FROM_NUMBER")
+TWILIO_MESSAGING_SID = os.getenv("TWILIO_MESSAGING_SID")
+TWILIO_SID = os.getenv("TWILIO_SID")
+TWILIO_TOKEN = os.getenv("TWILIO_TOKEN")
+WIALON_ADMIN_ID = os.getenv("WIALON_ADMIN_ID")
+WIALON_TOKEN = os.getenv("WIALON_TOKEN")

python_terminusgps-1.10.0/terminusgps/twilio/caller.py

@@ -0,0 +1,65 @@
+from typing import Any
+
+import asyncio
+import twilio.rest
+
+from django.conf import settings, ImproperlyConfigured
+from twilio.http.async_http_client import AsyncTwilioHttpClient
+
+if not hasattr(settings, "TWILIO_FROM_NUMBER"):
+    raise ImproperlyConfigured("'TWILIO_FROM_NUMBER' setting is required.")
+if not hasattr(settings, "TWILIO_MESSAGING_SID"):
+    raise ImproperlyConfigured("'TWILIO_MESSAGING_SID' setting is required.")
+if not hasattr(settings, "TWILIO_SID"):
+    raise ImproperlyConfigured("'TWILIO_SID' setting is required.")
+if not hasattr(settings, "TWILIO_TOKEN"):
+    raise ImproperlyConfigured("'TWILIO_TOKEN' setting is required.")
+
+
+class TwilioCaller:
+    def __init__(self) -> None:
+        self.from_number = settings.TWILIO_FROM_NUMBER
+        self.messaging_service_sid = settings.TWILIO_MESSAGING_SID
+
+    def __enter__(self) -> "TwilioCaller":
+        self.client = twilio.rest.Client(
+            settings.TWILIO_SID,
+            settings.TWILIO_TOKEN,
+            http_client=AsyncTwilioHttpClient(),
+        )
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_tb) -> None:
+        return None
+
+    async def create_notification(
+        self, to_number: str, message: str, method: str = "sms"
+    ) -> asyncio.Task[Any]:
+        match method:
+            case "sms":
+                task = asyncio.create_task(
+                    self.create_sms(to_number=to_number, message=message)
+                )
+            case "call" | "phone":
+                task = asyncio.create_task(
+                    self.create_call(to_number=to_number, message=message)
+                )
+            case _:
+                raise ValueError(f"Unsupported TwilioCaller method '{method}'.")
+
+        return task
+
+    async def create_call(self, to_number: str, message: str) -> None:
+        await self.client.calls.create_async(
+            to=to_number,
+            from_=self.from_number,
+            twiml=f"<Response><Say>{message}</Say></Response>",
+        )
+
+    async def create_sms(self, to_number: str, message: str) -> None:
+        await self.client.messages.create_async(
+            to=to_number,
+            from_=self.from_number,
+            body=message,
+            messaging_service_sid=self.messaging_service_sid,
+        )

{python_terminusgps-1.9.8 → python_terminusgps-1.10.0}/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:

{python_terminusgps-1.9.8 → python_terminusgps-1.10.0}/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)

{python_terminusgps-1.9.8 → python_terminusgps-1.10.0}/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)

{python_terminusgps-1.9.8 → python_terminusgps-1.10.0}/terminusgps/wialon/utils.py

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