ankh 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+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,39 @@
+= ankh
+
+Ankh is the ancient Egyptian sign of life. 
+
+Use Ankh in your Rails (2.3.x or 3.0) projects to protect against bots and other spam producers. It asks a simple
+arithmatic question to verify that the poster is human.
+
+In your model:
+
+    validates_human :on => :create
+
+In your view (Rails 2 syntax shown below):
+
+    <%- obj.generate_human_question %>
+    <%- form_for obj do |f| -%>
+      <%= f.label :human_answer, obj.human_question %>
+      <%= f.text_field :human_answer %>
+      <%= f.hidden_field :salted_human_answer %>
+    <%- end -%>
+
+== TODO
+
+* Nice form helpers
+* I18n support
+* automated testing of Rails 2.3.x vs. 3.0
+ 
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ankh"
+    gem.summary = %Q{Protect against bots and other spam producers with simple mathematical questions}
+    gem.description = %Q{Use Ankh in your Rails (2.3.x or 3.0) projects to protect against bots and other spam producers. It asks a simple
+    arithmatic question to verify that the poster is human.}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/ankh"
+    gem.authors = ["Dan Pickett"]
+    gem.add_dependency "activerecord", ">= 2.3.8"
+    gem.add_dependency "activesupport", ">= 2.3.8"
+    gem.add_dependency "configatron", "2.6.3"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_development_dependency "mocha"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+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 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+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"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ankh.gemspec

@@ -0,0 +1,84 @@
+# 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{ankh}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Pickett"]
+  s.date = %q{2010-10-13}
+  s.description = %q{Use Ankh in your Rails (2.3.x or 3.0) projects to protect against bots and other spam producers. It asks a simple
+    arithmatic question to verify that the poster is human.}
+  s.email = %q{dpickett@enlightsolutions.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ankh.gemspec",
+     "features/ankh.feature",
+     "features/step_definitions/ankh_steps.rb",
+     "features/support/env.rb",
+     "lib/ankh.rb",
+     "lib/ankh/model.rb",
+     "lib/ankh/question.rb",
+     "lib/ankh/rails/legacy.rb",
+     "lib/ankh/validations/human.rb",
+     "spec/ankh/model_spec.rb",
+     "spec/ankh/question_spec.rb",
+     "spec/ankh_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/active_record_spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dpickett/ankh}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Protect against bots and other spam producers with simple mathematical questions}
+  s.test_files = [
+    "spec/ankh/model_spec.rb",
+     "spec/ankh/question_spec.rb",
+     "spec/ankh_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/active_record_spec_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_runtime_dependency(%q<activerecord>, [">= 2.3.8"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.8"])
+      s.add_runtime_dependency(%q<configatron>, ["= 2.6.3"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.8"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+      s.add_dependency(%q<configatron>, ["= 2.6.3"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.8"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+    s.add_dependency(%q<configatron>, ["= 2.6.3"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/features/ankh.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'ankh'
+
+require 'spec/expectations'

data/lib/ankh.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "active_record"
+require "digest/sha1"
+require "configatron"
+
+require "ankh/rails/legacy"
+
+require "ankh/question"
+require "ankh/validations/human"
+
+require "ankh/model"
+
+module Ankh
+  def self.salt=(salt)
+    configatron.ankh.salt = salt
+  end
+  
+  def self.salt
+    configatron.ankh.salt ||= 'fqphweuyir8y34295yu234y5219pthfsdlhgfsaf'
+  end
+  
+  def self.encrypt(item_to_encrypt)
+    Digest::SHA1.hexdigest("--#{salt}--#{item_to_encrypt}")
+  end
+end

data/lib/ankh/model.rb

@@ -0,0 +1,17 @@
+module Ankh
+  module Model
+    def self.included(base)
+      base.send(:attr_accessor, :human_answer)
+      base.send(:attr_reader, :human_question)
+      base.send(:attr_accessor, :salted_human_answer)
+    end
+    
+    def generate_human_question
+      question = Ankh::Question.generate
+      @human_question = question.question
+      self.salted_human_answer = Ankh.encrypt(question.answer)
+    end
+  end
+end
+
+ActiveRecord::Base.extend(Ankh::Validations::HelperMethods)

data/lib/ankh/question.rb

@@ -0,0 +1,23 @@
+module Ankh
+  class Question
+    OPERATIONS = [
+      "+",
+      "-"
+    ]
+    
+    attr_reader :first_number, :second_number, :operation, :question, :answer
+    
+    def initialize
+      @second_number = rand(9)
+      @first_number = @second_number + rand(9)
+      @operation = OPERATIONS[rand(2)]
+      
+      @question = "What is #{first_number} #{operation} #{second_number}?"
+      @answer = @first_number.send(@operation, @second_number)
+    end
+    
+    def self.generate
+      new
+    end
+  end
+end

data/lib/ankh/rails/legacy.rb

@@ -0,0 +1,41 @@
+module Ankh
+  module Legacy
+    module ActiveRecord
+      def extended(base)
+        base.class_attribute :_validators
+      end
+      
+      def validates_with(*args, &block)
+        _validators ||= {}
+        
+        options = args.extract_options!
+        args.each do |klass|
+          validator = klass.new(options, &block)
+          validator.setup(self) if validator.respond_to?(:setup)
+
+          if validator.respond_to?(:attributes) && !validator.attributes.empty?
+            validator.attributes.each do |attribute|
+              _validators[nil] ||= []
+              _validators[attribute.to_sym] << validator
+            end
+          else
+            _validators[nil] ||= []
+            _validators[nil] << validator
+          end
+
+          validate(validator, options)
+        end
+      end
+      
+      private
+        def _merge_attributes(attr_names)
+          options = attr_names.extract_options!
+          options.merge(:attributes => attr_names.flatten)
+        end
+    end
+  end
+end
+
+unless ActiveRecord::Base.respond_to?(:validates_with)
+  ActiveRecord::Base.extend Ankh::Legacy::ActiveRecord
+end

data/lib/ankh/validations/human.rb

@@ -0,0 +1,33 @@
+module Ankh
+  module Validations
+    class HumanValidator
+      def initialize(options = {})
+        @options ||= options
+      end
+      
+      def validate(record)
+        if has_valid_answer?(record)
+          record.errors.add(:human_answer, @options[:message] || "is not valid")
+          record.human_answer = ""
+        end
+      end
+      
+      private
+      def has_valid_answer?(record)
+        record.salted_human_answer.present? && Ankh.encrypt(record.human_answer) != record.salted_human_answer
+      end
+    end
+    
+    module HelperMethods
+      def validates_human(options = {})
+        self.send(:include, Ankh::Model) unless probably_included_already?
+        validates_with HumanValidator, options
+      end
+      
+      private
+      def probably_included_already?
+        self.respond_to?(:human_question) && self.respond_to?(:human_answer)
+      end
+    end
+  end
+end

data/spec/ankh/model_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Ankh::Model do
+  INVALID_ANSWER = "3241235" #this answer will never be valid due to constraints
+  class Post < ActiveRecord::Base
+    validates_human
+  end
+  
+  subject do 
+    p = Post.new
+    p.generate_human_question
+    p
+  end
+  
+  describe "generation" do
+    its(:human_question){ should_not be_nil }
+    its(:human_answer){ should be_blank }
+    
+    it "should have a salted human answer" do
+      subject.salted_human_answer.should_not be_blank
+    end
+  end
+  
+  it "should not save if I do not specify a human answer" do
+    subject.human_answer = ""
+    subject.save.should be_false
+    subject.errors[:human_answer].should_not be_nil
+  end
+  
+  it "should clear out the human answer if validation fails" do
+    subject.human_answer = INVALID_ANSWER
+    subject.save.should be_false
+    subject.human_answer.should be_blank
+  end
+  
+  it "should not save if I do not match the intended answer" do
+    subject.human_answer = INVALID_ANSWER
+    subject.save.should be_false
+    subject.errors[:human_answer].should_not be_nil
+  end
+  
+  it "should save if I match the intended answer" do
+    question = Ankh::Question.new
+    Ankh::Question.expects(:generate).returns(question)
+    
+    subject.human_answer = question.answer
+    subject.save.should be_true
+  end
+end

data/spec/ankh/question_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Ankh::Question do
+  subject { Ankh::Question.generate }
+  
+  its(:question){ should_not be_nil }
+  its(:answer){ should_not be_nil }
+  
+  it "should have a valid operation" do
+    Ankh::Question::OPERATIONS.should include(subject.operation)
+  end
+  
+  it "should have a first number less than 20" do
+    subject.first_number.should < 20
+  end
+  
+  it "should have a second number less than 10" do
+    subject.second_number.should < 10
+  end
+  
+  describe "the question" do
+    it "should contain the first number" do
+      subject.question.should =~ /#{subject.first_number}/
+    end
+    
+    it "should contain the second number" do
+      subject.question.should =~ /#{subject.second_number}/
+    end
+    
+    it "should contain the operation" do
+      subject.question.should =~ /#{Regexp.escape(subject.operation)}/
+    end
+  end
+  
+  describe "the answer" do
+    it "should perform the operation on the two numbers" do
+      subject.answer.should eql(subject.first_number.send(subject.operation, subject.second_number))
+    end
+  end
+end

data/spec/ankh_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Ankh" do
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ankh'
+require 'spec'
+require 'spec/autorun'
+require 'mocha'
+
+require 'support/active_record_spec_helper'
+Spec::Runner.configure do |config|
+  include ActiveRecordSpecHelper
+  
+  config.before(:all) do
+    create_tables
+  end
+  
+  config.after(:all) do
+    drop_tables
+  end
+  
+  config.mock_with :mocha
+end

data/spec/support/active_record_spec_helper.rb

@@ -0,0 +1,44 @@
+# taken from the state_machine gem
+# Load TestCase helpers
+require 'active_support/test_case'
+require 'active_record/fixtures'
+
+begin
+  require 'active_record/test_case'
+rescue LoadError
+  class ActiveRecord::TestCase < ActiveSupport::TestCase
+    # self.fixture_path = FIXTURES_ROOT
+    self.use_instantiated_fixtures = false
+    self.use_transactional_fixtures = true
+  end
+end
+
+# Establish database connection
+ActiveRecord::Base.establish_connection({'adapter' => 'sqlite3', 'database' => ':memory:'})
+# ActiveRecord::Base.logger = Logger.new("#{File.dirname(__FILE__)}/../../active_record.log")
+
+module ActiveRecordSpecHelper
+  TABLES = [
+    "posts"
+  ]
+  
+  def create_tables
+    each_table do |table_name| 
+      ActiveRecord::Base.connection.create_table table_name unless table_exists?(table_name)
+    end
+  end
+  
+  def drop_tables
+    each_table do |table_name| 
+      ActiveRecord::Base.connection.drop_table table_name if table_exists?(table_name)
+    end
+  end
+  
+  def table_exists?(table_name)
+    ActiveRecord::Base.connection.table_exists?(table_name)
+  end
+  
+  def each_table(&block)
+    TABLES.each { |table_name| block.call(table_name) }
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification 
+name: ankh
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 6
+        - 3
+        version: 2.6.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: |-
+  Use Ankh in your Rails (2.3.x or 3.0) projects to protect against bots and other spam producers. It asks a simple
+      arithmatic question to verify that the poster is human.
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ankh.gemspec
+- features/ankh.feature
+- features/step_definitions/ankh_steps.rb
+- features/support/env.rb
+- lib/ankh.rb
+- lib/ankh/model.rb
+- lib/ankh/question.rb
+- lib/ankh/rails/legacy.rb
+- lib/ankh/validations/human.rb
+- spec/ankh/model_spec.rb
+- spec/ankh/question_spec.rb
+- spec/ankh_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/active_record_spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dpickett/ankh
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Protect against bots and other spam producers with simple mathematical questions
+test_files: 
+- spec/ankh/model_spec.rb
+- spec/ankh/question_spec.rb
+- spec/ankh_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record_spec_helper.rb