rack-captchator 0.1.0

data/LICENSE

@@ -0,0 +1,10 @@
+LICENSE
+(The MIT License)
+
+Copyright © 2011 nyash
+
+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,40 @@
+### Configuration
+
+    [sudo] gem install rack-captchator
+
+````ruby
+## Gemfile
+gem 'rack-captchator', :require => 'rack/captchator'
+````
+Add the middleware in your app file
+
+#### Sinatra-like frameworks
+
+````ruby
+## app.rb
+use Rack::Captchator
+helpers Rack::Captchator::Helpers
+````
+
+#### Example
+
+````haml
+## form.haml
+%form{:action => '/someroute', :method => 'post'}
+  = captcha_image_tag
+  = captha_answer_tag
+  %input{:type => "submit", :value => "submit"}
+
+## app.rb
+post '/someroute' do
+  if captcha_valid?
+    # your logic when it passed
+    else
+    # your logic when it failed
+  end
+end
+````
+
+#### Copyright
+
+Copyright (c) 2011 nyash. See LICENSE for details.

data/lib/rack/captchator.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../captchator/helpers', __FILE__)
+require 'open-uri'
+
+module Rack
+
+  class Captchator
+
+    ANSWER_URL = 'http://captchator.com/captcha/check_answer'
+    IMAGE_URL = 'http://captchator.com/captcha/image'
+    ANSWER_FIELD = 'captchator_answer'
+    SESSION_FIELD = 'captchator_session'
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.params[SESSION_FIELD]
+        result = validate(request.params[SESSION_FIELD],
+                          request.params[ANSWER_FIELD])
+        env['captchator.valid'] = result
+      end
+      @app.call(env)
+    end
+
+    def validate(session, answer)
+      !open("#{ANSWER_URL}/#{session}/#{answer}").read.to_i.zero? rescue false
+    end
+
+  end
+
+end

data/lib/rack/captchator/helpers.rb

@@ -0,0 +1,47 @@
+require 'securerandom'
+
+module Rack
+
+  class Captchator
+
+    module Helpers
+
+      # A helper method that outputs an image tag containing captcha
+      # @param [Hash] options
+      # @example You can provide key-value pairs to add additional attributes
+      #   captcha_image_tag(:class => "foo", :id => "bar", :alt => "baz")
+      #   # 'alt' attribute defaults to 'captcha'
+      def captcha_image_tag(options={})
+        options = {:alt => "captcha"}.merge!(options)
+        %Q{<input type='hidden' name='#{Rack::Captchator::SESSION_FIELD}' value='#{captcha_session}' />
+        <img src='#{Rack::Captchator::IMAGE_URL}/#{captcha_session}' #{attrify(options)}/>}
+      end
+
+      # A helper method that outputs a text field tag for answering the captcha
+      # @param [Hash] options
+      # @example You can provide key-value pairs to add additional attributes
+      #   captcha_answer_tag(:class => "foo", :id => "bar")
+      def captcha_answer_tag(options={})
+        %Q{<input type='text' name='#{Rack::Captchator::ANSWER_FIELD}' #{attrify(options)}/>}
+      end
+
+      # A helper method that checks whether the captcha was answered correctly
+      def captcha_valid?
+        request.env['captchator.valid']
+      end
+
+      def captcha_session
+        @captcha_session ||= SecureRandom.hex
+      end
+
+      private
+
+      def attrify(options)
+        options.map { |kv| kv.map { |e| e.to_s } }.reduce("") { |r, n| r << "#{n[0]}='#{n[1]}' " }
+      end
+      
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: rack-captchator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- nyash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-17 00:00:00.000000000 +02:00
+default_executable: 
+dependencies: []
+description: A very simple rack captcha middleware via captchator.com API
+email:
+- nyashh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/captchator/helpers.rb
+- lib/rack/captchator.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/nyash/rack_captchator
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Rack Captcha middleware
+test_files: []