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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 33.1.0
+Version: 33.3.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.1.0.dist-info → python_terminusgps-33.3.0.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,17 +12,23 @@ 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/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/utils.py,sha256=68GWcllu4h41qzFiKdUkWOAA4LDsTPqRY446VRMxYsY,116
 terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/django/forms.py,sha256=47z0NWtA1edkHviVmmpwmG-ofxU6j36BCRzO3UW3aek,4989
 terminusgps/django/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/django/settings.py,sha256=yJIcBE0xjY60AXF_gonY5hS3ofseqPW2k9uSoELgoho,639
 terminusgps/django/utils.py,sha256=SYDQyHA5tTuVwdpZGsCtf0LpTTD0ilRKoxa8StfSTpQ,156
+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
+terminusgps/django/forms/widgets.py,sha256=Hu6jNVx0i8JOOvAV1tuSHRqNI3mV2wijuKupUhol46c,1765
+terminusgps/django/tests/test_forms.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+terminusgps/django/tests/test_mixins.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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
@@ -47,7 +53,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.1.0.dist-info/METADATA,sha256=K_96np1Rmj8DPiPs4pxWKQygqzSkHm7Zzlloa2y8hNc,1581
-python_terminusgps-33.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-33.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-33.1.0.dist-info/RECORD,,
+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,,

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/django/forms/__init__.py

@@ -0,0 +1 @@
+from .forms import *

terminusgps/django/forms/fields.py

@@ -0,0 +1,57 @@
+from collections.abc import Sequence
+
+from authorizenet import apicontractsv1
+from django import forms
+
+from .widgets import AddressWidget, CreditCardWidget
+
+
+class CreditCardField(forms.MultiValueField):
+    require_all_fields = True
+
+    def __init__(self, fields=(), widget=CreditCardWidget(), *args, **kwargs) -> None:
+        if not fields:
+            fields = (
+                forms.CharField(label="Card #"),
+                forms.IntegerField(label="Expiry Month", min_value=1, max_value=12),
+                forms.IntegerField(label="Expiry Year"),
+                forms.CharField(label="CCV #"),
+            )
+        super().__init__(fields=fields, widget=widget, *args, **kwargs)
+
+    def compress(self, data_list: Sequence[str]) -> apicontractsv1.creditCardType:
+        """Compresses ``data_list`` into a :py:obj:`~authorizenet.apicontractsv1.creditCardType`."""
+        return apicontractsv1.creditCardType(
+            **{
+                "cardNumber": data_list[0],
+                "expirationDate": f"{data_list[1]}-{data_list[2]}",
+                "cardCode": data_list[3],
+            }
+        )
+
+
+class AddressField(forms.MultiValueField):
+    require_all_fields = True
+
+    def __init__(self, fields=(), widget=AddressWidget(), *args, **kwargs) -> None:
+        if not fields:
+            fields = (
+                forms.CharField(label="Street", max_length=128),
+                forms.CharField(label="City", max_length=128),
+                forms.CharField(label="State", max_length=64),
+                forms.CharField(label="Zip #", min_length=5, max_length=10),
+                forms.CharField(label="Country", max_length=2),
+            )
+        super().__init__(fields=fields, widget=widget, *args, **kwargs)
+
+    def compress(self, data_list: Sequence[str]) -> apicontractsv1.customerAddressType:
+        """Compresses ``data_list`` into a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`."""
+        return apicontractsv1.customerAddressType(
+            **{
+                "address": data_list[0],
+                "city": data_list[1],
+                "state": data_list[2],
+                "zip": data_list[3],
+                "country": data_list[4],
+            }
+        )

terminusgps/django/forms/widgets.py

@@ -0,0 +1,46 @@
+from authorizenet import apicontractsv1
+from django import forms
+
+
+class CreditCardWidget(forms.widgets.MultiWidget):
+    def __init__(self, widgets=(), attrs: dict | None = None) -> None:
+        if not widgets:
+            widgets = [
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+            ]
+        super().__init__(widgets=widgets, attrs=attrs)
+
+    def decompress(
+        self, value: apicontractsv1.creditCardType | None
+    ) -> list[str | None]:
+        """Decompresses a :py:attr:`~authorizenet.apicontractsv1.creditCardType` into a list of strings."""
+        if value is None:
+            return [None, None, None, None]
+
+        expiry_parts = value.expirationDate.split("-")
+        return [value.cardNumber, expiry_parts[0], expiry_parts[1], value.cardCode]
+
+
+class AddressWidget(forms.widgets.MultiWidget):
+    def __init__(self, widgets=(), attrs: dict | None = None) -> None:
+        if not widgets:
+            widgets = [
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+                forms.TextInput(attrs=attrs),
+            ]
+        super().__init__(widgets=widgets, attrs=attrs)
+
+    def decompress(
+        self, value: apicontractsv1.customerAddressType | None
+    ) -> list[str | None]:
+        """Decompresses a :py:attr:`~authorizenet.apicontractsv1.customerAddressType` into a list of strings."""
+        if value is None:
+            return [None, None, None, None, None]
+
+        return [value.address, value.city, value.state, value.country, value.zip]

terminusgps/django/tests/test_forms.py

@@ -0,0 +1 @@
+

terminusgps/django/forms.py

@@ -1,139 +0,0 @@
-from collections.abc import Sequence
-
-from authorizenet import apicontractsv1
-from django import forms
-
-
-class CreditCardWidget(forms.widgets.MultiWidget):
-    def __init__(self, widgets=(), attrs: dict | None = None) -> None:
-        if not widgets:
-            widgets = [
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-            ]
-        super().__init__(widgets=widgets, attrs=attrs)
-
-    def decompress(
-        self, value: apicontractsv1.creditCardType | None
-    ) -> list[str | None]:
-        """Decompresses a :py:attr:`~authorizenet.apicontractsv1.creditCardType` into a list of strings."""
-        if value is None:
-            return [None, None, None, None]
-
-        expiry_parts = value.expirationDate.split("-")
-        return [value.cardNumber, expiry_parts[0], expiry_parts[1], value.cardCode]
-
-
-class AddressWidget(forms.widgets.MultiWidget):
-    def __init__(self, widgets=(), attrs: dict | None = None) -> None:
-        if not widgets:
-            widgets = [
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-                forms.TextInput(attrs=attrs),
-            ]
-        super().__init__(widgets=widgets, attrs=attrs)
-
-    def decompress(
-        self, value: apicontractsv1.customerAddressType | None
-    ) -> list[str | None]:
-        """Decompresses a :py:attr:`~authorizenet.apicontractsv1.customerAddressType` into a list of strings."""
-        if value is None:
-            return [None, None, None, None, None]
-
-        return [value.address, value.city, value.state, value.country, value.zip]
-
-
-class CreditCardField(forms.MultiValueField):
-    require_all_fields = True
-
-    def __init__(self, fields=(), widget=CreditCardWidget(), *args, **kwargs) -> None:
-        if not fields:
-            fields = (
-                forms.CharField(label="Card #"),
-                forms.IntegerField(label="Expiry Month", min_value=1, max_value=12),
-                forms.IntegerField(label="Expiry Year"),
-                forms.CharField(label="CCV #"),
-            )
-        super().__init__(fields=fields, widget=widget, *args, **kwargs)
-
-    def compress(self, data_list: Sequence[str]) -> apicontractsv1.creditCardType:
-        """Compresses ``data_list`` into a :py:obj:`~authorizenet.apicontractsv1.creditCardType`."""
-        return apicontractsv1.creditCardType(
-            **{
-                "cardNumber": data_list[0],
-                "expirationDate": f"{data_list[1]}-{data_list[2]}",
-                "cardCode": data_list[3],
-            }
-        )
-
-
-class AddressField(forms.MultiValueField):
-    require_all_fields = True
-
-    def __init__(self, fields=(), widget=AddressWidget(), *args, **kwargs) -> None:
-        if not fields:
-            fields = (
-                forms.CharField(label="Street", max_length=128),
-                forms.CharField(label="City", max_length=128),
-                forms.CharField(label="State", max_length=64),
-                forms.CharField(label="Zip #", min_length=5, max_length=10),
-                forms.CharField(label="Country", max_length=2),
-            )
-        super().__init__(fields=fields, widget=widget, *args, **kwargs)
-
-    def compress(self, data_list: Sequence[str]) -> apicontractsv1.customerAddressType:
-        """Compresses ``data_list`` into a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`."""
-        return apicontractsv1.customerAddressType(
-            **{
-                "address": data_list[0],
-                "city": data_list[1],
-                "state": data_list[2],
-                "zip": data_list[3],
-                "country": data_list[4],
-            }
-        )
-
-
-def main() -> None:
-    import os
-
-    import django
-
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "terminusgps.django.settings")
-    django.setup()
-
-    class TestForm(forms.Form):
-        first_name = forms.CharField(label="First Name")
-        last_name = forms.CharField(label="Last Name")
-        phone = forms.CharField(label="Phone #")
-        address = AddressField(label="Address")
-        credit_card = CreditCardField(label="Credit Card")
-
-    form_data = {
-        "first_name": "TestFirst",
-        "last_name": "TestLast",
-        "phone": "555-555-5555",
-        "address_0": "123 Main St.",
-        "address_1": "Houston",
-        "address_2": "Texas",
-        "address_3": "77065",
-        "address_4": "US",
-        "credit_card_0": "4111111111111111",
-        "credit_card_1": "1",
-        "credit_card_2": "41",
-        "credit_card_3": "444",
-    }
-    form = TestForm(form_data)
-    print(f"{form.is_valid() = }")
-    print(f"{form.errors = }")
-    print(f"{type(form.clean()["address"]) = }")
-    print(f"{type(form.clean()["credit_card"]) = }")
-
-
-if __name__ == "__main__":
-    main()