payme-pkg 2.6.5__py3-none-any.whl → 3.0.17__py3-none-any.whl

payme_pkg-3.0.17.dist-info/METADATA

@@ -0,0 +1,193 @@
+Metadata-Version: 2.1
+Name: payme-pkg
+Version: 3.0.17
+Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
+Author: Muhammadali Akbarov
+Author-email: muhammadali17abc@gmail.com
+License: MIT
+Keywords: paymeuz paycomuz payme-merchant merchant-api subscribe-api payme-pkg payme-api
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: requests (==2.*)
+Requires-Dist: djangorestframework (==3.*)
+Requires-Dist: dataclasses (==0.*) ; python_version < "3.7"
+
+<h1 align="center">Payme Software Development Kit</h1>
+
+<p align="center">
+  <a href="https://t.me/+lO97J78xBj45MzBi">
+    <img src="https://img.shields.io/badge/Support%20Group-blue?logo=telegram&logoColor=white" alt="Support Group on Telegram"/>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://docs.pay-tech.uz"><img src="https://img.shields.io/static/v1?message=Documentation&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="https://github.com/PayTechUz/payme-pkg"><img src="https://img.shields.io/badge/Open_Source-❤️-FDA599?"/></a>
+  <a href="https://github.com/PayTechUz/payme-pkg/issues">
+    <img src="https://img.shields.io/github/issues/PayTechUz/payme-pkg" />
+  </a>
+  <a href="https://pepy.tech/project/payme-pkg">
+    <img src="https://static.pepy.tech/badge/payme-pkg" alt="PyPI - Downloads" />
+  </a>
+</p>
+
+<p align="center">Welcome to payme-pkg, the open source payme SDK for Python.</p>
+
+<p align="center">You can use it for test and production mode. Join our community and ask everything you need.</p>
+
+<a href="https://docs.pay-tech.uz">
+  <p align="center">Visit the full documentation for Merchant and Subscribe API</p>
+</a>
+
+<a href="https://youtu.be/xxiIggu_RNk?si=Idpg8omFvFDCYtcm" target="_blank">
+  <p align="center">
+    <img style="width: 60%;" src="https://i.postimg.cc/WbD32bHC/payme-pkg-demo-m4a.gif" alt="Payme PKG Demo">
+  </p>
+</a>
+
+<p align="center">
+  <a href="https://youtu.be/7q7-c72tHpc?si=Sr0EAmEawWAFRk1m" target="_blank">
+    <img src="https://img.shields.io/badge/Watch%20Demo-red?logo=youtube&logoColor=white&style=for-the-badge" 
+         alt="Watch the YouTube Demo" 
+         style="width: 150px; height: 30px; border-radius: 7px;" />
+  </a>
+</p>
+
+
+## Installation
+
+```shell
+pip install payme-pkg
+```
+
+## Installation to Django
+
+Add `'payme'` in to your settings.py
+
+```python
+INSTALLED_APPS = [
+    ...
+    'payme',
+    ...
+]
+```
+
+Add `'payme'` credentials inside to settings.py
+
+One time payment (Однаразовый платеж) configuration settings.py
+
+Example project: https://github.com/PayTechUz/shop-backend
+```python
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "order_id"
+PAYME_AMOUNT_FIELD = "total_amount"
+PAYME_ACCOUNT_MODEL = "orders.models.Orders"
+PAYME_ONE_TIME_PAYMENT = True
+```
+
+Multi payment (Накопительный) configuration settings.py
+
+Example project: Coming soon
+```python
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "id"
+PAYME_ACCOUNT_MODEL = "clients.models.Client"
+PAYME_ONE_TIME_PAYMENT = False
+```
+
+Create a new View that about handling call backs
+```python
+from payme.views import PaymeWebHookAPIView
+
+
+class PaymeCallBackAPIView(PaymeWebHookAPIView):
+    def handle_created_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction created for this params: {params} and cr_result: {result}")
+
+    def handle_successfully_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction successfully performed for this params: {params} and performed_result: {result}")
+
+    def handle_cancelled_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the cancelled payment. You can override this method
+        """
+        print(f"Transaction cancelled for this params: {params} and cancelled_result: {result}")
+```
+
+Add a `payme` path to core of urlpatterns:
+
+```python
+from django.urls import path
+from django.urls import include
+
+from your_app.views import PaymeCallBackAPIView
+
+urlpatterns = [
+    ...
+    path("payment/update/", PaymeCallBackAPIView.as_view()),
+    ...
+]
+```
+
+Run migrations
+```shell
+python3 manage.py makemigrations && python manage.py migrate
+```
+🎉 Congratulations you have been integrated merchant api methods with django, keep reading docs. After successfull migrations check your admin panel and see results what happened.
+
+## Generate Pay Link
+
+Example to generate link:
+
+- Input
+
+```python
+from payme import Payme
+
+payme = Payme(payme_id="your-payme-id")
+pay_link = payme.initializer.generate_pay_link(id=123456, amount=5000, return_url="https://example.com")
+print(pay_link)
+```
+
+- Output
+
+```
+https://checkout.paycom.uz/bT15b3VyLXBheW1lLWlkO2FjLmlkPTEyMzQ1NjthPTUwMDAwMDtjPWh0dHBzOi8vZXhhbXBsZS5jb20=
+```
+
+
+## Generate Fallback Link
+
+
+Example to generate fallback link:
+
+- Input
+
+The ID in the fallback is different from the merchant ID. You can get the ID from the Payme team.
+```python
+from payme import Payme
+
+payme = Payme(payme_id="your-payme-id", fallback_id="your-fallback-id")
+
+form_fields = {
+    "driver_id": 12345,
+    "amount": 1000
+}
+
+fallback_link = payme.initializer.generate_fallback_link(form_fields) # form field is optional
+print(fallback_link)
+```
+
+- Output
+
+```
+https://payme.uz/fallback/merchant/?id=examplelinkgenerated&driver_id=12345&amount=1000
+```

payme_pkg-3.0.17.dist-info/RECORD

@@ -0,0 +1,29 @@
+payme/__init__.py,sha256=dzLIyA9kQl0sO6z9nHkZDTjkfiI1BepdifKtJbjX2Cw,46
+payme/admin.py,sha256=67uHZiZe2w2s0TE23PS2v-V3xXRaha6o9acjVmNIQbM,470
+payme/apps.py,sha256=HHCY4zUNKPcjz25z0MahZcks0lsAxTGPS0Ml3U4DhZc,142
+payme/const.py,sha256=azndfKR53fe7mDfGW82Q-kwWdMu3x4S1upKc4gkYdlA,214
+payme/models.py,sha256=mT6sIeDOs-pKZ_b8Y9oafHBv5GruioJkpTqTGZ8AulA,4360
+payme/urls.py,sha256=_oUOwxW1Suc5TUmnj--lySYbotRg4yTDkDLJU20CGjE,145
+payme/util.py,sha256=UFb4cEnaufS_hh9C_0z079CSgJGivYjIgOl2iAFrBMs,625
+payme/views.py,sha256=A5_GxSFS1Hif2W1LAGP5YfnGazdaaqLXgFLEy2z0A7k,11928
+payme/classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/classes/cards.py,sha256=dr3SQdKAhfQmECtwHYW2nmx8wXaNYQFkg5uQU9z8vs4,7624
+payme/classes/client.py,sha256=_eMcSTiwMdwIe0aeccVav-43Uq7ORdH7idOuSTPjpcg,837
+payme/classes/http.py,sha256=KoEbjbeNCUCeCo2R36FH3SfDlyrZTU9OjiSmRA-dVms,3411
+payme/classes/initializer.py,sha256=FvzKp068JfSzHwcQ_w-eXYTomV5ggz7_p5zYBkAtBI4,2326
+payme/classes/receipts.py,sha256=KU4qyGHWZpWW88SjmmTD_N2Tz8pWOCvBbOPnw5tcS3Y,10094
+payme/exceptions/__init__.py,sha256=HoBFnDA3eW_xWZiFlonJK4vhBDTsuik91tvgzXTy8KA,94
+payme/exceptions/general.py,sha256=quy9TRv0HCUjP5EfplHyoLXuAGbrRnPveHeQZmBlHa8,7655
+payme/exceptions/webhook.py,sha256=f0J-fmCW_wpgsTmjGAOtyoZjIOoFpbQwkh_7cZUZkv0,3046
+payme/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/types/request/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/types/response/__init__.py,sha256=GAj5pjZ9oIO67T6YMiPd1fhTIvGrPfTv96tykfeChQc,81
+payme/types/response/cards.py,sha256=ilXFDUOPNabVsrQN1KWEzDiL6cDxdVvCbfEl6jCzGpU,1997
+payme/types/response/receipts.py,sha256=TlZeJyymRVHIorg0kbUaogy6MZxN1oq2jHGVRUnlY5A,4070
+payme/types/response/webhook.py,sha256=Br6Gr_-h7sCmOc3ag7H5yBryB8j-bm2mrt39Cy_Fy2E,2918
+payme_pkg-3.0.17.dist-info/LICENSE.txt,sha256=75dBVYmbzWUhwtaB1MSZfj-M-PGaMmeT9UVPli2-ZJ0,1086
+payme_pkg-3.0.17.dist-info/METADATA,sha256=dwjIyS9BH5OHbiivwBoOwZ90OTJwWt0hBMsr5QmwvuU,5534
+payme_pkg-3.0.17.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+payme_pkg-3.0.17.dist-info/top_level.txt,sha256=8mN-hGAa38pWbhrKHFs9CZywPCdidhMuwPKwuFJa0qw,6
+payme_pkg-3.0.17.dist-info/RECORD,,

{payme_pkg-2.6.5.dist-info → payme_pkg-3.0.17.dist-info}/WHEEL

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

payme/cards/__init__.py

@@ -1 +0,0 @@
-from . import subscribe_cards

payme/cards/subscribe_cards.py

@@ -1,166 +0,0 @@
-from ..decorators.decorators import payme_request
-from ..utils.to_json import to_json
-
-
-class PaymeSubscribeCards:
-    """
-    The PaymeSubscribeCards class includes
-    all paycom methods which are belongs to cards.
-
-    Parameters
-    ----------
-    base_url: str — The base url of the paycom api
-    paycom_id: str — The paycom_id uses to identify
-    timeout: int — How many seconds to wait for the server to send data
-
-    Full method documentation
-    -------------------------
-    https://developer.help.paycom.uz/metody-subscribe-api/
-    """
-    def __init__(
-        self,
-        base_url: str,
-        paycom_id: str,
-        timeout=5
-    ) -> "PaymeSubscribeCards":
-        self.base_url: str = base_url
-        self.timeout: int = timeout
-        self.headers: dict = {
-            "X-Auth": paycom_id,
-        }
-        self.__methods: dict = {
-            "cards_check": "cards.check",
-            "cards_create": "cards.create",
-            "cards_remove": "cards.remove",
-            "cards_verify": "cards.verify",
-            "cards_get_verify_code": "cards.get_verify_code",
-        }
-
-    @payme_request
-    def __request(self, data) -> dict:
-        """
-        Use this private method to request.
-        On success,response will be OK with format JSON.
-
-        Parameters
-        ----------
-        data: dict — Includes request data.
-
-        Returns dictionary Payme Response
-        ---------------------------------
-        """
-        return data
-
-    def cards_create(self, number: str, expire: str, save: bool = True) -> dict:
-        """
-        Use this method to create a new card's token.
-
-        Parameters
-        ----------
-        number: str — The card number maximum length 18 char
-        expire: str — The card expiration string maximum length 5 char
-        save: bool \
-            Type of token. Optional parameter
-            The option is enabled or disabled depending on the application's business logic
-            If the flag is true, the token can be used for further payments
-            if the flag is false the token can only be used once
-            The one-time token is deleted after payment
-
-        Full method documentation
-        -------------------------
-        https://developer.help.paycom.uz/metody-subscribe-api/cards.create
-        """
-        data: dict = {
-            "method": self.__methods.get("cards_create"),
-            "params": {
-                "card": {
-                    "number": number,
-                    "expire": expire,
-                },
-                "save": save,
-            }
-        }
-        return self.__request(to_json(**data))
-
-    def card_get_verify_code(self, token: str) -> dict:
-        """
-        Use this method to get the verification code.
-
-        Parameters
-        ----------
-        token: str — The card's non-active token
-
-        Full method documentation
-        -------------------------
-        https://developer.help.paycom.uz/metody-subscribe-api/cards.get_verify_code
-        """
-        data: dict = {
-            "method": self.__methods.get('cards_get_verify_code'),
-            "params": {
-                "token": token,
-            }
-        }
-        return self.__request(to_json(**data))
-
-    def cards_verify(self, verify_code: str, token: str) -> dict:
-        """
-        Verification of the card using the code sent via SMS.
-
-        Parameters
-        ----------
-        verify_code: str — Code for verification
-        token: str — The card's non-active token
-
-        Full method documentation
-        -------------------------
-        https://developer.help.paycom.uz/metody-subscribe-api/cards.verify
-        """
-        data: dict = {
-            "method": self.__methods.get("cards_verify"),
-            "params": {
-                "token": token,
-                "code": verify_code
-            }
-        }
-        return self.__request(to_json(**data))
-
-    def cards_check(self, token: str) -> dict:
-        """
-        Checking the card token active or non-active.
-
-        Parameters
-        ----------
-        token: str — The card's non-active token
-
-        Full method documentation
-        -------------------------
-        https://developer.help.paycom.uz/metody-subscribe-api/cards.check
-        """
-        data: dict = {
-            "method": self.__methods.get("cards_check"),
-            "params": {
-                "token": token,
-            }
-        }
-
-        return self.__request(to_json(**data))
-
-    def cards_remove(self, token: str) -> dict:
-        """
-        Delete card's token on success returns success.
-
-        Parameters
-        ----------
-        token: str — The card's non-active token
-
-        Full method documentation
-        -------------------------
-        https://developer.help.paycom.uz/metody-subscribe-api/cards.remove
-        """
-        data: dict = {
-            "method": self.__methods.get("cards_remove"),
-            "params": {
-                "token": token,
-            }
-        }
-        return self.__request(to_json(**data))

payme/decorators/decorators.py

@@ -1,34 +0,0 @@
-import functools
-
-from requests import request
-from requests.exceptions import Timeout
-from requests.exceptions import RequestException
-
-from ..utils.logging import logger
-
-from ..errors.exceptions import PaymeTimeoutException
-
-
-def payme_request(func):
-    """
-    Payme request decorator.
-    """
-    @functools.wraps(func)
-    def wrapper(self, data):
-        response = None
-        req_data = {
-            "method": "POST",
-            "url": self.base_url,
-            "data": data,
-            "headers": self.headers,
-            "timeout": self.timeout,
-        }
-        try:
-            response = request(**req_data)
-            response.raise_for_status()
-        except (Timeout, RequestException) as error:
-            logger.info("Payme request has been failed as error: %s", error)
-            raise PaymeTimeoutException() from error
-        return response.json()
-
-    return wrapper

payme/errors/exceptions.py

@@ -1,89 +0,0 @@
-from rest_framework.exceptions import APIException
-
-
-class BasePaymeException(APIException):
-    """
-    BasePaymeException it's APIException.
-    """
-    status_code = 200
-    error_code = None
-    message = None
-
-    # pylint: disable=super-init-not-called
-    def __init__(self, error_message: str = None):
-        detail: dict = {
-            "error": {
-                "code": self.error_code,
-                "message": self.message,
-                "data": error_message
-            }
-        }
-        self.detail = detail
-
-
-class PermissionDenied(BasePaymeException):
-    """
-    PermissionDenied APIException \
-        That is raised when the client is not allowed to server.
-    """
-    status_code = 200
-    error_code = -32504
-    message = "Permission denied"
-
-
-class MethodNotFound(BasePaymeException):
-    """
-    MethodNotFound APIException \
-        That is raised when the method does not exist.
-    """
-    status_code = 405
-    error_code = -32601
-    message = 'Method not found'
-
-
-class TooManyRequests(BasePaymeException):
-    """
-    TooManyRequests APIException \
-        That is raised when the request exceeds the limit.
-    """
-    status_code = 200
-    error_code = -31099
-    message = {
-        "uz": "Buyurtma tolovni amalga oshirish jarayonida",
-        "ru": "Транзакция в очереди",
-        "en": "Order payment status is queued"
-    }
-
-
-class IncorrectAmount(BasePaymeException):
-    """
-    IncorrectAmount APIException \
-        That is raised when the amount is not incorrect.
-    """
-    status_code = 200
-    error_code = -31001
-    message = {
-        'ru': 'Неверная сумма',
-        'uz': "Noto'g'ri qiymat",
-        'en': 'Incorrect amount',
-    }
-
-
-class PerformTransactionDoesNotExist(BasePaymeException):
-    """
-    PerformTransactionDoesNotExist APIException \
-        That is raised when a transaction does not exist or deleted.
-    """
-    status_code = 200
-    error_code = -31050
-    message = {
-        "uz": "Buyurtma topilmadi",
-        "ru": "Заказ не существует",
-        "en": "Order does not exists"
-    }
-
-
-class PaymeTimeoutException(Exception):
-    """
-    Payme timeout exception that means that payme is working slowly.
-    """

payme/methods/cancel_transaction.py

@@ -1,54 +0,0 @@
-import time
-
-from django.db import transaction
-
-from payme.utils.logging import logger
-from payme.models import MerchantTransactionsModel
-from payme.errors.exceptions import PerformTransactionDoesNotExist
-from payme.serializers import MerchantTransactionsModelSerializer as MTMS
-
-
-class CancelTransaction:
-    """
-    CancelTransaction class
-    That is used to cancel a transaction.
-
-    Full method documentation
-    -------------------------
-    https://developer.help.paycom.uz/metody-merchant-api/canceltransaction
-    """
-
-    @transaction.atomic
-    def __call__(self, params: dict):
-        clean_data: dict = MTMS.get_validated_data(
-            params=params
-        )
-        try:
-            with transaction.atomic():
-                transactions: MerchantTransactionsModel = \
-                    MerchantTransactionsModel.objects.filter(
-                        _id=clean_data.get('_id'),
-                    ).first()
-                if transactions.cancel_time == 0:
-                    transactions.cancel_time = int(time.time() * 1000)
-                if transactions.perform_time == 0:
-                    transactions.state = -1
-                if transactions.perform_time != 0:
-                    transactions.state = -2
-                transactions.reason = clean_data.get("reason")
-                transactions.save()
-
-        except PerformTransactionDoesNotExist as error:
-            logger.error("Paycom transaction does not exist: %s", error)
-            raise PerformTransactionDoesNotExist() from error
-
-        response: dict = {
-            "result": {
-                "state": transactions.state,
-                "cancel_time": transactions.cancel_time,
-                "transaction": transactions.transaction_id,
-                "reason": int(transactions.reason),
-            }
-        }
-
-        return transactions.order_id, response

payme/methods/check_perform_transaction.py

@@ -1,26 +0,0 @@
-from payme.utils.get_params import get_params
-from payme.serializers import MerchantTransactionsModelSerializer
-
-
-class CheckPerformTransaction:
-    """
-    CheckPerformTransaction class
-    That's used to check perform transaction.
-
-    Full method documentation
-    -------------------------
-    https://developer.help.paycom.uz/metody-merchant-api/checktransaction
-    """
-    def __call__(self, params: dict) -> tuple:
-        serializer = MerchantTransactionsModelSerializer(
-            data=get_params(params)
-        )
-        serializer.is_valid(raise_exception=True)
-
-        response = {
-            "result": {
-                "allow": True,
-                }
-            }
-
-        return None, response

payme/methods/check_transaction.py

@@ -1,43 +0,0 @@
-from django.db import DatabaseError
-
-from payme.utils.logging import logger
-from payme.models import MerchantTransactionsModel
-from payme.serializers import MerchantTransactionsModelSerializer as MTMS
-
-
-class CheckTransaction:
-    """
-    CheckTransaction class
-    That's used to check transaction
-
-    Full method documentation
-    -------------------------
-    https://developer.help.paycom.uz/metody-merchant-api/checkperformtransaction
-    """
-    def __call__(self, params: dict) -> tuple:
-        clean_data: dict = MTMS.get_validated_data(
-            params=params
-        )
-
-        try:
-            transaction = \
-                MerchantTransactionsModel.objects.get(
-                    _id=clean_data.get("_id"),
-                )
-            response = {
-                "result": {
-                    "create_time": int(transaction.created_at_ms),
-                    "perform_time": transaction.perform_time,
-                    "cancel_time": transaction.cancel_time,
-                    "transaction": transaction.transaction_id,
-                    "state": transaction.state,
-                    "reason": None,
-                }
-            }
-            if transaction.reason is not None:
-                response["result"]["reason"] = int(transaction.reason)
-
-        except DatabaseError as error:
-            logger.error("Error getting transaction in database: %s", error)
-
-        return None, response