ruby-2captcha 1.1.5 → 1.2.0

data/api_2captcha.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["info@2captcha.com"]
 
   spec.summary = "2Captcha API wrapper for Ruby."
-  spec.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."
+  spec.description = "Ruby package for easy integration with the API of 2captcha captcha solving service to bypass recaptcha, funcaptcha, geetest and solve any other captchas."
   spec.homepage = "https://2captcha.com/"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/2captcha/2captcha-ruby"
   spec.metadata["changelog_uri"] = "https://github.com/2captcha/2captcha-ruby/releases"
   spec.metadata["github_repo"] = "ssh://github.com/2captcha/2captcha-ruby"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/2captcha/2captcha-ruby/issues"
+  spec.metadata["keywords"] = "2captcha, captcha solver, captcha bypass, Ruby, automation, CAPTCHA API, CAPTCHA recognition, anti-captcha, reCAPTCHA, OCR, image recognition, human verification, bot protection, recaptcha"
+
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/examples/alibaba_example.rb

@@ -0,0 +1,16 @@
+
+require_relative '../lib/api_2captcha'
+
+client = Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.alibaba({
+    pageurl: "https://example.com/page-with-alibaba",
+    scene_id: "SCENE_ID",
+    prefix: "PREFIX"
+  })
+rescue StandardError => e
+  puts(e)
+end
+
+puts "Result: #{result.inspect}"

data/examples/altcha_example.rb

@@ -0,0 +1,12 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.altcha({
+    pageurl: 'https://mysite.com/page/with/altcha',
+    challenge: '{"algorithm":"SHA-256","challenge":"a4c9d8e7f1b23a6c...","signature":"7b3e2a9d5c8f1046e2d91c3a..."}'
+    # or:
+    # challenge_url: 'https://example.com/altcha-challenge'
+})
+
+puts "Result: #{result.inspect}"

data/examples/amazon_waf_example.rb

@@ -0,0 +1,14 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.amazon_waf({
+  sitekey: '0x1AAAAAAAAkg0s2VIOD34y5',
+  iv: 'CgAHbCe2GgAAAAAj',
+  context: '9BUgmlm48F92WUoqv97a49ZuEJJ50TCk9MVr3C7WMtQ0X6flVbufM4n8mjFLmbLVAPgaQ1Jydeaja94iAS49ljb+sUNLoukWedAQZKrlY4RdbOOzvcFqmD/ZepQFS9N5w15Exr4VwnVq+HIxTsDJwRviElWCdzKDebN/mk8/eX2n7qJi5G3Riq0tdQw9+C4diFZU5E97RSeahejOAAJTDqduqW6uLw9NsjJBkDRBlRjxjn5CaMMo5pYOxYbGrM8Un1JH5DMOLeXbq1xWbC17YSEoM1cRFfTgOoc+VpCe36Ai9Kc=',
+  pageurl: 'https://non-existent-example.execute-api.us-east-1.amazonaws.com/latest',
+  challenge_script: "https://41bcdd4fb3cb.610cd090.us-east-1.token.awswaf.com/41bcdd4fb3cb/0d21de737ccb/cd77baa6c832/challenge.js",
+  captcha_script: "https://41bcdd4fb3cb.610cd090.us-east-1.captcha.awswaf.com/41bcdd4fb3cb/0d21de737ccb/cd77baa6c832/captcha.js"
+})
+
+puts "Result: #{result.inspect}"

data/examples/atb_captcha_example.rb

@@ -0,0 +1,11 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.atb_captcha({
+  app_id: "197326679",
+  api_server: "api.atb_captcha.com",
+  pageurl: "https://mysite.com/page/with/atb_captcha"
+})
+
+puts "Result: #{result.inspect}"

data/examples/audio_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.audio({
+  audio: './media/example.mp3',
+  lang: "en"
+})
+
+puts "Result: #{result.inspect}"

data/examples/basilisk_example.rb

@@ -0,0 +1,15 @@
+
+require_relative '../lib/api_2captcha'
+
+client = Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.basilisk({
+    pageurl: "https://example.com/page-with-basilisk",
+    sitekey: "SITE_KEY"
+  })
+rescue StandardError => e
+  puts(e)
+end
+
+puts "Result: #{result.inspect}"

data/examples/binance_example.rb

@@ -0,0 +1,17 @@
+
+require_relative '../lib/api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+begin
+result = client.binance({
+          sitekey => "login",
+          url     => "https://example.com/page-with-binance",
+          validate_id => "cb0bfef...e54ecd57b"
+})
+rescue StandardError => e
+    puts(e)
+end
+
+
+puts "Result: #{result.inspect}"

data/examples/canvas_example.rb

@@ -0,0 +1,13 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.canvas({
+  image: 'path/to/captcha.jpg',
+  previous_id: 0,
+  lang: 'en',
+  hint_image: 'path/to/hint.jpg',
+  hint_text: 'Draw around apple'
+})
+
+puts "Result: #{result.inspect}"

data/examples/captchafox_example.rb

@@ -0,0 +1,20 @@
+
+require_relative '../lib/api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.captchafox({
+        sitekey: "sk_vKdD8WGlPF5FKpRDs1U4qTuu6Jv0w",
+        pageurl: "https://sinscrire.gmx.fr/",
+        api_server: "https://mam.example.com",
+        userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36",
+        proxytype: "socks5",
+        proxy: "u37d88e6957ca05d6-zone-custom-region-fr:u37d88e6957ca05d6@118.193.59.17:10743"
+               })
+
+rescue StandardError => e
+    puts(e)
+end
+
+puts "Result: #{result.inspect}"

data/examples/capy_example.rb

@@ -0,0 +1,11 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.capy({
+  sitekey: 'PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
+  pageurl: 'http://mysite.com/',
+  api_server: 'https://jp.api.capy.me/'
+})
+
+puts "Result: #{result.inspect}"

data/examples/cloudflare_turnstile_example.rb

@@ -0,0 +1,15 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.turnstile({
+  sitekey: "0x0AAAAAAADnPIDROzbs0Aaj",
+  data: "7fab0000b0e0ff00",
+  pagedata: "3gAFo2...0ME1UVT0=",
+  pageurl: "https://2captcha.com/",
+  action: "managed",
+  userAgent: "Mozilla/5.0 ... Chrome/116.0.0.0 Safari/537.36",
+  json: 1
+})
+
+puts "Result: #{result.inspect}"

data/examples/coordinates_example.rb

@@ -0,0 +1,12 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.coordinates({
+  image: 'path/to/captcha.jpg',
+  lang: 'en',
+  hint_image: 'path/to/hint.jpg',
+  hint_text: 'Connect the dots'
+})
+
+puts "Result: #{result.inspect}"

data/examples/cut_captcha_example.rb

@@ -0,0 +1,11 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.cutcaptcha({
+  misery_key: "a1488b66da00bf332a1488993a5443c79047e752",
+  api_key: "SAb83IIB",
+  pageurl: "https://example.cc/foo/bar.html"
+})
+
+puts "Result: #{result.inspect}"

data/examples/cyber_siara_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.cyber_siara({
+  pageurl: "https://test.com",
+  master_url_id: "12333-3123123"
+})
+
+puts "Result: #{result.inspect}"

data/examples/datadome_example.rb

@@ -0,0 +1,12 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.data_dome({
+  pageurl: "https://test.com",
+  captcha_url: "https://test.com/captcha/",
+  proxytype: "http",
+  proxy: "proxyuser:strongPassword@123.123.123.123:3128"
+})
+
+puts "Result: #{result.inspect}"

data/examples/drag_drop_example.rb

@@ -0,0 +1,24 @@
+require_relative "../lib/api_2captcha"
+
+client = Api2Captcha.new(ARGV[0])
+
+# NOTE: images below are placeholder illustrations, not a real captcha demo.
+backgroundFile = File.expand_path("../media/drag_drop/background.jpeg", __FILE__)
+image1File = File.expand_path("../media/drag_drop/image1.jpeg", __FILE__)
+image2File = File.expand_path("../media/drag_drop/image2.jpeg", __FILE__)
+
+backgroundStr = Base64.strict_encode64(File.binread(backgroundFile))
+image1Str = Base64.strict_encode64(File.binread(image1File))
+image2Str = Base64.strict_encode64(File.binread(image2File))
+
+begin
+  result = client.drag_drop({
+    body: backgroundStr,
+    images: [image1Str, image2Str],
+    textinstructions: "Drag the images to proper position"
+  })
+rescue StandardError => e
+  puts(e)
+end
+
+puts "Result: #{result.inspect}"

data/examples/friendly_captcha_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.friendly({
+  pageurl: "https://example.com",
+  sitekey: "2FZFEVS1FZCGQ9"
+})
+
+puts "Result: #{result.inspect}"

data/examples/funcaptcha_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.funcaptcha({
+   publickey: "69A21A01-CC7B-B9C6-0F9A-E7FA06677FFC",
+   pageurl: "https://mysite.com/page/with/funcaptcha",
+   surl: "https://client-api.arkoselabs.com"})
+
+puts "Result: #{result.inspect}"

data/examples/geetest_example.rb

@@ -0,0 +1,12 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.geetest({
+  gt: 'f1ab2cdefa3456789012345b6c78d90e',
+  api_server: 'api-na.geetest.com',
+  challenge: '12345678abc90123d45678ef90123a456b',
+  pageurl: 'https://www.site.com/page/'
+})
+
+puts "Result: #{result.inspect}"

data/examples/geetest_v4_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.geetest_v4({
+  captcha_id: 'e392e1d7fd421dc63325744d5a2b9c73',
+  pageurl: 'https://www.site.com/page/'
+})
+
+puts "Result: #{result.inspect}"

data/examples/grid_captcha_example.rb

@@ -0,0 +1,14 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.grid({
+  image: './media/recaptchaGrid4x4.jpg',
+  rows: 4,
+  cols: 4,
+  lang: 'en',
+  hint_image: './media/recaptchaGridImginstructions4x4.jpg',
+  # hint_text: 'Select all squares with stairs'
+})
+
+puts "Result: #{result.inspect}"

data/examples/hcaptcha_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.hcaptcha({
+  sitekey: '10000000-ffff-ffff-ffff-000000000001',
+  pageurl: 'https://www.site.com/page/'
+})
+
+puts "Result: #{result.inspect}"

data/examples/hunt_example.rb

@@ -0,0 +1,17 @@
+require_relative "../lib/api_2captcha"
+
+client = Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.hunt({
+                         pageurl: "https://example.com/page-with-hunt",
+                         api_get_lib: "https://example.com/hd-api/external/apps/app-id/api.js",
+                         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/key_captcha_example.rb

@@ -0,0 +1,13 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.keycaptcha({
+  s_s_c_user_id: 10,
+  s_s_c_session_id: '493e52c37c10c2bcdf4a00cbc9ccd1e8',
+  s_s_c_web_server_sign: '9006dc725760858e4c0715b835472f22-pz-',
+  s_s_c_web_server_sign2: '2ca3abe86d90c6142d5571db98af6714',
+  pageurl: 'https://www.keycaptcha.ru/demo-magnetic/'
+})
+
+puts "Result: #{result.inspect}"

data/examples/lemin_example.rb

@@ -0,0 +1,12 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.lemin({
+  captcha_id: 'CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
+  div_id: 'lemin-cropped-captcha',
+  pageurl: 'https://www.site.com/page/',
+  api_server: "https://api.leminnow.com/"
+})
+
+puts "Result: #{result.inspect}"

data/examples/mt_captcha_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.mt_captcha({
+  pageurl: "https://service.mtcaptcha.com/mtcv1/demo/index.html",
+  sitekey: "MTPublic-DemoKey9M"
+})
+
+puts "Result: #{result.inspect}"

data/examples/normal_captcha_example.rb

@@ -0,0 +1,11 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+image_absolute_path = File.expand_path("../media/normal_2.jpg", __FILE__)
+
+result = client.normal({
+  image: image_absolute_path,
+})
+
+puts "Result: #{result.inspect}"

data/examples/prosopo_example.rb

@@ -0,0 +1,16 @@
+
+require_relative '../lib/api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+begin
+result = client.prosopo({
+  pageurl: "https://www.twickets.live/",
+  sitekey: "5EZVvsHMrKCFKp5NYNoTyDjTjetoVo1Z4UNNbTwJf1GfN6Xm",
+})
+rescue StandardError => e
+    puts(e)
+end
+
+
+puts "Result: #{result.inspect}"

data/examples/recaptcha_v2_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+result = client.recaptcha_v2({
+  googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',
+  pageurl: 'https://2captcha.com/demo/recaptcha-v2',
+})
+
+puts "Result: #{result.inspect}"

data/examples/recaptcha_v3_example.rb

@@ -0,0 +1,18 @@
+require_relative '../lib/api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+begin
+result = client.recaptcha_v3({
+                               googlekey: "6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u",
+                               pageurl: "http://2captcha.com/demo/recaptcha-v3",
+                               version: "v3",
+                               score: 0.3,
+                               action: "verify"
+                             })
+rescue StandardError => e
+    puts(e)
+end
+
+
+puts "Result: #{result.inspect}"

data/examples/rotate_example.rb

@@ -0,0 +1,13 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.rotate({
+  image: 'path/to/captcha.jpg',
+  angle: 40,
+  lang: 'en',
+  hint_image: 'path/to/hint.jpg',
+  hint_text: 'Put the images in the correct way'
+})
+
+puts "Result: #{result.inspect}"

data/examples/temu_example.rb

@@ -0,0 +1,28 @@
+
+require_relative '../lib/api_2captcha'
+
+client =  Api2Captcha.new(ARGV[0])
+
+bodyFile = File.expand_path("../media/temu/body.png", __FILE__)
+part1File = File.expand_path("../media/temu/part1.png", __FILE__)
+part2File = File.expand_path("../media/temu/part2.png", __FILE__)
+part3File = File.expand_path("../media/temu/part3.png", __FILE__)
+
+bodyStr = Base64.strict_encode64(File.binread(bodyFile))
+part1Str = Base64.strict_encode64(File.binread(part1File))
+part2Str = Base64.strict_encode64(File.binread(part2File))
+part3Str = Base64.strict_encode64(File.binread(part3File))
+
+begin
+result = client.temu({
+  body: bodyStr,
+  part1: part1Str,
+  part2: part2Str,
+  part3: part3Str,
+})
+rescue StandardError => e
+    puts(e)
+end
+
+
+puts "Result: #{result.inspect}"

data/examples/tencent_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.tencent({
+  app_id: "197326679",
+  pageurl: "https://mysite.com/page/with/tencent"
+})
+
+puts "Result: #{result.inspect}"

data/examples/text_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.text({
+  textcaptcha:'If tomorrow is Saturday, what day is today?',
+  lang: "en"
+})
+
+puts "Result: #{result.inspect}"

data/examples/tspd_example.rb

@@ -0,0 +1,19 @@
+
+require_relative '../lib/api_2captcha'
+
+client = Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.tspd({
+    pageurl: "https://example.com/page-with-tspd",
+    tspd_cookie: "TS...",
+    html_page_base64: "PGh0bWw+...",
+    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/vkcaptcha_example.ru

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.vkcaptcha({
+  redirect_uri: 'https://id.vk.com/not_robot_captcha?domain=vk.com&session_token=eyJ....HGsc5B4LyvjA&variant=popup&blank=1',
+  userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36'
+})
+
+puts "Result: #{result.inspect}"

data/examples/vkimage_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.vkimage({
+  image: '/9j/4AAQSkZJRgABAQAAAQABAAD/2...',
+  steps: '[5,19,14,14,6,4,8...]'
+})
+
+puts "Result: #{result.inspect}"

data/examples/yandex_example.rb

@@ -0,0 +1,10 @@
+require 'api_2captcha'
+
+client =  Api2Captcha.new("YOUR_API_KEY")
+
+result = client.yandex({
+  sitekey: 'Y5Lh0tiycconMJGsFd3EbbuNKSp1yaZESUOIHfeV',
+  url: "https://rutube.ru"
+})
+
+puts "Result: #{result.inspect}"

data/examples/yidun_example.rb

@@ -0,0 +1,15 @@
+
+require_relative '../lib/api_2captcha'
+
+client = Api2Captcha.new(ARGV[0])
+
+begin
+  result = client.yidun({
+    pageurl: "https://example.com/page-with-yidun",
+    sitekey: "SITE_KEY"
+  })
+rescue StandardError => e
+  puts(e)
+end
+
+puts "Result: #{result.inspect}"

data/howto.txt

@@ -0,0 +1,8 @@
+
+ruby examples/prosopo_example.rb API_KEY
+
+API_KEY=API_KEY_123 rspec spec/api_2captcha_spec.rb --tag recaptcha_v3
+
+rake spec
+rake -T
+ruby api_2captcha_spec.rb