rack-attack-recaptcha 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d867b620635d9c9982cb3de3d29ea2ccfa31978e
+  data.tar.gz: 5ae0d7485b457f2f3371b2ad1a56dbfdee35d2f7
+SHA512:
+  metadata.gz: c589069fdc7844543f70b124f8a06c0d30e65d30a5a82366b6b73191d01f8024ac6a16a558d55ade91ff79e4bf24b0e72753fe59589d1cf702c309c875068451
+  data.tar.gz: 70ee51e0dc169413fac883117a1b9930bebc882ab94fc6b41f12b4206b3186ad263514efeec032c0c27bc12b63a8d0fbe4ced74bfb8ae35a5b07eff0785742d1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Omer Rauchwerger
+
+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.md

@@ -0,0 +1,81 @@
+# Rack::Attack::Recaptcha
+
+rack-attack-recaptcha allows you to easily respond to requests that get
+throttled by [rack-attack](https://github.com/kickstarter/rack-attack) by showing a captcha instead of the "Retry
+later" message you get with [rack-attack](https://github.com/kickstarter/rack-attack). This will allow you to keep
+your app functional even in the event of an attack from a public
+IP, for example, since legit users who share that IP will still be able
+to access the app by entering a captcha.
+
+rack-attack-recaptcha works similarly to [recaptch](http://github.com/ambethia/recaptcha). It gives you 2 helper methods
+(`recaptcha_tags_if_under_attack` for views and
+`verify_recaptcha_if_under_attack` for controllers) which will simply
+call `recaptcha_tags` or `verify_recaptcha` (provided by [recaptcha](http://github.com/ambethia/recaptcha)) accordingly when the current
+request should be throttled. If the request is not part of
+an attack,
+`verify_tags_if_under_attack` will display nothing and
+`verify_recaptcha_if_under_attack` will simply return `true`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-attack-recaptcha'
+
+And then execute:
+
+    $ bundle
+
+Tell your app to use the Rack::Attack middleware. For Rails 3+ apps:
+
+    # In config/application.rb
+    config.middleware.use Rack::Attack::Recaptcha
+
+To setup throttles, check out rack-attack's wiki.
+To setup Recaptcha credentials, check out [recaptcha](http://github.com/ambethia/recaptcha)'s wiki.
+
+## Usage
+
+After you've setup your Recaptcha credentials and defined some throttles, add `recaptcha_tags_if_under_attack` to each form you want to protect. Place it where
+you want the Recaptcha widget to appear.
+
+Example:
+
+    # app/views/foos/foo.html.erb
+
+    <%= form_for @foo do |f| %>
+      # ... additional lines truncated for brevity ...
+      <%= recaptcha_tags_if_under_attack %>
+      # ... additional lines truncated for brevity ...
+    <% end %>
+
+_(If the request is legit, `recaptcha_tags_if_under_attack` will render nothing.)_
+
+Now add `verify_recaptcha_if_under_attack` logic to each form action that you've
+protected:
+
+    # app/controllers/foos_controller.rb
+
+    def create
+      if verify_recaptcha_if_under_attack && @foo.save
+        # ...
+      else
+        # ...
+      end
+    end
+
+_(If the request is legit,
+`verify_recaptcha_if_under_attack` won't actually check the captcha and
+will simply return `true`)_
+
+Note that `recaptcha_tags_if_under_attack` and `verify_recaptcha_if_under_attack`
+pass all options to `recaptcha_tags` and `verify_recaptcha` so you can
+use all the configuration values that are provided by [recaptcha](http://github.com/ambethia/recaptcha). (See [recaptcha](http://github.com/ambethia/recaptcha)'s documentation for a list of all the configuration options)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :test do
+  $LOAD_PATH.unshift('lib', 'spec')
+  Dir.glob('./spec/**/*_spec.rb') { |f| require f }
+end

data/lib/rack/attack/recaptcha/client_helper.rb

@@ -0,0 +1,11 @@
+module Rack
+  module Attack
+    module Recaptcha
+      module ClientHelper
+        def recaptcha_tags_if_under_attack(options={})
+          recaptcha_tags(options) if request.env["rack.attack.use_recaptcha"]
+        end
+      end
+    end
+  end
+end

data/lib/rack/attack/recaptcha/rails.rb

@@ -0,0 +1,4 @@
+require "recaptcha/rails"
+
+ActionView::Base.send(:include, Rack::Attack::Recaptcha::ClientHelper)
+ActionController::Base.send(:include, Rack::Attack::Recaptcha::VerificationHelper)

data/lib/rack/attack/recaptcha/verification_helper.rb

@@ -0,0 +1,15 @@
+module Rack
+  module Attack
+    module Recaptcha
+      module VerificationHelper
+        def verify_recaptcha_if_under_attack(options={})
+          if request.env["rack.attack.use_recaptcha"]
+            verify_recaptcha(options)
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/attack/recaptcha/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Attack
+    module Recaptcha
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/rack/attack/recaptcha.rb

@@ -0,0 +1,28 @@
+require "rack/attack"
+require "rack/attack/recaptcha/version"
+require "rack/attack/recaptcha/client_helper"
+require "rack/attack/recaptcha/verification_helper"
+require "rack/attack/recaptcha/rails"
+
+module Rack
+  module Attack
+    module Recaptcha
+      class << self
+        def new(app)
+          @rack_attack = Rack::Attack.new(app).tap { |attack|
+            attack.throttled_response = lambda { |env|
+              env["rack.attack.use_recaptcha"] = true
+              app.call(env)
+            }
+          }
+
+          self
+        end
+
+        def call(env)
+          @rack_attack.call(env)
+        end
+      end
+    end
+  end
+end

data/rack-attack-recaptcha.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/attack/recaptcha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-attack-recaptcha"
+  spec.version       = Rack::Attack::Recaptcha::VERSION
+  spec.authors       = ["Omer Lachish-Rauchwerger"]
+  spec.email         = ["omer@rauchy.net"]
+  spec.description   = %q{An extension for Rack::Attack that supports responding to throttled requests with Recaptcha tags}
+  spec.summary       = %q{Block & throttle abusive requests with Recaptcha}
+  spec.homepage      = "http://github.com/rauchy/rack-attack-recaptcha"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'activesupport', '>= 3.0.0'
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0.2"
+
+  spec.add_dependency "rack-attack"
+  spec.add_dependency "recaptcha"
+end

data/spec/client_helper_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+require "ostruct"
+
+class DummyView
+  include Rack::Attack::Recaptcha::ClientHelper
+
+  def recaptcha_tags(options)
+    "yay recaptcha! #{options[:foo]}!"
+  end
+
+  def request
+    @request ||= OpenStruct.new(env: {})
+  end
+end
+
+module Rack
+  module Attack
+    module Recaptcha
+      describe ClientHelper do
+        describe ".recaptcha_tags_if_under_attack" do
+          it "delegates to Recaptcha if under attack" do
+            dummy_view = DummyView.new
+            dummy_view.request.env["rack.attack.use_recaptcha"] = true
+
+            tags = dummy_view.recaptcha_tags_if_under_attack(foo: "yay")
+
+            tags.must_equal("yay recaptcha! yay!")
+          end
+
+          it "does nothing when not under attack" do
+            dummy_view = DummyView.new
+
+            tags = dummy_view.recaptcha_tags_if_under_attack(foo: "yay")
+
+            tags.must_be_nil
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rack_attack_recaptcha_spec.rb

@@ -0,0 +1,41 @@
+require_relative "spec_helper"
+
+describe "Rack::Attack::Recaptcha" do
+  include Rack::Test::Methods
+
+  def set_last_env(env)
+    @last_env = env
+  end
+
+  def app
+    that = self
+    Rack::Builder.new {
+      use Rack::Attack::Recaptcha
+      run lambda {|env| that.set_last_env(env) ; [200, {}, ["Hello World"]]}
+    }.to_app
+  end
+
+  before do
+    @bad_ip = "1.2.3.4"
+    Rack::Attack.cache.store = ActiveSupport::Cache::MemoryStore.new
+    Rack::Attack.throttle("req/ip", :limit => 1, :period => 1) { |req| req.ip }
+  end
+
+  it "always delegates request to the underlying app" do
+    get "/", {}, "REMOTE_ADDR" => @bad_ip
+
+    last_response.body.must_equal "Hello World"
+  end
+
+  it "doesn't add a recaptcha flag to the environment when throttle is below the limit" do
+    get "/", {}, "REMOTE_ADDR" => @bad_ip
+
+    @last_env.keys.wont_include "rack.attack.use_recaptcha"
+  end
+
+  it "adds a recaptcha flag to the environment when hitting the throttle limit" do
+    10.times { get "/", {}, "REMOTE_ADDR" => @bad_ip }
+
+    @last_env["rack.attack.use_recaptcha"].must_equal true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "minitest/autorun"
+require "minitest/pride"
+require "rack/test"
+require "rack/attack/recaptcha"
+require "active_support"
+
+require 'rspec/mocks'
+
+module MinitestRSpecMocksIntegration
+  include ::RSpec::Mocks::ExampleMethods
+
+  def before_setup
+    ::RSpec::Mocks.setup
+    super
+  end
+
+  def after_teardown
+    super
+    ::RSpec::Mocks.verify
+  ensure
+    ::RSpec::Mocks.teardown
+  end
+end
+
+Minitest::Spec.send(:include, MinitestRSpecMocksIntegration)

data/spec/verification_helper_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+require "ostruct"
+
+class DummyController
+  include Rack::Attack::Recaptcha::VerificationHelper
+
+  def verify_recaptcha(options)
+    "yay recaptcha! #{options[:foo]}!"
+  end
+
+  def request
+    @request ||= OpenStruct.new(env: {})
+  end
+end
+
+module Rack
+  module Attack
+    module Recaptcha
+      describe ClientHelper do
+        describe ".verify_recaptcha_if_under_attack" do
+          it "delegates to Recaptcha if under attack" do
+            dummy_controller = DummyController.new
+            dummy_controller.request.env["rack.attack.use_recaptcha"] = true
+
+            verification = dummy_controller.verify_recaptcha_if_under_attack(foo: "yay")
+
+            verification.must_equal("yay recaptcha! yay!")
+          end
+
+          it "returns true by default when not under attack" do
+            dummy_controller = DummyController.new
+
+            verification = dummy_controller.verify_recaptcha_if_under_attack(foo: "yay")
+
+            verification.must_equal true
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: rack-attack-recaptcha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Omer Lachish-Rauchwerger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: rack-attack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: recaptcha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An extension for Rack::Attack that supports responding to throttled requests
+  with Recaptcha tags
+email:
+- omer@rauchy.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/attack/recaptcha.rb
+- lib/rack/attack/recaptcha/client_helper.rb
+- lib/rack/attack/recaptcha/rails.rb
+- lib/rack/attack/recaptcha/verification_helper.rb
+- lib/rack/attack/recaptcha/version.rb
+- rack-attack-recaptcha.gemspec
+- spec/client_helper_spec.rb
+- spec/rack_attack_recaptcha_spec.rb
+- spec/spec_helper.rb
+- spec/verification_helper_spec.rb
+homepage: http://github.com/rauchy/rack-attack-recaptcha
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Block & throttle abusive requests with Recaptcha
+test_files:
+- spec/client_helper_spec.rb
+- spec/rack_attack_recaptcha_spec.rb
+- spec/spec_helper.rb
+- spec/verification_helper_spec.rb