rack-proxy 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cd49adb5cd0843a5467ecf9cacc3a5d7f3c903d
-  data.tar.gz: 64cc29bbc91ee24fbe14e200b3b69b5e8b2c0e71
+  metadata.gz: ce99adfb07beb9e42b72e91bd39860d2ec1efb7b
+  data.tar.gz: dfb0ede7fc70291ba58a24c7a478691f2fa5558f
 SHA512:
-  metadata.gz: 2986ff1e4178e92f172cdedcd38a8f7617f7d532018c1d687edecfe0bd694583a4ba409620c875b86b4d836a0e9926be078fd8aa99052c724b4fdb9f2468a774
-  data.tar.gz: 0915046fbf017fee515398ca66f78515a4fcfa551f95a6c9134cceebf54e310040f0cfce2d325e75f8e95e0d386647a98cf61247396d321a98d56ff1f133f120
+  metadata.gz: 602c219b1b8151a7b77f1e6751d0919cc320cc13c6b0c0ce2f4c2a7c16dca345688ad3b3a4a109480660856a0ee7125ec36d892c97a22fb92a973e8b0a7bc005
+  data.tar.gz: 897c3d1db3ab71a70ce88bb9437b4a7be25cae6db20b2601f20e227b558a4a6b02416997dad68b03a7d38d0d6948bca74d3739fabfd877c0876043ea42a34dc6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-proxy (0.6.2)
+    rack-proxy (0.6.4)
       rack
 
 GEM

data/README.md

@@ -1,12 +1,12 @@
 A request/response rewriting HTTP proxy. A Rack app. Subclass `Rack::Proxy` and provide your `rewrite_env` and `rewrite_response` methods.
 
 Installation
--------
+----
 
-Add the following to your Gemfile:
+Add the following to your `Gemfile`:
 
 ```
-gem 'rack-proxy', '~> 0.6.3'
+gem 'rack-proxy', '~> 0.6.4'
 ```
 
 Or install:
@@ -15,22 +15,72 @@ Or install:
 gem install rack-proxy
 ```
 
-Example
--------
+Use Cases
+----
+Below are some examples of real world use cases for Rack-Proxy, done something interesting add the list below and send a PR.
+
+* Allowing one app to act as central trust authority
+  * handle accepting self-sign certificates for internal apps
+  * authentication / authorization prior to proxying requests to a blindly trusting backend
+  * avoiding CORs complications by proxying from same domain to another backend
+* subdomain based pass-through to multiple apps
+* Complex redirect rules
+   * redirect pages with different extensions (ex: `.php`) to another app 
+   * useful for handling awkward redirection rules for moved pages
+* fan Parallel Requests: turning a single API request to [multiple concurrent backend requests](https://github.com/typhoeus/typhoeus#making-parallel-requests) & merging results.
+* inserting or stripping headers required or problematic for certain clients
+
+Options
+----
+
+Options can be set when initializing the middleware or overriding a method.
+
+
+* `:streaming` - defaults to `true`, but does not work on all Ruby versions, recommend to set to `false`
+* `:ssl_verify_none` - tell `Net::HTTP` to not validate certs
+* `:ssl_version` - tell `Net::HTTP` to set a specific `ssl_version`
+* `:backend` - the URI parseable format of host and port of the target proxy backend. If not set it will assume the backend target is the same as the source.
+* `:read_timeout` - set proxy timeout it defaults to 60 seconds
+
+To pass in options, when you configure your middleware you can pass them in as an optional hash.
 
 ```ruby
-class Foo < Rack::Proxy
+Rails.application.config.middleware.use ExampleServiceProxy, backend: 'http://guides.rubyonrails.org', streaming: false
+```
+
+Examples
+----
+
+See and run the examples below from `lib/rack_proxy_examples/`. To mount any example into an existing Rails app:
+
+1. create `config/initializers/proxy.rb`
+2. modify the file to require the example file
+```ruby
+require 'rack_proxy_examples/forward_host'
+```
+
+### Forward request to Host and Insert Header
+
+Test with `require 'rack_proxy_examples/forward_host'`
+
+```ruby
+class ForwardHost < Rack::Proxy
 
   def rewrite_env(env)
     env["HTTP_HOST"] = "example.com"
-
     env
   end
 
   def rewrite_response(triplet)
     status, headers, body = triplet
 
+    # example of inserting an additional header
     headers["X-Foo"] = "Bar"
+    
+    # if you rewrite env, it appears that content-length isn't calculated correctly
+    # resulting in only partial responses being sent to users
+    # you can remove it or recalculate it here
+    headers["content-length"] = nil
 
     triplet
   end
@@ -40,15 +90,30 @@ end
 
 ### Disable SSL session verification when proxying a server with e.g. self-signed SSL certs
 
+Test with `require 'rack_proxy_examples/trusting_proxy'`
+
 ```ruby
 class TrustingProxy < Rack::Proxy
 
   def rewrite_env(env)
-    env["rack.ssl_verify_none"] = true
+    env["HTTP_HOST"] = "self-signed.badssl.com"
 
+    # We are going to trust the self-signed SSL 
+    env["rack.ssl_verify_none"] = true
     env
   end
 
+  def rewrite_response(triplet)
+    status, headers, body = triplet
+    
+    # if you rewrite env, it appears that content-length isn't calculated correctly
+    # resulting in only partial responses being sent to users
+    # you can remove it or recalculate it here
+    headers["content-length"] = nil
+
+    triplet
+  end
+
 end
 ```
 
@@ -58,31 +123,98 @@ The same can be achieved for *all* requests going through the `Rack::Proxy` inst
 Rack::Proxy.new(ssl_verify_none: true)
 ```
 
-Using it as a middleware:
--------------------------
+### Rails middleware example
+
+Test with `require 'rack_proxy_examples/example_service_proxy'`
+
+```ruby
+###
+# This is an example of how to use Rack-Proxy in a Rails application.
+#  
+# Setup:
+# 1. rails new test_app 
+# 2. cd test_app
+# 3. install Rack-Proxy in `Gemfile`
+#    a. `gem 'rack-proxy', '~> 0.6.3'`
+# 4. install gem: `bundle install`
+# 5. create `config/initializers/proxy.rb` adding this line `require 'rack_proxy_examples/example_service_proxy'`
+# 6. run: `SERVICE_URL=http://guides.rubyonrails.org rails server`
+# 7. open in browser: `http://localhost:3000/example_service`
+#
+###
+ENV['SERVICE_URL'] ||= 'http://guides.rubyonrails.org'
+
+class ExampleServiceProxy < Rack::Proxy
+  def perform_request(env)
+    request = Rack::Request.new(env)
+
+    # use rack proxy for anything hitting our host app at /example_service
+    if request.path =~ %r{^/example_service}
+        backend = URI(ENV['SERVICE_URL'])
+        # most backends required host set properly, but rack-proxy doesn't set this for you automatically
+        # even when a backend host is passed in via the options
+        env["HTTP_HOST"] = backend.host
+
+        # This is the only path that needs to be set currently on Rails 5 & greater
+        env['PATH_INFO'] = ENV['SERVICE_PATH'] || '/configuring.html'
+        
+        # don't send your sites cookies to target service, unless it is a trusted internal service that can parse all your cookies
+        env['HTTP_COOKIE'] = ''
+        super(env)
+    else
+      @app.call(env)
+    end
+  end
+end
+```
+
+### Using as middleware to forward only some extensions to another Application
+
+Test with `require 'rack_proxy_examples/rack_php_proxy'`
 
 Example: Proxying only requests that end with ".php" could be done like this:
 
 ```ruby
-require 'rack/proxy'
+###
+# Open http://localhost:3000/test.php to trigger proxy
+###
 class RackPhpProxy < Rack::Proxy
 
   def perform_request(env)
     request = Rack::Request.new(env)
     if request.path =~ %r{\.php}
-      env["HTTP_HOST"] = "localhost"
-      env["REQUEST_PATH"] = "/php/#{request.fullpath}"
+      env["HTTP_HOST"] = ENV["HTTP_HOST"] ? URI(ENV["HTTP_HOST"]).host : "localhost"
+      ENV["PHP_PATH"] ||= '/manual/en/tutorial.firstpage.php'
+       
+      # Rails 3 & 4
+      env["REQUEST_PATH"] = ENV["PHP_PATH"] || "/php/#{request.fullpath}"
+      # Rails 5 and above
+      env['PATH_INFO'] = ENV["PHP_PATH"] || "/php/#{request.fullpath}"
+
+      env['content-length'] = nil
+      
       super(env)
     else
       @app.call(env)
     end
   end
+
+  def rewrite_response(triplet)
+    status, headers, body = triplet
+    
+    # if you proxy depending on the backend, it appears that content-length isn't calculated correctly
+    # resulting in only partial responses being sent to users
+    # you can remove it or recalculate it here
+    headers["content-length"] = nil
+
+    triplet
+  end
 end
 ```
 
 To use the middleware, please consider the following:
 
-1) For Rails we could add a configuration in config/application.rb
+1) For Rails we could add a configuration in `config/application.rb`
 
 ```ruby
   config.middleware.use RackPhpProxy, {ssl_verify_none: true}
@@ -101,11 +233,13 @@ This will allow to run the other requests through the application and only proxy
 See tests for more examples.
 
 WARNING
--------
+----
 
-Doesn't work with fakeweb/webmock. Both libraries monkey-patch net/http code.
+Doesn't work with `fakeweb`/`webmock`. Both libraries monkey-patch net/http code.
 
 Todos
------
+----
 
--	Make the docs up to date with the current use case for this code: everything except streaming which involved a rather ugly monkey patch and only worked in 1.8, but does not work now.
+* Make the docs up to date with the current use case for this code: everything except streaming which involved a rather ugly monkey patch and only worked in 1.8, but does not work now.
+* Improve and validate requirements for Host and Path rewrite rules
+* Ability to inject logger and set log level

data/lib/net_http_hacked.rb

@@ -4,11 +4,11 @@
 #
 # [status, headers, streamable_body]
 #
-# See http://github.com/aniero/rack-streaming-proxy 
+# See http://github.com/aniero/rack-streaming-proxy
 # for alternative that uses additional process.
 #
 # BTW I don't like monkey patching either
-# but this is not real monkey patching. 
+# but this is not real monkey patching.
 # I just added some methods and named them very uniquely
 # to avoid eventual conflicts. You're safe. Trust me.
 #
@@ -45,7 +45,7 @@ class Net::HTTP
   #
   #   res
   # end
-  
+
   def begin_request_hacked(req)
     begin_transport req
     req.exec @socket, @curr_http_version, edit_path(req.path)
@@ -56,7 +56,7 @@ class Net::HTTP
     @req_hacked, @res_hacked = req, res
     @res_hacked
   end
-  
+
   def end_request_hacked
     @res_hacked.end_reading_body_hacked
     end_transport @req_hacked, @res_hacked
@@ -77,12 +77,12 @@ class Net::HTTPResponse
   #     @socket = nil
   #   end
   # end
-  
+
   def begin_reading_body_hacked(sock, reqmethodallowbody)
     @socket = sock
     @body_exist = reqmethodallowbody && self.class.body_permitted?
   end
-  
+
   def end_reading_body_hacked
     self.body
     @socket = nil

data/lib/rack/proxy.rb

@@ -5,7 +5,7 @@ module Rack
 
   # Subclass and bring your own #rewrite_request and #rewrite_response
   class Proxy
-    VERSION = "0.6.3"
+    VERSION = "0.6.4"
 
     class << self
       def extract_http_request_headers(env)

data/lib/rack_proxy_examples/example_service_proxy.rb

@@ -0,0 +1,40 @@
+###
+# This is an example of how to use Rack-Proxy in a Rails application.
+#  
+# Setup:
+# 1. rails new test_app 
+# 2. cd test_app
+# 3. install Rack-Proxy in `Gemfile`
+#    a. `gem 'rack-proxy', '~> 0.6.3'`
+# 4. install gem: `bundle install`
+# 5. create `config/initializers/proxy.rb` adding this line `require 'rack_proxy_examples/example_service_proxy'`
+# 6. run: `SERVICE_URL=http://guides.rubyonrails.org rails server`
+# 7. open in browser: `http://localhost:3000/example_service`
+#
+###
+ENV['SERVICE_URL'] ||= 'http://guides.rubyonrails.org'
+
+class ExampleServiceProxy < Rack::Proxy
+  def perform_request(env)
+    request = Rack::Request.new(env)
+
+    # use rack proxy for anything hitting our host app at /example_service
+    if request.path =~ %r{^/example_service}
+        backend = URI(ENV['SERVICE_URL'])
+        # most backends required host set properly, but rack-proxy doesn't set this for you automatically
+        # even when a backend host is passed in via the options
+        env["HTTP_HOST"] = backend.host
+
+        # This is the only path that needs to be set currently on Rails 5 & greater
+        env['PATH_INFO'] = ENV['SERVICE_PATH'] || '/configuring.html'
+        
+        # don't send your sites cookies to target service, unless it is a trusted internal service that can parse all your cookies
+        env['HTTP_COOKIE'] = ''
+        super(env)
+    else
+      @app.call(env)
+    end
+  end
+end
+
+Rails.application.config.middleware.use ExampleServiceProxy, backend: ENV['SERVICE_URL'], streaming: false

data/lib/rack_proxy_examples/forward_host.rb

@@ -0,0 +1,24 @@
+class ForwardHost < Rack::Proxy
+
+  def rewrite_env(env)
+    env["HTTP_HOST"] = "example.com"
+    env
+  end
+
+  def rewrite_response(triplet)
+    status, headers, body = triplet
+
+    # example of inserting an additional header
+    headers["X-Foo"] = "Bar"
+    
+    # if you rewrite env, it appears that content-length isn't calculated correctly
+    # resulting in only partial responses being sent to users
+    # you can remove it or recalculate it here
+    headers["content-length"] = nil
+
+    triplet
+  end
+
+end
+
+Rails.application.config.middleware.use ForwardHost, backend: 'http://example.com', streaming: false

data/lib/rack_proxy_examples/rack_php_proxy.rb

@@ -0,0 +1,37 @@
+###
+# Open http://localhost:3000/test.php to trigger proxy
+###
+class RackPhpProxy < Rack::Proxy
+
+  def perform_request(env)
+    request = Rack::Request.new(env)
+    if request.path =~ %r{\.php}
+      env["HTTP_HOST"] = ENV["HTTP_HOST"] ? URI(ENV["HTTP_HOST"]).host : "localhost"
+      ENV["PHP_PATH"] ||= '/manual/en/tutorial.firstpage.php'
+       
+      # Rails 3 & 4
+      env["REQUEST_PATH"] = ENV["PHP_PATH"] || "/php/#{request.fullpath}"
+      # Rails 5 and above
+      env['PATH_INFO'] = ENV["PHP_PATH"] || "/php/#{request.fullpath}"
+
+      env['content-length'] = nil
+      
+      super(env)
+    else
+      @app.call(env)
+    end
+  end
+
+  def rewrite_response(triplet)
+    status, headers, body = triplet
+    
+    # if you proxy depending on the backend, it appears that content-length isn't calculated correctly
+    # resulting in only partial responses being sent to users
+    # you can remove it or recalculate it here
+    headers["content-length"] = nil
+
+    triplet
+  end
+end
+
+Rails.application.config.middleware.use RackPhpProxy, backend: ENV["HTTP_HOST"]='http://php.net', streaming: false

data/lib/rack_proxy_examples/trusting_proxy.rb

@@ -0,0 +1,24 @@
+class TrustingProxy < Rack::Proxy
+
+  def rewrite_env(env)
+    env["HTTP_HOST"] = "self-signed.badssl.com"
+
+    # We are going to trust the self-signed SSL 
+    env["rack.ssl_verify_none"] = true
+    env
+  end
+
+  def rewrite_response(triplet)
+    status, headers, body = triplet
+    
+    # if you rewrite env, it appears that content-length isn't calculated correctly
+    # resulting in only partial responses being sent to users
+    # you can remove it or recalculate it here
+    headers["content-length"] = nil
+
+    triplet
+  end
+
+end
+
+Rails.application.config.middleware.use TrustingProxy, backend: 'https://self-signed.badssl.com', streaming: false

data/rack-proxy.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jacek Becela"]
   s.email       = ["jacek.becela@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/rack-proxy"
+  s.homepage    = "https://github.com/ncr/rack-proxy"
   s.summary     = %q{A request/response rewriting HTTP proxy. A Rack app.}
   s.description = %q{A Rack app that provides request/response rewriting proxy capabilities with streaming.}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-proxy
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Jacek Becela
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -71,12 +71,16 @@ files:
 - lib/rack-proxy.rb
 - lib/rack/http_streaming_response.rb
 - lib/rack/proxy.rb
+- lib/rack_proxy_examples/example_service_proxy.rb
+- lib/rack_proxy_examples/forward_host.rb
+- lib/rack_proxy_examples/rack_php_proxy.rb
+- lib/rack_proxy_examples/trusting_proxy.rb
 - rack-proxy.gemspec
 - test/http_streaming_response_test.rb
 - test/net_http_hacked_test.rb
 - test/rack_proxy_test.rb
 - test/test_helper.rb
-homepage: http://rubygems.org/gems/rack-proxy
+homepage: https://github.com/ncr/rack-proxy
 licenses: []
 metadata: {}
 post_install_message: 
@@ -95,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rack-proxy
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: A request/response rewriting HTTP proxy. A Rack app.