ruby-2captcha 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d43df532b2141353e6422da8e0665393eb50e141146845a1c29626588c4dd68
-  data.tar.gz: d8ebb3b307406598dc10d828a7263f3a31d703fde4f9e2c0ed0dce362beddb8d
+  metadata.gz: 6e27af7b5ab7e5e7a117b7598d8eb609ca10bee60174078691eda86265e8d464
+  data.tar.gz: 21dcd54bfe95f730b5887e41bdbdec5baca72eb915e8b8125f1006c59821640b
 SHA512:
-  metadata.gz: f0a5795f465569fdbede1fec84f74f1d65ba0a1cdc7adf93021b4feb11cfc22b377330c4ac7a2574e5dceffc6358106d64ed0a518375370a3a56b52a3ecbbbda
-  data.tar.gz: a979fff1899841066c9d2898ae0c6e56bd2725221ca1542cd5b4f040f9e7b48fe491fc4c7f51dc41f61565ab041fb986260a2fda6879f6296df69d116a6cf6f7
+  metadata.gz: 69eeb331f6d5104521ffceaaa3268cab0c48c502e9e390d9e6d259cdfb568027f2ffbd82cbcf445797663fd6f9deaf89537a88e50e42459ca70df6b53af54a79
+  data.tar.gz: c25f4db3a71a56f95846964081f986765007a38a493917d496e3e21f2a6b974b2917788b35265d2c622a13f99bac620e89cefb121890b099da91fade1759fa1c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-2captcha (1.1.6)
+    ruby-2captcha (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -56,6 +56,7 @@ Examples of API requests for different captcha types are available on the [Ruby
       - [Alibaba](#alibaba)
       - [Yidun](#yidun)
       - [Drag & Drop Captcha](#drag--drop-captcha)
+      - [Imperva (Incapsula)](#imperva-incapsula)
     - [Other methods](#other-methods)
       - [send / get_result](#send--get_result)
       - [balance](#balance)
@@ -688,6 +689,29 @@ result = client.drag_drop({
 })
 ```
 
+### Imperva (Incapsula)
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#imperva)</sup>
+
+Cookie-based method for automated solving of Imperva (Incapsula) captcha. `incapsula_script_url` and `incapsula_cookies` are generated dynamically and may differ on each page load. Optionally pass `reese84_url_endpoint` if the site uses Reese84, and `userAgent` of the browser that opens the page.
+
+The result contains cookies for each domain in `request.domains`, which should be sent to the target site. If `request.headers.User-Agent` is returned, use the same User-Agent in requests to the site.
+
+> [!IMPORTANT]
+> To solve the Imperva captcha, you must use a proxy. It is recommended to use [residential proxies].
+
+```ruby
+result = client.imperva({
+  pageurl: "https://example.com/page-with-imperva",
+  incapsula_script_url: "/_Incapsula_Resource?SWUDNSAI=31&xinfo=1",
+  incapsula_cookies: "visid_incap_123456=sample; incap_ses_123_123456=sample",
+  reese84_url_endpoint: "https://example.com/_Incapsula_Resource?reese84=1",
+  userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
+  proxytype: "http",
+  proxy: "proxyuser:strongPassword@123.123.123.123:3128"
+})
+```
+
 ## Other methods
 
 ### send / get_result

data/README.ru.md

@@ -53,6 +53,7 @@
     - [Alibaba](#alibaba)
     - [Yidun](#yidun)
     - [Drag & Drop Captcha](#drag--drop-captcha)
+    - [Imperva (Incapsula)](#imperva-incapsula)
   - [Другие методы](#другие-методы)
     - [send / get_result](#send--get_result)
     - [Баланс](#баланс)
@@ -680,6 +681,29 @@ result = client.drag_drop({
 })
 ```
 
+### Imperva (Incapsula)
+
+<sup>[Описание метода API](https://2captcha.com/2captcha-api#imperva)</sup>
+
+Основанный на cookies метод автоматизированного решения капчи Imperva (Incapsula). Параметры `incapsula_script_url` и `incapsula_cookies` генерируются динамически и могут отличаться при каждой загрузке страницы. Необязательно можно передать `reese84_url_endpoint`, если он нужен на конкретном сайте, и `userAgent` браузера, с которым открывается страница.
+
+В ответе приходят cookies для каждого домена в `request.domains` — их нужно передать на целевой сайт. Если в ответе пришёл `request.headers.User-Agent`, используйте тот же User-Agent в запросах к сайту.
+
+> [!IMPORTANT]
+> Для решения Imperva captcha необходимо использовать прокси. Рекомендуется использовать [резидентные прокси].
+
+```ruby
+result = client.imperva({
+  pageurl: "https://example.com/page-with-imperva",
+  incapsula_script_url: "/_Incapsula_Resource?SWUDNSAI=31&xinfo=1",
+  incapsula_cookies: "visid_incap_123456=sample; incap_ses_123_123456=sample",
+  reese84_url_endpoint: "https://example.com/_Incapsula_Resource?reese84=1",
+  userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
+  proxytype: "http",
+  proxy: "proxyuser:strongPassword@123.123.123.123:3128"
+})
+```
+
 ## Другие методы
 
 ### send / get_result

data/examples/imperva_example.rb

@@ -0,0 +1,20 @@
+
+require_relative '../lib/api_2captcha'
+
+client = Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.imperva({
+    pageurl: "https://example.com/page-with-imperva",
+    incapsula_script_url: "/_Incapsula_Resource?SWUDNSAI=31&xinfo=1",
+    incapsula_cookies: "visid_incap_123456=sample; incap_ses_123_123456=sample",
+    reese84_url_endpoint: "https://example.com/_Incapsula_Resource?reese84=1",
+    userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
+    proxytype: "http",
+    proxy: "proxyuser:strongPassword@123.123.123.123:3128"
+  })
+rescue StandardError => e
+  puts(e)
+end
+
+puts "Result: #{result.inspect}"

data/examples/text_example.rb

@@ -1,10 +1,23 @@
-require 'api_2captcha'
+require "api_2captcha"
 
-client =  Api2Captcha.new("YOUR_API_KEY")
+client = Api2Captcha.new(ARGV[0])
 
-result = client.text({
-  textcaptcha:'If tomorrow is Saturday, what day is today?',
-  lang: "en"
-})
-
-puts "Result: #{result.inspect}"
+begin
+  result = client.text({
+                         textcaptcha: "If tomorrow is Saturday, what day is today?",
+                         lang: "en"
+                       })
+  puts "Result: #{result.inspect}"
+rescue Api2Captcha::ValidationException => e
+  # invalid parameters passed
+  puts(e)
+rescue Api2Captcha::NetworkException => e
+  # network error occurred
+  puts(e)
+rescue Api2Captcha::ApiException => e
+  # api respond with error
+  puts(e)
+rescue Api2Captcha::TimeoutException => e
+  # captcha is not solved so far
+  puts(e)
+end

data/lib/api_2captcha/client.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-require 'net/http'
-require 'uri'
-require 'json'
-require 'base64'
-require 'open-uri'
+
+require "net/http"
+require "uri"
+require "json"
+require "base64"
+require "open-uri"
 
 module Api2Captcha
   class Client
@@ -42,12 +43,15 @@ module Api2Captcha
       complete_params = get_params(params)
       captcha_id = send_request(complete_params)
       return captcha_id if return_id
+
       get_result(captcha_id)
     end
 
     def send(*args)
-      raise ArgumentError,
-      "Invalid arguments of the send method" unless args.size == 1
+      unless args.size == 1
+        raise ArgumentError,
+              "Invalid arguments of the send method"
+      end
 
       arg = args.first
       if arg.is_a?(String)
@@ -94,7 +98,7 @@ module Api2Captcha
 
     def get_balance
       response = make_res_request({ "action" => "getbalance" }, "getbalance")
-      return response["request"].to_f
+      response["request"].to_f
     end
 
     def normal(params)
@@ -265,6 +269,10 @@ module Api2Captcha
       solve("drag_drop", **params)
     end
 
+    def imperva(params)
+      solve("incapsula", **params)
+    end
+
     private
 
     def base_url
@@ -274,7 +282,7 @@ module Api2Captcha
     def send_request(params)
       uri = URI("#{base_url}/in.php")
       req = Net::HTTP::Post.new(uri)
-      req.content_type = 'application/json'
+      req.content_type = "application/json"
       req.body = params.to_json
       captcha_id = get_captcha_id(make_request(uri, req))
     end
@@ -288,14 +296,14 @@ module Api2Captcha
       hint_image = params.delete("hint_image")
 
       image_content = if base64_encoded?(image)
-        image
-      else
-        Base64.strict_encode64(get_image_content(image))
-      end
+                        image
+                      else
+                        Base64.strict_encode64(get_image_content(image))
+                      end
 
       hint_image_content = if hint_image
-                  base64_encoded?(hint_image) ? hint_image : Base64.strict_encode64(get_image_content(hint_image))
-                  end
+                             base64_encoded?(hint_image) ? hint_image : Base64.strict_encode64(get_image_content(hint_image))
+                           end
 
       result_params = {
         "method" => "base64",
@@ -309,20 +317,20 @@ module Api2Captcha
     end
 
     def get_image_content(image)
-      return download_image(image) if image.start_with?('http')
+      return download_image(image) if image.start_with?("http")
       return File.binread(image) if File.file?(image)
+
       image
     end
 
     def base64_encoded?(string)
-      string.is_a?(String) && string.match(/\A[A-Za-z0-9+\/=]+\z/) && (string.length % 4).zero?
+      string.is_a?(String) && string.match(%r{\A[A-Za-z0-9+/=]+\z}) && (string.length % 4).zero?
     end
 
     def download_image(url)
       response = URI.open(url)
-      if response.status[0] != '200'
-        raise StandardError, "File could not be downloaded from url: #{url}"
-      end
+      raise StandardError, "File could not be downloaded from url: #{url}" if response.status[0] != "200"
+
       response.read
     end
 
@@ -336,11 +344,10 @@ module Api2Captcha
       case response
       when Net::HTTPSuccess
         response_json = JSON.parse(response.body.strip)
-        if response_json["status"] == 1
-          response_json["request"]
-        else
-          raise ApiException, "API Error: #{response_json["request"]}"
-        end
+        raise ApiException, "API Error: #{response_json["request"]}" unless response_json["status"] == 1
+
+        response_json["request"]
+
       else
         raise NetworkException, "Network Error: #{response.code.to_i}"
       end
@@ -361,19 +368,17 @@ module Api2Captcha
     def make_res_request(request, action)
       uri = URI("#{base_url}/res.php?key=#{@api_key}&action=#{action}&json=1")
       req = Net::HTTP::Post.new(uri)
-      req.content_type = 'application/json'
+      req.content_type = "application/json"
       req.body = request.to_json
 
       response = make_request(uri, req)
 
       case response
       when Net::HTTPSuccess
-        return JSON.parse(response.body)
+        JSON.parse(response.body)
       else
         raise Api2Captcha::NetworkException, "Network Error: #{response.code.to_i}"
       end
     end
   end
 end
-
-

data/lib/api_2captcha/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-2captcha
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - 2captcha.com
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-17 00:00:00.000000000 Z
+date: 2026-10-15 00:00:00.000000000 Z
 dependencies: []
 description: Ruby package for easy integration with the API of 2captcha captcha solving
   service to bypass recaptcha, funcaptcha, geetest and solve any other captchas.
@@ -52,6 +52,7 @@ files:
 - examples/grid_captcha_example.rb
 - examples/hcaptcha_example.rb
 - examples/hunt_example.rb
+- examples/imperva_example.rb
 - examples/key_captcha_example.rb
 - examples/lemin_example.rb
 - examples/media/drag_drop/background.jpeg