ruby-2captcha 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b17960788d337b014b4337b32068a6ded3315e92fd649c28c0df2b0ba8d2cf09
-  data.tar.gz: 8b4b808a9d0b1696758bd21a8fe6b8cdeb584f1244416e3d86df83595c4003db
+  metadata.gz: 94adc4930618e4ff87a67f2863b7bcafdde25e41907547b8a5ed95d95bd20708
+  data.tar.gz: c98061247be1c224ebd09271a25bcca3e00dd010d6c2b698e2a5a931d1fbfb34
 SHA512:
-  metadata.gz: c288e20b91dd6b780f0acbc9f9bcf66428954b37d88505ce54330f88e320e775fe6eeccf8ebb621637376d409f0c5a702cb2d5a9d45a3e63ce612ea0a038d2a6
-  data.tar.gz: 7304970593279b972e1b85b22b430b7f271d9f0cc85afca244b4b24024bcf4607db17bd0701086b0035d30b7076631aa43de6e06215746e293304feaacd70187
+  metadata.gz: c02f909803243426c91c9b908595717dba50e837d517f8260d0ffca48999cb02c098211bc3144c04c39314cf5a5617d085143b90d91cffa46b888b12d1624b29
+  data.tar.gz: 44bfc875ace31d895ff44b4d826250ab62af899ddf32a87b34b0b640f7dd83a9f0a40efac8e9babe1610121be9181921faf850322f22d1da6e611c7d5a5d09ba

data/README.md

@@ -1,6 +1,6 @@
 # Ruby 2Captcha API Client
 
-This is the easiest way to quickly integrate 2Captcha into your code and automate solving of any type of captcha.
+This is the easiest way to quickly integrate [2Captcha] into your code and automate solving of any type of captcha.
 
 A Ruby client for the 2Captcha API.
 
@@ -13,6 +13,7 @@ A Ruby client for the 2Captcha API.
   - [reCAPTCHA v2](#recaptcha-v2)
   - [reCAPTCHA v3](#recaptcha-v3)
   - [reCAPTCHA Enterprise](#recaptcha-enterprise)
+  - [FunCaptcha](#funcaptcha)
   - [GeeTest](#geetest)
   - [hCaptcha](#hcaptcha)
   - [KeyCaptcha](#keycaptcha)
@@ -31,11 +32,13 @@ A Ruby client for the 2Captcha API.
   - [DataDome](#datadome)
   - [MTCaptcha](#mtcaptcha)
   - [Friendly captcha](#friendly-captcha)
+  - [Cutcaptcha](#cutcaptcha)
 - [Other methods](#other-methods)
   - [send / get_result](#send--get_result)
   - [balance](#balance)
   - [report](#report)
-  - [Error handling](#error-handling)
+- [Proxies](#proxies)
+- [Error handling](#error-handling)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -72,15 +75,15 @@ client.api_key = "YOUR_API_KEY"
 
 ### Client instance options
 
-|Option|Default value|Description|
-|---|---|---|
-|soft_id|-|your software ID obtained after publishing in [2captcha sofware catalog]|
-|callback|-|URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account|
-|default_timeout|120|Timeout in seconds for all captcha types except reCAPTCHA. Defines how long the module tries to get the answer from `res.php` API endpoint|
-|polling_interval|10|Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended|
+|Option          |Default value|Description                                                             |
+|----------------|-------------|------------------------------------------------------------------------|
+|soft_id         |-            |your software ID obtained after publishing in [2captcha sofware catalog]|
+|callback        |-            |URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account|
+|default_timeout |120          |Timeout in seconds for all captcha types except reCAPTCHA. Defines how long the module tries to get the answer from `res.php` API endpoint|
+|polling_interval|10           |Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended|
 
 >  **IMPORTANT:** once `callback` is defined for `Client` instance, all methods return only the captcha ID and DO NOT poll the API to get the result. The result will be sent to the callback URL.
-To get the answer manually use [get_result method](#send--getresult)
+To get the answer manually use [get_result method](#send--get_result)
 
 ## Solve captcha
 When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.
@@ -88,15 +91,15 @@ When you submit any image-based captcha use can provide additional options to he
 ### Captcha options
 | Option        | Default Value | Description                                                                                        |
 | ------------- | ------------- | -------------------------------------------------------------------------------------------------- |
-| numeric       | 0             | Defines if captcha contains numeric or other symbols [see more info in the API docs][post options] |
-| min_len     | 0             | minimal answer lenght                                                                              |
-| max_len     | 0             | maximum answer length                                                                              |
+| numeric       | 0             | Defines if captcha contains numeric or other symbols [see more info in the API docs][normal_post] |
+| min_len       | 0             | minimal answer lenght                                                                              |
+| max_len       | 0             | maximum answer length                                                                              |
 | phrase        | 0             | defines if the answer contains multiple words or not                                               |
-| case_sensitive | 0             | defines if the answer is case sensitive                                                            |
+| case_sensitive| 0             | defines if the answer is case sensitive                                                            |
 | calc          | 0             | defines captcha requires calculation                                                               |
 | lang          | -             | defines the captcha language, see the [list of supported languages]                                |
-| hint_image       | -             | an image with hint shown to workers with the captcha, translated into instructionsimg API parameter                                               |
-| hint_text      | -             | hint or task text shown to workers with the captcha                                                |
+| hint_image    | -             | an image with hint shown to workers with the captcha, translated into instructionsimg API parameter                                               |
+| hint_text     | -             | hint or task text shown to workers with the captcha                                                |
 
 Below you can find basic examples for every captcha type, check out the code below.
 
@@ -363,12 +366,22 @@ result = client.mt_captcha({
 ### Friendly captcha
 Use this method to solve Friendly captcha and obtain a token to bypass the protection.
 ```ruby
-result = client.friendly_captcha({
+result = client.friendly({
   pageurl: "https://example.com",
   sitekey: "2FZFEVS1FZCGQ9"
 })
 ```
 
+### Cutcaptcha
+Use this method to solve Cutcaptcha and obtain a token to bypass the protection.
+```ruby
+result = client.cutcaptcha({
+  misery_key: "a1488b66da00bf332a1488993a5443c79047e752",
+  api_key: "SAb83IIB",
+  pageurl: "https://example.cc/foo/bar.html"
+})
+```
+
 ## Other methods
 
 ### send / get_result
@@ -407,8 +420,24 @@ Use this method to report good or bad captcha answer.
 client.report(captcha_id, True) # captcha solved correctly
 client.report(captcha_id, False) # captcha solved incorrectly
 ```
+## Proxies
 
-### Error handling
+You can pass your proxy as an additional argument for methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, keycaptcha, capy puzzle, lemin, turnstile, amazon waf, Cutcaptcha, Friendly captcha, MTCaptcha, DataDome, CyberSiARA and etc. The proxy will be forwarded to the API to solve the captcha.
+
+We have our own proxies that we can offer you. [Buy residential proxies] for avoid restrictions and blocks. [Quick start].
+
+Example solving reCAPTCHA V2 using proxy:
+```ruby
+result = client.recaptcha_v2({
+  googlekey: '6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
+  pageurl: 'https://mysite.com/page/with/recaptcha_v2',
+  invisible: 1,
+  proxytype: "https",
+  proxy: "proxyuser:strongPassword@123.123.123.123:3128"
+})
+```
+
+## Error handling
 In case of an error, the captcha solver throws an exception. It's important to properly handle these cases. We recommend using `begin rescue` to handle exceptions.
 ```ruby
   begin
@@ -427,3 +456,12 @@ In case of an error, the captcha solver throws an exception. It's important to p
     puts(e)
   end
 ```
+
+<!-- Shared links -->
+[2Captcha]: https://2captcha.com/
+[2captcha sofware catalog]: https://2captcha.com/software
+[pingback settings]: https://2captcha.com/setting/pingback
+[normal_post]: https://2captcha.com/2captcha-api#normal_post
+[list of supported languages]: https://2captcha.com/2captcha-api#language
+[Buy residential proxies]: https://2captcha.com/proxy/residential-proxies
+[Quick start]: https://2captcha.com/proxy?openAddTrafficModal=true

data/README.ru.md

@@ -1,17 +1,18 @@
 # Ruby 2Captcha API Client
 
-Это самый простой способ быстро интегрировать 2Captcha в ваш код и автоматизировать решение любого типа капчи.
+Это самый простой способ быстро интегрировать [2Captcha] в ваш код и автоматизировать решение любого типа капчи.
 
 Ruby-клиент для API 2Captcha.
 
-- [Установка](#installation)
-- [Настройка](#configuration)
-    - [Опции экземпляра клиента](#client-instance-options)
-- [Решение капчи](#solve-captcha)
-  - [Обычная капча](#normal-captcha)
-  - [Текстовая капча](#text-captcha)
-  - [ReCaptcha v2](#recaptcha-v2)
-  - [ReCaptcha v3](#recaptcha-v3)
+- [Установка](#установка)
+- [Настройка](#настройка)
+    - [Опции экземпляра клиента](#опции-экземпляра-клиента)
+- [Решение капчи](#решение-капчи)
+  - [Обычная капча](#обычная-капча)
+  - [Текстовая капча](#текстовая-капча)
+  - [reCAPTCHA v2](#recaptcha-v2)
+  - [reCAPTCHA v3](#recaptcha-v3)
+  - [FunCaptcha](#funcaptcha)
   - [GeeTest](#geetest)
   - [hCaptcha](#hcaptcha)
   - [KeyCaptcha](#keycaptcha)
@@ -29,23 +30,28 @@ Ruby-клиент для API 2Captcha.
   - [DataDome](#datadome)
   - [MTCaptcha](#mtcaptcha)
   - [Friendly captcha](#friendly-captcha)
-- [Другие методы](#other-methods)
+  - [Cutcaptcha](#cutcaptcha)
+- [Другие методы](#другие-методы)
   - [send / get_result](#send--get_result)
-  - [balance](#balance)
-  - [report](#report)
-  - [Обработка ошибок](#error-handling)
+  - [Баланс](#баланс)
+  - [Отчет](#отчет)
+- [Прокси](#прокси)
+- [Обработка ошибок](#обработка-ошибок)
 
 ## Установка
 Автоматическая установка гема с помощью Bundler. Добавьте следующую строку в ваш Gemfile:
+
 ```ruby
 gem 'ruby-2captcha'
 ```
 Затем выполните следующую команду в терминале:
+
 ```ruby
 bundle install
 ```
 
 Или установите его самостоятельно, выполнив следующую команду в терминале:
+
 ```ruby
 gem install ruby-2captcha
 ```
@@ -63,7 +69,7 @@ require 'api_2captcha'
 
 client =  Api2Captcha.new("YOUR_API_KEY")
 ```
-
+### Опции экземпляра клиента
 У вас также есть возможность настроить некоторые параметры экземпляра Api2Captcha:
 
 ```ruby
@@ -83,7 +89,7 @@ client.polling_interval(10)
 
 | Параметр            | Значение по умолчанию | Описание                                                                                                                   |
 |-------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------|
-| numeric           | 0             | Определяет, содержит ли капча числа или другие символы [подробнее см. в документации по API](https://2captcha.com/2captcha-api#normal_post)                              |
+| numeric           | 0             | Определяет, содержит ли капча числа или другие символы [подробнее см. в документации по API](https://2captcha.com/2captcha-api#solving_normal_captcha)                              |
 | min_len           | 0             |  Минимальная длина ответа length                                                                                                         |
 | max_len           | 0             | Максимальная длина ответа length                                                                                                         |
 | phrase            | 0             | Определяет, содержит ли ответ несколько слов или нет                                                                          |
@@ -97,6 +103,7 @@ client.polling_interval(10)
 
 ### Обычная капча
 Для обхода обычной капчи (искаженный текст на картинке) используйте следующий метод. Этот метод также может использоваться для распознавания любого текста на картинке.
+
 ```ruby
 result = client.normal({ image: 'path/to/captcha.jpg'})
 # OR
@@ -104,9 +111,10 @@ result = client.normal({
   image: 'https://site-with-captcha.com/path/to/captcha.jpg'
 })
 ```
-
 ### Текстовая капча
+
 Этот метод может использоваться для обхода капчи, которая требует ответить на вопрос, представленный в явном виде.
+
 ```ruby
 result = client.text({
   textcaptcha:'Если завтра суббота, то какой сегодня день?',
@@ -114,8 +122,9 @@ result = client.text({
 })
 ```
 
-### ReCaptcha v2
-Используйте этот метод для решения ReCaptcha V2 и получения токена для обхода защиты.
+### reCAPTCHA v2
+Используйте этот метод для решения reCAPTCHA v2 и получения токена для обхода защиты.
+
 ```ruby
 result = client.recaptcha_v2({
   googlekey: '6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -124,8 +133,9 @@ result = client.recaptcha_v2({
 })
 ```
 
-### ReCaptcha v3
-Этот метод предоставляет решение для ReCaptcha V3 и возвращает токен.
+### reCAPTCHA v3
+Этот метод предоставляет решение для reCAPTCHA v3 и возвращает токен.
+
 ```ruby
 result = client.recaptcha_v3({
   googlekey: '6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -138,6 +148,7 @@ result = client.recaptcha_v3({
 
 ### FunCaptcha
 Метод решения FunCaptcha (Arkoselabs). Он возвращает токен.
+
 ```ruby
 result = client.funcaptcha({
    publickey: "69A21A01-CC7B-B9C6-0F9A-E7FA06677FFC",
@@ -147,6 +158,7 @@ result = client.funcaptcha({
 
 ### GeeTest
 Метод для решения головоломки GeeTest captcha. Он возвращает набор токенов в формате JSON.
+
 ```ruby
 result = client.geetest({
   gt: 'f1ab2cdefa3456789012345b6c78d90e',
@@ -158,6 +170,7 @@ result = client.geetest({
 
 ### hCaptcha
 Метод решения hCaptcha. Он возвращает токен для обхода капчи.
+
 ```ruby
 result = client.hcaptcha({
   sitekey: '10000000-ffff-ffff-ffff-000000000001',
@@ -167,6 +180,7 @@ result = client.hcaptcha({
 
 ### KeyCaptcha
 Метод на основе токенов для решения KeyCaptcha.
+
 ```ruby
 result = client.keycaptcha({
   s_s_c_user_id: 10,
@@ -179,6 +193,7 @@ result = client.keycaptcha({
 
 ### Capy
 Метод основан на использовании токенов для обхода паззла Capy.
+
 ```ruby
 result = client.capy({
   sitekey: 'PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
@@ -189,6 +204,7 @@ result = client.capy({
 
 ### Grid
 Метод сетки изначально называется методом Old ReCaptcha V2. Этот метод может быть использован для обхода любого типа капчи, где вы можете применить сетку к изображению и необходимо кликнуть по определенным ячейкам сетки. Он возвращает количество выбранных ячеек.
+
 ```ruby
 result = client.grid({
   image: 'path/to/captcha.jpg',
@@ -203,6 +219,7 @@ result = client.grid({
 
 ### Canvas
 Метод Canvas может быть использован, когда вам необходимо нарисовать линию вокруг объекта на изображении. Он возвращает набор координат точек для рисования многоугольника.
+
 ```ruby
 result = client.canvas({
   image: 'path/to/captcha.jpg',
@@ -215,6 +232,7 @@ result = client.canvas({
 
 ### ClickCaptcha
 Метод ClickCaptcha возвращает координаты точек на изображении капчи. Может быть использован, если вам необходимо кликнуть по определенным точкам на изображении.
+
 ```ruby
 result = client.coordinates({
   image: 'path/to/captcha.jpg',
@@ -226,6 +244,7 @@ result = client.coordinates({
 
 ### Rotate
 Этот метод может быть использован для решения капчи, которая просит повернуть объект. В основном используется для обхода FunCaptcha. Он возвращает угол поворота.
+
 ```ruby
 result = client.rotate({
   image: 'path/to/captcha.jpg',
@@ -236,8 +255,10 @@ result = client.rotate({
 })
 ```
 
+
 ### Lemin Cropped Captcha
 Используйте этот метод для решения задания hCaptcha. Он возвращает JSON-ответ с указанными значениями: ответ (answer) и идентификатор задания (challenge_id).
+
 ```ruby
 result = client.lemin({
   captcha_id: 'CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
@@ -247,8 +268,10 @@ result = client.lemin({
 })
 ```
 
+
 ### Cloudflare Turnstile
 Используйте этот метод для решения задачи Cloudflare Turnstile. Он возвращает JSON с токеном.
+
 ```ruby
 result = client.turnstile({
   sitekey: '0x1AAAAAAAAkg0s2VIOD34y5',
@@ -258,6 +281,7 @@ result = client.turnstile({
 
 ### Amazon WAF
 Используйте этот метод для решения Captcha Amazon WAF, также известного как AWS WAF Captcha, который является частью интеллектуальной защиты от угроз для Amazon AWS. Он возвращает JSON с токеном.
+
 ```ruby
 result = client.amazon_waf({
   sitekey: '0x1AAAAAAAAkg0s2VIOD34y5',
@@ -271,6 +295,7 @@ result = client.amazon_waf({
 
 ### GeeTest v4
 Используйте этот метод для решения GeeTest v4. Он возвращает ответ в формате JSON.
+
 ```ruby
 result = client.geetest_v4({
   captcha_id: 'e392e1d7fd421dc63325744d5a2b9c73',
@@ -280,6 +305,7 @@ result = client.geetest_v4({
 
 ### Audio
 Этот метод можно использовать для решения аудио-капчи.
+
 ```ruby
 result = client.audio({
   audio: 'path/to/audio.jpg',
@@ -289,6 +315,7 @@ result = client.audio({
 
 ### CyberSiARA
 Метод решения CyberSiARA. Он возвращает токен для обхода капчи.
+
 ```ruby
 result = client.cyber_siara({
   pageurl: "https://test.com",
@@ -299,6 +326,7 @@ result = client.cyber_siara({
 ### DataDome
 Метод решения DataDome вернет токен для обхода капчи.
 Чтобы решить капчу DataDome вы должны обязательно использовать прокси.
+
 ```ruby
 result = client.data_dome({
   pageurl: "https://test.com",
@@ -308,8 +336,10 @@ result = client.data_dome({
 })
 ```
 
+
 ### MTCaptcha
 Метод решения MTCaptcha. Он возвращает токен для обхода капчи.
+
 ```ruby
 result = client.mt_captcha({
   pageurl: "https://service.mtcaptcha.com/mtcv1/demo/index.html",
@@ -317,19 +347,35 @@ result = client.mt_captcha({
 })
 ```
 
+
 ### Friendly captcha
 Метод решения Friendly captcha. Он возвращает токен для обхода капчи.
+
 ```ruby
-result = client.friendly_captcha({
+result = client.friendly({
   pageurl: "https://example.com",
   sitekey: "2FZFEVS1FZCGQ9"
 })
 ```
 
+
+### Cutcaptcha
+Метод решения Cutcaptcha. Он возвращает токен для обхода капчи.
+
+```ruby
+result = client.cutcaptcha({
+  misery_key: "a1488b66da00bf332a1488993a5443c79047e752",
+  api_key: "SAb83IIB",
+  pageurl: "https://example.cc/foo/bar.html"
+})
+```
+
+
 ## Другие методы
 
 ### send / get_result
 Эти методы могут быть использованы для ручного отправления капчи и получения результата.
+
 ```ruby
 # пример для обычной капчи
 captcha_id = client.send('path/to/captcha.jpg')
@@ -348,22 +394,42 @@ time.sleep(20)
 # Получить готовый результат
 result = client.get_result(captcha_id)
 ```
-
 ### Баланс
 Используйте этот метод, чтобы посмотреть баланс в вашем аккаунте.
+
 ```ruby
 balance = client.get_balance
 ```
 
 ### Отчет
 Используйте этот метод для отправки отчета о правильном или неправильном ответе на капчу.
+
 ```ruby
 client.report(captcha_id, True) # капча решена правильно
 client.report(captcha_id, False) # капча решена неправильно
 ```
 
-### Обработка ошибок
+## Прокси
+
+Вы можете передать свой прокси-сервер в качестве дополнительного аргумента для методов: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, keycaptcha, capy puzzle, lemin, turnstile, amazon waf, Cutcaptcha, Friendly captcha, MTCaptcha, DataDome, CyberSiARA и других. Передынный Прокси-сервер будет перенаправлен в API и будет использован для загрузки капчи.
+
+У нас есть свои собственные прокси-серверы, которые мы можем вам предложить. [Купить резидентские прокси] чтобы избежать ограничений и блокировок. [Быстрый старт].
+
+Пример решения reCAPTCHA V2 с использованием прокси-сервера:
+
+```ruby
+result = client.recaptcha_v2({
+  googlekey: '6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
+  pageurl: 'https://mysite.com/page/with/recaptcha_v2',
+  invisible: 1,
+  proxytype: "https",
+  proxy: "proxyuser:strongPassword@123.123.123.123:3128"
+})
+```
+
+## Обработка ошибок
 В случае ошибки при решении капчи генерируется исключение. Важно правильно обрабатывать такие случаи. Мы рекомендуем использовать конструкцию `begin rescue` для обработки.
+
 ```ruby
   begin
   result = client.text('Если завтра суббота, то какой сегодня день?')
@@ -381,3 +447,8 @@ client.report(captcha_id, False) # капча решена неправильн
     puts(e)
   end
 ```
+
+<!-- Shared links -->
+[2Captcha]: https://2captcha.com/
+[Купить резидентские прокси]: https://2captcha.com/proxy/residential-proxies
+[Быстрый старт]: https://2captcha.com/proxy?openAddTrafficModal=true

data/lib/api_2captcha/client.rb

@@ -23,7 +23,7 @@ module Api2Captcha
       @default_timeout = 120
       @recaptcha_timeout = 600
       @polling_interval = 10
-      @soft_id = 0
+      @soft_id = 4584
       @domain = DEFAULT_DOMAIN
     end
 
@@ -201,6 +201,10 @@ module Api2Captcha
       solve("friendly_captcha", **params)
     end
 
+    def cutcaptcha(params)
+      solve("cutcaptcha", **params)
+    end
+
     private
 
     def base_url

data/lib/api_2captcha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Api2Captcha
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-2captcha
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - 2captcha.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies: []
 description: Ruby package for easy integration with the API of 2captcha captcha solving
   service to bypass recaptcha, hcaptcha, funcaptcha, geetest and solve any other captchas.