easy_captcha 0.1.9 → 0.2.0

data/README.rdoc

@@ -11,12 +11,22 @@ Add following line to routes.rb
 Add following line to application_controller.rb
   after_filter lambda { session.delete(:captcha) }
 
-The last line is very important for security!!!
+The last filter is a critical security measurement! Every request after displaying the captcha-image must prevent this filter from being executed.
 
 == Configuration
 You can write this in "config/initializers/easy_captcha.rb", if you want to customize the default configuration
 
   EasyCaptcha.setup do |config|
+
+    # Cache
+    # config.cache = true
+    # Cache temp dir
+    # config.temp_dir = Rails.root + 'tmp' + 'captchas'
+    # Cache size
+    # config.cache_size = 500
+    # Cache expire
+    # config.cache_expire = 1.days
+
     # Chars
     # config.chars = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
     # Length
@@ -66,6 +76,10 @@ You can write this in "config/initializers/easy_captcha.rb", if you want to cust
 == Example
 You find an example app under: http://github.com/traxanos/easy_captcha_example
 
+== History
+ * 0.1 Init
+ * 0.2 Cache support for high frequented sites
+
 == Maintainers
 
 * Marco Scholl (http://github.com/traxanos)

data/VERSION

@@ -1 +1 @@
-0.1.9
+0.2.0

data/easy_captcha.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_captcha}
-  s.version = "0.1.9"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marco Scholl"]

data/lib/easy_captcha/captcha.rb

@@ -5,32 +5,32 @@ module EasyCaptcha
     attr_reader :code
     # blob of generated captcha image
     attr_reader :image
-    
+
     # generate captcha by code
-    def initialize(code)
+    def initialize(code, file)
       @code = code
-      generate_captcha
+      generate_captcha(file)
     end
-    
+
     def inspect #:nodoc:
       "<EasyCaptcha::Captcha @code=#{code}>"
     end
 
     private
-    
-    def generate_captcha #:nodoc:
+
+    def generate_captcha(file) #:nodoc:
       canvas = Magick::Image.new(EasyCaptcha.image_width, EasyCaptcha.image_height) do |variable|
         self.background_color = EasyCaptcha.image_background_color unless EasyCaptcha.image_background_color.nil?
       end
 
       # Render the text in the image
-      canvas.annotate(Magick::Draw.new, 0,0,0,0, code) {
-        self.gravity = Magick::CenterGravity
+      canvas.annotate(Magick::Draw.new, 0, 0, 0, 0, code) {
+        self.gravity     = Magick::CenterGravity
         self.font_family = EasyCaptcha.font_family
         self.font_weight = Magick::LighterWeight
-        self.fill = EasyCaptcha.font_fill_color
+        self.fill        = EasyCaptcha.font_fill_color
         if EasyCaptcha.font_stroke.to_i > 0
-          self.stroke = EasyCaptcha.font_stroke_color
+          self.stroke       = EasyCaptcha.font_stroke_color
           self.stroke_width = EasyCaptcha.font_stroke
         end
         self.pointsize = EasyCaptcha.font_size
@@ -38,21 +38,24 @@ module EasyCaptcha
 
       # Blur
       canvas = canvas.blur_image(EasyCaptcha.blur_radius, EasyCaptcha.blur_sigma) if EasyCaptcha.blur?
-      
+
       # Wave
       w = EasyCaptcha.wave_length
       a = EasyCaptcha.wave_amplitude
       canvas = canvas.wave(rand(a.last - a.first) + a.first, rand(w.last - w.first) + w.first) if EasyCaptcha.wave?
-      
+
       # Sketch
       canvas = canvas.sketch(EasyCaptcha.sketch_radius, EasyCaptcha.sketch_sigma, rand(180)) if EasyCaptcha.sketch?
-      
+
       # Implode
       canvas = canvas.implode(EasyCaptcha.implode.to_f) if EasyCaptcha.implode.is_a? Float
-      
+
       # Crop image because to big after waveing
       canvas = canvas.crop(Magick::CenterGravity, EasyCaptcha.image_width, EasyCaptcha.image_height)
-      
+
+      unless file.nil?
+        canvas.write(file) { self.format = 'PNG' }
+      end
       @image = canvas.to_blob { self.format = 'PNG' }
       canvas.destroy!
     end

data/lib/easy_captcha/controller_helpers.rb

@@ -1,7 +1,7 @@
 module EasyCaptcha
   # helper class for ActionController
   module ControllerHelpers
-    
+
     def self.included(base) #:nodoc:
       base.class_eval do
         helper_method :valid_captcha?
@@ -10,7 +10,23 @@ module EasyCaptcha
 
     # generate captcha image and return it as blob
     def generate_captcha
-      Captcha.new(generate_captcha_code).image
+      if EasyCaptcha.cache
+        FileUtils.mkdir_p(EasyCaptcha.cache_temp_dir)
+        files = Dir.glob(EasyCaptcha.cache_temp_dir + "*")
+        unless files.size < EasyCaptcha.cache_size
+          file = File.open(files.at(Kernel.rand(files.size)))
+
+          if file.mtime < EasyCaptcha.cache_expire.ago
+            File.unlink(file.path)
+          else
+            return file.readlines.join
+          end
+        end
+        generated_code = generate_captcha_code
+        Captcha.new(generated_code, EasyCaptcha.cache_temp_dir + "#{generated_code}").image
+      else
+        Captcha.new(generate_captcha_code).image
+      end
     end
 
     # generate captcha code, save in session and return
@@ -23,6 +39,6 @@ module EasyCaptcha
       return false if session[:captcha].blank? or code.blank?
       session[:captcha].to_s.upcase == code.to_s.upcase
     end
-    
+
   end
 end

data/lib/easy_captcha.rb

@@ -10,7 +10,23 @@ module EasyCaptcha
   autoload :ModelHelpers, 'easy_captcha/model_helpers'
   autoload :ViewHelpers, 'easy_captcha/view_helpers'
   autoload :ControllerHelpers, 'easy_captcha/controller_helpers'
-  
+
+  # Cache
+  mattr_accessor :cache
+  @@cache = true
+
+  # Cache temp
+  mattr_accessor :cache_temp_dir
+  @@cache_temp_dir = Rails.root + 'tmp' + 'captchas'
+
+  # Cache size
+  mattr_accessor :cache_size
+  @@cache_size = 500
+
+  # Cache expire
+  mattr_accessor :cache_expire
+  @@cache_expire = 1.days
+
   # Chars
   mattr_accessor :chars
   @@chars = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
@@ -62,11 +78,15 @@ module EasyCaptcha
     def wave? #:nodoc:
       wave
     end
-      
+
     def blur? #:nodoc:
       blur
     end
-    
+
+    def cache? #:nodoc:
+      cache
+    end
+
     # called by rails after initialize
     def init
       ActiveRecord::Base.send :include, ModelHelpers
@@ -78,5 +98,5 @@ end
 
 EasyCaptcha.init
 
-  
+
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Marco Scholl