python-rucaptcha 5.3__py3-none-any.whl → 6.0__py3-none-any.whl

python_rucaptcha/__version__.py

@@ -1 +1 @@
-__version__ = "5.3"
+__version__ = "6.0"

python_rucaptcha/amazon_waf.py

@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import AmazonWAFCaptchaEnm
 
@@ -5,11 +7,11 @@ from .core.enums import AmazonWAFCaptchaEnm
 class AmazonWAF(BaseCaptcha):
     def __init__(
         self,
-        pageurl: str,
-        sitekey: str,
+        websiteURL: str,
+        websiteKey: str,
         iv: str,
         context: str,
-        method: str = AmazonWAFCaptchaEnm.AMAZON_WAF.value,
+        method: Union[str, AmazonWAFCaptchaEnm] = AmazonWAFCaptchaEnm.AmazonTaskProxyless,
         *args,
         **kwargs,
     ):
@@ -18,74 +20,80 @@ class AmazonWAF(BaseCaptcha):
 
         Args:
             rucaptcha_key: User API key
-            pageurl: Full URL of the captcha page
-            sitekey: Key value from the page
+            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",
-            ...           pageurl="https://page-with-waf.com/",
-            ...           sitekey="some-site-key",
+            ...           websiteURL="https://page-with-waf.com/",
+            ...           websiteKey="some-site-key",
             ...           iv="some-iv-value",
             ...           context="some-context-value").captcha_handler()
             {
-                'captchaSolve': 'eyJ0e......jNuSFqtyP4Ho',
-                'taskId': '7111111984',
-                'error': False,
-                'errorBody': None
+               "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",
-            ...           pageurl="https://page-with-waf.com/",
-            ...           sitekey="some-site-key",
+            ...           websiteURL="https://page-with-waf.com/",
+            ...           websiteKey="some-site-key",
             ...           iv="some-iv-value",
             ...           context="some-context-value").aio_captcha_handler()
             {
-                'captchaSolve': 'eyJ0e......jNuSFqtyP4Ho',
-                'taskId': '7111111984',
-                'error': False,
-                'errorBody': None
+               "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-rucaptcha#amazon-waf
+            https://rucaptcha.com/api-docs/amazon-aws-waf-captcha
         """
         super().__init__(method=method, *args, **kwargs)
 
-        self.post_payload.update({"sitekey": sitekey, "pageurl": pageurl, "iv": iv, "context": context})
-
         # 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
 
-        Examples:
-            >>> AmazonWAF(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...           pageurl="https://page-with-waf.com/",
-            ...           sitekey="some-site-key",
-            ...           iv="some-iv-value",
-            ...           context="some-context-value").captcha_handler()
-            {
-                'captchaSolve': 'eyJ0e......jNuSFqtyP4Ho',
-                'taskId': '7111111984',
-                'error': False,
-                'errorBody': None
-            }
-
         Returns:
-            Response to captcha as JSON string with fields:
-                 captchaSolve - captcha solution,
-                 taskId - finds the ID of the task to solve the captcha,
-                 error - False - if everything is fine, True - if there is an error,
-                 errorBody - error name
+            Dict with full server response
 
         Notes:
             Check class docstirng for more info
@@ -97,25 +105,8 @@ class AmazonWAF(BaseCaptcha):
         """
         Asynchronous method for captcha solving
 
-        Examples:
-            >>> await AmazonWAF(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...           pageurl="https://page-with-waf.com/",
-            ...           sitekey="some-site-key",
-            ...           iv="some-iv-value",
-            ...           context="some-context-value").aio_captcha_handler()
-            {
-                'captchaSolve': 'eyJ0e......jNuSFqtyP4Ho',
-                'taskId': '7111111984',
-                'error': False,
-                'errorBody': None
-            }
-
         Returns:
-            Response to captcha as JSON string with fields:
-                 captchaSolve - captcha solution,
-                 taskId - finds the ID of the task to solve the captcha,
-                 error - False - if everything is fine, True - if there is an error,
-                 errorBody - error name
+            Dict with full server response
 
         Notes:
             Check class docstirng for more info

python_rucaptcha/audio_captcha.py

@@ -1,15 +1,15 @@
-import base64
 import shutil
-from typing import Optional
+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: str = SaveFormatsEnm.TEMP.value,
+        save_format: Union[str, SaveFormatsEnm] = SaveFormatsEnm.TEMP,
         audio_clearing: bool = True,
         audio_path: str = "PythonRuCaptchaAudio",
         lang: str = "en",
@@ -38,6 +38,17 @@ class AudioCaptcha(BaseCaptcha):
                 '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')
@@ -48,19 +59,31 @@ class AudioCaptcha(BaseCaptcha):
                 '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-rucaptcha#audio
+            https://rucaptcha.com/api-docs/audio
         """
 
-        super().__init__(method=AudioCaptchaEnm.AUDIO.value, *args, **kwargs)
+        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.post_payload.update({"lang": lang})
+        self.create_task_payload["task"].update({"lang": lang})
 
     def captcha_handler(
         self,
@@ -78,60 +101,25 @@ class AudioCaptcha(BaseCaptcha):
             captcha_base64: Captcha file BASE64 info
             kwargs: additional params for `requests` library
 
-        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
-            }
-
-            >>> AudioCaptcha(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             lang='en'
-            ...             ).captcha_handler(captcha_link='http://some/link/address/recaptcha_55914.mp3')
-            {
-                'captchaSolve': 'five five nine one four',
-                'taskId': 73243152973,
-                'error': False,
-                'errorBody': None
-            }
-
         Returns:
             Dict with full server response
 
         Notes:
             Check class docstirng for more info
         """
-        # if a local file link is passed
-        if captcha_file:
-            self.post_payload.update({"body": base64.b64encode(self._local_file_captcha(captcha_file)).decode("utf-8")})
-        # if the file is transferred in base64 encoding
-        elif captcha_base64:
-            self.post_payload.update({"body": base64.b64encode(captcha_base64).decode("utf-8")})
-        # if a URL is passed
-        elif captcha_link:
-            try:
-                content = self.url_open(url=captcha_link, **kwargs).content
-            except Exception as error:
-                self.result.error = True
-                self.result.errorBody = str(error)
-                return self.result.dict()
-
-            # according to the value of the passed parameter, select the function to save the file
-            if self.save_format == SaveFormatsEnm.CONST.value:
-                self._file_const_saver(content, self.audio_path, file_extension="mp3")
-            self.post_payload.update({"body": base64.b64encode(content).decode("utf-8")})
-
-        else:
-            # if none of the parameters are passed
-            self.result.error = True
-            self.result.errorBody = self.NO_CAPTCHA_ERR
-            return self.result.dict()
-
-        return self._processing_response(**kwargs)
+
+        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,
@@ -149,59 +137,24 @@ class AudioCaptcha(BaseCaptcha):
             captcha_base64: Captcha file BASE64
             kwargs: additional params for `aiohttp` library
 
-        Examples:
-            >>> 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
-            }
-            >>> await AudioCaptcha(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             lang='en'
-            ...             ).aio_captcha_handler(captcha_link='http://some/link/address/recaptcha_55914.mp3')
-            {
-                'captchaSolve': 'five five nine one four',
-                'taskId': 73243152973,
-                'error': False,
-                'errorBody': None
-            }
-
         Returns:
             Dict with full server response
 
         Notes:
             Check class docstirng for more info
         """
-        # if a local file link is passed
-        if captcha_file:
-            self.post_payload.update({"body": base64.b64encode(self._local_file_captcha(captcha_file)).decode("utf-8")})
-        # if the file is transferred in base64 encoding
-        elif captcha_base64:
-            self.post_payload.update({"body": base64.b64encode(captcha_base64).decode("utf-8")})
-        # if a URL is passed
-        elif captcha_link:
-            try:
-                content = await self.aio_url_read(url=captcha_link, **kwargs)
-            except Exception as error:
-                self.result.error = True
-                self.result.errorBody = str(error)
-                return self.result.dict()
-
-            # according to the value of the passed parameter, select the function to save the file
-            if self.save_format == SaveFormatsEnm.CONST.value:
-                self._file_const_saver(content, self.audio_path, file_extension="mp3")
-            self.post_payload.update({"body": base64.b64encode(content).decode("utf-8")})
-
-        else:
-            # if none of the parameters are passed
-            self.result.error = True
-            self.result.errorBody = self.NO_CAPTCHA_ERR
-            return self.result.dict()
-
-        return await self._aio_processing_response()
+        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:

python_rucaptcha/capy_puzzle.py

@@ -1,131 +1,121 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import CapyPuzzleEnm
 
 
 class CapyPuzzle(BaseCaptcha):
-    def __init__(self, pageurl: str, captchakey: str, method: str = CapyPuzzleEnm.CAPY.value, *args, **kwargs):
+    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
-            pageurl: Full URL of the captcha page
-            captchakey: The value of the `captchakey` parameter you found in the code of the page
+            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",
-            ...             captchakey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method=CapyPuzzleEnm.CAPY.value,
+            ...             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()
             {
-               "captchaSolve": {
-                  "captchakey": "PUZZLE_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captchakey":"PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
+                  "challengekey":"qHAPtn68KTnXFM8VQ3mtYRtmy3cSKuHJ",
+                  "answer":"0xax8ex0xax84x0xkx7qx0xux7gx0xx42x0x3ox42x0x3ox4cx",
+                  "respKey":""
                },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
+               "cost":"0.00299",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":1,
+               "taskId":75190409731
             }
 
             >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             captchakey="AVATAR_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method=CapyPuzzleEnm.CAPY.value,
+            ...             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()
             {
-               "captchaSolve": {
-                  "captchakey": "AVATART_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captchakey":"PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
+                  "challengekey":"qHAPtn68KTnXFM8VQ3mtYRtmy3cSKuHJ",
+                  "answer":"0xax8ex0xax84x0xkx7qx0xux7gx0xx42x0x3ox42x0x3ox4cx",
+                  "respKey":""
                },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
+               "cost":"0.00299",
+               "ip":"1.2.3.4",
+               "createTime":1692863536,
+               "endTime":1692863556,
+               "solveCount":1,
+               "taskId":75190409731
             }
 
             >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             captchakey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method="capy",
+            ...             websiteKey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
+            ...             websiteURL="https://www.capy.me/account/register/",
+            ...             method="CapyTaskProxyless",
             ...             api_server="https://jp.api.capy.me/",
             ...             version="puzzle",
             ...             ).captcha_handler()
             {
-               "captchaSolve": {
-                  "captchakey": "PUZZLE_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
+               "errorId":0,
+               "status":"ready",
+               "solution":{
+                  "captchakey":"PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
+                  "challengekey":"qHAPtn68KTnXFM8VQ3mtYRtmy3cSKuHJ",
+                  "answer":"0xax8ex0xax84x0xkx7qx0xux7gx0xx42x0x3ox42x0x3ox4cx",
+                  "respKey":""
                },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
+               "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-rucaptcha#solving_capy
+            https://rucaptcha.com/api-docs/capy-puzzle-captcha
         """
         super().__init__(method=method, *args, **kwargs)
 
-        self.post_payload.update({"captchakey": captchakey, "pageurl": pageurl})
+        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):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
         Args:
             kwargs: additional params for `requests` library
 
-        Examples:
-            >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             captchakey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method=CapyPuzzleEnm.CAPY.value,
-            ...             api_server="https://jp.api.capy.me/",
-            ...             version="puzzle",
-            ...             ).captcha_handler()
-            {
-               "captchaSolve": {
-                  "captchakey": "PUZZLE_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
-               },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
-            }
-
-            >>> CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             captchakey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method=CapyPuzzleEnm.CAPY.value,
-            ...             api_server="https://jp.api.capy.me/",
-            ...             version="avatar",
-            ...             ).captcha_handler()
-            {
-               "captchaSolve": {
-                  "captchakey": "AVATART_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
-               },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
-            }
-
         Returns:
             Dict with full server response
 
@@ -135,47 +125,10 @@ class CapyPuzzle(BaseCaptcha):
 
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 
-        Examples:
-            >>> await CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             captchakey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method=CapyPuzzleEnm.CAPY.value,
-            ...             api_server="https://jp.api.capy.me/",
-            ...             version="puzzle",
-            ...             ).aio_captcha_handler()
-            {
-               "captchaSolve": {
-                  "captchakey": "PUZZLE_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
-               },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
-            }
-
-            >>> await CapyPuzzle(rucaptcha_key="aa9011f31111181111168611f1151122",
-            ...             captchakey="PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w",
-            ...             pageurl="https://www.capy.me/account/register/",
-            ...             method=CapyPuzzleEnm.CAPY.value,
-            ...             api_server="https://jp.api.capy.me/",
-            ...             version="avatar",
-            ...             ).aio_captcha_handler()
-            {
-               "captchaSolve": {
-                  "captchakey": "AVATART_C...w",
-                  "challengekey": "Uf....It",
-                  "answer": "26x...x9mx"
-               },
-               "taskId": 73052314114,
-               "error": False,
-               "errorBody": None
-            }
-
         Returns:
             Dict with full server response