easy_captcha-ftbpro 0.6.4

data/lib/easy_captcha/captcha.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module EasyCaptcha
+  # captcha generation class
+  class Captcha
+    # code for captcha generation
+    attr_reader :code
+    # blob of generated captcha image
+    attr_reader :image
+
+    # generate captcha by code
+    def initialize code
+      @code = code
+      generate_captcha
+    end
+
+    def inspect #:nodoc:
+      "<EasyCaptcha::Captcha @code=#{code}>"
+    end
+
+    private
+
+    def generate_captcha #:nodoc:
+      @image = EasyCaptcha.generator.generate(@code)
+    end
+  end
+end

data/lib/easy_captcha/controller.rb

@@ -0,0 +1,22 @@
+module EasyCaptcha
+  # captcha controller
+  class Controller < ActionController::Base
+    before_filter :overwrite_cache_control
+    # captcha action send the generated image to browser
+    def captcha
+      if params[:format] == "wav" and EasyCaptcha.espeak?
+        send_data generate_speech_captcha, :disposition => 'inline', :type => 'audio/wav'
+      else
+        send_data generate_captcha, :disposition => 'inline', :type => 'image/png'
+      end
+    end
+
+    private
+    # Overwrite cache control for Samsung Galaxy S3 (remove no-store)
+    def overwrite_cache_control
+      response.headers["Cache-Control"] = "no-cache, max-age=0, must-revalidate"
+      response.headers["Pragma"] = "no-cache"
+      response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
+    end
+  end
+end

data/lib/easy_captcha/controller_helpers.rb

@@ -0,0 +1,93 @@
+module EasyCaptcha
+  # helper class for ActionController
+  module ControllerHelpers
+
+    def self.included(base) #:nodoc:
+      base.class_eval do
+        helper_method :valid_captcha?, :captcha_valid?
+      end
+    end
+
+    # generate captcha image and return it as blob
+    def generate_captcha
+      if EasyCaptcha.cache
+        # create cache dir
+        FileUtils.mkdir_p(EasyCaptcha.cache_temp_dir)
+
+        # select all generated captchas from cache
+        files = Dir.glob(EasyCaptcha.cache_temp_dir + "*.png")
+
+        unless files.size < EasyCaptcha.cache_size
+          file              = File.open(files.at(Kernel.rand(files.size)))
+          session[:captcha] = File.basename(file.path, '.*')
+
+          if file.mtime < EasyCaptcha.cache_expire.ago
+            File.unlink(file.path)
+            # remove speech version
+            File.unlink(file.path.gsub(/png\z/, "wav")) if File.exists?(file.path.gsub(/png\z/, "wav"))
+          else
+            return file.readlines.join
+          end
+        end
+        generated_code = generate_captcha_code
+        image = Captcha.new(generated_code).image
+
+        # write captcha for caching
+        File.open(captcha_cache_path(generated_code), 'w') { |f| f.write image }
+
+        # write speech file if u create a new captcha image
+        EasyCaptcha.espeak.generate(generated_code, speech_captcha_cache_path(generated_code)) if EasyCaptcha.espeak?
+
+        # return image
+        image
+      else
+        Captcha.new(generate_captcha_code).image
+      end
+    end
+
+    # generate speech by captcha from session
+    def generate_speech_captcha
+      raise RuntimeError, "espeak disabled" unless EasyCaptcha.espeak?
+      if EasyCaptcha.cache
+        File.read(speech_captcha_cache_path(current_captcha_code))
+      else
+        wav_file = Tempfile.new("#{current_captcha_code}.wav")
+        EasyCaptcha.espeak.generate(current_captcha_code, wav_file.path)
+        File.read(wav_file.path)
+      end
+    end
+
+    # return cache path of captcha image
+    def captcha_cache_path(code)
+      "#{EasyCaptcha.cache_temp_dir}/#{code}.png"
+    end
+
+    # return cache path of speech captcha
+    def speech_captcha_cache_path(code)
+      "#{EasyCaptcha.cache_temp_dir}/#{code}.wav"
+    end
+
+    # current active captcha from session
+    def current_captcha_code
+      session[:captcha]
+    end
+
+    # generate captcha code, save in session and return
+    def generate_captcha_code
+      session[:captcha] = EasyCaptcha.length.times.collect { EasyCaptcha.chars[rand(EasyCaptcha.chars.size)] }.join
+    end
+
+    # validate given captcha code and re
+    def captcha_valid?(code)
+      return false if session[:captcha].blank? or code.blank?
+      session[:captcha].to_s.upcase == code.to_s.upcase
+    end
+    alias_method :valid_captcha?, :captcha_valid?
+
+    # reset the captcha code in session for security after each request
+    def reset_last_captcha_code!
+      session.delete(:captcha)
+    end
+
+  end
+end

data/lib/easy_captcha/espeak.rb

@@ -0,0 +1,79 @@
+module EasyCaptcha
+  # espeak wrapper
+  class Espeak
+
+    # generator for captcha images
+    def initialize(&block)
+      defaults
+      yield self if block_given?
+    end
+
+    # set default values
+    def defaults
+      @amplitude = 80..120
+      @pitch     = 30..70
+      @gap       = 80
+      @voice     = nil
+    end
+
+    attr_writer :amplitude, :pitch, :gap, :voice
+
+    # return amplitude
+    def amplitude
+      if @amplitude.is_a? Range
+        @amplitude.to_a.sort_by { rand }.first
+      else
+        @amplitude.to_i
+      end
+    end
+
+    # return amplitude
+    def pitch
+      if @pitch.is_a? Range
+        @pitch.to_a.sort_by { rand }.first
+      else
+        @pitch.to_i
+      end
+    end
+
+    def gap
+      @gap.to_i
+    end
+
+    def voice
+      if @voice.is_a? Array
+        v = @voice.sort_by { rand }.first
+      else
+        v = @voice
+      end
+
+      v.try :gsub, /[^A-Za-z0-9\-\+]/, ""
+    end
+
+    # generate wav file by captcha
+    def generate(captcha, wav_file)
+      # get code
+      if captcha.is_a? Captcha
+        code = captcha.code
+      elsif captcha.is_a? String
+        code = captcha
+      else
+        raise ArgumentError, "invalid captcha"
+      end
+
+      # add spaces
+      code = code.each_char.to_a.join(" ")
+
+      cmd = "espeak -g 10"
+      cmd << " -a #{amplitude}" unless @amplitude.nil?
+      cmd << " -p #{pitch}" unless @pitch.nil?
+      cmd << " -g #{gap}" unless @gap.nil?
+      cmd << " -v '#{voice}'" unless @voice.nil?
+      cmd << " -w #{wav_file} '#{code}'"
+
+      %x{#{cmd}}
+      true
+    end
+
+  end
+end

data/lib/easy_captcha/generator.rb

@@ -0,0 +1,8 @@
+module EasyCaptcha
+  # module for generators
+  module Generator
+    autoload :Base, 'easy_captcha/generator/base'
+    autoload :Default, 'easy_captcha/generator/default'
+
+  end
+end

data/lib/easy_captcha/generator/base.rb

@@ -0,0 +1,19 @@
+module EasyCaptcha
+  module Generator
+
+    # base class for generators
+    class Base
+
+      # generator for captcha images
+      def initialize(&block)
+        defaults
+        yield self if block_given?
+      end
+
+      # default values for generator
+      def defaults
+      end
+
+    end
+  end
+end

data/lib/easy_captcha/generator/default.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+module EasyCaptcha
+  module Generator
+
+    # default generator
+    class Default < Base
+
+      # set default values
+      def defaults
+        @font_size              = 24
+        @font_fill_color        = '#333333'
+        @font		        = File.expand_path('../../../../resources/captcha.ttf', __FILE__)
+        @font_stroke            = '#000000'
+        @font_stroke_color      = 0
+        @image_background_color = '#FFFFFF'
+        @sketch                 = true
+        @sketch_radius          = 3
+        @sketch_sigma           = 1
+        @wave                   = true
+        @wave_length            = (60..100)
+        @wave_amplitude         = (3..5)
+        @implode                = 0.05
+        @blur                   = true
+        @blur_radius            = 1
+        @blur_sigma             = 2
+      end
+
+      # Font
+      attr_accessor :font_size, :font_fill_color, :font, :font_family, :font_stroke, :font_stroke_color
+
+      # Background
+      attr_accessor :image_background_color, :background_image
+
+      # Sketch
+      attr_accessor :sketch, :sketch_radius, :sketch_sigma
+
+      # Wave
+      attr_accessor :wave, :wave_length, :wave_amplitude
+
+      # Implode
+      attr_accessor :implode
+
+      # Gaussian Blur
+      attr_accessor :blur, :blur_radius, :blur_sigma
+
+      def sketch? #:nodoc:
+        @sketch
+      end
+
+      def wave? #:nodoc:
+        @wave
+      end
+
+      def blur? #:nodoc:
+        @blur
+      end
+
+      # generate image
+      def generate(code)
+        config = self
+        canvas = Magick::Image.new(EasyCaptcha.image_width, EasyCaptcha.image_height) do |variable|
+          self.background_color = config.image_background_color unless config.image_background_color.nil?
+          self.background_color = 'none' if config.background_image.present?
+        end
+
+        # Render the text in the image
+        canvas.annotate(Magick::Draw.new, 0, 0, 0, 0, code) {
+          self.gravity     = Magick::CenterGravity
+          self.font 	   = config.font
+          self.font_weight = Magick::LighterWeight
+          self.fill        = config.font_fill_color
+          if config.font_stroke.to_i > 0
+            self.stroke       = config.font_stroke_color
+            self.stroke_width = config.font_stroke
+          end
+          self.pointsize = config.font_size
+        }
+
+        # Blur
+        canvas = canvas.blur_image(config.blur_radius, config.blur_sigma) if config.blur?
+
+        # Wave
+        w = config.wave_length
+        a = config.wave_amplitude
+        canvas = canvas.wave(rand(a.last - a.first) + a.first, rand(w.last - w.first) + w.first) if config.wave?
+
+        # Sketch
+        canvas = canvas.sketch(config.sketch_radius, config.sketch_sigma, rand(180)) if config.sketch?
+
+        # Implode
+        canvas = canvas.implode(config.implode.to_f) if config.implode.is_a? Float
+
+        # Crop image because to big after waveing
+        canvas = canvas.crop(Magick::CenterGravity, EasyCaptcha.image_width, EasyCaptcha.image_height)
+
+
+        # Combine images if background image is present
+        if config.background_image.present?
+          background = Magick::Image.read(config.background_image).first
+          background.composite!(canvas, Magick::CenterGravity, Magick::OverCompositeOp)
+
+          image = background.to_blob { self.format = 'PNG' }
+        else
+                image = canvas.to_blob { self.format = 'PNG' }
+        end
+
+        # ruby-1.9
+        image = image.force_encoding 'UTF-8' if image.respond_to? :force_encoding
+
+        canvas.destroy!
+        image
+      end
+
+    end
+  end
+end

data/lib/easy_captcha/model_helpers.rb

@@ -0,0 +1,29 @@
+module EasyCaptcha
+  module ModelHelpers #:nodoc:
+    # helper class for ActiveRecord
+    def self.included(base) #:nodoc:
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods #:nodoc:
+      # to activate model captcha validation
+      def acts_as_easy_captcha
+        include InstanceMethods
+        attr_writer :captcha, :captcha_verification
+      end
+    end
+
+    module InstanceMethods #:nodoc:
+
+      def captcha  #:nodoc:
+        ""
+      end
+
+      # validate captcha
+      def captcha_valid?
+        errors.add(:captcha, :invalid) if @captcha.blank? or @captcha_verification.blank? or @captcha.to_s.upcase != @captcha_verification.to_s.upcase 
+      end
+      alias_method :valid_captcha?, :captcha_valid?
+    end
+  end
+end

data/lib/easy_captcha/routes.rb

@@ -0,0 +1,10 @@
+module ActionDispatch #:nodoc:
+  module Routing #:nodoc:
+    class Mapper #:nodoc:
+      # call to add default captcha root
+      def captcha_route
+        match 'captcha' => EasyCaptcha::Controller, :action => :captcha, :via => :get
+      end
+    end
+  end
+end

data/lib/easy_captcha/version.rb

@@ -0,0 +1,3 @@
+module EasyCaptcha
+  VERSION = '0.6.4'
+end

data/lib/easy_captcha/view_helpers.rb

@@ -0,0 +1,11 @@
+module EasyCaptcha
+  # helper class for ActionView
+  module ViewHelpers
+    # generate an image_tag for captcha image
+    def captcha_tag(*args)
+      options = { :alt => 'captcha', :width => EasyCaptcha.image_width, :height => EasyCaptcha.image_height }
+      options.merge! args.extract_options!
+      image_tag(captcha_url(:i => Time.now.to_i), options)
+    end
+  end
+end

data/lib/generators/easy_captcha/install_generator.rb

@@ -0,0 +1,23 @@
+module EasyCaptcha
+  module Generators #:nodoc:
+    class InstallGenerator < Rails::Generators::Base #:nodoc:
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Install easy_captcha"
+
+      def copy_initializer #:nodoc:
+        template "easy_captcha.rb", "config/initializers/easy_captcha.rb"
+      end
+
+      def add_devise_routes #:nodoc:
+        route 'captcha_route'
+      end
+
+      def add_after_filter #:nodoc:
+        inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+          "  # reset captcha code after each request for security\n  after_filter :reset_last_captcha_code!\n\n"
+        end
+      end
+    end
+  end
+end