anti_captcha 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea4b4a53f966ab69db9ea92a2575ee32afe55c88
-  data.tar.gz: 13674c466b8c24af5b4e1e995b56151fff45d1a4
+SHA256:
+  metadata.gz: c824ede49ec41b2b6ff994fbb8b3caae33f935e78daa10759537d44b59c37a5f
+  data.tar.gz: b043e76306535964664fdab5e80a51ee63743be47c2900d810769c9332ec77df
 SHA512:
-  metadata.gz: d6fa39db3ce217ed087511f235f0a6af458cdc78899f5b3e51c886064e64eb9ad7087a61c1e007b36d5600a13b7ece8b89738e1bf4591ffe2d7ca92d66d1899a
-  data.tar.gz: 7d3b40a511221ddd807698b06c55b13e98ec10b3dcf48284266444bb43aca3a38f1f39a9976db68295d14f3d53164936b3ff7985f10e743e4a55f907295db1a8
+  metadata.gz: c0894512b1baaf7bf6b53bcdee0c34c25fdad188c3ce499194aefb68beae30ec360ad47e059fb54dffdb2da3fe9629706021155f78bf7319f83c4dcb0e6b01e6
+  data.tar.gz: b51249b061d7a8a85c0909cece6b6f7f07cc7c4c25bc8ae2826197ca24e28f89b93302d2497663b78ebdfb2e5ff1c47f1e19bcbd2649c51b359118c4080f085f

data/README.md

@@ -115,6 +115,26 @@ Or install it yourself as:
   "1JJHJ_VuuHAqJKxcaasbTsqw-L1Sm4gD57PTeaEr9-MaETG1vfu2H5zlcwkjsRoZoHxx6V9yUDw8Ig-hYD8kakmSnnjNQd50w_Y_tI3aDLp-s_7ZmhH6pcaoWWsid5hdtMXyvrP9DscDuCLBf7etLle8caPWSaYCpAq9DOTtj5NpSg6-OeCJdGdkjsakFUMeGeqmje87wSajcjmdjl_w4XZBY2zy8fUH6XoAGZ6AeCTulIljBQDObQynKDd-rutPvKNxZasDk-LbhTfw508g1lu9io6jnvm3kbAdnkfZ0x0PkGiUMHU7hnuoW6bXo2Yn_Zt5tDWL7N7wFtY6B0k7cTy73f8er508zReOuoyz2NqL8smDCmcJu05ajkPGt20qzpURMwHaw"
   ```
 
+7. **FunCaptcha**
+
+  This method allows you to solve FunCaptcha.
+
+  **Send the `website_public_key` and `website_url` parameters**
+
+  This method requires no browser emulation. You can send two parameters that
+  identify the website in which the CAPTCHA is found.
+
+  ```ruby
+  options = {
+    website_public_key: 'xyz',
+    website_url: 'http://example.com/example=1',
+    language_pool: '...'
+  }
+
+  solution = client.decode_fun_captcha(options)
+  solution.token # Solution of the captcha
+  ```
+
 ## Notes
 
 #### Ruby dependencies

data/lib/anti_captcha.rb

@@ -34,6 +34,7 @@ require 'anti_captcha/errors'
 require 'anti_captcha/models/solution'
 require 'anti_captcha/models/image_to_text_solution'
 require 'anti_captcha/models/no_captcha_solution'
+require 'anti_captcha/models/fun_captcha_solution'
 require 'anti_captcha/models/task_result'
 require 'anti_captcha/client'
 require 'anti_captcha/version'

data/lib/anti_captcha/client.rb

@@ -4,6 +4,8 @@ module AntiCaptcha
   #
   class Client
     BASE_URL = 'https://api.anti-captcha.com/:action'
+    PROXYABLE_TASKS = %w(NoCaptchaTask FunCaptchaTask)
+    SUPPORTED_TASKS = %w(ImageToTextTask NoCaptchaTask FunCaptchaTask)
 
     attr_accessor :client_key, :timeout, :polling
 
@@ -58,48 +60,18 @@ module AntiCaptcha
     #                                         answer. 0 - no requirements.
     #   @option options [Integer] :max_length Defines maximum length of the
     #                                         answer. 0 - no requirements.
+    #   @option options [String] :comment Additional comment for workers like
+    #                                     "enter letters in red color". Result
+    #                                     is not guaranteed.
     #
     # @return [AntiCaptcha::ImageToTextSolution] The solution of the image
     #                                            CAPTCHA.
     #
     def decode_image!(options)
-      started_at = Time.now
-
       options[:body64] = load_captcha(options)
       task = create_task!('ImageToTextTask', options)
-
-      if task['taskId']
-        api_result = get_task_result!(task['taskId'])
-
-        while api_result['status'] != 'ready'
-          sleep(polling)
-          api_result = get_task_result!(task['taskId'])
-          raise AntiCaptcha::Timeout if (Time.now - started_at) > timeout
-        end
-
-        task_result = AntiCaptcha::TaskResult.new(
-          task_id:           task['taskId'],
-          error_id:          api_result['errorId'],
-          error_code:        api_result['errorCode'],
-          error_description: api_result['errorDescription'],
-          status:            api_result['status'],
-          cost:              api_result['cost'],
-          ip:                api_result['ip'],
-          create_time:       api_result['createTime'],
-          end_time:          api_result['endTime'],
-          solve_count:       api_result['solveCount']
-        )
-
-        return AntiCaptcha::ImageToTextSolution.new(
-          api_response: api_result,
-          task_result:  task_result,
-          url:          api_result['solution']['url'],
-          text:         api_result['solution']['text']
-        )
-
-      else
-        raise AntiCaptcha.raise_error('taskId not received from Anti Captcha.')
-      end
+      task_result = get_task_result!(task['taskId'])
+      AntiCaptcha::ImageToTextSolution.new(task_result)
     end
 
     #
@@ -134,53 +106,37 @@ module AntiCaptcha
     # @return [AntiCaptcha::NoCaptchaSolution] The solution of the NoCaptcha.
     #
     def decode_nocaptcha!(options, proxy = nil)
-      started_at = Time.now
-
-      if proxy.nil?
-        task_type = 'NoCaptchaTaskProxyless'
-        hsh       = options
-      else
-        task_type = 'NoCaptchaTask'
-        hsh       = options.merge(proxy)
-      end
-
-      task = create_task!(task_type, hsh)
-
-      if task['taskId']
-        api_result = get_task_result!(task['taskId'])
-
-        while api_result['status'] != 'ready'
-          sleep(polling)
-          api_result = get_task_result!(task['taskId'])
-          raise AntiCaptcha::Timeout if (Time.now - started_at) > timeout
-        end
-
-        task_result = AntiCaptcha::TaskResult.new(
-          task_id:           task['taskId'],
-          error_id:          api_result['errorId'],
-          error_code:        api_result['errorCode'],
-          error_description: api_result['errorDescription'],
-          status:            api_result['status'],
-          cost:              api_result['cost'],
-          ip:                api_result['ip'],
-          create_time:       api_result['createTime'],
-          end_time:          api_result['endTime'],
-          solve_count:       api_result['solveCount']
-        )
-
-        return AntiCaptcha::NoCaptchaSolution.new(
-          api_response:             api_result,
-          task_result:              task_result,
-          g_recaptcha_response:     api_result['solution']['gRecaptchaResponse'],
-          g_recaptcha_response_md5: api_result['solution']['gRecaptchaResponseMD5']
-        )
-
-      else
-        raise AntiCaptcha.raise_error('taskId not received from Anti Captcha.')
-      end
+      task = create_task!('NoCaptchaTask', options, proxy)
+      task_result = get_task_result!(task['taskId'])
+      AntiCaptcha::NoCaptchaSolution.new(task_result)
     end
 
     #
+    # Decodes a FunCaptcha CAPTCHA.
+    #
+    # @param [Hash] options Options hash.
+    #   @option options [String]  :website_url
+    #   @option options [String]  :website_public_key
+    #   @option options [String]  :language_pool
+    #
+    # @param [Hash] proxy Not mandatory. A hash with configs of the proxy that
+    #                     has to be used. Defaults to `nil`.
+    #   @option proxy [String]  :proxy_type
+    #   @option proxy [String]  :proxy_address
+    #   @option proxy [String]  :proxy_port
+    #   @option proxy [String]  :proxy_login
+    #   @option proxy [String]  :proxy_login
+    #   @option proxy [String]  :proxy_password
+    #   @option proxy [String]  :user_agent
+    #
+    # @return [AntiCaptcha::FunCaptchaSolution] The solution of the FunCaptcha.
+    #
+    def decode_fun_captcha!(options, proxy = nil)
+      task = create_task!('FunCaptchaTask', options, proxy)
+      task_result = get_task_result!(task['taskId'])
+      AntiCaptcha::FunCaptchaSolution.new(task_result)
+    end
+
     # Creates a task for solving the selected CAPTCHA type.
     #
     # @param [String] type The type of the CAPTCHA.
@@ -200,21 +156,27 @@ module AntiCaptcha
     #                                         answer. 0 - no requirements.
     #   @option options [Integer] :max_length Defines maximum length of the
     #                                         answer. 0 - no requirements.
+    #   @option options [String] :comment Additional comment for workers like
+    #                                     "enter letters in red color". Result
+    #                                     is not guaranteed.
     #   # NoCaptcha
     #   @option options [String]  :website_url Address of target web page.
     #   @option options [String]  :website_key Recaptcha website key.
     #   @option options [String]  :language_pool
-    #   @option options [String]  :proxy_type
-    #   @option options [String]  :proxy_address
-    #   @option options [String]  :proxy_port
-    #   @option options [String]  :proxy_login
-    #   @option options [String]  :proxy_login
-    #   @option options [String]  :proxy_password
-    #   @option options [String]  :user_agent
+    #
+    # @param [Hash] proxy Not mandatory. A hash with configs of the proxy that
+    #                     has to be used. Defaults to `nil`.
+    #   @option proxy [String]  :proxy_type
+    #   @option proxy [String]  :proxy_address
+    #   @option proxy [String]  :proxy_port
+    #   @option proxy [String]  :proxy_login
+    #   @option proxy [String]  :proxy_login
+    #   @option proxy [String]  :proxy_password
+    #   @option proxy [String]  :user_agent
     #
     # @return [Hash] Information about the task.
     #
-    def create_task!(type, options)
+    def create_task!(type, options, proxy = nil)
       args = {
         languagePool: (options[:language_pool] || 'en'),
         softId: '859'
@@ -230,35 +192,45 @@ module AntiCaptcha
           numeric:   options[:numeric],
           math:      options[:math],
           minLength: options[:min_length],
-          maxLength: options[:max_length]
+          maxLength: options[:max_length],
+          comment:   options[:comment],
         }
 
-      when 'NoCaptchaTaskProxyless'
+      when 'NoCaptchaTask'
         args[:task] = {
-          type:       'NoCaptchaTaskProxyless',
+          type:       'NoCaptchaTask',
           websiteURL: options[:website_url],
-          websiteKey: options[:website_key]
+          websiteKey: options[:website_key],
         }
 
-      when 'NoCaptchaTask'
+      when 'FunCaptchaTask'
         args[:task] = {
-          type:          'NoCaptchaTask',
-          websiteURL:    options[:website_url],
-          websiteKey:    options[:website_key],
-          proxyType:     options[:proxy_type],
-          proxyAddress:  options[:proxy_address],
-          proxyPort:     options[:proxy_port],
-          proxyLogin:    options[:proxy_login],
-          proxyPassword: options[:proxy_password],
-          userAgent:     options[:user_agent]
+          type:            'FunCaptchaTask',
+          websiteURL:       options[:website_url],
+          websitePublicKey: options[:website_public_key],
         }
 
       else
         message = "Invalid task type: '#{type}'. Allowed types: " +
-          "#{%w(ImageToTextTask NoCaptchaTaskProxyless NoCaptchaTask).join(', ')}"
+          "#{SUPPORTED_TASKS.join(', ')}"
         raise AntiCaptcha.raise_error(message)
       end
 
+      if PROXYABLE_TASKS.include?(type)
+        if proxy.nil?
+          args[:task][:type] += 'Proxyless'
+        else
+          args.merge!(
+            proxyType:     proxy[:proxy_type],
+            proxyAddress:  proxy[:proxy_address],
+            proxyPort:     proxy[:proxy_port],
+            proxyLogin:    proxy[:proxy_login],
+            proxyPassword: proxy[:proxy_password],
+            userAgent:     proxy[:user_agent]
+          )
+        end
+      end
+
       request('createTask', args)
     end
 
@@ -270,8 +242,20 @@ module AntiCaptcha
     # @return [Hash] Information about the task.
     #
     def get_task_result!(task_id)
-      args = { taskId: task_id }
-      request('getTaskResult', args)
+      raise AntiCaptcha.raise_error('taskId not received from Anti Captcha.') unless task_id
+
+      started_at = Time.now
+
+      loop do
+        api_result = request('getTaskResult', { taskId: task_id })
+
+        if api_result['status'] == 'ready'
+          return AntiCaptcha::TaskResult.new(api_result, task_id)
+        end
+
+        sleep(polling)
+        raise AntiCaptcha::Timeout if (Time.now - started_at) > timeout
+      end
     end
 
     #

data/lib/anti_captcha/errors.rb

@@ -3,7 +3,7 @@ module AntiCaptcha
   # This is the base AntiCaptcha exception class. Rescue it if you want to
   # catch any exception that might be raised.
   #
-  class Error < Exception
+  class Error < StandardError
   end
 
   class ArgumentError < Error

data/lib/anti_captcha/models/fun_captcha_solution.rb

@@ -0,0 +1,13 @@
+module AntiCaptcha
+  class FunCaptchaSolution < AntiCaptcha::Solution
+    attr_accessor :token
+
+    def initialize(task_result = nil)
+      super
+
+      if task_result
+        @token = task_result.api_result['solution']['token']
+      end
+    end
+  end
+end

data/lib/anti_captcha/models/image_to_text_solution.rb

@@ -1,5 +1,14 @@
 module AntiCaptcha
   class ImageToTextSolution < AntiCaptcha::Solution
     attr_accessor :url, :text
+
+    def initialize(task_result = nil)
+      super
+
+      if task_result
+        @url  = task_result.api_result['solution']['url']
+        @text = task_result.api_result['solution']['text']
+      end
+    end
   end
 end

data/lib/anti_captcha/models/no_captcha_solution.rb

@@ -1,5 +1,14 @@
 module AntiCaptcha
   class NoCaptchaSolution < AntiCaptcha::Solution
     attr_accessor :g_recaptcha_response, :g_recaptcha_response_md5
+
+    def initialize(task_result = nil)
+      super
+
+      if task_result
+        @g_recaptcha_response     = task_result.api_result['solution']['gRecaptchaResponse']
+        @g_recaptcha_response_md5 = task_result.api_result['solution']['gRecaptchaResponseMD5']
+      end
+    end
   end
 end

data/lib/anti_captcha/models/solution.rb

@@ -1,5 +1,12 @@
 module AntiCaptcha
   class Solution < AntiCaptcha::Model
     attr_accessor :api_response, :task_result
+
+    def initialize(task_result = nil)
+      if task_result
+        @api_response = task_result.api_result
+        @task_result  = task_result
+      end
+    end
   end
 end

data/lib/anti_captcha/models/task_result.rb

@@ -1,6 +1,21 @@
 module AntiCaptcha
   class TaskResult < AntiCaptcha::Model
     attr_accessor :task_id, :error_id, :error_code, :error_description, :status,
-    :cost, :ip, :create_time, :end_time, :solve_count
+    :cost, :ip, :create_time, :end_time, :solve_count, :api_result
+
+    def initialize(api_result, task_id)
+      @task_id = task_id
+
+      @api_result        = api_result
+      @error_id          = api_result['errorId']
+      @error_code        = api_result['errorCode']
+      @error_description = api_result['errorDescription']
+      @status            = api_result['status']
+      @cost              = api_result['cost']
+      @ip                = api_result['ip']
+      @create_time       = api_result['createTime']
+      @end_time          = api_result['endTime']
+      @solve_count       = api_result['solveCount']
+    end
   end
 end

data/lib/anti_captcha/version.rb

@@ -1,4 +1,4 @@
 module AntiCaptcha
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
   USER_AGENT = "AntiCaptcha/Ruby v#{VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anti_captcha
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Infosimples
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ files:
 - lib/anti_captcha/client.rb
 - lib/anti_captcha/errors.rb
 - lib/anti_captcha/http.rb
+- lib/anti_captcha/models/fun_captcha_solution.rb
 - lib/anti_captcha/models/image_to_text_solution.rb
 - lib/anti_captcha/models/no_captcha_solution.rb
 - lib/anti_captcha/models/solution.rb
@@ -99,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby API for Anti Captcha (CAPTCHA Solver as a Service)