python-terminusgps 24.5.0__py3-none-any.whl → 25.0.0__py3-none-any.whl

{python_terminusgps-24.5.0.dist-info → python_terminusgps-25.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 24.5.0
+Version: 25.0.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

{python_terminusgps-24.5.0.dist-info → python_terminusgps-25.0.0.dist-info}/RECORD

@@ -15,8 +15,7 @@ terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/ses.py,sha256=sDca2GjMaZvUt3kUPtGCpcqHiOkij9lMV1ogZofgYUU,2372
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
-terminusgps/twilio/caller.py,sha256=HixmE5vquzsLpCwPvGOpiuYK2laqFA4x-qyJDblSQ40,2346
-terminusgps/twilio/logger.py,sha256=qlbOUvqBt7dNUOQGgn_N8_nwiqo0ewbqP9VN4N7dCrM,968
+terminusgps/twilio/caller.py,sha256=TiQ4f0TDDC35he1M1iSsBM2vutdGriwtV4pc17T--6I,3552
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=n1ux68oWYWnzeZdN811Iw_Lk78KBM0YMJMoonn67uZY,1723
 terminusgps/wialon/flags.py,sha256=_NIL3mrEGhvI5YISVjimjYtUatdgOqhZPJX368MtKSU,13959
@@ -31,7 +30,7 @@ terminusgps/wialon/items/route.py,sha256=PTJx1gmT_PGz7nlSSUS2VzjYD-aAuvkEOIdIFne
 terminusgps/wialon/items/unit.py,sha256=K0kmzFEInR3dAQVtMUA6M7KNy7HlD5IKl7f7YElr2sQ,9116
 terminusgps/wialon/items/unit_group.py,sha256=Stp-WfCGbOqcnxV6FU1AKtV7KIxIwCHa0NwhNJfgRoM,5032
 terminusgps/wialon/items/user.py,sha256=INwAibQVmjNNelepQXMfDevgJqMvIjHHgEjAMLRvhB0,7082
-python_terminusgps-24.5.0.dist-info/METADATA,sha256=uvI90bQIizyzMEx8hv5N22TwF20LkN7UOdAtSXOZSZk,946
-python_terminusgps-24.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-24.5.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-24.5.0.dist-info/RECORD,,
+python_terminusgps-25.0.0.dist-info/METADATA,sha256=RRNrckAzXzk1PVqHehcdAQ9rKWU1B7bFxZmyrkVYslE,946
+python_terminusgps-25.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-25.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-25.0.0.dist-info/RECORD,,

terminusgps/twilio/caller.py

@@ -1,25 +1,31 @@
 import asyncio
-import logging
 from typing import Any
 
 import twilio.rest
 from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
 from twilio.http.async_http_client import AsyncTwilioHttpClient
 
-from terminusgps.twilio.logger import TwilioLogger
+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.")
+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.")
 
 
 class TwilioCaller:
-    def __init__(self, log_level: int = logging.CRITICAL) -> None:
+    def __init__(self) -> None:
+        """Sets Twilio messaging session variables."""
         self.client_sid = settings.TWILIO_SID
         self.client_token = settings.TWILIO_TOKEN
         self.from_number = settings.TWILIO_FROM_NUMBER
         self.messaging_sid = settings.TWILIO_MESSAGING_SID
-        self.logger = TwilioLogger(
-            logging.getLogger(self.__class__.__name__), level=log_level
-        ).get_logger()
 
     def __enter__(self) -> "TwilioCaller":
+        """Creates an asyncronous Twilio client."""
         self.client = twilio.rest.Client(
             self.client_sid, self.client_token, http_client=AsyncTwilioHttpClient()
         )
@@ -31,10 +37,21 @@ class TwilioCaller:
     async def create_notification(
         self, to_number: str, message: str, method: str = "sms"
     ) -> asyncio.Task[Any]:
-        self.logger.debug(
-            f"Creating '{method}' notification targeting '{to_number}'..."
-        )
+        """
+        Returns an awaitable notification task.
+
+        Available methods are ``"sms"``, ``"call"`` and ``"phone"``.
 
+        :param to_number: A phone number to notify.
+        :type to_number: :py:obj:`str`
+        :param message: A notification message.
+        :type message: :py:obj:`str`
+        :param method: A notification method. Default is ``"sms"``.
+        :type method: :py:obj:`str`
+        :returns: An awaitable task.
+        :rtype: :py:obj:`~asyncio.Task`
+
+        """
         match method:
             case "sms":
                 return asyncio.create_task(
@@ -44,12 +61,21 @@ class TwilioCaller:
                 return asyncio.create_task(
                     self.create_call(to_number=to_number, message=message)
                 )
-            case "log":
-                return asyncio.create_task(self.create_log(message=message))
             case _:
                 raise ValueError(f"Unsupported TwilioCaller method '{method}'.")
 
     async def create_call(self, to_number: str, message: str) -> None:
+        """
+        Calls ``to_number`` and reads ``message`` aloud.
+
+        :param to_number: A phone number.
+        :type to_number: :py:obj:`str`
+        :param message: A message to be read aloud.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
         await self.client.calls.create_async(
             to=to_number,
             from_=self.from_number,
@@ -57,12 +83,20 @@ class TwilioCaller:
         )
 
     async def create_sms(self, to_number: str, message: str) -> None:
+        """
+        Texts ``message`` to ``to_number``.
+
+        :param to_number: A phone number.
+        :type to_number: :py:obj:`str`
+        :param message: A message to be texted.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
         await self.client.messages.create_async(
             to=to_number,
             from_=self.from_number,
             body=message,
             messaging_service_sid=self.messaging_sid,
         )
-
-    async def create_log(self, message: str) -> None:
-        self.logger.info(message)

terminusgps/twilio/logger.py

@@ -1,29 +0,0 @@
-import logging
-
-
-class TwilioLogger:
-    def __init__(
-        self,
-        logger: logging.Logger,
-        level: int = logging.DEBUG,
-        format: str = "%(name)s - %(levelname)s - %(asctime)s - %(message)s",
-        use_stream_handler: bool = True,
-        use_file_handler: bool = False,
-        filename: str = "twilio_debug.log",
-    ) -> None:
-        self.logger = logger
-        self.logger.setLevel(level)
-        formatter = logging.Formatter(format)
-
-        if use_stream_handler and not self.logger.handlers:
-            stream_handler = logging.StreamHandler()
-            stream_handler.setFormatter(formatter)
-            self.logger.addHandler(stream_handler)
-
-        if use_file_handler and not self.logger.handlers:
-            file_handler = logging.FileHandler(filename)
-            file_handler.setFormatter(formatter)
-            self.logger.addHandler(file_handler)
-
-    def get_logger(self) -> logging.Logger:
-        return self.logger