two_captcha 1.3.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59c78a3d0fc1086113ee19839c34915f2ee25dfd
-  data.tar.gz: 93324acc8b929a1ce9afd091854fb613a65b1880
+SHA256:
+  metadata.gz: 9d9f28e64ed32b2c3bb8973f14bea2dbb15828550806d0306e6bdbdf07815562
+  data.tar.gz: eaa46657370a298929c7e5f49104abb3f696a74cddeddb8f1052a1f3c2140b8d
 SHA512:
-  metadata.gz: 1bbb44cd113201bc56e8f1a29bc3f933a5a0e2e9f5fc90eb69c33c381768ca8b3822ac1175a64289e52e8bbe6bb2d3a525587704388c57865fb6582460de7288
-  data.tar.gz: 4cd54178eefe7b37bf5a21451bf35cbd8d03a03056bb8c9783756198f6e8591820ceba41b7a373e902415a51801685212040dbafe586a27eda428dff9fa7325d
+  metadata.gz: cc567f2ecf5c0771e1b1ca7cade9c44a33abe2a224256132d2d8326798b998f5b8750fdbb489995c320a705f68ed7d9bb685450c87174c71389d987eb06258a0
+  data.tar.gz: dac73380663bc6471b233db9b30a6d2be296b27fa92131a3beaf54f7a155d503658c7ad53accf1e500eb50704413bd9af931793f6ccc200251dce157f5dbe1f3

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

@@ -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,76 @@ 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
+  ```
+
+## Using proxy or other custom options
+
+You are allowed to use custom options like `proxy`, `proxytype` or `userAgent` whenever the 2Captcha API supports it. Example:
+
+  ```ruby
+  options = {
+    sitekey: 'xyz',
+    pageurl: 'http://example.com/example=1',
+    proxy: 'login:password@123.123.123.123:3128',
+    userAgent: 'user agent'
+  }
+
+  captcha = client.decode_hcaptcha!(options)
+  ```
+
 ## Notes
 
 #### Thread-safety

data/lib/two_captcha/client.rb

@@ -18,9 +18,9 @@ module TwoCaptcha
     # @return [TwoCaptcha::Client] A Client instance.
     #
     def initialize(key, options = {})
-      self.key    = key
-      self.timeout  = options[:timeout] || 60
-      self.polling  = options[:polling] || 5
+      self.key     = key
+      self.timeout = options[:timeout] || 60
+      self.polling = options[:polling] || 5
     end
 
     # Decode the text from an image (i.e. solve a captcha).
@@ -105,30 +105,102 @@ module TwoCaptcha
 
       fail(TwoCaptcha::GoogleKey) if options[:googlekey].empty?
 
-      payload_in = {
-        method: 'userrecaptcha',
-        googlekey: options[:googlekey],
-        pageurl: options[:pageurl]
-      }
+      upload_options = { method: 'userrecaptcha' }.merge(options)
+      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
+
+      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
 
-      payload_res = {
-        action: 'get',
-        json: '1',
-        id: captcha_id
-      }
+      fail(TwoCaptcha::GoogleKey) if options[:googlekey].empty?
 
-      response_res = request('res', :get, payload_res)
+      upload_options = {
+        method:  'userrecaptcha',
+        version: 'v3',
+      }.merge(options)
+      decoded_captcha = upload(upload_options)
 
-      while response_res.match(/CAPTCHA_NOT_READY|CAPCHA_NOT_READY/i)
-        sleep(polling)
-        response_res = request('res', :get, payload_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
 
-      JSON.load(response_res)['request']
+      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::SiteKey) if options[:sitekey].empty?
+
+      upload_options = { method: 'hcaptcha' }.merge(options)
+      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
+
+      decoded_captcha
     end
 
     # Upload a captcha to 2Captcha.
@@ -139,8 +211,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)
 
@@ -176,11 +248,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

@@ -26,6 +26,12 @@ module TwoCaptcha
     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')

data/lib/two_captcha/version.rb

@@ -1,4 +1,4 @@
 module TwoCaptcha
-  VERSION = '1.3.2'
+  VERSION = '1.7.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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: two_captcha
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Rafael Barbolo
 - Rafael Ivan Garcia
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,7 +88,7 @@ homepage: https://github.com/infosimples/two_captcha
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,9 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby API for 2Captcha (Captcha Solver as a Service)
 test_files: