python-terminusgps 33.3.0__py3-none-any.whl → 33.5.0__py3-none-any.whl

{python_terminusgps-33.3.0.dist-info → python_terminusgps-33.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 33.3.0
+Version: 33.5.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.12
+Requires-Dist: aiobotocore>=2.21.1
 Requires-Dist: argparse>=1.4.0
 Requires-Dist: authorizenet>=1.1.5
 Requires-Dist: boto3>=1.34.144

{python_terminusgps-33.3.0.dist-info → python_terminusgps-33.5.0.dist-info}/RECORD

@@ -15,13 +15,14 @@ terminusgps/authorizenet/tests/test_auth.py,sha256=sdByYrcv8RKjcJckOHbyHH1z_M4qr
 terminusgps/authorizenet/tests/test_profiles.py,sha256=tvLBY0iSAC33RlWiBP_NSnPskUQBjfrf0YHMpR-m22k,7566
 terminusgps/authorizenet/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/aws/connect.py,sha256=TWf2bVz6LqSNQfVD7FKRn3K71VuLOwBj05Gs-9BsROg,693
+terminusgps/aws/notifier.py,sha256=0w7tuMJ2tslMXKrLYcHi8kkxPsbvgfyFajkpD4UwlLc,1361
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/utils.py,sha256=68GWcllu4h41qzFiKdUkWOAA4LDsTPqRY446VRMxYsY,116
 terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/django/settings.py,sha256=yJIcBE0xjY60AXF_gonY5hS3ofseqPW2k9uSoELgoho,639
 terminusgps/django/utils.py,sha256=SYDQyHA5tTuVwdpZGsCtf0LpTTD0ilRKoxa8StfSTpQ,156
+terminusgps/django/validators.py,sha256=dnENfniiHRJjZhQQ76dIcjfwuq-mkjQahKegZYgmryc,3342
 terminusgps/django/forms/__init__.py,sha256=hh8Z9AC_u2m2bu3h6sdmPyndfQneCEVovENPHmoTDC0,21
 terminusgps/django/forms/fields.py,sha256=BfuPzOZyGvWsEzONW2h4i01fhoL0IS0-gDdBKW4jHgI,2225
 terminusgps/django/forms/forms.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -31,10 +32,6 @@ terminusgps/django/tests/test_mixins.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 terminusgps/django/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=l53-IxXn0wXc_oDcDxfhlrKPz-F4_KfMPV1dAzZjNo4,5060
-terminusgps/twilio/validators.py,sha256=HWCpzgDXTedofty4Zhrm2OenbgtkzrDUC08B1l15gqc,1112
-terminusgps/twilio/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/twilio/tests/test_caller.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/twilio/tests/test_validators.py,sha256=CETv7Mcr19UMMfh1UaWSV26FiOeh2WCK_VutfKXnf7g,1428
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=Ju2XL2A4DPFD-w8NjYqEfnnqregl1luPT0XGhGSUnO8,6316
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
@@ -53,7 +50,7 @@ terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/wialon/tests/test_items.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_session.py,sha256=9mBlYchMo9NeqRIZsmxYzrM1zBHorqu4ooxqSNppLpI,1336
 terminusgps/wialon/tests/test_utils.py,sha256=SK4PxJQGECFnzx_EQeRAQfsQ5_3FLaVcis2W9u_ibuI,1730
-python_terminusgps-33.3.0.dist-info/METADATA,sha256=CMGz4nsoWA7NjUaj9BPHN8WVudEFlyYj_UwqUH0T8R8,1581
-python_terminusgps-33.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-33.3.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-33.3.0.dist-info/RECORD,,
+python_terminusgps-33.5.0.dist-info/METADATA,sha256=Jd4lLTQC74E24wIMEG6WDYXiYg0e4uY8i-LTxwWkEvs,1616
+python_terminusgps-33.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-33.5.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-33.5.0.dist-info/RECORD,,

terminusgps/aws/notifier.py

@@ -0,0 +1,49 @@
+import asyncio
+import uuid
+from contextlib import AsyncExitStack
+
+from aiobotocore.session import AioSession
+
+from terminusgps.django.validators import validate_e164_phone_number
+
+
+class AWSNotifier:
+    def __init__(self, region: str = "us-east-1") -> None:
+        self._client = None
+        self._region = region
+        self._exit_stack = AsyncExitStack()
+
+    async def __aenter__(self):
+        session = AioSession()
+        self._client = await self._exit_stack.enter_async_context(
+            session.create_client("sns")
+        )
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self._exit_stack.__aexit__(exc_type, exc_val, exc_tb)
+
+    async def send_sms(
+        self, phone_number: str, message: str, message_id: str, group_id: str
+    ) -> dict:
+        validate_e164_phone_number(phone_number)
+        await self._client.publish(
+            **{
+                "PhoneNumber": phone_number,
+                "Message": message,
+                "MessageDeduplicationId": message_id,
+                "MessageGroupId": group_id,
+            }
+        )
+
+
+async def main() -> None:
+    notifier = AWSNotifier()
+    message_id = str(uuid.uuid4())
+    await notifier.send_sms(
+        "+17133049421", "This is a test message", message_id, "message-group"
+    )
+    return
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

terminusgps/django/validators.py

@@ -0,0 +1,93 @@
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+VALID_COUNTRY_CODES = ("+1", "+52")
+
+
+def validate_e164_phone_number(value: str) -> None:
+    """Raises :py:exec:`~django.core.exceptions.ValidationError` if the value is not a valid `E.164 <https://en.wikipedia.org/wiki/E.164>`_ formatted phone number."""
+    if not value.startswith("+"):
+        raise ValidationError(
+            _("E.164 phone number must begin with a '+', got '%(char)s'."),
+            code="invalid",
+            params={"char": value[0]},
+        )
+    if " " in value:
+        raise ValidationError(
+            _("E.164 phone number cannot contain spaces, got '%(value)s'."),
+            code="invalid",
+            params={"value": value},
+        )
+    if "-" in value:
+        raise ValidationError(
+            _("E.164 phone number cannot contain hyphens, got '%(value)s'."),
+            code="invalid",
+            params={"value": value},
+        )
+    if len(value) < 12:
+        raise ValidationError(
+            _(
+                "E.164 phone number cannot be less than 12 characters in length, got %(len)s."
+            ),
+            code="invalid",
+            params={"len": len(value)},
+        )
+    if len(value) > 15:
+        raise ValidationError(
+            _(
+                "E.164 phone number cannot be greater than 15 characters in length, got %(len)s."
+            ),
+            code="invalid",
+            params={"len": len(value)},
+        )
+
+    country_code: str = value[:-10]
+    area_code: str = value[-10:-7]
+    subscriber_number: str = value[-7:]
+
+    if len(country_code) < 2 or len(country_code) > 5:
+        raise ValidationError(
+            _(
+                "E.164 phone number country code must be between 2 and 5 characters in length, got %(len)s."
+            ),
+            code="invalid",
+            params={"len": len(country_code)},
+        )
+    if country_code not in VALID_COUNTRY_CODES:
+        raise ValidationError(
+            _(
+                "E.164 phone number cannot contain an invalid country code, got '%(country_code)s'."
+            ),
+            code="invalid",
+            params={"country_code": country_code},
+        )
+    if not len(area_code) == 3:
+        raise ValidationError(
+            _(
+                "E.164 phone number must contain a 3-digit area code, got '%(area_code)s'."
+            ),
+            code="invalid",
+            params={"area_code": area_code},
+        )
+    if not area_code.isdigit():
+        raise ValidationError(
+            _("E.164 phone number must have a valid area code, got '%(area_code)s'"),
+            code="invalid",
+            params={"area_code": area_code},
+        )
+    if not len(subscriber_number) == 7:
+        raise ValidationError(
+            _(
+                "E.164 phone number must contain a 7-digit subscriber number, got '%(subscriber_number)s'."
+            ),
+            code="invalid",
+            params={"subscriber_number": subscriber_number},
+        )
+    if not subscriber_number.isdigit():
+        raise ValidationError(
+            _(
+                "E.164 phone number must have a valid subscriber number, got '%(subscriber_number)s'"
+            ),
+            code="invalid",
+            params={"subscriber_number": subscriber_number},
+        )

terminusgps/aws/connect.py

@@ -1,21 +0,0 @@
-import datetime
-
-import jwt
-from django.conf import settings
-
-
-def get_aws_connect_jwt(widget_id: str, expires_in: int = 500) -> str:
-    if expires_in > 600:
-        raise ValueError(f"'expires_in' must be less than 600, got '{expires_in}'.")
-
-    payload = {
-        "sub": widget_id,
-        "iat": datetime.datetime.utcnow(),
-        "exp": datetime.datetime.utcnow() - datetime.timedelta(seconds=expires_in),
-        "segmentAttributes": {"connect:Subtype": {"ValueString": "connect:Guide"}},
-    }
-    header = {"typ": "JWT", "alg": "HS256"}
-    encoded_token = jwt.encode(
-        payload, settings.CONNECT_SECRET, algorithm=header["alg"], headers=header
-    )
-    return encoded_token

terminusgps/twilio/tests/test_validators.py

@@ -1,40 +0,0 @@
-from unittest import TestCase
-
-import django
-from django.core.exceptions import ValidationError
-
-from terminusgps.twilio import validators
-
-django.setup()
-
-
-class PhoneNumberValidatorTestCase(TestCase):
-    def setUp(self) -> None:
-        self.validator = validators.validate_phone_number
-
-    def test_phone_without_plus(self) -> None:
-        """Fails if a phone number without a '+' leading character passes validation."""
-        with self.assertRaises(ValidationError) as context:
-            self.validator("15555555555")
-        self.assertTrue(
-            "Phone number must begin with a '+', got '15555555555'."
-            in str(context.exception)
-        )
-
-    def test_phone_min_length(self) -> None:
-        """Fails if a phone number of 8 characters in length passes validation."""
-        with self.assertRaises(ValidationError) as context:
-            self.validator("+1555555")
-        self.assertTrue(
-            "Phone number cannot be less than 12 characters, got 8."
-            in str(context.exception)
-        )
-
-    def test_phone_max_length(self) -> None:
-        """Fails if a phone number of 20 characters in length passes validation."""
-        with self.assertRaises(ValidationError) as context:
-            self.validator("+1555555555555555555")
-        self.assertTrue(
-            "Phone number cannot be greater than 19 characters, got 20."
-            in str(context.exception)
-        )

terminusgps/twilio/validators.py

@@ -1,31 +0,0 @@
-from django.core.exceptions import ValidationError
-from django.utils.translation import gettext_lazy as _
-
-
-def validate_phone_number(value: str) -> None:
-    min_length, max_length = 12, 19
-
-    if not value.startswith("+"):
-        raise ValidationError(
-            _("Phone number must begin with a '+', got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-    if not value[1:].isdigit():
-        raise ValidationError(
-            _("Phone number must be '+' followed by a digit, got '%(value)s'"),
-            code="invalid",
-            params={"value": value},
-        )
-    if len(value) < min_length:
-        raise ValidationError(
-            _("Phone number cannot be less than %(min)s characters, got %(len)s."),
-            code="invalid",
-            params={"min": min_length, "len": len(value)},
-        )
-    if len(value) > max_length:
-        raise ValidationError(
-            _("Phone number cannot be greater than %(max)s characters, got %(len)s."),
-            code="invalid",
-            params={"max": max_length, "len": len(value)},
-        )