python-payway 0.0.4__tar.gz → 0.0.6__tar.gz

{python_payway-0.0.4 → python_payway-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-payway
-Version: 0.0.4
+Version: 0.0.6
 Summary: Python client for working with Westpac's PayWay REST API
 Author-email: Ben Napper <reppan197@gmail.com>
 License: MIT
@@ -232,7 +232,7 @@ Please follow PayWay's advice about reducing your risk of fraudulent transaction
 
 ```bash
 uv python install 3.8.19
-uv venv
+uv venv --python 3.8.19
 source .venv/bin/activate
 uv sync --extra dev
 ```
@@ -240,5 +240,5 @@ uv sync --extra dev
 ## Testing
 
 ```bash
-python -m unittest discover tests
+uv run pytest tests/ -v
 ```

{python_payway-0.0.4 → python_payway-0.0.6}/README.md

@@ -213,7 +213,7 @@ Please follow PayWay's advice about reducing your risk of fraudulent transaction
 
 ```bash
 uv python install 3.8.19
-uv venv
+uv venv --python 3.8.19
 source .venv/bin/activate
 uv sync --extra dev
 ```
@@ -221,5 +221,5 @@ uv sync --extra dev
 ## Testing
 
 ```bash
-python -m unittest discover tests
+uv run pytest tests/ -v
 ```

{python_payway-0.0.4 → python_payway-0.0.6}/payway/client.py

@@ -2,14 +2,17 @@ from __future__ import annotations
 
 import json
 from logging import getLogger
-from typing import NoReturn
+from typing import Any
 
 import requests
 
-from payway.conf import CUSTOMER_URL, TOKEN_NO_REDIRECT, TRANSACTION_URL
 from payway.constants import (
     BANK_ACCOUNT_PAYMENT_CHOICE,
     CREDIT_CARD_PAYMENT_CHOICE,
+    CUSTOMER_URL,
+    PAYWAY_ERROR_RESPONSE_CODES,
+    TOKEN_NO_REDIRECT,
+    TRANSACTION_URL,
     VALID_PAYMENT_METHOD_CHOICES,
 )
 from payway.customers import CustomerRequest
@@ -46,12 +49,12 @@ class Client(CustomerRequest, TransactionRequest):
         bank_account_id: str,
         secret_api_key: str,
         publishable_api_key: str,
-    ) -> NoReturn:
+    ) -> None:
         """
-        :param merchant_id        : str                 = PayWay Merchant ID
-        :param bank_account_id   : str                  = PayWay Bank Account ID
-        :param secret_api_key   : str                   = PayWay Secret APi Key
-        :param publishable_api_key   : str              = PayWay Publishable API Key
+        :param merchant_id: PayWay Merchant ID
+        :param bank_account_id: PayWay Bank Account ID
+        :param secret_api_key: PayWay Secret APi Key
+        :param publishable_api_key: PayWay Publishable API Key
         """
         self._validate_credentials(
             merchant_id,
@@ -63,11 +66,9 @@ class Client(CustomerRequest, TransactionRequest):
         self.bank_account_id = bank_account_id
         self.secret_api_key = secret_api_key
         self.publishable_api_key = publishable_api_key
-
         session = requests.Session()
         session.auth = (self.secret_api_key, "")
-        headers = {"content-type": "application/x-www-form-urlencoded"}
-        session.headers = headers
+        session.headers = {"content-type": "application/x-www-form-urlencoded"}
         self.session = session
         session_no_headers = requests.Session()
         session_no_headers.auth = session.auth
@@ -79,17 +80,15 @@ class Client(CustomerRequest, TransactionRequest):
         bank_account_id: str,
         secret_api_key: str,
         publishable_api_key: str,
-    ) -> NoReturn:
-        if not merchant_id or not bank_account_id or not secret_api_key or not publishable_api_key:
-            if not secret_api_key or not publishable_api_key:
-                logger.error("PayWay API keys not found")
-                raise PaywayError(
-                    message="PayWay API keys not found",
-                    code="INVALID_API_KEYS",
-                )
-            logger.error(
-                "Merchant ID, bank account ID, secret API key, publishable API key are " "invalid",
+    ) -> None:
+        if any(not key for key in (secret_api_key, publishable_api_key)):
+            logger.error("PayWay API keys not found")
+            raise PaywayError(
+                message="PayWay API keys not found",
+                code="INVALID_API_KEYS",
             )
+        if any(not val for val in (merchant_id, bank_account_id)):
+            logger.error("Merchant ID or bank account ID invalid")
             raise PaywayError(
                 message="Invalid credentials",
                 code="INVALID_API_CREDENTIALS",
@@ -99,7 +98,7 @@ class Client(CustomerRequest, TransactionRequest):
         return requests.get(url=endpoint, auth=(self.secret_api_key, ""), timeout=30)
 
     def post_request(
-        self, endpoint: str, data: dict, auth: tuple | None = None, idempotency_key: str | None = None
+        self, endpoint: str, data: dict[str, Any], auth: tuple[str, str] | None = None, idempotency_key: str | None = None
     ) -> requests.Response:
         """
         Supply an idempotency_key to avoid duplicate POSTs
@@ -112,7 +111,7 @@ class Client(CustomerRequest, TransactionRequest):
             headers["Idempotency-Key"] = idempotency_key
         return requests.post(url=endpoint, auth=auth, data=data, headers=headers, timeout=30)
 
-    def put_request(self, endpoint: str, data: dict) -> requests.Response:
+    def put_request(self, endpoint: str, data: dict[str, Any]) -> requests.Response:
         return requests.put(
             url=endpoint,
             auth=(self.secret_api_key, ""),
@@ -123,7 +122,7 @@ class Client(CustomerRequest, TransactionRequest):
 
     def create_token(
         self, payway_obj: BankAccount | PayWayCard, payment_method: str, idempotency_key: str | None = None
-    ) -> tuple[TokenResponse, list]:
+    ) -> tuple[TokenResponse | None, list[PaymentError] | None]:
         """
         Creates a single use token for a Customer's payment setup (credit card or bank account)
         :param payway_obj:   object: one of model.PayWayCard or model.BankAccount object
@@ -146,10 +145,9 @@ class Client(CustomerRequest, TransactionRequest):
                 "paymentMethod": payway_payment_method,
             },
         )
-        endpoint = TOKEN_NO_REDIRECT
         logger.info("Sending Create Token request to PayWay.")
         response = self.post_request(
-            endpoint,
+            TOKEN_NO_REDIRECT,
             data,
             auth=(self.publishable_api_key, ""),
             idempotency_key=idempotency_key,
@@ -157,17 +155,20 @@ class Client(CustomerRequest, TransactionRequest):
         errors = self._validate_response(response)
         if errors:
             return None, errors
-        token_response = TokenResponse().from_dict(response.json())
-        return token_response, errors
+        return TokenResponse().from_dict(response.json()), errors
 
-    def create_card_token(self, card: PayWayCard, idempotency_key: str | None = None) -> tuple[TokenResponse, list]:
+    def create_card_token(
+        self, card: PayWayCard, idempotency_key: str | None = None
+    ) -> tuple[TokenResponse | None, list[PaymentError] | None]:
         """
         :param card:    PayWayCard object represents a customer's credit card details
         :param idempotency_key:   str: unique value to avoid duplicate POSTs
         """
         return self.create_token(card, "card", idempotency_key=idempotency_key)
 
-    def create_bank_account_token(self, bank_account: BankAccount, idempotency_key: str | None = None) -> str:
+    def create_bank_account_token(
+        self, bank_account: BankAccount, idempotency_key: str | None = None
+    ) -> tuple[TokenResponse | None, list[PaymentError] | None]:
         """
         :param bank_account:    BankAccount object represents a customer's bank account
         :param idempotency_key:   str: unique value to avoid duplicate POSTs
@@ -179,26 +180,23 @@ class Client(CustomerRequest, TransactionRequest):
             idempotency_key=idempotency_key,
         )
 
-    def create_customer(self, customer: PayWayCustomer, idempotency_key: str | None = None) -> tuple[PayWayCustomer | None, list]:
+    def create_customer(
+        self, customer: PayWayCustomer, idempotency_key: str | None = None
+    ) -> tuple[PayWayCustomer | None, list[PaymentError] | None]:
         """
         Create a customer in PayWay system
-
         POST /customers to have PayWay generate the customer number
         PUT /customers/{customerNumber} to use your own customer number
-
         :param customer:    PayWayCustomer object represents a customer in PayWay
         :param idempotency_key:   str: unique value to avoid duplicate POSTs
         See model.PayWayCustomer
-        :return:
         """
 
         data = customer.to_dict()
         data.update(
             {"merchantId": self.merchant_id, "bankAccountId": self.bank_account_id},
         )
-
         logger.info("Sending Create Customer request to PayWay.")
-
         if customer.custom_id:
             endpoint = f"{CUSTOMER_URL}/{customer.custom_id}"
             response = self.put_request(endpoint, data)
@@ -209,15 +207,15 @@ class Client(CustomerRequest, TransactionRequest):
                 data,
                 idempotency_key=idempotency_key,
             )
-
         errors = self._validate_response(response)
         if errors:
             return None, errors
-
         customer = PayWayCustomer().from_dict(response.json())
         return customer, errors
 
-    def process_payment(self, payment: PayWayPayment, idempotency_key: str | None = None) -> tuple[PayWayTransaction, list]:
+    def process_payment(
+        self, payment: PayWayPayment, idempotency_key: str | None = None
+    ) -> tuple[PayWayTransaction | None, list[PaymentError] | None]:
         """
         Process an individual payment against a Customer with active Recurring Billing setup.
         :param payment: PayWayPayment object (see model.PayWayPayment)
@@ -234,30 +232,16 @@ class Client(CustomerRequest, TransactionRequest):
         transaction = PayWayTransaction.from_dict(response.json())
         return transaction, errors
 
-    def _validate_response(self, response: requests.Response) -> list | None:
+    def _validate_response(self, response: requests.Response) -> list[PaymentError] | None:
         """
         Validates all responses from PayWay to catch documented PayWay errors.
         :param response: requests response object
         """
-        if response.status_code in [
-            400,
-            401,
-            403,
-            405,
-            406,
-            407,
-            409,
-            410,
-            415,
-            429,
-            501,
-            503,
-        ]:
+        if response.status_code in PAYWAY_ERROR_RESPONSE_CODES:
             http_error_msg = f"{response.status_code} Client Error: {response.reason} for url: {response.url}"
-            raise PaywayError(code=response.status_code, message=http_error_msg)
+            raise PaywayError(code=str(response.status_code), message=http_error_msg)
 
         if response.status_code in [404, 422]:  # Documented PayWay errors in JSON
-            # parse error message
             return PaymentError().from_dict(response.json())
 
         if response.status_code == 500:
@@ -265,17 +249,17 @@ class Client(CustomerRequest, TransactionRequest):
                 errors = response.json()
             except json.JSONDecodeError:
                 raise PaywayError(
-                    code=response.status_code,
+                    code=str(response.status_code),
                     message="Internal server error",
                 )
             # Documented PayWay server errors in JSON
             payway_error = ServerError().from_dict(errors)
             message = payway_error.to_message()
-            raise PaywayError(code=response.status_code, message=message)
+            raise PaywayError(code=str(response.status_code), message=message)
 
         return None
 
-    def get_transaction(self, transaction_id: int) -> tuple[PayWayTransaction, list]:
+    def get_transaction(self, transaction_id: int) -> tuple[PayWayTransaction | None, list[PaymentError] | None]:
         """
         Lookup and return a transaction if found in PayWay
         :param transaction_id: str  A PayWay transaction ID
@@ -288,7 +272,9 @@ class Client(CustomerRequest, TransactionRequest):
         transaction = PayWayTransaction.from_dict(response.json())
         return transaction, errors
 
-    def void_transaction(self, transaction_id: int, idempotency_key: str | None = None) -> tuple[PayWayTransaction, list]:
+    def void_transaction(
+        self, transaction_id: int, idempotency_key: str | None = None
+    ) -> tuple[PayWayTransaction | None, list[PaymentError] | None]:
         """
         Void a transaction in PayWay
         :param transaction_id: str  A PayWay transaction ID
@@ -299,8 +285,7 @@ class Client(CustomerRequest, TransactionRequest):
         errors = self._validate_response(response)
         if errors:
             return None, errors
-        transaction = PayWayTransaction.from_dict(response.json())
-        return transaction, errors
+        return PayWayTransaction.from_dict(response.json()), errors
 
     def refund_transaction(
         self,
@@ -309,7 +294,7 @@ class Client(CustomerRequest, TransactionRequest):
         order_id: str | None = None,
         ip_address: str | None = None,
         idempotency_key: str | None = None,
-    ) -> tuple[PayWayTransaction, list]:
+    ) -> tuple[PayWayTransaction | None, list[PaymentError] | None]:
         """
         Refund a transaction in PayWay
         :param transaction_id: str  A PayWay transaction ID
@@ -331,10 +316,9 @@ class Client(CustomerRequest, TransactionRequest):
         errors = self._validate_response(response)
         if errors:
             return None, errors
-        transaction = PayWayTransaction.from_dict(response.json())
-        return transaction, errors
+        return PayWayTransaction.from_dict(response.json()), errors
 
-    def get_customer(self, customer_id: str) -> tuple[PayWayCustomer, list]:
+    def get_customer(self, customer_id: str) -> tuple[PayWayCustomer | None, list[PaymentError] | None]:
         """
         Returns a PayWay Customer's Payment Setup, [Payment] Schedule, Contact Details, Custom Fields and Notes
         :param customer_id  str PayWay customer ID in PayWay system
@@ -344,10 +328,9 @@ class Client(CustomerRequest, TransactionRequest):
         errors = self._validate_response(response)
         if errors:
             return None, errors
-        customer = PayWayCustomer.from_dict(response.json())
-        return customer, errors
+        return PayWayCustomer.from_dict(response.json()), errors
 
-    def update_payment_setup(self, token: str, customer_id: str) -> tuple[PaymentSetup, str]:
+    def update_payment_setup(self, token: str, customer_id: str) -> tuple[PaymentSetup | None, list[PaymentError] | None]:
         """
         Updates the Customer's Payment Setup with a new Credit Card or Bank Account.
         :param token: PayWay credit card or bank account token
@@ -363,5 +346,4 @@ class Client(CustomerRequest, TransactionRequest):
         errors = self._validate_response(response)
         if errors:
             return None, errors
-        ps = PaymentSetup.from_dict(response.json())
-        return ps, errors
+        return PaymentSetup.from_dict(response.json()), errors

{python_payway-0.0.4 → python_payway-0.0.6}/payway/constants.py

@@ -1,5 +1,11 @@
 from __future__ import annotations
 
+PAYWAY_API_URL = "https://api.payway.com.au/rest/v1"
+TOKEN_URL = PAYWAY_API_URL + "/single-use-tokens-redirect"
+TRANSACTION_URL = PAYWAY_API_URL + "/transactions"
+CUSTOMER_URL = PAYWAY_API_URL + "/customers"
+OWN_BANK_ACCOUNTS_URL = PAYWAY_API_URL + "/your-bank-accounts"
+TOKEN_NO_REDIRECT = PAYWAY_API_URL + "/single-use-tokens"
 TRANSACTION_APPROVED = "0"
 
 SUMMARY_CODES = {
@@ -69,7 +75,8 @@ EFT_RESPONSE_CODES = {
 CVN_RESPONSE_CODES = {
     "M": "Matched",  # i.e. the CVN is correct
     "N": "Not Matched",  # i.e. the CVN is incorrect
-    "P": "Not Processed",  # i.e. the CVN was not processed for some reason; do not assume that the CVN is necessarily correct
+    "P": "Not Processed",
+    # i.e. the CVN was not processed for some reason; do not assume that the CVN is necessarily correct
     "S": "Suspicious",
     "U": "Unknown",  # i.e. the CVN was not processed for some reason; do not assume that the CVN is necessarily correct
 }
@@ -132,3 +139,17 @@ DIRECT_DEBIT_CHOICES = (
 )
 PAYMENT_METHOD_CHOICES = OTHER_PAYMENT_CHOICES + DIRECT_DEBIT_CHOICES
 VALID_PAYMENT_METHOD_CHOICES = ["card", "direct_debit"]
+PAYWAY_ERROR_RESPONSE_CODES = [
+    400,
+    401,
+    403,
+    405,
+    406,
+    407,
+    409,
+    410,
+    415,
+    429,
+    501,
+    503,
+]

{python_payway-0.0.4 → python_payway-0.0.6}/payway/customers.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
+from typing import Any
+
 import requests
 
-from payway.conf import CUSTOMER_URL
+from payway.constants import CUSTOMER_URL
 from payway.model import PayWayCustomer
 from payway.utils import json_list
 
@@ -79,7 +81,7 @@ class CustomerRequest:
 
     @json_list("update_contact_details")
     def update_contact_details(
-        self, customer_number: int, customer: PayWayCustomer | None = None, **options: dict
+        self, customer_number: int, customer: PayWayCustomer | None = None, **options: dict[str, Any]
     ) -> requests.Response:
         """
         param: customer_number: PayWay customer number

{python_payway-0.0.4 → python_payway-0.0.6}/payway/exceptions.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
 
-from typing import NoReturn
+from typing import Any
 
 
 class PaywayError(Exception):
-    _code: str = None
-    _message: str = None
+    _code: str = ""
+    _message: str = ""
 
-    def __init__(self, code: str, message: str, *args: dict, **kwargs: dict) -> NoReturn:
+    def __init__(self, code: str, message: str, *args: dict[str, Any], **kwargs: dict[str, Any]) -> None:
         """
         code            : str = PayWay API response/error code
         message         : str = appropriate message
@@ -16,7 +16,7 @@ class PaywayError(Exception):
         super().__init__(*args, **kwargs)
 
         self._code = code
-        self._message = f"{code}: {message}".encode()
+        self._message = f"{code}: {message}"
 
     def __str__(self) -> str:
-        return self.message
+        return self._message