winton-captcha 1.0.6 → 1.1.0

data/README.markdown

@@ -13,45 +13,28 @@ Install
 
 <pre>
 {
+  # Captcha colors
   :colors => {
-    :background => '#1B1C20',
-    :font => '#7385C5'
+    :background => '#FFFFFF',
+    :font => '#080288'
   },
-  # number of captcha images to generate
-  :count => 500,
-  :destination => "#{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
-  }
+  # 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 => RAILS_ENV == 'production' ? 24 * 60 * 60 : 10 ** 8
 }
 </pre>
 
+See <code>lib/captcha/config.rb</code> for more options.
+
+### Add public/images/captchas/* to your .gitignore file
+
+<pre>
+public/images/captchas/*
+</pre>
+
 ### Create a captcha controller
 	
 	script/generate controller Captchas
@@ -68,10 +51,34 @@ class CaptchasController < ApplicationController
 end
 </pre> 
 
-### Add public/images/captchas/* to your .gitignore
+### Add acts\_as\_captcha to your model
+
+<pre>
+acts_as_captcha "does not have the correct code"
+</pre>
+
+The parameter is either the error added to the captcha input or nil to add a generic error to base.
+
+### In your view
+
+<pre>
+<img src="/captcha?<%= Time.now.to_i %>" onclick="this.src = '/captcha/new?' + (new Date()).getTime()" />
+<%= text_field_tag(:captcha) %>
+</pre>
+
+### In your controller
+
+<pre>
+model_instance.known_captcha = session[:captcha]
+model_instance.captcha = params[:captcha]
+</pre>
+
+### More information
 
-  public/images/captchas/*
+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.
 
-Captchas will generate and re-generate automatically (see the <code>generate_every</code> option).
+We used the following URLs in our view:
+* <code>/captcha</code> to retrieve the image
+* <code>/captcha/new</code> to grab a new image
 
-Access <code>/captcha</code> to retrieve the image, <code>/captcha/new</code> to grab a new image, and <code>session[:captcha]</code> for the captcha code.
+Use <code>session[:captcha]</code> to store, retrieve, and reset the captcha code.

data/captcha.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = 'captcha'
-  s.version = '1.0.6'
+  s.version = '1.1.0'
   s.date    = '2009-03-24'
   
   s.summary     = "An Rmagick based, Google-style captcha generator"

data/init.rb

@@ -1,5 +1,5 @@
 require 'captcha'
-if File.exists?("#{RAILS_ROOT}/lib/captcha_config.rb")
+if defined?(RAILS_ROOT) && File.exists?("#{RAILS_ROOT}/lib/captcha_config.rb")
   require "#{RAILS_ROOT}/lib/captcha_config"
 end
 

data/lib/captcha/action.rb

@@ -13,7 +13,7 @@ module Captcha
 
     module InstanceMethods
       def new
-        files = Dir["#{Captcha::Config.options[:destination]}/*.jpg"]
+        files = Captcha::Config.newest_captchas
         session[:captcha] = File.basename(files[rand(files.length)], '.jpg')
         redirect_to(:action => :show)
       end

data/lib/captcha/config.rb

@@ -1,7 +1,8 @@
 module Captcha
   class Config
     
-    PRODUCTION = defined?(RAILS_ENV) && RAILS_ENV == 'production'
+    PRODUCTION = defined?(RAILS_ENV) ?
+      RAILS_ENV == 'production' || RAILS_ENV == 'staging' : false
     ROOT = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/" : ''
     
     @@options = {
@@ -61,6 +62,15 @@ module Captcha
         File.basename f, '.jpg'
       end
     end
+    
+    def self.newest_captchas
+      captchas = self.captchas_ordered_by_modified
+      if captchas
+        captchas[0..@@options[:count]-1]
+      else
+        []
+      end
+    end
   
     def self.options
       @@options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: winton-captcha
 version: !ruby/object:Gem::Version 
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors: 
 - Winton Welsh