antigate_rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3952502c45b4cc8a15522423013ebc84958525ec
+  data.tar.gz: f6dc2ed15421b756a7300772d0bddb85f49f6acc
+SHA512:
+  metadata.gz: caa7c349e716e54e13cfc9a8986ec79cfc5fecb03c0d5720134967016de6f23c108581375835c3dd0c7bd1b64866f36a72319d3522d90c6c0c1e95d310a66305
+  data.tar.gz: 6171491feb4e0a2ec4c8177ab4a108d3a6c1f4c3c2575565591882dbdc8fa40b854377b9600d7ab76b21870fd3f292541aceb7df53d9d468b813f9e8c4afa118

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in antigate_rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nikita Pomiashchii
+
+MIT License
+
+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/README.md

@@ -0,0 +1,42 @@
+# AntigateRb
+
+Antigate.com ruby api wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'antigate_rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install antigate_rb
+
+## Usage example
+
+Configure with api params
+
+```ruby
+AntigateRb.configure do |config|
+  config.key = 'api_key'
+  config.min_len = 6
+  config.max_len = 10
+end
+```
+
+```ruby
+@client = AntigateRb::Client.new(retries_count: 5, phrase: 1)
+code = @client.code(image_content)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/antigate_rb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'antigate_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "antigate_rb"
+  spec.version       = AntigateRb::VERSION
+  spec.authors       = ["Nikita Pomiashchii"]
+  spec.email         = ["pomnikita@gmail.com"]
+  spec.summary       = "Antigate api ruby wrapper"
+  spec.description   = "Antigate api ruby wrapper"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "httpi"
+  spec.add_dependency "activesupport"
+end

data/lib/antigate_rb.rb

@@ -0,0 +1,16 @@
+require 'antigate_rb/version'
+require 'antigate_rb/configuration'
+require 'antigate_rb/client'
+require 'antigate_rb/error'
+
+module AntigateRb
+
+  def self.configure(&block)
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+end

data/lib/antigate_rb/client.rb

@@ -0,0 +1,113 @@
+require 'httpi'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/object'
+
+module AntigateRb
+  class Client
+
+    def initialize(options = {})
+      @retries_count = options.delete(:retries_count) || 10
+      @sleep = options.delete(:sleep) || 5
+      @options = AntigateRb.configuration.options.merge(options)
+    end
+
+    def decode(image)
+      case request_image(image)
+      when /OK\|(.+)/
+        @captcha_id = $1
+        check
+      when /^ERROR_(.+)/
+        raise error_class($1)
+      else
+        raise UnknownResponse
+      end
+    end
+
+    def check
+      return if @captcha_id.blank?
+      begin
+        get_status
+      rescue CaptchaNotReady => e
+        attempt ||= @retries_count
+        raise e if (attempt -= 1) < 0
+        sleep @sleep
+        retry
+      end
+    end
+
+    def report_bad
+      return if @captcha_id.blank?
+      request_report_bad
+    end
+
+    def get_balance
+      request_balance
+    end
+
+    def get_stats(date = Date.today)
+      request_stats date
+    end
+
+    private
+
+    def get_status
+      case request_status
+      when /^OK\|(.+)/
+        $1
+      when 'CAPCHA_NOT_READY'
+        raise CaptchaNotReady
+      when /^ERROR_(.+)/
+        raise error_class($1)
+      else
+        raise UnknownResponse
+      end
+    end
+
+    def request_status
+      request 'http://antigate.com/res.php',
+        key: AntigateRb.configuration.key,
+        action: 'get',
+        id: @captcha_id
+    end
+
+    def request_image(image)
+      request 'http://antigate.com/in.php',
+        @options.merge(method: 'base64', body: Base64.encode64(image))
+    end
+
+    def request_report_bad
+      request 'http://antigate.com/res.php',
+        key: AntigateRb.configuration.key,
+        action: 'reportbad',
+        id: @captcha_id
+    end
+
+    def request_balance
+      request 'http://antigate.com/res.php',
+        key: AntigateRb.configuration.key,
+        action: 'getbalance'
+    end
+
+    def request_stats(date)
+      request 'http://antigate.com/res.php',
+        key: AntigateRb.configuration.key,
+        action: 'getstats',
+        date: date.strftime('%Y-%m-%d')
+    end
+
+    def request(url, params)
+      request = HTTPI::Request.new.tap do |request|
+        request.url = url
+        request.body = params
+      end
+      HTTPI.post(request).body
+    end
+
+    def error_class(string)
+      "AntigateRb::#{string.downcase.classify}".constantize
+    rescue NameError
+      UnknownErrorResponse
+    end
+
+  end
+end

data/lib/antigate_rb/configuration.rb

@@ -0,0 +1,32 @@
+module AntigateRb
+  class Configuration
+
+    @@config_keys = []
+
+    def self.config_key(key, default_value = nil)
+      attr_accessor key
+      @@config_keys << key
+      if default_value
+        define_method key do
+          instance_variable_get(:"@#{key}") || default_value
+        end
+      end
+    end
+
+    config_key :key
+    config_key :phrase, 0
+    config_key :regsense, 0
+    config_key :numeric, 0
+    config_key :calc, 0
+    config_key :min_len, 0
+    config_key :max_len, 0
+    config_key :is_russian, 0
+
+    def options
+      @@config_keys.each_with_object({}) do |key, hash|
+        hash[key] = __send__(key) if __send__(key)
+      end
+    end
+
+  end
+end

data/lib/antigate_rb/error.rb

@@ -0,0 +1,48 @@
+module AntigateRb
+
+  class Error < StandardError
+  end
+
+  class UnknownResponse < Error
+  end
+
+  class UnknownErrorResponse < Error
+  end
+
+  class WrongUserKey < Error
+  end
+
+  class KeyDoesNotExist < Error
+  end
+
+  class ZeroBalance < Error
+  end
+
+  class NoSlotAvailable < Error
+  end
+
+  class ZeroCaptchaFilesize < Error
+  end
+
+  class TooBigCaptchaFilesize < Error
+  end
+
+  class WrongFileExtension < Error
+  end
+
+  class ImageTypeNotSupported < Error
+  end
+
+  class IpNotAllowed < Error
+  end
+
+  class CaptchaNotReady < Error
+  end
+
+  class WrongIdFormat < Error
+  end
+
+  class CaptchaUnsolvable < Error
+  end
+
+end

data/lib/antigate_rb/version.rb

@@ -0,0 +1,3 @@
+module AntigateRb
+  VERSION = "0.0.1"
+end

data/test/antigate_rb_test.rb

@@ -0,0 +1,130 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'antigate_rb'
+
+HTTPI.log = false
+
+class TestAntigateConfigure < MiniTest::Unit::TestCase
+  def setup
+    AntigateRb.configure do |config|
+      config.key = 'test_key'
+      config.phrase = 1
+    end
+  end
+
+  def test_configuration_default_options
+    assert_equal({ key: "test_key", phrase: 1, regsense: 0, numeric: 0, calc: 0,
+                 min_len: 0, max_len: 0, is_russian: 0 },
+                 AntigateRb.configuration.options)
+  end
+end
+
+class TestAntigate < MiniTest::Unit::TestCase
+  def setup
+    AntigateRb.configure do |config|
+      config.key = 'test_key'
+    end
+    @client = AntigateRb::Client.new(sleep: 0, retries_count: 1)
+  end
+
+  def test_success_request
+    stub_request(:post, "http://antigate.com/in.php").
+      to_return(status: 200, body: 'OK|request_id')
+
+    stub_request(:post, "http://antigate.com/res.php").
+      with(body: {"action"=>"get", "id"=>"request_id", "key"=>"test_key"}).
+      to_return(status: 200, body: 'CAPCHA_NOT_READY').then.
+      to_return(status: 200, body: 'OK|result')
+
+    result = @client.decode 'file_content'
+    assert_equal 'result', result
+  end
+
+  def test_with_retries
+    stub_request(:post, "http://antigate.com/in.php").
+      to_return(status: 200, body: 'OK|request_id')
+
+    stub_request(:post, "http://antigate.com/res.php").
+      with(body: {"action"=>"get", "id"=>"request_id", "key"=>"test_key"}).
+      to_return(status: 200, body: 'CAPCHA_NOT_READY').then.
+      to_return(status: 200, body: 'CAPCHA_NOT_READY')
+
+    assert_raises AntigateRb::CaptchaNotReady do
+      @client.decode 'file_content'
+    end
+  end
+
+  %w(ERROR_KEY_DOES_NOT_EXIST ERROR_WRONG_ID_FORMAT ERROR_CAPTCHA_UNSOLVABLE).each do |error_message|
+    define_method "test_status_#{error_message}" do
+      stub_request(:post, "http://antigate.com/in.php").
+        to_return(status: 200, body: 'OK|request_id')
+
+      stub_request(:post, "http://antigate.com/res.php").
+        with(body: {"action"=>"get", "id"=>"request_id", "key"=>"test_key"}).
+        to_return(status: 200, body: error_message)
+
+      assert_raises "AntigateRb::#{error_message.gsub(/^ERROR_/,'').downcase.classify}".constantize do
+        @client.decode 'file_content'
+      end
+    end
+  end
+
+  %w(ERROR_WRONG_USER_KEY ERROR_KEY_DOES_NOT_EXIST ERROR_ZERO_BALANCE
+     ERROR_NO_SLOT_AVAILABLE ERROR_ZERO_CAPTCHA_FILESIZE
+     ERROR_TOO_BIG_CAPTCHA_FILESIZE ERROR_WRONG_FILE_EXTENSION
+     ERROR_IMAGE_TYPE_NOT_SUPPORTED ERROR_IP_NOT_ALLOWED).each do |error_message|
+
+    define_method("test_request_#{error_message}") do
+      stub_request(:post, "http://antigate.com/in.php").
+        to_return(status: 200, body: error_message)
+
+      assert_raises "AntigateRb::#{error_message.gsub(/^ERROR_/,'').downcase.classify}".constantize do
+        @client.decode 'file_content'
+      end
+    end
+  end
+
+  def test_unknown_response
+    stub_request(:post, "http://antigate.com/in.php").
+      to_return(status: 200, body: 'unknown')
+
+    assert_raises AntigateRb::UnknownResponse do
+      @client.decode 'file_content'
+    end
+  end
+
+  def test_unknown_error_response
+    stub_request(:post, "http://antigate.com/in.php").
+      to_return(status: 200, body: 'ERROR_unknown')
+
+    assert_raises AntigateRb::UnknownErrorResponse do
+      @client.decode 'file_content'
+    end
+  end
+
+  def test_report_bad
+    @client.instance_variable_set :@captcha_id, 'test_id'
+    stub_request(:post, "http://antigate.com/res.php").
+      with(body: {"action"=>"reportbad", "id"=>"test_id", "key"=>"test_key"}).
+      to_return(status: 200, body: 'ok')
+
+    assert @client.report_bad
+  end
+
+  def test_get_balance
+    stub_request(:post, "http://antigate.com/res.php").
+      with(body: {"action"=>"getbalance", "key"=>"test_key"}).
+      to_return(status: 200, body: '10.05')
+
+    assert_equal '10.05', @client.get_balance
+  end
+
+  def test_get_stats
+    stub_request(:post, "http://antigate.com/res.php").
+      with(body: {"action" => "getstats", "key"=>"test_key", "date" => Date.today.strftime('%Y-%m-%d')}).
+      to_return(status: 200, body: '<?xml version="1.0"?><response></response>')
+
+    assert_equal '<?xml version="1.0"?><response></response>', @client.get_stats
+  end
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: antigate_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nikita Pomiashchii
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Antigate api ruby wrapper
+email:
+- pomnikita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- antigate_rb.gemspec
+- lib/antigate_rb.rb
+- lib/antigate_rb/client.rb
+- lib/antigate_rb/configuration.rb
+- lib/antigate_rb/error.rb
+- lib/antigate_rb/version.rb
+- test/antigate_rb_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Antigate api ruby wrapper
+test_files:
+- test/antigate_rb_test.rb