rack-reverse-proxy 0.1.0 → 0.2.0

data/README.rdoc

@@ -2,13 +2,18 @@
 
 This is a simple reverse proxy for Rack that pretty heavily rips off Rack Forwarder.  It is not meant for production systems (although it may work), as the webserver fronting your app is generally much better at this sort of thing.
 
+== Installation
+The gem is available on gemcutter.  Assuming you have a recent version of Rubygems you should just be able to install it via:
+  gem install rack-reverse-proxy
+
+== Usage
 Matchers can be a regex or a string.  If a regex is used, you can use the subcaptures in your forwarding url by denoting them with a $.
 
 Right now if more than one matcher matches any given route, it throws an exception for an ambiguous match.  This will probably change later.  If no match is found, the call is forwarded to your application.
 
 Below is an example for configuring the middleware:
 
-  require 'lib/rack/reverse_proxy'
+  require 'rack/reverse_proxy'
 
   use Rack::ReverseProxy do 
     # Forward the path /test* to http://example.com/test*

data/Rakefile

@@ -10,7 +10,9 @@ begin
     gem.email = "jaswope@gmail.com"
     gem.homepage = "http://github.com/jaswope/rack-reverse-proxy"
     gem.authors = ["Jon Swope"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "rspec", ">= 0"
+    gem.add_development_dependency "rack-test", ">= 0"
+    gem.add_development_dependency "webmock", ">= 0"
     gem.add_dependency "rack", ">= 1.0.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -19,29 +21,21 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :test => :check_dependencies
+task :spec => :check_dependencies
 
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/rack/reverse_proxy.rb

@@ -13,73 +13,99 @@ module Rack
       matcher, url = get_matcher_and_url rackreq.fullpath
       return @app.call(env) if matcher.nil?
 
-      path = rackreq.fullpath
-      match = case matcher
-              when String
-                path.match(/^#{matcher}/)
-              when Regexp
-                path.match(matcher)
-              end
-      uri = case url 
-            when /\$\d/
-              match.to_a.each_with_index { |m, i| url.gsub!("$#{i.to_s}", m) }
-              URI(url)
-            else
-              URI.join(url, path)
-            end
- 
-       headers = Rack::Utils::HeaderHash.new
-       env.each { |key, value|
-         if key =~ /HTTP_(.*)/
-           headers[$1] = value
-         end
-       }
- 
-       res = Net::HTTP.start(uri.host, uri.port) { |http|
-         m = rackreq.request_method
-         case m
-         when "GET", "HEAD", "DELETE", "OPTIONS", "TRACE"
-           req = Net::HTTP.const_get(m.capitalize).new(uri.path, headers)
-         when "PUT", "POST"
-           req = Net::HTTP.const_get(m.capitalize).new(uri.path, headers)
-           req.body_stream = rackreq.body
-         else
-           raise "method not supported: #{method}"
-         end
+      uri = get_uri(url, matcher, rackreq.fullpath) 
+      headers = Rack::Utils::HeaderHash.new
+      env.each { |key, value|
+        if key =~ /HTTP_(.*)/
+          headers[$1] = value
+        end
+      }
  
-         http.request(req)
-       }
+      res = Net::HTTP.start(uri.host, uri.port) { |http|
+        m = rackreq.request_method
+        case m
+        when "GET", "HEAD", "DELETE", "OPTIONS", "TRACE"
+          req = Net::HTTP.const_get(m.capitalize).new(uri.path, headers)
+        when "PUT", "POST"
+          req = Net::HTTP.const_get(m.capitalize).new(uri.path, headers)
+          req.body_stream = rackreq.body
+        else
+          raise "method not supported: #{method}"
+        end
+
+        http.request(req)
+      }
  
-       [res.code, Rack::Utils::HeaderHash.new(res.to_hash), [res.body]]
+      [res.code, Rack::Utils::HeaderHash.new(res.to_hash), [res.body]]
     end
     
     private
 
     def get_matcher_and_url path
       matches = @paths.select do |matcher, url|
-        case matcher
-        when String
-          path =~ /^#{matcher}/
-        when Regexp
-          path =~ matcher
-        end
+        match_path(path, matcher)
       end
 
       if matches.length < 1
         nil
       elsif matches.length > 1
-        raise AmbiguousProxyMatch
+        raise AmbiguousProxyMatch.new(path, matches)
       else
         matches.first.map{|a| a.dup}
       end
     end
 
+    def match_path(path, matcher)
+      if matcher.is_a?(Regexp)
+        path.match(matcher)
+      else
+        path.match(/^#{matcher.to_s}/)
+      end
+    end
+
+    def get_uri(url, matcher, path)
+      if url =~/\$\d/
+        match_path(path, matcher).to_a.each_with_index { |m, i| url.gsub!("$#{i.to_s}", m) }
+        URI(url)
+      else
+        URI.join(url, path)
+      end
+    end
+
     def reverse_proxy matcher, url
+      raise GenericProxyURI.new(url) if matcher.is_a?(String) && URI(url).class == URI::Generic
       @paths.merge!(matcher => url)
     end
   end
 
+  class GenericProxyURI < Exception
+    attr_reader :url
+
+    def intialize(url)
+      @url = url
+    end
+
+    def to_s
+      %Q(Your URL "#{@url}" is too generic. Did you mean "http://#{@url}"?)
+    end
+  end
+
   class AmbiguousProxyMatch < Exception
+    attr_reader :path, :matches
+    def initialize(path, matches)
+      @path = path
+      @matches = matches
+    end
+
+    def to_s
+      %Q(Path "#{path}" matched multiple endpoints: #{formatted_matches})
+    end
+
+    private
+
+    def formatted_matches
+      matches.map {|m| %Q("#{m[0].to_s}" => "#{m[1]}")}.join(', ')
+    end
   end
 
 end

data/rack-reverse-proxy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-reverse-proxy}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jon Swope"]
-  s.date = %q{2010-04-10}
+  s.date = %q{2010-04-11}
   s.description = %q{A Rack based reverse proxy for basic needs.  Useful for testing or in cases where webserver configuration is unavailable.}
   s.email = %q{jaswope@gmail.com}
   s.extra_rdoc_files = [
@@ -26,17 +26,18 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/rack/reverse_proxy.rb",
      "rack-reverse-proxy.gemspec",
-     "test/helper.rb",
-     "test/test_rack-reverse-proxy.rb"
+     "spec/rack/reverse_proxy_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/jaswope/rack-reverse-proxy}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A Simple Reverse Proxy for Rack}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_rack-reverse-proxy.rb"
+    "spec/spec_helper.rb",
+     "spec/rack/reverse_proxy_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -44,14 +45,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<rack>, [">= 1.0.0"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<rack>, [">= 1.0.0"])
   end
 end

data/spec/rack/reverse_proxy_spec.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rack::ReverseProxy do
+  include Rack::Test::Methods
+  include WebMock
+
+  def app
+    Rack::ReverseProxy.new
+  end
+
+  def dummy_app
+    lambda { [200, {}, ['Dummy App']] }
+  end
+
+  describe "as middleware" do
+    def app
+      Rack::ReverseProxy.new(dummy_app) do
+        reverse_proxy '/test', 'http://example.com/'
+      end
+    end
+
+    it "should forward requests to the calling app when the path is not matched" do
+      get '/'
+      last_response.body.should == "Dummy App"
+      last_response.should be_ok
+    end
+
+    it "should proxy requests when a pattern is matched" do
+      stub_request(:get, 'http://example.com/test').to_return({:body => "Proxied App"})
+      get '/test'
+      last_response.body.should == "Proxied App"
+    end
+
+    describe "with ambiguous routes" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy '/test', 'http://example.com/'
+          reverse_proxy /^\/test/, 'http://example.com/'
+        end
+      end
+
+      it "should throw an exception" do
+        lambda { get '/test' }.should raise_error(Rack::AmbiguousProxyMatch)
+      end
+    end
+
+    describe "with a route as a regular expression" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy %r|^/test(/.*)$|, 'http://example.com$1'
+        end
+      end
+
+      it "should support subcaptures" do
+        stub_request(:get, 'http://example.com/path').to_return({:body => "Proxied App"})
+        get '/test/path'
+        last_response.body.should == "Proxied App"
+      end
+    end
+
+    describe "with a route as a string" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy '/test', 'http://example.com'
+          reverse_proxy '/path', 'http://example.com/foo$0'
+        end
+      end
+
+      it "should append the full path to the uri" do
+        stub_request(:get, 'http://example.com/test/stuff').to_return({:body => "Proxied App"})
+        get '/test/stuff'
+        last_response.body.should == "Proxied App"
+      end
+
+    end
+
+    describe "with a generic url" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy '/test', 'example.com'
+        end
+      end
+
+      it "should throw an exception" do
+        lambda{ app }.should raise_error(Rack::GenericProxyURI)
+      end
+    end
+
+    describe "with a matching route" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy '/test', 'http://example.com/'
+        end
+      end
+
+      %w|get head delete put post|.each do |method|
+        describe "and using method #{method}" do
+          it "should forward the correct request" do
+            stub_request(method.to_sym, 'http://example.com/test').to_return({:body => "Proxied App for #{method}"})
+            eval "#{method} '/test'"
+            last_response.body.should == "Proxied App for #{method}"
+          end
+
+          if %w|put post|.include?(method)
+            it "should forward the request payload" do
+              pending "valid test with next release of WebMock" do
+                stub_request(method.to_sym, 'http://example.com/test').to_return { |req| {:body => req.body} }
+                eval "#{method} '/test', {:test => 'test'}"
+                last_response.body.should == "test=test"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe "as a rack app" do
+    it "should respond with 404 when the path is not matched" do
+      get '/'
+      last_response.should be_not_found
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/reverse_proxy'
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+require 'rack/test'
+require 'webmock'
+
+Spec::Runner.configure do |config|
+  WebMock.disable_net_connect!
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rack-reverse-proxy
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jon Swope
@@ -9,29 +14,59 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 -04:00
+date: 2010-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id004
 description: A Rack based reverse proxy for basic needs.  Useful for testing or in cases where webserver configuration is unavailable.
 email: jaswope@gmail.com
 executables: []
@@ -51,8 +86,9 @@ files:
 - VERSION
 - lib/rack/reverse_proxy.rb
 - rack-reverse-proxy.gemspec
-- test/helper.rb
-- test/test_rack-reverse-proxy.rb
+- spec/rack/reverse_proxy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 - README
 has_rdoc: true
 homepage: http://github.com/jaswope/rack-reverse-proxy
@@ -67,21 +103,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Simple Reverse Proxy for Rack
 test_files: 
-- test/helper.rb
-- test/test_rack-reverse-proxy.rb
+- spec/spec_helper.rb
+- spec/rack/reverse_proxy_spec.rb

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rack/reverse-proxy'
-
-class Test::Unit::TestCase
-end

data/test/test_rack-reverse-proxy.rb

@@ -1,4 +0,0 @@
-require 'helper'
-
-class TestRackReverseProxy < Test::Unit::TestCase
-end