rack-proxy 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9520dd879490c3e4e00d0617a74994fd178488878cf149f44acc4795975609e
-  data.tar.gz: 99c9ea6a98cbae6713c03f4ac4a6b87cf682a9189c073f29ecd5845d3ddc5c7e
+  metadata.gz: e5728c44041f0dddc056d3ebc1b35e5429e3319115c07ade4e98278d02f5ffc2
+  data.tar.gz: 2d0a518195f43bb38557ab68c00c8bce11f234675fa1a4e1f242b3ce177d83f6
 SHA512:
-  metadata.gz: f5b53e01fef046f99405006fcb5b60f053ede10fc23bb231ad27deebbe52593d1ad1fcd1ba77471dcb76405c65a9d7a3a685ed13caea6bdb1dbf927ad19ffffc
-  data.tar.gz: 940b3f2ba7a1248475799497e757a9a9be8875e933ef47b0fdc583181d0368804c56d0bd5b356860c169e4bdd9e68f2cfd6b7c6f273b9d542fd5bdd93b6e7f46
+  metadata.gz: 353fc92d5a941f141f18f17d885506ff51098756687fcab816aa7e61fa5ace9e62a2658530c23d917f059d36db6585988f80d829a2818036f4f232d02436cf4e
+  data.tar.gz: 8874cf1e8ee86ad08db5b894ed9eb5e9975f1b43cf1c46e3b2422e720f57356b683a3c0782cd682435567506afeee690f90030e540b532a4c992b5724e9d820b

data/Gemfile.lock

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

data/README.md

@@ -43,6 +43,7 @@ Options can be set when initializing the middleware or overriding a method.
 * `: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
+* `:logger` - any object responding to `#<<` (e.g. `$stdout`, a `StringIO`, or a Ruby `Logger`). Wired through to `Net::HTTP#set_debug_output` so the full HTTP wire-level conversation is written to the sink. Useful for debugging.
 
 To pass in options, when you configure your middleware you can pass them in as an optional hash.
 

data/lib/rack/http_streaming_response.rb

@@ -10,7 +10,7 @@ module Rack
       304 => true
     }.freeze
 
-    attr_accessor :use_ssl, :verify_mode, :read_timeout, :ssl_version, :cert, :key
+    attr_accessor :use_ssl, :verify_mode, :read_timeout, :ssl_version, :cert, :key, :logger
 
     def initialize(request, host, port = nil)
       @request, @host, @port = request, host, port
@@ -61,6 +61,7 @@ module Rack
         http.ssl_version = ssl_version if ssl_version
         http.cert = cert if cert
         http.key = key if key
+        http.set_debug_output(logger) if logger
         http.start
       end
     end

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.8.0".freeze
+    VERSION = "0.8.1".freeze
 
     HOP_BY_HOP_HEADERS = {
       'connection' => true,
@@ -83,6 +83,10 @@ module Rack
       @username = opts[:username]
       @password = opts[:password]
 
+      # Optional logger for Net::HTTP debug output. Accepts anything with a #<< method
+      # (e.g. $stdout, a StringIO, or a Ruby Logger instance).
+      @logger = opts[:logger]
+
       @opts = opts
     end
 
@@ -143,6 +147,7 @@ module Rack
           target_response.verify_mode = (@verify_mode || OpenSSL::SSL::VERIFY_PEER) if use_ssl
           target_response.cert = @cert if @cert
           target_response.key = @key if @key
+          target_response.logger = @logger if @logger
         else
           http = Net::HTTP.new(backend.host, backend.port)
           http.use_ssl = use_ssl if use_ssl
@@ -151,6 +156,7 @@ module Rack
           http.verify_mode = @verify_mode || OpenSSL::SSL::VERIFY_PEER if use_ssl
           http.cert = @cert if @cert
           http.key = @key if @key
+          http.set_debug_output(@logger) if @logger
 
           target_response = http.start do
             http.request(target_request)

data/test/rack_proxy_test.rb

@@ -226,6 +226,41 @@ class RackProxyTest < Test::Unit::TestCase
     assert last_response.ok?
   end
 
+  # Issue #80: a :logger option should pipe Net::HTTP debug output to the
+  # given sink (anything responding to #<<). We use a StringIO to capture it.
+  def test_logger_captures_request_in_non_streaming
+    sink = StringIO.new
+    with_webrick_proxy(streaming: false, logger: sink) do |port, proxy|
+      proxy.host = "127.0.0.1:#{port}"
+      get '/empty'
+      assert last_response.ok?
+    end
+    assert_match(/GET \/empty/, sink.string,
+      "expected debug output to include request line, got: #{sink.string.inspect}")
+  end
+
+  def test_logger_captures_request_in_streaming
+    sink = StringIO.new
+    with_webrick_proxy(streaming: true, logger: sink) do |port, proxy|
+      proxy.host = "127.0.0.1:#{port}"
+      get '/empty'
+      assert last_response.ok?
+    end
+    assert_match(/GET \/empty/, sink.string,
+      "expected debug output to include request line, got: #{sink.string.inspect}")
+  end
+
+  def test_no_logger_means_no_debug_output
+    # Without a :logger option, Net::HTTP's set_debug_output should never be
+    # called. We can't directly assert that, but we can confirm requests still
+    # work when no logger is configured (covered by every other test).
+    with_webrick_proxy(streaming: false) do |port, proxy|
+      proxy.host = "127.0.0.1:#{port}"
+      get '/empty'
+      assert last_response.ok?
+    end
+  end
+
   private
 
   def assert_no_array_header_values(streaming:)
@@ -242,7 +277,7 @@ class RackProxyTest < Test::Unit::TestCase
 
   # Spin up a tiny WEBrick server with fixed routes so we can exercise the
   # proxy against real Net::HTTP requests without depending on a remote host.
-  def with_webrick_proxy(streaming:)
+  def with_webrick_proxy(**proxy_opts)
     require 'webrick'
     server = WEBrick::HTTPServer.new(
       Port: 0,
@@ -260,7 +295,7 @@ class RackProxyTest < Test::Unit::TestCase
     Thread.new { server.start }
     port = server.config[:Port]
 
-    proxy = HostProxy.new(streaming: streaming)
+    proxy = HostProxy.new(**proxy_opts)
     @app = proxy
     yield port, proxy
   ensure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-proxy
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Jacek Becela