simple_captcha_reloaded 0.0.1.beta1 → 0.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa801cc85f0158820e305bf66357177b8c5bd510
-  data.tar.gz: 132bf89c7a166597d1696da847e286ff660a51f7
+  metadata.gz: 8f4126818899ea31db41b60c51a036065f0fde3c
+  data.tar.gz: 479910c2d5ad2b20c5e0f9f3eeb0c3d1a693c0bb
 SHA512:
-  metadata.gz: b1e5dde7410f5d751fac27564b03394854224b2f7bb6301574b3d238899fde52c5dc9f253e772f9d2d98c838529d50bf0e8389b2c5595418d1e9dfe8739f0819
-  data.tar.gz: 2d0e18542d4e71e4ae8abdd4541a540ee944a10ea1027c8f499e503289b44ec29e8c58466dafb9fa93e930491e5b06d9be192b7773d3ad95bb145f0b47dcdcc0
+  metadata.gz: 9f69f5ad7cf1e8737d8ccdf91e4b1788d00d3235f80882b20a42a58c5cb598247a8691e316f0771a5342047089d215ab3e11a34d2001f3b86cc43ccdfc822b0f
+  data.tar.gz: 901e27f5873bed57c56ee6d637d49ebb78ece64bed5226ebef34678c4f8b19ca7347f30fb82e4432688459fd99a2c6150b333d14753e562e7cb7277e0de6d553

data/README.md

@@ -0,0 +1,194 @@
+# Simple Captcha Reloaded
+
+[![Build Status](https://travis-ci.org/zealot128/simple_captcha_reloaded.svg?branch=master)](https://travis-ci.org/zealot128/simple_captcha_reloaded)
+[![Gem Version](https://badge.fury.io/rb/simple_captcha_reloaded.svg)](http://badge.fury.io/rb/simple_captcha_reloaded)
+
+This is a rewrite of the popular Simple-Captcha Gem. Similarily to Simple-Captcha, it provides an easy way to integrate a Captcha into a Rails appliaction. In comparison to the older Gem(s), I decided to drop support for ancient versions of Rails + Formtastic + Mongoid, but also add specs and support for SimpleForm.
+
+## Features
+
+* Works with Rails 4.1+, Ruby 2.0+ (keyword arguments)
+* Integrated into Model validation flow
+* Optional controller integration for custom flow
+* Uses a database table to track random captchas
+* Uses imagemagick to generate the captcha and stream it to the client, without file access
+
+## Prerequisites
+
+This needs Rails (4.1+), ActiveRecord with a database (all should be fine) and imagemagick.
+
+Mac:
+
+```
+brew install imagemagick ghostscript
+```
+
+Linux:
+
+```
+apt-get install imagemagick ghostscript
+```
+
+## Usage
+
+Put it into your Gemfile:
+
+```ruby
+gem 'simple_captcha_reloaded'
+```
+
+and run ``bundle install``.
+
+
+### Integration 1: Model based
+
+Just integrate the module into on of your ActiveModel::Model compliant Models:
+
+```ruby
+class Message < ActiveRecord::Base
+  include SimpleCaptchaReloaded::Model
+end
+```
+
+this adds 2 new methods: ``valid_with_captcha?`` and ``save_with_captcha`` to the model. Use it like this in controller:
+
+```ruby
+class MessagesController < ApplicationController
+  def submit
+    @message = Message.new(message_params)
+    if @message.save_with_captcha
+      ...
+    else
+      render :new
+    end
+  end
+
+  def message_params
+    params.require(:message).permit(..., :captcha, :captcha_key)
+  end
+end
+```
+
+Make sure to whiteliste the attributes ``captcha`` and ``captcha_key`` with Strong Parameters.
+
+To show the captcha, you can use the SimpleForm helper:
+
+### Simple Form
+
+The Gem provides a custom input for SimpleForm:
+
+```slim
+= simple_form_for @model do |f|
+  = f.input :captcha, as: :simple_captcha
+  = f.submit
+```
+
+### Formtastic
+
+PLANNED
+
+### Manual by using default Rails view helper
+
+Similar to "Displaying Captcha" below, just change the key and value calls of the ``simple_captcha`` helper method to match your model:
+
+```slim
+= simple_captcha(key: 'user[captcha_key]', value: 'user[captcha]', refresh_button: true)
+```
+
+### Integration II - Controller
+
+If you need to use the captcha without a model, you can do the show and validation by hand
+
+## Displaying Captcha
+
+Within your form, call the function:
+
+```slim
+= form_tag '' do |f|
+  = simple_captcha(key: :captcha_key, value: :captcha, refresh_button: true)
+  = submit_tag 'send'
+```
+
+This method is a thin wrapper which will render the view ``simple_captcha_reloaded/simple_captcha_reloaded.html`` in the end. As this is a Rails engine, you can overwrite the view by creating a ``app/views/simple_captcha_reloaded/_simple_captcha_reloaded.html.erb`` in your project tree.
+
+Adjust it to your needs:
+
+```erb
+<div class='simple-captcha-wrapper' id='<%=id %>'>
+  <%= hidden_field_tag key, captcha[:captcha_id] %>
+  <%= image_tag captcha[:captcha_url], class: 'simple-captcha-image' %>
+  <%= text_field_tag value, '', class: 'simple-captcha-input' %>
+  <%- if refresh_button %>
+    <%=link_to t('simple_captcha_reloaded.refresh_button_html'), captcha[:refresh_url], data: { remote: true} %>
+  <% end %>
+</div>
+```
+
+### Manual Validation
+
+Now you can call a method in your controller to check if the captcha is valid:
+
+```ruby
+def submit
+  if captcha_valid?(params[:captcha_key], params[:captcha])
+    ..
+  else
+    ... error
+  end
+end
+```
+
+## Customizing
+
+### Captcha Options
+
+```ruby
+# Default Options
+SimpleCaptchaReloaded::Config.tap do |config|
+  config.captcha_path = '/simple_captcha'
+  config.image = SimpleCaptchaReloaded::Image.new
+  config.characters = %w[a b c d e f g h j k m n p q r s t u v w x y z 0 2 3 4 5 6 8 9]
+  config.length = 6
+end
+```
+
+To change the appearance of the Captcha, initialize a SimpleCaptchaReloaded::Image.new with different parameters (default parameters shown):
+
+```ruby
+  config.image = SimpleCaptchaReloaded::Image.new(implode: :medium,
+    distortion: :random,
+    image_styles: IMAGE_STYLES.slice('simply_red', 'simply_green', 'simply_blue'),
+    noise: 0,
+    size: '100x28',
+    image_magick_path: '',
+    tmp_path: nil
+  )
+
+# whereas IMAGE_STYLES are:
+IMAGE_STYLES = {
+  'embosed_silver'  => ['-fill darkblue', '-shade 20x60', '-background white'],
+  'simply_red'      => ['-fill darkred', '-background white'],
+  'simply_green'    => ['-fill darkgreen', '-background white'],
+  'simply_blue'     => ['-fill darkblue', '-background white'],
+  'distorted_black' => ['-fill darkblue', '-edge 10', '-background white'],
+  'all_black'       => ['-fill darkblue', '-edge 2', '-background white'],
+  'charcoal_grey'   => ['-fill darkblue', '-charcoal 5', '-background white'],
+  'almost_invisible' => ['-fill red', '-solarize 50', '-background white']
+}
+```
+
+
+## Contributing
+
+Report bugs/feature requests to the Github issues.
+If you'd like to contribute, here a little setup guide.
+The Gem uses **Appraisal**, to create various configuration Gem sets. For each Gem set, a new dummy app will be automatically created.
+
+1. Fork, and clone
+2. ``bundle``
+3. ``appraisal install``
+4. ``appraisal rails-stable make regenerate`` To build the dummy app with the Rails-Stable configuration
+4. ``appraisal rails-stable rspec`` To run tests
+
+If you need to add new controller methods to the dummy app, have a look at ``spec/template.rb``
+

data/app/models/simple_captcha_reloaded/data.rb

@@ -11,6 +11,15 @@ module SimpleCaptchaReloaded
       key
     end
 
+    def self.valid_captcha?(key,value)
+      element = find_by_key(key)
+      value && element && element.valid_captcha?(value)
+    end
+
+    def valid_captcha?(other)
+      other.present? and value == other.strip.downcase
+    end
+
     def self.clear
       SimpleCaptchaReloaded::Data.where('created_at < ?', 1.hour.ago).delete_all
     end

data/app/views/simple_captcha_reloaded/_simple_captcha_reloaded.html.erb

@@ -0,0 +1,8 @@
+<div class='simple-captcha-wrapper' id='<%=id %>'>
+  <%= hidden_field_tag key, captcha[:captcha_id] %>
+  <%= image_tag captcha[:captcha_url], class: 'simple-captcha-image' %>
+  <%= text_field_tag value, '', class: 'simple-captcha-input' %>
+  <%- if refresh_button %>
+    <%=link_to t('simple_captcha_reloaded.refresh_button_html'), captcha[:refresh_url], data: { remote: true} %>
+  <% end %>
+</div>

data/lib/simple_captcha_reloaded/adapters/simple_form.rb

@@ -2,7 +2,7 @@ require 'simple_form/version'
 class SimpleCaptchaInput < SimpleForm::Inputs::StringInput
   def input(wrapper_options=nil)
     set_options
-    code = get_code
+    @captcha = SimpleCaptchaReloaded.generate_captcha(id: options[:captcha][:id], request: template.request)
 
     if SimpleForm::VERSION[/^3\.0/]
       input = super()
@@ -10,13 +10,13 @@ class SimpleCaptchaInput < SimpleForm::Inputs::StringInput
       input = super
     end
     refresh = if options[:captcha][:refresh_button]
-                refresh_button(code)
+                refresh_button(@captcha)
               else
                 ""
               end
     [
-      image_tag(code),
-      captcha_key(code),
+      image_tag(@captcha),
+      captcha_key(@captcha),
       input,
       refresh
     ].join.html_safe
@@ -24,10 +24,9 @@ class SimpleCaptchaInput < SimpleForm::Inputs::StringInput
 
   protected
 
-  def refresh_button(code)
+  def refresh_button(captcha)
     template.content_tag :div, class: 'simple-captcha-reload' do
-      url = SimpleCaptchaReloaded::Config.refresh_url(template.request, options[:captcha][:id])
-      template.link_to url, class: options[:captcha][:refresh_button_class], data: {remote: true} do
+      template.link_to captcha[:refresh_url], class: options[:captcha][:refresh_button_class], data: {remote: true} do
         I18n.t('simple_captcha_reloaded.refresh_button_html')
       end
     end
@@ -40,19 +39,12 @@ class SimpleCaptchaInput < SimpleForm::Inputs::StringInput
     options[:wrapper_html][:id] ||= options[:captcha][:id]
   end
 
-  def get_code
-    old_key = template.request.session[:captcha]
-    SimpleCaptchaReloaded::Data.generate_captcha_id(old_key: old_key)
+  def image_tag(captcha)
+    template.content_tag(:img, nil, src: captcha[:captcha_url], alt: 'Captcha', class: 'simple-captcha-image')
   end
 
-
-  def image_tag(code)
-    url = SimpleCaptchaReloaded::Config.image_url(code, template.request)
-    template.content_tag(:img, nil, src: url, alt: 'Captcha', class: 'simple-captcha-image')
-  end
-
-  def captcha_key(code)
-    @builder.hidden_field :captcha_key, value: code
+  def captcha_key(captcha)
+    @builder.hidden_field :captcha_key, value: captcha[:captcha_id]
   end
 
   def default_options

data/lib/simple_captcha_reloaded/controller_helper.rb

@@ -0,0 +1,7 @@
+module SimpleCaptchaReloaded
+  module ControllerHelper
+    def captcha_valid?(key, value)
+      SimpleCaptchaReloaded::Data.valid_captcha?(key, value)
+    end
+  end
+end

data/lib/simple_captcha_reloaded/engine.rb

@@ -1,3 +1,5 @@
+require 'simple_captcha_reloaded/view_helper'
+require 'simple_captcha_reloaded/controller_helper'
 module SimpleCaptchaReloaded
   class Engine < ::Rails::Engine
     isolate_namespace SimpleCaptchaReloaded
@@ -5,6 +7,10 @@ module SimpleCaptchaReloaded
       if defined?(SimpleForm)
         require 'simple_captcha_reloaded/adapters/simple_form'
       end
+      ActiveSupport.on_load :action_controller do
+        helper SimpleCaptchaReloaded::ViewHelper
+        ActionController::Base.send(:include, SimpleCaptchaReloaded::ControllerHelper)
+      end
       app.middleware.use SimpleCaptchaReloaded::Middleware
     end
 

data/lib/simple_captcha_reloaded/model.rb

@@ -19,7 +19,7 @@ module SimpleCaptchaReloaded::Model
                        elsif !captcha.present?
                          errors.add :captcha, I18n.t('simple_captcha_reloaded.errors.blank')
                          false
-                       elsif data.value != captcha.downcase.strip
+                       elsif not data.valid_captcha?(captcha)
                          errors.add :captcha, I18n.t('simple_captcha_reloaded.errors.wrong')
                          false
                        else

data/lib/simple_captcha_reloaded/version.rb

@@ -1,3 +1,3 @@
 module SimpleCaptchaReloaded
-  VERSION = "0.0.1.beta1"
+  VERSION = "0.1.0.beta1"
 end

data/lib/simple_captcha_reloaded/view_helper.rb

@@ -0,0 +1,17 @@
+module SimpleCaptchaReloaded
+  module ViewHelper
+    # key: params[key] for the captcha id
+    # value: params[value] for the user-answer
+    # refresh_button: show refresh button
+    # id: wrapper id for the element, to refresh the captcha
+    def simple_captcha(key: :captcha_key, value: :captcha, refresh_button: true, id: 'simple_captcha_wrapper')
+      captcha = SimpleCaptchaReloaded.generate_captcha(id: id, request: request)
+      render 'simple_captcha_reloaded/simple_captcha_reloaded',
+        key: key,
+        value: value,
+        captcha: captcha,
+        refresh_button: refresh_button,
+        id: id
+    end
+  end
+end

data/lib/simple_captcha_reloaded.rb

@@ -5,4 +5,15 @@ require 'simple_captcha_reloaded/model'
 require 'simple_captcha_reloaded/middleware'
 
 module SimpleCaptchaReloaded
+  def self.generate_captcha(id:, request:, old_key: request.session[:captcha])
+    captcha_id = SimpleCaptchaReloaded::Data.generate_captcha_id(old_key: old_key)
+    captcha_url = SimpleCaptchaReloaded::Config.image_url(captcha_id, request)
+    refresh_url = SimpleCaptchaReloaded::Config.refresh_url(request, id)
+    {
+      captcha_id: captcha_id,
+      captcha_url: captcha_url,
+      refresh_url: refresh_url
+    }
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_captcha_reloaded
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta1
+  version: 0.1.0.beta1
 platform: ruby
 authors:
 - Stefan Wienert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -186,13 +186,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/simple_captcha_reloaded/application.js
 - app/assets/stylesheets/simple_captcha_reloaded/application.css
 - app/controllers/simple_captcha_reloaded/application_controller.rb
 - app/helpers/simple_captcha_reloaded/application_helper.rb
 - app/models/simple_captcha_reloaded/data.rb
-- app/views/layouts/simple_captcha_reloaded/application.html.erb
+- app/views/simple_captcha_reloaded/_simple_captcha_reloaded.html.erb
 - config/environment.rb
 - config/locales/simple_captcha.en.yml
 - config/routes.rb
@@ -200,11 +201,13 @@ files:
 - lib/simple_captcha_reloaded.rb
 - lib/simple_captcha_reloaded/adapters/simple_form.rb
 - lib/simple_captcha_reloaded/config.rb
+- lib/simple_captcha_reloaded/controller_helper.rb
 - lib/simple_captcha_reloaded/engine.rb
 - lib/simple_captcha_reloaded/image.rb
 - lib/simple_captcha_reloaded/middleware.rb
 - lib/simple_captcha_reloaded/model.rb
 - lib/simple_captcha_reloaded/version.rb
+- lib/simple_captcha_reloaded/view_helper.rb
 - lib/tasks/simple_captcha_reloaded_tasks.rake
 homepage: https://github.com/zealot128/simple_captcha_reloaded
 licenses:

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

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>SimpleCaptchaReloaded</title>
-  <%= stylesheet_link_tag    "simple_captcha_reloaded/application", media: "all" %>
-  <%= javascript_include_tag "simple_captcha_reloaded/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>