Merge pull request #44 from pex/master

The last two years of community development

Author: jaswope

.rspec

@@ -0,0 +1 @@
+--color

Gemfile

@@ -1,3 +1,2 @@
-source "http://rubygems.org"
-
+source "https://rubygems.org"
 gemspec

Gemfile.lock

@@ -1,30 +1,88 @@
 PATH
   remote: .
   specs:
-    rack-reverse-proxy (0.4.1)
+    rack-reverse-proxy (0.8.1)
       rack (>= 1.0.0)
+      rack-proxy (~> 0.5)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.2.6)
-    crack (0.1.8)
-    rack (1.3.2)
-    rack-test (0.5.7)
+    addressable (2.3.6)
+    coderay (1.0.9)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.0)
+    ffi (1.9.0-java)
+    formatador (0.2.4)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rspec (1.2.1)
+      guard (>= 1.1)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry (0.9.12.2-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rack (1.4.1)
+    rack-proxy (0.5.15)
+      rack
+    rack-test (0.6.2)
       rack (>= 1.0)
-    rake (0.8.7)
-    rspec (1.3.2)
-    webmock (1.5.0)
-      addressable (>= 2.2.2)
-      crack (>= 0.1.7)
+    rake (10.3.2)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    safe_yaml (1.0.3)
+    slop (3.4.5)
+    spoon (0.0.4)
+      ffi
+    thor (0.18.1)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.15)
+  guard-bundler
+  guard-rspec
   rack-reverse-proxy!
-  rack-test (~> 0.5.7)
-  rake (~> 0.8.7)
-  rspec (~> 1.3.2)
-  webmock (~> 1.5.0)
+  rack-test (~> 0.6)
+  rake (~> 10.3)
+  rspec (~> 3.1)
+  webmock (~> 1.18)

Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

README.md

@@ -0,0 +1,64 @@
+# A Reverse Proxy for Rack
+[![TravisCI](https://secure.travis-ci.org/pex/rack-reverse-proxy.png "Build Status")](http://travis-ci.org/pex/rack-reverse-proxy "Build Status")
+
+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
+```
+
+For your Gemfile use:
+
+```ruby
+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 `$`.
+
+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:
+
+```ruby
+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', username: 'name', password: 'basic_auth_secret'
+end
+
+app = proc do |env|
+  [ 200, {'Content-Type' => 'text/plain'}, "b" ]
+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.
+* 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 Jon Swope. See LICENSE for details.

README.rdoc

@@ -1,27 +1,10 @@
 require 'rubygems'
 require 'rake'
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-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'
+RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
 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-reverse-proxy #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

Rakefile

@@ -1 +1 @@
-0.4.4
+0.8.1

VERSION

@@ -0,0 +1,31 @@
+module Rack
+  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 {|matcher| matcher.to_s}.join(', ')
+    end
+  end
+end