mikehale-rat-hole 0.1.7 → 0.1.8

data/{History.txt → CHANGELOG.rdoc}

@@ -1,25 +1,31 @@
-=== 0.1.7 / 2009-02-25
+= 0.1.8
+
+* bug fixes
+* use jeweler instead of hoe
+* add test harness
+
+= 0.1.7
 
 * 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
+= 0.1.6
 
 * properly calculate request_uri if query_string is empty
 
-=== 0.1.5 / 2008-12-18
+= 0.1.5
 
 * calculate request_uri = path_info + query_string
 
-=== 0.1.4 / 2008-12-18
+= 0.1.4
 
 * update process_server_response hook to include rack_request
 
-=== 0.1.2 / 2008-12-17
+= 0.1.2
 
 * use patched-hoe from newgem
 
-=== 0.1.0 / 2008-12-17
+= 0.1.0
 
 * First release.

data/Manifest.txt

@@ -1,9 +1,11 @@
-History.txt
+CHANGELOG.rdoc
 Manifest.txt
 README.rdoc
 Rakefile
 lib/rat_hole.rb
+lib/rat_hole_test.rb
 lib/util.rb
 rat-hole.gemspec
 test/mock_request.rb
 test/test_rat_hole.rb
+VERSION.yml

data/README.rdoc

@@ -46,6 +46,20 @@ You can also modify the response from the server to cleanup html tweak headers e
 
   Rack::Handler::Mongrel.run(app, {:Host => 'localhost', :Port => 5001})
 
+=== Testing your RatHole into existance
+  class PoliticalAgendaRatHoleTest < RatHoleTest
+    def test_has_proper_response
+      through_the(PoliticalAgendaRatHole, 'terralien.com') do |raw_response, app_response|
+        assert_equal raw_response.status.to_i, app_response.status.to_i
+        assert !raw_response.headers.has_key?('Ron-Paul')
+        assert app_response.headers.has_key?('Ron-Paul')
+
+        assert !raw_response.body.to_s.include?('http://ronpaul.com')
+        assert app_response.body.to_s.include?('http://ronpaul.com')
+      end
+    end
+  end
+
 == INSTALL:
   * sudo gem install mikehale-rat-hole
 
@@ -60,8 +74,10 @@ You can also modify the response from the server to cleanup html tweak headers e
 * 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
+* write up some rathole's for common tasks (logging)
+* move to rspec?
+* support post, head, delete, etc?
+* add caching? can apache do this for us?
 
 == Credits
 * Michael Hale (http://halethegeek.com)
@@ -70,7 +86,7 @@ You can also modify the response from the server to cleanup html tweak headers e
 == LICENSE
 The MIT License
 
-Copyright (c) 2008 Michael Hale & David Bogus
+Copyright (c) 2008-2009 Michael Hale & David Bogus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 8

data/lib/rat_hole.rb

@@ -1,5 +1,4 @@
 require 'net/http'
-require 'rubygems'
 require 'rack'
 require 'delegate'
 require 'util'
@@ -7,8 +6,6 @@ require 'open3'
 
 class RatHole
 
-  VERSION = '0.1.7'
-
   def initialize(host, tidy=false)
     @host = host
     @tidy = tidy
@@ -25,7 +22,6 @@ class RatHole
   def call(env)
     Net::HTTP.start(@host) do |http|
       http.instance_eval{@socket = MethodSpy.new(@socket){|method| method =~ /#{ENV['RH_METHOD_SPY_FILTER']}/}} if $DEBUG
-
       env.delete('HTTP_ACCEPT_ENCODING')
       source_request = Rack::Request.new(env)
       process_user_request(source_request)
@@ -41,9 +37,6 @@ class RatHole
         response = http.get(request_uri, source_headers)
       elsif source_request.post?
         post = Net::HTTP::Post.new(request_uri, source_headers)
-        class << post
-          include HTTPHeaderPatch
-        end
         post.form_data = source_request.POST
         response = http.request(post)
       end
@@ -52,17 +45,23 @@ class RatHole
       headers = response.to_hash
       body = response.body || ''
       body = tidy_html(body) if @tidy
-      headers.delete('transfer-encoding')
+      headers.delete('Transfer-Encoding')
 
       server_response = Rack::Response.new(body, code, headers)
+      whack_array(server_response)
       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 whack_array(server_response)
+    server_response.headers.each do |k, v|
+      if v.is_a?(Array) && v.size == 1
+        server_response[k] = v.first
+      end
+    end
+  end
+
   def tidy_html(body)
     if `which tidy` == ''
       $stderr.puts "tidy not found in path"
@@ -87,4 +86,4 @@ end
 # This class simply extends RatHole and does nothing.
 # It's only useful for making sure that you have everything hooked up correctly.
 class EmptyRatHole < RatHole
-end
+end

data/lib/rat_hole_test.rb

@@ -0,0 +1,40 @@
+require 'test/unit'
+
+class RatHoleTest < Test::Unit::TestCase
+  def through_the(rathole_klass, host, uri='/', headers={})
+    app = Rack::Builder.new do
+      use Rack::ShowExceptions
+      use Rack::ShowStatus
+      run rathole_klass.new(host)
+    end
+
+    app_response = Rack::MockRequest.new(app).get(uri, headers)
+    raw_response = Net::HTTP.start(host) do |http|
+      http.get(uri, headers)
+    end
+    # Wrap raw_response in Rack::Response to make things easier to work with.
+    raw_headers = raw_response.to_hash
+    raw_response = Rack::Response.new(raw_response.body, raw_response.code, raw_headers)
+    normalize_headers(raw_response.headers)
+    normalize_headers(app_response.headers)
+    yield(raw_response, app_response)
+  end
+
+  def normalize_headers(headers)
+    new_headers = headers.inject({}){|h,e|
+      k,v = e
+      # the value of these headers changes
+      v = nil if k =~ /cookie|date|runtime|last-modified/i
+      # skip headers that rat-hole removes
+      unless k =~ /transfer/i
+        v = v.first if v.is_a?(Array) && v.size == 1 #normalize things
+        h.merge!(k => v)
+      end
+      h
+    }
+    headers.replace(new_headers)
+  end
+
+  def test_nothing #make autotest happy
+  end
+end

data/lib/util.rb

@@ -32,7 +32,18 @@ class String
   end
 end
 
-module HTTPHeaderPatch
+module Net::HTTPHeader
+  def to_hash
+    new_headers = @header.dup
+    @header.each do |k,v|
+      new_headers.delete(k)
+      new_headers[k.to_camel_case] = v
+    end
+    new_headers
+  end
+end
+
+class Net::HTTP::Post
   # handle multiple parameters with the same name
   def form_data=(params, sep = '&')
     self.body = params.map {|key,value|

data/test/test_rat_hole.rb

@@ -1,11 +1,10 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
-require 'rubygems'
 require 'rr'
 require 'delegate'
 require 'test/unit'
-require 'ruby-debug'
 require 'rat_hole'
+require 'rat_hole_test'
 require 'mock_request'
 require 'hpricot'
 
@@ -121,6 +120,16 @@ class TestRatHole < Test::Unit::TestCase
     assert_equal(expected_headers, proxied_request.headers)
   end
 
+  def test_content_type
+    mock_server(:headers=>{'content-type' => ['image/gif']})
+    response = send_get_request
+    assert_equal 'image/gif', response.headers['Content-Type']
+
+    mock_server
+    response = send_get_request
+    assert_equal 'text/html', response.headers['Content-Type']
+  end
+
   def test_convert_rack_env_to_http_headers_more_data
     expected_headers = {
       "X-Forwarded-Host"=>"www.example.com",
@@ -173,63 +182,35 @@ class TestRatHole < Test::Unit::TestCase
     send_post_request('', '/uri?with=param')
     assert_equal('/uri?with=param', proxied_request.uri)
   end
+end
 
-  def test_systemic_empty_rathole
-    host = 'halethegeek.com'
-    app =  EmptyRatHole.new(host)
-    app_response = Rack::MockRequest.new(app).get('/', {})
-    raw_response = Net::HTTP.start(host) do |http|
-      http.get('/', {})
+class TestEmptyRatHole < RatHoleTest
+  def test_has_proper_response
+    through_the(EmptyRatHole, 'halethegeek.com') do |raw_response, app_response|
+      assert_not_equal 0, raw_response.headers
+      assert_equal raw_response.status.to_i, app_response.status.to_i
+      assert_equal raw_response.headers, app_response.headers
+      assert_equal raw_response.body.to_s, app_response.body.to_s
     end
-    # Wrap raw_response in Rack::Response to make things easier to work with.
-    raw_response = Rack::Response.new(raw_response.body, raw_response.code, raw_response.to_hash)
-
-    assert_equal raw_response.status.to_i, app_response.status.to_i
-    assert_equal normalize_headers(raw_response.headers), normalize_headers(app_response.headers)
-    assert_equal raw_response.body.to_s, app_response.body.to_s
   end
+end
 
-  def test_systemic_political_agenda
-    host = 'terralien.com'
-    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('/', {})
+class PoliticalAgendaRatHoleTest < RatHoleTest
+  def test_has_proper_response
+    through_the(PoliticalAgendaRatHole, 'terralien.com') do |raw_response, app_response|
+      assert_equal raw_response.status.to_i, app_response.status.to_i
+      assert !raw_response.headers.has_key?('Ron-Paul')
+      assert app_response.headers.has_key?('Ron-Paul')
+
+      assert !raw_response.body.to_s.include?('http://ronpaul.com')
+      assert app_response.body.to_s.include?('http://ronpaul.com')
     end
-    # Wrap raw_response in Rack::Response to make things easier to work with.
-    raw_response = Rack::Response.new(raw_response.body, raw_response.code, raw_response.to_hash)
-    raw_headers = normalize_headers(raw_response.headers)
-    app_headers = normalize_headers(app_response.headers)
-
-    assert_equal raw_response.status.to_i, app_response.status.to_i
-    assert !raw_headers.has_key?('Ron-Paul')
-    assert app_headers.has_key?('Ron-Paul')
-
-    assert !raw_response.body.to_s.include?('http://ronpaul.com')
-    assert app_response.body.to_s.include?('http://ronpaul.com')
-  end
-
-  def normalize_headers(headers)
-    headers.inject({}){|h,e|
-      k,v = e
-      # don't compare headers that change or that we remove
-      unless k =~ /cookie|transfer|date|runtime/i
-        v = [v] unless v.is_a? Array #normalize things
-        h.merge!(k => v)
-      end
-      h
-    }
   end
 end
 
 class PoliticalAgendaRatHole < RatHole
   def process_server_response(rack_response, rack_request)
-    if(rack_response.content_type == 'text/html')
+    if(rack_response.content_type =~ /text\/html/)
       doc = Hpricot(rack_response.body.first)
       (doc/"a").set('href', 'http://ronpaul.com')
       rack_response.body.first.replace(doc.to_html)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mikehale-rat-hole
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Michael Hale
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-25 00:00:00 -08:00
+date: 2009-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,82 +23,30 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.1
     version: 
-- !ruby/object:Gem::Dependency 
-  name: rr
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.164
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: cucumber
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.1.12
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.0
-    version: 
-description: 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/]
+description: 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.
 email: mikehale@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- History.txt
+- CHANGELOG.rdoc
 - Manifest.txt
 - README.rdoc
-- Rakefile
+- VERSION.yml
 - lib/rat_hole.rb
+- lib/rat_hole_test.rb
 - lib/util.rb
-- rat-hole.gemspec
 - test/mock_request.rb
 - test/test_rat_hole.rb
 has_rdoc: true
 homepage: http://github.com/mikehale/rat-hole
 post_install_message: 
 rdoc_options: 
-- --main
-- README.rdoc
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -115,10 +63,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: rat-hole
+rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Rack compliant proxy
-test_files: 
-- test/test_rat_hole.rb
+summary: Rack compliant http proxy
+test_files: []
+

data/Rakefile

@@ -1,30 +0,0 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'rubygems'
-require 'hoe-patched' # because it supports README.*
-require 'rat_hole'
-
-Hoe.new('rat-hole', RatHole::VERSION) do |p|
-  p.summary = 'Rack compliant proxy'
-  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.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']
-  p.extra_dev_deps << ['cucumber', '>= 0.1.12']
-  p.author << 'Michael Hale'
-  p.author << 'David Bogus'
-  p.email = 'mikehale@gmail.com'
-end
-
-desc %(Update the gemspec so that github will build a new gem: http://gems.github.com/)
-task :update_gemspec do
-  begin
-    old_stdout = STDOUT.dup
-    STDOUT.reopen('rat-hole.gemspec')
-    Rake::Task["debug_gem"].invoke
-  ensure
-    STDOUT.reopen(old_stdout)
-  end
-end

data/rat-hole.gemspec

@@ -1,50 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{rat-hole}
-  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{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"]
-  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "lib/rat_hole.rb", "lib/util.rb", "rat-hole.gemspec", "test/mock_request.rb", "test/test_rat_hole.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/mikehale/rat-hole}
-  s.rdoc_options = ["--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{rat-hole}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Rack compliant proxy}
-  s.test_files = ["test/test_rat_hole.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    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.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"])
-      s.add_dependency(%q<cucumber>, [">= 0.1.12"])
-      s.add_dependency(%q<hoe>, [">= 1.8.0"])
-    end
-  else
-    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"])
-    s.add_dependency(%q<cucumber>, [">= 0.1.12"])
-    s.add_dependency(%q<hoe>, [">= 1.8.0"])
-  end
-end