textcaptcha 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in textcaptcha.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Drew Tempelmeyer
+
+MIT License
+
+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,62 @@
+= textcaptcha
+
+textcaptcha utilizies the textcaptcha.com API to help prevent SPAM. The idea behind the library is to be framework agnostic.
+
+== Configuring
+If you've not yet obtained an API key for textcaptcha.com, do so at http://textcaptcha.com/register.
+  Textcaptcha.configure do |config|
+    config.api_key = 'yourapikeyhere'
+  end
+
+== Retrieving a textCAPTCHA
+  captcha = Textcaptcha.obtain
+    # => { :question => "What's eight - 7?", :answers => [ "c4ca4238a0b923820dcc509a6f75849b", "f97c5d29941bfb1b2fdab0874906ab82" ] }
+
+== Validating an answer
+Validate the user's answer compared to the answers retrieved from Textcaptcha.obtain
+  captcha = Textcaptcha.obtain
+    # => { :question => "What's eight - 7?", :answers => [ "c4ca4238a0b923820dcc509a6f75849b", "f97c5d29941bfb1b2fdab0874906ab82" ] }
+  Textcaptcha.valid? 'sixteen', captcha[:answers]
+    # => false
+
+== Rails 3 Implementation
+Since textcaptcha remains framework agnostic, there's a bit more work to implement it, yet minimal.
+
+On the sign up form, retrieve the question and answer(s).
+  # app/controllers/users_controller.rb
+  # GET /users/new
+  def new
+    Textcaptcha.configure do |config|
+      config.api_key = 'yourapikeyhere'
+    end
+
+    captcha                   = Textcaptcha.obtain
+    session[:captcha_answers] = captcha[:answers]
+    @captcha_question         = captcha[:question]
+    @user                     = User.new
+  end
+
+  # POST /users
+  def create
+    user = User.new(params[:user])
+    if Textcaptcha.valid?(params[:captcha_answer], session[:captcha_answers]) && user.save
+      # ...
+    end
+  end
+
+In your view.
+  # app/views/users/new.html.erb
+  <%= label_tag 'captcha_answer', @captcha_question %>
+  <%= text_field_tag 'captcha_answer' %>
+
+== Contributing
+Be a hero in helping with the battle against spam.
+* Fork
+* Write test(s)
+* Implement
+* Submit pull request
+
+Or
+
+* Send me money
+

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = false
+end
+
+RDoc::Task.new do |rd|
+  README      = 'README.rdoc'
+  rd.main     = README
+  rd.rdoc_dir = 'doc'
+  rd.title    = 'textcaptcha'
+  rd.rdoc_files.include(README, 'lib/**/*.rb')
+end
+

data/lib/textcaptcha.rb

@@ -0,0 +1,39 @@
+require "textcaptcha/configuration"
+require "textcaptcha/version"
+require "digest/md5"
+require "httparty"
+
+module Textcaptcha
+  # The API URL for textcaptcha
+  URL = 'http://api.textcaptcha.com/'
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure variables. See Textcaptcha::Configuration
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    # Obtain the question and answer(s). Returns a hash with the question and answers. The answers are MD5 hashed values to be checked after submission.
+    #
+    # Textcaptcha.obtain # => { :question => "What's eight - 7?", :answers => [ "c4ca4238a0b923820dcc509a6f75849b", "f97c5d29941bfb1b2fdab0874906ab82" ] }
+    def obtain
+      api_response = HTTParty.get(URL << self.configuration.api_key)
+      { :question => api_response['captcha']['question'], :answers => Array.new(api_response['captcha']['answer']) }
+    end
+    alias :get :obtain
+
+    # Returns true if the answer is valid.
+    #
+    # == Parameters
+    # * <tt>answer</tt> - The answer provided by the user.
+    # * <tt>answers</tt> - The possible correct answers returned from <tt>obtain</tt>.
+    def valid?(answer, answers)
+      answers.include?(Digest::MD5.hexdigest(answer.to_s.lstrip.rstrip))
+    end
+
+  end
+
+end

data/lib/textcaptcha/configuration.rb

@@ -0,0 +1,7 @@
+module Textcaptcha #:nodoc:
+  # Store the configuration values for Textcaptcha
+  class Configuration
+    # * <tt>api_key</tt> - The API key that you received from textcaptcha.com
+    attr_accessor :api_key
+  end
+end

data/lib/textcaptcha/version.rb

@@ -0,0 +1,3 @@
+module Textcaptcha
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require "test/unit"
+require "textcaptcha"
+
+class Test::Unit::TestCase
+	def setup
+		Textcaptcha.configure do |config|
+			config.api_key = '7k7mhd0r3ack4gkwwsg8o0g0k9hk1abi'
+		end
+	end
+end
+

data/test/test_textcaptcha.rb

@@ -0,0 +1,24 @@
+require "helper"
+require "digest/md5"
+
+class TestTextcaptcha < Test::Unit::TestCase
+
+	def test_obtain
+		response = Textcaptcha.obtain
+		assert_equal false, response[:question].nil?
+		assert_equal true, response[:question].length > 0
+		assert_equal 'Array', response[:answers].class.to_s
+		assert_equal true, response[:answers].length > 0
+	end
+
+	def test_valid?
+		answers = [ Digest::MD5.hexdigest('three'), Digest::MD5.hexdigest('3') ]
+		assert_equal false, Textcaptcha.valid?('four', answers)
+		assert_equal false, Textcaptcha.valid?(4, answers)
+		assert_equal true, Textcaptcha.valid?('three', answers)
+		assert_equal true, Textcaptcha.valid?('3', answers)
+		assert_equal true, Textcaptcha.valid?(3, answers)
+	end
+
+end
+

data/textcaptcha.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/textcaptcha/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Drew Tempelmeyer"]
+  gem.email         = ["drewtemp@gmail.com"]
+  gem.description   = %q{Ruby gem to use the textcaptcha.com service}
+  gem.summary       = %q{Ruby gem to use the textcaptcha.com service}
+  gem.homepage      = "https://github.com/drewtempelmeyer/textcaptcha"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "textcaptcha"
+  gem.require_paths = ["lib"]
+  gem.version       = Textcaptcha::VERSION
+  gem.date          = "2012-01-19"
+
+  gem.add_dependency('httparty', '>= 0.8.1')
+
+  # Development dependencies
+  gem.add_development_dependency 'rake', '>= 0.9.2'
+  gem.add_development_dependency 'rdoc', '>= 2.5.0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: textcaptcha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Drew Tempelmeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70292534697440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70292534697440
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70292534696940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70292534696940
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70292534696480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70292534696480
+description: Ruby gem to use the textcaptcha.com service
+email:
+- drewtemp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/textcaptcha.rb
+- lib/textcaptcha/configuration.rb
+- lib/textcaptcha/version.rb
+- test/helper.rb
+- test/test_textcaptcha.rb
+- textcaptcha.gemspec
+homepage: https://github.com/drewtempelmeyer/textcaptcha
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1438809734930026122
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1438809734930026122
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby gem to use the textcaptcha.com service
+test_files:
+- test/helper.rb
+- test/test_textcaptcha.rb