kamcaptcha 0.1.0 → 0.2.0

data/kamcaptcha.gemspec

@@ -1,4 +1,4 @@
-Gem::Specification.new "kamcaptcha", "0.1.0" do |s|
+Gem::Specification.new "kamcaptcha", "0.2.0" do |s|
   s.summary     = "A captcha image generator that's a little less retarded"
   s.description = "Helps humankind with simpler captchas"
   s.authors     = [ "Morten Primdahl" ]

data/lib/kamcaptcha.rb

@@ -1,28 +1,37 @@
 require "digest"
 
+require 'kamcaptcha/token'
+
 # You must configure Kamcaptcha with a path to the generated words, and a salt.
 # The salt must be the same you used when generating words.
 module Kamcaptcha
-
   class << self
-    attr_accessor :salt, :path
-  end
+    attr_accessor :salt, :path, :template
+    attr_writer :prefix
 
-  def self.random
-    images[rand(images.size)]
-  end
+    def prefix
+      @prefix || ""
+    end
 
-  def self.images
-    @images ||= Dir.glob("#{path}/*.*").map { |f| File.basename(f) }
-  end
+    def random
+      images[rand(images.size)]
+    end
 
-  def self.valid?(input, validation)
-    input = input.to_s.delete(" ").downcase
-    encrypt(input) == validation
-  end
+    def images
+      @images ||= Dir.glob("#{path}/*.*").map { |f| File.basename(f) }
+    end
 
-  def self.encrypt(string)
-    raise "You must configure a salt" if Kamcaptcha.salt.nil?
-    Digest::SHA2.hexdigest("#{salt}::#{string}")
+    def encrypt(string)
+      raise "You must configure a salt" if Kamcaptcha.salt.nil?
+      Digest::SHA2.hexdigest("#{salt}::#{string}")
+    end
   end
 end
+
+Kamcaptcha.template = <<-END
+  <div class="kamcaptcha">
+    <label for="kamcaptcha_input"><%= label %></label><input type="text" id="kamcaptcha_input" name="kamcaptcha[input]" />
+    <input type="hidden" name="kamcaptcha[validation]" value="<%= token %>" />
+    <img src="<%= image %>" />
+  </div>
+END

data/lib/kamcaptcha/helper.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module Kamcaptcha
   module Helper
     DEFAULT_LABEL = "Please type the characters in the image below"
@@ -5,16 +7,22 @@ module Kamcaptcha
     # Usage: <%= kamcaptcha :label => "Please prove that you're a human" %>
     def kamcaptcha(options = {})
       label = options.fetch(:label, DEFAULT_LABEL)
+      template = options.fetch(:template, Kamcaptcha.template)
+
       image = Kamcaptcha.random
+
       token = image.split(".").first
+      token = instance_exec(token, &Kamcaptcha::Token.generator) if Kamcaptcha::Token.generator
+
+      image = File.join('/', Kamcaptcha.prefix, image)
+
+      instance_exec(token, &Kamcaptcha::Token.store) if Kamcaptcha::Token.store
+
+      # Makes sure the ERB template only gets these variables: label, token, image
+      form = ERB.new(template).result(OpenStruct.new(:label => label, :token => token, :image => image).send(:binding))
 
-      <<-FORM
-        <div class="kamcaptcha">
-          <label for="kamcaptcha[input]">#{label}</label><input type="text" id="kamcaptcha[input]" name="kamcaptcha[input]" />
-          <input type="hidden" name="kamcaptcha[validation]" value="#{token}" />
-          <img src="#{image}" />
-        </div
-      FORM
+      form = form.html_safe if form.respond_to?(:html_safe)
+      form
     end
 
   end

data/lib/kamcaptcha/token.rb

@@ -0,0 +1,19 @@
+module Kamcaptcha
+  module Token
+    class << self
+      attr_accessor :generator, :lookup, :store
+
+      def valid?(validation, input)
+        input = Kamcaptcha.encrypt(input.to_s.delete(" ").downcase)
+        input = instance_exec(input, &generator) if generator
+
+        input == validation
+      end
+    end
+  end
+end
+
+# Default form lookup
+Kamcaptcha::Token.lookup = lambda do
+  params[:kamcaptcha][:validation]
+end

data/lib/kamcaptcha/validation.rb

@@ -5,7 +5,9 @@ module Kamcaptcha
       return false unless params.respond_to?(:key?)
       return false unless params.key?(:kamcaptcha)
 
-      Kamcaptcha.valid?(params[:kamcaptcha][:input], params[:kamcaptcha][:validation])
+      token = instance_exec(&Kamcaptcha::Token.lookup)
+
+      Kamcaptcha::Token.valid?(token, params[:kamcaptcha][:input])
     end
   end
 end

data/test/test_helper.rb

@@ -7,7 +7,7 @@ require "minitest/autorun"
 Bundler.require
 
 require "RMagick"
-require "debugger" unless ENV["TRAVIS"]
+require "debugger" unless ENV["TRAVIS"] || RUBY_VERSION.start_with?("1.8")
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 

data/test/unit/test_generator.rb

@@ -1,7 +1,6 @@
 require File.expand_path("test/test_helper")
 
 describe Kamcaptcha::Generator do
-
   describe Kamcaptcha::Generator::RandomWordGenerator do
     subject { Kamcaptcha::Generator::RandomWordGenerator.new("3-10") }
 

data/test/unit/test_helper.rb

@@ -17,5 +17,70 @@ describe Kamcaptcha::Helper do
     it "uses a default label" do
       assert_match /#{Kamcaptcha::Helper::DEFAULT_LABEL}/, subject
     end
+
+    it "uses the token" do
+      assert_match /value="hello"/, subject
+    end
+
+    describe "should use the token storage if it exists" do
+      before(:all) { @store, Kamcaptcha::Token.store = Kamcaptcha::Token.store, lambda {|token| @token = token}}
+      after(:all) { Kamcaptcha::Token.store = @store }
+
+      it "should set the storage" do
+        subject # will store the token
+
+        assert_equal "hello", @token
+      end
+    end
+
+    describe "html safety" do
+      before(:all) do
+        class String
+          def html_safe
+            "safe"
+          end
+        end
+      end
+
+      after(:all) do
+        class String
+          remove_method :html_safe
+        end
+      end
+
+      it "should call #html_safe" do
+        assert_equal "safe", subject
+      end
+    end
+
+    describe "image path" do
+      before(:all) { @prefix, Kamcaptcha.prefix = Kamcaptcha.prefix, "omg/123" }
+      after(:all) { Kamcaptcha.prefix = @prefix }
+
+      subject { Kamcaptcha.stub(:random, "hello.png") { kamcaptcha(:template => "<%= image %>") } }
+
+      it "should prefix image path" do
+        assert_equal "/omg/123/hello.png", subject
+      end
+    end
+
+    describe "should use custom generator if it exists" do
+      before(:all) { @generator, Kamcaptcha::Token.generator = Kamcaptcha::Token.generator, lambda {|_| "token"}}
+      after(:all) { Kamcaptcha::Token.generator = @generator }
+
+      subject { Kamcaptcha.stub(:random, "hello.png") { kamcaptcha(:template => "<%= token %>") } }
+
+      it "should use the custom generator" do
+        assert_equal "token", subject
+      end
+    end
+
+    describe "when given a template" do
+      subject { Kamcaptcha.stub(:random, "hello.png") { kamcaptcha(:template => "this-isnt-real") } }
+
+      it "should use custom template" do
+        assert_equal "this-isnt-real", subject
+      end
+    end
   end
 end

data/test/unit/test_kamcaptcha.rb

@@ -1,8 +1,6 @@
 require File.expand_path("test/test_helper")
 
 describe Kamcaptcha do
-
   describe "#images" do
   end
-
 end

data/test/unit/test_token.rb

@@ -0,0 +1,28 @@
+require File.expand_path("test/test_helper")
+
+describe Kamcaptcha::Token do
+  describe "#valid?" do
+    let(:validation) { Kamcaptcha.encrypt("hello") }
+
+    it "should handle other types" do
+      refute Kamcaptcha::Token.valid?(validation, 123)
+    end
+
+    it "should handle spaces" do
+      assert Kamcaptcha::Token.valid?(validation, "h e l l   o")
+    end
+
+    it "should handle mixed case" do
+      assert Kamcaptcha::Token.valid?(validation, "HeLLo")
+    end
+
+    describe "with a custom generator" do
+      before(:all) { @generator, Kamcaptcha::Token.generator = Kamcaptcha::Token.generator, lambda {|_| "hello"}}
+      after(:all) { Kamcaptcha::Token.generator = @generator }
+
+      it "should call the generator" do
+        assert Kamcaptcha::Token.valid?("hello", "anything")
+      end
+    end
+  end
+end

metadata

@@ -1,118 +1,119 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: kamcaptcha
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: trollop
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rmagick
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: uuidtools
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 2
-        - 1
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.3
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.3
 description: Helps humankind with simpler captchas
 email: primdahl@me.com
-executables: 
+executables:
 - kamcaptcha
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -124,44 +125,37 @@ files:
 - lib/kamcaptcha.rb
 - lib/kamcaptcha/generator.rb
 - lib/kamcaptcha/helper.rb
+- lib/kamcaptcha/token.rb
 - lib/kamcaptcha/validation.rb
 - test/test_helper.rb
 - test/unit/test_generator.rb
 - test/unit/test_helper.rb
 - test/unit/test_kamcaptcha.rb
+- test/unit/test_token.rb
 - test/unit/test_validation.rb
 homepage: http://github.com/morten/kamcaptcha
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A captcha image generator that's a little less retarded
 test_files: []
-