kamcaptcha 0.0.1 → 0.1.0

data/Gemfile

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

data/README.md

@@ -1,4 +1,4 @@
-# Kamcaptcha
+# Kamcaptcha [![Build Status](https://secure.travis-ci.org/morten/kamcaptcha.png)](http://travis-ci.org/morten/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.
 

data/bin/kamcaptcha

@@ -21,7 +21,7 @@ Usage examples:
   kamcaptcha tmp/
   kamcaptcha --count 100 tmp/
   kamcaptcha --height 100 --width 300 tmp/
-  kamcaptcha --length 8 --format gif tmp/
+  kamcaptcha --length 8-10 --source random --format gif tmp/
 
 A default run creates a "./tmp" directory and generates 10 random five character word PNG images, each 240x50 pixels in size.
 
@@ -32,7 +32,8 @@ EOS
   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 :source, "How to generate words, [dictionary|random]", :default => "dictionary"
+  opt :length, "Length of the word in number of characters, or as a range e.g. 7-9", :default => "5"
   opt :format, "Image file format", :default => "png"
 end
 
@@ -43,10 +44,11 @@ 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"
+puts "Generating #{opts[:count]} words into #{ARGV[0]} - hang tight...\n\n"
 
-opts[:count].times do |i|
-  puts "\t#{i+1}\t"+Kamcaptcha::Generator.generate(ARGV[0], opts)
+files = Kamcaptcha::Generator.generate(ARGV[0], opts)
+files.each_with_index do |file, index|
+  puts "\t#{index+1}\t#{file}"
 end
 
 puts "\nRemember to set Kamcaptcha.salt = '#{Kamcaptcha.salt}' in your application\n"

data/kamcaptcha.gemspec

@@ -1,4 +1,4 @@
-Gem::Specification.new "kamcaptcha", "0.0.1" do |s|
+Gem::Specification.new "kamcaptcha", "0.1.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/generator.rb

@@ -1,39 +1,104 @@
-require "rubygems"
-
 begin
-  require "rmagick"
+  require "RMagick"
 rescue LoadError => e
   puts "RMagick required to run the generator, gem install rmagick"
-  return
+  exit
 end
 
 module Kamcaptcha
   class Generator
+    class WordGenerator
+      attr_reader :min, :max
+
+      def initialize(length)
+        if length.to_s =~ /^(\d+)$/
+          @min = @max = $1.to_i
+        elsif length =~ /^(\d+)-(\d+)$/
+          @min = [$1.to_i, $2.to_i].min
+          @max = [$1.to_i, $2.to_i].max
+        else
+          raise ArgumentError.new("Invalid word length specified: #{length}")
+        end
+      end
+    end
+
+    class RandomWordGenerator < WordGenerator
+      CHARS = "23456789ABCDEFGHJKLMNPQRSTUVXYZ".split("")
+
+      def generate
+        length  = min
+        length += Kernel.rand(max - min) unless max == min
+
+        (1..length).map { CHARS[rand(CHARS.size)] }.join(" ")
+      end
+    end
+
+    class DictionaryWordGenerator < WordGenerator
+      class << self
+        attr_accessor :dict # Use this to set a custom dictionary or dictionary generating function
+      end
+
+      def generate
+        words[rand(words.size)].split("").join(" ")
+      end
+
+      def words
+        @words ||= begin
+          if self.class.dict
+            if self.class.dict.respond_to?(:call)
+              w = self.class.dict.call
+            else
+              w = self.class.dict
+            end
+          else
+            w = default_dict
+          end
+
+          w.each_with_index { |word, i| w[i] = word.upcase }
+          w.select { |w| w.size >= min && w.size <= max && w !~ /O/ }
+        end
+      end
+
+      def default_dict
+        return File.read("/usr/share/dict/words").split("\n") if File.exists?("/usr/share/dict/words")
+        return File.read("/usr/dict/words").split("\n") if File.exists?("/usr/dict/words")
+
+        raise ArgumentError.new("Sorry, need a dictionary file")
+      end
+    end
+
     DEFAULTS = {
-      :chars  => "23456789ABCDEFGHJKLMNPQRSTUVXYZ".split(""),
       :width  => 240,
       :height => 50,
       :length => 5,
-      :format => "png"
+      :format => "png",
+      :count  => 1
     }
 
     def self.generate(path, options = {})
       options = DEFAULTS.merge(options)
 
-      word  = generate_word(options[:chars], options[:length])
-      image = build_image(word, options[:width], options[:height])
+      if options[:source] != "random"
+        source = DictionaryWordGenerator.new(options[:length])
+      else
+        source = RandomWordGenerator.new(options[:length])
+      end
+
+      files = []
 
-      name  = word.delete(" ").downcase
-      file  = File.join(path, Kamcaptcha.encrypt(name) + ".#{options[:format]}")
+      options[:count].times do
+        word  = source.generate
+        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!
+        image.write(file)
+        image.destroy!
 
-      file
-    end
+        files << file
+      end
 
-    def self.generate_word(chars, size)
-      (1..size).map { chars[rand(chars.size)] }.join(" ")
+      files
     end
 
     def self.build_image(word, width, height)

data/test/test_helper.rb

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

data/test/unit/test_generator.rb

@@ -1,15 +1,42 @@
+require File.expand_path("test/test_helper")
+
 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
+
+  describe Kamcaptcha::Generator::RandomWordGenerator do
+    subject { Kamcaptcha::Generator::RandomWordGenerator.new("3-10") }
+
+    it "delivers words of the specified size range" do
+      20.times do
+        word = subject.generate.delete(" ")
+
+        assert word.size >= 3, "Size mismatch #{word}"
+        assert word.size <= 10, "Size mismatch #{word}"
+
+        assert_match /[0-9A-Z]+/, word
+      end
+    end
+  end
+
+  describe Kamcaptcha::Generator::DictionaryWordGenerator do
+    after do
+      Kamcaptcha::Generator::DictionaryWordGenerator.dict = nil
+    end
+
+    subject { Kamcaptcha::Generator::DictionaryWordGenerator.new("1-5") }
+
+    it "delivers words from the dict" do
+      Kamcaptcha::Generator::DictionaryWordGenerator.dict = [ "foo", "fum" ]
+
+      20.times do
+        word = subject.generate.delete(" ")
+        assert [ "FOO", "FUM" ].member?(word), "Word #{word} not found"
+      end
     end
   end
 
   describe "#generate" do
     it "generates a file" do
-      file = Kamcaptcha::Generator.generate("/tmp")
+      file = Kamcaptcha::Generator.generate("/tmp", :source => "random").first
       assert File.exist?(file)
       File.unlink(file)
     end

data/test/unit/test_helper.rb

@@ -1,3 +1,5 @@
+require File.expand_path("test/test_helper")
+
 describe Kamcaptcha::Helper do
   include Kamcaptcha::Helper
 

data/test/unit/test_kamcaptcha.rb

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

data/test/unit/test_validation.rb

@@ -1,3 +1,5 @@
+require File.expand_path("test/test_helper")
+
 describe Kamcaptcha::Validation do
   def params
     @params

metadata

@@ -1,119 +1,118 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: kamcaptcha
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-09-12 00:00:00 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
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !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
+  requirement: &id002 !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'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
   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
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rmagick
   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
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: minitest
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !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
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 1
+        - 3
         version: 2.1.3
+  type: :development
+  version_requirements: *id006
 description: Helps humankind with simpler captchas
 email: primdahl@me.com
-executables:
+executables: 
 - kamcaptcha
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -132,28 +131,37 @@ files:
 - test/unit/test_kamcaptcha.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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A captcha image generator that's a little less retarded
 test_files: []
+