python-terminusgps 45.6.1__tar.gz → 45.7.0__tar.gz

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/.github/workflows/sphinx.yml

@@ -12,8 +12,25 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Build HTML
-        uses: ammaraskar/sphinx-action@8.2.3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.17"
+
+      - name: Set up python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install project
+        run: uv sync --locked --group docs
+
+      - name: Build docs
+        run: |
+          source .venv/bin/activate
+          cd docs
+          make html
+          deactivate
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v4

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 45.6.1
+Version: 45.7.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://terminusgps.github.io/python-terminusgps
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/docs/requirements.txt

@@ -1,5 +1,6 @@
+authorizenet>=1.1.5
 autoclasstoc>=1.7.0
 django>=5.2.1
-furo==2024.04.27
 python-wialon>=1.2.4
+sphinx>=8.2.3
 sphinxawesome-theme>=5.3.2

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/docs/source/authorizenet/constants.rst

@@ -1,12 +1,15 @@
 Constants
 =========
 
-These constants inherit from :py:obj:`~django.db.models.TextChoices`, not the built-in Python :py:obj:`~enum.StrEnum` type.
+These constants inherit from :py:obj:`django.db.models.TextChoices`, not the built-in Python :py:obj:`~enum.StrEnum` type.
 
 Django :py:obj:`~django.db.models.TextChoices` provides attributes such as :py:attr:`~django.db.models.TextChoices.choices`, :py:attr:`~django.db.models.TextChoices.values`, :py:attr:`~django.db.models.TextChoices.labels` and more.
 
 .. py:currentmodule:: terminusgps.authorizenet.constants
 
+.. autoclass:: CurrencyCode
+    :members:
+
 .. autoclass:: Environment
     :members:
 

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/docs/source/authorizenet/index.rst

@@ -1,13 +1,13 @@
 Authorizenet
 ============
 
-The :py:mod:`terminusgps.authorizenet` package provides convenient functions for interacting with the Authorizenet API in a Pythonic interface.
+The :py:mod:`terminusgps.authorizenet` package provides a Pythonic interface for interacting with the Authorizenet API.
 
 Most `Authorizenet API endpoints <https://developer.authorize.net/api/reference/index.html>`_ are represented as plain Python functions.
 
-.. attention:: These functions require the following settings to be present in your Django project's ``settings.py`` module.
+.. attention:: :py:mod:`terminusgps.authorizenet` requires the following settings to be present in your Django project's ``settings.py`` module.
 
-   Using this package without setting these settings will raise :py:exc:`~django.core.exceptions.ImproperlyConfigured`.
+   Using the package without setting these settings will raise :py:exc:`~django.core.exceptions.ImproperlyConfigured`.
 
    +-----------------------------------+---------------+
    | setting                           | type          |
@@ -25,8 +25,7 @@ Most `Authorizenet API endpoints <https://developer.authorize.net/api/reference/
     :maxdepth: 2
     :caption: Contents:
 
-    auth.rst
     constants.rst
-    exceptions.rst
     api.rst
+    service.rst
     usage.rst

python_terminusgps-45.7.0/docs/source/authorizenet/service.rst

@@ -0,0 +1,9 @@
+Service
+=======
+
+.. autoexception:: terminusgps.authorizenet.service.AuthorizenetControllerExecutionError
+    :members:
+
+.. autoclass:: terminusgps.authorizenet.service.AuthorizenetService
+    :autoclasstoc:
+    :members:

python_terminusgps-45.7.0/docs/source/authorizenet/usage.rst

@@ -0,0 +1,6 @@
+Usage
+=====
+
+Check the Authorizenet API documentation for expected attributes in each response.
+
+TODO

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/docs/source/conf.py

@@ -33,7 +33,6 @@ intersphinx_mapping = {
     ),
 }
 
-templates_path = ["_templates"]
 exclude_patterns = []
 
 

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "45.6.1"
+version = "45.7.0"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

python_terminusgps-45.7.0/terminusgps/authorizenet/api/transactions.py

@@ -0,0 +1,100 @@
+from decimal import Decimal
+
+from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
+from lxml.objectify import ObjectifiedElement
+
+__all__ = []
+
+
+def build_transaction_request(
+    transaction_type: str,
+    amount: Decimal,
+    payment: apicontractsv1.paymentType | None = None,
+    order: apicontractsv1.orderType | None = None,
+    address: apicontractsv1.customerAddressType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.settingType | None = None,
+    line_items: apicontractsv1.ArrayOfLineItem | None = None,
+) -> apicontractsv1.transactionRequestType:
+    request = apicontractsv1.transactionRequestType()
+    request.transactionType = transaction_type
+    request.amount = amount
+
+    if payment is not None:
+        request.payment = payment
+    if order is not None:
+        request.order = order
+    if address is not None:
+        request.billTo = address
+    if customer_data is not None:
+        request.customer = customer_data
+    if settings is not None:
+        request.transactionSettings = settings
+    if line_items is not None:
+        request.lineItems = line_items
+    return request
+
+
+def charge_credit_card(
+    amount: Decimal,
+    credit_card: apicontractsv1.creditCardType,
+    address: apicontractsv1.customerAddressType,
+    order: apicontractsv1.orderType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.settingType | None = None,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="authCaptureTransaction",
+        amount=amount,
+        payment=apicontractsv1.paymentType(creditCard=credit_card),
+        address=address,
+        order=order,
+        customer_data=customer_data,
+        settings=settings,
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def authorize_credit_card(
+    amount: Decimal,
+    credit_card: apicontractsv1.creditCardType,
+    address: apicontractsv1.customerAddressType,
+    order: apicontractsv1.orderType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.settingType | None = None,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="authOnlyTransaction",
+        amount=amount,
+        payment=apicontractsv1.paymentType(creditCard=credit_card),
+        address=address,
+        order=order,
+        customer_data=customer_data,
+        settings=settings,
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def capture_authorized_amount(
+    amount: Decimal,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="priorAuthCaptureTransaction", amount=amount
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def refund_credit_card(
+    amount: Decimal, credit_card: apicontractsv1.creditCardType
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="refundTransaction",
+        amount=amount,
+        payment=apicontractsv1.paymentType(creditCard=credit_card),
+    )
+    return request, apicontrollers.createTransactionController

python_terminusgps-45.7.0/terminusgps/authorizenet/service.py

@@ -0,0 +1,112 @@
+from functools import cached_property
+
+from authorizenet.apicontractsv1 import merchantAuthenticationType
+from authorizenet.apicontrollersbase import APIOperationBase
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+from lxml.objectify import ObjectifiedElement
+
+if not settings.configured:
+    from terminusgps import default_settings
+
+    settings.configure(default_settings)
+
+
+class AuthorizenetControllerExecutionError(Exception):
+    """Raised when an Authorizenet API controller fails to execute."""
+
+    def __init__(self, message: str, code: str, *args, **kwargs) -> None:
+        super().__init__(message, *args, **kwargs)
+        self._message: str = message
+        self._code: str = code
+
+    def __str__(self) -> str:
+        return f"{self.code}: {self.message}"
+
+    @property
+    def message(self) -> str:
+        """An Authorizenet API error message."""
+        return self._message
+
+    @property
+    def code(self) -> str:
+        """An Authorizenet API error code."""
+        return self._code
+
+
+class AuthorizenetService:
+    """A service for safely interacting with the Authorizenet API."""
+
+    REQUIRED_SETTINGS = (
+        "MERCHANT_AUTH_ENVIRONMENT",
+        "MERCHANT_AUTH_LOGIN_ID",
+        "MERCHANT_AUTH_TRANSACTION_KEY",
+        "MERCHANT_AUTH_VALIDATION_MODE",
+    )
+
+    def __init__(self) -> None:
+        """Raises :py:exc:`~django.core.exceptions.ImproperlyConfigured` if required settings weren't set."""
+        for setting in self.REQUIRED_SETTINGS:
+            if not hasattr(settings, setting):
+                raise ImproperlyConfigured(f"'{setting}' setting is required.")
+
+    def call_api(
+        self,
+        request: ObjectifiedElement,
+        controller_cls: type[APIOperationBase],
+        reference_id: str | None = None,
+    ) -> ObjectifiedElement:
+        """
+        Adds required authentication data to the request before executing it and returning its response.
+
+        If ``reference_id`` was provided, it is added to the request before execution.
+
+        :param request: An Authorizenet API request element.
+        :type request: ~lxml.objectify.ObjectifiedElement
+        :param controller_cls: An Authorizenet controller class.
+        :type controller_cls: type[~authorizenet.apicontrollersbase.APIOperationBase]
+        :param reference_id: An optional reference id string for the API call. Default is :py:obj:`None`.
+        :type reference_id: str | None
+        :raises AuthorizenetControllerExecutionError: If the API call failed.
+        :returns: An Authorizenet API response.
+        :rtype: ~lxml.objectify.ObjectifiedElement
+
+        """
+        request.merchantAuthentication = self.merchantAuthentication
+        if reference_id is not None:
+            request.refId = reference_id
+
+        controller = controller_cls(request)
+        controller.setenvironment(self.environment)
+        controller.execute()
+
+        response: ObjectifiedElement | None = controller.getresponse()
+        if response is None:
+            raise AuthorizenetControllerExecutionError(
+                message="No response from the Authorizenet API controller.",
+                code="1",
+            )
+        elif response is not None and response.messages.resultCode != "Ok":
+            raise AuthorizenetControllerExecutionError(
+                message=response.messages.message[0]["text"].text,
+                code=response.messages.message[0]["code"].text,
+            )
+        return response
+
+    @cached_property
+    def merchantAuthentication(self) -> merchantAuthenticationType:
+        """Merchant authentication element for Authorizenet API requests."""
+        return merchantAuthenticationType(
+            name=str(settings.MERCHANT_AUTH_LOGIN_ID),
+            transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
+        )
+
+    @cached_property
+    def environment(self) -> str:
+        """Environment for Authorizenet API requests."""
+        return str(settings.MERCHANT_AUTH_ENVIRONMENT)
+
+    @cached_property
+    def validationMode(self) -> str:
+        """Validation mode for Authorizenet API requests."""
+        return str(settings.MERCHANT_AUTH_VALIDATION_MODE)

{python_terminusgps-45.6.1 → python_terminusgps-45.7.0}/uv.lock

@@ -298,7 +298,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "45.6.1"
+version = "45.7.0"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },

python_terminusgps-45.6.1/docs/source/authorizenet/auth.rst

@@ -1,22 +0,0 @@
-Authentication
-==============
-
-Authentication for each Authorizenet API call is handled by values defined in a Django ``settings.py`` module.
-
-Required settings:
-
-   +-----------------------------------+---------------+
-   | setting                           | type          |
-   +===================================+===============+
-   | ``MERCHANT_AUTH_ENVIRONMENT``     | :py:obj:`str` |
-   +-----------------------------------+---------------+
-   | ``MERCHANT_AUTH_LOGIN_ID``        | :py:obj:`str` |
-   +-----------------------------------+---------------+
-   | ``MERCHANT_AUTH_TRANSACTION_KEY`` | :py:obj:`str` |
-   +-----------------------------------+---------------+
-   | ``MERCHANT_AUTH_VALIDATION_MODE`` | :py:obj:`str` |
-   +-----------------------------------+---------------+
-
-.. automodule:: terminusgps.authorizenet.auth
-    :synopsis: Provides functions for authenticating Authorizenet API calls.
-    :members:

python_terminusgps-45.6.1/docs/source/authorizenet/exceptions.rst

@@ -1,4 +0,0 @@
-Exceptions
-==========
-
-.. autoexception:: terminusgps.authorizenet.controllers.AuthorizenetControllerExecutionError

python_terminusgps-45.6.1/docs/source/authorizenet/usage.rst

@@ -1,20 +0,0 @@
-Usage
-=====
-
-Check the Authorizenet API documentation for expected attributes in each response.
-
-.. code:: python
-
-    from terminusgps.authorizenet import api as anet
-
-    # An Authorizenet 'createCustomerProfileRequest'
-    response = anet.create_customer_profile(
-        merchant_id="1",
-        email="blake@terminusgps.com",
-        description="Blake Nall"
-    )
-
-    # Authorizenet API calls may return None
-    # Check first before trying to access attributes on it
-    if response is not None and hasattr(response, "customerProfileId"):
-        response.customerProfileId

python_terminusgps-45.6.1/terminusgps/authorizenet/api/transactions.py

@@ -1,2 +0,0 @@
-# TODO
-__all__ = []

python_terminusgps-45.6.1/terminusgps/authorizenet/auth.py

@@ -1,38 +0,0 @@
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from django.conf import settings
-
-
-def get_merchant_auth() -> merchantAuthenticationType:
-    """
-    Returns the merchant authentication information for Authorizenet API controller execution.
-
-    :returns: A merchant authentication object.
-    :rtype: ~authorizenet.apicontractsv1.merchantAuthenticationType
-
-    """
-    return merchantAuthenticationType(
-        name=str(settings.MERCHANT_AUTH_LOGIN_ID),
-        transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
-    )
-
-
-def get_environment() -> str:
-    """
-    Returns the environment for Authorizenet API controller execution.
-
-    :returns: An Authorizenet API environment string.
-    :rtype: str
-
-    """
-    return settings.MERCHANT_AUTH_ENVIRONMENT
-
-
-def get_validation_mode() -> str:
-    """
-    Returns the validation mode for Authorizenet API controller execution.
-
-    :returns: An Authorizenet API validation string.
-    :rtype: str
-
-    """
-    return settings.MERCHANT_AUTH_VALIDATION_MODE

python_terminusgps-45.6.1/terminusgps/authorizenet/controllers.py

@@ -1,57 +0,0 @@
-from authorizenet.apicontrollersbase import APIOperationBase
-from lxml.objectify import ObjectifiedElement
-
-
-def execute_controller(
-    controller: APIOperationBase, environment: str
-) -> ObjectifiedElement:
-    """
-    Executes an Authorizenet API controller and returns its response.
-
-    :param controller: An Authorizenet API controller.
-    :type controller: ~authorizenet.apicontrollersbase.APIOperationBase
-    :param environment: Authorizenet environment to execute the controller in.
-    :type environment: :py:obj:`str`
-    :param merchant_auth: Authorizenet merchant authentication element.
-    :type merchant_auth: ~authorizenet.apicontractsv1.merchantAuthenticationType
-    :raises AuthorizenetControllerExecutionError: If the API call fails.
-    :returns: An Authorizenet API response.
-    :rtype: ~lxml.objectify.ObjectifiedElement
-
-    """
-    controller.setenvironment(environment)
-    controller.execute()
-    response: ObjectifiedElement | None = controller.getresponse()
-
-    if response is None:
-        raise AuthorizenetControllerExecutionError(
-            message="Authorizenet controller response didn't exist.", code="1"
-        )
-    elif response is not None and response.messages.resultCode != "Ok":
-        raise AuthorizenetControllerExecutionError(
-            message=response.messages.message[0]["text"].text,
-            code=response.messages.message[0]["code"].text,
-        )
-    return response
-
-
-class AuthorizenetControllerExecutionError(Exception):
-    """Raised when an Authorizenet API controller fails to execute."""
-
-    def __init__(self, message: str, code: str, *args, **kwargs) -> None:
-        super().__init__(message, *args, **kwargs)
-        self._message: str = message
-        self._code: str = code
-
-    def __str__(self) -> str:
-        return f"{self.code}: {self.message}"
-
-    @property
-    def message(self) -> str:
-        """An Authorizenet API error message."""
-        return self._message
-
-    @property
-    def code(self) -> str:
-        """An Authorizenet API error code."""
-        return self._code

python_terminusgps-45.6.1/terminusgps/authorizenet/services.py

@@ -1,66 +0,0 @@
-from functools import cached_property
-from typing import Callable
-
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
-from lxml.objectify import ObjectifiedElement
-
-from .auth import get_environment, get_merchant_auth, get_validation_mode
-from .controllers import (
-    AuthorizenetControllerExecutionError,
-    execute_controller,
-)
-
-
-class AuthorizenetService:
-    """A service for safely interacting with the Authorizenet API."""
-
-    REQUIRED_SETTINGS = (
-        "MERCHANT_AUTH_ENVIRONMENT",
-        "MERCHANT_AUTH_LOGIN_ID",
-        "MERCHANT_AUTH_TRANSACTION_KEY",
-        "MERCHANT_AUTH_VALIDATION_MODE",
-    )
-
-    def __init__(self) -> None:
-        """Raises :py:exc:`~django.core.exceptions.ImproperlyConfigured` if required settings weren't set."""
-        for setting in self.REQUIRED_SETTINGS:
-            if not hasattr(settings, setting):
-                raise ImproperlyConfigured(f"'{setting}' setting is required.")
-
-    def request(self, func: Callable, *args, **kwargs) -> ObjectifiedElement:
-        """
-        Calls the Authorizenet API function with arguments and returns the result.
-
-        :param func: An Authorizenet API function.
-        :type func: ~typing.Callable
-        :param args: Positional arguments for the API call.
-        :param kwargs: Keyword arguments for the API call.
-        :raises ~terminusgps.authorizenet.controllers.AuthorizenetControllerExecutionError: If the API call failed.
-        :returns: The Authorizenet API call response.
-        :rtype: ~lxml.objectify.ObjectifiedElement
-
-        """
-        try:
-            request, controller_cls = func(*args, **kwargs)
-            request.merchantAuthentication = self.merchantAuthentication
-            controller = controller_cls(request)
-            return execute_controller(controller, self.environment)
-        except AuthorizenetControllerExecutionError:
-            raise
-
-    @cached_property
-    def merchantAuthentication(self) -> merchantAuthenticationType:
-        """Merchant authentication element for Authorizenet API requests."""
-        return get_merchant_auth()
-
-    @cached_property
-    def environment(self) -> str:
-        """Environment for Authorizenet API requests."""
-        return get_environment()
-
-    @cached_property
-    def validationMode(self) -> str:
-        """Validation mode for Authorizenet API requests."""
-        return get_validation_mode()