python-mope 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

mope/__version__.py

@@ -1,2 +1,2 @@
 __author__ = "lemuel@vokality.com"
-__version__ = "0.1.0"
+__version__ = "0.3.0"

mope/client.py

@@ -1,11 +1,36 @@
+from collections.abc import Iterable, Mapping, Set
+from typing import IO, Protocol, TypeAlias
 from urllib.parse import urljoin
 
 import requests
 
 from mope.__version__ import __version__
+from mope.json import json_value
 from mope.resources.shop import ShopResource
 
-_user_agent = "Python Mope %s" % __version__
+QueryScalar: TypeAlias = str | bytes | int | float
+QueryValue: TypeAlias = QueryScalar | Iterable[QueryScalar] | None
+
+
+class QueryItems(Protocol):
+    def items(self) -> Set[tuple[QueryScalar, QueryValue]]: ...
+
+
+QueryParams: TypeAlias = (
+    QueryItems | Iterable[tuple[QueryScalar, QueryValue]] | str | bytes
+)
+RequestData: TypeAlias = (
+    Mapping[str, object]
+    | list[tuple[str, object]]
+    | tuple[tuple[str, object], ...]
+    | Iterable[bytes]
+    | IO[str]
+    | IO[bytes]
+    | str
+    | bytes
+)
+
+_user_agent = f"Python Mope {__version__}"
 
 
 class Client:
@@ -14,12 +39,17 @@ class Client:
         self._headers = {
             "User-Agent": _user_agent,
             "Content-Type": "application/json",
-            "Authorization": "Bearer %s" % token,
+            "Authorization": f"Bearer {token}",
         }
         self._base_url = "https://api.mope.sr/api"
 
     def call_api(
-        self, method, endpoint, params=None, data=None, json=None
+        self,
+        method: str,
+        endpoint: str,
+        params: QueryParams | None = None,
+        data: RequestData | None = None,
+        json: object = None,
     ) -> requests.Response:
         url = urljoin(self._base_url, endpoint)
         return requests.request(
@@ -27,7 +57,7 @@ class Client:
             url=url,
             params=params,
             data=data,
-            json=json,
+            json=json_value(json, path="request"),
             headers=self._headers,
         )
 
@@ -38,7 +68,7 @@ class Mope:
         self._headers = {
             "User-Agent": _user_agent,
             "Content-Type": "application/json",
-            "Authorization": "Bearer %s" % token,
+            "Authorization": f"Bearer {token}",
         }
         self.base_url = "https://api.mope.sr/api"
 

mope/json.py

@@ -0,0 +1,49 @@
+"""JSON types and validation at the API boundary."""
+
+from math import isfinite
+from typing import TypeAlias
+
+JsonValue: TypeAlias = (
+    str | int | float | bool | None | list["JsonValue"] | dict[str, "JsonValue"]
+)
+JsonObject: TypeAlias = dict[str, JsonValue]
+
+
+def json_value(value: object, *, path: str = "response") -> JsonValue:
+    if value is None or isinstance(value, (str, bool, int)):
+        return value
+    if isinstance(value, float):
+        if not isfinite(value):
+            raise ValueError(f"{path} must contain a finite JSON number")
+        return value
+    if isinstance(value, list):
+        return [
+            json_value(item, path=f"{path}[{index}]")
+            for index, item in enumerate(value)
+        ]
+    if isinstance(value, dict):
+        return json_object(value, path=path)
+    raise TypeError(f"{path} must be a JSON value")
+
+
+def json_object(value: object, *, path: str = "response") -> JsonObject:
+    if not isinstance(value, dict):
+        raise TypeError(f"{path} must be a JSON object")
+    result: JsonObject = {}
+    for key, item in value.items():
+        if not isinstance(key, str):
+            raise TypeError(f"{path} must have string keys")
+        result[key] = json_value(item, path=f"{path}.{key}")
+    return result
+
+
+def json_string(value: object, *, path: str) -> str:
+    if not isinstance(value, str):
+        raise TypeError(f"{path} must be a string")
+    return value
+
+
+def json_integer(value: object, *, path: str) -> int:
+    if isinstance(value, bool) or not isinstance(value, int):
+        raise TypeError(f"{path} must be an integer")
+    return value

mope/models/payments.py

@@ -1,16 +1,57 @@
 from abc import ABC, abstractmethod
 from dataclasses import asdict, dataclass
-from typing import Any, Dict, List
+from typing import Literal, Self, TypeAlias, TypedDict
 
+from mope.json import JsonValue, json_integer, json_object, json_string
 
+CurrencyCode: TypeAlias = Literal["SRD", "EUR", "USD"]
+PaymentStatus: TypeAlias = Literal["open", "scanned", "unconfirmed", "paid"]
+
+
+class PaymentMetadata(TypedDict):
+    key: str
+    value: str
+
+
+def _payment_status(value: object) -> PaymentStatus:
+    match value:
+        case "open":
+            return "open"
+        case "scanned":
+            return "scanned"
+        case "unconfirmed":
+            return "unconfirmed"
+        case "paid":
+            return "paid"
+        case _:
+            raise ValueError("status must be open, scanned, unconfirmed, or paid")
+
+
+def _payment_metadata(value: object) -> list[PaymentMetadata]:
+    if not isinstance(value, list):
+        raise TypeError("meta_data must be an array")
+    result: list[PaymentMetadata] = []
+    for index, entry in enumerate(value):
+        path = f"meta_data[{index}]"
+        item = json_object(entry, path=path)
+        result.append(
+            PaymentMetadata(
+                key=json_string(item["key"], path=f"{path}.key"),
+                value=json_string(item["value"], path=f"{path}.value"),
+            )
+        )
+    return result
+
+
+@dataclass
 class BaseModel(ABC):
     @classmethod
     @abstractmethod
-    def from_json(cls, data: Dict[str, Any]) -> None:
+    def from_json(cls, data: object) -> Self:
         pass
 
-    def as_dict(self) -> Dict[str, Any]:
-        return asdict(self)
+    def as_dict(self) -> dict[str, JsonValue]:
+        return json_object(asdict(self))
 
 
 @dataclass
@@ -19,8 +60,12 @@ class CreatePaymentResponse(BaseModel):
     url: str
 
     @classmethod
-    def from_json(cls, data: Dict[str, Any]) -> "CreatePaymentResponse":
-        return cls(id=data["id"], url=data["url"])
+    def from_json(cls, data: object) -> Self:
+        payload = json_object(data)
+        return cls(
+            id=json_string(payload["id"], path="id"),
+            url=json_string(payload["url"], path="url"),
+        )
 
 
 @dataclass
@@ -30,11 +75,12 @@ class Currency(BaseModel):
     symbol: str
 
     @classmethod
-    def from_json(cls, data: Dict[str, str]) -> "Currency":
+    def from_json(cls, data: object) -> Self:
+        payload = json_object(data, path="currency")
         return cls(
-            name=data["name"],
-            code=data["code"],
-            symbol=data["symbol"],
+            name=json_string(payload["name"], path="currency.name"),
+            code=json_string(payload["code"], path="currency.code"),
+            symbol=json_string(payload["symbol"], path="currency.symbol"),
         )
 
 
@@ -46,18 +92,19 @@ class PaymentRequest(BaseModel):
     description: str
     expires_at: str
     currency: Currency
-    status: str
-    meta_data: List[Dict[str, Any]]
+    status: PaymentStatus
+    meta_data: list[PaymentMetadata]
 
     @classmethod
-    def from_json(cls, data: Dict[str, Any]) -> "PaymentRequest":
+    def from_json(cls, data: object) -> Self:
+        payload = json_object(data)
         return cls(
-            id=data["id"],
-            amount=data["amount"],
-            created_at=data["created_at"],
-            description=data["description"],
-            expires_at=data["expires_at"],
-            currency=Currency.from_json(data["currency"]),
-            status=data["status"],
-            meta_data=data["meta_data"],
+            id=json_string(payload["id"], path="id"),
+            amount=json_integer(payload["amount"], path="amount"),
+            created_at=json_string(payload["created_at"], path="created_at"),
+            description=json_string(payload["description"], path="description"),
+            expires_at=json_string(payload["expires_at"], path="expires_at"),
+            currency=Currency.from_json(payload["currency"]),
+            status=_payment_status(payload["status"]),
+            meta_data=_payment_metadata(payload["meta_data"]),
         )

mope/resources/shop.py

@@ -1,8 +1,9 @@
-from mope.models.payments import CreatePaymentResponse, PaymentRequest
+from mope.models.payments import CreatePaymentResponse, CurrencyCode, PaymentRequest
+from mope.transport import ApiTransport
 
 
 class ShopResource:
-    def __init__(self, client) -> None:
+    def __init__(self, client: ApiTransport) -> None:
         self._client = client
 
     def create_payment_request(
@@ -10,7 +11,7 @@ class ShopResource:
         amount: int,
         description: str,
         order_id: str,
-        currency: str,
+        currency: CurrencyCode,
         redirect_url: str,
     ) -> CreatePaymentResponse:
         """
@@ -37,7 +38,7 @@ class ShopResource:
         fetches a payment request given a payment ID
         """
 
-        endpoint = "shop/payment_request/%s" % payment_id
+        endpoint = f"shop/payment_request/{payment_id}"
         response = self._client.call_api("GET", endpoint=endpoint)
         response.raise_for_status()
         return PaymentRequest.from_json(response.json())

mope/transport.py

@@ -0,0 +1,11 @@
+from typing import Protocol
+
+from requests import Response
+
+
+class ApiTransport(Protocol):
+    """The HTTP operations required by API resources."""
+
+    def call_api(
+        self, method: str, endpoint: str, *, json: object = None
+    ) -> Response: ...

python_mope-0.3.0.dist-info/METADATA

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: python-mope
+Version: 0.3.0
+Summary: A client library for interacting with the Mopé Web Shop API
+Author-email: Lemuel Boyce <lemuel@vokality.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/rhymiz/python-mope
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 6 - Mature
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3,>=2.34.2
+Dynamic: license-file
+
+![build](https://github.com/rhymiz/python-mope/workflows/build/badge.svg)
+[![downloads](https://pepy.tech/badge/python-mope)](https://pepy.tech/project/python-mope)
+[![Ruff](https://img.shields.io/badge/lint%20and%20format-Ruff-D7FF64.svg)](https://docs.astral.sh/ruff/)
+
+# Python Mopé
+Client library for Mopé by Hakrinbank
+
+### Token acquisition and API Docs
+- [API Docs](https://api.mope.sr/integration/doc)
+- Instructions for [acquiring a token](https://drive.google.com/file/d/10fWqgpl2Ip9JIacl0pwzUDi_HV6WLbCi/view?usp=sharing)
+
+
+### Requirements
+- Python 3.11 or newer
+- Mopé API Token
+
+### Getting Started
+First, install from PyPi by running `pip install python-mope`
+
+Example usage:
+
+```python
+from mope import Mope
+
+mope = Mope(token="test_123")
+mope.shop.get_payment_request(payment_id="123")
+```
+
+### Development
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then run:
+
+```sh
+uv sync --locked
+uv run --locked ruff check .
+uv run --locked ruff format --check .
+uv run --locked ty check
+uv run --locked pytest
+uv build --no-sources
+```
+
+Development uses Python 3.15.2 from `.python-version`; uv installs it when needed.
+The library supports Python 3.11+, and CI tests the built wheel on Python 3.11,
+3.12, 3.13, 3.14, and 3.15. Ruff and ty target Python 3.11 compatibility.
+Run `uv run ruff format .` to format code. Commit `uv.lock` after changing
+dependencies; use `uv lock --upgrade` to refresh their locked versions.
+
+The package includes inline types and a `py.typed` marker. API responses are
+validated before creating models: invalid field types raise `TypeError`, invalid
+status values raise `ValueError`, and missing required fields raise `KeyError`.
+Values are not coerced. Payment metadata remains a list of dictionaries with
+string `key` and `value` fields, as defined by the
+[Mopé API schema](https://api.mope.sr/integration/paths/GetPaymentRequest.yaml).
+
+### Publishing
+
+To release, update `mope/__version__.py`, run `uv lock`, and commit the changes.
+Publish a GitHub release whose tag is the package version or `v` followed by that
+version. The workflow checks the tag, runs lint, formatting and type checks,
+builds the source distribution and wheel, and tests the installed wheel across
+all supported Python versions before uploading those same artifacts to PyPI.
+
+### Resources
+#### shop
+
+*Methods*
+
+##### `shop.create_payment_request`
+
+| Argument   | Type                | Required |
+| ---        |---                  | ---      |
+|amount      | int                 | yes      |
+|description | string              | yes      |
+|order_id    | string              | yes      |
+|currency    | enum (USD, SRD, EUR) | yes      |
+|redirect_url| string              | yes      |
+
+
+return type: `mope.models.payments.CreatePaymentResponse`
+
+##### `shop.get_payment_request`
+
+| Argument  | Type   | Required |
+|---        |---     |---       |
+|payment_id | string | yes      |
+
+
+return type: `mope.models.payments.PaymentRequest`

python_mope-0.3.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+mope/__init__.py,sha256=3nuq9PuAWTDZz6Ejg_737iQ5JRSC44uW_n5NPdHUscU,49
+mope/__version__.py,sha256=m1lfA5cU5lKTRV_7jofTAXIaBSOm8FGd8VLnnfV4jug,57
+mope/client.py,sha256=WK8IPinJu84GsxsDC3vDzGB3c8wcjFEisMtaCq8IID8,2074
+mope/json.py,sha256=kj03cwke1AXfd3LjFygapfYeopavF_e6YuasRMLamRE,1625
+mope/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mope/transport.py,sha256=AuN6SaKZG13d8ujVNOzMrSNMttH3P6Gl6x9hfznfoew,255
+mope/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mope/models/payments.py,sha256=oKovsudX6OvaTib4ya-GikuMDwvQVkDB-0pvSQyF-6I,3204
+mope/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mope/resources/shop.py,sha256=qQfDCbOOFJmIbii6bqpUOlg4npjUiJFqEd7nLeKu4Hc,1340
+python_mope-0.3.0.dist-info/licenses/LICENSE,sha256=H1HkxgxLo4v8voMaHpZVRh5Ao8jUezeLzSHpp182his,1069
+python_mope-0.3.0.dist-info/METADATA,sha256=JPw6Ao0bgzNLk3sPKznoSw3nK_G9VjKq8_Vuhf7TOLc,4046
+python_mope-0.3.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+python_mope-0.3.0.dist-info/top_level.txt,sha256=KNJibHVOvmp47d34dVOoxczy3_oafEiKZ4szVTOW6AA,5
+python_mope-0.3.0.dist-info/RECORD,,

{python_mope-0.1.0.dist-info → python_mope-0.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

python_mope-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Lemuel Boyce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_mope-0.1.0.dist-info/METADATA

@@ -1,80 +0,0 @@
-Metadata-Version: 2.1
-Name: python-mope
-Version: 0.1.0
-Summary: A client library for interacting with the Mopé Web Shop API
-Home-page: https://github.com/rhymiz/python-mope
-Author: Lemuel Boyce
-Author-email: lemuel@vokality.com
-License: MIT
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 6 - Mature
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Office/Business :: Financial
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.7,<=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: requests (>=2.23.0)
-
-![build](https://github.com/rhymiz/python-mope/workflows/build/badge.svg)
-[![downloads](https://pepy.tech/badge/python-mope)](https://pepy.tech/project/python-mope)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-# Python Mopé
-Client library for Mopé by Hakrinbank
-
-### Token acquisition and API Docs
-- [API Docs](https://api.mope.sr/integration/doc)
-- Instructions for [acquiring a token](https://drive.google.com/file/d/10fWqgpl2Ip9JIacl0pwzUDi_HV6WLbCi/view?usp=sharing)
-
-
-### Requirements
-- Python >= 3.7,<=3.11
-- requests (currently not sure what the min required version is)
-- Mopé API Tokens
-
-### Getting Started
-First, you can install from PyPi by running `pip install python-mope`
-
-Example usage:
-
-```python
-from mope import Mope
-
-mope = Mope(token='test_123')
-mope.shop.get_payment_request(payment_id='123')
-```
-
-### Resources
-#### shop
-
-*Methods*
-
-##### `shop.create_payment_request`
-
-| Argument   | Type                | Required |
-| ---        |---                  | ---      |
-|amount      | int                 | yes      |
-|description | string              | yes      |
-|order_id    | string              | yes      |
-|currency    | enum (USD, SRD, EU) | yes      | 
-|redirect_url| string              | yes      |
-
-
-return type: `mope.models.payments.CreatePaymentResponse`
-
-##### `shop.get_payment_request`
-
-| Argument  | Type   | Required |
-|---        |---     |---       |
-|payment_id | string | yes      |
-
-
-return type: `mope.models.payments.PaymentRequest`

python_mope-0.1.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-mope/__init__.py,sha256=3nuq9PuAWTDZz6Ejg_737iQ5JRSC44uW_n5NPdHUscU,49
-mope/__version__.py,sha256=MDAdK8ywbell4HI6AcHpwyhGQHs7giZw6H2kzGXwr9s,57
-mope/client.py,sha256=Z7HW72rRLxmtng1Wah4b6aRxlOTWuSwP_72hOY9XIE8,1308
-mope/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mope/models/payments.py,sha256=eAynuKRpyWwQsggml5oUyG5K12uhgtwXmpeWr9Y9jvA,1472
-mope/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mope/resources/shop.py,sha256=0Ju89jMX6wYIwGXoAjFIT3qfpRjOolHLMM8P2U-KZk0,1265
-python_mope-0.1.0.dist-info/METADATA,sha256=p2_-wtZhDgTXaLspwekbifc-PQk-bAuwYgrwifV59Tw,2553
-python_mope-0.1.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-python_mope-0.1.0.dist-info/top_level.txt,sha256=KNJibHVOvmp47d34dVOoxczy3_oafEiKZ4szVTOW6AA,5
-python_mope-0.1.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-python_mope-0.1.0.dist-info/RECORD,,

python_mope-0.1.0.dist-info/zip-safe

@@ -1 +0,0 @@
-