rack-reverse-proxy 0.4.1 → 0.4.3

data/README.rdoc

@@ -6,6 +6,9 @@ This is a simple reverse proxy for Rack that pretty heavily rips off Rack Forwar
 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
 
+For your Gemfile use:
+  gem "rack-reverse-proxy", :require => "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 $.
 
@@ -16,11 +19,14 @@ Below is an example for configuring the middleware:
   require 'rack/reverse_proxy'
 
   use Rack::ReverseProxy do 
+    # Set :preserve_host to true globally (default is true already)
+    reverse_proxy_options :preserve_host => true
+
     # Forward the path /test* to http://example.com/test*
     reverse_proxy '/test', 'http://example.com/'
 
     # Forward the path /foo/* to http://example.com/bar/*
-    reverse_proxy /^\/foo(\/.*)$/, 'http://example.com/bar$1'
+    reverse_proxy /^\/foo(\/.*)$/, 'http://example.com/bar$1', :username => 'name', :password => 'basic_auth_secret'
   end
 
   app = proc do |env|
@@ -28,6 +34,13 @@ Below is an example for configuring the middleware:
   end
   run app
 
+reverse_proxy_options sets global options for all reverse proxies. Available options are:
+* :preserve_host Set to false to omit Host headers
+* :username username for basic auth
+* :password password for basic auth
+* :matching is a global only option, if set to :first the first matched url will be requested (no ambigous error). Default: :all.
+* :timeout seconds to timout the requests
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -1,25 +1,6 @@
 require 'rubygems'
 require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rack-reverse-proxy"
-    gem.summary = %Q{A Simple Reverse Proxy for Rack}
-    gem.description = %Q{A Rack based reverse proxy for basic needs.  Useful for testing or in cases where webserver configuration is unavailable.}
-    gem.email = "jaswope@gmail.com"
-    gem.homepage = "http://github.com/jaswope/rack-reverse-proxy"
-    gem.authors = ["Jon Swope"]
-    gem.add_development_dependency "rspec", ">= 0"
-    gem.add_development_dependency "rack-test", ">= 0"
-    gem.add_development_dependency "webmock", "~> 1.5.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
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler/gem_tasks'
 
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
@@ -33,8 +14,6 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
 require 'rake/rdoctask'

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.3

data/lib/rack/reverse_proxy.rb

@@ -4,39 +4,56 @@ require 'net/https'
 module Rack
   class ReverseProxy
     def initialize(app = nil, &b)
-      @app = app || lambda { [404, [], []] }
-      @paths = {}
-      @opts = {:preserve_host => false}
+      @app = app || lambda {|env| [404, [], []] }
+      @matchers = []
+      @global_options = {:preserve_host => true, :matching => :all, :verify_ssl => true}
       instance_eval &b if block_given?
     end
 
     def call(env)
       rackreq = Rack::Request.new(env)
-      matcher, url = get_matcher_and_url rackreq.fullpath
+      matcher = get_matcher rackreq.fullpath
       return @app.call(env) if matcher.nil?
 
-      uri = get_uri(url, matcher, rackreq.fullpath) 
+      uri = matcher.get_uri(rackreq.fullpath,env)
+      all_opts = @global_options.dup.merge(matcher.options)
       headers = Rack::Utils::HeaderHash.new
       env.each { |key, value|
         if key =~ /HTTP_(.*)/
           headers[$1] = value
         end
       }
-			headers['HOST'] = uri.host if @opts[:preserve_host]
+      headers['HOST'] = uri.host if all_opts[:preserve_host]
  
-			session = Net::HTTP.new(uri.host, uri.port)
-			session.use_ssl = (uri.scheme == 'https')
-			session.verify_mode = OpenSSL::SSL::VERIFY_NONE
-			session.start { |http|
+      session = Net::HTTP.new(uri.host, uri.port)
+      session.read_timeout=all_opts[:timeout] if all_opts[:timeout]
+
+      session.use_ssl = (uri.scheme == 'https')
+      if uri.scheme == 'https' && all_opts[:verify_ssl]
+        session.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      else
+        # DO NOT DO THIS IN PRODUCTION !!!
+        session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      session.start { |http|
         m = rackreq.request_method
         case m
         when "GET", "HEAD", "DELETE", "OPTIONS", "TRACE"
           req = Net::HTTP.const_get(m.capitalize).new(uri.request_uri, headers)
-          req.basic_auth @opts[:username], @opts[:password] if @opts[:username] and @opts[:password]
+          req.basic_auth all_opts[:username], all_opts[:password] if all_opts[:username] and all_opts[:password]
         when "PUT", "POST"
           req = Net::HTTP.const_get(m.capitalize).new(uri.request_uri, headers)
-          req.basic_auth @opts[:username], @opts[:password] if @opts[:username] and @opts[:password]
-          req.content_length = rackreq.body.length
+          req.basic_auth all_opts[:username], all_opts[:password] if all_opts[:username] and all_opts[:password]
+
+          if rackreq.body.respond_to?(:read) && rackreq.body.respond_to?(:rewind)
+            body = rackreq.body.read
+            req.content_length = body.size
+            rackreq.body.rewind
+          else
+            req.content_length = rackreq.body.size
+          end
+
+          req.content_type = rackreq.content_type unless rackreq.content_type.nil?
           req.body_stream = rackreq.body
         else
           raise "method not supported: #{m}"
@@ -52,20 +69,20 @@ module Rack
         [res.code, create_response_headers(res), [body]]
       }
     end
-    
+
     private
 
-    def get_matcher_and_url path
-      matches = @paths.select do |matcher, url|
-        match_path(path, matcher)
+    def get_matcher path
+      matches = @matchers.select do |matcher|
+        matcher.match?(path)
       end
 
       if matches.length < 1
         nil
-      elsif matches.length > 1
+      elsif matches.length > 1 && @global_options[:matching] != :first
         raise AmbiguousProxyMatch.new(path, matches)
       else
-        matches.first.map{|a| a.dup}
+        matches.first
       end
     end
 
@@ -79,27 +96,14 @@ module Rack
       response_headers
     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
+    def reverse_proxy_options(options)
+      @global_options=options
     end
 
     def reverse_proxy matcher, url, opts={}
-      raise GenericProxyURI.new(url) if matcher.is_a?(String) && URI(url).class == URI::Generic
-      @paths.merge!(matcher => url)
-      @opts.merge!(opts)
+      raise GenericProxyURI.new(url) if matcher.is_a?(String) && url.is_a?(String) && URI(url).class == URI::Generic
+      @matchers << ReverseProxyMatcher.new(matcher,url,opts)
     end
   end
 
@@ -129,8 +133,41 @@ module Rack
     private
 
     def formatted_matches
-      matches.map {|m| %Q("#{m[0].to_s}" => "#{m[1]}")}.join(', ')
+      matches.map {|matcher| matcher.to_s}.join(', ')
     end
   end
 
+  class ReverseProxyMatcher
+    def initialize(matching,url,options)
+      @matching=matching
+      @url=url
+      @options=options
+      @matching_regexp= matching.kind_of?(Regexp) ? matching : /^#{matching.to_s}/
+    end
+
+    attr_reader :matching,:matching_regexp,:url,:options
+
+    def match?(path)
+      match_path(path) ? true : false
+    end
+
+    def get_uri(path,env)
+      _url=(url.respond_to?(:call) ? url.call(env) : url)
+      if _url =~/\$\d/
+        match_path(path).to_a.each_with_index { |m, i| _url.gsub!("$#{i.to_s}", m) }
+        URI(_url)
+      else
+        URI.join(_url, path)
+      end
+    end
+    def to_s
+      %Q("#{matching.to_s}" => "#{url}")
+    end
+    private
+    def match_path(path)
+      path.match(matching_regexp)
+    end
+
+
+  end
 end

data/rack-reverse-proxy.gemspec

@@ -1,11 +1,6 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{rack-reverse-proxy}
-  s.version = "0.4.1"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jon Swope"]
@@ -37,26 +32,11 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb"
   ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rack-test>, [">= 0"])
-      s.add_development_dependency(%q<webmock>, ["~> 1.5.0"])
-      s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rack-test>, [">= 0"])
-      s.add_dependency(%q<webmock>, ["~> 1.5.0"])
-      s.add_dependency(%q<rack>, [">= 1.0.0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rack-test>, [">= 0"])
-    s.add_dependency(%q<webmock>, ["~> 1.5.0"])
-    s.add_dependency(%q<rack>, [">= 1.0.0"])
-  end
+  s.add_development_dependency "rspec", "~> 1.3.2"
+  s.add_development_dependency "bundler", "~> 1.0.15"
+  s.add_development_dependency "rake", "~> 0.8.7"
+  s.add_development_dependency "rack-test", "~> 0.5.7"
+  s.add_development_dependency "webmock", "~> 1.5.0"
+  s.add_dependency "rack", ">= 1.0.0"
 end
 

data/spec/rack/reverse_proxy_spec.rb

@@ -9,13 +9,14 @@ describe Rack::ReverseProxy do
   end
 
   def dummy_app
-    lambda { [200, {}, ['Dummy App']] }
+    lambda { |env| [200, {}, ['Dummy App']] }
   end
 
   describe "as middleware" do
     def app
       Rack::ReverseProxy.new(dummy_app) do
         reverse_proxy '/test', 'http://example.com/', {:preserve_host => true}
+        reverse_proxy '/2test', lambda{ |env| 'http://example.com/'}
       end
     end
 
@@ -31,34 +32,41 @@ describe Rack::ReverseProxy do
       last_response.body.should == "Proxied App"
     end
 
-		it "the response header should never contain Status" do
-			stub_request(:any, 'example.com/test/stuff').to_return(:headers => {'Status' => '200 OK'})
-			get '/test/stuff'
-			last_response.headers['Status'].should == nil
-		end
+    it "should proxy requests to a lambda url when a pattern is matched" do
+      stub_request(:get, 'http://example.com/2test').to_return({:body => "Proxied App2"})
+      get '/2test'
+      last_response.body.should == "Proxied App2"
+    end
 
-		it "the response header should never transfer-encoding" do
-			stub_request(:any, 'example.com/test/stuff').to_return(:headers => {'transfer-encoding' => 'Chunked'})
-			get '/test/stuff'
-			last_response.headers['transfer-encoding'].should == nil
-		end
+    it "the response header should never contain Status" do
+      stub_request(:any, 'example.com/test/stuff').to_return(:headers => {'Status' => '200 OK'})
+      get '/test/stuff'
+      last_response.headers['Status'].should == nil
+    end
 
-		it "should set the Host header" do
-			stub_request(:any, 'example.com/test/stuff')
-			get '/test/stuff'
-			a_request(:get, 'http://example.com/test/stuff').with(:headers => {"Host" => "example.com"}).should have_been_made
-		end
+    it "the response header should never transfer-encoding" do
+      stub_request(:any, 'example.com/test/stuff').to_return(:headers => {'transfer-encoding' => 'Chunked'})
+      get '/test/stuff'
+      last_response.headers['transfer-encoding'].should == nil
+    end
+
+    it "should set the Host header" do
+      stub_request(:any, 'example.com/test/stuff')
+      get '/test/stuff'
+      a_request(:get, 'http://example.com/test/stuff').with(:headers => {"Host" => "example.com"}).should have_been_made
+    end
 
     describe "with preserve host turned off" do
       def app
         Rack::ReverseProxy.new(dummy_app) do
-          reverse_proxy '/test', 'http://example.com/'
+          reverse_proxy '/test', 'http://example.com/', {:preserve_host => false}
         end
       end
 
       it "should not set the Host header" do
         stub_request(:any, 'example.com/test/stuff')
         get '/test/stuff'
+        a_request(:get, 'http://example.com/test/stuff').with(:headers => {"Host" => "example.com"}).should_not have_been_made
         a_request(:get, 'http://example.com/test/stuff').should have_been_made
       end
     end
@@ -77,9 +85,10 @@ describe Rack::ReverseProxy do
       end
     end
 
-    describe "with ambiguous routes" do
+    describe "with ambiguous routes and all matching" do
       def app
         Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy_options :matching => :all
           reverse_proxy '/test', 'http://example.com/'
           reverse_proxy /^\/test/, 'http://example.com/'
         end
@@ -90,6 +99,22 @@ describe Rack::ReverseProxy do
       end
     end
 
+    describe "with ambiguous routes and first matching" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy_options :matching => :first
+          reverse_proxy '/test', 'http://example1.com/'
+          reverse_proxy /^\/test/, 'http://example2.com/'
+        end
+      end
+
+      it "should throw an exception" do
+        stub_request(:get, 'http://example1.com/test').to_return({:body => "Proxied App"})
+        get '/test'
+        last_response.body.should == "Proxied App"
+      end
+    end
+
     describe "with a route as a regular expression" do
       def app
         Rack::ReverseProxy.new(dummy_app) do
@@ -104,20 +129,20 @@ describe Rack::ReverseProxy do
       end
     end
 
-		describe "with a https route" do
+    describe "with a https route" do
       def app
         Rack::ReverseProxy.new(dummy_app) do
           reverse_proxy '/test', 'https://example.com'
         end
       end
 
-			it "should make a secure request" do
+      it "should make a secure request" do
         stub_request(:get, 'https://example.com/test/stuff').to_return({:body => "Proxied Secure App"})
         get '/test/stuff'
         last_response.body.should == "Proxied Secure App"
-			end
+      end
 
-		end
+    end
 
     describe "with a route as a string" do
       def app

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-reverse-proxy
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,34 +9,55 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-04 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-04-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20805780 !ruby/object:Gem::Requirement
+  requirement: &23654620 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: *23654620
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &23653440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.15
   type: :development
   prerelease: false
-  version_requirements: *20805780
+  version_requirements: *23653440
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &23652760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *23652760
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &20805260 !ruby/object:Gem::Requirement
+  requirement: &23652060 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.7
   type: :development
   prerelease: false
-  version_requirements: *20805260
+  version_requirements: *23652060
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &20804660 !ruby/object:Gem::Requirement
+  requirement: &23650540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +65,10 @@ dependencies:
         version: 1.5.0
   type: :development
   prerelease: false
-  version_requirements: *20804660
+  version_requirements: *23650540
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &20804080 !ruby/object:Gem::Requirement
+  requirement: &23649320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +76,7 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *20804080
+  version_requirements: *23649320
 description: A Rack based reverse proxy for basic needs.  Useful for testing or in
   cases where webserver configuration is unavailable.
 email: jaswope@gmail.com
@@ -75,7 +96,6 @@ files:
 - spec/rack/reverse_proxy_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/jaswope/rack-reverse-proxy
 licenses: []
 post_install_message: 
@@ -96,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A Simple Reverse Proxy for Rack