kamcaptcha 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg/
+tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without test
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - ree

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :test do
+  gem "ruby-debug", "~> 0.10.4", :require => nil, :platforms => :ruby_18
+  gem "debugger",   "~> 1.1.1",  :require => nil, :platforms => :ruby_19
+end
+
+gemspec

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Morten Primdahl
+
+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.md

@@ -0,0 +1,52 @@
+# Kamcaptcha
+
+A captcha system that uses less ridiculous images than ReCAPTCHA. Kamcaptcha has two somewhat independent parts to it, a generator for building the word images to present, and then a runtime configuration for checking validity of what gets submitted.
+
+## Generating images
+
+This is something you do locally, probably just once. You need to generate a series of images for your application to serve, using the kamcaptcha command line tool. The tool depends on RMagick being installed, so:
+
+1. `gem install rmagick`
+2. kamcaptcha --help
+
+And then generate the images with your preferences. If you specify a salt, make sure to use that same salt when you configure your application runtime. If you do not specify a salt, kamcaptcha will generate you an appropriate one to use, it looks like this:
+
+```sh
+$ kamcaptcha  --count 3 /tmp
+Generating 3 words into /tmp
+
+  1 /tmp/d519172b9cdfb2de5a5b30cf60836defc9b393f0e38a680937fcd5179467b191.png
+  2 /tmp/a235210981703ca66e6d44450c39d42f40ad482bf165401a485b0d3e6c98e3e8.png
+  3 /tmp/4ae2941beeea48773243cbf1366520c32dcc7b6375630c0e65bdf313df164ddc.png
+
+Remember to set Kamcaptcha.salt = '58be24c9f6d0293ce2c9316fca1a6ec65d04c9156482b5ae51a267e022ba5a5c' in your application
+```
+
+## Runtime configuration
+
+Presumably, Kamcaptcha will be used primarily with Rails, so the following instructions are Rails centric although there's nothing Rails specific about Kamcaptcha.
+
+You need to configure Kamcaptcha in e.g. an initializer:
+
+```ruby
+Kamcaptcha.salt = '58be24c9f6d0293ce2c9316fca1a6ec65d04c9156482b5ae51a267e022ba5a5c'
+Kamcaptcha.path = File.join(Rails.root, "app", "assets", "images", "kampcaptcha")
+
+# Optionally make use of the included form helper and and validations
+ActionController::Base.send(:helper, Kamcaptcha::Helper)
+ActionController::Base.send(:include, Kamcaptcha::Validation)
+```
+
+You can now use Kamcaptcha in your views:
+
+```ruby
+<%= kamcaptcha :label => "Please type in the letters below" %>
+```
+
+And in your controllers:
+
+```ruby
+return head(:bad_request) unless kamcaptcha_validates?
+```
+
+You can write your own helper and controller logic easily, take a look at the source.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default do
+  sh "bundle exec rake test"
+end

data/bin/kamcaptcha

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler"
+
+require "kamcaptcha"
+require "kamcaptcha/generator"
+
+require "trollop"
+require "digest"
+
+ARGV << "--help" if ARGV.empty?
+
+opts = Trollop.options do
+  banner <<-EOS
+Captcha word library generator. Builds images of words to present to users.
+
+  kamcaptcha [options] <output directory>
+
+Usage examples:
+  kamcaptcha tmp/
+  kamcaptcha --count 100 tmp/
+  kamcaptcha --height 100 --width 300 tmp/
+  kamcaptcha --length 8 --format gif tmp/
+
+A default run creates a "./tmp" directory and generates 10 random five character word PNG images, each 240x50 pixels in size.
+
+Full list of options:
+EOS
+
+  opt :salt, "Salt to use, if not specified one will be generated"
+  opt :count, "How many words to generate", :default => 10
+  opt :height, "Height of the word image in pixels", :default => 50
+  opt :width, "Width of the word image in pixesks", :default => 240
+  opt :length, "Length of the word in number of characters", :default => 5
+  opt :format, "Image file format", :default => "png"
+end
+
+if ARGV.empty? || !File.exist?(ARGV[0])
+  puts "Output directory does not exist"
+  exit 1
+end
+
+Kamcaptcha.salt = opts[:salt] || Digest::SHA2.hexdigest((0...64).map { rand(150).chr }.join)
+
+puts "Generating #{opts[:count]} words into #{ARGV[0]}\n\n"
+
+opts[:count].times do |i|
+  puts "\t#{i+1}\t"+Kamcaptcha::Generator.generate(ARGV[0], opts)
+end
+
+puts "\nRemember to set Kamcaptcha.salt = '#{Kamcaptcha.salt}' in your application\n"
+

data/kamcaptcha.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new "kamcaptcha", "0.0.1" 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" ]
+  s.email       = "primdahl@me.com"
+  s.homepage    = "http://github.com/morten/kamcaptcha"
+  s.files       = `git ls-files`.split("\n")
+  s.license     = "MIT"
+
+  s.add_runtime_dependency("trollop", ">= 2.0")
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("rmagick")
+  s.add_development_dependency("minitest")
+  s.add_development_dependency("uuidtools", ">= 2.1.3")
+
+  s.executables << "kamcaptcha"
+end

data/lib/kamcaptcha.rb

@@ -0,0 +1,28 @@
+require "digest"
+
+# 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
+
+  def self.random
+    images[rand(images.size)]
+  end
+
+  def self.images
+    @images ||= Dir.glob("#{path}/*.*").map { |f| File.basename(f) }
+  end
+
+  def self.valid?(input, validation)
+    input = input.to_s.delete(" ").downcase
+    encrypt(input) == validation
+  end
+
+  def self.encrypt(string)
+    raise "You must configure a salt" if Kamcaptcha.salt.nil?
+    Digest::SHA2.hexdigest("#{salt}::#{string}")
+  end
+end

data/lib/kamcaptcha/generator.rb

@@ -0,0 +1,73 @@
+require "rubygems"
+
+begin
+  require "rmagick"
+rescue LoadError => e
+  puts "RMagick required to run the generator, gem install rmagick"
+  return
+end
+
+module Kamcaptcha
+  class Generator
+    DEFAULTS = {
+      :chars  => "23456789ABCDEFGHJKLMNPQRSTUVXYZ".split(""),
+      :width  => 240,
+      :height => 50,
+      :length => 5,
+      :format => "png"
+    }
+
+    def self.generate(path, options = {})
+      options = DEFAULTS.merge(options)
+
+      word  = generate_word(options[:chars], options[:length])
+      image = build_image(word, options[:width], options[:height])
+
+      name  = word.delete(" ").downcase
+      file  = File.join(path, Kamcaptcha.encrypt(name) + ".#{options[:format]}")
+
+      image.write(file)
+      image.destroy!
+
+      file
+    end
+
+    def self.generate_word(chars, size)
+      (1..size).map { chars[rand(chars.size)] }.join(" ")
+    end
+
+    def self.build_image(word, width, height)
+      text_img  = Magick::Image.new(width, height)
+      black_img = Magick::Image.new(width, height) do
+        self.background_color = "black"
+      end
+
+      text_img.annotate(Magick::Draw.new, 0, 0, 0, 0, word) do
+        self.gravity      = Magick::WestGravity
+        self.font_family  = "Verdana"
+        self.font_weight  = Magick::BoldWeight
+        self.fill         = "#666666"
+        self.stroke       = "black"
+        self.stroke_width = 2
+        self.pointsize    = 44
+      end
+
+      # Apply a little blur and fuzzing
+      text_img        = text_img.gaussian_blur(1.2, 1.2)
+      text_img        = text_img.sketch(20, 30.0, 30.0)
+      text_img        = text_img.wave(3, 90)
+
+      # Now we need to get the white out
+      text_mask       = text_img.negate
+      text_mask.matte = false
+
+      # Add cut-out our captcha from the black image with varying tranparency
+      black_img.composite!(text_mask, Magick::CenterGravity, Magick::CopyOpacityCompositeOp)
+
+      text_img.destroy!
+      text_mask.destroy!
+
+      black_img
+    end
+  end
+end

data/lib/kamcaptcha/helper.rb

@@ -0,0 +1,21 @@
+module Kamcaptcha
+  module Helper
+    DEFAULT_LABEL = "Please type the characters in the image below"
+
+    # Usage: <%= kamcaptcha :label => "Please prove that you're a human" %>
+    def kamcaptcha(options = {})
+      label = options.fetch(:label, DEFAULT_LABEL)
+      image = Kamcaptcha.random
+      token = image.split(".").first
+
+      <<-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
+    end
+
+  end
+end

data/lib/kamcaptcha/validation.rb

@@ -0,0 +1,11 @@
+module Kamcaptcha
+  module Validation
+    def kamcaptcha_validates?
+      return false unless defined?(params)
+      return false unless params.respond_to?(:key?)
+      return false unless params.key?(:kamcaptcha)
+
+      Kamcaptcha.valid?(params[:kamcaptcha][:input], params[:kamcaptcha][:validation])
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require "bundler"
+
+require "minitest/spec"
+require "minitest/mock"
+require "minitest/autorun"
+
+Bundler.require
+
+require "debugger" unless ENV["TRAVIS"]
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "kamcaptcha"
+require "kamcaptcha/helper"
+require "kamcaptcha/validation"
+require "kamcaptcha/generator"
+
+Kamcaptcha.salt = Time.now.to_f.to_s

data/test/unit/test_generator.rb

@@ -0,0 +1,17 @@
+describe Kamcaptcha::Generator do
+  describe "#generate_word" do
+    it "builds a word by the given chars and length" do
+      word = Kamcaptcha::Generator.generate_word([ "a", "b" ], 6)
+      assert_equal 6, word.split(" ").size
+      assert_match /[ab ]+/, word
+    end
+  end
+
+  describe "#generate" do
+    it "generates a file" do
+      file = Kamcaptcha::Generator.generate("/tmp")
+      assert File.exist?(file)
+      File.unlink(file)
+    end
+  end
+end

data/test/unit/test_helper.rb

@@ -0,0 +1,19 @@
+describe Kamcaptcha::Helper do
+  include Kamcaptcha::Helper
+
+  describe "#kamcaptcha" do
+    subject { Kamcaptcha.stub(:random, "hello.png") { kamcaptcha } }
+
+    describe "when given a label" do
+      subject { Kamcaptcha.stub(:random, "hello.png") { kamcaptcha(:label => "KAMCAPTCHA!") } }
+
+      it "uses that label" do
+        assert_match /KAMCAPTCHA!/, subject
+      end
+    end
+
+    it "uses a default label" do
+      assert_match /#{Kamcaptcha::Helper::DEFAULT_LABEL}/, subject
+    end
+  end
+end

data/test/unit/test_kamcaptcha.rb

@@ -0,0 +1,6 @@
+describe Kamcaptcha do
+
+  describe "#images" do
+  end
+
+end

data/test/unit/test_validation.rb

@@ -0,0 +1,47 @@
+describe Kamcaptcha::Validation do
+  def params
+    @params
+  end
+
+  include Kamcaptcha::Validation
+
+  describe "#kamcaptcha_validates?" do
+    describe "when @params.nil?" do
+      before { @params = nil }
+      it "returns false" do
+        refute kamcaptcha_validates?
+      end
+    end
+
+    describe "when @params.empty?" do
+      before { @params = {} }
+      it "returns false" do
+        refute kamcaptcha_validates?
+      end
+    end
+
+    describe "when a correct word was entered" do
+      before do
+        word    = "hello"
+        encoded = Kamcaptcha.encrypt(word)
+        @params = { :kamcaptcha => { :input => word, :validation => encoded }}
+      end
+
+      it "returns true" do
+        assert kamcaptcha_validates?
+      end
+    end
+
+    describe "when a wrong word was entered" do
+      before do
+        word    = "hello"
+        encoded = Kamcaptcha.encrypt(word)
+        @params = { :kamcaptcha => { :input => "other", :validation => encoded }}
+      end
+
+      it "returns false" do
+        refute kamcaptcha_validates?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: kamcaptcha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Morten Primdahl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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
+  prerelease: false
+  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
+        version: '0'
+  type: :development
+  prerelease: false
+  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
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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
+  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:
+- kamcaptcha
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- bin/kamcaptcha
+- kamcaptcha.gemspec
+- lib/kamcaptcha.rb
+- lib/kamcaptcha/generator.rb
+- lib/kamcaptcha/helper.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_validation.rb
+homepage: http://github.com/morten/kamcaptcha
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A captcha image generator that's a little less retarded
+test_files: []