yl_simple_captcha 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49d4020265cd517eb6871543f8442c70ab14048f
+  data.tar.gz: ded8246373674be7d0a11b97886ed012f5696e12
+SHA512:
+  metadata.gz: fdd8fc68c5925d709f2fb898d00e66ea79cef8da1a197bbe3b5b74e380ac655fb763d8f089769f68e1a408d8bc2f16355cdd381af54f3e42c1190d3eb646748f
+  data.tar.gz: edeec1675ece371acf2f6c231e22361bb295928a2edadf7bd30fe50830ef116b0b764aea6e3f29580890fb41062753d5f01285f046feeb39e5d121182bda4f59

data/README.md

@@ -0,0 +1,335 @@
+#SimpleCaptcha2
+
+[![Build Status](https://travis-ci.org/pludoni/simple-captcha.png?branch=master)](https://travis-ci.org/pludoni/simple-captcha)
+[![Gem Version](https://badge.fury.io/rb/simple_captcha2.svg)](https://badge.fury.io/rb/simple_captcha2)
+
+SimpleCaptcha(2) is the simplest and a robust captcha plugin. Its implementation requires adding up a single line in views and in controllers/models.
+SimpleCaptcha2 is available to be used with Rails 3 + 4.
+This is a fork of the popular Rubygem ``simple_captcha`` which got abandoned.
+
+##Features
+
+* Zero FileSystem usage (secret code moved to db-store and image storage removed).
+* Provides various image styles.
+* Provides three level of complexity of images.
+* Works absolutely fine in distributed environment(session and db based implementation works fine in distributed environment).
+* Implementation is as easy as just writing a single line in your view. ```<%= show_simple_captcha %>``` within the 'form' tags.
+* Flexible DOM and CSS handling(There is a separate view partial for rendering SimpleCaptcha DOM elements).
+* Automated removal of 1 hour old unmatched simple_captcha data.
+
+##Requirements
+
+* Ruby >= 1.9.3
+* Rails >= 3.2
+* ImageMagick should be installed on your machine to use this plugin.
+  visit http://www.imagemagick.org/script/index.php for more details.
+
+You might need to install Ghostscript on a Mac-System:
+
+```
+brew install ghostscript
+```
+
+##Installation
+
+Put this into your Gemfile
+
+```ruby
+gem 'yl_simple_captcha', require: 'simple_captcha', :git => 'git://github.com/jiawenliang/simple-captcha.git'
+```
+
+and run ``bundle install``.
+
+## Setup
+
+After installation, follow these simple steps to setup the plugin. The setup will depend on the version of rails your application is using.
+
+```bash
+rails generate simple_captcha [template_format] # Available options erb, haml. Default: erb 
+rake db:migrate # Mongoid: skip this step and remove the migration
+```
+
+## Usage
+
+There are two usage scenarios:
+
+### Controller Based
+
+Add the following line in the file "app/controllers/application.rb"
+
+```ruby
+ApplicationController < ActionController::Base
+  include SimpleCaptcha::ControllerHelpers
+end
+```
+
+In the view file within the form tags add this code
+
+```erb
+<%= show_simple_captcha %>
+```
+
+and in the controller's action authenticate it as
+
+```ruby
+if simple_captcha_valid?
+  do this
+else
+  do that
+end
+```
+
+### Model Based
+
+This is suggested, if you want to integrate the error message into the normal form validation flow.
+
+In the view file within the form tags write this code
+
+```erb
+<%= show_simple_captcha(:object=>"user") %>
+```
+
+and in the model class add this code
+
+```ruby
+class User < ActiveRecord::Base
+  apply_simple_captcha
+end
+```
+
+Mongoid:
+
+```ruby
+class User
+  include SimpleCaptcha::ModelHelpers
+  apply_simple_captcha
+end
+```
+
+#### Strong parameters (Rails 4.x)
+
+Must add them:
+
+```ruby
+:captcha, :captcha_key
+```
+
+####Form-Builder helper
+
+```erb
+<%= form_for @user do |form| -%>
+  ...
+  <%= form.simple_captcha :label => "Enter numbers.." %>
+  ...
+<% end -%>
+```
+
+####Validating with captcha
+
+NOTE: @user.valid? will still work as it should, it will not validate the captcha code.
+
+```ruby
+@user.valid_with_captcha?
+```
+
+####Saving with captcha
+
+NOTE: @user.save will still work as it should, it will not validate the captcha code.
+
+```ruby
+@user.save_with_captcha
+```
+
+###Formtastic integration
+
+SimpleCaptcha detects if you are using Formtastic:
+
+```erb
+<%= form.input :captcha, :as => :simple_captcha %>
+```
+
+### Tests
+
+You can make the Captcha always pass with a initializer file: config/initializers/simple_captcha.rb
+
+```ruby
+SimpleCaptcha.always_pass = Rails.env.test?
+```
+
+You can also ask for the value, e.g. Acceptance Tests/Features:
+
+```ruby
+visit '/pages/form_tag'
+assert_equal 1, SimpleCaptcha::SimpleCaptchaData.count
+fill_in 'captcha', with: SimpleCaptcha::SimpleCaptchaData.first.value
+```
+
+##Options & Examples
+
+###View Options
+
+* ``:label`` - provides the custom text b/w the image and the text field, the default is "type the code from the image"
+* ``:object`` - the name of the object of the model class, to implement the model based captcha.
+* ``:code_type`` - return numeric only if set to 'numeric'
+* ``:multiple`` - allow to use the same captcha in multiple forms in one page. True for the first appaerance and false for the rest.
+
+###Global options
+
+* ``:image_style`` - provides the specific image style for the captcha image.
+There are eight different styles available with the plugin as...
+
+1. simply_blue
+2. simply_red
+3. simply_green
+4. charcoal_grey
+5. embosed_silver
+6. all_black
+7. distorted_black
+8. almost_invisible
+
+Default style is 'simply_blue'.
+You can also specify 'random' to select the random image style.
+
+* ``:distortion`` - handles the complexity of the image. The :distortion can be set to 'low', 'medium' or 'high'. Default is 'low'.
+
+* ``:implode`` - handles the complexity of the image. The :implode can be set to 'none', 'low', 'medium' or 'high'. Default is 'medium'.
+
+Create "./config/initializers/simple_captcha.rb"
+
+```ruby
+SimpleCaptcha.setup do |sc|
+  # default: 100x28
+  sc.image_size = '120x40'
+
+  # default: 5
+  sc.length = 6
+  
+  # when the table name is changed,should defined it.defalut: simple_captcha_data.
+  sc.table_name = "simple_captcha_data"
+
+  # default: simply_blue
+  # possible values:
+  # 'embosed_silver',
+  # 'simply_red',
+  # 'simply_green',
+  # 'simply_blue',
+  # 'distorted_black',
+  # 'all_black',
+  # 'charcoal_grey',
+  # 'almost_invisible'
+  # 'random'
+  sc.image_style = 'simply_green'
+
+  # default: low
+  # possible values: 'low', 'medium', 'high', 'random'
+  sc.distortion = 'medium'
+
+  # default: medium
+  # possible values: 'none', 'low', 'medium', 'high'
+  sc.implode = 'low'
+end
+```
+
+You can add your own style:
+
+```ruby
+SimpleCaptcha.setup do |sc|
+  sc.image_style = 'mycaptha'
+  sc.add_image_style('mycaptha', [
+      "-background '#F4F7F8'",
+      "-fill '#86818B'",
+      "-border 1",
+      "-bordercolor '#E0E2E3'"])
+end
+```
+
+You can provide the path where image_magick is installed as well:
+
+```ruby
+SimpleCaptcha.setup do |sc|
+  sc.image_magick_path = '/usr/bin' # you can check this from console by running: which convert
+end
+```
+
+
+### How to change the CSS for SimpleCaptcha DOM elements?
+
+You can change the CSS of the SimpleCaptcha DOM elements as per your need in this file.
+
+``app/views/simple_captcha/_simple_captcha.erb``
+
+###View's Examples
+####Controller Based Example
+
+```erb
+<%= show_simple_captcha %>
+
+<%= show_simple_captcha(:label => "human authentication") %>
+```
+
+####Model Based Example
+
+```erb
+<%= show_simple_captcha(:object => 'user', :label => "human authentication") %>
+```
+
+####Model Options
+
+* ``:message`` - provides the custom message on failure of captcha authentication the default is "Secret Code did not match with the Image"
+
+* ``:add_to_base`` - if set to true, appends the error message to the base.
+
+#####Model's Example
+
+```ruby
+class User < ActiveRecord::Base
+  apply_simple_captcha
+end
+
+class User < ActiveRecord::Base
+  apply_simple_captcha :message => "The secret Image and code were different", :add_to_base => true
+end
+```
+
+
+##I18n
+
+```yaml
+en:
+  simple_captcha:
+    placeholder: "Enter the image value"
+    label: "Enter the code in the box:"
+    refresh_button_text: "Refresh"
+    message:
+      default: "Secret Code did not match with the Image"
+      user: "The secret Image and code were different"
+```
+
+##Contributing
+
+For testing, generate a temporary Rails dummy app inside test:
+
+```bash
+rake dummy:setup
+rake app:db:migrate
+rake app:db:migrate RAILS_ENV=test
+export BUNDLE_GEMFILE=$PWD/Gemfile
+cd test/dummy && rake db:migrate db:test:prepare
+rake test
+```
+
+Please add test cases when adding new functionality. I started with some basic example integration tests for a very basic coverage.
+
+The tests will be run on [Travis-CI](https://travis-ci.org/pludoni/simple-captcha).
+
+##Who's who?
+
+Enjoy the simplest captcha implementation.
+
+Original Author of the Version for Rails 2:
+Author: Sur, Blog: http://expressica.com, Contact: sur.max@gmail.com
+Plugin Homepage: http://expressica.com/simple_captcha
+
+Plugin update for rails 3: http://github.com/galetahub
+
+update for Rails 4, tests and forked by Stefan Wienert (pludoni GmbH)

data/Rakefile

@@ -0,0 +1,63 @@
+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    = 'SimpleCaptcha'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+if File.exists? APP_RAKEFILE
+  load 'rails/tasks/engine.rake'
+end
+
+namespace :dummy do
+  desc 'Setup dummy Rails app for test purpose'
+  task :setup do
+    require 'rails'
+    require 'simple_captcha'
+    require File.expand_path('../test/lib/generators/simple_captcha/dummy/dummy_generator', __FILE__)
+    SimpleCaptcha::DummyGenerator.start %w(--quiet)
+  end
+
+  desc 'destroy dummy Rails app under test/dummy'
+  task :destroy do
+    FileUtils.rm_rf "test/dummy" if File.exists?("test/dummy")
+  end
+
+  desc 'redo'
+  task :redo do
+    sh 'rake dummy:destroy'
+    sh 'rake dummy:setup'
+    sh 'rake app:db:migrate'
+    sh 'rake app:db:migrate RAILS_ENV=test'
+  end
+
+
+end
+
+
+
+
+Bundler::GemHelper.install_tasks :name => 'simple_captcha2'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test
+

data/lib/generators/USAGE

@@ -0,0 +1,7 @@
+SimpleCaptcha
+=============
+# Generate migration and copy view partial
+  rails generate simple_captcha [template_format]
+  template_format               Sets template format to be generated
+                                Available options: erb, haml
+                                Default: erb

data/lib/generators/simple_captcha_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+
+class SimpleCaptchaGenerator < Rails::Generators::Base
+  argument :template_format, :type => :string, :default => 'erb'
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates/'))
+  end
+
+  def self.next_migration_number(dirname)
+    Time.now.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_partial
+    template "partial.#{template_format}", File.join('app/views', 'simple_captcha', "_simple_captcha.#{template_format}")
+  end
+
+  def create_captcha_migration
+    migration_template "migration.rb", File.join('db/migrate', "create_simple_captcha_data.rb")
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateSimpleCaptchaData < ActiveRecord::Migration
+  def self.up
+    create_table :simple_captcha_data do |t|
+      t.string :key, :limit => 40
+      t.string :value, :limit => 6
+      t.timestamps
+    end
+    
+    add_index :simple_captcha_data, :key, :name => "idx_key"
+  end
+
+  def self.down
+    drop_table :simple_captcha_data
+  end
+end

data/lib/generators/templates/partial.erb

@@ -0,0 +1,41 @@
+<style type="text/css">
+  .simple_captcha{border: 1px solid #ccc; padding: 5px !important;}
+  .simple_captcha,
+  .simple_captcha div{display: table;}
+  .simple_captcha .simple_captcha_field,
+  .simple_captcha .simple_captcha_image{
+    border: 1px solid #ccc;
+    margin: 0px 0px 2px 0px !important;
+    padding: 0px !important;
+  }
+  .simple_captcha .simple_captcha_image img{
+    margin: 0px !important;
+    padding: 0px !important;
+    width: 110px !important;
+  }
+  .simple_captcha .simple_captcha_label{font-size: 12px;}
+  .simple_captcha .simple_captcha_field input{
+    width: 150px !important;
+    font-size: 16px;
+    border: none;
+    background-color: #efefef;
+  }
+</style>
+
+<div class='simple_captcha'>
+  <div class='simple_captcha_image'>
+    <%%= simple_captcha_options[:image] %>
+  </div>
+
+  <div class='simple_captcha_field'>
+    <%%= simple_captcha_options[:field] %>
+  </div>
+
+  <div class='simple_captcha_label'>
+    <%%= simple_captcha_options[:label] %>
+  </div>
+
+  <div class='simple_captcha_refresh_button'>
+    <%%= simple_captcha_options[:refresh_button] %>
+  </div>
+</div>

data/lib/generators/templates/partial.haml

@@ -0,0 +1,28 @@
+:css
+  .simple_captcha{border: 1px solid #ccc; padding: 5px !important;}
+  .simple_captcha,
+  .simple_captcha div{display: table;}
+  .simple_captcha .simple_captcha_field,
+  .simple_captcha .simple_captcha_image{
+    border: 1px solid #ccc;
+    margin: 0px 0px 2px 0px !important;
+    padding: 0px !important;
+  }
+  .simple_captcha .simple_captcha_image img{
+    margin: 0px !important;
+    padding: 0px !important;
+    width: 110px !important;
+  }
+  .simple_captcha .simple_captcha_label{font-size: 12px;}
+  .simple_captcha .simple_captcha_field input{
+    width: 150px !important;
+    font-size: 16px;
+    border: none;
+    background-color: #efefef;
+  }
+
+.simple_captcha
+  .simple_captcha_image= simple_captcha_options[:image]
+  .simple_captcha_field= simple_captcha_options[:field]
+  .simple_captcha_label= simple_captcha_options[:label]
+  .simple_captcha_refresh_button= simple_captcha_options[:refresh_button]

data/lib/simple_captcha/controller.rb

@@ -0,0 +1,32 @@
+module SimpleCaptcha #:nodoc
+  module ControllerHelpers #:nodoc
+    # This method is to validate the simple captcha in controller.
+    # It means when the captcha is controller based i.e. :object has not been passed to the method show_simple_captcha.
+    #
+    # *Example*
+    #
+    # If you want to save an object say @user only if the captcha is validated then do like this in action...
+    #
+    #  if simple_captcha_valid?
+    #   @user.save
+    #  else
+    #   flash[:notice] = "captcha did not match"
+    #   redirect_to :action => "myaction"
+    #  end
+    def simple_captcha_valid?
+      return true if SimpleCaptcha.always_pass
+      return @_simple_captcha_result unless @_simple_captcha_result.nil?
+
+      if params[:captcha]
+        captcha_key = params[:captcha_key] || session[:captcha]
+        data = SimpleCaptcha::Utils::simple_captcha_value(captcha_key)
+        result = data == params[:captcha].delete(" ").upcase
+        SimpleCaptcha::Utils::simple_captcha_passed!(captcha_key) if result
+        @_simple_captcha_result = result
+        result
+      else
+        false
+      end
+    end
+  end
+end

data/lib/simple_captcha/engine.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'rails'
+require 'simple_captcha'
+
+module SimpleCaptcha
+  class Engine < ::Rails::Engine
+    config.before_initialize do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, SimpleCaptcha::ModelHelpers)
+      end
+    end
+
+    config.after_initialize do
+      ActionView::Base.send(:include, SimpleCaptcha::ViewHelper)
+      ActionView::Helpers::FormBuilder.send(:include, SimpleCaptcha::FormBuilder)
+
+      if Object.const_defined?("Formtastic")
+        require 'simple_captcha/formtastic'
+      end
+    end
+
+    config.app_middleware.use SimpleCaptcha::Middleware
+  end
+end
+
+

data/lib/simple_captcha/form_builder.rb

@@ -0,0 +1,43 @@
+module SimpleCaptcha
+  module FormBuilder
+    def self.included(base)
+      base.send(:include, SimpleCaptcha::ViewHelper)
+      base.send(:include, SimpleCaptcha::FormBuilder::ClassMethods)
+      base.send(:include, ActionView::Helpers)
+      if defined? Sprockets::Helpers
+        base.send(:include, Sprockets::Helpers::RailsHelper)
+        base.send(:include, Sprockets::Helpers::IsolatedHelper)
+      end
+
+      base.delegate :render, :session, :to => :template
+    end
+
+    module ClassMethods
+      # Example:
+      # <% form_for :post, :url => posts_path do |form| %>
+      #   ...
+      #   <%= form.simple_captcha :label => "Enter numbers.." %>
+      # <% end %>
+      #
+      def simple_captcha(options = {})
+        options.update :object => @object_name
+        show_simple_captcha(objectify_options(options))
+      end
+
+      private
+
+        def template
+          @template
+        end
+
+        def simple_captcha_field(options={})
+          html = {:autocomplete => 'off', :autocorrect => 'off', :autocapitalize => 'off', :required => 'required', :value => ''}
+          html.merge!(options[:input_html] || {})
+          html[:placeholder] = options[:placeholder] || I18n.t('simple_captcha.placeholder')
+
+          text_field(:captcha, html) +
+          hidden_field(:captcha_key, {:value => options[:field_value], :id => simple_captch_hidden_field_id(options)})
+        end
+    end
+  end
+end

data/lib/simple_captcha/formtastic.rb

@@ -0,0 +1,15 @@
+if defined? Formtastic
+  require 'formtastic/version'
+  if Formtastic::VERSION < '2.2'
+    raise 'Only Formtastic Version 2.2 or greater is supported by SimpleCaptcha'
+  end
+
+  class SimpleCaptchaInput
+    include Formtastic::Inputs::Base
+    def to_html
+      options.update :object => sanitized_object_name
+      builder.send(:show_simple_captcha, options)
+    end
+  end
+
+end