python-rucaptcha 5.3__tar.gz → 6.0__tar.gz

{python-rucaptcha-5.3 → python-rucaptcha-6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-rucaptcha
-Version: 5.3
+Version: 6.0
 Summary: Python 3.7+ RuCaptcha library with AIO module.
 Home-page: https://andreidrang.github.io/python-rucaptcha/
 Author: AndreiDrang, redV0ID
@@ -39,28 +39,38 @@ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-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: Programming Language :: Python :: 3.12
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: AsyncIO
 Classifier: Operating System :: Unix
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
-Requires-Python: >=3.7.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: msgspec==0.18.*
+Requires-Dist: tenacity==8.2.*
 
 
 # python-rucaptcha
 
 
-![](https://github.com/AndreiDrang/python-rucaptcha/blob/master/files/RuCaptcha.png)
+![](files/RuCaptchaHigh.png)
+
+<a href="https://dashboard.capsolver.com/passport/register?inviteCode=kQTn-tG07Jb1">
+    <img src="https://cdn.discordapp.com/attachments/1105172394655625306/1105180101802471575/20221207-160749.gif" alt="Capsolver's Banner">
+</a>
+<br>
+At the lowest price on the market, you may receive a variety of solutions, including reCAPTCHA V2, reCAPTCHA V3, hCaptcha, hCaptcha Click, FunCaptcha, picture-to-text, and more. With this service, 0.1s is the slowest speed ever measured.
+<hr>
 
 [![PyPI version](https://badge.fury.io/py/python-rucaptcha.svg)](https://badge.fury.io/py/python-rucaptcha)
 [![Python versions](https://img.shields.io/pypi/pyversions/python-rucaptcha.svg?logo=python&logoColor=FBE072)](https://badge.fury.io/py/python-rucaptcha)
-[![Downloads](https://pepy.tech/badge/python-rucaptcha/month)](https://pepy.tech/project/python-rucaptcha)
+[![Downloads](https://static.pepy.tech/badge/python-rucaptcha/month)](https://pepy.tech/project/python-rucaptcha)
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/aec93bb04a277cf0dde9/maintainability)](https://codeclimate.com/github/AndreiDrang/python-rucaptcha/maintainability)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/b4087362bd024b088b358b3e10e7a62f)](https://www.codacy.com/gh/AndreiDrang/python-rucaptcha/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=AndreiDrang/python-rucaptcha&amp;utm_campaign=Badge_Grade)
@@ -111,12 +121,14 @@ Is described in the [documentation-website](https://andreidrang.github.io/python
 
 ### Changelog
 
+For full changelog info check - [Releases page](https://github.com/AndreiDrang/python-rucaptcha/releases).
+
+- v.6.0 - Library refactoring. Stop using `pydantic`, start using `msgspec`. Move to API v2. Drop Python 3.8 support. More details at [Releases page](https://github.com/AndreiDrang/python-rucaptcha/releases). 
 - v.5.3 - Added support for [Death By Captcha](https://www.deathbycaptcha.com?refid=1237267242) and other services by changing `service_type` and `url_request` \ `url_response` parameters.
 - v.5.2 - Added Audio captcha method.
 - v.5.1 - Check [releases page](https://github.com/AndreiDrang/python-rucaptcha/releases).
 - v.5.0 - Added AmazonWAF captcha method.
 - v.4.2 - Added [Yandex Smart Captcha](https://rucaptcha.com/api-rucaptcha#yandex).
-- v.4.0 - Rework classes and methods. Adding `TikTok` captcha. Adding inheritance and serializers. The `Callback server` is deprecated.
 
 ### Get API Key to work with the library
 1. On the page - https://rucaptcha.com/enterpage

python-rucaptcha-6.0/python_rucaptcha/__version__.py

@@ -0,0 +1 @@
+__version__ = "6.0"

python-rucaptcha-6.0/python_rucaptcha/amazon_waf.py

@@ -0,0 +1,114 @@
+from typing import Union
+
+from .core.base import BaseCaptcha
+from .core.enums import AmazonWAFCaptchaEnm
+
+
+class AmazonWAF(BaseCaptcha):
+    def __init__(
+        self,
+        websiteURL: str,
+        websiteKey: str,
+        iv: str,
+        context: str,
+        method: Union[str, AmazonWAFCaptchaEnm] = AmazonWAFCaptchaEnm.AmazonTaskProxyless,
+        *args,
+        **kwargs,
+    ):
+        """
+        The class is used to work with Amazon WAF
+
+        Args:
+            rucaptcha_key: User API key
+            websiteURL: Full URL of the captcha page
+            websiteKey: Key value from the page
+            iv: Value iv from the page
+            context: Value of context from page
+            method: Captcha type
+
+        Examples:
+            >>> AmazonWAF(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...           websiteURL="https://page-with-waf.com/",
+            ...           websiteKey="some-site-key",
+            ...           iv="some-iv-value",
+            ...           context="some-context-value").captcha_handler()
+            {
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captcha_voucher":"eyJ0eXAiO...oQjTnJlBvAW4",
+                  "existing_token":"f8ab5749-f916-...5D8yAA39JtKVbw="
+               },
+               "cost":"0.00145",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":0,
+               "taskId": 73243152973,
+            }
+
+            >>> AmazonWAF(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...           websiteURL="https://page-with-waf.com/",
+            ...           websiteKey="some-site-key",
+            ...           iv="some-iv-value",
+            ...           context="some-context-value").aio_captcha_handler()
+            {
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captcha_voucher":"eyJ0eXAiO...oQjTnJlBvAW4",
+                  "existing_token":"f8ab5749-f916-...5D8yAA39JtKVbw="
+               },
+               "cost":"0.00145",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":0,
+               "taskId": 73243152973,
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://rucaptcha.com/api-docs/amazon-aws-waf-captcha
+        """
+        super().__init__(method=method, *args, **kwargs)
+
+        # check user params
+        if method not in AmazonWAFCaptchaEnm.list_values():
+            raise ValueError(f"Invalid method parameter set, available - {AmazonWAFCaptchaEnm.list_values()}")
+        # insert `gt` param to payload
+        self.create_task_payload["task"].update(
+            {
+                "websiteURL": websiteURL,
+                "websiteKey": websiteKey,
+                "iv": iv,
+                "context": context,
+            }
+        )
+
+    def captcha_handler(self, **kwargs) -> dict:
+        """
+        Synchronous method for captcha solving
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+
+        return self._processing_response(**kwargs)
+
+    async def aio_captcha_handler(self) -> dict:
+        """
+        Asynchronous method for captcha solving
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+        return await self._aio_processing_response()

python-rucaptcha-6.0/python_rucaptcha/audio_captcha.py

@@ -0,0 +1,161 @@
+import shutil
+from typing import Union, Optional
+
+from .core.base import BaseCaptcha
+from .core.enums import SaveFormatsEnm, AudioCaptchaEnm
+from .core.serializer import GetTaskResultResponseSer
+
+
+class AudioCaptcha(BaseCaptcha):
+    def __init__(
+        self,
+        save_format: Union[str, SaveFormatsEnm] = SaveFormatsEnm.TEMP,
+        audio_clearing: bool = True,
+        audio_path: str = "PythonRuCaptchaAudio",
+        lang: str = "en",
+        *args,
+        **kwargs,
+    ):
+        """
+        The class is used to work with Text Captcha.
+
+        Args:
+            rucaptcha_key: User API key
+            save_format: The format in which the file will be saved, or as a temporary file - 'temp',
+                                 or as a regular file to a folder created by the library - 'const'.
+            audio_clearing: True - delete file after solution, False - don't delete file after solution
+            audio_path: Folder to save captcha audio
+            lang: Captcha audio lang: `en`, `fr`, `de`, `el`, `pt`, `ru`
+
+        Examples:
+            >>> AudioCaptcha(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...             lang='en'
+            ...             ).captcha_handler(captcha_file='examples/mediacaptcha_audio/recaptcha_55914.mp3')
+            {
+                'captchaSolve': 'five five nine one four',
+                'taskId': 73243152973,
+                'error': False,
+                'errorBody': None
+            }
+
+            >>> with open("src/examples/mediacaptcha_audio/recaptcha_55914.mp3", "rb") as f:
+            ...     file_data = f.read()
+            >>> AudioCaptcha(rucaptcha_key="aa9011f31111181111168611f1151122"
+            ...             ).captcha_handler(captcha_base64=file_data)
+            {
+                'captchaSolve': 'five five nine one four',
+                'taskId': 73243152973,
+                'error': False,
+                'errorBody': None
+            }
+
+            >>> await AudioCaptcha(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...             lang='en'
+            ...             ).aio_captcha_handler(captcha_file='examples/mediacaptcha_audio/recaptcha_55914.mp3')
+            {
+                'captchaSolve': 'five five nine one four',
+                'taskId': 73243152973,
+                'error': False,
+                'errorBody': None
+            }
+
+            >>> with open("src/examples/mediacaptcha_audio/recaptcha_55914.mp3", "rb") as f:
+            ...     file_data = f.read()
+            >>> await AudioCaptcha(rucaptcha_key="aa9011f31111181111168611f1151122"
+            ...             ).aio_captcha_handler(captcha_base64=file_data)
+            {
+                'captchaSolve': 'five five nine one four',
+                'taskId': 73243152973,
+                'error': False,
+                'errorBody': None
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://rucaptcha.com/api-docs/audio
+        """
+
+        super().__init__(method=AudioCaptchaEnm.AudioTask.value, *args, **kwargs)
+        self.save_format = save_format
+        self.audio_clearing = audio_clearing
+        self.audio_path = audio_path
+        self.result = GetTaskResultResponseSer()
+
+        self.create_task_payload["task"].update({"lang": lang})
+
+    def captcha_handler(
+        self,
+        captcha_link: Optional[str] = None,
+        captcha_file: Optional[str] = None,
+        captcha_base64: Optional[bytes] = None,
+        **kwargs,
+    ) -> dict:
+        """
+        Synchronous method for captcha solving
+
+        Args:
+            captcha_link: Captcha file URL
+            captcha_file: Captcha file path
+            captcha_base64: Captcha file BASE64 info
+            kwargs: additional params for `requests` library
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+
+        self._body_file_processing(
+            save_format=self.save_format,
+            file_path=self.audio_path,
+            file_extension="mp3",
+            captcha_link=captcha_link,
+            captcha_file=captcha_file,
+            captcha_base64=captcha_base64,
+            **kwargs,
+        )
+        if not self.result.errorId:
+            return self._processing_response(**kwargs)
+        return self.result.to_dict()
+
+    async def aio_captcha_handler(
+        self,
+        captcha_link: Optional[str] = None,
+        captcha_file: Optional[str] = None,
+        captcha_base64: Optional[bytes] = None,
+        **kwargs,
+    ) -> dict:
+        """
+        Asynchronous method for captcha solving
+
+        Args:
+            captcha_link: Captcha file URL
+            captcha_file: Captcha file path
+            captcha_base64: Captcha file BASE64
+            kwargs: additional params for `aiohttp` library
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+        await self._aio_body_file_processing(
+            save_format=self.save_format,
+            file_path=self.audio_path,
+            file_extension="mp3",
+            captcha_link=captcha_link,
+            captcha_file=captcha_file,
+            captcha_base64=captcha_base64,
+            **kwargs,
+        )
+        if not self.result.errorId:
+            return await self._aio_processing_response()
+        return self.result.to_dict()
+
+    def __del__(self):
+        if self.save_format == SaveFormatsEnm.CONST.value and self.audio_clearing:
+            shutil.rmtree(self.audio_path)

python-rucaptcha-6.0/python_rucaptcha/capy_puzzle.py

@@ -0,0 +1,138 @@
+from typing import Union
+
+from .core.base import BaseCaptcha
+from .core.enums import CapyPuzzleEnm
+
+
+class CapyPuzzle(BaseCaptcha):
+    def __init__(
+        self,
+        websiteURL: str,
+        websiteKey: str,
+        method: Union[str, CapyPuzzleEnm] = CapyPuzzleEnm.CapyTaskProxyless,
+        *args,
+        **kwargs,
+    ):
+        """
+        The class is used to work with CapyPuzzle.
+
+        Args:
+            rucaptcha_key: User API key
+            websiteURL: Full URL of the captcha page
+            websiteKey: The value of the `captchakey` parameter you found in the code of the page
+            method: Captcha type
+
+        Examples:
+            >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...             websiteKey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
+            ...             websiteURL="https://www.capy.me/account/register/",
+            ...             method=CapyPuzzleEnm.CapyTaskProxyless.value,
+            ...             api_server="https://jp.api.capy.me/",
+            ...             version="puzzle",
+            ...             ).captcha_handler()
+            {
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captchakey":"PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
+                  "challengekey":"qHAPtn68KTnXFM8VQ3mtYRtmy3cSKuHJ",
+                  "answer":"0xax8ex0xax84x0xkx7qx0xux7gx0xx42x0x3ox42x0x3ox4cx",
+                  "respKey":""
+               },
+               "cost":"0.00299",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":1,
+               "taskId":75190409731
+            }
+
+            >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...             websiteKey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
+            ...             websiteURL="https://www.capy.me/account/register/",
+            ...             method=CapyPuzzleEnm.CapyTaskProxyless.value,
+            ...             api_server="https://jp.api.capy.me/",
+            ...             version="avatar",
+            ...             ).captcha_handler()
+            {
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captchakey":"PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
+                  "challengekey":"qHAPtn68KTnXFM8VQ3mtYRtmy3cSKuHJ",
+                  "answer":"0xax8ex0xax84x0xkx7qx0xux7gx0xx42x0x3ox42x0x3ox4cx",
+                  "respKey":""
+               },
+               "cost":"0.00299",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":1,
+               "taskId":75190409731
+            }
+
+            >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
+            ...             websiteKey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
+            ...             websiteURL="https://www.capy.me/account/register/",
+            ...             method="CapyTaskProxyless",
+            ...             api_server="https://jp.api.capy.me/",
+            ...             version="puzzle",
+            ...             ).captcha_handler()
+            {
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captchakey":"PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
+                  "challengekey":"qHAPtn68KTnXFM8VQ3mtYRtmy3cSKuHJ",
+                  "answer":"0xax8ex0xax84x0xkx7qx0xux7gx0xx42x0x3ox42x0x3ox4cx",
+                  "respKey":""
+               },
+               "cost":"0.00299",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":1,
+               "taskId":75190409731
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://rucaptcha.com/api-docs/capy-puzzle-captcha
+        """
+        super().__init__(method=method, *args, **kwargs)
+
+        self.create_task_payload["task"].update({"websiteURL": websiteURL, "websiteKey": websiteKey})
+
+        # check user params
+        if method not in CapyPuzzleEnm.list_values():
+            raise ValueError(f"Invalid method parameter set, available - {CapyPuzzleEnm.list_values()}")
+
+    def captcha_handler(self, **kwargs) -> dict:
+        """
+        Sync solving method
+
+        Args:
+            kwargs: additional params for `requests` library
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+
+        return self._processing_response(**kwargs)
+
+    async def aio_captcha_handler(self) -> dict:
+        """
+        Async solving method
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+        return await self._aio_processing_response()

python-rucaptcha-6.0/python_rucaptcha/control.py

@@ -0,0 +1,174 @@
+from .core.base import BaseCaptcha
+from .core.enums import ControlEnm
+from .core.result_handler import get_sync_result, get_async_result
+
+
+class Control(BaseCaptcha):
+    def __init__(
+        self,
+        *args,
+        **kwargs,
+    ):
+        """
+        The class is used to work with RuCaptcha control methods.
+
+        Args:
+            action: Control action type
+
+        Examples:
+            >>> Control(rucaptcha_key="aa9.....").getBalance()
+            {
+                'balance': 1593.4479
+            }
+
+            >>> await Control(rucaptcha_key="aa9.....").aio_getBalance()
+            {
+                'balance': 1593.4479
+            }
+
+            >>> Control(rucaptcha_key="aa9.....").reportCorrect(id=75188571838)
+            {
+                'errorId': 0,
+                'status': 'success'
+            }
+
+            >>> await Control(rucaptcha_key="aa9.....").aio_reportCorrect(id=75188571838)
+            {
+                'errorId': 0,
+                'status': 'success'
+            }
+
+            >>> Control(rucaptcha_key="aa9.....").reportIncorrect(id=75188571838)
+            {
+                'errorId': 0,
+                'status': 'success'
+            }
+
+            >>> await Control(rucaptcha_key="aa9.....").aio_reportIncorrect(id=75188571838)
+            {
+                'errorId': 0,
+                'status': 'success'
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://rucaptcha.com/api-docs/get-balance
+            https://rucaptcha.com/api-docs/report-correct
+            https://rucaptcha.com/api-docs/report-incorrect
+        """
+
+        super().__init__(method=ControlEnm.control, *args, **kwargs)
+
+    def reportCorrect(self, id: int) -> dict:
+        """
+        reportCorrect method
+
+        Args:
+            id: Captcha task ID
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://2captcha.com/api-docs/report-correct
+        """
+        self.get_task_payload.taskId = id
+        return get_sync_result(
+            get_payload=self.get_task_payload,
+            sleep_time=self.params.sleep_time,
+            url_response=f"https://api.{self.params.service_type}.com/reportCorrect",
+        )
+
+    async def aio_reportCorrect(self, id: int) -> dict:
+        """
+        Captcha results report
+
+        Args:
+            id: Captcha task ID
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://2captcha.com/api-docs/report-correct
+        """
+        self.get_task_payload.taskId = id
+        return await get_async_result(
+            get_payload=self.get_task_payload,
+            sleep_time=self.params.sleep_time,
+            url_response=f"https://api.{self.params.service_type}.com/reportCorrect",
+        )
+
+    def reportIncorrect(self, id: int) -> dict:
+        """
+        reportCorrect method
+
+        Args:
+            id: Captcha task ID
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://2captcha.com/api-docs/report-incorrect
+        """
+        self.get_task_payload.taskId = id
+        return get_sync_result(
+            get_payload=self.get_task_payload,
+            sleep_time=self.params.sleep_time,
+            url_response=f"https://api.{self.params.service_type}.com/reportIncorrect",
+        )
+
+    async def aio_reportIncorrect(self, id: int) -> dict:
+        """
+        Captcha results report
+
+        Args:
+            id: Captcha task ID
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://2captcha.com/api-docs/report-incorrect
+        """
+        self.get_task_payload.taskId = id
+        return await get_async_result(
+            get_payload=self.get_task_payload,
+            sleep_time=self.params.sleep_time,
+            url_response=f"https://api.{self.params.service_type}.com/reportIncorrect",
+        )
+
+    def getBalance(self) -> dict:
+        """
+        GetBalance method
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+        return get_sync_result(
+            get_payload=self.get_task_payload,
+            sleep_time=self.params.sleep_time,
+            url_response=f"https://api.{self.params.service_type}.com/getBalance",
+        )
+
+    async def aio_getBalance(self) -> dict:
+        """
+        Async GetBalance method
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstirng for more info
+        """
+        return get_sync_result(
+            get_payload=self.get_task_payload,
+            sleep_time=self.params.sleep_time,
+            url_response=f"https://api.{self.params.service_type}.com/getBalance",
+        )