99 lines
2.4 KiB
Markdown
99 lines
2.4 KiB
Markdown
# RuCaptcha
|
|
|
|
[](https://badge.fury.io/rb/rucaptcha)
|
|
[](https://travis-ci.org/rucaptcha/rucaptcha)
|
|
|
|
This is a Captcha gem for Rails Applications. It runs an ImageMagick command to draw Captcha image - so it has NO performance issues or memory leak issues.
|
|
|
|
**There is NO: RMagick**
|
|
|
|
Idea by: https://ruby-china.org/topics/20558#reply4
|
|
|
|
[中文介绍和使用说明](https://ruby-china.org/topics/27832)
|
|
|
|
### Requirements
|
|
|
|
- ImageMagick
|
|
|
|
### Example
|
|
|
|
    
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
Put rucaptcha in your `Gemfile`:
|
|
|
|
```
|
|
gem 'rucaptcha'
|
|
```
|
|
|
|
Create `config/initializers/rucaptcha.rb`
|
|
|
|
```rb
|
|
RuCaptcha.configure do
|
|
# Number of chars, default: 4
|
|
self.len = 4
|
|
# Image width, default: 180
|
|
self.width = 180
|
|
# Image height, default: 48
|
|
self.height = 48
|
|
end
|
|
```
|
|
|
|
Edit `config/routes.rb`, add the following code:
|
|
|
|
```rb
|
|
Rails.application.routes.draw do
|
|
...
|
|
mount RuCaptcha::Engine => "/rucaptcha"
|
|
...
|
|
end
|
|
```
|
|
|
|
Controller `app/controller/account_controller.rb`
|
|
|
|
```rb
|
|
class AccountController < ApplicationController
|
|
def create
|
|
@user = User.new(params[:user])
|
|
if verify_rucaptcha?(@user) && @user.save
|
|
redirect_to root_path, notice: 'Sign up successed.'
|
|
else
|
|
render 'account/new'
|
|
end
|
|
end
|
|
end
|
|
```
|
|
|
|
View `app/views/account/new.html.erb`
|
|
|
|
```erb
|
|
<form>
|
|
...
|
|
<div class="form-group">
|
|
<%= rucaptcha_input_tag(class: 'form-control', placeholder: 'Input Captcha') %>
|
|
<%= rucaptcha_image_tag(alt: 'Captcha') %>
|
|
</div>
|
|
...
|
|
</form>
|
|
```
|
|
|
|
## Test skip captcha validation
|
|
|
|
```rb
|
|
describe 'sign up and login', type: :feature do
|
|
before do
|
|
allow_any_instance_of(ActionController::Base).to receive(:verify_rucaptcha?).and_return(true)
|
|
end
|
|
|
|
it { ... }
|
|
end
|
|
```
|
|
|
|
## TODO
|
|
|
|
- Use [rtesseract](https://github.com/dannnylo/rtesseract) to test OCR.
|
|
|