winton-captcha 1.1.0 → 1.2.0

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

@@ -1,8 +1,19 @@
 captcha
 =======
 
-An Rmagick based, Google-style captcha generator.
+A Google-style captcha for enterprise Rails apps
 
+Goals
+-----
+
+* Batch generate captchas
+* Use ciphered filenames (no need to store filename/captcha code pairs)
+* Captchas refresh automatically
+* Easy configuration
+** Number of captchas
+** Period for captcha refresh
+** Colors, wave, implode
+* Handle lots of users
 
 Install
 -------
@@ -12,7 +23,9 @@ Install
 ### Create lib/captcha_config.rb (optional)
 
 <pre>
-{
+Captcha::Config.new(
+  # Used for filename cipher
+  :password => 'something-unique',
   # Captcha colors
   :colors => {
     :background => '#FFFFFF',
@@ -23,8 +36,8 @@ Install
   # Where to write captchas
   :destination => "#{RAILS_ROOT}/public/images/captchas",
   # Generate new batch every day
-  :generate_every => RAILS_ENV == 'production' ? 24 * 60 * 60 : 10 ** 8
-}
+  :generate_every => 24 * 60 * 60
+)
 </pre>
 
 See <code>lib/captcha/config.rb</code> for more options.
@@ -35,50 +48,40 @@ See <code>lib/captcha/config.rb</code> for more options.
 public/images/captchas/*
 </pre>
 
-### Create a captcha controller
-	
-	script/generate controller Captchas
-
-### Add the resource to your routes.rb
-
-	map.resource :captcha
-
-### Add acts\_as\_captcha to captchas_controller.rb
+### Add acts\_as\_captcha to application_controller.rb
 
 <pre>
-class CaptchasController < ApplicationController
+class ApplicationController < ActionController::Base
   acts_as_captcha
 end
-</pre> 
+</pre>
+
+You may now use the <code>reset_captcha</code> method in any controller.
 
 ### Add acts\_as\_captcha to your model
 
 <pre>
-acts_as_captcha "does not have the correct code"
+class User < ActiveRecord::Base
+  acts_as_captcha :base => "base error when captcha fails", :field => "field error when captcha fails"
+end
 </pre>
 
-The parameter is either the error added to the captcha input or nil to add a generic error to base.
+No parameters behaves like <code>:field => true</code>, a default error is added to the "captcha" field.
+
+Use <code>:base => true</code> to activate a default error for base.
 
 ### In your view
 
 <pre>
-<img src="/captcha?<%= Time.now.to_i %>" onclick="this.src = '/captcha/new?' + (new Date()).getTime()" />
+&lt;img src="/images/captchas/<%= session[:captcha] %>.jpg" /&gt;
 <%= text_field_tag(:captcha) %>
 </pre>
 
 ### In your controller
 
 <pre>
-model_instance.known_captcha = session[:captcha]
-model_instance.captcha = params[:captcha]
-</pre>
-
-### More information
-
-Captchas will generate and re-generate automatically when a Rails instance starts. Captcha keeps the old batch of captchas around until the next re-generate so users do not get 404s.
-
-We used the following URLs in our view:
-* <code>/captcha</code> to retrieve the image
-* <code>/captcha/new</code> to grab a new image
-
-Use <code>session[:captcha]</code> to store, retrieve, and reset the captcha code.
+user = User.new
+user.known_captcha = session[:captcha]
+user.captcha = params[:captcha]
+user.save
+</pre>

data/captcha.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name    = 'captcha'
-  s.version = '1.1.0'
-  s.date    = '2009-03-24'
+  s.version = '1.2.0'
+  s.date    = '2009-03-27'
   
-  s.summary     = "An Rmagick based, Google-style captcha generator"
-  s.description = "An Rmagick based, Google-style captcha generator"
+  s.summary     = "A Google-style captcha for enterprise Rails apps"
+  s.description = "A Google-style captcha for enterprise Rails apps"
   
   s.author   = 'Winton Welsh'
   s.email    = 'mail@wintoni.us'
@@ -14,24 +14,22 @@ Gem::Specification.new do |s|
   
   # = MANIFEST =
   s.files = %w[
+    MIT-LICENSE
     README.markdown
     Rakefile
     captcha.gemspec
     init.rb
     lib/captcha.rb
     lib/captcha/action.rb
-    lib/captcha/actions.rb
-    lib/captcha/captcha.rb
+    lib/captcha/cipher.rb
     lib/captcha/config.rb
     lib/captcha/generator.rb
     lib/captcha/image.rb
-    lib/captcha/routes.rb
+    lib/captcha/model.rb
     resources/captcha.ttf
-    resources/captchas.rb
     spec/lib/captcha_spec.rb
     spec/spec.opts
     spec/spec_helper.rb
-    tasks/captcha.rake
   ]
   # = MANIFEST =
 end

data/lib/captcha/action.rb

@@ -7,22 +7,26 @@ module Captcha
 
     module ClassMethods
       def acts_as_captcha
-        include Captcha::Action::InstanceMethods
+        unless included_modules.include? InstanceMethods
+          include InstanceMethods 
+        end
+        before_filter :assign_captcha
       end
     end
 
     module InstanceMethods
-      def new
-        files = Captcha::Config.newest_captchas
-        session[:captcha] = File.basename(files[rand(files.length)], '.jpg')
-        redirect_to(:action => :show)
+      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 show
-        new and return unless session[:captcha]
-        file = "#{Captcha::Config.options[:destination]}/#{session[:captcha]}.jpg"
-        new and return unless File.exists?(file)
-        send_file(file, :disposition => 'inline', :type => 'image/jpeg')
+      
+      def reset_captcha
+        session[:captcha] = nil
+        assign_captcha
       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

@@ -1,11 +1,19 @@
 module Captcha
   class Config
     
-    PRODUCTION = defined?(RAILS_ENV) ?
-      RAILS_ENV == 'production' || RAILS_ENV == 'staging' : false
-    ROOT = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/" : ''
+    if defined?(RAILS_ENV)
+      PRODUCTION = RAILS_ENV == 'production' || RAILS_ENV == 'staging'
+      ROOT = "#{RAILS_ROOT}/"
+    else
+      PRODUCTION = false
+      ROOT = ""
+    end
+    ONE_DAY = 24 * 60 * 60
     
+    @@exists = {}
+    @@exists_since = Time.now
     @@options = {
+      :password => 'captcha',
       :colors => {
         :background => '#FFFFFF',
         :font => '#080288'
@@ -19,7 +27,7 @@ module Captcha
         # canvas width (px)
         :width => 110
       },
-      :generate_every => PRODUCTION ? 24 * 60 * 60 : 10 ** 8,
+      :generate_every => PRODUCTION ? ONE_DAY * 1 : ONE_DAY * 10000,
       # http://www.imagemagick.org/RMagick/doc/image2.html#implode
       :implode => 0.2,
       :letters => {
@@ -27,7 +35,7 @@ module Captcha
         :baseline => 25,
         # number of letters in captcha
         :count => 6,
-        :ignore => ['a','e','i','o','u','l','j','q'],
+        :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)
@@ -47,29 +55,25 @@ module Captcha
       @@options.merge!(options)
     end
     
-    def self.captchas_ordered_by_modified
-      return unless @@options
-      files_modified = Dir["#{@@options[:destination]}/*.jpg"].collect do |file|
-        [ file, File.mtime(file) ]
-      end
-      # Youngest to oldest
-      files_modified.sort! { |a, b| b[1] <=> a[1] }
-      files_modified.collect { |f| f[0] }
+    def self.captchas
+      Dir["#{@@options[:destination]}/*.jpg"]
     end
-  
+    
     def self.codes
-      self.captchas_ordered_by_modified.collect do |f|
+      self.captchas.collect do |f|
         File.basename f, '.jpg'
       end
     end
     
-    def self.newest_captchas
-      captchas = self.captchas_ordered_by_modified
-      if captchas
-        captchas[0..@@options[:count]-1]
-      else
-        []
+    def self.exists?(code)
+      if Time.now - @@exists_since > 60 * 60
+        @@exists = {}
+        @@exists_since = Time.now
+      end
+      unless @@exists[code]
+        @@exists[code] = File.exists?("#{@@options[:destination]}/#{code}.jpg")
       end
+      @@exists[code]
     end
   
     def self.options
@@ -77,8 +81,12 @@ module Captcha
     end
   
     def self.last_modified
-      youngest = self.captchas_ordered_by_modified.first
-      youngest ? File.mtime(youngest) : nil
+      file = self.captchas.first
+      if file
+        File.mtime(file)
+      else
+        nil
+      end
     end
   end
 end

data/lib/captcha/generator.rb

@@ -7,23 +7,20 @@ module Captcha
     def generate
       return unless Config.options
       return if Config.last_modified && Config.last_modified > Time.now - Config.options[:generate_every]
+      path = Config.options[:destination]
+      if File.exists?(path)
+        FileUtils.rm_rf Config.options[:destination]
+      end
       FileUtils.mkdir_p Config.options[:destination]
       (1..Config.options[:count]).each do |x|
-        c = Image.new Config.options
-        File.open("#{Config.options[:destination]}/#{c.code}.jpg", 'w') do |f|
-          f << c.image
+        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
-      destroy_if_over_limit
       GC.start
     end
-    
-    def destroy_if_over_limit
-      if Config.codes.length >= Config.options[:count] * 3
-        Config.captchas_ordered_by_modified[(Config.options[:count] * 2)..-1].each do |file|
-          FileUtils.rm_f(file)
-        end
-      end
-    end
   end
 end

data/lib/captcha/image.rb

@@ -4,13 +4,12 @@ module Captcha
   class Image
 
     include Magick
-    attr_reader :code, :image
+    attr_reader :code, :data
 
     def initialize(o)
-      @code = generate_code o
+      generate_code o
     
-      canvas = Magick::ImageList.new
-      canvas.new_image(o[:dimensions][:width], o[:dimensions][:height]) {
+      canvas = Magick::Image.new(o[:dimensions][:width], o[:dimensions][:height]) {
         self.background_color = o[:colors][:background]
       }
   
@@ -30,17 +29,19 @@ module Captcha
       canvas = canvas.wave(o[:wave][:amplitude], rand(w.last - w.first) + w.first)
       canvas = canvas.implode(o[:implode])
   
-      @code  = @code.to_s
-      @image = canvas.to_blob { self.format = "JPG" }
+      @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_array = []
-      1.upto(o[:letters][:count]) { code_array << chars[rand(chars.length)] }
-      code_array
+      @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/lib/captcha.rb

@@ -1,4 +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/spec/lib/captcha_spec.rb

@@ -17,47 +17,15 @@ describe :captcha do
   it "should generate captchas" do
     Captcha::Config.codes.length.should == 10
   end
-  it "should only generate more captchas if the youngest file is older than the generate_every option" do
-    @generator.generate
-    Captcha::Config.codes.length.should == 10
-    sleep @delay
-    @generator.generate
-    Captcha::Config.codes.length.should == 20
-  end
-  it "should not allow more than twice the captcha limit to exist" do
-    sleep @delay
-    @generator.generate
-    Captcha::Config.codes.length.should == 20
-    sleep @delay
-    @generator.generate
-    Captcha::Config.codes.length.should == 20
-  end
-  it "should only destroy the oldest captchas" do
+  it "should generate fresh captchas if the files are older than the generate_every option" do
     codes = Captcha::Config.codes
     sleep @delay
     @generator.generate
-    codes2 = Captcha::Config.codes
-    Captcha::Config.codes.length.should == 20
-    Captcha::Config.codes[9..-1].should_include_all_from(codes)
+    codes.should_not == 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 == 20
-    Captcha::Config.codes[9..-1].should_include_all_from(codes2)
-    Captcha::Config.codes.should_not_include_any_from(codes)
-    @generator.generate
-    Captcha::Config.codes.length.should == 20
-    Captcha::Config.codes.should_not_include_any_from(codes2)
-  end
-  class Array
-    def should_include_all_from(array)
-      included_all = true
-      array.each { |a| included_all = false unless self.include?(a) }
-      included_all
-    end
-    def should_not_include_any_from(array)
-      included_any = false
-      array.each { |a| included_any = true if self.include?(a) }
-      included_any
-    end
+    Captcha::Config.codes.length.should == 10
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: winton-captcha
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Winton Welsh
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-24 00:00:00 -07:00
+date: 2009-03-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: An Rmagick based, Google-style captcha generator
+description: A Google-style captcha for enterprise Rails apps
 email: mail@wintoni.us
 executables: []
 
@@ -22,24 +22,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- MIT-LICENSE
 - README.markdown
 - Rakefile
 - captcha.gemspec
 - init.rb
 - lib/captcha.rb
 - lib/captcha/action.rb
-- lib/captcha/actions.rb
-- lib/captcha/captcha.rb
+- lib/captcha/cipher.rb
 - lib/captcha/config.rb
 - lib/captcha/generator.rb
 - lib/captcha/image.rb
-- lib/captcha/routes.rb
+- lib/captcha/model.rb
 - resources/captcha.ttf
-- resources/captchas.rb
 - spec/lib/captcha_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tasks/captcha.rake
 has_rdoc: false
 homepage: http://github.com/winton/captcha
 post_install_message: 
@@ -65,6 +63,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: An Rmagick based, Google-style captcha generator
+summary: A Google-style captcha for enterprise Rails apps
 test_files: []