two_captcha 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29bc40bcdecf08c3315a97224e2dbc0b7308f737
-  data.tar.gz: f16d6172e691101d63534746c83da27d109abdb0
+SHA256:
+  metadata.gz: 85dec926f62d43f6629fea1232276b55950cac27c107e64d064f6374f571c6b6
+  data.tar.gz: 9e962be8d8d1dd76f6cfe7644003a042b3bcccf216aa5d820fd057c95d930c22
 SHA512:
-  metadata.gz: 36c9c2bd793aba1dda0b4ce7414ab2b56ae5193c314714f6b2b33f22cec13ecc8ffbf29ac0fb997b866890079b3131b316a26c5a05274bc300e55d93072f6573
-  data.tar.gz: 0d7d9a545bdfa066e551031a824129635ca4b4f2639de54204bb2d7d2beeb8a9fc40b93e51bc1eba051836534b68ead71a595dff9be271300b1b6aa327710de3
+  metadata.gz: 11dc25d38866f051f13963f460c9b8d5b813d0960b4f1ce8fa3b0c589555d368021cae3994cd1e9d0e6f730940a6921fa91173a70e48a29ec25b7a3903ac814e
+  data.tar.gz: 762fd992e1b9fa35cfc91baf729d280d123298a46f92b75a6dc03e3b42294184d3a4c84cfc449b5d6d44615f54434c5a1d9c0b565ce1ab7d310cf907996b0d50

data/Changelog.md

@@ -0,0 +1,9 @@
+# TwoCaptcha Changes
+
+### 1.4.0
+
+* **breaking changes:**
+  * The method "decode_recaptcha_v2" now always return a TwoCaptcha::Captcha
+    object. It was returning a string when successful.
+* enhancements:
+  * Add tests to solve RecaptchaV2 with the preferred method.

data/README.md

@@ -1,4 +1,4 @@
-Developed by [Infosimples](https://infosimples.com), a [big data company](https://infosimples.com/en/data-engineering).
+Developed by [Infosimples](https://infosimples.com).
 
 # TwoCaptcha
 
@@ -66,10 +66,13 @@ Or install it yourself as:
   captcha = client.captcha('130920620') # with 130920620 as the captcha id
   ```
 
-4. **Report incorrectly solved captcha for refund**
+4. **Report incorrectly (for refund) or correctly (useful for reCAPTCHA v3) solved captcha**
 
   ```ruby
-  client.report!('130920620') # with 130920620 as the captcha id
+  client.report!('130920620', 'reportbad') # with 130920620 as the captcha id
+  # return true if successfully reported
+
+  client.report!('256892751', 'reportgood') # with 256892751 as the captcha id
   # return true if successfully reported
   ```
 
@@ -96,17 +99,18 @@ Or install it yourself as:
   # return an XML string with the current service load.
   ```
 
-## Clickable CAPTCHAs (e.g. "No CAPTCHA reCAPTCHA")
+## reCAPTCHA v2 (e.g. "No CAPTCHA reCAPTCHA")
 
 There are two ways of solving captchas similar to
 [reCAPTCHA v2](https://support.google.com/recaptcha/?hl=en#6262736).
 
 ### (Prefered) Sending the `googlekey` and `pageurl` parameters
 
-This method requires no browser emulation. You can send two parameters that identify website in which the captcha is found.
+This method requires no browser emulation. You can send two parameters that
+identify the website in which the captcha is found.
 
-Please read the oficial documentation at https://2captcha.com/newapi-recaptcha-en for
-more information.
+Please read the [oficial documentation](https://2captcha.com/newapi-recaptcha-en)
+for more information.
 
   ```ruby
   options = {
@@ -114,13 +118,16 @@ more information.
     pageurl: 'http://example.com/example=1'
   }
 
-  client.decode_recaptcha_v2(options)
+  captcha = client.decode_recaptcha_v2(options)
+  captcha.text        # Solution of the captcha
+  captcha.id          # Numeric ID of the captcha solved by TwoCaptcha
   ```
 
-  The response will be a code that validates the form, like the following:
+  The solution (`captcha.text`) will be a code that validates the form, like the
+  following:
 
   ```ruby
-  "03AHJ_VuuHAqJKxcTH6sbTsqw-L1Sm4gD57PTeaEr9-MaETG1vfu2H5zlcw0u2KqgjHPiXWwlulOw0Ef82tH6SOSbXdelgkvdDl8HreKFug05zfadw2n-A2HoTgYteVA53Q46VatEcZofa5eKfaWgvrPS-IP1DpV4bnUEG69-VbWAx7fJ-p4rHSxq-ZYesBkk9yYFrAiT_70uSz8lg3iqRImfRW91RIkEq8A5UBn4vABUQvlDV4eoKpeNUKDmHOABHkdsV8_1KEgCbabIwsIuIkN1_hw-Mkg0NRdWuXgNtOWen0Zv65yl6D31yhyLV2s0h3ygQwrpxJpBWs7o_rG2TaVfi0y9S5cYr-YlMTHszvMQCVllf5WAiNAgV28JuAnFH5WqRHqT56Tz6ZVNigIToEzq1tnfuewgmJuyyP_woy_MGRoZoHxx6V9yUDw8Ig-hYD8kakmSnnjNQd50w_Y_tI3aDLp-s_7ZmhH6pcaoWWsid5hdtMXyvrP9DscDuCLBf7etLle8caPWSaYCpAq9DOTtj5NpSg6-OeCJdGdgIPT9Xdbo_dm4pLGZ0CNd5WQcjil_kZN_uErRssv9r8j5SC6tsIPBneQLqqqsg8Hyt9kjIh0N10d6-sFeV3QWw-OuzCrPSNYc-_AxvwaB0GUAOmHDDbj8kKz1oqfdBwJienRm246cbstqdc7uAHHuLWLpt1A5W-56PEbb3Zs-HNo3kcjvlJcfrOVJKW68-G3S635EJ9SBm9GFKzFojEu4-TF9CvYNJKaXY9dDev_TVbBaWpWN2Ctx5hHKRbtD1_g2LsGUTDkpo7wrf4pbAyP34zeMRBI1wrrV12PBKnuafaMjy2KIFLt0LM91uWiBzEC61AiSKKEwP2nydRIyIFGwbLFUMeGeqmje87wSajcjmdjl_w4XZBY2zy8fUH6XoAGZ6AeCTulIljBQDObQynKDd-rutPvKNxZw3sra3yRt9ziDVKKDk-LbhTfw508g1lu9io6jnvm3kbAdnkfZ0x0PkGiUMHU7hnuoW6bXo2Yn_Zt5tDWL7N7wFtY6B0k7cTy73f8er508zReOuoyz2NqL8smDCmcJu05kr5R6OVHfeUszn5OiYeVh8Q_gTMsEf4wdaOsQWGZhWQIS8Vi_6IYzwQsnOtYdI6T8q4IDrQh-9eemVn0gNI6gdyknStQ7DoujdPGt20qzpURMwHaw"
+  "1JJHJ_VuuHAqJKxcaasbTsqw-L1Sm4gD57PTeaEr9-MaETG1vfu2H5zlcwkjsRoZoHxx6V9yUDw8Ig-hYD8kakmSnnjNQd50w_Y_tI3aDLp-s_7ZmhH6pcaoWWsid5hdtMXyvrP9DscDuCLBf7etLle8caPWSaYCpAq9DOTtj5NpSg6-OeCJdGdkjsakFUMeGeqmje87wSajcjmdjl_w4XZBY2zy8fUH6XoAGZ6AeCTulIljBQDObQynKDd-rutPvKNxZasDk-LbhTfw508g1lu9io6jnvm3kbAdnkfZ0x0PkGiUMHU7hnuoW6bXo2Yn_Zt5tDWL7N7wFtY6B0k7cTy73f8er508zReOuoyz2NqL8smDCmcJu05ajkPGt20qzpURMwHaw"
   ```
 
 ### Sending the challenge image
@@ -161,6 +168,61 @@ The response will be a simple text:
 '61267'
 ```
 
+## reCAPTCHA v3
+
+This method requires no browser emulation. You can send four parameters that
+identify the website in which the CAPTCHA is found and the minimum score
+(0.3, 0.5 or 0.7) you desire.
+
+**It's strongly recommended to use a minimum score of 0.3 as higher scores are extremely rare.**
+
+Please read the [oficial documentation](https://2captcha.com/2captcha-api#solving_recaptchav3)
+for more information.
+
+  ```ruby
+  options = {
+    googlekey: 'xyz',
+    pageurl:   'http://example.com/example=1',
+    action:    'verify',
+    min_score: 0.3
+  }
+
+  captcha = client.decode_recaptcha_v3(options)
+  captcha.text        # Solution of the captcha
+  captcha.id          # Numeric ID of the captcha solved by TwoCaptcha
+  ```
+
+The solution (`captcha.text`) will be a code that validates the form, like the
+following:
+
+  ```ruby
+  "1JJHJ_VuuHAqJKxcaasbTsqw-L1Sm4gD57PTeaEr9-MaETG1vfu2H5zlcwkjsRoZoHxx6V9yUDw8Ig-hYD8kakmSnnjNQd50w_Y_tI3aDLp-s_7ZmhH6pcaoWWsid5hdtMXyvrP9DscDuCLBf7etLle8caPWSaYCpAq9DOTtj5NpSg6-OeCJdGdkjsakFUMeGeqmje87wSajcjmdjl_w4XZBY2zy8fUH6XoAGZ6AeCTulIljBQDObQynKDd-rutPvKNxZasDk-LbhTfw508g1lu9io6jnvm3kbAdnkfZ0x0PkGiUMHU7hnuoW6bXo2Yn_Zt5tDWL7N7wFtY6B0k7cTy73f8er508zReOuoyz2NqL8smDCmcJu05ajkPGt20qzpURMwHaw"
+  ```
+
+## hCaptcha
+
+  This method allows you to solve hCaptcha.
+
+  There are two methods available:
+
+  - `decode_hcaptcha`: solves hCaptcha CAPTCHAs. It doesn't raise exceptions.
+  - `decode_hcaptcha!`: solves hCaptcha CAPTCHAs. It may raise an error if something goes wrong.
+
+  **Send the `sitekey` and `pageurl` parameters**
+
+  This method requires no browser emulation. You can send two parameters that
+  identify the website in which the CAPTCHA is found.
+
+  ```ruby
+  options = {
+    sitekey: 'xyz',
+    pageurl: 'http://example.com/example=1'
+  }
+
+  captcha = client.decode_hcaptcha!(options)
+  captcha.text # Solution of the captcha
+  ```
+
 ## Notes
 
 #### Thread-safety

data/lib/two_captcha/client.rb

@@ -105,32 +105,114 @@ module TwoCaptcha
 
       fail(TwoCaptcha::GoogleKey) if options[:googlekey].empty?
 
-      payload_in = {
+      upload_options = {
         method: 'userrecaptcha',
         googlekey: options[:googlekey],
         pageurl: options[:pageurl]
       }
+      decoded_captcha = upload(upload_options)
 
-      response_in = request('in', :get, payload_in)
-      status, captcha_id = response_in.split('|')
+      # pool untill the answer is ready
+      while decoded_captcha.text.to_s.empty?
+        sleep([polling, 10].max) # sleep at least 10 seconds
+        decoded_captcha = captcha(decoded_captcha.id)
+        fail TwoCaptcha::Timeout if (Time.now - started_at) > timeout
+      end
 
-      payload_res = {
-        action: 'get',
-        json: '1',
-        id: captcha_id
+      decoded_captcha
+    end
+
+    #
+    # Solve reCAPTCHA v3.
+    #
+    # @param [Hash] options Options hash. Check docs for the method decode!.
+    #
+    # @return [TwoCaptcha::Captcha] The solution of the given captcha.
+    #
+    def decode_recaptcha_v3(options = {})
+      decode_recaptcha_v3!(options)
+    rescue TwoCaptcha::Error => ex
+      TwoCaptcha::Captcha.new
+    end
+
+    #
+    # Solve reCAPTCHA v3.
+    #
+    # @param [Hash] options Options hash.
+    # @option options [String]  :googlekey The open key of the site in which recaptcha is installed.
+    # @option options [String]  :pageurl The URL of the page where the recaptcha is encountered.
+    # @option options [String]  :action The action paramenter present on the page that uses recaptcha.
+    # @option options [String]  :min_score The minimum score necessary to pass the challenge.
+    #
+    # @return [TwoCaptcha::Captcha] The solution of the given captcha.
+    #
+    def decode_recaptcha_v3!(options = {})
+      started_at = Time.now
+
+      fail(TwoCaptcha::GoogleKey) if options[:googlekey].empty?
+
+      upload_options = {
+        method:    'userrecaptcha',
+        version:   'v3',
+        googlekey: options[:googlekey],
+        pageurl:   options[:pageurl],
+        action:    options[:action],
+        min_score: options[:min_score]
       }
+      decoded_captcha = upload(upload_options)
 
-      response_res = request('res', :get, payload_res)
-      result = JSON.load(response_res)
+      # pool untill the answer is ready
+      while decoded_captcha.text.to_s.empty?
+        sleep([polling, 10].max) # sleep at least 10 seconds
+        decoded_captcha = captcha(decoded_captcha.id)
+        fail TwoCaptcha::Timeout if (Time.now - started_at) > timeout
+      end
 
-      while ['CAPCHA_NOT_READY', 'CAPTCHA_NOT_READY'].include? result['request']
-        sleep(polling)
-        response_res = request('res', :get, payload_res)
-        result = JSON.load(response_res)
+      decoded_captcha
+    end
+
+    #
+    # Solve hCaptcha.
+    #
+    # @param [Hash] options Options hash. Check docs for the method decode_hcaptcha!.
+    #
+    # @return [TwoCaptcha::Captcha] The solution of the given captcha.
+    #
+    def decode_hcaptcha(options = {})
+      decode_hcaptcha!(options)
+    rescue TwoCaptcha::Error => ex
+      TwoCaptcha::Captcha.new
+    end
+
+    #
+    # Solve hCaptcha.
+    #
+    # @param [Hash] options Options hash.
+    # @option options [String]  :sitekey The  key of the site in which hCaptcha is installed.
+    # @option options [String]  :pageurl The URL of the page where the recaptcha is encountered.
+    #
+    # @return [TwoCaptcha::Captcha] The solution of the given captcha.
+    #
+    def decode_hcaptcha!(options = {})
+      started_at = Time.now
+
+      fail(TwoCaptcha::GoogleKey) if options[:sitekey].empty?
+
+      upload_options = {
+        method:    'hcaptcha',
+        sitekey:   options[:sitekey],
+        pageurl:   options[:pageurl]
+      }
+      decoded_captcha = upload(upload_options)
+
+      # pool untill the answer is ready
+      while decoded_captcha.text.to_s.empty?
+        sleep([polling, 10].max) # sleep at least 10 seconds
+        decoded_captcha = captcha(decoded_captcha.id)
         fail TwoCaptcha::Timeout if (Time.now - started_at) > timeout
       end
 
-      result['request']
+      decoded_captcha
     end
 
     # Upload a captcha to 2Captcha.
@@ -141,8 +223,8 @@ module TwoCaptcha
     #
     def upload(options = {})
       args = {}
-      args[:body]   = options[:raw64]
-      args[:method] = 'base64'
+      args[:body]   = options[:raw64] if options[:raw64]
+      args[:method] = options[:method] || 'base64'
       args.merge!(options)
       response = request('in', :multipart, args)
 
@@ -178,11 +260,12 @@ module TwoCaptcha
     # Report incorrectly solved captcha for refund.
     #
     # @param [Integer] id Numeric ID of the captcha.
+    # @param [Integer] action 'reportbad' (default) or 'reportgood'.
     #
     # @return [Boolean] true if correctly reported
     #
-    def report!(captcha_id)
-      response = request('res', :get, action: 'reportbad', id: captcha_id)
+    def report!(captcha_id, action = 'reportbad')
+      response = request('res', :get, action: action, id: captcha_id)
       response == 'OK_REPORT_RECORDED'
     end
 

data/lib/two_captcha/errors.rb

@@ -14,6 +14,24 @@ module TwoCaptcha
     end
   end
 
+  class Timeout < Error
+    def initialize
+      super('The captcha was not solved in the expected time')
+    end
+  end
+
+  class GoogleKey < Error
+    def initialize
+      super('Missing googlekey parameter')
+    end
+  end
+
+  class SiteKey < Error
+    def initialize
+      super('Missing sitekey parameter')
+    end
+  end
+
   class WrongUserKey < Error
     def initialize
       super('Wrong “key” parameter format, it should contain 32 symbols')
@@ -92,15 +110,27 @@ module TwoCaptcha
     end
   end
 
-  class Timeout < Error
+  class CaptchaImageBlocked < Error
     def initialize
-      super('The captcha was not solved in the expected time')
+      super('You have sent an image, that is unrecognizable and which is saved in our database as such. Usually this happens when the site where you get the captcha from has stopped sending you captcha and started giving you a “deny access” cap.')
     end
   end
 
-  class GoogleKey < Error
+  class WrongCaptchaId < Error
     def initialize
-      super('Missing googlekey parameter')
+      super('You are trying to get the answer or complain a captcha that was submitted more than 15 minutes ago.')
+    end
+  end
+
+  class BadDuplicates < Error
+    def initialize
+      super('Error is returned when 100% accuracy feature is enabled. The error means that max numbers of tries is reached but min number of matches not found.')
+    end
+  end
+
+  class ReportNotRecorded < Error
+    def initialize
+      super('Error is returned to your complain request (reportbad) if you already complained lots of correctly solved captchas.')
     end
   end
 
@@ -118,6 +148,10 @@ module TwoCaptcha
     'ERROR_WRONG_ID_FORMAT'          => TwoCaptcha::WrongIdFormat,
     'ERROR_CAPTCHA_UNSOLVABLE'       => TwoCaptcha::CaptchaUnsolvable,
     'ERROR_EMPTY_ACTION'             => TwoCaptcha::EmptyAction,
-    'ERROR_GOOGLEKEY'                => TwoCaptcha::GoogleKey
+    'ERROR_GOOGLEKEY'                => TwoCaptcha::GoogleKey,
+    'ERROR_CAPTCHAIMAGE_BLOCKED'     => TwoCaptcha::CaptchaImageBlocked,
+    'ERROR_WRONG_CAPTCHA_ID'         => TwoCaptcha::WrongCaptchaId,
+    'ERROR_BAD_DUPLICATES'           => TwoCaptcha::BadDuplicates,
+    'REPORT_NOT_RECORDED'            => TwoCaptcha::ReportNotRecorded,
   }
 end

data/lib/two_captcha/version.rb

@@ -1,4 +1,4 @@
 module TwoCaptcha
-  VERSION = '1.3.0'
+  VERSION = '1.6.0'
   USER_AGENT = "TwoCaptcha/Ruby v#{VERSION}"
 end

data/spec/lib/client_spec.rb

@@ -92,4 +92,22 @@ describe TwoCaptcha::Client do
       it { expect(@captcha.id).to match(/[0-9]{9}/) }
     end
   end
+
+  context 'image reCAPTCHA v2' do
+    before(:all) { @client = TwoCaptcha.new(key) }
+
+    describe '#decode_recaptcha_v2!' do
+      before(:all) do
+        options = {
+          googlekey: '6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-',
+          pageurl: 'https://www.google.com/recaptcha/api2/demo'
+        }
+        @captcha = @client.decode_recaptcha_v2!(options)
+      end
+
+      it { expect(@captcha).to be_a(TwoCaptcha::Captcha) }
+      it { expect(@captcha.text.size).to be > 50 } # not perfect, I know
+      it { expect(@captcha.id).to match(/[0-9]{9}/) }
+    end
+  end
 end

data/two_captcha.gemspec

@@ -6,7 +6,7 @@ require 'two_captcha/version'
 Gem::Specification.new do |spec|
   spec.name          = "two_captcha"
   spec.version       = TwoCaptcha::VERSION
-  spec.authors       = ["Marcelo Mita", "Rafael Barbolo"]
+  spec.authors       = ["Rafael Barbolo", "Rafael Ivan Garcia"]
   spec.email         = ["team@infosimples.com.br"]
   spec.summary       = %q{Ruby API for 2Captcha (Captcha Solver as a Service)}
   spec.description   = %q{TwoCaptcha allows you to solve captchas with manual labor}
@@ -14,7 +14,11 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  # Since our currently binstubs are used only during the gem's development, we
+  # are ignoring them in the gem specification.
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: two_captcha
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
-- Marcelo Mita
 - Rafael Barbolo
-autorequire: 
+- Rafael Ivan Garcia
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,9 +56,7 @@ dependencies:
 description: TwoCaptcha allows you to solve captchas with manual labor
 email:
 - team@infosimples.com.br
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -66,6 +64,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -89,7 +88,7 @@ homepage: https://github.com/infosimples/two_captcha
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,9 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Ruby API for 2Captcha (Captcha Solver as a Service)
 test_files: