python-terminusgps 1.10.1__tar.gz → 1.10.3__tar.gz

{python_terminusgps-1.10.1 → python_terminusgps-1.10.3}/PKG-INFO

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

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.10.1"
+version = "1.10.3"
 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.10.3/terminusgps/aws/ses.py

@@ -0,0 +1,72 @@
+import boto3
+import json
+
+
+class SESEmailTemplate:
+    def __init__(self, template_name: str, region_name: str = "us-east-1") -> None:
+        self.name = template_name
+        self.region = region_name
+        self.client = boto3.Session().client(service_name="ses")
+
+    def send(
+        self,
+        from_addr: str,
+        recipients: list[str],
+        replyto_list: list[str],
+        data: dict[str, str],
+        cc_list: list[str] | None = None,
+        bcc_list: list[str] | None = None,
+    ) -> None:
+        destination = self._get_destination(recipients, cc_list, bcc_list)
+        self.client.send_templated_email(
+            **{
+                "Source": from_addr,
+                "Destination": destination,
+                "ReplyToAddresses": replyto_list,
+                "Template": self.name,
+                "TemplateData": json.dumps(data),
+            }
+        )
+
+    def create(self, subject: str, text_content: str, html_content: str) -> None:
+        self.client.create_template(
+            **{
+                "Template": {
+                    "TemplateName": self.name,
+                    "SubjectPart": subject,
+                    "TextPart": text_content,
+                    "HtmlPart": html_content,
+                }
+            }
+        )
+
+    def update(self, subject: str, text_content: str, html_content: str) -> None:
+        self.client.update_template(
+            **{
+                "Template": {
+                    "TemplateName": self.name,
+                    "SubjectPart": subject,
+                    "TextPart": text_content,
+                    "HtmlPart": html_content,
+                }
+            }
+        )
+
+    def test_render(self, data: dict[str, str]) -> str:
+        response = self.client.test_render_template(
+            **{"TemplateName": self.name, "TemplateData": json.dumps(data)}
+        )
+        return response.get("RenderedTemplate")
+
+    def _get_destination(
+        self,
+        recipients: list[str],
+        cc_list: list[str] | None,
+        bcc_list: list[str] | None,
+    ) -> dict[str, list[str]]:
+        destination: dict[str, list[str]] = {"ToAddresses": recipients}
+        if cc_list is not None:
+            destination.update({"CcAddresses": cc_list})
+        if bcc_list is not None:
+            destination.update({"BccAddresses": bcc_list})
+        return destination

{python_terminusgps-1.10.1 → python_terminusgps-1.10.3}/terminusgps/twilio/caller.py

@@ -9,14 +9,14 @@ from twilio.http.async_http_client import AsyncTwilioHttpClient
 
 class TwilioCaller:
     def __init__(self) -> None:
+        self.client_sid = settings.TWILIO_SID
+        self.client_token = settings.TWILIO_TOKEN
         self.from_number = settings.TWILIO_FROM_NUMBER
-        self.messaging_service_sid = settings.TWILIO_MESSAGING_SID
+        self.messaging_sid = settings.TWILIO_MESSAGING_SID
 
     def __enter__(self) -> "TwilioCaller":
         self.client = twilio.rest.Client(
-            settings.TWILIO_SID,
-            settings.TWILIO_TOKEN,
-            http_client=AsyncTwilioHttpClient(),
+            self.client_sid, self.client_token, http_client=AsyncTwilioHttpClient()
         )
         return self
 
@@ -37,7 +37,6 @@ class TwilioCaller:
                 )
             case _:
                 raise ValueError(f"Unsupported TwilioCaller method '{method}'.")
-
         return task
 
     async def create_call(self, to_number: str, message: str) -> None:
@@ -52,5 +51,5 @@ class TwilioCaller:
             to=to_number,
             from_=self.from_number,
             body=message,
-            messaging_service_sid=self.messaging_service_sid,
+            messaging_service_sid=self.messaging_sid,
         )

{python_terminusgps-1.10.1 → python_terminusgps-1.10.3}/terminusgps/wialon/items/base.py

@@ -5,7 +5,14 @@ from terminusgps.wialon.session import WialonSession
 
 
 class WialonBase:
-    def __init__(self, id: str | int, session: WialonSession, **kwargs) -> None:
+    def __init__(
+        self,
+        id: str | int | None = None,
+        session: WialonSession | None = None,
+        **kwargs,
+    ) -> None:
+        if session is None:
+            raise ValueError("A valid Wialon API session is required.")
         if isinstance(id, str) and not id.isdigit():
             raise ValueError(f"'id' must be a digit. Got '{id}'.")
 
@@ -59,7 +66,7 @@ class WialonBase:
         return True if self.id in response.keys() else False
 
     @abstractmethod
-    def create(self) -> int | None:
+    def create(self, *args, **kwargs) -> int | None:
         """Creates a Wialon object and returns its id."""
         raise NotImplementedError("Subclasses must implement this method.")
 

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

@@ -0,0 +1,33 @@
+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

{python_terminusgps-1.10.1 → python_terminusgps-1.10.3}/terminusgps/wialon/items/unit.py

@@ -144,9 +144,9 @@ class WialonUnit(WialonBase):
 
     def get_phone_numbers(self) -> list[str]:
         """
-        Retrieves all phone numbers assigned to this Wialon unit.
+        Retrieves all phone numbers assigned to the unit.
 
-        This includes any attached drivers, custom fields, and normally assigned unit 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.
@@ -154,28 +154,48 @@ class WialonUnit(WialonBase):
 
         """
 
-        phone_numbers = []
-        phones_0 = self._get_driver_phone_numbers()
-        phones_1 = self._get_cfield_phone_numbers()
+        phone_numbers: list[str] = []
+        phones_0: list[str] | None = self._get_driver_phone_numbers()
+        phones_1: list[str] | None = self._get_cfield_phone_numbers()
+        phones_2: list[str] | None = self._get_afield_phone_numbers()
 
-        if phones_0:
+        if phones_0 is not None:
             phone_numbers.extend(phones_0)
-        if phones_1:
+        if phones_1 is not None:
             phone_numbers.extend(phones_1)
+        if phones_2 is not None:
+            phone_numbers.extend(phones_2)
         return list(dict.fromkeys(phone_numbers))  # Removes duplicate phone numbers
 
-    def _get_cfield_phone_numbers(self) -> list[str] | None:
+    def _get_afield_phone_numbers(self, key: str = "to_number") -> list[str] | None:
         """
-        Retrives any phone numbers saved in the unit's custom 'to_number' field.
+        Retrives any phone numbers saved in an admin field by key.
 
+        :param key: An admin field key. Default is ``"to_number"``.
+        :type key: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: A list of phone numbers, if the unit has admin phone number fields.
+        :rtype: :py:obj:`list` | :py:obj:`None`
+
+        """
+        for field_name, field_val in self.afields.items():
+            if field_name == key:
+                return self.clean_phone_numbers([field_val])
+
+    def _get_cfield_phone_numbers(self, key: str = "to_number") -> list[str] | None:
+        """
+        Retrives any phone numbers saved in a custom field by key.
+
+        :param key: A custom field key. Default is ``"to_number"``.
+        :type key: :py:obj:`str`
         :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])
+        for field_name, field_val in self.cfields.items():
+            if field_name == key:
+                return self.clean_phone_numbers([field_val])
 
     def _get_driver_phone_numbers(self) -> list[str] | None:
         """

{python_terminusgps-1.10.1 → python_terminusgps-1.10.3}/uv.lock

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