captchatrader 0.1.0

data/Changelog.md

@@ -0,0 +1,3 @@
+== 0.0.1 (2011-06-29)
+
+* First working release of credits, submit and respond actions

data/README.md

@@ -0,0 +1,65 @@
+captchatrader
+=============
+
+Ruby bindings for the captchatrader.com API. Submit captcha images and retrieve the text as a string.
+
+
+Features
+--------
+
+* Submit capture images and retrieve the text
+* Notify server if text is correct to prevent charging credits on incorrectly detected captchas
+* Retrieve amount of credits left
+
+Usage
+--------
+
+    Captchatrader::API.username = "your-username"
+    Captchatrader::API.password = "your-password-or-passkey"
+    Captchatrader::API.api_key  = "your-applications-api-key"
+
+    # Submit a capture image to retrieve the text
+    captcha = Captchatrader::API.submit("http://example.com/link-to-image.jpg", :url)
+    puts captcha.value  # => "capture text"
+  
+    # Tell the server that this captcha has been detected incorrectly (prevent charging credits)
+    Captchatrader::API.respond(captcha.ticket, false)  # true
+  
+    # Credits left for this username
+    Captchatrader::API.credits  # => 90
+
+Install
+-------
+
+    gem install capturetrader
+  
+Requirements
+------------
+
+* None (only Mocha for running tests)
+
+License
+-------
+
+The MIT License
+
+Copyright (c) 2011 Dennis Theisen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/captchatrader.rb

@@ -0,0 +1,11 @@
+require 'net/http'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/captchatrader")
+
+require 'error'
+require 'submission'
+require 'api'
+
+module Captchatrader
+  VERSION = File.read(File.dirname(__FILE__) + "/../version.txt")
+end

data/lib/captchatrader/api.rb

@@ -0,0 +1,79 @@
+module Captchatrader
+  module API
+    extend self
+    
+    BASE_URL = "http://api.captchatrader.com"
+    SUBMIT_TYPES = [:url, :file]
+    
+    attr_accessor :username, :password, :api_key
+    
+    def submit(image, type, match = nil)
+      raise ArgumentError, "type must be one of #{SUBMIT_TYPES.join(', ')}" unless SUBMIT_TYPES.include?(type.to_sym)
+
+      params = {
+        :value    => image,
+        :type     => type,
+        :api_key  => API.api_key,
+        :username => API.username,
+        :password => API.password
+      }
+      params[:match] = match if match
+      
+      response = post("#{BASE_URL}/submit", params)
+      parse_response(response, :submit, :image => image)
+    end
+    
+    def respond(ticket, correct)
+      params = {
+        :ticket     => ticket,
+        :is_correct => correct,
+        :username   => API.username,
+        :password   => API.password
+      }
+      response = post("#{BASE_URL}/respond", params)
+      parse_response(response, :respond)
+    end
+    
+    def credits
+      response = get("#{BASE_URL}/get_credits/username:#{API.username}/password:#{API.password}/")
+      parse_response(response, :credits)
+    end
+    
+    
+    private
+    
+    def get(url)
+      url = URI.parse(url)
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        http.get(url.request_uri)
+      end
+      response.body
+    end
+    
+    def post(url, params)
+      url = URI.parse(url)
+      post = Net::HTTP::Post.new(url.request_uri)
+      post.set_form_data(params)
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        http.request(post)
+      end
+      response.body
+    end
+    
+    def parse_response(response, type, options = {})
+      raise API::Error, "Unexpected response from captchatrader: #{response}" unless response =~ /\A\[.+\]\z/ 
+      
+      code, details = response[1..-2].split(/ *, */)
+      raise API::Error, details.to_s[1..-2] if code.to_i == -1
+      
+      case type
+      when :credits
+        details.to_i
+      when :submit
+        Submission.new(details.to_s[1..-2], code.to_i, options[:image])
+      when :respond
+        code.to_i == 0
+      end
+    end
+  end
+end

data/lib/captchatrader/error.rb

@@ -0,0 +1,23 @@
+module Captchatrader
+  module API
+
+    class Error < StandardError
+      # submit
+      API_KEY_DISABLED     = "The API key has been disabled, likely because it is not responding to CAPTCHAs correctly or is submitting too quickly"
+      INSUFFICIENT_CREDITS = "The account provided does not have enough credits to complete the request"
+      INTERNAL_ERROR       = "The server encountered an unexpected situation and the request was aborted"
+      INVALID_API_KEY      = "The API key provided was not registered"
+      INVALID_PARAMETERS   = "The request was not submitted correctly"
+      INVALID_TYPE         = "The type argument was invalid"
+      INVALID_USER         = "The username/password combination was incorrect"
+      USER_NOT_VALIDATED   = "The user has not been validated or is banned"
+      NOT_AN_IMAGE         = "The file or url uploaded was not detected to be a valid image"
+      SUBMISSION_ERROR     = "An error occurred in the file upload"
+      
+      # respond
+      INCORRECT_REPORTS    = "Too many negative responses were submitted in a short time frame"
+      INVALID_TICKET       = "The type argument was invalid"
+    end
+
+  end
+end

data/lib/captchatrader/submission.rb

@@ -0,0 +1,12 @@
+module Captchatrader
+  module API
+
+    # Holds responses for captcha submissions
+    class Submission < Struct.new(:value, :ticket, :image)
+      def to_s
+        value
+      end
+    end
+    
+  end
+end

data/version.txt

@@ -0,0 +1 @@
+0.1.0

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: captchatrader
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dennis Theisen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-29 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Submit captcha images and retrieve the text as a string.
+email: soleone@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Changelog.md
+- README.md
+- version.txt
+- lib/captchatrader/api.rb
+- lib/captchatrader/error.rb
+- lib/captchatrader/submission.rb
+- lib/captchatrader.rb
+has_rdoc: true
+homepage: http://github.com/Soleone/captchatrader
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the captchatrader.com API.
+test_files: []
+