Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zinovyev/captcher
Easy to use classical captcha for Rails apps
https://github.com/zinovyev/captcher
Last synced: about 2 months ago
JSON representation
Easy to use classical captcha for Rails apps
- Host: GitHub
- URL: https://github.com/zinovyev/captcher
- Owner: zinovyev
- License: mit
- Created: 2019-03-25T23:46:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-29T22:03:47.000Z (almost 6 years ago)
- Last Synced: 2024-04-25T23:20:23.537Z (8 months ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/captcher
- Size: 971 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Captcher
Easy to use classic captcha for Rails apps
## Feature
* Configurable via DSL
* Supports caching
* Simple, Easy to use
* Uses Imagemagick via the MiniMagick gem
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'captcher'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install captcher
```
Mount the engine inside your application by adding this line to your application's routes file at `config/routes.rb`:
```ruby
mount Captcher::Engine => "/captcher"
```
## Usage
### Render on page
1. Include the concern with helper methods to your ApplicationController:
```ruby
class ApplicationController < ActionController::Base
include Captcher::CaptchaAware
end
```
2. Use helper methods in your controller:
```ruby
class MyController < ApplicationController
def index
reload_captcha # Reload the captcha
# render response with success code ...
end
def create
@comment = Comment.new(comment_params)
captcha_check = confirm_captcha?(params[:captcha])
if @comment.valid? && captcha_check && @comment.save
# render response with success code ...
else
@comment.errors[:captcha] << "Captcha verification failed" unless captcha_check
# render response with error code ...
end
end
# ... some other code
end
```
3. An example bootstrap-based html/erb code:
```html
<%= simple_form_for(some_form) do |f| %>
<%= text_field_tag :captcha, "",
type: :text,
label: false,
class: "form-control",
placeholder: "Enter the captcha" %>
<%= image_tag(captcher.captcha_path(format: :png), style: "height: 35px;",
id: "captcha-image") %>
<% end %>
```
4. Javascript code to refresh the capture:
```javascript
function reloadCaptcha() {
$.ajax({
type: 'GET',
url: '/captcher/captcha/reload.png',
success: function() {
var timestamp = (new Date()).getTime();
$('#captcha-image').attr("src", "/captcher/captcha.png?" + timestamp);
},
});
}
$('#captcha-reload').click(function() {
reloadCaptcha();
});
```
### API endpoints
These endpoints are available by default (as soon as you've mounted the `Captcher` engine to your `routes.rb` file) and can be used for some async requests:
* `http://your-application.com/captcher/captcha` - Load the captcha image
* `http://your-application.com/captcher/captcha/reload` - Reload the captcha
* `http://your-application.com/captcher/captcha/confirm?confirmation=code` - Confirm captcha code
## Configuration
Select one of the following available modes:
* **code\_captcha** - Classic image-based captcha;
* **cached\_captcha** - Acts like a caching proxy for any of available captcha types.
Keeps several generated captcha variants in cache. The number of available cache slots is configured with the `slots_count` parameter
* **math\_captcha** (not implemented yet)
* **awesome_captcha** (not implemented yet)
```ruby
# config/initialiers/captcher.rb
Captcher.configure do |c|
c.mode = :cached_captcha
c.code_captcha do |cc|
cc.fonts Dir[Captcher::Engine.root.join("lib/fonts/**")]
cc.font_size 50
cc.font_color "black"
cc.count 5
cc.background "#999999"
cc.format "png"
end
c.cached_captcha do |cc|
cc.slots_count 10
cc.wrapped :code_captcha
end
end
```
## TODO
1. Implement some other types of captcha
2. Integrate with Travis to test the gem against different versions of Ruby/ROR
3. Improve code style
4. Improve documentation
5. Autogenerated API documentation
6. ~~Add some caching~~
## Contributing
Contribution directions go here.
## Fonts
The fonts wich are shiped by default with this repo
are taken from https://github.com/google/fonts
and use the SIL Open Font License, v1.1
**There's a list of the origin paths of the fonts**:
* https://github.com/google/fonts/tree/master/ofl/bangers
* https://github.com/google/fonts/tree/master/ofl/carterone
* https://github.com/google/fonts/tree/master/ofl/frederickathegreat
* https://github.com/google/fonts/tree/master/ofl/indieflower
* https://github.com/google/fonts/tree/master/ofl/lobstertwo
* https://github.com/google/fonts/tree/master/ofl/sigmarone
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).