rucaptcha_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 642a13024ef55b534056108982db38a64189151d
+  data.tar.gz: 71ac25cca9fe38550a7b5f1814df40f3991f3ee2
+SHA512:
+  metadata.gz: 45b70900c9022c1eb3fc6c7298176ba10c887fc2587db7045d6cdb6b02f933d522bd163581adf8c0f214f51f2bc6749d4211371f5a79846424f4131cd578c61f
+  data.tar.gz: e09ecf5a6977662c7ba4583afc2de2020936287c69182915920794fb8cf50e596cfe61a243e1f9faf27e1ebc88cff4054e8de32d887b87d23e5be58efd171d69

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,32 @@
+# RucaptchaApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rucaptcha_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rucaptcha_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rucaptcha_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rucaptcha_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rucaptcha_api/errors.rb

@@ -0,0 +1,55 @@
+module Errors
+	def inspect__send_captcha_for_solving__errors response, path_to_captcha
+		raise response + "\n" + case response
+		when 'ERROR_WRONG_USER_KEY'
+			"explanation: Не верный формат параметра key, должно быть 32 символа\nkey: #{@rucaptcha_key}"
+		when 'ERROR_KEY_DOES_NOT_EXIST'
+			"explanation: Использован несуществующий key\nkey: #{@rucaptcha_key}"
+		when 'ERROR_ZERO_BALANCE'
+			'explanation: Баланс Вашего аккаунта нулевой'
+		when 'ERROR_NO_SLOT_AVAILABLE'
+			'explanation: Текущая ставка распознования выше, чем максимально установленная в настройках Вашего аккаунта. Либо на сервере скопилась очередь и работники не успевают её разобрать, повторите загрузку через 5 секунд.'
+		when 'ERROR_ZERO_CAPTCHA_FILESIZE'
+			"explanation: Размер капчи меньше 100 Байт\n#{path_to_captcha}'s size:' #{File.new(path_to_captcha).size} bytes"
+		when 'ERROR_TOO_BIG_CAPTCHA_FILESIZE'
+			"explanation: Размер капчи более 100 КБайт\n#{path_to_captcha}'s size:' #{File.new(path_to_captcha).size/1024} kilobytes"
+		when 'ERROR_WRONG_FILE_EXTENSION'
+			"explanation: Ваша капча имеет неверное расширение, допустимые расширения jpg,jpeg,gif,png\nyour kaptcha extension: #{File.extname path_to_captcha},\npath to your captcha: #{path_to_captcha}"
+		when 'ERROR_IMAGE_TYPE_NOT_SUPPORTED'
+			"explanation: Сервер не может определить тип файла капчи\npath to your captcha: #{path_to_captcha}"
+		when 'ERROR_IP_NOT_ALLOWED'
+			'explanation: В Вашем аккаунте настроено ограничения по IP с которых можно делать запросы. И IP, с которого пришёл данный запрос не входит в список разрешённых.'
+		when 'IP_BANNED'
+			"explanation: IP-адрес, с которого пришёл запрос заблокирован из-за частых обращений с различными неверными ключами. Блокировка снимается через час\nTime.now: #{Time.now}"
+		end
+	end
+
+
+	def inspect__get_solved_captcha__errors response, captcha_id
+		raise response + "\n" + case response
+		when 'ERROR_KEY_DOES_NOT_EXIST'
+			"explanation: Вы использовали неверный key в запросе\nkey: #{@rucaptcha_key}"
+		when 'ERROR_WRONG_ID_FORMAT'
+			"explanation: Неверный формат ID капчи. ID должен содержать только цифры\ncaptcha id: #{captcha_id}"
+		when 'ERROR_CAPTCHA_UNSOLVABLE'
+			'explanation: Капчу не смогли разгадать 3 разных работника. Списанные средства за это изображение возвращаются обратно на баланс'
+		when 'ERROR_WRONG_CAPTCHA_ID'
+			'explanation: Вы пытаетесь получить ответ на капчу или пожаловаться на капчу, которая была загружена более 15 минут назад'
+		when 'ERROR_BAD_DUPLICATES'
+			'explanation: Ошибка появляется при включённом 100%м распознании. Было использовано максимальное количество попыток, но необходимое количество одинаковых ответов не было набрано'
+		end
+	end
+
+
+	# Пожаловаться на неправильно расшифрованную капчу
+	def complain captcha_id
+		rucaptcha_complain_link = BASE_URI + "/res.php?key=#{@rucaptcha_key}&action=reportbad&id=#{captcha_id}"
+		response = RestClient.get rucaptcha_complain_link
+		response == 'OK_REPORT_RECORDED' ? true : response
+	end
+
+
+
+
+
+end

data/lib/rucaptcha_api/stats.rb

@@ -0,0 +1,49 @@
+module Stats
+
+	def self.included(base)
+		base.extend ClassMethods
+	end
+		
+	# Узнать баланс аккаунта. Баланс указывается в Российских рублях
+	def balance
+		rucaptcha_balance_link = BASE_URI + "/res.php?key=#{@rucaptcha_key}&action=getbalance"
+		RestClient.get rucaptcha_balance_link
+	end
+
+	# Запрос статуса и стоимости распознования данной капчи. Цена указывается в рублях
+	def captcha_cost captcha_id
+		rucaptcha_cost_link = BASE_URI + "/res.php?key=#{@rucaptcha_key}&action=get2&id=#{captcha_id}"
+		RestClient.get rucaptcha_cost_link
+	end
+
+	# получить статистику использования аккаунта в XML за указанную дату
+	# => string with xml
+	def stats_for date: '2013-11-27'
+		rucaptcha_stats_for_date_link = BASE_URI + "/res.php?key=#{@rucaptcha_key}&action=getstats&date=#{date}"
+		RestClient.get rucaptcha_stats_for_date_link
+	end
+
+
+	module ClassMethods
+		# waiting: количество работников ожидающих капчу.
+		# load: процент загрузки работников
+		# minbid: текущая ставка за распознание капчи. В рублях
+		# averageRecognitionTime: среднее время (в секундах) за которое в данный момент разгадываются капчи
+		def rucaptcha_stats
+			rucaptcha_stats_link = BASE_URI + "/load.php"
+			response = RestClient.get rucaptcha_stats_link
+
+			doc = Nokogiri::XML response
+			{ 
+				waiting: doc.at_css('waiting').text, 
+				load: doc.css('load').text, 
+				minbid: doc.at_css('minbid').text, 
+				average_recognition_time: doc.at_css('averageRecognitionTime').text
+			}
+
+		end
+	end
+
+
+
+end

data/lib/rucaptcha_api/version.rb

@@ -0,0 +1,3 @@
+class RucaptchaApi
+  VERSION = '1.0.0'
+end

data/lib/rucaptcha_api.rb

@@ -0,0 +1,53 @@
+require 'rest-client'
+require 'nokogiri'
+
+require "rucaptcha_api/version"
+require "rucaptcha_api/errors"
+require "rucaptcha_api/stats"
+
+
+RucaptchaApi.class_eval do
+	include Errors
+	include Stats
+
+	BASE_URI = 'http://rucaptcha.com'
+
+	attr_reader :rucaptcha_key
+
+	def initialize rucaptcha_key
+		@rucaptcha_key = rucaptcha_key
+	end
+
+	def send_captcha_for_solving path_to_captcha, params: {}
+
+		final_params = {
+			key:      @rucaptcha_key,
+			file:     File.new(path_to_captcha)
+		}.merge params #either add or override defaults
+		
+		response = RestClient.post "#{BASE_URI}/in.php", final_params #"OK|179055170"
+
+		if captcha_id = response.scan(/\AOK\|([0-9]+)\Z/).flatten[0] #either nil or '179055170' 
+			captcha_id
+		else
+			inspect__send_captcha_for_solving__errors response, path_to_captcha
+		end
+	end
+
+	def get_solved_captcha captcha_id
+		get_link = BASE_URI + "/res.php?key=#{@rucaptcha_key}&action=get&id=#{captcha_id}"
+		response = RestClient.get get_link
+		if response == 'CAPCHA_NOT_READY'
+			sleep 5
+			get_solved_captcha captcha_id
+		elsif solved_captcha = response.scan(/\AOK\|(\w+)\Z/).flatten[0]
+			solved_captcha
+		else
+			inspect__get_solved_captcha__errors response, captcha_id
+		end
+	end
+
+
+end
+
+

data/rucaptcha_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rucaptcha_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rucaptcha_api"
+  spec.version       = RucaptchaApi::VERSION
+  spec.authors       = ["Jevgenija Karunus"]
+  spec.email         = ["lakesare@gmail.com"]
+
+  spec.summary       = 'Ruby mapper for https://rucaptcha.com API'
+  spec.homepage      = 'https://github.com/lakesare/rucaptcha_api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency 'rest-client'
+  spec.add_runtime_dependency 'nokogiri'
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rucaptcha_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jevgenija Karunus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rest-client
+  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: nokogiri
+  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: 
+email:
+- lakesare@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rucaptcha_api.rb
+- lib/rucaptcha_api/errors.rb
+- lib/rucaptcha_api/stats.rb
+- lib/rucaptcha_api/version.rb
+- rucaptcha_api.gemspec
+homepage: https://github.com/lakesare/rucaptcha_api
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby mapper for https://rucaptcha.com API
+test_files: []