deathbycaptcha 4.1.2 → 4.1.3

data/README.md

@@ -12,11 +12,6 @@ Thread-safety note
 
 The API is thread-safe, which means it is perfectly fine to share a client instance between multiple threads.
 
-Latest version
---------------
-
-The latest version of this API is 4.1.1.
-
 Installation
 ------------
 
@@ -38,23 +33,23 @@ Examples
 	require 'deathbycaptcha'
 
 	client = DeathByCaptcha.http_client('myusername', 'mypassword')
-	
+
 #### Socket client
 
 	require 'deathbycaptcha'
 
 	client = DeathByCaptcha.socket_client('myusername', 'mypassword')
-	
+
 #### Verbose mode (for debugging purposes)
 
 	client.config.is_verbose = true
-	
+
 #### Decoding captcha
 
 ##### From URL
-	
+
 	response = client.decode 'http://www.phpcaptcha.org/securimage/securimage_show.php'
-	
+
 	puts "captcha id: #{response['captcha']}, solution: #{response['text']}, is_correct: #{response['is_correct']}}"
 
 ##### From file path
@@ -62,7 +57,7 @@ Examples
 	response = client.decode 'path/to/my/captcha/file'
 
 	puts "captcha id: #{response['captcha']}, solution: #{response['text']}, is_correct: #{response['is_correct']}}"
-	
+
 ##### From a file
 
 	file = File.open('path/to/my/captcha/file', 'r')
@@ -70,7 +65,7 @@ Examples
 	response = client.decode file
 
 	puts "captcha id: #{response['captcha']}, solution: #{response['text']}, is_correct: #{response['is_correct']}}"
-	
+
 ##### From raw content
 
 	raw_content = File.open('path/to/my/captcha/file', 'r').read
@@ -80,9 +75,9 @@ Examples
 	puts "captcha id: #{response['captcha']}, solution: #{response['text']}, is_correct: #{response['is_correct']}}"
 
 #### Get the solution of a captcha
-	
+
 	puts client.get_captcha('130920620')['text'] # where 130920620 is the captcha id
-	
+
 #### Get user account information
 
 	puts client.get_user

data/lib/deathbycaptcha.rb

@@ -1,9 +1,9 @@
 require 'deathbycaptcha/version'
 require 'deathbycaptcha/config'
-require 'deathbycaptcha/error'
+require 'deathbycaptcha/errors'
 require 'deathbycaptcha/client'
 require 'deathbycaptcha/http_client'
 require 'deathbycaptcha/socket_client'
 
-module DeathByCaptcha  
+module DeathByCaptcha
 end

data/lib/deathbycaptcha/client.rb

@@ -3,73 +3,72 @@ require 'digest/sha1'
 require 'rest_client'
 
 module DeathByCaptcha
-  
+
   #
   # DeathByCaptcha API Client
   #
   class Client
-    
+
     attr_accessor :config
-    
+
     def initialize(username, password, extra = {})
       data = {
-        :is_verbose => false, # If true, prints messages during execution
-        :logger_output => STDOUT, # Logger output path or IO instance
-        :api_version => API_VERSION, # API version (used as user-agent with http requests)
-        :software_vendor_id => 0, # API unique software ID
-        :max_captcha_file_size => 64 * 1024, # Maximum CAPTCHA image filesize, currently 64K
-        :default_timeout => 60, # Default CAPTCHA timeout
-        :polls_interval => 5, # Default decode polling interval
-        :http_base_url => 'http://api.deathbycaptcha.com/api', # Base HTTP API url
-        :http_response_type => 'application/json', # Preferred HTTP API server's response content type, do not change
-        :socket_host => 'api.deathbycaptcha.com', # Socket API server's host
-        :socket_port => (8123..8130).map { |p| p }, # Socket API server's ports range
-        :username => username, # DeathByCaptcha username
-        :password => password, # DeathByCaptcha user's password not encrypted
+        :is_verbose             => false, # If true, prints messages during execution.
+        :logger_output          => STDOUT, # Logger output path or IO instance.
+        :api_version            => API_VERSION, # API version (used as user-agent with http requests).
+        :software_vendor_id     => 0, # API unique software ID.
+        :max_captcha_file_size  => (64 * 1024), # Maximum CAPTCHA image filesize, currently 64K.
+        :default_timeout        => 60, # Default CAPTCHA timeout.
+        :polls_interval         => 5, # Default decode polling interval.
+        :http_base_url          => 'http://api.dbcapi.me/api', # Base HTTP API url.
+        :http_response_type     => 'application/json', # Preferred HTTP API server's response content type, do not change.
+        :socket_host            => 'api.dbcapi.me', # Socket API server's host.
+        :socket_ports           => (8123..8130).map { |p| p }, # Socket API server's ports range.
+        :username               => username, # DeathByCaptcha username.
+        :password               => password, # DeathByCaptcha user's password not encrypted.
       }.merge(extra)
-      
-      @config = DeathByCaptcha::Config.new(data) # Config instance
-      @logger = Logger.new(@config.logger_output) # Logger
-      
+
+      @config = DeathByCaptcha::Config.new(data) # Config instance.
+      @logger = Logger.new(@config.logger_output) # Logger.
     end
-    
+
     #
-    # Fetch the user's details -- balance, rate and banned status
+    # Fetch the user's details -- balance, rate and banned status.
     #
     def get_user
       raise DeathByCaptcha::Errors::NotImplemented
     end
-    
+
     #
-    # Fetch the user's balance (in US cents)
+    # Fetch the user's balance (in US cents).
     #
     def get_balance
       raise DeathByCaptcha::Errors::NotImplemented
     end
-    
+
     #
-    # Fetch a CAPTCHA details -- its numeric ID, text and correctness
+    # Fetch a CAPTCHA details -- its numeric ID, text and correctness.
     #
     def get_captcha(cid)
       raise DeathByCaptcha::Errors::NotImplemented
     end
-    
+
     #
-    # Fetch a CAPTCHA text
+    # Fetch a CAPTCHA text.
     #
     def get_text(cid)
       raise DeathByCaptcha::Errors::NotImplemented
     end
-    
+
     #
-    # Report a CAPTCHA as incorrectly solved
+    # Report a CAPTCHA as incorrectly solved.
     #
     def report(cid)
       raise DeathByCaptcha::Errors::NotImplemented
     end
-    
+
     #
-    # Upload a CAPTCHA
+    # Upload a CAPTCHA.
     #
     # Accepts file names, file objects or urls, and an optional flag telling
     # whether the CAPTCHA is case-sensitive or not.  Returns CAPTCHA details
@@ -78,7 +77,7 @@ module DeathByCaptcha
     def upload(captcha, options = {})
       raise DeathByCaptcha::Errors::NotImplemented
     end
-    
+
     #
     # Try to solve a CAPTCHA.
     #
@@ -90,47 +89,46 @@ module DeathByCaptcha
     #
     def decode(captcha, options = {})
       options = {
-        :timeout => config.default_timeout,
-        :is_case_sensitive => false,
-        :is_raw_content => false
+        :timeout            => config.default_timeout,
+        :is_case_sensitive  => false,
+        :is_raw_content     => false
       }.merge(options)
-      
+
       deadline = Time.now + options[:timeout]
       c = upload(captcha, options)
       if c
-        
+
         while deadline > Time.now and (c['text'].nil? or c['text'].empty?)
           sleep(config.polls_interval)
           c = get_captcha(c['captcha'])
         end
-        
+
         if c['text']
           return c if c['is_correct']
         else
           remove(c['captcha'])
         end
-        
+
       end
-      
     end
-    
+
     #
     # Protected methods.
     #
     protected
-    
+
     #
     # Return a hash with the user's credentials
     #
     def userpwd
       { :username => config.username, :password => config.password }
     end
-    
+
     #
     # Private methods.
     #
     private
-    
+
     #
     # Log a command and a message
     #
@@ -150,41 +148,41 @@ module DeathByCaptcha
     # => a filesystem path otherwise
     #
     def load_file(captcha, is_raw_content = false)
-      
+
       file = nil
-      
+
       if is_raw_content
         # Create a temporary file, write the raw content and return it
         tmp_file_path = File.join(Dir.tmpdir, "captcha_#{Time.now.to_i}_#{rand}")
         File.open(tmp_file_path, 'wb') { |f| f.write captcha }
         file = File.open(tmp_file_path, 'r')
-        
+
       elsif captcha.kind_of? File
         # simply return the file
         file = captcha
-        
+
       elsif captcha.kind_of? String and captcha.match(/^https?:\/\//i)
         # Create a temporary file, download the file, write it to tempfile and return it
         tmp_file_path = File.join(Dir.tmpdir, "captcha_#{Time.now.to_i}_#{rand}")
         File.open(tmp_file_path, 'wb') { |f| f.write RestClient.get(captcha) }
         file = File.open(tmp_file_path, 'r')
-        
+
       else
         # Return the File opened
         file = File.open(captcha, 'r')
-        
+
       end
-      
+
       if file.nil?
         raise DeathByCaptcha::Errors::CaptchaEmpty
       elsif config.max_captcha_file_size <= File.size?(file).to_i
         raise DeathByCaptcha::Errors::CaptchaOverflow
       end
-      
+
       file
-      
+
     end
-    
+
   end
-  
+
 end

data/lib/deathbycaptcha/config.rb

@@ -1,4 +1,4 @@
-module DeathByCaptcha    
+module DeathByCaptcha
 
   #
   # Config class
@@ -6,7 +6,7 @@ module DeathByCaptcha
   #
   class Config
 
-    def initialize(data={})
+    def initialize(data = {})
       @data = {}
       update!(data)
     end
@@ -38,5 +38,5 @@ module DeathByCaptcha
     end
 
   end
-  
+
 end

data/lib/deathbycaptcha/{error.rb → errors.rb}

@@ -1,9 +1,9 @@
 module DeathByCaptcha
-  
+
   module Errors
-    
+
     #
-    # Custom Error class for rescuing from DeathByCaptcha API errors
+    # Custom Error class for rescuing from DeathByCaptcha API errors.
     #
     class Error < StandardError
 
@@ -14,56 +14,56 @@ module DeathByCaptcha
     end
 
     #
-    # Raised when a method tries to access a not implemented method
+    # Raised when a method tries to access a not implemented method.
     #
     class NotImplemented < Error
       def initialize
         super('The requested functionality was not implemented')
       end
     end
-    
+
     #
-    # Raised when a HTTP call fails
+    # Raised when a HTTP call fails.
     #
     class CallError < Error
       def initialize
         super('HTTP call failed')
       end
     end
-    
+
     #
-    # Raised when the user is not allowed to access the API
+    # Raised when the user is not allowed to access the API.
     #
     class AccessDenied < Error
       def initialize
         super('Access denied, please check your credentials and/or balance')
       end
     end
-    
+
     #
-    # Raised when the captcha file could not be loaded or is empty
+    # Raised when the captcha file could not be loaded or is empty.
     #
     class CaptchaEmpty
       def initialize
         super('CAPTCHA image is empty or could not be loaded')
       end
     end
-    
+
     #
-    # Raised when the size of the captcha file is too big
+    # Raised when the size of the captcha file is too big.
     #
     class CaptchaOverflow
       def initialize
         super('CAPTCHA image is too big')
       end
     end
-    
+
     class ServiceOverload
       def initialize
         super('CAPTCHA was rejected due to service overload, try again later')
       end
     end
-    
+
   end
-  
+
 end

data/lib/deathbycaptcha/http_client.rb

@@ -3,16 +3,16 @@ require 'json'
 require 'digest/md5'
 
 module DeathByCaptcha
-  
+
   #
   # DeathByCaptcha HTTP API client
   #
   class HTTPClient < DeathByCaptcha::Client
-    
+
     def get_user
       call('user', userpwd)
     end
-    
+
     def get_captcha(cid)
       call("captcha/#{cid}")
     end
@@ -20,79 +20,79 @@ module DeathByCaptcha
     def report(cid)
       call("captcha/#{cid}/report", userpwd)['is_correct']
     end
-    
+
     def remove(cid)
       not call("captcha/#{cid}/remove", userpwd)['captcha']
     end
-    
+
     #
     # Protected methods.
     #
     protected
-    
+
     def upload(captcha, options = {})
       options = {
-        :is_case_sensitive => false,
-        :is_raw_content => false
+        :is_case_sensitive  => false,
+        :is_raw_content     => false
       }.merge(options)
-      
-      data = userpwd
-      data[:swid] = config.software_vendor_id
-      data[:is_case_sensitive] = options[:is_case_sensitive] ? 1 : 0
-      data[:captchafile] = load_file(captcha, options[:is_raw_content])
-      response = call('captcha', data)
-      
+
+      data                      = userpwd
+      data[:swid]               = config.software_vendor_id
+      data[:is_case_sensitive]  = (options[:is_case_sensitive] ? 1 : 0)
+      data[:captchafile]        = load_file(captcha, options[:is_raw_content])
+      response                  = call('captcha', data)
+
       return response if response['captcha']
     end
-    
+
     #
     # Private methods.
     #
     private
-    
+
     def call(cmd, payload = {}, headers = {})
-      
-      headers = {} unless headers.is_a?(Hash)
-      headers['Accept'] = config.http_response_type if headers['Accept'].nil?
+
+      headers               = {} unless headers.is_a?(Hash)
+      headers['Accept']     = config.http_response_type if headers['Accept'].nil?
       headers['User-Agent'] = config.api_version if headers['User-Agent'].nil?
-      
+
       log('SEND', "#{cmd} #{payload}")
-      
+
       begin
         url = "#{config.http_base_url}/#{cmd}"
-        
+
         if payload.empty?
           response = RestClient.get(url, headers)
         else
           response = RestClient.post(url, payload, headers)
         end
-        
+
         log('RECV', "#{response.size} #{response}")
-        
+
         return JSON.load(response)
-        
+
       rescue RestClient::Unauthorized => exc
         raise DeathByCaptcha::Errors::AccessDenied
-      
+
       rescue RestClient::RequestFailed => exc
-        raise DeathByCaptcha::Errors::AccessDenied
-        
+        raise DeathByCaptcha::Errors::CallError
+
       rescue RestClient::ServiceUnavailable => exc
         raise DeathByCaptcha::Errors::ServiceOverload
-      
+
       else
         raise DeathByCaptcha::Errors::CallError
-        
+
       end
-      
+
       return {}
-      
+
     end
-    
+
   end
-  
+
   def self.http_client(username, password, extra = {})
     DeathByCaptcha::HTTPClient.new(username, password, extra)
   end
-  
+
 end

data/lib/deathbycaptcha/socket_client.rb

@@ -5,109 +5,93 @@ require 'socket'
 require 'base64'
 
 module DeathByCaptcha
-  
+
   #
   # DeathByCaptcha Socket API client
   #
   class SocketClient < DeathByCaptcha::Client
-    
-    #
-    # Socket API server's host & ports range.
-    #
-    @@socket_host = 'api.deathbycaptcha.com'
-    @@socket_ports = (8123...8131).to_a
-    
+
     def initialize(username, password, extra = {})
-      @mutex = Mutex.new
+      @mutex  = Mutex.new
       @socket = nil
-      
+
       super(username, password, extra)
     end
-    
+
     def get_user
       call('user')
     end
-    
+
     def get_captcha(cid)
-      call('captcha', {:captcha => cid})
+      call('captcha', { :captcha => cid })
     end
 
     def report(cid)
-      data = { 'captcha' => cid }
-      call('report', data)[:is_correct]
+      call('report', { :captcha => cid })[:is_correct]
     end
-    
+
     #
     # Protected methods.
     #
     protected
-    
+
     def upload(captcha, is_case_sensitive = false, is_raw_content = false)
       data = {
-        :captcha => Base64.encode64(load_file(captcha, is_raw_content).read),
-        :is_case_sensitive => (is_case_sensitive ? 1 : 0)
+        :captcha            => Base64.encode64(load_file(captcha, is_raw_content).read),
+        :is_case_sensitive  => (is_case_sensitive ? 1 : 0)
       }
-      
+
       call('upload', data)
     end
-    
+
     #
     # Private methods.
     #
     private
-    
+
     def connect
       unless @socket
         log('CONN')
-        
         begin
-          random_port = @@socket_ports[rand(@@socket_ports.size)]
-          
+          random_port = config.socket_ports[rand(config.socket_ports.size)]
           # Creates a new Socket.
-          addr = Socket.pack_sockaddr_in(random_port, @@socket_host)
-          
-          @socket = Socket.new(:INET, :STREAM)
+          addr = Socket.pack_sockaddr_in(random_port, config.socket_host)
+
+          @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
           @socket.connect_nonblock(addr)
+        rescue Errno::EINPROGRESS
+          log("INPROG", 'Waiting...')
         rescue Exception => e
-          if e.errno == 36 # EINPROGRESS
-            # Nothing.
-          else
-            close # Closes the socket.
-            log('CONN', 'Could not connect.')
-            log('CONN', e.backtrace.join('\n'))
-            
-            raise e
-          end
+          close # Closes the socket.
+          log('CONN', 'Could not connect.')
+          log('CONN', e.backtrace.join("\n"))
+          raise e
         end
-        
       end
-      
       @socket
     end
-    
+
     def close
       if @socket
         log('CLOSE')
-        
         begin
           @socket.close
         rescue Exception => e
           log('CLOSE', 'Could not close socket.')
-          log('CLOSE', e.backtrace.join('\n'))
+          log('CLOSE', e.backtrace.join("\n"))
         ensure
           @socket = nil
         end
       end
     end
-    
+
     def send(sock, buf)
       # buf += '\n'
       fds = [sock]
-      
       deadline = Time.now.to_f + 3 * config.polls_interval
       while deadline > Time.now.to_f and not buf.empty? do
         _, wr, ex = IO.select([], fds, fds, config.polls_interval)
-        
+
         if ex and ex.any?
           raise IOError.new('send(): select() excepted')
         elsif wr
@@ -116,7 +100,7 @@ module DeathByCaptcha
               sent = wr.first.send(buf, 0)
               buf = buf[sent, buf.size - sent]
             rescue Exception => e
-              if [35, 36].include? e.errno 
+              if [35, 36].include? e.errno
                 break
               else
                 raise e
@@ -125,28 +109,29 @@ module DeathByCaptcha
           end
         end
       end
-      
+
       unless buf.empty?
         raise IOError.new('send() timed out')
       else
         return self
       end
     end
-    
+
     def recv(sock)
       fds = [sock]
       buf = ''
-      
+
       deadline = Time.now.to_f() + 3 * config.polls_interval
       while deadline > Time.now.to_f do
         rd, _, ex = IO.select(fds, [], fds, config.polls_interval)
-        
         if ex and ex.any?
           raise IOError.new('send(): select() excepted')
         elsif rd
           while true do
             begin
               s = rd.first.recv_nonblock(256)
+            rescue Errno::EAGAIN
+              break
             rescue Exception => e
               if [35, 36].include? e.errno
                 break
@@ -161,41 +146,40 @@ module DeathByCaptcha
               end
             end
           end
-          
           break if buf.size > 0
         end
       end
-      
+
       return buf[0, buf.size] if buf.size > 0
       raise IOError.new('recv() timed out')
     end
-    
+
     def call(cmd, data = {})
       data = {} if data.nil?
       data.merge!({ :cmd => cmd, :version => config.api_version })
-      
+
       request = data.to_json
       log('SEND', request.to_s)
-      
+
       response = nil
-      
+
       (0...1).each do
         if not @socket and cmd != 'login'
           call('login', userpwd)
         end
-        
+
         # Locks other threads.
         # If another thread has already acquired the lock, this thread will be locked.
         @mutex.lock
-        
+
         begin
           sock = connect
           send(sock, request)
-          
+
           response = recv(sock)
         rescue Exception => e
           log('SEND', e.message)
-          log('SEND', e.backtrace.join('\n'))
+          log('SEND', e.backtrace.join("\n"))
           close
         else
           # If no exception raised.
@@ -203,24 +187,24 @@ module DeathByCaptcha
         ensure
           @mutex.unlock
         end
-        
+
       end
-      
+
       if response.nil?
         msg = 'Connection timed out during API request'
         log('SEND', msg)
-        
+
         raise Exception.new(msg)
       end
-      
+
       log('RECV', response.to_s)
-      
+
       begin
         response = JSON.load(response)
       rescue Exception => e
         raise Exception.new('Invalid API response')
       end
-      
+
       if 0x00 < response['status'] and 0x10 > response['status']
         raise DeathByCaptcha::Errors::AccessDenied
       elsif 0xff == response['status']
@@ -228,13 +212,13 @@ module DeathByCaptcha
       else
         return response
       end
-      
+
     end
-    
+
   end
-  
-  def self.socket_client(username, password, extra={})
+
+  def self.socket_client(username, password, extra = {})
     DeathByCaptcha::SocketClient.new(username, password, extra)
   end
-  
+
 end

data/lib/deathbycaptcha/version.rb

@@ -1,4 +1,4 @@
 module DeathByCaptcha
-  VERSION = "4.1.2"
-  API_VERSION = "DBC/Ruby v4.1.0"
-end
+  VERSION = "4.1.3"
+  API_VERSION = "DBC/Ruby v4.1.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deathbycaptcha
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 -03:00
-default_executable: 
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2152235960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,15 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152235960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2152235460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +37,12 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *2152235460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
 description: Ruby API for DeathByCaptcha (Captcha Solver as a Service)
 email:
 - tech@infosimples.com.br
@@ -50,11 +59,10 @@ files:
 - lib/deathbycaptcha.rb
 - lib/deathbycaptcha/client.rb
 - lib/deathbycaptcha/config.rb
-- lib/deathbycaptcha/error.rb
+- lib/deathbycaptcha/errors.rb
 - lib/deathbycaptcha/http_client.rb
 - lib/deathbycaptcha/socket_client.rb
 - lib/deathbycaptcha/version.rb
-has_rdoc: true
 homepage: http://www.infosimples.com.br/en/open-source/captcha-solving-api/
 licenses: []
 post_install_message: 
@@ -75,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: deathbycaptcha
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby API for DeathByCaptcha (Captcha Solver as a Service)