easy_captcha 0.5.1 → 0.6.1

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
   - 1.9.2
+  - 1.9.3
   - jruby
-  - ruby-head
 notifications:
   recipients:
     - develop@marco-scholl.de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_captcha (0.5.1)
+    easy_captcha (0.6.0)
       bundler (>= 1.1.0)
       rails (>= 3.0.0)
       rmagick (>= 2.13.1)
@@ -88,15 +88,15 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
-    rspec-rails (2.11.0)
+    rspec-rails (2.11.4)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec (~> 2.11.0)
-    simplecov (0.6.4)
+    simplecov (0.7.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -107,10 +107,9 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.33)
-    yard (0.8.2.1)
+    yard (0.8.3)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/README.rdoc

@@ -40,6 +40,21 @@ You can configure easy_captcha in "config/initializers/easy_captcha.rb", if you
     # config.image_height   = 40
     # config.image_width    = 140
 
+    # eSpeak (default disabled)
+    # config.espeak do |espeak|
+      # Amplitude, 0 to 200
+      # espeak.amplitude = 80..120
+
+      # Word gap. Pause between words
+      # espeak.gap = 80
+
+      # Pitch adjustment, 0 to 99
+      # espeak.pitch = 30..70
+
+      # Use voice file of this name from espeak-data/voices
+      # espeak.voice = nil
+    # end
+
     # configure generator
     # config.generator :default do |generator|
 
@@ -90,17 +105,18 @@ You can configure easy_captcha in "config/initializers/easy_captcha.rb", if you
     <p><%= captcha_tag %></p>
     <p><%= text_field_tag :captcha %></p>
     <p><%= submit_tag 'Validate' %></p>
-  <% end %>  
+  <% end %>
 
 == Example app
 You find an example app under: http://github.com/phatworx/easy_captcha_example
 
 == History
- * 0.1 init
- * 0.2 cache support for high frequented sites
- * 0.3 use generators, optimizations, update licence to same of all my plugins
- * 0.4 generator support
- * 0.5 (transparent) background support
+* 0.1 init
+* 0.2 cache support for high frequented sites
+* 0.3 use generators, optimizations, update licence to same of all my plugins
+* 0.4 generator support
+* 0.5 (transparent) background support
+* 0.6 espeak support for barrier-free support
 
 == Maintainers
 

data/easy_captcha.gemspec

@@ -32,7 +32,6 @@ Gem::Specification.new do |s|
   s.add_dependency('rspec-rails', [">= 2.8.1"])
   s.add_dependency('yard', [">= 0.7.0"])
 
-
   if defined?(PLATFORM) && PLATFORM == 'java'
     s.add_runtime_dependency('rmagick4j','>= 0.3.7')
   else

data/lib/easy_captcha.rb

@@ -3,10 +3,10 @@ require 'rails'
 require 'action_controller'
 require 'active_record'
 require 'active_support'
-require 'easy_captcha/parameters'
 
 # Captcha-Plugin for Rails
 module EasyCaptcha
+  autoload :Espeak, 'easy_captcha/espeak'
   autoload :Captcha, 'easy_captcha/captcha'
   autoload :Controller, 'easy_captcha/controller'
   autoload :ModelHelpers, 'easy_captcha/model_helpers'
@@ -70,6 +70,26 @@ module EasyCaptcha
       end
     end
 
+    def espeak=(state)
+      if state === true
+        @espeak = Espeak.new
+      else
+        @espeak = false
+      end
+    end
+
+    def espeak(&block)
+      if block_given?
+        @espeak = Espeak.new &block
+      else
+        @espeak ||= false
+      end
+    end
+
+    def espeak?
+      not @espeak === false
+    end
+
     # depracated
     def method_missing name, *args
       name = name.to_s # fix for jruby

data/lib/easy_captcha/controller.rb

@@ -3,7 +3,11 @@ module EasyCaptcha
   class Controller < ActionController::Base
     # captcha action send the generated image to browser
     def captcha
-      send_data generate_captcha, :disposition => 'inline', :type => 'image/png'
+      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
   end
 end

data/lib/easy_captcha/controller_helpers.rb

@@ -15,14 +15,16 @@ module EasyCaptcha
         FileUtils.mkdir_p(EasyCaptcha.cache_temp_dir)
 
         # select all generated captchas from cache
-        files = Dir.glob(EasyCaptcha.cache_temp_dir + "*")
-        
+        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
@@ -31,7 +33,10 @@ module EasyCaptcha
         image = Captcha.new(generated_code).image
 
         # write captcha for caching
-        File.open(EasyCaptcha.cache_temp_dir + "#{generated_code}", 'w') { |f| f.write image }
+        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
@@ -40,6 +45,33 @@ module EasyCaptcha
       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

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/version.rb

@@ -1,3 +1,3 @@
 module EasyCaptcha
-  VERSION = '0.5.1'
+  VERSION = '0.6.1'
 end

data/lib/easy_captcha/view_helpers.rb

@@ -8,4 +8,4 @@ module EasyCaptcha
       image_tag(captcha_url(:i => Time.now.to_i), options)
     end
   end
-end
+end

data/lib/generators/templates/easy_captcha.rb

@@ -18,6 +18,21 @@ EasyCaptcha.setup do |config|
   # config.image_height   = 40
   # config.image_width    = 140
 
+  # eSpeak
+  # config.espeak do |espeak|
+    # Amplitude, 0 to 200
+    # espeak.amplitude = 80..120
+
+    # Word gap. Pause between words
+    # espeak.gap = 80
+
+    # Pitch adjustment, 0 to 99
+    # espeak.pitch = 30..70
+
+    # Use voice file of this name from espeak-data/voices
+    # espeak.voice = nil
+  # end
+
   # configure generator
   # config.generator :default do |generator|
 
@@ -48,4 +63,4 @@ EasyCaptcha.setup do |config|
     # generator.blur_radius            = 1
     # generator.blur_sigma             = 2
   # end
-end
+end

data/spec/espeak_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe EasyCaptcha::Espeak do
+  context "check default values" do
+    subject { EasyCaptcha::Espeak.new }
+
+    its(:amplitude) { (80..120).to_a.should include(subject) }
+    its(:pitch) { (30..70).to_a.should include(subject) }
+    its(:gap) { should eq 80 }
+    its(:voice) { should be_nil }
+
+  end
+
+  context "check config: voices" do
+    let(:voices) { ['german', 'german+m1'] }
+    subject do
+      EasyCaptcha::Espeak.new do |config|
+        config.voice = voices
+      end
+    end
+    its(:voice) { voices.should include(subject) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_captcha
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -129,11 +129,11 @@ files:
 - lib/easy_captcha/captcha.rb
 - lib/easy_captcha/controller.rb
 - lib/easy_captcha/controller_helpers.rb
+- lib/easy_captcha/espeak.rb
 - lib/easy_captcha/generator.rb
 - lib/easy_captcha/generator/base.rb
 - lib/easy_captcha/generator/default.rb
 - lib/easy_captcha/model_helpers.rb
-- lib/easy_captcha/parameters.rb
 - lib/easy_captcha/routes.rb
 - lib/easy_captcha/version.rb
 - lib/easy_captcha/view_helpers.rb
@@ -141,6 +141,7 @@ files:
 - lib/generators/templates/easy_captcha.rb
 - resources/captcha.ttf
 - spec/easy_captcha_spec.rb
+- spec/espeak_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 homepage: http://github.com/phatworx/easy_captcha
@@ -156,9 +157,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4538857605889255644
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -167,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Captcha-Plugin for Rails

data/lib/easy_captcha/parameters.rb

@@ -1,31 +0,0 @@
-module ActionDispatch
-  module Http
-    module Parameters
-      private
-
-      # TODO: Validate that the characters are UTF-8. If they aren't,
-      # you'll get a weird error down the road, but our form handling
-      # should really prevent that from happening
-      def encode_params(params)
-        return params unless "ruby".encoding_aware?
-
-        if params.is_a?(String)
-          return params.dup.force_encoding("UTF-8").encode!
-        elsif !params.is_a?(Hash)
-          return params
-        end
-
-        params.each do |k, v|
-          case v
-          when Hash
-            encode_params(v)
-          when Array
-            v.map! {|el| encode_params(el) }
-          else
-            encode_params(v)
-          end
-        end
-      end
-		end
-	end
-end