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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 33.2.0
+Version: 33.3.1
 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.2.0.dist-info → python_terminusgps-33.3.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/authorizenet/auth.py,sha256=umNpOXObDrIt2K40padWBedQl7tVAmEg2alBWhGk-qQ,1238
 terminusgps/authorizenet/constants.py,sha256=xmulPmiBLhFfZoc7Il3l-DZA9Nq5HSaJmJKU-v-5X-Y,420
 terminusgps/authorizenet/controllers.py,sha256=9t62qdGpmAkP4tNyPefd7vBRutXvMWsxql6z_pg52Bg,2146
-terminusgps/authorizenet/utils.py,sha256=zmBVqRamCmxEO6tZWRaGPn5uvL_Lr0yO36Lgc954m8k,2930
+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
@@ -12,16 +12,17 @@ terminusgps/authorizenet/profiles/payments.py,sha256=MmjvE4ZSfgyGPRUzeREB_dX_n6Q
 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=24lo71F5MWOUNdB2MwTAstPUkyfZ58aOiIxiRwyWcd0,7476
+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
@@ -53,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.2.0.dist-info/METADATA,sha256=zRen2hb6Tb8T0FM81XTAcRPElynhCVAPPt4hoN4hVJY,1581
-python_terminusgps-33.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-33.2.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-33.2.0.dist-info/RECORD,,
+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,,

terminusgps/authorizenet/tests/test_profiles.py

@@ -149,7 +149,9 @@ class PaymentProfileTestCase(TestCase):
     def test_payment_profile_create(self) -> None:
         """Fails if a payment profile is not properly created in Authorizenet."""
         test_payment_profile = PaymentProfile(
-            id=None, customer_profile_id=self.test_customer_profile.id, default=True
+            id=None,
+            customer_profile_id=str(self.test_customer_profile.id),
+            default=True,
         )
         test_payment_profile.id = test_payment_profile.create(
             address=self.test_address_obj, payment=self.test_payment_obj
@@ -159,7 +161,9 @@ class PaymentProfileTestCase(TestCase):
     def test_payment_profile_delete(self) -> None:
         """Fails if a payment profile is not properly deleted in Authorizenet."""
         test_payment_profile = PaymentProfile(
-            id=None, customer_profile_id=self.test_customer_profile.id, default=True
+            id=None,
+            customer_profile_id=str(self.test_customer_profile.id),
+            default=True,
         )
         test_payment_profile.id = test_payment_profile.create(
             address=self.test_address_obj, payment=self.test_payment_obj
@@ -170,7 +174,9 @@ class PaymentProfileTestCase(TestCase):
     def test_payment_profile_last_4(self) -> None:
         """Fails if a payment profile's last 4 credit card digits are not properly retrieved."""
         test_payment_profile = PaymentProfile(
-            id=None, customer_profile_id=self.test_customer_profile.id, default=True
+            id=None,
+            customer_profile_id=str(self.test_customer_profile.id),
+            default=True,
         )
         test_payment_profile.id = test_payment_profile.create(
             address=self.test_address_obj, payment=self.test_payment_obj

terminusgps/authorizenet/utils.py

@@ -5,11 +5,107 @@ from .auth import get_merchant_auth
 from .controllers import AuthorizenetControllerExecutor
 
 
+def get_payment_profile_transactions(
+    customer_profile_id: int | str,
+    payment_profile_id: int | str,
+    descending: bool = False,
+    limit: int = 100,
+    offset: int = 0,
+) -> dict | None:
+    """
+    Returns a transaction list for a customer payment profile.
+
+    `getTransactionListForCustomerRequest <https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-customer-profile-transaction-list>`_
+
+    :param customer_profile_id: A customer profile id.
+    :type customer_profile_id: :py:obj:`int` | :py:obj:`str`
+    :param payment_profile_id: A customer payment profile id.
+    :type payment_profile_id: :py:obj:`int` | :py:obj:`str`
+    :param descending: Whether or not to sort the response in descending order. Default is :py:obj:`False`.
+    :type descending: :py:obj:`bool`
+    :param limit: Maximum amount of transactions to return in the response. Default is :py:obj:`100` .
+    :type limit: :py:obj:`int`
+    :param offset: Offsets the response for pagination. Default is :py:obj:`0` for page 0.
+    :type offset: :py:obj:`int`
+    :raises ValueError: If ``customer_profile_id`` was provided as a string containing non-digits.
+    :raises ValueError: If ``payment_profile_id`` was provided as a string containing non-digits.
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: A merchant details object, if found.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    raise NotImplementedError
+
+    if isinstance(customer_profile_id, str) and not customer_profile_id.isdigit():
+        raise ValueError(
+            f"'customer_profile_id' can only contain digits, got '{customer_profile_id}'."
+        )
+    if isinstance(payment_profile_id, str) and not payment_profile_id.isdigit():
+        raise ValueError(
+            f"'payment_profile_id' can only contain digits, got '{payment_profile_id}'."
+        )
+
+    request = apicontractsv1.getTransactionListForCustomerRequest(
+        merchantAuthentication=get_merchant_auth(),
+        customerProfileId=str(customer_profile_id),
+        customerPaymentProfileId=str(payment_profile_id),
+        sorting={
+            "orderBy": "submitTimeUTC",
+            "orderDescending": str(descending).lower(),
+        },
+        paging={"limit": limit, "offset": offset},
+    )
+    controller = apicontrollers.getTransactionListForCustomerController(request)
+    return AuthorizenetControllerExecutor.execute_controller(controller)
+
+
+def get_merchant_details() -> dict | None:
+    """
+    Returns Authorizenet merchant details.
+
+    `getMerchantDetailsRequest <http://developer.authorize.net/api/reference/index.html#transaction-reporting-get-merchant-details>`_
+
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: A merchant details object, if found.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    request = apicontractsv1.getMerchantDetailsRequest(
+        merchantAuthentication=get_merchant_auth()
+    )
+    controller = apicontrollers.getMerchantDetailsController(request)
+    return AuthorizenetControllerExecutor.execute_controller(controller)
+
+
+def get_transaction(id: int | str) -> dict | None:
+    """
+    Returns Authorizenet transaction details by id.
+
+    `getTransactionDetailsRequest <https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-transaction-details>`_
+
+    :param id: An Authorizenet transaction id.
+    :type id: :py:obj:`int` | :py:obj:`str`
+    :raises ValueError: If ``id`` was provided as a string containing non-digits.
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: A transaction object, if found.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    if isinstance(id, str) and not id.isdigit():
+        raise ValueError(f"'id' can only contain digits, got '{id}'.")
+
+    request = apicontractsv1.getTransactionDetailsRequest(
+        merchantAuthentication=get_merchant_auth(), transId=str(id)
+    )
+    controller = apicontrollers.getTransactionDetailsController(request)
+    return AuthorizenetControllerExecutor.execute_controller(controller)
+
+
 def get_customer_profile_ids() -> list[int]:
     """
     Returns a list of all customer profile ids in Authorizenet.
 
-    :raises ControllerExecutionError: If the API call fails.
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
     :returns: A list of all customer profile ids in Authorizenet.
     :rtype: :py:obj:`list`
 

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