python-terminusgps 33.3.1__py3-none-any.whl → 34.0.0__py3-none-any.whl

{python_terminusgps-33.3.1.dist-info → python_terminusgps-34.0.0.dist-info}/METADATA

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

{python_terminusgps-33.3.1.dist-info → python_terminusgps-34.0.0.dist-info}/RECORD

@@ -1,23 +1,27 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/auth.py,sha256=umNpOXObDrIt2K40padWBedQl7tVAmEg2alBWhGk-qQ,1238
+terminusgps/authorizenet/auth.py,sha256=g2tJPxP9V1nXnUcKzhHSRSs6ruSIHej5_hcf8P7bod8,1262
 terminusgps/authorizenet/constants.py,sha256=xmulPmiBLhFfZoc7Il3l-DZA9Nq5HSaJmJKU-v-5X-Y,420
 terminusgps/authorizenet/controllers.py,sha256=9t62qdGpmAkP4tNyPefd7vBRutXvMWsxql6z_pg52Bg,2146
 terminusgps/authorizenet/utils.py,sha256=FrKqXWrplcgiET1rDTmUaqmN_ze7j93jWgfFeJR8rlg,7073
 terminusgps/authorizenet/profiles/__init__.py,sha256=IG4XCEEYtHKqXOatlZlob6J3ukAgF7cFR-RXxOSMS1c,161
 terminusgps/authorizenet/profiles/addresses.py,sha256=xDlnFlIjuR7NVXwfj5aJT9E_GolnYFuYASkfenvWfm8,6292
-terminusgps/authorizenet/profiles/base.py,sha256=lPc8Pugp5EcXtZmeBpeqicij7l0ROGvMYTV8J0fLLmQ,3768
+terminusgps/authorizenet/profiles/base.py,sha256=Pu1NGrvC5Ox2W1oZuVcPqUw3aUoSK191Evexw1U6_3k,3940
 terminusgps/authorizenet/profiles/customers.py,sha256=ArXOHPgyBu01tgBPHHYyezb4PIeXh70IWjYCy-lHpWg,11734
-terminusgps/authorizenet/profiles/payments.py,sha256=MmjvE4ZSfgyGPRUzeREB_dX_n6QfpC3zGIlqFnIC8BQ,10956
+terminusgps/authorizenet/profiles/payments.py,sha256=nhudGuJ6RzmK0MrhDVuYL2BxvyzKNpliBIfIpFU5Y-4,11038
 terminusgps/authorizenet/profiles/subscriptions.py,sha256=m_jb9GqeD1tLmeqSnaGwJrzPcQOulEkF8K1wCaqKR24,7924
 terminusgps/authorizenet/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/tests/test_auth.py,sha256=sdByYrcv8RKjcJckOHbyHH1z_M4qrATFI3qj_XDQXbk,1624
 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/notifier.py,sha256=0w7tuMJ2tslMXKrLYcHi8kkxPsbvgfyFajkpD4UwlLc,1361
+terminusgps/aws/notifications.py,sha256=N5p9EqN4wqBRJAMEFOjyseVatpwsxlB0QrHyqFDK5SI,5698
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/utils.py,sha256=68GWcllu4h41qzFiKdUkWOAA4LDsTPqRY446VRMxYsY,116
+terminusgps/aws/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/aws/tests/test_notifications.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/aws/tests/test_secrets.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/aws/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/django/settings.py,sha256=yJIcBE0xjY60AXF_gonY5hS3ofseqPW2k9uSoELgoho,639
@@ -32,10 +36,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
@@ -54,7 +54,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.1.dist-info/METADATA,sha256=BoV05Kh_54bDSH1P82Pe7MhHm3j8OTqBMqwZiEMrC0w,1616
-python_terminusgps-33.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-33.3.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-33.3.1.dist-info/RECORD,,
+python_terminusgps-34.0.0.dist-info/METADATA,sha256=OLumu5xwbGDw-7yR3niZdmytYWiKwS80xQMazYTcy5g,1616
+python_terminusgps-34.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-34.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-34.0.0.dist-info/RECORD,,

terminusgps/authorizenet/auth.py

@@ -10,7 +10,7 @@ if not settings.configured:
 
 def get_merchant_auth() -> merchantAuthenticationType:
     """
-    Returns the merchant authentication information for Authorizenet API requests.
+    Returns the current merchant authentication information for Authorizenet API requests.
 
     :returns: A merchant authentication object.
     :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
@@ -24,7 +24,7 @@ def get_merchant_auth() -> merchantAuthenticationType:
 
 def get_environment() -> str:
     """
-    Returns the environment for Authorizenet API requests.
+    Returns the current environment for Authorizenet API requests.
 
     :returns: An Authorizenet API environment string.
     :rtype: :py:obj:`str`
@@ -35,7 +35,7 @@ def get_environment() -> str:
 
 def get_validation_mode() -> str:
     """
-    Returns the validation mode for Authorizenet API requests.
+    Returns the current validation mode for Authorizenet API requests.
 
     :returns: An Authorizenet API validation string.
     :rtype: :py:obj:`str`

terminusgps/authorizenet/profiles/base.py

@@ -62,6 +62,17 @@ class AuthorizenetProfileBase(AuthorizenetControllerExecutor):
         """
         return get_merchant_auth()
 
+    @property
+    def validationMode(self) -> str:
+        """
+        The current Authorizenet API validation mode.
+
+        :returns: An Authorizenet API validation mode string.
+        :rtype: :py:obj:`str`
+
+        """
+        return get_validation_mode()
+
 
 class AuthorizenetSubProfileBase(AuthorizenetProfileBase):
     """Base class for Authorizenet 'sub-profiles', profiles that have an associated customer profile."""
@@ -83,10 +94,6 @@ class AuthorizenetSubProfileBase(AuthorizenetProfileBase):
         self.customerProfileId = customer_profile_id
         self.default = default
 
-    @property
-    def validationMode(self) -> str:
-        return get_validation_mode()
-
     @property
     def customerProfileId(self) -> str:
         """

terminusgps/authorizenet/profiles/payments.py

@@ -8,7 +8,12 @@ class PaymentProfile(AuthorizenetSubProfileBase):
 
     @property
     def last_4(self) -> str | None:
-        """Last 4 digits of the payment profile credit card."""
+        """
+        Last 4 digits of the payment profile credit card.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+
+        """
         if self.id:
             response = self._authorizenet_get_payment_profile()
             return str(response.paymentProfile.payment.creditCard.cardNumber)[-4:]
@@ -31,7 +36,7 @@ class PaymentProfile(AuthorizenetSubProfileBase):
         """
         return int(
             self._authorizenet_create_payment_profile(
-                address, payment
+                address=address, payment=payment
             ).customerPaymentProfileId
         )
 

terminusgps/aws/notifications.py

@@ -0,0 +1,193 @@
+import asyncio
+import uuid
+from collections.abc import Sequence
+from contextlib import AsyncExitStack
+
+from aiobotocore.session import AioSession
+
+from terminusgps.django.validators import validate_e164_phone_number
+
+
+class AsyncNotificationManager:
+    def __init__(
+        self, group_id: str | None = None, region_name: str = "us-east-1"
+    ) -> None:
+        """
+        Sets :py:attr:`group_id` and :py:attr:`region_name` if provided.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self._exit_stack = AsyncExitStack()
+        self._sns_client = None
+        self._region_name = region_name
+        self.group_id = group_id
+
+    async def __aenter__(self) -> "AsyncNotificationManager":
+        """
+        Creates an asyncronous session and client.
+
+        :returns: The notification manager.
+        :rtype: :py:obj:`~terminusgps.aws.notifications.AsyncNotificationManager`
+
+        """
+        session = AioSession()
+        self._sns_client = await self._exit_stack.enter_async_context(
+            session.create_client("sns", region_name=self.region_name)
+        )
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
+        """
+        Destroys the asyncronous session.
+
+        :param exc_type: Exception type.
+        :param exc_val: Exception value.
+        :param exc_tb: Exception traceback.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        await self._exit_stack.__aexit__(exc_type, exc_val, exc_tb)
+
+    @property
+    def region_name(self) -> str:
+        """
+        An AWS region name.
+
+        :type: :py:obj:`str`
+
+        """
+        return self._region_name
+
+    @property
+    def group_id(self) -> str:
+        """
+        A message group id.
+
+        :type: :py:obj:`str`
+
+        """
+        return str(self._group_id)
+
+    @group_id.setter
+    def group_id(self, other: str | None) -> None:
+        """
+        Sets :py:attr:`group_id` to ``other``.
+
+        :param other: A message group id.
+        :type other: :py:obj:`str` | :py:obj:`None`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        if not other:
+            other = str(uuid.uuid4())
+        self._group_id = other
+
+    async def send_push_batch(self, target_arns: Sequence[str], message: str) -> None:
+        """
+        Sends a push notification to each AWS resource by ARN in ``target_arns``.
+
+        :param target_arns: A sequence of AWS resource ARNs.
+        :type target_arns: :py:obj:`~collections.abc.Sequence`
+        :param message: A message body.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        await asyncio.gather(
+            *[
+                self.send_push(
+                    target_arn=arn, message=message, message_id=str(uuid.uuid4())
+                )
+                for arn in target_arns
+            ]
+        )
+
+    async def send_sms_batch(self, to_numbers: Sequence[str], message: str) -> None:
+        """
+        Sends an sms message to each phone number in ``to_numbers``.
+
+        :param to_numbers: A sequence of phone numbers.
+        :type to_numbers: :py:obj:`~collections.abc.Sequence`
+        :param message: A message body.
+        :type message: :py:obj:`str`
+        :raises ValidationError: If a ``to_number`` wasn't a valid E.164 formatted phone number.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        for to_number in to_numbers:
+            validate_e164_phone_number(to_number)
+
+        await asyncio.gather(
+            *[
+                self.send_sms(
+                    to_number=num, message=message, message_id=str(uuid.uuid4())
+                )
+                for num in to_numbers
+            ]
+        )
+
+    async def send_sms(self, to_number: str, message: str, message_id: str) -> None:
+        """
+        Sends an sms to ``to_number``.
+
+        :param to_number: A destination phone number.
+        :type to_number: :py:obj:`str`
+        :param message: A message body.
+        :type message: :py:obj:`str`
+        :param message_id: A message deduplication id.
+        :type message_id: :py:obj:`str`
+        :raises ValidationError: If ``to_number`` wasn't a valid E.164 formatted phone number.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        validate_e164_phone_number(to_number)
+
+        await self._sns_client.publish(
+            **{
+                "PhoneNumber": to_number,
+                "Message": message,
+                "MessageDeduplicationId": message_id,
+                "MessageGroupId": self.group_id,
+            }
+        )
+
+    async def send_push(self, target_arn: str, message: str, message_id: str) -> None:
+        """
+        Sends a push notification to ``target_arn``.
+
+        :param target_arn: An AWS resource ARN.
+        :type target_arn: :py:obj:`str`
+        :param message: A message body.
+        :type message: :py:obj:`str`
+        :param message_id: A message deduplication id.
+        :type message_id: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        await self._sns_client.publish(
+            **{
+                "TargetArn": target_arn,
+                "Message": message,
+                "MessageDeduplicationId": message_id,
+                "MessageGroupId": self.group_id,
+            }
+        )
+
+
+async def main() -> None:
+    async with AsyncNotificationManager(str(uuid.uuid4())) as manager:
+        await manager.send_sms_batch(
+            ["+17133049421", "+18324667085", "+18322835634"], "This is a test message."
+        )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

terminusgps/aws/notifier.py

@@ -1,49 +0,0 @@
-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/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)},
-        )