redis_captcha 0.8.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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.rdoc

@@ -0,0 +1,125 @@
+# RedisCaptcha
+
+RedisCaptcha is a captcha engine base on Redis for Rails 3.2. It provides simple captcha that can be read by human.
+
+
+## Features
+
+* RedisCaptcha is easy to setup, easy to use.
+* RedisCaptcha 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
+* Redis > 2.4
+* ImageMagick
+
+*I haven't tried lower version yet.*
+
+## Getting started
+
+**1. Add RedisCaptcha to your gemfile**
+
+```ruby
+gem 'redis_captcha'
+```
+
+**2. Generate initializer**
+
+    rails g redis_captcha:install
+
+It'll generate `config/initializers/redis_captcha.rb`, and you can configure all options here.
+
+**3. Mount RedisCaptcha::Engine in your router.rb**
+
+```ruby
+mount RedisCaptcha::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 RedisCaptcha::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 RedisCaptcha 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 RedisCaptcha 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.8.0**
+
+First Version
+
+
+## Author
+
+* I'm hellolucky, I come from Taiwan
+* hellolucky123@gmail.com
+* http://twitter.com/hellolucky123
+* http://blog.hellolucky.info
+
+
+## License
+
+This project rocks and uses MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'RedisCaptcha'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/controllers/redis_captcha/application_controller.rb

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

data/app/controllers/redis_captcha/captcha_controller.rb

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

data/config/routes.rb

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

data/lib/generators/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module RedisCaptcha
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Copy RedisCaptcha 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/redis_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 :)
+
+===============================================================================

data/lib/generators/templates/redis_captcha.rb

@@ -0,0 +1,73 @@
+RedisCaptcha.setup do |config|
+
+  # ==> Redis configuration
+  config.redis_config = {
+    :host => "127.0.0.1",
+    :port => 6379,
+    :db => 0
+  }
+
+  # ==> Redis scope configuration
+  config.redis_scope = "RedisCaptcha"
+
+  # ==> Redis key expired time
+  config.expired_time = 1800
+
+  # ==> Redis locked times and locked time
+  config.locked_times = 30
+  config.locked_time = 600
+
+  # ==> ImageMagick path
+  config.image_magick_path = ""
+
+  # ==> Tempfile path
+  config.tempfile_path = "/tmp"
+
+  # ==> Tempfile name
+  config.tempfile_name = "redis_captcha"
+
+  # ==> Tempfile type and content type
+  config.tempfile_type = ".png"
+  config.content_type = "image/png"
+
+  # ==> Image width and height
+  config.width = 120
+  config.height = 30
+
+  # ==> Char set
+  # You can add/remove char you want
+  config.chars = %w(2 3 4 5 6 7 9 a 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)
+
+  # ==> String length
+  # You can set the same value if you don't want it to be random length
+  config.string_length = {
+    :max => 6,
+    :min => 4
+  }
+
+  # ==> Image font color and background
+  config.font_color = "gray"
+  config.background = "white"
+
+  # ==> Lines on your captcha
+  # You can set 0, 0 if you don't want to draw any line on your captcha
+  config.line = {
+    :max => 4,
+    :min => 2
+  }
+  config.line_color = "gary"
+
+  # ==> Swirl
+  # http://www.imagemagick.org/Usage/warping/#swirl
+  config.swirl_range = {
+    :max => 20,
+    :min => -20
+  }
+
+  # ==> Case sensitive
+  config.case_sensitive = false
+
+  # ==> Error message
+  # if you want to use I18n in your model, you can set it to be nil
+  config.error_message = "is invalid"
+end

data/lib/redis_captcha.rb

@@ -0,0 +1,120 @@
+require 'redis'
+require 'redis_captcha/engine'
+require 'redis_captcha/controller'
+require 'generators/install_generator'
+
+module RedisCaptcha
+
+  autoload :Image, "redis_captcha/image"
+  autoload :KeyHandler, "redis_captcha/key_handler"
+  autoload :Model, "redis_captcha/model"
+
+  mattr_accessor :redis_config
+  @@redis_config = {
+    :host => "127.0.0.1",
+    :port => 6379,
+    :db => 0
+  }
+
+  mattr_accessor :redis_scope
+  @@redis_scope = "RedisCaptcha"
+
+  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 = "redis_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 = "gary"
+
+  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.redis
+    @@redis ||= Redis.new(redis_config)
+  end
+
+  def self.options
+    @@options ||= {
+      :redis_scope => redis_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