captcha 1.2.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Winton Welsh
+
+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.markdown

@@ -0,0 +1,89 @@
+captcha
+=======
+
+A Google-style captcha for enterprise Rails apps
+
+Goals
+-----
+
+* Batch generate captchas
+* Use ciphered filenames (no need to store filename/captcha pairs)
+* Easy configuration
+  * Number of captchas
+  * Period for captcha refresh
+  * Colors, wave, implode
+* Handle lots of users
+
+Install
+-------
+
+	script/plugin install git://github.com/winton/captcha.git
+
+### Create lib/captcha_config.rb (optional)
+
+<pre>
+Captcha::Config.new(
+  # Used for filename cipher
+  :password => 'something-unique',
+  # Captcha colors
+  :colors => {
+    :background => '#FFFFFF',
+    :font => '#080288'
+  },
+  # Number of captcha images to generate
+  :count => RAILS_ENV == 'production' ? 500 : 10,
+  # Where to write captchas
+  :destination => "#{RAILS_ROOT}/public/images/captchas",
+  # Generate new batch every day
+  :generate_every => 24 * 60 * 60
+)
+</pre>
+
+See <code>lib/captcha/config.rb</code> for more options.
+
+### application_controller.rb
+
+<pre>
+class ApplicationController < ActionController::Base
+  acts_as_captcha
+end
+</pre>
+
+You may now use the <code>reset_captcha</code> method in any controller.
+
+### user.rb
+
+<pre>
+class User < ActiveRecord::Base
+  acts_as_captcha :base => "base error when captcha fails", :field => "field error when captcha fails"
+end
+</pre>
+
+With no parameters, a default error is added to the "captcha" field (<code>:field => true</code>).
+
+Specify <code>:base => true</code> to use a default error for base.
+
+### In your view
+
+<pre>
+&lt;img src="/images/captchas/<%= session[:captcha] %>.jpg" /&gt;
+<%= text_field_tag(:captcha) %>
+</pre>
+
+### In your controller
+
+<pre>
+user = User.new
+user.known_captcha = session[:captcha]
+user.captcha = params[:captcha]
+user.save
+reset_captcha
+</pre>
+
+### crontab
+
+<pre>
+0 0 * * * cd /path/to/rails/app && /usr/bin/rake RAILS_ENV=production captcha:generate
+</pre>
+
+Your config file sets the captcha refresh period. The rake task just checks if its time to repopulate, and does so if necessary.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'gemspec'
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+desc "Package gem"
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.rcov = true
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/gemspec.rb

@@ -0,0 +1,21 @@
+GEM_NAME = 'captcha'
+GEM_FILES = FileList['**/*'] - FileList[
+  'coverage', 'coverage/**/*',
+  'pkg', 'pkg/**/*'
+]
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.summary = "A Google-style captcha for enterprise Rails apps"
+  # == CONFIGURE ==
+  s.add_dependency('rmagick', '>=2.9.2')
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "1.2.1"
+end

data/init.rb

@@ -0,0 +1,7 @@
+require 'captcha'
+if defined?(RAILS_ROOT) && File.exists?("#{RAILS_ROOT}/lib/captcha_config.rb")
+  require "#{RAILS_ROOT}/lib/captcha_config"
+end
+
+ActionController::Base.send :include, Captcha::Action
+ActiveRecord::Base.send :include, Captcha::Model

data/lib/captcha.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + "/captcha/action.rb"
+require File.dirname(__FILE__) + "/captcha/image.rb"
+require File.dirname(__FILE__) + "/captcha/config.rb"
+require File.dirname(__FILE__) + "/captcha/cipher.rb"
+require File.dirname(__FILE__) + "/captcha/generator.rb"

data/lib/captcha/action.rb

@@ -0,0 +1,34 @@
+module Captcha
+  module Action
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_captcha
+        unless included_modules.include? InstanceMethods
+          include InstanceMethods 
+        end
+        before_filter :assign_captcha
+      end
+    end
+
+    module InstanceMethods
+      private
+      
+      def assign_captcha
+        unless session[:captcha] && Captcha::Config.exists?(session[:captcha])
+          files = Captcha::Config.captchas
+          session[:captcha] = File.basename(files[rand(files.length)], '.jpg')
+        end
+      end
+      
+      def reset_captcha
+        session[:captcha] = nil
+        assign_captcha
+      end
+    end
+  
+  end
+end

data/lib/captcha/cipher.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+require 'digest/sha1'
+
+module Captcha
+  class Cipher
+    @@key = Digest::SHA1.hexdigest(Config.options[:password])
+    @@iv = 'captchas'*2
+    
+    def self.encrypt(text)
+      # Encrypt
+      cipher = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+      cipher.encrypt
+      cipher.key = @@key
+      cipher.iv = @@iv
+      encrypted = cipher.update(text)
+      encrypted << cipher.final
+      # Turn into chr codes separated by underscores
+      # 135_14_163_53_43_135_172_31_1_23_169_81_49_110_49_230
+      encrypted = (0..encrypted.length-1).collect do |x|
+        encrypted[x]
+      end
+      encrypted.join('_')
+    end
+    
+    def self.decrypt(text)
+      # Decode chr coded string
+      encrypted = text.split('_').collect do |x|
+        x.to_i.chr
+      end
+      encrypted = encrypted.join('')
+      # Decrypt
+      cipher = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+      cipher.decrypt
+      cipher.key = @@key
+      cipher.iv = @@iv
+      decrypted = cipher.update(encrypted)
+      decrypted << cipher.final
+    end
+  end
+end

data/lib/captcha/config.rb

@@ -0,0 +1,83 @@
+module Captcha
+  class Config
+    
+    if defined?(RAILS_ENV)
+      PRODUCTION = RAILS_ENV == 'production' || RAILS_ENV == 'staging'
+      ROOT = "#{RAILS_ROOT}/"
+    else
+      PRODUCTION = false
+      ROOT = ""
+    end
+    ONE_DAY = 24 * 60 * 60
+    
+    @@options = {
+      :password => 'captcha',
+      :colors => {
+        :background => '#FFFFFF',
+        :font => '#080288'
+      },
+      # number of captcha images to generate
+      :count => PRODUCTION ? 500 : 10,
+      :destination => "#{ROOT}public/images/captchas",
+      :dimensions => {
+        # canvas height (px)
+        :height => 32,
+        # canvas width (px)
+        :width => 110
+      },
+      :generate_every => PRODUCTION ? ONE_DAY * 1 : ONE_DAY * 10000,
+      # http://www.imagemagick.org/RMagick/doc/image2.html#implode
+      :implode => 0.2,
+      :letters => {
+        # text baseline (px)
+        :baseline => 25,
+        # number of letters in captcha
+        :count => 6,
+        :ignore => ['a','e','i','o','u','l','j','q','v'],
+        # font size (pts)
+        :points => 38,
+        # width of a character (used to decrease or increase space between characters) (px)
+        :width => 17
+      },
+      :ttf => File.expand_path("#{File.dirname(__FILE__)}/../../resources/captcha.ttf"),
+      # http://www.imagemagick.org/RMagick/doc/image3.html#wave
+      :wave => {
+        # range is used for randomness (px)
+        :wavelength => (40..70),
+        # distance between peak and valley of sin wave (px)
+        :amplitude => 3
+      }
+    }
+    
+    def initialize(options={})
+      @@options.merge!(options)
+    end
+    
+    def self.captchas
+      Dir["#{@@options[:destination]}/*.jpg"]
+    end
+    
+    def self.codes
+      self.captchas.collect do |f|
+        File.basename f, '.jpg'
+      end
+    end
+    
+    def self.exists?(code)
+      File.exists?("#{@@options[:destination]}/#{code}.jpg")
+    end
+  
+    def self.options
+      @@options
+    end
+  
+    def self.last_modified
+      file = self.captchas.first
+      if file && File.exists?(file)
+        File.mtime(file)
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/captcha/generator.rb

@@ -0,0 +1,26 @@
+module Captcha
+  class Generator
+    def initialize
+      generate
+    end
+  
+    def generate
+      return unless Config.options
+      return if Config.last_modified && Config.last_modified > Time.now - Config.options[:generate_every]
+      path = Config.options[:destination]
+      Config.captchas.each do |captcha|
+        FileUtils.rm_f captcha
+      end
+      FileUtils.mkdir_p path
+      (1..Config.options[:count]).each do |x|
+        image = Image.new Config.options
+        path = "#{Config.options[:destination]}/#{Cipher.encrypt(image.code)}.jpg"
+        next if File.exists?(path)
+        File.open(path, 'w') do |f|
+          f << image.data
+        end
+      end
+      GC.start
+    end
+  end
+end

data/lib/captcha/image.rb

@@ -0,0 +1,47 @@
+require 'RMagick'
+
+module Captcha
+  class Image
+
+    include Magick
+    attr_reader :code, :data
+
+    def initialize(o)
+      generate_code o
+    
+      canvas = Magick::Image.new(o[:dimensions][:width], o[:dimensions][:height]) {
+        self.background_color = o[:colors][:background]
+      }
+  
+      text = Magick::Draw.new
+      text.font = File.expand_path o[:ttf]
+      text.pointsize = o[:letters][:points]
+  
+      cur = 0
+      @code.each { |c|
+        text.annotate(canvas, 0, 0, cur, o[:letters][:baseline], c) {
+          self.fill = o[:colors][:font]
+        }
+        cur += o[:letters][:width]
+      }
+  
+      w = o[:wave][:wavelength]
+      canvas = canvas.wave(o[:wave][:amplitude], rand(w.last - w.first) + w.first)
+      canvas = canvas.implode(o[:implode])
+  
+      @code = @code.to_s
+      @data = canvas.to_blob { self.format = "JPG" }
+      canvas.destroy!
+    end
+  
+    private
+
+    def generate_code(o)
+      chars = ('a'..'z').to_a - o[:letters][:ignore]
+      @code = []
+      1.upto(o[:letters][:count]) do
+        @code << chars[rand(chars.length)]
+      end
+    end
+  end
+end

data/lib/captcha/model.rb

@@ -0,0 +1,56 @@
+module Captcha
+  module Model
+    def self.included(base)
+      base.extend ActMethods
+    end
+    
+    module ActMethods
+      def acts_as_captcha(options={})
+        extend ClassMethods
+        include InstanceMethods
+        attr_reader :captcha, :known_captcha
+        cattr_accessor :captcha_options
+        self.captcha_options = options
+        validate :captcha_must_match_known_captcha
+      end
+    end
+  
+    module ClassMethods
+    end
+  
+    module InstanceMethods
+      def captcha=(c)
+        @captcha = c || ''
+      end
+      
+      def known_captcha=(c)
+        @known_captcha = c || ''
+      end
+      
+      def captcha_must_match_known_captcha
+        return true if self.captcha.nil? || self.known_captcha.nil?
+        if self.captcha.strip.downcase != Captcha::Cipher.decrypt(self.known_captcha)
+          if self.captcha_options[:base]
+            self.errors.add_to_base(
+              case self.captcha_options[:base]
+              when true
+                "Enter the correct text in the image (6 characters)"
+              else
+                self.captcha_options[:base]
+              end
+            )
+          else
+            self.errors.add(:captcha, 
+              case self.captcha_options[:field]
+              when true, nil
+                "text does not match the text in the image."
+              else
+                self.captcha_options[:field]
+              end
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/captcha_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe :captcha do
+  before(:each) do
+    @delay = 2 # 2 seconds
+    Captcha::Config.new(
+      :count => 10,
+      :destination => File.expand_path(File.dirname(__FILE__) + "/../tmp"),
+      :generate_every => @delay
+    )
+    FileUtils.rm_rf Captcha::Config.options[:destination]
+    @generator = Captcha::Generator.new
+  end
+  after(:all) do
+    FileUtils.rm_rf Captcha::Config.options[:destination]
+  end
+  it "should generate captchas" do
+    Captcha::Config.codes.length.should == 10
+  end
+  it "should generate fresh captchas if the files are older than the generate_every option" do
+    codes = Captcha::Config.codes
+    sleep @delay
+    @generator.generate
+    codes.should_not == Captcha::Config.codes
+  end
+  it "should not regenerate before the files are older than the generate_every option" do
+    codes = Captcha::Config.codes
+    sleep 1
+    @generator.generate
+    codes.should == Captcha::Config.codes
+  end
+  it "should not allow more than the captcha limit to exist" do
+    sleep @delay
+    @generator.generate
+    Captcha::Config.codes.length.should == 10
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'captcha'
+require 'spec'

data/tasks/captcha.rake

@@ -0,0 +1,6 @@
+namespace :captcha do
+  desc 'Generate a batch of captchas'
+  task :generate => :environment do
+    Captcha::Generator.new
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: captcha
+version: !ruby/object:Gem::Version 
+  version: 1.2.1
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.9.2
+    version: 
+description: 
+email: mail@wintoni.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- gemspec.rb
+- init.rb
+- lib/captcha/action.rb
+- lib/captcha/cipher.rb
+- lib/captcha/config.rb
+- lib/captcha/generator.rb
+- lib/captcha/image.rb
+- lib/captcha/model.rb
+- lib/captcha.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- resources/captcha.ttf
+- spec/lib/captcha_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/captcha.rake
+has_rdoc: true
+homepage: http://github.com/winton/captcha
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Google-style captcha for enterprise Rails apps
+test_files: []
+