easy_captcha 0.2.5 → 0.3.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem "rails", ">= 3.0.0"
+gem "rmagick"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "cover_me"
+end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    configatron (2.6.4)
+      yamler (>= 0.1.0)
+    cover_me (1.0.0.rc5)
+      configatron
+      hashie
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    hashie (0.4.0)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rmagick (2.13.1)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    yamler (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cover_me
+  jeweler (~> 1.5.1)
+  rails (>= 3.0.0)
+  rmagick

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2010 [name of plugin creator]
+Copyright (c) 2010 Marco Scholl
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,20 +1,15 @@
-== EasyCaptcha
+= EasyCaptcha
 A simple captcha implementation for rails 3 based on rmagick
 
 == Installation
-To install easy_captcha
-  gem install easy_captcha
+add to Gemfile
+  gem 'easy_captcha'
 
-Add following line to routes.rb
-  get :captcha => EasyCaptcha::Controller
-
-Add following line to application_controller.rb
-  after_filter lambda { session.delete(:captcha) }
-
-The last filter is a critical security measurement! Every request after displaying the captcha-image must prevent this filter from being executed.
+after bundle execute
+  rails g easy_captcha:install
 
 == Configuration
-You can write this in "config/initializers/easy_captcha.rb", if you want to customize the default configuration
+You can configure easy_captcha in "config/initializers/easy_captcha.rb", if you want to customize the default configuration
 
   EasyCaptcha.setup do |config|
 
@@ -73,17 +68,28 @@ You can write this in "config/initializers/easy_captcha.rb", if you want to cust
     <p><%= submit_tag 'Validate' %></p>
   <% end %>  
 
-== Example
+== Example app
 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
+ * 0.3 use generators, optimizations, update licence to same of all my plugins
 
 == Maintainers
 
 * Marco Scholl (http://github.com/traxanos)
 
-== License
+== Contributing to EasyCaptcha
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
 
-Copyright (c) 2010 Marco Scholl, released under the MIT license
+Copyright (c) 2010 Marco Scholl. See LICENSE.txt for further details.

data/Rakefile

@@ -1,52 +1,48 @@
-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"  
-    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"  
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-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
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "easy_captcha"
+  gem.homepage = "http://github.com/traxanos/easy_captcha"
+  gem.license = "MIT"
+  gem.summary = "Captcha-Plugin for Rails"
+  gem.description = "Captcha-Plugin for Rails"
+  gem.email = "develop@marco-scholl.de"
+  gem.authors = ["Marco Scholl"]
+  gem.add_runtime_dependency 'rails', '>= 3.0.0'
+  gem.add_runtime_dependency 'rmagick'
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-task :spec => :check_dependencies
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
 
-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"
+namespace :cover_me do
+  task :report do
+    require 'cover_me'
+    CoverMe.complete!
   end
 end
 
-task :default => :spec
+task :test do
+  Rake::Task['cover_me:report'].invoke
+end
+
+task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.0

data/easy_captcha.gemspec

@@ -5,18 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_captcha}
-  s.version = "0.2.5"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marco Scholl"]
-  s.date = %q{2010-12-07}
+  s.date = %q{2011-01-26}
   s.description = %q{Captcha-Plugin for Rails}
   s.email = %q{develop@marco-scholl.de}
   s.extra_rdoc_files = [
+    "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
-    "MIT-LICENSE",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
@@ -27,13 +30,17 @@ Gem::Specification.new do |s|
     "lib/easy_captcha/controller.rb",
     "lib/easy_captcha/controller_helpers.rb",
     "lib/easy_captcha/model_helpers.rb",
+    "lib/easy_captcha/routes.rb",
     "lib/easy_captcha/view_helpers.rb",
+    "lib/generators/easy_captcha/install_generator.rb",
+    "lib/generators/templates/easy_captcha.rb",
     "resources/captcha.ttf",
     "spec/easy_captcha_spec.rb",
     "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/traxanos/easy_captcha}
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Captcha-Plugin for Rails}
@@ -47,16 +54,28 @@ Gem::Specification.new do |s|
     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"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<cover_me>, [">= 0"])
       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"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<cover_me>, [">= 0"])
       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"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<cover_me>, [">= 0"])
     s.add_dependency(%q<rails>, [">= 3.0.0"])
     s.add_dependency(%q<rmagick>, [">= 0"])
   end

data/lib/easy_captcha.rb

@@ -90,6 +90,7 @@ module EasyCaptcha
 
     # called by rails after initialize
     def init
+      require 'easy_captcha/routes'
       ActiveRecord::Base.send :include, ModelHelpers
       ActionController::Base.send :include, ControllerHelpers
       ActionView::Base.send :include, ViewHelpers

data/lib/easy_captcha/controller.rb

@@ -1,6 +1,5 @@
 module EasyCaptcha
   # captcha controller
-  #   get :captcha => EasyCaptcha::Controller
   class Controller < ActionController::Base
     # captcha action send the generated image to browser
     def captcha

data/lib/easy_captcha/controller_helpers.rb

@@ -14,7 +14,7 @@ module EasyCaptcha
         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)))
+          file              = File.open(files.at(Kernel.rand(files.size)))
           session[:captcha] = File.basename(file.path)
 
           if file.mtime < EasyCaptcha.cache_expire.ago
@@ -41,5 +41,10 @@ module EasyCaptcha
       session[:captcha].to_s.upcase == code.to_s.upcase
     end
 
+    # 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/model_helpers.rb

@@ -1,11 +1,11 @@
 module EasyCaptcha
-  module ModelHelpers
+  module ModelHelpers #:nodoc:
     # helper class for ActiveRecord
     def self.included(base) #:nodoc:
       base.extend ClassMethods
     end
     
-    module ClassMethods
+    module ClassMethods #:nodoc:
       # to activate model captcha validation
       def acts_as_easy_captcha
         include InstanceMethods
@@ -13,11 +13,13 @@ module EasyCaptcha
       end
     end
 
-    module InstanceMethods
-      def captcha
+    module InstanceMethods #:nodoc:
+
+      def captcha  #:nodoc:
         ""
       end
 
+      # validate captcha
       def valid_captcha?
         errors.add(:captcha, :invalid) if @captcha.blank? or @captcha_verification.blank? or @captcha.to_s.upcase != @captcha_verification.to_s.upcase 
       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, :via => :get
+      end
+    end
+  end
+end

data/lib/easy_captcha/view_helpers.rb

@@ -3,7 +3,8 @@ module EasyCaptcha
   module ViewHelpers
     # generate an image_tag for captcha image
     def captcha_tag(*args)
-      options = args.extract_options!
+      options = { :alt => 'captcha' }
+      options.merge! args.extract_options!
       image_tag(captcha_path(:i => Time.now.to_i), options)
     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

data/lib/generators/templates/easy_captcha.rb

@@ -0,0 +1,44 @@
+EasyCaptcha.setup do |config|
+  # Cache
+  # config.cache = true
+  # Cache temp dir from Rails.root
+  # config.cache_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
+  # 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
+
+  # Blur
+  # config.blur = true
+  # config.blur_radius = 1
+  # config.blur_sigma = 2
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marco Scholl
@@ -14,28 +14,83 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-07 00:00:00 +01:00
+date: 2011-01-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
+  name: rails
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
         - 1
-        - 2
-        - 9
-        version: 1.2.9
+        version: 1.5.1
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: cover_me
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,11 +101,11 @@ dependencies:
         - 0
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rmagick
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -59,7 +114,8 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id007
 description: Captcha-Plugin for Rails
 email: develop@marco-scholl.de
 executables: []
@@ -67,9 +123,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE.txt
 - README.rdoc
 files: 
-- MIT-LICENSE
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
@@ -80,15 +139,18 @@ files:
 - lib/easy_captcha/controller.rb
 - lib/easy_captcha/controller_helpers.rb
 - lib/easy_captcha/model_helpers.rb
+- lib/easy_captcha/routes.rb
 - lib/easy_captcha/view_helpers.rb
+- lib/generators/easy_captcha/install_generator.rb
+- lib/generators/templates/easy_captcha.rb
 - resources/captcha.ttf
 - spec/easy_captcha_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/traxanos/easy_captcha
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -99,6 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3005660918227227729
       segments: 
       - 0
       version: "0"