dalli_captcha 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,127 @@
+dalli_captcha
+=============
+
+DalliCaptcha is a captcha engine base on Dalli for Rails 3.2. It provides simple captcha that can be read by human.
+
+
+## Features
+
+* DalliCaptcha is easy to setup, easy to use.
+* DalliCaptcha provides simple captcha that can be read by human.
+* You don't have to manage image files because they will be removed by Tempfile.
+* You can set option `locked_times` and `locked_time` to avoid someone who want to attack.
+* The Captcha will be Expired automatically by setting `expired_time`.
+* ......
+
+
+## Requirements
+
+* Ruby >= 1.9
+* Rails > 3.2
+* Dalli > 2.4
+* ImageMagick
+
+*I haven't tried lower version yet.*
+
+## Getting started
+
+**1. Add DalliCaptcha to your gemfile**
+
+```ruby
+  gem 'dalli_captcha'
+or
+  gem 'dalli_captcha',:git =>"git://github.com/javyliu/dalli_captcha.git"
+```
+
+**2. Generate initializer**
+
+    rails g dalli_captcha:install
+
+It'll generate `config/initializers/dalli_captcha.rb`, and you can configure all options here.
+
+**3. Mount DalliCaptcha::Engine in your router.rb**
+
+```ruby
+mount DalliCaptcha::Engine => '/captcha', :as => :captcha
+```
+
+
+**4. Add before_filter to your controller**
+
+```ruby
+class PostsController < ApplicationController
+    before_filter :generate_captcha_key, :only => [:new, :edit]
+    ......
+end
+```
+
+**4. Add module to your model**
+
+```ruby
+class Post < ActiveRecord::Base
+    include DalliCaptcha::Model
+end
+```
+
+if you set `config.active_record.whitelist_attributes = true` in `config/application.rb`, remember to add attr_accessible to your model:
+
+```ruby
+attr_accessible :captcha, :captcha_key
+```
+
+to your model.
+
+**5. Use DalliCaptcha in your view**
+
+```erb
+<%= image_tag(captcha_path(:timestamp => Time.now.to_i), :alt => "captcha") %>
+<%= f.text_field :captcha %>
+<%= f.hidden_field :captcha_key, :value => session[:captcha_key] %>
+```
+
+**6. Use DalliCaptcha in your controller**
+
+```ruby
+    # Initialize a post
+    @post = Post.new(:title => "test")
+
+    # valid with captcha
+    @post.valid?
+
+    # save with captcha
+    @post.save
+
+    # valid without captcha
+    @post.valid_without_captcha?
+
+    # save without captcha
+    @post.save_without_captcha
+```
+
+
+Enjoy it!
+
+
+## Todo list
+
+* To add a simple site
+* To write tests
+
+
+## History
+
+**0.0.1**
+
+First Version
+
+
+## Author
+
+* javyquan@gmail.com
+* http://hi.baidu.com/javyquan
+
+
+## License
+
+This project rocks and uses MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DalliCaptcha'
+  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__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+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/app/assets/javascripts/dalli_captcha/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/dalli_captcha/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/dalli_captcha/application_controller.rb

@@ -0,0 +1,4 @@
+module DalliCaptcha
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/dalli_captcha/captcha_controller.rb

@@ -0,0 +1,13 @@
+module DalliCaptcha
+  class CaptchaController < ApplicationController
+    def show
+      captcha = DalliCaptcha::Image.new(session[:captcha_key])
+      tempfile = captcha.generate
+      if tempfile
+        send_file(tempfile.path, :type => captcha.content_type, :disposition => 'inline', :filename => captcha.filename)
+      else
+        render :nothing => true
+      end
+    end
+  end
+end

data/app/helpers/dalli_captcha/application_helper.rb

@@ -0,0 +1,4 @@
+module DalliCaptcha
+  module ApplicationHelper
+  end
+end

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

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

data/config/routes.rb

@@ -0,0 +1,3 @@
+DalliCaptcha::Engine.routes.draw do
+  root :to => 'captcha#show'
+end

data/lib/dalli_captcha/controller.rb

@@ -0,0 +1,14 @@
+require 'uuid'
+
+module DalliCaptcha
+  module Controller
+    def generate_captcha_key
+      if session[:captcha_key].blank?
+        uuid = UUID.new
+        session[:captcha_key] = uuid.generate.gsub("-", "").hex
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, DalliCaptcha::Controller

data/lib/dalli_captcha/engine.rb

@@ -0,0 +1,5 @@
+module DalliCaptcha
+  class Engine < ::Rails::Engine
+    isolate_namespace DalliCaptcha
+  end
+end

data/lib/dalli_captcha/image.rb

@@ -0,0 +1,94 @@
+module DalliCaptcha
+  class Image
+    #user the session[:captcha_key] to set the memcache key
+    def initialize(captcha_key)
+      @key_handler = DalliCaptcha::KeyHandler.new(captcha_key)
+      @options = DalliCaptcha.options
+    end
+
+    def generate
+      #unless @key_handler.locked?
+        @string = get_string
+        @key_handler.set(@string)
+
+        tempfile = Tempfile.new([@options[:tempfile_name], @options[:tempfile_type]], @options[:tempfile_path])
+
+        params = ""
+        params << get_line_param
+        params << get_image_size_param
+        params << get_background_param
+        params << get_string_param
+        params << get_swirl_param
+
+        command = `#{@options[:image_magick_path]}convert #{params} #{tempfile.path}`
+        puts "#{@options[:image_magick_path]}convert #{params} #{tempfile.path}"
+
+        tempfile
+      #else
+        #nil
+      #end
+    end
+
+    def filename
+      "#{@options[:tempfile_name]}#{@options[:tempfile_type]}"
+    end
+
+    def content_type
+      @options[:content_type]
+    end
+
+    protected
+
+    def get_string
+      chars = @options[:chars]
+      max = @options[:string_length][:max]
+      min = @options[:string_length][:min]
+      range = max - min
+      length = ((range > 0) ? rand(range + 1) : 0) + min
+
+      string = ""
+      length.times { string << chars[rand(chars.length)] }
+
+      string
+    end
+
+    def get_line_param
+      max = @options[:line][:max]
+      min = @options[:line][:min]
+      range = max - min
+      amount = ((range > 0) ? rand(range + 1) : 0) + min
+
+      params = ""
+
+      amount.times do
+        params << "-fill #{@options[:line_color]} "
+        params << "-draw \"line #{rand(10)},#{rand(@options[:height])} #{rand(10) + @options[:width] - 10},#{rand(@options[:height])}\" "
+      end
+
+      params
+    end
+
+    def get_image_size_param
+      "-size #{@options[:width]}X#{@options[:height]} "
+    end
+
+    def get_background_param
+      "-background #{@options[:background]} "
+    end
+
+    def get_string_param
+      "-gravity center -fill #{@options[:font_color]} label:\"#{@string}\" "
+    end
+
+    def get_swirl_param
+      max = @options[:swirl_range][:max]
+      min = @options[:swirl_range][:min]
+
+      "-swirl #{(min..max).to_a.sample} "
+    end
+
+    def get_charcoal
+      rand(3)
+    end
+  end
+end

data/lib/dalli_captcha/key_handler.rb

@@ -0,0 +1,41 @@
+module DalliCaptcha
+  class KeyHandler
+    def initialize(captcha_key)
+      @dalli = DalliCaptcha.dalli
+      @captcha_key = captcha_key
+      @options = DalliCaptcha.options
+
+      @string_key = "#{@options[:dalli_scope]}:#{@captcha_key}:string"
+      @locked_times_key = "#{@options[:dalli_scope]}:#{@captcha_key}:locked_times"
+    end
+
+    #set string in memcache
+    def set(string)
+      string = @options[:case_sensitive] ? string : string.downcase
+      @dalli.set(@string_key,string,@options[:expired_time])
+
+      #locked_times = @dalli.get(@locked_times_key).to_i
+      #@dalli.incrby(@locked_times_key, 1)
+      #@dalli.expire(@locked_times_key, @options[:locked_time]) if locked_times == 0
+    end
+
+    def delete
+      @dalli.delete(@string_key)
+      #@dalli.del(@locked_times_key)
+    end
+
+    def locked?
+      locked_times = @dalli.get(@locked_times_key).to_i
+      @captcha_key.blank? || (locked_times >= @options[:locked_times])
+    end
+
+    def valid?(captcha)
+      string = @dalli.get(@string_key)
+      if captcha.blank? || string.blank?
+        return false
+      else
+        string == (@options[:case_sensitive] ? captcha : captcha.downcase)
+      end
+    end
+  end
+end

data/lib/dalli_captcha/model.rb

@@ -0,0 +1,45 @@
+module DalliCaptcha
+  module Model
+    extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send :validate, :check_captcha
+      base.send :after_save, :delete_captcha
+      base.send :attr_accessor, :captcha, :captcha_key
+    end
+
+    module ClassMethods
+    end
+
+    def key_handler
+      @key_handler ||= DalliCaptcha::KeyHandler.new(captcha_key)
+    end
+
+    def check_captcha
+      if without_captcha?
+        @skip_captcha = false
+      else
+        errors.add(:captcha, DalliCaptcha::options[:error_message]) unless key_handler.valid?(captcha)
+      end
+    end
+
+    def delete_captcha
+      key_handler.delete
+    end
+
+    def without_captcha?
+      !!@skip_captcha
+    end
+
+    def valid_without_captcha?
+      @skip_captcha = true
+      self.valid?
+    end
+
+    def save_without_captcha
+      @skip_captcha = true
+      self.save
+    end
+  end
+end

data/lib/dalli_captcha/version.rb

@@ -0,0 +1,3 @@
+module DalliCaptcha
+  VERSION = "0.0.1"
+end

data/lib/dalli_captcha.rb

@@ -0,0 +1,120 @@
+require 'dalli'
+require "dalli_captcha/engine"
+require 'dalli_captcha/controller'
+require 'generators/install_generator'
+
+module DalliCaptcha
+
+  autoload :Image, "dalli_captcha/image"
+  autoload :KeyHandler, "dalli_captcha/key_handler"
+  autoload :Model, "dalli_captcha/model"
+
+  mattr_accessor :dalli_config
+  @@dalli_config = {
+    :host => "localhost:11211",
+    :compress => true,
+    :namespace => "captcha"
+  }
+
+  mattr_accessor :dalli_scope
+  @@dalli_scope = "DalliCaptcha"
+
+  mattr_accessor :expired_time
+  @@expired_time = 1800
+
+  mattr_accessor :locked_times
+  @@locked_times = 30
+
+  mattr_accessor :locked_time
+  @@locked_time = 600
+
+  mattr_accessor :image_magick_path
+  @@image_magick_path = ""
+
+  mattr_accessor :tempfile_path
+  @@tempfile_path = "/tmp"
+
+  mattr_accessor :tempfile_name
+  @@tempfile_name = "dalli_captcha"
+
+  mattr_accessor :tempfile_type
+  @@tempfile_type = ".png"
+
+  mattr_accessor :content_type
+  @@content_type = "image/png"
+
+  mattr_accessor :width
+  @@width = 120
+
+  mattr_accessor :height
+  @@height = 30
+
+  mattr_accessor :chars
+  @@chars = %w(2 3 4 5 6 7 9 a b c d e f g h j k m n p q r s t w x y z A C D E F G H J K L M N P Q R S T X Y Z)
+
+  mattr_accessor :string_length
+  @@string_length = {
+    :max => 6,
+    :min => 4
+  }
+
+  mattr_accessor :font_color
+  @@font_color = "gray"
+
+  mattr_accessor :background
+  @@background = "white"
+
+  mattr_accessor :line
+  @@line = {
+    :max => 4,
+    :min => 2
+  }
+
+  mattr_accessor :line_color
+  @@line_color = "gray"
+
+  mattr_accessor :swirl_range
+  @@swirl_range = {
+    :max => 20,
+    :min => -20
+  }
+
+  mattr_accessor :case_sensitive
+  @@case_sensitive = false
+
+  mattr_accessor :error_message
+  @@error_message = "is invalid"
+
+  def self.setup
+    yield self
+  end
+
+  def self.dalli
+    @@dalli ||= Dalli::Client.new(dalli_config.delete(:host),dalli_config)
+  end
+
+  def self.options
+    @@options ||= {
+      :dalli_scope => dalli_scope,
+      :expired_time => expired_time,
+      :locked_times => locked_times,
+      :locked_time => locked_time,
+      :image_magick_path => image_magick_path,
+      :tempfile_path => tempfile_path,
+      :tempfile_name => tempfile_name,
+      :tempfile_type => tempfile_type,
+      :content_type => content_type,
+      :width => width,
+      :height => height,
+      :chars => chars,
+      :string_length => string_length,
+      :font_color => font_color,
+      :background => background,
+      :line => line,
+      :line_color => line_color,
+      :swirl_range => swirl_range,
+      :case_sensitive => case_sensitive,
+      :error_message => error_message
+    }
+  end
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,21 @@
+
+require 'rails/generators'
+
+module DalliCaptcha
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Copy DalliCaptcha default files"
+
+      def copy_initializer
+        copy_file "redis_captcha.rb", "config/initializers/redis_captcha.rb"
+      end
+
+      def show_readme
+          readme "README"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,29 @@
+===============================================================================
+
+1. Setup "config/initializers/dalli_captcha.rb"
+
+2. Mount RedisCaptcha::Engine in your router.rb
+
+   mount RedisCaptcha::Engine => '/captcha', :as => :captcha
+
+3. Add to your controller
+
+   before_filter :generate_captcha_key
+
+4. Add to your model
+
+   include RedisCaptcha::Model
+
+5. If you set "config.active_record.whitelist_attributes = true" in "config/application.rb", remember to add attr_accessible to your model
+
+   attr_accessible :captcha, :captcha_key
+
+6. Add to your view
+
+<%= image_tag(captcha_path(:timestamp => Time.now.to_i), :alt => "captcha") %>
+<%= f.text_field :captcha %>
+<%= f.hidden_field :captcha_key, :value => session[:captcha_key] %>
+
+Enjoy it :)
+
+===============================================================================