Yandex Captcha
Ruby wrapper for Yandex Cleanweb with Rails and Sinatra support, spam detector.
Unfortunatelly, this gem is not capable with MRI 1.8.7 because of MRI 1.8.7 doesn't have URI.encode_www_form method.
Installation
Add this line to your application's Gemfile:
gem 'yandex_captcha', '~> 0.4.3'
Or:
gem 'yandex_captcha', github: 'merqlove/yandex-captcha'
And then execute:
$ bundle
Or install it yourself as:
$ gem install yandex_captcha
This gem can be used as Rails Engine or Sinatra Extension.
Tested:
- Rails 3.2+
- Rails 4.1
- Sinatra 1.4+
Usage
Get the api key: http://api.yandex.ru/cleanweb/getkey.xml
Configuration options
| Name | Value |
|---|---|
| api_key | Yandex.CleanWeb API key. (default nil) |
| captcha_type (optional) | Type of captcha (std,estd,lite,elite,rus,latl,elatl,latu,elatu,latm, elatm). (default std) |
| api_server_url (optional) | Yandex.CleanWeb API server URL. (default http://cleanweb-api.yandex.ru/1.0) |
| skip_verify_env (optional) | Custom error provider for non ajax mode. (default ['test', 'cucumber']) |
| handle_timeouts_gracefull (optional) | Graceful error's on timeouts. (default true) |
| current_env (optional) | Current environment (default `ENV['RACK_ENV'] |
Code
# Rails routes
mount YandexCaptcha::Engine, at: '/yandex_captcha/'
# or
mount YandexCaptcha::Engine, at: '/'
# Sinatra
register YandexCaptcha::Sinatra
# Configuration
YandexCaptcha.configure do |config|
config.api_key = "your_key"
endIn Views
captcha_tag options
| Name | Value |
|---|---|
| :ajax (optional) | Ajaxify your captcha, don't wait for it on any page. (default false) |
| :noscript (optional) | Adding wrap around captcha. Works only for non ajax mode. (default false) |
| :error (optional) | Custom error provider for non ajax mode. (default flash or nil) |
Code
<form action="/path" method="POST">
<%= captcha_tags ajax:true %>
<input type="submit" value="Submit" />
</form>
or
<%= form_tag some_response_path do %>
<%= captcha_tags ajax:true %>
<%= submit_tag 'Submit' %>
<% end %>In Controllers
valid_captcha? options
| Name | Value |
|---|---|
| :captcha_id | Yandex.CleanWeb captcha id. (default nil) |
| :value | User response value. (default nil) |
| :request_id (optional) | Some unique request id (default nil) |
get_captcha options
| Name | Value |
|---|---|
| :request_id (optional) | Some unique request id (default nil) |
Example
# Rails / Sinatra / or if you included helpers
if valid_captcha?(params[:captcha_response_id], params[:captcha_response_field])
# some
end
# Long way
if YandexCaptcha::Verify.valid_captcha?(params[:captcha_response_id], params[:captcha_response_field])
# some
endOther examples
# Helpers
spam?("just phrase")
=> false
# Methods
YandexCaptcha::Verify.spam?("just phrase")
=> false
YandexCaptcha::Verify.spam?(body_plain: "my text", ip: "80.80.40.3")
=> false
YandexCaptcha::Verify.spam?(body_html: "some spam <a href='http://spam.com'>spam link</a>")
=> { id: "request id", links: [ ['http://spam.com', true] ] }More complex example
user_input = "download free porn <a>...</a>"
if spam_check = YandexCaptcha::Verify.spam?(user_input, ip: current_user.ip)
captcha = YandexCaptcha::Verify.get_captcha(spam_check[:id])
# now you can show captcha[:url] to user
# but remember to write captcha[:captcha] to session
# to check is captcha enterred by user is valid:
captcha_valid = YandexCaptcha::Verify.valid_captcha?(result[:id], captcha[:captcha], user_captcha)
endIf you use Yandex Captcha in Rails app, we recommend to set up the api key in config/initializers/yandex_captcha.rb
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Special respect to Evrone which gem yandex-cleanweb include most of code in lib/yandex_captcha/verify.rb and some examples on this page.