async_yookassa 0.1.0__tar.gz

async_yookassa-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ivan Ashikhmin
+
+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.

async_yookassa-0.1.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: async_yookassa
+Version: 0.1.0
+Summary: 
+Author: prodream
+Author-email: sushkoos@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: distro (>=1.9.0,<2.0.0)
+Requires-Dist: httpx (>=0.27.2,<0.28.0)
+Requires-Dist: pre-commit (>=4.0.1,<5.0.0)
+Requires-Dist: pydantic[email] (>=2.9.2,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Async YooKassa (unofficial)
+
+Неофициальный клиент для работы с платежами по [API ЮKassa](https://yookassa.ru/developers/api)
+
+За основу взята [официальная библиотека от ЮМани](https://git.yoomoney.ru/projects/SDK/repos/yookassa-sdk-python/browse).  
+
+## Цель
+Заменить синхронный `requests` на асинхронный `httpx`, также переложить валидацию данных на `Pydantic`.
+
+## Реализовано на данный момент
+
+* Модели данных запроса и ответа платежа, а также необходимые для них модели.
+* Класс `Configuration`, для определения авторизации по апи.
+* Класс `Payment` с возможностью создать платёж.
+* Класс `APIClient` для выполнения запросов к API.
+
+
+## Требования
+
+1. Python >=3.12 (на момент разработки)
+2. pip
+
+## Установка
+### C помощью pip
+
+1. Установите pip.
+2. В консоли выполните команду
+```bash
+pip install --upgrade yookassa
+```
+
+## Начало работы
+
+1. Импортируйте модуль
+```python
+import async_yookassa
+```
+2. Установите данные для конфигурации
+```python
+from async_yookassa import Configuration
+
+Configuration.configure(account_id='<Идентификатор магазина>', secret_key='<Секретный ключ>')
+```
+
+или
+
+```python
+from async_yookassa import Configuration
+
+Configuration.account_id = '<Идентификатор магазина>'
+Configuration.secret_key = '<Секретный ключ>'
+```
+
+или через oauth
+
+```python
+from async_yookassa import Configuration
+
+Configuration.configure_auth_token(token='<Oauth Token>')
+```
+
+Если вы согласны участвовать в развитии SDK, вы можете передать данные о вашем фреймворке, cms или модуле:
+```python
+from async_yookassa import Configuration
+from async_yookassa.models.configuration_submodels.version_model import Version
+
+Configuration.configure('<Идентификатор магазина>', '<Секретный ключ>')
+Configuration.configure_user_agent(
+    framework=Version(name='Django', version='2.2.3'),
+    cms=Version(name='Wagtail', version='2.6.2'),
+    module=Version(name='Y.CMS', version='0.0.1')
+)
+```
+
+3. Вызовите нужный метод API. [Подробнее в документации к API ЮKassa](https://yookassa.ru/developers/api)
+

async_yookassa-0.1.0/README.md

@@ -0,0 +1,75 @@
+# Async YooKassa (unofficial)
+
+Неофициальный клиент для работы с платежами по [API ЮKassa](https://yookassa.ru/developers/api)
+
+За основу взята [официальная библиотека от ЮМани](https://git.yoomoney.ru/projects/SDK/repos/yookassa-sdk-python/browse).  
+
+## Цель
+Заменить синхронный `requests` на асинхронный `httpx`, также переложить валидацию данных на `Pydantic`.
+
+## Реализовано на данный момент
+
+* Модели данных запроса и ответа платежа, а также необходимые для них модели.
+* Класс `Configuration`, для определения авторизации по апи.
+* Класс `Payment` с возможностью создать платёж.
+* Класс `APIClient` для выполнения запросов к API.
+
+
+## Требования
+
+1. Python >=3.12 (на момент разработки)
+2. pip
+
+## Установка
+### C помощью pip
+
+1. Установите pip.
+2. В консоли выполните команду
+```bash
+pip install --upgrade yookassa
+```
+
+## Начало работы
+
+1. Импортируйте модуль
+```python
+import async_yookassa
+```
+2. Установите данные для конфигурации
+```python
+from async_yookassa import Configuration
+
+Configuration.configure(account_id='<Идентификатор магазина>', secret_key='<Секретный ключ>')
+```
+
+или
+
+```python
+from async_yookassa import Configuration
+
+Configuration.account_id = '<Идентификатор магазина>'
+Configuration.secret_key = '<Секретный ключ>'
+```
+
+или через oauth
+
+```python
+from async_yookassa import Configuration
+
+Configuration.configure_auth_token(token='<Oauth Token>')
+```
+
+Если вы согласны участвовать в развитии SDK, вы можете передать данные о вашем фреймворке, cms или модуле:
+```python
+from async_yookassa import Configuration
+from async_yookassa.models.configuration_submodels.version_model import Version
+
+Configuration.configure('<Идентификатор магазина>', '<Секретный ключ>')
+Configuration.configure_user_agent(
+    framework=Version(name='Django', version='2.2.3'),
+    cms=Version(name='Wagtail', version='2.6.2'),
+    module=Version(name='Y.CMS', version='0.0.1')
+)
+```
+
+3. Вызовите нужный метод API. [Подробнее в документации к API ЮKassa](https://yookassa.ru/developers/api)

async_yookassa-0.1.0/async_yookassa/__init__.py

@@ -0,0 +1,7 @@
+from async_yookassa.configuration import Configuration
+from async_yookassa.payment import Payment
+
+__author__ = "Ivan Ashikhmin and YooMoney"
+__email__ = "sushkoos@gmail.com and cms@yoomoney.ru"
+__version__ = "0.1.0"
+__all__ = ["Configuration", "Payment"]

async_yookassa-0.1.0/async_yookassa/apiclient.py

@@ -0,0 +1,152 @@
+from base64 import b64encode
+from typing import Any
+
+from httpx import AsyncClient, AsyncHTTPTransport, Response
+
+from async_yookassa import Configuration
+from async_yookassa.exceptions.api_error import APIError
+from async_yookassa.exceptions.bad_request_error import BadRequestError
+from async_yookassa.exceptions.forbidden_error import ForbiddenError
+from async_yookassa.exceptions.not_found_error import NotFoundError
+from async_yookassa.exceptions.response_processing_error import ResponseProcessingError
+from async_yookassa.exceptions.too_many_request_error import TooManyRequestsError
+from async_yookassa.exceptions.unauthorized_error import UnauthorizedError
+from async_yookassa.models.payment_request_model import PaymentRequest
+from async_yookassa.models.user_agent_model import UserAgent
+
+
+class APIClient:
+    """
+    Класс клиента API.
+    """
+
+    def __init__(self):
+        self.configuration = Configuration.instantiate()
+        self.endpoint = Configuration.api_endpoint()
+        self.account_id = self.configuration.account_id
+        self.secret_key = self.configuration.secret_key
+        self.auth_token = self.configuration.auth_token
+        self.transport = AsyncHTTPTransport(retries=self.configuration.max_attempts)
+        self.async_client = AsyncClient(timeout=self.configuration.timeout, transport=self.transport)
+
+        self.user_agent = UserAgent()
+        if self.configuration.agent_framework:
+            self.user_agent.framework = self.configuration.agent_framework
+        if self.configuration.agent_cms:
+            self.user_agent.cms = self.configuration.agent_cms
+        if self.configuration.agent_module:
+            self.user_agent.module = self.configuration.agent_module
+
+    async def request(
+        self,
+        body: PaymentRequest | None = None,
+        method: str = "",
+        path: str = "",
+        query_params: dict[str, str] | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> dict[str, Any]:
+        """
+        Подготовка запроса.
+
+        :param method: HTTP метод
+        :param path: URL запроса
+        :param query_params: Словарь GET параметров запроса
+        :param headers: Словарь заголовков запроса
+        :param body: Тело запроса
+        :return: Ответ на запрос в формате JSON
+        """
+        if isinstance(body, PaymentRequest):
+            body = body.model_dump()
+
+        request_headers = self.prepare_request_headers(headers=headers)
+        raw_response = await self.execute(
+            body=body, method=method, path=path, query_params=query_params, request_headers=request_headers
+        )
+
+        if raw_response.status_code != 200:
+            self.__handle_error(raw_response=raw_response)
+
+        return raw_response.json()
+
+    async def execute(
+        self,
+        method: str,
+        path: str,
+        request_headers: dict[str, str],
+        query_params: dict[str, str] | None = None,
+        body: dict[str, Any] | None = None,
+    ) -> Response:
+        """
+        Выполнение запроса.
+
+        :param body: Тело запроса
+        :param method: HTTP метод
+        :param path: URL запроса
+        :param query_params: Массив GET параметров запроса
+        :param request_headers: Массив заголовков запроса
+        :return: Response
+        """
+        async with self.async_client as client:
+            # self.log_request(body, method, path, query_params, request_headers)
+
+            raw_response = await client.request(
+                method=method, url=self.endpoint + path, params=query_params, headers=request_headers, json=body
+            )
+
+            # self.log_response(raw_response.content, self.get_response_info(raw_response), raw_response.headers)
+
+        return raw_response
+
+    def prepare_request_headers(self, headers: dict[str, str]) -> dict[str, str]:
+        """
+        Подготовка заголовков запроса.
+
+        :param headers: Словарь заголовков запроса
+        :return: Словарь заголовков запроса
+        """
+        request_headers = {"Content-type": "application/json"}
+        if self.auth_token is not None:
+            auth_headers = {"Authorization": "Bearer " + self.auth_token}
+        else:
+            auth_headers = {"Authorization": self.basic_auth(self.account_id, self.secret_key)}
+
+        request_headers.update(auth_headers)
+
+        request_headers.update({"YM-User-Agent": self.user_agent.get_header_string()})
+
+        if isinstance(headers, dict):
+            request_headers.update(headers)
+        return request_headers
+
+    @staticmethod
+    def basic_auth(username: str, password: str) -> str:
+        """
+        Формирование токена для Basic авторизации.
+
+        :param username: Идентификатор аккаунта
+        :param password: Секретный ключ магазина
+        :return: Строка авторизации
+        """
+        token = b64encode(f"{username}:{password}".encode()).decode("ascii")
+        return f"Basic {token}"
+
+    @staticmethod
+    def __handle_error(raw_response):
+        """
+        Выбрасывает исключение по коду ошибки.
+        """
+        http_code = raw_response.status_code
+        if http_code == BadRequestError.HTTP_CODE:
+            raise BadRequestError(raw_response.json())
+        elif http_code == ForbiddenError.HTTP_CODE:
+            raise ForbiddenError(raw_response.json())
+        elif http_code == NotFoundError.HTTP_CODE:
+            raise NotFoundError(raw_response.json())
+        elif http_code == TooManyRequestsError.HTTP_CODE:
+            raise TooManyRequestsError(raw_response.json())
+        elif http_code == UnauthorizedError.HTTP_CODE:
+            raise UnauthorizedError(raw_response.json())
+        elif http_code == ResponseProcessingError.HTTP_CODE:
+            raise ResponseProcessingError(raw_response.json())
+        else:
+            raise APIError(raw_response.text)

async_yookassa-0.1.0/async_yookassa/configuration.py

@@ -0,0 +1,104 @@
+from dataclasses import dataclass
+from typing import Self
+
+from async_yookassa.exceptions.configuration_errors import ConfigurationError
+from async_yookassa.models.configuration_submodels.version_model import Version
+
+
+@dataclass
+class Configuration:
+    api_url: str = "https://api.yookassa.ru/v3"
+    account_id: str | None = None
+    secret_key: str | None = None
+    timeout: int = 1800
+    max_attempts: int = 3
+    auth_token: str | None = None
+    agent_framework: Version | None = None
+    agent_cms: Version | None = None
+    agent_module: Version | None = None
+
+    def __post_init__(self):
+        self.assert_has_api_credentials()
+
+    @classmethod
+    def configure(cls, account_id: str, secret_key: str, **kwargs) -> None:
+        """
+        Устанавливает настройки конфигурации для базовой авторизации.
+
+        :param account_id: Идентификатор магазина.
+        :param secret_key: Секретный ключ.
+        :param kwargs: Словарь с дополнительными параметрами.
+        """
+        cls.account_id = account_id
+        cls.secret_key = secret_key
+        cls.auth_token = None
+        cls.api_url = kwargs.get("api_url", cls.api_url)
+        cls.timeout = kwargs.get("timeout", cls.timeout)
+        cls.max_attempts = kwargs.get("max_attempts", cls.max_attempts)
+
+    @classmethod
+    def configure_auth_token(cls, token: str, **kwargs) -> None:
+        """
+        Устанавливает настройки конфигурации для авторизации по OAuth.
+
+        :param token: Ключ OAuth.
+        :param kwargs: Словарь с дополнительными параметрами.
+        """
+        cls.account_id = None
+        cls.secret_key = None
+        cls.auth_token = token
+        cls.api_url = kwargs.get("api_url", cls.api_url)
+        cls.timeout = kwargs.get("timeout", cls.timeout)
+        cls.max_attempts = kwargs.get("max_attempts", cls.max_attempts)
+
+    def configure_user_agent(
+        self, framework: Version | None = None, cms: Version | None = None, module: Version | None = None
+    ) -> None:
+        """
+        Устанавливает настройки конфигурации для User-Agent.
+
+        :param framework: Версия фреймворка.
+        :param cms: Версия CMS.
+        :param module: Версия модуля.
+        """
+        if isinstance(framework, Version):
+            self.agent_framework = framework
+        if isinstance(cms, Version):
+            self.agent_cms = cms
+        if isinstance(module, Version):
+            self.agent_module = module
+
+    @classmethod
+    def instantiate(cls) -> Self:
+        """
+        Получение объекта конфигурации.
+
+        :return: Объект конфигурации
+        """
+        return cls(
+            account_id=cls.account_id,
+            secret_key=cls.secret_key,
+            timeout=cls.timeout,
+            max_attempts=cls.max_attempts,
+            auth_token=cls.auth_token,
+            agent_framework=cls.agent_framework,
+            agent_cms=cls.agent_cms,
+            agent_module=cls.agent_module,
+            api_url=cls.api_url,
+        )
+
+    @staticmethod
+    def api_endpoint() -> str:
+        """Возвращает URL для API Кассы."""
+        return Configuration.api_url
+
+    def has_api_credentials(self) -> bool:
+        """Проверка наличия параметров базовой авторизации."""
+        return self.account_id is not None and self.secret_key is not None
+
+    def assert_has_api_credentials(self) -> None:
+        """Проверка наличия API параметров, выброс исключения ConfigurationError при ошибке."""
+        if self.auth_token is None and not self.has_api_credentials():
+            raise ConfigurationError("account_id and secret_key are required")
+        elif self.auth_token and self.has_api_credentials():
+            raise ConfigurationError("Could not configure authorization with both auth_token and basic auth")

async_yookassa-0.1.0/async_yookassa/enums/candellation_details_enums.py

@@ -0,0 +1,30 @@
+from enum import Enum
+
+
+class PartyEnum(str, Enum):
+    yoo_money = "yoo_money"
+    payment_network = "payment_network"
+    merchant = "merchant"
+
+
+class ReasonEnum(str, Enum):
+    three_d_secure_failed = "3d_secure_failed"
+    call_issuer = "call_issuer"
+    canceled_by_merchant = "canceled_by_merchant"
+    card_expired = "card_expired"
+    country_forbidden = "country_forbidden"
+    deal_expired = "deal_expired"
+    expired_on_capture = "expired_on_capture"
+    expired_on_confirmation = "expired_on_confirmation"
+    fraud_suspected = "fraud_suspected"
+    general_decline = "general_decline"
+    identification_required = "identification_required"
+    insufficient_funds = "insufficient_funds"
+    internal_timeout = "internal_timeout"
+    invalid_card_number = "invalid_card_number"
+    invalid_csc = "invalid_csc"
+    issuer_unavailable = "issuer_unavailable"
+    payment_method_limit_exceeded = "payment_method_limit_exceeded"
+    payment_method_restricted = "payment_method_restricted"
+    permission_revoked = "permission_revoked"
+    unsupported_mobile_operator = "unsupported_mobile_operator"

async_yookassa-0.1.0/async_yookassa/enums/card_enums.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class CardTypeEnum(str, Enum):
+    MasterCard = "MasterCard"
+    Visa = "Visa"
+    Mir = "Mir"
+    UnionPay = "UnionPay"
+    JCB = "JCB"
+    AmericanExpress = "AmericanExpress"
+    DinersClub = "DinersClub"
+    DiscoverCard = "DiscoverCard"
+    InstaPayment = "InstaPayment"
+    InstaPaymentTM = "InstaPaymentTM"
+    Laser = "Laser"
+    Dankort = "Dankort"
+    Solo = "Solo"
+    Switch = "Switch"
+    Unknown = "Unknown"
+
+
+class SourceEnum(str, Enum):
+    mir_pay = "mir_pay"
+    apple_pay = "apple_pay"
+    google_pay = "google_pay"

async_yookassa-0.1.0/async_yookassa/enums/confirmation_enums.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class ConfirmationTypeEnum(str, Enum):
+    embedded = "embedded"
+    external = "external"
+    mobile_application = "mobile_application"
+    qr = "qr"
+    redirect = "redirect"

async_yookassa-0.1.0/async_yookassa/enums/fiscalization_enums.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+
+class FiscalizationProviderEnum(str, Enum):
+    fns = "fns"
+    avanpost = "avanpost"
+    a_qsi = "a_qsi"
+    atol = "atol"
+    business_ru = "business_ru"
+    evotor = "evotor"
+    first_ofd = "first_ofd"
+    kit_invest = "kit_invest"
+    life_pay = "life_pay"
+    mertrade = "mertrade"
+    modul_kassa = "modul_kassa"
+    rocket = "rocket"
+    shtrih_m = "shtrih_m"

async_yookassa-0.1.0/async_yookassa/enums/me_enums.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class MeStatusEnum(str, Enum):
+    enabled = "enabled"
+    disabled = "disabled"
+
+
+class PayoutMethodsEnum(str, Enum):
+    bank_card = "bank_card"
+    yoo_money = "yoo_money"
+    sbp = "sbp"

async_yookassa-0.1.0/async_yookassa/enums/payment_method_data_enums.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class PaymentMethodDataTypeEnum(str, Enum):
+    sber_loan = "sber_loan"
+    mobile_balance = "mobile_balance"
+    bank_card = "bank_card"
+    cash = "cash"
+    sbp = "sbp"
+    b2b_sberbank = "b2b_sberbank"
+    electronic_certificate = "electronic_certificate"
+    yoo_money = "yoo_money"
+    sberbank = "sberbank"
+    tinkoff_bank = "tinkoff_bank"

async_yookassa-0.1.0/async_yookassa/enums/payment_method_enums.py

@@ -0,0 +1,21 @@
+from enum import Enum
+
+
+class PaymentMethodTypeEnum(str, Enum):
+    sber_loan = "sber_loan"
+    alfabank = "alfabank"
+    mobile_balance = "mobile_balance"
+    bank_card = "bank_card"
+    installments = "installments"
+    cash = "cash"
+    sbp = "sbp"
+    b2b_sberbank = "b2b_sberbank"
+    electronic_certificate = "electronic_certificate"
+    yoo_money = "yoo_money"
+    apple_pay = "apple_pay"
+    google_pay = "google_pay"
+    qiwi = "qiwi"
+    sberbank = "sberbank"
+    tinkoff_bank = "tinkoff_bank"
+    wechat = "wechat"
+    webmoney = "webmoney"

async_yookassa-0.1.0/async_yookassa/enums/payment_response_enums.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class PaymentResponseStatusEnum(str, Enum):
+    pending = "pending"
+    waiting_for_capture = "waiting_for_capture"
+    succeeded = "succeeded"
+    canceled = "canceled"
+
+
+class ReceiptRegistrationEnum(str, Enum):
+    pending = "pending"
+    succeeded = "succeeded"
+    canceled = "canceled"

async_yookassa-0.1.0/async_yookassa/enums/receiver_enums.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class ReceiverTypeEnum(str, Enum):
+    bank_account = "bank_account"
+    mobile_balance = "mobile_balance"
+    digital_wallet = "digital_wallet"

async_yookassa-0.1.0/async_yookassa/enums/transfers_enums.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class TransferStatusEnum(str, Enum):
+    pending = "pending"
+    waiting_for_capture = "waiting_for_capture"
+    succeeded = "succeeded"
+    canceled = "canceled"

async_yookassa-0.1.0/async_yookassa/enums/vat_data_enums.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class VatDataTypeEnum(str, Enum):
+    untaxed = "untaxed"
+    calculated = "calculated"
+    mixed = "mixed"
+
+
+class RateEnum(str, Enum):
+    seven = "7"
+    ten = "10"
+    eighteen = "18"
+    twenty = "20"

async_yookassa-0.1.0/async_yookassa/exceptions/api_error.py

@@ -0,0 +1,6 @@
+class APIError(Exception):
+    """
+    Неожиданный код ошибки.
+    """
+
+    pass

async_yookassa-0.1.0/async_yookassa/exceptions/authorize_error.py

@@ -0,0 +1,9 @@
+from async_yookassa.exceptions.api_error import APIError
+
+
+class AuthorizeError(APIError):
+    """
+    Ошибка авторизации. Не установлен заголовок.
+    """
+
+    pass

async_yookassa-0.1.0/async_yookassa/exceptions/bad_request_error.py

@@ -0,0 +1,9 @@
+from async_yookassa.exceptions.api_error import APIError
+
+
+class BadRequestError(APIError):
+    """
+    Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API.
+    """
+
+    HTTP_CODE = 400