solvecaptcha-ruby 1.0.0

data/api_solvecaptcha.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/api_solvecaptcha/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "solvecaptcha-ruby"
+  spec.version = ApiSolveCaptcha::VERSION
+  spec.authors = ["solvecaptcha.com"]
+
+  spec.summary = "Solvercaptcha API wrapper for Ruby."
+  spec.description = "Ruby package for easy integration with the API of solvecaptcha captcha solving service to bypass recaptcha, funcaptcha, geetest and solve any other captchas."
+  spec.homepage = "https://solvecaptcha.com//"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/solvercaptcha/solvecaptcha-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/solvercaptcha/solvecaptcha-ruby/releases"
+  spec.metadata["github_repo"] = "ssh://github.com/solvercaptcha/solvecaptcha-ruby"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/solvercaptcha/solvecaptcha-ruby/issues"
+  spec.metadata["keywords"] = "Solvercaptcha, 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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir       = "bin"
+  spec.executables  = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/examples/amazon_waf_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.amazon_waf({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/atb_captcha_example.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/api_solvecaptcha'
+
+client =  ApiSolveCaptcha.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_relative '../lib/api_solvecaptcha'
+
+client =  ApiSolveCaptcha.new("YOUR_API_KEY")
+
+result = client.audio({
+  audio: './media/example.mp3',
+  lang: "en"
+})
+
+puts "Result: #{result.inspect}"

data/examples/canvas_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.canvas({'canvas': 'BASE64_CANVAS_IMAGE'})
+
+puts result

data/examples/capy_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.capy({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com', 'api_server': 'https://api.capy.me'})
+
+puts result

data/examples/clickcaptcha_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.clickcaptcha({'img': 'BASE64_IMAGE', 'coords': '120,50;140,70'})
+
+puts result

data/examples/cutcaptcha_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.cutcaptcha({'captchakey': 'CAPTCHAKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/cybersiara_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.cybersiara({'siara_id': 'SIARA_ID', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/datadome_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.datadome({'captcha_url': 'https://example.com/captcha', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/friendlycaptcha_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.friendlycaptcha({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/funcaptcha_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.funcaptcha({'publickey': 'PUBLICKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/geetest_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.geetest({'gt': 'GT', 'challenge': 'CHALLENGE', 'api_server': 'https://api.geetest.com', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/geetest_v4_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.geetest_v4({'captcha_id': 'CAPTCHA_ID', 'lot_number': 'LOT_NUMBER', 'payload': '{}', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/grid_captcha_example.rb

@@ -0,0 +1,14 @@
+require_relative '../lib/api_solvecaptcha'
+
+client =  ApiSolveCaptcha.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_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.hcaptcha({
+  sitekey: 'SITEKEY',
+  pageurl: 'https://example.com'
+})
+
+puts result

data/examples/keycaptcha_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.keycaptcha({'s_s_c_user_id': 'USER_ID', 's_s_c_session_id': 'SESSION_ID', 's_s_c_web_server_sign': 'SIGN', 's_s_c_web_server_sign2': 'SIGN2', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/lemin_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.lemin({'captcha_id': 'CAPTCHA_ID', 'api_server': 'https://api.lemin.com', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/mtcaptcha_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.mtcaptcha({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/normal_captcha_example.rb

@@ -0,0 +1,15 @@
+require_relative "../lib/api_solvecaptcha"
+
+client = ApiSolveCaptcha.new("YOUR_API_KEY")
+
+image_path = File.join(__dir__, 'media', 'normal_2.jpg')
+
+puts "Image path: #{image_path}"
+puts "File exists: #{File.exist?(image_path)}"
+puts "File size: #{File.size?(image_path).to_i} bytes"
+
+result = client.normal({
+  image: image_path,
+})
+
+puts "Result: #{result.inspect}"

data/examples/recaptcha_enterprise_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.recaptcha_enterprise({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/recaptcha_v2_example.rb

@@ -0,0 +1,10 @@
+require_relative "../lib/api_solvecaptcha"
+
+client =  ApiSolveCaptcha.new("6663f112abc465058b7a9b448d3a0f54")
+
+result = client.recaptcha_v2({
+  googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',
+  pageurl: 'https://solvecaptcha.com/demo/recaptcha-v2',
+})
+
+puts "Result: #{result.inspect}"

data/examples/recaptcha_v3_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.recaptcha_v3({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/rotate_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.rotate({'body': 'BASE64_IMAGE'})
+
+puts result

data/examples/tencent_example.rb

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

data/examples/turnstile_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.turnstile({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/examples/yandex_smart_example.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/api_solvecaptcha'
+
+client = ApiSolveCaptcha::Client.new('YOUR_API_KEY')
+
+result = client.yandex_smart({'sitekey': 'SITEKEY', 'pageurl': 'https://example.com'})
+
+puts result

data/lib/api_solvecaptcha/api_solvecaptcha_exceptions.rb

@@ -0,0 +1,25 @@
+module ApiSolveCaptcha
+  class ValidationException < StandardError
+    def initialize(message = 'Invalid parameters passed')
+      super(message)
+    end
+  end
+
+  class NetworkException < StandardError
+    def initialize(message = 'Network error occurred')
+      super(message)
+    end
+  end
+
+  class ApiException < StandardError
+    def initialize(message = 'API response error')
+      super(message)
+    end
+  end
+
+  class TimeoutException < StandardError
+    def initialize(message = 'Captcha solving timed out')
+      super(message)
+    end
+  end
+end

data/lib/api_solvecaptcha/client.rb

@@ -0,0 +1,166 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'base64'
+require 'open-uri'
+require 'net/http/post/multipart'
+
+
+module ApiSolveCaptcha
+  class Client
+    DEFAULT_DOMAIN = "api.solvecaptcha.com"
+    BASE_URL_FORMAT = "https://%s"
+
+    attr_accessor :domain, :callback, :default_timeout,
+                  :soft_id, :recaptcha_timeout,
+                  :polling_interval, :api_key
+
+    def initialize(api_key, callback = nil)
+      @api_key = api_key
+      @soft_id = nil
+      @callback = callback
+      @default_timeout = 120
+      @recaptcha_timeout = 600
+      @polling_interval = 5
+      @domain = DEFAULT_DOMAIN
+    end
+
+    def solve(method, return_id: false, **params)
+      params["method"] = method
+      params["key"] = @api_key
+      params["json"] = 1
+
+      params["pingback"] = @callback if @callback
+
+      complete_params = get_params(params)
+      captcha_id = send_request(complete_params)
+      return captcha_id if return_id
+
+      get_result(captcha_id)
+    end
+
+    def normal(params)
+      solve("post", **params)
+    end
+
+    def get_result(captcha_id)
+      uri = URI("#{base_url}/res.php?key=#{@api_key}&action=get&id=#{captcha_id}&json=1")
+      start_time = Time.now
+
+      loop do
+        response = make_request(uri)
+
+        if response.is_a?(Net::HTTPSuccess)
+          response_json = JSON.parse(response.body.strip)
+
+          case response_json["request"]
+          when "CAPCHA_NOT_READY"
+            sleep @polling_interval
+          when /[a-zA-Z0-9]+/
+            return response_json
+          else
+            raise "API Error: #{response_json["request"]}"
+          end
+        else
+          raise "Network Error: #{response.code}"
+        end
+
+        raise "Timeout" if Time.now - start_time > @default_timeout
+      end
+    end
+
+    def report(captcha_id, is_correct)
+      action = is_correct ? "reportgood" : "reportbad"
+      uri = URI("#{base_url}/res.php?key=#{@api_key}&action=#{action}&id=#{captcha_id}")
+      make_request(uri)
+    end
+
+    private
+
+    def base_url
+      BASE_URL_FORMAT % @domain
+    end
+
+    def get_params(params)
+      params["image"].nil? ? params : file_params(params)
+    end
+
+    def file_params(params)
+      image = params.delete("image")
+      hint_image = params.delete("hint_image")
+
+      image_content = if base64_encoded?(image)
+        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
+
+      result_params = {
+        "method" => "base64",
+        "body" => image_content,
+        "filename" => File.basename(image),
+        "ext" => File.extname(image).delete(".")
+      }
+
+      result_params["imginstructions"] = hint_image_content if hint_image_content
+      params.merge(result_params)
+    end
+
+    def get_image_content(image)
+      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?
+    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
+      response.read
+    end
+
+
+    def send_request(params)
+      uri = URI("#{base_url}/in.php")
+    
+      file_path = params.delete("image")
+      file = UploadIO.new(File.open(file_path), mime_type(file_path), File.basename(file_path))
+    
+      form_data = params.merge("file" => file)
+    
+      req = Net::HTTP::Post::Multipart.new(uri.path, form_data)
+    
+      response = make_request(uri, req)
+    
+      if response.is_a?(Net::HTTPSuccess)
+        parsed_response = JSON.parse(response.body.strip)
+    
+        raise "API Error: #{parsed_response["request"]}" unless parsed_response["status"] == 1
+    
+        parsed_response["request"]
+      else
+        raise "Network Error: #{response.code}"
+      end
+    end
+    
+    def mime_type(file_path)
+      MIME::Types.type_for(file_path).first.to_s || "application/octet-stream"
+    end
+    
+
+    def make_request(uri, req = nil)
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req || Net::HTTP::Get.new(uri))
+      end
+    end
+  end
+end

data/lib/api_solvecaptcha/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiSolveCaptcha
+  VERSION = "1.0.0"
+end

data/lib/api_solvecaptcha.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "./api_solvecaptcha/api_solvecaptcha_exceptions"
+require_relative "./api_solvecaptcha/client"
+require_relative "./api_solvecaptcha/version"
+
+
+module ApiSolveCaptcha
+  def self.new(*args)
+    Client.new(*args)
+  end
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: solvecaptcha-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- solvecaptcha.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-22 00:00:00.000000000 Z
+dependencies: []
+description: Ruby package for easy integration with the API of solvecaptcha captcha
+  solving service to bypass recaptcha, funcaptcha, geetest and solve any other captchas.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- RELEASING.md
+- Rakefile
+- api_solvecaptcha.gemspec
+- examples/amazon_waf_example.rb
+- examples/atb_captcha_example.rb
+- examples/audio_example.rb
+- examples/canvas_example.rb
+- examples/capy_example.rb
+- examples/clickcaptcha_example.rb
+- examples/cutcaptcha_example.rb
+- examples/cybersiara_example.rb
+- examples/datadome_example.rb
+- examples/friendlycaptcha_example.rb
+- examples/funcaptcha_example.rb
+- examples/geetest_example.rb
+- examples/geetest_v4_example.rb
+- examples/grid_captcha_example.rb
+- examples/hcaptcha_example.rb
+- examples/keycaptcha_example.rb
+- examples/lemin_example.rb
+- examples/media/example.mp3
+- examples/media/normal_2.jpg
+- examples/media/recaptchaGrid4x4.jpg
+- examples/media/recaptchaGridImginstructions4x4.jpg
+- examples/mtcaptcha_example.rb
+- examples/normal_captcha_example.rb
+- examples/recaptcha_enterprise_example.rb
+- examples/recaptcha_v2_example.rb
+- examples/recaptcha_v3_example.rb
+- examples/rotate_example.rb
+- examples/tencent_example.rb
+- examples/turnstile_example.rb
+- examples/yandex_smart_example.rb
+- lib/api_solvecaptcha.rb
+- lib/api_solvecaptcha/api_solvecaptcha_exceptions.rb
+- lib/api_solvecaptcha/client.rb
+- lib/api_solvecaptcha/version.rb
+homepage: https://solvecaptcha.com//
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://solvecaptcha.com//
+  source_code_uri: https://github.com/solvercaptcha/solvecaptcha-ruby
+  changelog_uri: https://github.com/solvercaptcha/solvecaptcha-ruby/releases
+  github_repo: ssh://github.com/solvercaptcha/solvecaptcha-ruby
+  bug_tracker_uri: https://github.com/solvercaptcha/solvecaptcha-ruby/issues
+  keywords: Solvercaptcha, captcha solver, captcha bypass, Ruby, automation, CAPTCHA
+    API, CAPTCHA recognition, anti-captcha, reCAPTCHA, OCR, image recognition, human
+    verification, bot protection, recaptcha
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Solvercaptcha API wrapper for Ruby.
+test_files: []