mikehale-rat-hole 0.1.6 → 0.1.7

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.1.7 / 2009-02-25
+
+* add support for tidy
+* update api to not require request/response to be returned
+* require rack 0.9.1 or greater
+
 === 0.1.6 / 2008-12-18
 
 * properly calculate request_uri if query_string is empty

data/README.rdoc

@@ -15,9 +15,6 @@ You can also modify the response from the server to cleanup html tweak headers e
   class PoliticalAgendaRatHole < RatHole
     def process_user_request(rack_request)
       # optionally munge the request before passing it to the old server
-      
-      # required to return the rack request
-      rack_request
     end
 
     def process_server_response(rack_response, rack_request)
@@ -37,13 +34,16 @@ You can also modify the response from the server to cleanup html tweak headers e
 
         rack_response.headers['Ron-Paul'] = 'wish I could have voted for this guy'
       end
-
-      # required to return the rack response
-      rack_response
     end
   end
 
-  app =  PoliticalAgendaRatHole.new('www.google.com')
+  app = Rack::Builder.new do
+    use Rack::CommonLogger # display apache style common logs
+    use Rack::ShowExceptions # show exceptions
+    use Rack::Reloader # reload app when an included file changes
+    run PoliticalAgendaRatHole.new('www.google.com')
+  end
+
   Rack::Handler::Mongrel.run(app, {:Host => 'localhost', :Port => 5001})
 
 == INSTALL:
@@ -53,14 +53,15 @@ You can also modify the response from the server to cleanup html tweak headers e
   User Request  --->
       ---  RatHoleProxy.process_user_request(rack_request) --->
                                                                 <==========> OLD SERVER
-      <---  RatHoleProxy.process_server_response(rack_response) ---
+      <---  RatHoleProxy.process_server_response(rack_response, rack_request) ---
   User Response  <---
 
 == TODO
-* add error handling
+* handle server down
 * handle gziped content (accept-encoding, transfer-encoding)
 * maybe use a pool of Net::HTTP connections to speed things up
 * provide an easy way for testing rat holes
+* write up some rathole's for common tasks
 
 == Credits
 * Michael Hale (http://halethegeek.com)

data/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
 require 'rubygems'
 require 'hoe-patched' # because it supports README.*
 require 'rat_hole'
@@ -8,7 +8,7 @@ Hoe.new('rat-hole', RatHole::VERSION) do |p|
   p.description = p.paragraphs_of('README.rdoc', 0...1).to_s
   p.url = 'http://github.com/mikehale/rat-hole'
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.extra_deps << ['rack', '>= 0.4.0']
+  p.extra_deps << ['rack', '>= 0.9.1']
   p.extra_dev_deps << ['rr', '>= 0.6.0']
   p.extra_dev_deps << ['hpricot', '>= 0.6.164']
   p.extra_dev_deps << ['newgem', '>= 1.1.0']

data/lib/rat_hole.rb

@@ -3,13 +3,15 @@ require 'rubygems'
 require 'rack'
 require 'delegate'
 require 'util'
+require 'open3'
 
 class RatHole
 
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 
-  def initialize(host)
+  def initialize(host, tidy=false)
     @host = host
+    @tidy = tidy
   end
 
   def process_user_request(rack_request)
@@ -25,7 +27,8 @@ class RatHole
       http.instance_eval{@socket = MethodSpy.new(@socket){|method| method =~ /#{ENV['RH_METHOD_SPY_FILTER']}/}} if $DEBUG
 
       env.delete('HTTP_ACCEPT_ENCODING')
-      source_request = process_user_request(Rack::Request.new(env))
+      source_request = Rack::Request.new(env)
+      process_user_request(source_request)
       source_headers = request_headers(source_request.env)
       
       if source_request.query_string.nil? || source_request.query_string == ''
@@ -48,10 +51,29 @@ class RatHole
       code = response.code.to_i
       headers = response.to_hash
       body = response.body || ''
+      body = tidy_html(body) if @tidy
       headers.delete('transfer-encoding')
 
-      process_server_response(Rack::Response.new(body, code, headers), source_request).finish
+      server_response = Rack::Response.new(body, code, headers)
+      process_server_response(server_response, source_request)
+      if server_response.headers.has_key?("content-length")
+        server_response.headers["content-length"] = server_response.headers["content-length"].first
+      end
+      server_response.finish
+    end
+  end
+
+  def tidy_html(body)
+    if `which tidy` == ''
+      $stderr.puts "tidy not found in path"
+      return
+    end
+    tidied = Open3.popen3('tidy -ascii') do |stdin, stdout, stderr|
+      stdin.print body
+      stdin.close
+      stdout.read
     end
+    body.replace(tidied)
   end
 
   def request_headers(env)

data/rat-hole.gemspec

@@ -1,10 +1,12 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{rat-hole}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Hale", "David Bogus"]
-  s.date = %q{2008-12-18}
+  s.date = %q{2009-02-25}
   s.description = %q{Rat Hole is a handy library for creating a rack compliant http proxy that allows you to modify the request from the user and the response from the server.  The name is inspired by why's mousehole[http://code.whytheluckystiff.net/mouseHole/]}
   s.email = %q{mikehale@gmail.com}
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
@@ -14,7 +16,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{rat-hole}
-  s.rubygems_version = %q{1.2.0}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{Rack compliant proxy}
   s.test_files = ["test/test_rat_hole.rb"]
 
@@ -22,15 +24,15 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
-    if current_version >= 3 then
-      s.add_runtime_dependency(%q<rack>, [">= 0.4.0"])
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0.9.1"])
       s.add_development_dependency(%q<rr>, [">= 0.6.0"])
       s.add_development_dependency(%q<hpricot>, [">= 0.6.164"])
       s.add_development_dependency(%q<newgem>, [">= 1.1.0"])
       s.add_development_dependency(%q<cucumber>, [">= 0.1.12"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
     else
-      s.add_dependency(%q<rack>, [">= 0.4.0"])
+      s.add_dependency(%q<rack>, [">= 0.9.1"])
       s.add_dependency(%q<rr>, [">= 0.6.0"])
       s.add_dependency(%q<hpricot>, [">= 0.6.164"])
       s.add_dependency(%q<newgem>, [">= 1.1.0"])
@@ -38,7 +40,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<hoe>, [">= 1.8.0"])
     end
   else
-    s.add_dependency(%q<rack>, [">= 0.4.0"])
+    s.add_dependency(%q<rack>, [">= 0.9.1"])
     s.add_dependency(%q<rr>, [">= 0.6.0"])
     s.add_dependency(%q<hpricot>, [">= 0.6.164"])
     s.add_dependency(%q<newgem>, [">= 1.1.0"])

data/test/test_rat_hole.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rubygems'
 require 'rr'
@@ -191,7 +191,12 @@ class TestRatHole < Test::Unit::TestCase
 
   def test_systemic_political_agenda
     host = 'terralien.com'
-    app =  PoliticalAgendaRatHole.new(host)
+    app = Rack::Builder.new do
+      use Rack::ShowExceptions
+      use Rack::ShowStatus
+      run PoliticalAgendaRatHole.new(host)
+    end
+    
     app_response = Rack::MockRequest.new(app).get('/', {})
     raw_response = Net::HTTP.start(host) do |http|
       http.get('/', {})
@@ -230,6 +235,5 @@ class PoliticalAgendaRatHole < RatHole
       rack_response.body.first.replace(doc.to_html)
       rack_response.headers['Ron-Paul'] = 'wish I could have voted for this guy'
     end
-    rack_response
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mikehale-rat-hole
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Michael Hale
@@ -10,20 +10,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-18 00:00:00 -08:00
+date: 2009-02-25 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.0
+        version: 0.9.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: rr
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -33,6 +35,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -42,6 +45,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: newgem
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -51,6 +55,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -60,6 +65,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: