easy_captcha 0.1.2

data/.gitignore

@@ -0,0 +1,14 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# jeweler generated
+pkg
+
+.DS_Store

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,67 @@
+== EasyCaptcha
+A simple captcha implementation for rails 3 based on rmagick
+
+== Installation
+To install easy_captcha
+  gem install easy_captcha
+
+Add following line to routes.rb
+  match "captcha" => EasyCaptcha::Controller
+
+== Configuration
+You can write this in "config/initializers/easy_captcha.rb", if you want to customize the default configuration
+
+  EasyCaptcha.setup do |config|
+    # 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
+    # config.length = 6
+    # Font
+    # config.font_size = 24
+    # config.font_fill_color = '#333333'
+    # config.font_stroke_color = '#000000'
+    # config.font_stroke = 0
+    # config.font_family = File.expand_path('../../resources/afont.ttf', __FILE__)
+    
+    # Image
+    #config.image_height = 40
+    #config.image_width = 140
+    #config.image_background_color = "#FFFFFF"
+    
+    # Wave
+    # config.wave = true
+    # config.wave_length = (60..100)
+    # config.wave_amplitude = (3..5)
+    
+    # Sketch
+    # config.sketch = true
+    # config.sketch_radius = 3
+    # config.sketch_sigma = 1
+    
+    # Implode
+    # config.implode = 0.1
+    
+    # Gaussian Blur
+    # config.blur = true
+    # config.blur_radius = 1
+    # config.blur_sigma = 2
+  end
+
+== Example
+
+  <% form_tag '/' do %>
+    <% if request.post? %>
+      <p><%= valid_captcha?(params[:captcha]) ? 'valid' : 'invalid' %> captcha</p>
+    <% end %>
+    <p><%= captcha_tag %></p>
+    <p><%= text_field_tag :captcha %></p>
+    <p><%= submit_tag 'Validate' %></p>
+  <% end %>  
+
+== Maintainers
+
+* Marco Scholl (http://github.com/traxanos)
+
+== License
+
+Copyright (c) 2010 Marco Scholl, released under the MIT license

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'  
+require 'rake'  
+  
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "easy_captcha"  
+    gemspec.summary = "Captcha-Plugin for Rails"  
+    gemspec.description = "Captcha-Plugin for Rails. IMage generate based on rmagick"  
+    gemspec.email = "develop@marco-scholl.de"  
+    gemspec.homepage = "http://github.com/traxanos/easy_captcha"  
+    gemspec.authors = ["Marco Scholl"]
+    gemspec.add_development_dependency "rspec", ">= 1.2.9"
+    gemspec.add_runtime_dependency "rails", ">= 3.0.0"
+    gemspec.add_runtime_dependency "rmagick"
+  end  
+  Jeweler::GemcutterTasks.new
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "easy_captcha #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/easy_captcha.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_captcha}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marco Scholl"]
+  s.date = %q{2010-09-04}
+  s.description = %q{Captcha-Plugin for Rails. IMage generate based on rmagick}
+  s.email = %q{develop@marco-scholl.de}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "easy_captcha.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/easy_captcha.rb",
+     "lib/easy_captcha/captcha.rb",
+     "lib/easy_captcha/controller.rb",
+     "lib/easy_captcha/controller_helpers.rb",
+     "lib/easy_captcha/view_helpers.rb",
+     "resources/captcha.ttf",
+     "test/easy_captcha_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/traxanos/easy_captcha}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Captcha-Plugin for Rails}
+  s.test_files = [
+    "test/easy_captcha_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<rmagick>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_dependency(%q<rmagick>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+    s.add_dependency(%q<rmagick>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'easy_captcha'

data/lib/easy_captcha/captcha.rb

@@ -0,0 +1,60 @@
+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:
+      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
+        self.font_family = EasyCaptcha.font_family
+        self.font_weight = Magick::LighterWeight
+        self.fill = EasyCaptcha.font_fill_color
+        if EasyCaptcha.font_stroke.to_i > 0
+          self.stroke = EasyCaptcha.font_stroke_color
+          self.stroke_width = EasyCaptcha.font_stroke
+        end
+        self.pointsize = EasyCaptcha.font_size
+      }
+
+      # 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)
+      
+      @image = canvas.to_blob { self.format = 'PNG' }
+      canvas.destroy!
+    end
+  end
+end

data/lib/easy_captcha/controller.rb

@@ -0,0 +1,10 @@
+module EasyCaptcha
+  # captcha controller
+  #   match "captcha" => EasyCaptcha::Controller
+  class Controller < ActionController::Base
+    # captcha action send the generated image to browser
+    def captcha
+      send_data generate_captcha, :disposition => 'inline', :type => 'image/png'
+    end
+  end
+end

data/lib/easy_captcha/controller_helpers.rb

@@ -0,0 +1,27 @@
+module EasyCaptcha
+  # helper class for ActionController
+  module ControllerHelpers
+    
+    # declare helper_methods
+    def self.included(base)
+      base.class_eval do
+        helper_method :valid_captcha?
+      end
+    end
+    
+    # generate captcha image and return it as blob
+    def generate_captcha
+      Captcha.new(generate_captcha_code).image
+    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
+    def valid_captcha?(code)
+      session[:captcha].to_s.upcase == code.to_s.upcase
+    end
+  end
+end

data/lib/easy_captcha/view_helpers.rb

@@ -0,0 +1,10 @@
+module EasyCaptcha
+  # helper class for ActionView
+  module ViewHelpers
+    # generate an image_tag for captcha image
+    def captcha_tag(*args)
+      options = args.extract_options!
+      image_tag(captcha_path(:i => Time.now.to_i), options)
+    end
+  end
+end

data/lib/easy_captcha.rb

@@ -0,0 +1,78 @@
+require 'active_support'
+# Captcha-Plugin for Rails
+module EasyCaptcha
+  autoload :Captcha, 'easy_captcha/captcha'
+  autoload :Controller, 'easy_captcha/controller'
+  autoload :ViewHelpers, 'easy_captcha/view_helpers'
+  autoload :ControllerHelpers, 'easy_captcha/controller_helpers'
+  
+  # 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)
+  # Length
+  mattr_accessor :length
+  @@length = 6
+  # Font
+  mattr_accessor :font_size, :font_fill_color, :font_family, :font_stroke, :font_stroke_color
+  @@font_size = 24
+  @@font_fill_color = '#333333'
+  @@font_family = File.expand_path('../../../resources/captcha.ttf', __FILE__)
+  @@font_stroke = '#000000'
+  @@font_stroke_color = 0
+  # Image
+  mattr_accessor :image_width, :image_height, :image_background_color
+  @@image_width = 140
+  @@image_height = 40
+  @@image_background_color = '#FFFFFF'
+  # Sketch
+  mattr_accessor :sketch, :sketch_radius, :sketch_sigma
+  @@sketch = true
+  @@sketch_radius = 3
+  @@sketch_sigma = 1
+  # Wave
+  mattr_accessor :wave, :wave_length, :wave_amplitude
+  @@wave = true
+  @@wave_length = (60..100)
+  @@wave_amplitude = (3..5)
+  # Implode
+  mattr_accessor :implode
+  @@implode = 0.05
+  # Gaussian Blur
+  mattr_accessor :blur, :blur_radius, :blur_sigma
+  @@blur = true
+  @@blur_radius = 1
+  @@blur_sigma = 2
+
+  class << self
+    # to configure easy_captcha
+    # for a sample look the readme.rdoc file
+    def setup
+      yield self
+    end
+
+    def sketch? #:nodoc:
+      sketch
+    end
+
+    def wave? #:nodoc:
+      wave
+    end
+      
+    def blur? #:nodoc:
+      blur
+    end
+    
+    # called by rails after initialize
+    def init
+      ActionController::Base.send :include, ControllerHelpers
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end
+
+Rails.configuration.after_initialize do #:nodoc:
+  EasyCaptcha.init
+end
+
+  
+

data/test/easy_captcha_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class EasyCaptchaTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: easy_captcha
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Marco Scholl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Captcha-Plugin for Rails. IMage generate based on rmagick
+email: develop@marco-scholl.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- easy_captcha.gemspec
+- init.rb
+- install.rb
+- lib/easy_captcha.rb
+- lib/easy_captcha/captcha.rb
+- lib/easy_captcha/controller.rb
+- lib/easy_captcha/controller_helpers.rb
+- lib/easy_captcha/view_helpers.rb
+- resources/captcha.ttf
+- test/easy_captcha_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/traxanos/easy_captcha
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Captcha-Plugin for Rails
+test_files: 
+- test/easy_captcha_test.rb
+- test/test_helper.rb