rack-halt 0.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Kraybill
+
+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,108 @@
+# Rack::Halt
+
+A rack middleware for defining paths that halt the rack request. In
+many rack-compliant applications you may find the need to prevent
+certain requests from routing to the application. This is an
+alternative to instances when you cannot or do not want to write
+an Apache or Nginx location block and will be more performant,
+than trying to allow the Rails router, for example, handle.
+
+
+## Current Version
+
+0.0.1
+
+
+## Requirements
+
+* [Rack](http://rack.github.com/)
+
+
+## Installation
+
+### Gemfile
+
+Add this line to your application's Gemfile.
+
+```ruby
+gem 'rack-halt'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+### Manual
+
+Or install it yourself.
+
+```bash
+$ gem install rack-halt
+```
+
+
+## Usage
+
+### Sample rackup file
+
+```ruby
+gem 'rack-halt', '~> 0.0.1'
+require 'rack/halt'
+use Rack::Halt do
+  halt '/application/x-shockwave-application'
+  halt %r{\/text\/(css|javascript)}
+end
+```
+
+### Sample usage in a rails app
+```ruby
+config.middleware.insert_after(Rack::Lock, Rack::Halt) do
+  halt '/application/x-shockwave-flash'
+  halt %r{/text/(javascript|css)}
+end
+```
+
+
+## Authors
+
+* Chris Kraybill / [@ckraybill](https://github.com/ckraybill)
+
+
+## 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
+
+If you find bugs, have feature requests or questions, please
+[file an issue](https://github.com/ckraybill/rack-halt/issues).
+
+
+## License
+
+Copyright (c) 2013 Chris Kraybill
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/rack/halt.rb

@@ -0,0 +1,45 @@
+require 'rack'
+
+module Rack::Halt
+  autoload :Rule,    'rack/halt/rule'
+  autoload :RuleSet, 'rack/halt/rule_set'
+
+  class << self
+
+    def new(app, &rule_block)
+      @app = app
+      @rule_set = RuleSet.new
+      @rule_set.instance_eval(&rule_block) if block_given?
+
+      self
+    end
+
+    def call(env)
+      if matched_rule = find_first_matching_rule(env)
+        return [404, {"Content-Type" => "text/html"}, content_for(env)]
+      end
+      @app.call(env)
+    end
+
+  private
+
+    def find_first_matching_rule(env)
+      @rule_set.rules.detect { |rule| rule.matches?(env) }
+    end
+
+    def content_for(env)
+      env["REQUEST_METHOD"] == "HEAD" ? [] : content
+    end
+
+    def content
+      <<-EOS
+<html>
+<head><title>404 Not Found</title></head>
+<body>
+<h1>404 Not Found</h1>
+</body>
+</html>
+      EOS
+    end
+  end
+end

data/lib/rack/halt/rule.rb

@@ -0,0 +1,32 @@
+module Rack::Halt
+  class Rule
+    attr_reader :rule
+
+    def initialize(rule)
+      @rule = rule
+    end
+
+    def matches?(rack_env)
+      path = build_path_from_env(rack_env)
+      string_matches?(path, self.rule)
+    end
+
+  private
+
+    def build_path_from_env(env)
+      path = env['PATH_INFO'] || ''
+      path += "?#{env['QUERY_STRING']}" unless env['QUERY_STRING'].nil? || env['QUERY_STRING'].empty?
+      path
+    end
+
+    def string_matches?(string, matcher)
+      if matcher.is_a?(Regexp)
+        string =~ matcher
+      elsif matcher.is_a?(String)
+        string == matcher
+      else
+        false
+      end
+    end
+  end
+end

data/lib/rack/halt/rule_set.rb

@@ -0,0 +1,24 @@
+module Rack::Halt
+  class RuleSet
+    attr_reader :rules
+    def initialize #:nodoc:
+      @rules = []
+    end
+
+  protected
+    # Creates a halt rule that will stop subsequent middlewares from
+    # being called.
+    #
+    #  halt '/application/x-shockwave-flash'
+    #  halt '/text/css'
+    #  halt %r{\/text\/(css|javascript)}
+    def halt(rule)
+      add_rule rule
+    end
+
+  private
+    def add_rule(rule)
+      @rules << Rule.new(rule)
+    end
+  end
+end

data/lib/rack/halt/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Halt
+    VERSION = "0.0.1"
+  end
+end

data/rack-halt.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack/halt/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-halt"
+  gem.version       = Rack::Halt::VERSION
+  gem.authors       = ["Chris Kraybill"]
+  gem.email         = ["ckraybill@gmail.com"]
+  gem.description   = %q{Prevent matched paths from subsequent middleware calls}
+  gem.summary       = %q{Stop rack requests in their tracks}
+  gem.homepage      = %q{https://github.com/ckraybill/rack-halt}
+
+  gem.files         = [
+    "Gemfile",
+    "LICENSE.txt",
+    "Rakefile",
+    "README.md",
+    "lib/rack/halt.rb",
+    "lib/rack/halt/rule.rb",
+    "lib/rack/halt/rule_set.rb",
+    "lib/rack/halt/version.rb",
+    "rack-halt.gemspec"
+  ]
+  gem.executables   = []
+  gem.test_files    = [
+    "test/halt_test.rb",
+    "test/rule_set_test.rb",
+    "test/rule_test.rb",
+    "test/test_helper.rb"
+  ]
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rack'
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rack-test'
+end

data/test/halt_test.rb

@@ -0,0 +1,20 @@
+require_relative "test_helper"
+
+describe Rack::Halt do
+  allow_ok_requests
+
+  it "returns 404" do
+    get '/text/css'
+    assert_equal last_response.status, 404
+  end
+
+  it "renders not found content when request method is not HEAD" do
+    get '/text/javascript'
+    last_response.body.must_include '<h1>404 Not Found</h1>'
+  end
+
+  it "returns no body when request method is HEAD" do
+    head '/application/x-shockwave-application'
+    last_response.body.must_be_empty
+  end
+end

data/test/rule_set_test.rb

@@ -0,0 +1,21 @@
+require_relative "test_helper"
+
+describe Rack::Halt::RuleSet do
+
+  subject { Rack::Halt::RuleSet.new }
+
+  describe '.initialize' do
+    it "initializes an empty array of rules" do
+      subject.rules.must_equal []
+    end
+  end
+
+  describe '.halt' do
+    before { subject.send(:halt, '/test') }
+
+    it "adds a rule" do
+      subject.rules.size.must_equal 1
+      subject.rules.first.must_be_kind_of Rack::Halt::Rule
+    end
+  end
+end

data/test/rule_test.rb

@@ -0,0 +1,53 @@
+require_relative "test_helper"
+
+describe Rack::Halt::Rule do
+
+  subject { Rack::Halt::Rule }
+
+  describe '.initialize' do
+    let(:rule) { '/test' }
+
+    it "assigns the rule" do
+      subject.new(rule).rule.must_equal rule
+    end
+  end
+
+  describe ".matches?" do
+
+    describe "requests without query params" do
+      let(:env) { {'PATH_INFO' => '/test'} }
+
+      it "matches with an equivalent string" do
+        subject.new('/test').matches?(env).must_equal true
+      end
+
+      it "does not match with an unequal string" do
+        subject.new('/not-a-match').matches?(env).must_equal false
+      end
+
+      it "matches with a matching regexp" do
+        subject.new(%r(\/test)).matches?(env).wont_be_nil
+      end
+
+      it "does not match with a non-matching regexp" do
+        subject.new(%r(not-a-match)).matches?(env).must_be_nil
+      end
+    end
+
+    describe "requests with query params" do
+      let(:env) { {'PATH_INFO' => '/test', 'QUERY_STRING' => 'foo=bar'} }
+
+      it "matches with the same path and query string" do
+        subject.new('/test?foo=bar').matches?(env).must_equal true
+      end
+
+      it "does not match with a string containing the path but not the query params" do
+        subject.new('/test').matches?(env).must_equal false
+      end
+
+      it "matches with a regexp with the path and not the query params" do
+        subject.new(%r{\/test}).matches?(env).wont_be_nil
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require "rubygems"
+require "bundler/setup"
+
+require "minitest/autorun"
+require "rack/test"
+
+require "rack/halt"
+
+class Minitest::Spec
+
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.new {
+      use Rack::Halt do
+        halt '/application/x-shockwave-application'
+        halt %r{\/text\/(css|javascript)}
+      end
+
+      run lambda {|env| [200, {}, ['Hello World']]}
+    }.to_app
+  end
+
+  def self.allow_ok_requests
+    it "must allow ok requests" do
+      get '/'
+      assert_equal 'Hello World', last_response.body
+      assert last_response.ok?
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rack-halt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Kraybill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Prevent matched paths from subsequent middleware calls
+email:
+- ckraybill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- README.md
+- lib/rack/halt.rb
+- lib/rack/halt/rule.rb
+- lib/rack/halt/rule_set.rb
+- lib/rack/halt/version.rb
+- rack-halt.gemspec
+- test/halt_test.rb
+- test/rule_set_test.rb
+- test/rule_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ckraybill/rack-halt
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Stop rack requests in their tracks
+test_files:
+- test/halt_test.rb
+- test/rule_set_test.rb
+- test/rule_test.rb
+- test/test_helper.rb