Add Drag & Drop captcha support with sync/async solvers, tests, examples, and documentation (#148)

Author: poplers24

README.md

@@ -55,6 +55,7 @@ Examples of API requests for different captcha types are available on the [Pytho
     - [Alibaba](#alibaba)
     - [TSPD](#tspd)
     - [Basilisk](#basilisk)
+    - [Drag & Drop](#drag--drop)
   - [Other methods](#other-methods)
     - [send / get\_result](#send--get_result)
     - [balance](#balance)
@@ -611,6 +612,26 @@ result = solver.basilisk(pageurl='https://example.com/login',
                          )
 ```
 
+### Drag & Drop
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#drag-and-drop-captcha)</sup>
+
+Use this method to solve a captcha where one or more images need to be dragged onto specific positions on a background image.
+`body` and each item in `images` can be a file path, a URL, or a Base64-encoded string.
+
+Returns the standard result dictionary `{'captchaId': 'TASK_ID', 'code': 'COORDINATES'}`. The coordinates string in
+`result['code']` contains one entry per image from `images`, in the same order, separated by `|`. An image that
+wasn't moved may be returned by the API as `null`.
+
+```python
+result = solver.drag_and_drop(
+    body='path/to/background.jpg',
+    images=['path/to/image1.jpg', 'path/to/image2.jpg'],
+)
+
+coordinates = result['code']
+```
+
 ## Other methods
 
 ### send / get_result

examples/async/async_drag_and_drop.py

@@ -0,0 +1,30 @@
+import asyncio
+import os
+import sys
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+
+from twocaptcha import AsyncTwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = AsyncTwoCaptcha(api_key)
+
+
+async def solve_captcha():
+    try:
+        return await solver.drag_and_drop(body='../images/drag_drop_main.jpeg',
+                                          images=['../images/drag_drop_image1.jpeg', '../images/drag_drop_image2.jpeg'])
+    except Exception as e:
+        sys.exit(e)
+
+
+if __name__ == '__main__':
+    result = asyncio.run(solve_captcha())
+    sys.exit('result: ' + str(result))

examples/async/async_drag_and_drop_base64.py

@@ -0,0 +1,42 @@
+import asyncio
+import os
+import sys
+from base64 import b64encode
+
+import aiofiles
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+
+from twocaptcha import AsyncTwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = AsyncTwoCaptcha(api_key)
+
+
+async def solve_captcha():
+    async with aiofiles.open('../images/drag_drop_main.jpeg', 'rb') as f:
+        body_b64 = b64encode(await f.read()).decode('utf-8')
+
+    async with aiofiles.open('../images/drag_drop_image1.jpeg', 'rb') as f:
+        image1_b64 = b64encode(await f.read()).decode('utf-8')
+
+    async with aiofiles.open('../images/drag_drop_image2.jpeg', 'rb') as f:
+        image2_b64 = b64encode(await f.read()).decode('utf-8')
+
+    try:
+        return await solver.drag_and_drop(body=body_b64,
+                                          images=[image1_b64, image2_b64])
+    except Exception as e:
+        sys.exit(e)
+
+
+if __name__ == '__main__':
+    result = asyncio.run(solve_captcha())
+    sys.exit('result: ' + str(result))

examples/async/async_drag_and_drop_options.py

@@ -0,0 +1,36 @@
+import asyncio
+import os
+import sys
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+
+from twocaptcha import AsyncTwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = AsyncTwoCaptcha(api_key, defaultTimeout=120, pollingInterval=10)
+
+
+async def solve_captcha():
+    try:
+        return await solver.drag_and_drop(
+            body='../images/drag_drop_main.jpeg',
+            images=['../images/drag_drop_image1.jpeg', '../images/drag_drop_image2.jpeg'],
+            hintText='Drag the images to proper position',
+            language=0,
+            lang='en',
+            header_acao=0,
+        )
+    except Exception as e:
+        sys.exit(e)
+
+
+if __name__ == '__main__':
+    result = asyncio.run(solve_captcha())
+    sys.exit('result: ' + str(result))

examples/images/drag_drop_image1.jpeg

@@ -0,0 +1,26 @@
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+try:
+    result = solver.drag_and_drop(body='../images/drag_drop_main.jpeg',
+                                  images=['../images/drag_drop_image1.jpeg', '../images/drag_drop_image2.jpeg'])
+
+except Exception as e:
+    sys.exit(str(e))
+
+else:
+    sys.exit('result: ' + str(result))

examples/images/drag_drop_image2.jpeg

@@ -0,0 +1,36 @@
+import sys
+import os
+from base64 import b64encode
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+with open('../images/drag_drop_main.jpeg', 'rb') as f:
+    body_b64 = b64encode(f.read()).decode('utf-8')
+
+with open('../images/drag_drop_image1.jpeg', 'rb') as f:
+    image1_b64 = b64encode(f.read()).decode('utf-8')
+
+with open('../images/drag_drop_image2.jpeg', 'rb') as f:
+    image2_b64 = b64encode(f.read()).decode('utf-8')
+
+try:
+    result = solver.drag_and_drop(body=body_b64,
+                                  images=[image1_b64, image2_b64])
+
+except Exception as e:
+    sys.exit(str(e))
+
+else:
+    sys.exit('result: ' + str(result))

examples/images/drag_drop_main.jpeg

@@ -0,0 +1,32 @@
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key, defaultTimeout=120, pollingInterval=10)
+
+try:
+    result = solver.drag_and_drop(
+        body='../images/drag_drop_main.jpeg',
+        images=['../images/drag_drop_image1.jpeg', '../images/drag_drop_image2.jpeg'],
+        hintText='Drag the images to proper position',
+        language=0,
+        lang='en',
+        header_acao=0,
+    )
+
+except Exception as e:
+    sys.exit(str(e))
+
+else:
+    sys.exit('result: ' + str(result))