rack_url_stripper 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,27 @@
+= rack_url_stripper
+
+middleware to remove url's, actions, and script from your markup
+
+To use:
+
+  config.gem 'rack_url_stripper'
+
+Set a path prefix to filter what gets stripped:
+
+  Rack::UrlStripper::Middleware.path_prefix = '/templates/'
+
+Any path that starts with '/templates/' will remove all links, action url's, and script tags
+
+== 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 Second Rotation, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack_url_stripper"
+    gem.summary = %Q{Removes urls from anchors and forms et al}
+    gem.description = %Q{Strips urls from anchors and forms to essentially create an html page that doesn't like anywhere}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/rack_url_stripper"
+    gem.authors = ["Dan Pickett"]
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    gem.add_development_dependency 'rack-test', '>= 0.5.3'
+    gem.add_dependency 'nokogiri', '>= 1.3.3'
+    gem.add_dependency 'rack', '>=1.0.1'
+    gem.add_dependency 'configatron', '2.5.1'
+    # 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 '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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack_url_stripper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/rack_url_stripper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+
+require 'rack'
+require 'nokogiri'
+require 'configatron'
+
+require 'rack_url_stripper/document_to_strip'
+require 'rack_url_stripper/middleware'

data/lib/rack_url_stripper/document_to_strip.rb

@@ -0,0 +1,23 @@
+module Rack
+  module UrlStripper
+    class DocumentToStrip
+      def initialize(body)
+        @doc = Nokogiri::HTML.parse(body)
+      end
+
+      def clear_uri_for(element, attribute)
+        @doc.xpath("//#{element}/@#{attribute}").each do |i|
+          i.value = '#'
+        end
+      end
+
+      def remove_tag(tag_name)
+        @doc.xpath("//#{tag_name}").remove()
+      end
+
+      def to_s
+        @doc.to_s
+      end
+    end
+  end
+end

data/lib/rack_url_stripper/middleware.rb

@@ -0,0 +1,49 @@
+module Rack
+  module UrlStripper
+    class Middleware
+      class PathPrefixNotSpecifiedError < Exception; end
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        require_path_prefix
+
+        @resp = @app.call(env)
+        strip_document if should_strip_document?(env)
+
+        @resp
+      end
+
+      def self.path_prefix=(path)
+        configatron.rack_url_stripper.path_prefix = path
+      end
+
+      def self.path_prefix
+        configatron.rack_url_stripper.path_prefix
+      end
+
+      private
+        def require_path_prefix
+          if self.class.path_prefix.nil?
+            raise PathPrefixNotSpecifiedError, 'No path_prefix was set for rack_url_stripper'
+          end
+        end
+
+        def should_strip_document?(env)
+          env['PATH_INFO'] =~ /^#{self.class.path_prefix}/
+        end
+
+        def strip_document
+          doc = Rack::UrlStripper::DocumentToStrip.new(@resp[2].body[0])
+
+          doc.clear_uri_for('a', 'href')
+          doc.clear_uri_for('form', 'action')
+          doc.remove_tag('script')
+
+          @resp[2].body[0] = doc.to_s
+        end
+    end
+  end
+end

data/spec/fixtures/markup.html

@@ -0,0 +1,32 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Test</title>
+  </head>
+
+  <script src="http://www.google.com">
+  </script>
+
+  <body>
+    <a href="http://www.google.com">Google</a>
+    <a href='http://www.yahoo.com'>Yahoo</a>
+    <a href="some_relative_path">Something Relative</a>
+    <a href="/some_absolute_path">Something Absolute</a>
+
+    <form action="/something">
+      <input type="hidden" name="foo" value="bar" />
+      <input type="hidden" name="bar" value="foo" />
+    </form>
+
+    <form action="http://www.google.com/fdsa">
+      <input type="text" name="fool" />
+      <input type="submit" value="submit" />
+    </form>
+
+    <script type="text/javascript">
+      alert('hello world');
+    </script>
+  </body>
+</html>

data/spec/rack_url_stripper/middleware_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Rack::UrlStripper::Middleware do
+  class TestApplication
+    def call(env)
+      req = Rack::Request.new(env)
+      resp = Rack::Response.new
+      resp.write(File.read(File.join(File.dirname(__FILE__), '/../fixtures/markup.html')))
+      resp.finish
+    end
+  end
+
+  def app
+    Rack::UrlStripper::Middleware.new(TestApplication.new)
+  end
+
+  describe 'when requesting w/ appropriate path prefix' do
+    before(:each) do
+      Rack::UrlStripper::Middleware.path_prefix = '/proper_prefix/'
+      @response = get '/proper_prefix/giggity/giggity'
+    end
+
+    it 'should drop urls in an href of an anchor' do 
+      @response.body.should_not =~ /href=\"([^\#]*)\"/i
+      @response.body.should_not =~ /href=\'([^\#]*)\'/i
+    end
+
+    it 'should drop urls in the action of a form tag' do
+      @response.body.should_not =~ /action=\"([^\#]*)\"/i
+      @response.body.should_not =~ /action=\'([^\#]*)\'/i
+    end
+
+    it 'should remove script tags' do
+      @response.body.should_not =~ /<script/i
+    end
+
+    it 'should remove the stuff inside a script tag' do
+      @response.body.should_not =~ /alert/
+    end
+  end
+
+  describe 'when requesting withou the appropirate path prefix' do
+    before(:each) do
+      Rack::UrlStripper::Middleware.path_prefix = '/proper_prefix/'
+      @response = get '/giggity/giggity'
+    end
+
+    it 'should not drop urls in an href' do
+      @response.body.should_not =~ /href=\"\#\"/i
+    end
+
+    it 'should not drop action urls in a form tag' do
+      @response.body.should_not =~ /action=\"\#\"/i
+    end
+  end
+
+  it 'should raise an error if I have not specified a path prefix' do
+    Rack::UrlStripper::Middleware.path_prefix = nil
+    lambda { get "/" }.should raise_error
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack_url_stripper'
+require 'spec'
+require 'spec/autorun'
+require 'rack/test'
+
+Spec::Runner.configure do |config|
+  include Rack::Test::Methods 
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: rack_url_stripper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.5.1
+    version: 
+description: Strips urls from anchors and forms to essentially create an html page that doesn't like anywhere
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack_url_stripper.rb
+- lib/rack_url_stripper/document_to_strip.rb
+- lib/rack_url_stripper/middleware.rb
+- spec/fixtures/markup.html
+- spec/rack_url_stripper/middleware_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dpickett/rack_url_stripper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Removes urls from anchors and forms et al
+test_files: 
+- spec/rack_url_stripper/middleware_spec.rb
+- spec/spec_helper.rb