winton-captcha 1.0.3 → 1.0.4

data/README.markdown

@@ -1,23 +1,23 @@
 captcha
 =======
 
-A simple captcha generator for Rails.
-
-
-How it works
-------------
-
-If **public/images/captchas** does not exist, 100 captchas will be generated there when the application starts.
+An Rmagick based, Google-style captcha generator for Rails.
 
 
 Install
 -------
 
-	gem install winton-captcha
+	script/plugin install git://github.com/winton/captcha.git
+
+### Generate config/captcha.rb
+
+	rake captcha
 
-### Add to environment.rb
+Take a look at the config file.
 
-	config.gem 'winton-captcha', :lib => 'captcha', :source => 'http://gems.github.com'
+### Generate captchas
+	
+	rake captcha:generate
 
 ### Add to .gitignore
 

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+
+task :default => 'captcha.gemspec'
+
+file 'captcha.gemspec' => FileList['{lib,spec}/**','Rakefile'] do |f|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  parts = spec.split("  # = MANIFEST =\n")
+  fail 'bad spec' if parts.length != 3
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write...
+  parts[1] = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = parts.join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "Updated #{f.name}"
+end
+
+# sudo rake install
+task :install do
+  `sudo gem uninstall captcha -x`
+  `gem build captcha.gemspec`
+  `sudo gem install captcha*.gem`
+  `rm captcha*.gem`
+end

data/captcha.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  s.name    = 'captcha'
+  s.version = '1.0.4'
+  s.date    = '2009-03-23'
+  
+  s.summary     = "An Rmagick based, Google-style captcha generator"
+  s.description = "An Rmagick based, Google-style captcha generator"
+  
+  s.author   = 'Winton Welsh'
+  s.email    = 'mail@wintoni.us'
+  s.homepage = 'http://github.com/winton/captcha'
+  
+  s.has_rdoc = false
+  
+  # = MANIFEST =
+  s.files = %w[
+    README.markdown
+    Rakefile
+    captcha.gemspec
+    init.rb
+    lib/captcha.rb
+    lib/captcha/action.rb
+    lib/captcha/actions.rb
+    lib/captcha/captcha.rb
+    lib/captcha/config.rb
+    lib/captcha/generator.rb
+    lib/captcha/image.rb
+    lib/captcha/routes.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/init.rb

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

data/lib/captcha.rb

@@ -1,59 +1,4 @@
-require 'RMagick'
-
-Dir[File.expand_path('*/*.rb', File.dirname(__FILE__))].each do |f|
-  require [ File.dirname(f), File.basename(f, '.rb') ].join('/')
-end
-
-class Captcha
-  
-  include Magick
-  attr_reader :code, :code_image
-  
-  JIGGLE = 15
-  WOBBLE = 25
-
-  def initialize(len)
-    chars = ('a'..'z').to_a - ['a','e','i','o','u','l','j']
-    code_array = []
-    1.upto(len) { code_array << chars[rand(chars.length)] }
-    granite = Magick::ImageList.new('granite:')
-    canvas = Magick::ImageList.new
-    canvas.new_image(32*len, 50, Magick::TextureFill.new(granite))
-    text = Magick::Draw.new
-    text.font = File.expand_path('vendor/plugins/captcha/resources/captcha.ttf')
-    text.pointsize = 40
-    cur = 10
-
-    code_array.each { |c|
-      rot    = rand(10) > 5 ? rand(WOBBLE) : -rand(WOBBLE)
-      weight = rand(10) > 5 ? NormalWeight : BoldWeight
-      text.annotate(canvas,0,0,cur,30+rand(JIGGLE), c) {
-        self.rotation = rot
-        self.font_weight = weight
-        self.fill = '#98999B'
-      }
-      cur += 30
-    }
-    
-    @code = code_array.to_s
-    @code_image = canvas.to_blob {
-      self.format = "JPG" 
-    }
-    
-    GC.start
-  end
-
-end
-
-to = "public/images/captchas"
-unless File.exists?(to)
-  FileUtils.mkdir_p to
-  (0..99).each do |x|
-    c = Captcha.new(6)
-    File.open("#{to}/#{c.code}.jpg", 'w') do |f|
-      f << c.code_image
-    end
-  end
-end
-
-ActionController::Base.send :include, CaptchaActions
+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/generator.rb"

data/lib/captcha/action.rb

@@ -0,0 +1,42 @@
+module Captcha
+  module Action
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_captcha
+        include Captcha::Action::InstanceMethods
+        self.around_filter CaptchaFilter.new
+      end
+    end
+
+    module InstanceMethods
+      def new
+        files = Dir["#{RAILS_ROOT}/#{CAPTCHAS.options[:destination]}/*.jpg"]
+        @captcha = File.basename(files[rand(files.length)], '.jpg')
+        show
+      end
+    
+      def show
+        new unless @captcha
+        send_file "#{RAILS_ROOT}/#{CAPTCHAS.options[:destination]}/#{@captcha}.jpg", :type => 'image/jpeg', :disposition => 'inline'
+      end
+    end
+  
+    private
+  
+    class CaptchaFilter
+      def before(controller)
+        @captcha = session[:captcha]
+      end
+      def after(controller)
+        if session[:captcha] != @captcha
+          session[:captcha] = @captcha
+        end
+      end
+    end
+  
+  end
+end

data/lib/captcha/config.rb

@@ -0,0 +1,71 @@
+module Captcha
+  class Config
+    def initialize(options={})
+      @@options = {
+        :colors => {
+          :background => '#1B1C20',
+          :font => '#7385C5'
+        },
+        # number of captcha images to generate
+        :count => 500,
+        :destination => File.expand_path(
+          (defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/" : '') +
+          "public/images/captchas"
+        ),
+        :dimensions => {
+          # canvas height (px)
+          :height => 31,
+          # canvas width (px)
+          :width => 90
+        },
+        :generate_every => 24 * 60 * 60,
+        # http://www.imagemagick.org/RMagick/doc/image2.html#implode
+        :implode => 0.2,
+        :letters => {
+          # text baseline (px)
+          :baseline => 24,
+          # number of letters in captcha
+          :count => 6,
+          :ignore => ['a','e','i','o','u','l','j','q'],
+          # font size (pts)
+          :points => 34,
+          # width of a character (used to decrease or increase space between characters) (px)
+          :width => 14
+        },
+        :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 => (20..70),
+          # distance between peak and valley of sin wave (px)
+          :amplitude => 3
+        }
+      }.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] }
+    end
+  
+    def self.codes
+      self.captchas_ordered_by_modified.collect do |f|
+        File.basename f, '.jpg'
+      end
+    end
+  
+    def self.options
+      @@options
+    end
+  
+    def self.last_modified
+      youngest = self.captchas_ordered_by_modified.first
+      youngest ? File.mtime(youngest) : nil
+    end
+  end
+end

data/lib/captcha/generator.rb

@@ -0,0 +1,29 @@
+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]
+      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
+        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

@@ -0,0 +1,46 @@
+require 'RMagick'
+
+module Captcha
+  class Image
+
+    include Magick
+    attr_reader :code, :image
+
+    def initialize(o)
+      @code = generate_code o
+    
+      canvas = Magick::ImageList.new
+      canvas.new_image(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
+      @image = canvas.to_blob { self.format = "JPG" }
+    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
+    end
+  end
+end

data/resources/captchas.rb

@@ -0,0 +1,24 @@
+{
+  :count => 100,    # number of captcha images to generate
+  :width => 90,     # canvas width (px)
+  :height => 31,    # canvas height (px)
+  :colors => {
+    :background => '#1B1C20',
+    :font => '#7385C5'
+  },
+  :letters => {
+    :baseline => 24,# text baseline (px)
+    :count => 6,    # number of letters in captcha
+    :ignore => ['a','e','i','o','u','l','j','q'],
+    :points => 34,  # font size (pts)
+    :width => 14,   # width of a character (used to decrease or increase space between characters) (px)
+  },
+  :implode => 0.2,  # http://www.imagemagick.org/RMagick/doc/image2.html#implode
+  :wave => {        # http://www.imagemagick.org/RMagick/doc/image3.html#wave
+    :wavelength => (20..70), # range is used for randomness (px)
+    :amplitude => 3          # distance between peak and valley of sin wave (px)
+  },
+  :generate_on_startup => RAILS_ENV == 'production',
+  :destination => 'tmp/captchas',
+  :ttf => 'vendor/plugins/captcha/resources/captcha.ttf'
+}

data/spec/lib/captcha_spec.rb

@@ -0,0 +1,63 @@
+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 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
+    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)
+    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
+  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,55 @@
+require File.expand_path('../lib/captcha/captcha.rb', File.dirname(__FILE__))
+
+desc 'Updates config/captcha.rb'
+task :captcha => 'captcha:config'
+
+namespace :captcha do
+  
+  desc 'Updates config/captcha.rb'
+  task :config => 'captcha:config:to_app'
+  
+  desc 'Generates captchas'
+  task :generate do
+    Captchas.new
+  end
+  
+  namespace :config do
+    desc 'Copies plugin resources to app'
+    task :to_app do
+      captcha_resource 'captchas.rb', 'config/captchas.rb'
+    end
+
+    desc 'Copies app resources to plugin'
+    task :to_plugin do
+      captcha_resource 'captchas.rb', 'config/captchas.rb', true
+    end
+    
+    desc 'Removes plugin resources from app'
+    task :remove do
+      rm_rf 'config/captchas.rb'
+    end
+  end
+  
+  def captcha_resource(type, to, reverse=false, overwrite=true)
+    from = "#{File.dirname(__FILE__)}/../resources/#{type}"
+    from, to = to, from if reverse
+    puts "=> Removing old #{type}..."
+    puts to
+    return if File.exists?(to) && !overwrite
+    if File.directory?(from)
+      FileUtils.remove_dir(to, true) if File.exists?(to)
+      FileUtils.mkdir_p to
+    else
+      File.unlink(to) if File.exists?(to)
+    end
+    puts "=> Copying #{type}..."
+    (File.directory?(from) ? Dir["#{from}/*"] : [from]).each do |f|
+      if File.directory? f
+        FileUtils.mkdir_p "#{to}/#{File.basename(f)}"
+        FileUtils.cp_r f, to
+      else
+        FileUtils.cp f, to
+      end
+    end if File.exists?(from)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: winton-captcha
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Winton Welsh
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-16 00:00:00 -07:00
+date: 2009-03-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: A simple captcha generator for Rails
+description: An Rmagick based, Google-style captcha generator
 email: mail@wintoni.us
 executables: []
 
@@ -22,12 +22,24 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.markdown
+- Rakefile
+- captcha.gemspec
 - init.rb
 - lib/captcha.rb
-- lib/captcha
+- lib/captcha/action.rb
 - lib/captcha/actions.rb
-- README.markdown
+- lib/captcha/captcha.rb
+- lib/captcha/config.rb
+- lib/captcha/generator.rb
+- lib/captcha/image.rb
+- lib/captcha/routes.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: 
@@ -53,6 +65,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A simple captcha generator for Rails
+summary: An Rmagick based, Google-style captcha generator
 test_files: []
 

data/lib/captcha/actions.rb

@@ -1,26 +0,0 @@
-module CaptchaActions
-
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    def acts_as_captcha
-      include CaptchaActions::InstanceMethods
-    end
-  end
-
-  module InstanceMethods
-    def index
-      new unless session[:captcha]
-      send_file "#{RAILS_ROOT}/public/images/captchas/#{session[:captcha]}.jpg", :type => 'image/jpeg', :disposition => 'inline'
-    end
-
-    def new
-      files = Dir["#{RAILS_ROOT}/public/images/captchas/*.jpg"]
-      session[:captcha] = File.basename(files[rand(files.length)], '.jpg')
-      index
-    end
-  end
-  
-end