captcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42a4bd27e904e52012256226988e854b5d21cf73a69af147f3407de4cd3e8965
+  data.tar.gz: 8effe1d5469292eece64a258f89dd604a2c0389473af70dd1553e80d820ae052
+SHA512:
+  metadata.gz: 117d2b310d1ec56e1474f92c5a28ab09340df48e53e6514581f35febfe7e63ad2a6d9c5b767a9224a3209678eb90dd648d686c4c9412bbd93957cf82a0e566fd
+  data.tar.gz: c7a699acdf006c866d389a28caf0143db664919a1811fc039c1f79c54502ffc2c00c569e82bdbe741218af43ee338b132a2f5f8a4b393072b432c80a7ba072bc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Ivan Zinovyev
+
+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,210 @@
+# Captcher
+
+Easy to use classical captcha for Rails apps
+
+![Example of captcha field](docs/captcha_field.png "Captcher captcha")
+
+
+## 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(session) # Reload the captcha
+    # render response with success code ...
+  end
+
+  def create
+    @comment = Comment.new(comment_params)
+    captcha_check = confirm_captcha?(session, 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| %>
+  <!-- Some html/erb code for all form fields -->
+  <!-- ... -->
+  <!-- /Some html/erb code for all form fields -->
+
+  <div class="input-group">
+    <%= text_field_tag :captcha, "",
+      type: :text,
+      label: false,
+      class: "form-control",
+      placeholder: "Enter the captcha" %>
+
+    <div class="input-group-append">
+      <div class="input-group-text" style="padding: 0">
+        <%= image_tag(captcher.captcha_path(format: :png), style: "height: 35px;",
+                                                           id: "captcha-image") %>
+      </div>
+      <button class="btn btn-outline-secondary" type="button" id="captcha-reload">
+        <i class="fa fa-refresh"></i>
+      </button>
+    </div>
+  </div>
+
+<% 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
+
+```ruby
+
+# config/initialiers/captcher.rb
+
+Captcher.configure do |c|
+  c.mode = :code_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
+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
+
+
+## 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).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Captcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/captcher/captchas_controller.rb

@@ -0,0 +1,22 @@
+module Captcher
+  class CaptchasController < ActionController::Base
+    include Captcher::CaptchaAware
+
+    def show
+      render_captcha(load_captcha(session))
+    end
+
+    def reload
+      render_captcha(reload_captcha(session))
+    end
+    alias refresh reload
+
+    def confirm
+      if confirm_captcha?(session, params[:confirmation])
+        render json: { success: true }, status: 200
+      else
+        render json: { success: false }, status: 422
+      end
+    end
+  end
+end

data/app/controllers/concerns/captcher/captcha_aware.rb

@@ -0,0 +1,30 @@
+module Captcher
+  module CaptchaAware
+    extend ActiveSupport::Concern
+
+    def load_captcha(session)
+      Captcher.captcha_class.restore_or_create(Captcher.config, session)
+    end
+
+    def reload_captcha(session)
+      captcha = Captcher.captcha_class.new(config: Captcher.config)
+      captcha.store(session)
+      captcha
+    end
+
+    def confirm_captcha(session, confirmation)
+      captcha = load_captcha(session)
+      captcha.validate(confirmation)
+    end
+    alias confirm_captcha? confirm_captcha
+
+    private
+
+    def render_captcha(captcha)
+      format = params[:format] || captcha.own_config[:format]
+      filename = "captcha.#{format}"
+      type = "image/#{format}"
+      send_data captcha.represent, filename: filename, type: type, disposition: :inline
+    end
+  end
+end

data/app/helpers/captcher/application_helper.rb

@@ -0,0 +1,13 @@
+module Captcher
+  module ApplicationHelper
+    def captcha_tag(options)
+      options = options.symbolize_keys
+
+      src = options[:src] = captcha_path
+
+      options[:alt] = options.fetch(:alt) { image_alt(src) }
+      options[:width], options[:height] = extract_dimensions(options.delete(:size)) if options[:size]
+      tag("img", options)
+    end
+  end
+end

data/app/views/layouts/captcher/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Captcher</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "captcher/application", media: "all" %>
+  <%= javascript_include_tag "captcher/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Captcher::Engine.routes.draw do
+  resource :captcha, only: [:show] do
+    member do
+      %i[reload refresh confirm].each do |route|
+        send :post, route
+        send :get, route
+      end
+    end
+  end
+end

data/lib/captcher.rb

@@ -0,0 +1,57 @@
+require "mini_magick"
+require "captcher/engine"
+require "captcher/config"
+require "captcher/text_image"
+require "captcher/base_captcha"
+require "captcher/captchas/awesome_captcha"
+require "captcher/captchas/math_captcha"
+require "captcher/captchas/code_captcha"
+require "pry" if Rails.env.in?(%w[development test])
+
+module Captcher
+  extend self
+
+  def configure
+    @config = Captcher::Config.new
+    yield(@config)
+    self
+  end
+
+  def config
+    default_config.merge(@config)
+  end
+
+  def captcha_class
+    return @captcha_class if @captcha_class
+
+    klass = Captcher.config[:mode].to_s.camelize
+    @captcha_class = "Captcher::Captchas::#{klass}".constantize
+  end
+
+  private
+
+  # rubocop:disable Metrics/MethodLength
+  def default_config
+    @default_config ||= Captcher::Config.new do |c|
+      c.mode = :code_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.math_captcha do |mc|
+
+      end
+
+      c.awesome_captcha do |ac|
+
+      end
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+end

data/lib/captcher/base_captcha.rb

@@ -0,0 +1,46 @@
+module Captcher
+  class BaseCaptcha
+    SESSION_KEY = "captcha_state".freeze
+
+    class << self
+      attr_accessor :name
+
+      def restore(session)
+        state = session[SESSION_KEY]
+        new(state) if state
+      end
+
+      def restore_or_create(config, session)
+        restore(session) || new(config: config).store(session)
+      end
+    end
+
+    attr_accessor :config, :payload
+
+    def initialize(options = {})
+      options = options.with_indifferent_access
+      @config = options[:config] if options[:config]
+      @payload = options[:payload] if options[:payload]
+      after_initialize
+    end
+
+    def after_initialize; end
+
+    def store(session)
+      session[SESSION_KEY] = { payload: payload, config: config }
+      self
+    end
+
+    def own_config
+      @own_config ||= @config[self.class.name.to_sym]
+    end
+
+    def represent(format = :html, options = {})
+      raise NotImplementedError
+    end
+
+    def validate(confirmation)
+      raise NotImplementedError
+    end
+  end
+end