rack-reverse-proxy 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff26702f215fd146c4a043bc583a058f7102001b
-  data.tar.gz: c451349b33d1715e57ce4da1652bba7f4a7b9192
+  metadata.gz: 5006b032a51816d16876f3a92b9a1e0435483832
+  data.tar.gz: 8c5b31b2cff31606543f2d216bc2937178926b1f
 SHA512:
-  metadata.gz: 0916fd37a7f4f5c4a63d3a51d01ad07f60c6a687fa45db392f1816dcb63dd82608b466f6451b7a169f7c66b252dceb697e0e0bdd8c86cad4a7fa145ce9895a4a
-  data.tar.gz: fb4a7b6158ffb9ae52c6689d0e71f95fdcbb1b0a1e131e7d3e5c7c2677096121af205b04be922d1521a075a35ae5ab9ba8ae9875ffab3aece726763a3b27a50c
+  metadata.gz: 20c79748659c8c1e0e52294322b7470a7f31cd4ac6c32e83f9d035044badb02f2c9ea5db1b97839c12e629643e26b6ecabced99f7ad6afdc80eccee015e87b38
+  data.tar.gz: 5990b64a3e455ecfc80f67d5c6059fc48fc1fb0eb94c266653d511459628f118e3158c40612dd7dfe0e2da887916cff8ab4a1ce07e8159d907de7fd35e03c033

data/README.md

@@ -53,6 +53,8 @@ run app
 * `:timeout` seconds to timout the requests
 * `:force_ssl` redirects to ssl version, if not already using it (requires `:replace_response_host`). Default: false.
 * `:verify_mode` the `OpenSSL::SSL` verify mode passed to Net::HTTP. Default: `OpenSSL::SSL::VERIFY_PEER`.
+* `:x_forwarded_headers` sets up proper `X-Forwarded-*` headers. Default: true.
+* `:preserve_encoding` Set to true to pass Accept-Encoding header to proxy server. Default: false.
 
 ### Sample usage in a Ruby on Rails app
 

data/lib/rack_reverse_proxy/middleware.rb

@@ -13,7 +13,8 @@ module RackReverseProxy
       @rules = []
       @global_options = {
         :preserve_host => true,
-        :x_forwarded_host => true,
+        :preserve_encoding => false,
+        :x_forwarded_headers => true,
         :matching => :all,
         :replace_response_host => false
       }

data/lib/rack_reverse_proxy/roundtrip.rb

@@ -84,13 +84,18 @@ module RackReverseProxy
       target_request_headers["HOST"] = host_header
     end
 
+    def preserve_encoding
+      return if options[:preserve_encoding]
+      target_request_headers.delete("Accept-Encoding")
+    end
+
     def host_header
       return uri.host if uri.port == uri.default_port
       "#{uri.host}:#{uri.port}"
     end
 
-    def set_forwarded_host
-      return unless options[:x_forwarded_host]
+    def set_forwarded_headers
+      return unless options[:x_forwarded_headers]
       target_request_headers["X-Forwarded-Host"] = source_request.host
       target_request_headers["X-Forwarded-Port"] = source_request.port.to_s
     end
@@ -178,7 +183,8 @@ module RackReverseProxy
 
     def setup_request
       preserve_host
-      set_forwarded_host
+      preserve_encoding
+      set_forwarded_headers
       initialize_http_header
       set_basic_auth
       setup_body

data/lib/rack_reverse_proxy/version.rb

@@ -1,4 +1,4 @@
 #:nodoc:
 module RackReverseProxy
-  VERSION = "0.10.0".freeze
+  VERSION = "0.11.0".freeze
 end

data/spec/rack/reverse_proxy_spec.rb

@@ -63,6 +63,15 @@ RSpec.describe Rack::ReverseProxy do
       expect(last_response.body).to eq("Proxied App2")
     end
 
+    it "returns headers from proxied app as strings" do
+      stub_request(:get, "http://example.com/test").to_return(
+        :body => "Proxied App",
+        :headers => { "Proxied-Header" => "TestValue" }
+      )
+      get "/test"
+      expect(last_response.headers["Proxied-Header"]).to eq("TestValue")
+    end
+
     it "sets the Host header w/o default port" do
       stub_request(:any, "example.com/test/stuff")
       get "/test/stuff"
@@ -83,6 +92,16 @@ RSpec.describe Rack::ReverseProxy do
       ).to have_been_made
     end
 
+    it "sets the X-Forwarded-Port header to the proxying port by default" do
+      stub_request(:any, "example.com/test/stuff")
+      get "/test/stuff"
+      expect(
+        a_request(:get, "http://example.com/test/stuff").with(
+          :headers => { "X-Forwarded-Port" => "80" }
+        )
+      ).to have_been_made
+    end
+
     it "does not produce headers with a Status key" do
       stub_request(:get, "http://example.com/2test").to_return(
         :status => 301, :headers => { :status => "301 Moved Permanently" }
@@ -128,6 +147,20 @@ RSpec.describe Rack::ReverseProxy do
       expect(last_response.headers["Content-Length"]).to eq(body.length.to_s)
     end
 
+    it "does not include Accept-Encoding header" do
+      stub_request(:any, "http://example.com/test")
+
+      get "/test", {}, "HTTP_ACCEPT_ENCODING" => "gzip, deflate"
+
+      expect(
+        a_request(:get, "http://example.com/test").with(
+          :headers => { "Accept-Encoding" => "gzip, deflate" }
+        )
+      ).not_to have_been_made
+
+      expect(a_request(:get, "http://example.com/test")).to have_been_made
+    end
+
     describe "with non-default port" do
       def app
         Rack::ReverseProxy.new(dummy_app) do
@@ -167,10 +200,30 @@ RSpec.describe Rack::ReverseProxy do
       end
     end
 
-    describe "with x_forwarded_host turned off" do
+    describe "with preserve encoding turned on" do
+      def app
+        Rack::ReverseProxy.new(dummy_app) do
+          reverse_proxy "/test", "http://example.com/", :preserve_encoding => true
+        end
+      end
+
+      it "sets the Accept-Encoding header" do
+        stub_request(:any, "http://example.com/test")
+
+        get "/test", {}, "HTTP_ACCEPT_ENCODING" => "gzip, deflate"
+
+        expect(
+          a_request(:get, "http://example.com/test").with(
+            :headers => { "Accept-Encoding" => "gzip, deflate" }
+          )
+        ).to have_been_made
+      end
+    end
+
+    describe "with x_forwarded_headers turned off" do
       def app
         Rack::ReverseProxy.new(dummy_app) do
-          reverse_proxy_options :x_forwarded_host => false
+          reverse_proxy_options :x_forwarded_headers => false
           reverse_proxy "/test", "http://example.com/"
         end
       end
@@ -185,6 +238,17 @@ RSpec.describe Rack::ReverseProxy do
         ).not_to have_been_made
         expect(a_request(:get, "http://example.com/test/stuff")).to have_been_made
       end
+
+      it "does not set the X-Forwarded-Port header to the proxying port" do
+        stub_request(:any, "example.com/test/stuff")
+        get "/test/stuff"
+        expect(
+          a_request(:get, "http://example.com/test/stuff").with(
+            :headers => { "X-Forwarded-Port" => "80" }
+          )
+        ).not_to have_been_made
+        expect(a_request(:get, "http://example.com/test/stuff")).to have_been_made
+      end
     end
 
     describe "with timeout configuration" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-reverse-proxy
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jon Swope
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack