rack-proxy 0.7.7 → 1.0.1

data/rack-proxy.gemspec

@@ -1,25 +1,30 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "rack-proxy"
+require "rack/proxy/version"
 
 Gem::Specification.new do |s|
-  s.name        = "rack-proxy"
-  s.version     = Rack::Proxy::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.license     = 'MIT'
-  s.authors     = ["Jacek Becela"]
-  s.email       = ["jacek.becela@gmail.com"]
-  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.}
-  s.required_ruby_version = '>= 2.6'
+  s.name = "rack-proxy"
+  s.version = Rack::Proxy::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.license = "MIT"
+  s.authors = ["Jacek Becela"]
+  s.email = ["jacek.becela@gmail.com"]
+  s.homepage = "https://github.com/ncr/rack-proxy"
+  s.summary = "A request/response rewriting HTTP proxy. A Rack app."
+  s.description = "A Rack app that provides request/response rewriting proxy capabilities with streaming."
+  s.required_ruby_version = ">= 3.0"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.metadata = {
+    "source_code_uri" => "https://github.com/ncr/rack-proxy",
+    "changelog_uri" => "https://github.com/ncr/rack-proxy/blob/master/CHANGELOG.md",
+    "bug_tracker_uri" => "https://github.com/ncr/rack-proxy/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
+  s.files = Dir["lib/**/*.rb"] + %w[README.md LICENSE CHANGELOG.md SECURITY.md rack-proxy.gemspec]
   s.require_paths = ["lib"]
 
-  s.add_dependency("rack")
+  s.add_dependency("rack", ">= 2.0", "< 4")
   s.add_development_dependency("rack-test")
   s.add_development_dependency("test-unit")
+  s.add_development_dependency("webrick")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-proxy
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 1.0.1
 platform: ruby
 authors:
 - Jacek Becela
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2026-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Rack app that provides request/response rewriting proxy capabilities
   with streaming.
 email:
@@ -60,31 +80,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
-- lib/net_http_hacked.rb
+- SECURITY.md
 - 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
+- lib/rack/proxy/version.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: https://github.com/ncr/rack-proxy
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/ncr/rack-proxy
+  changelog_uri: https://github.com/ncr/rack-proxy/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ncr/rack-proxy/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -93,19 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A request/response rewriting HTTP proxy. A Rack app.
-test_files:
-- test/http_streaming_response_test.rb
-- test/net_http_hacked_test.rb
-- test/rack_proxy_test.rb
-- test/test_helper.rb
+test_files: []

data/.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: [ncr]

data/.gitignore

@@ -1,3 +0,0 @@
-pkg/*
-*.gem
-.bundle

data/.travis.yml

@@ -1,18 +0,0 @@
-cache: bundler
-language: ruby
-before_install:
-  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
-  - gem install bundler
-  - gem update bundler
-script: bundle exec rake test
-rvm:
-  - 2.0.0
-  - 2.1.5
-  - 2.2.2
-  - 2.2.3
-  - 2.3.0
-  - 2.3.1
-env:
- - RAILS_ENV=test RACK_ENV=test
-notifications:
-  email: false

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gem 'rake'
-
-# Specify your gem's dependencies in rack-proxy.gemspec
-gemspec

data/Gemfile.lock

@@ -1,28 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rack-proxy (0.7.7)
-      rack
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    power_assert (2.0.3)
-    rack (3.0.8)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rake (13.0.6)
-    test-unit (3.6.1)
-      power_assert
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  rack-proxy!
-  rack-test
-  rake
-  test-unit
-
-BUNDLED WITH
-   2.4.17

data/Rakefile

@@ -1,14 +0,0 @@
-require 'rubygems'
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require "rake/testtask"
-task :test do
-  Rake::TestTask.new do |t|
-    t.libs << "test"
-    t.test_files = FileList['test/*_test.rb']
-    t.verbose = true
-  end
-end
-
-task :default => :test

data/lib/net_http_hacked.rb

@@ -1,90 +0,0 @@
-# We are hacking net/http to change semantics of streaming handling
-# from "block" semantics to regular "return" semantics.
-# We need it to construct a streamable rack triplet:
-#
-# [status, headers, streamable_body]
-#
-# See http://github.com/zerowidth/rack-streaming-proxy
-# for alternative that uses additional process.
-#
-# BTW I don't like monkey patching either
-# 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.
-#
-# Also, in Ruby 1.9.2 you could use Fibers to avoid hacking net/http.
-
-require 'net/https'
-
-class Net::HTTP
-  # Original #request with block semantics.
-  #
-  # def request(req, body = nil, &block)
-  #   unless started?
-  #     start {
-  #       req['connection'] ||= 'close'
-  #       return request(req, body, &block)
-  #     }
-  #   end
-  #   if proxy_user()
-  #     unless use_ssl?
-  #       req.proxy_basic_auth proxy_user(), proxy_pass()
-  #     end
-  #   end
-  #
-  #   req.set_body_internal body
-  #   begin_transport req
-  #     req.exec @socket, @curr_http_version, edit_path(req.path)
-  #     begin
-  #       res = HTTPResponse.read_new(@socket)
-  #     end while res.kind_of?(HTTPContinue)
-  #     res.reading_body(@socket, req.response_body_permitted?) {
-  #       yield res if block_given?
-  #     }
-  #   end_transport req, res
-  #
-  #   res
-  # end
-
-  def begin_request_hacked(req)
-    begin_transport req
-    req.exec @socket, @curr_http_version, edit_path(req.path)
-    begin
-      res = Net::HTTPResponse.read_new(@socket)
-    end while res.kind_of?(Net::HTTPContinue)
-    res.begin_reading_body_hacked(@socket, req.response_body_permitted?)
-    @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
-    @res_hacked
-  end
-end
-
-class Net::HTTPResponse
-  # Original #reading_body with block semantics
-  #
-  # def reading_body(sock, reqmethodallowbody)  #:nodoc: internal use only
-  #   @socket = sock
-  #   @body_exist = reqmethodallowbody && self.class.body_permitted?
-  #   begin
-  #     yield
-  #     self.body   # ensure to read body
-  #   ensure
-  #     @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
-  end
-end

data/lib/rack_proxy_examples/example_service_proxy.rb

@@ -1,40 +0,0 @@
-###
-# 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.7.7'`
-# 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

@@ -1,24 +0,0 @@
-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

@@ -1,37 +0,0 @@
-###
-# 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

@@ -1,24 +0,0 @@
-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/test/http_streaming_response_test.rb

@@ -1,48 +0,0 @@
-require "test_helper"
-require "rack/http_streaming_response"
-
-class HttpStreamingResponseTest < Test::Unit::TestCase
-
-  def setup
-    host, req = "example.com", Net::HTTP::Get.new("/")
-    @response = Rack::HttpStreamingResponse.new(req, host, 443)
-    @response.use_ssl = true
-  end
-
-  def test_streaming
-    # Response status
-    assert_equal 200, @response.status
-    assert_equal 200, @response.status
-
-    # Headers
-    headers = @response.headers
-
-    assert headers.size.positive?
-
-    assert_match %r{text/html; ?charset=utf-8}, headers["content-type"].first.downcase
-    assert_equal headers["content-type"], headers["CoNtEnT-TyPe"]
-    assert headers["content-length"].first.to_i.positive?
-
-    # Body
-    chunks = []
-    @response.body.each do |chunk|
-      chunks << chunk
-    end
-
-    assert chunks.size.positive?
-    chunks.each do |chunk|
-      assert chunk.is_a?(String)
-    end
-
-  end
-
-  def test_to_s
-    assert_equal @response.headers["Content-Length"].first.to_i, @response.body.to_s.bytesize
-  end
-
-  def test_to_s_called_twice
-    body = @response.body
-    assert_equal body.to_s, body.to_s
-  end
-
-end

data/test/net_http_hacked_test.rb

@@ -1,36 +0,0 @@
-require "test_helper"
-require "net_http_hacked"
-
-class NetHttpHackedTest < Test::Unit::TestCase
-  
-  def test_net_http_hacked
-    req = Net::HTTP::Get.new("/")
-    http = Net::HTTP.start("www.iana.org", "80")
-
-    # Response code
-    res = http.begin_request_hacked(req)
-    assert res.code == "200"
-
-    # Headers
-    headers = {}
-    res.each_header { |k, v| headers[k] = v }
-
-    assert headers.size > 0
-    assert headers["content-type"] == "text/html; charset=UTF-8"
-    assert !headers["date"].nil?
-
-    # Body
-    chunks = []
-    res.read_body do |chunk|
-      chunks << chunk
-    end
-
-    assert chunks.size > 0
-    chunks.each do |chunk|
-      assert chunk.is_a?(String)
-    end
-
-    http.end_request_hacked
-  end
-  
-end

data/test/rack_proxy_test.rb

@@ -1,127 +0,0 @@
-require "test_helper"
-require "rack/proxy"
-
-class RackProxyTest < Test::Unit::TestCase
-  class HostProxy < Rack::Proxy
-    attr_accessor :host
-
-    def rewrite_env(env)
-      env["HTTP_HOST"] = self.host || 'example.com'
-      env
-    end
-  end
-
-  def app(opts = {})
-    return @app ||= HostProxy.new(opts)
-  end
-
-  def test_http_streaming
-    get "/"
-    assert last_response.ok?
-
-    assert_match(/Example Domain/, last_response.body)
-  end
-
-  def test_http_full_request
-    app(:streaming => false)
-    get "/"
-    assert last_response.ok?
-    assert_match(/Example Domain/, last_response.body)
-  end
-
-  def test_http_full_request_headers
-    app(:streaming => false)
-    app.host = 'www.google.com'
-    get "/"
-    assert !Array(last_response['Set-Cookie']).empty?, 'Google always sets a cookie, yo. Where my cookies at?!'
-  end
-
-  def test_https_streaming
-    app.host = 'www.apple.com'
-    get 'https://example.com'
-    assert last_response.ok?
-    assert_match(/(itunes|iphone|ipod|mac|ipad)/, last_response.body)
-  end
-
-  def test_https_streaming_tls
-    app(:ssl_version => :TLSv1).host = 'www.apple.com'
-    get 'https://example.com'
-    assert last_response.ok?
-    assert_match(/(itunes|iphone|ipod|mac|ipad)/, last_response.body)
-  end
-
-  def test_https_full_request
-    app(:streaming => false).host = 'www.apple.com'
-    get 'https://example.com'
-    assert last_response.ok?
-    assert_match(/(itunes|iphone|ipod|mac|ipad)/, last_response.body)
-  end
-
-  def test_https_full_request_tls
-    app({:streaming => false, :ssl_version => :TLSv1}).host = 'www.apple.com'
-    get 'https://example.com'
-    assert last_response.ok?
-    assert_match(/(itunes|iphone|ipod|mac|ipad)/, last_response.body)
-  end
-
-  def test_normalize_headers
-    proxy_class = Rack::Proxy
-    headers = { 'header_array' => ['first_entry'], 'header_non_array' => :entry }
-
-    normalized_headers = proxy_class.send(:normalize_headers, headers)
-    assert normalized_headers.instance_of?(Rack::Utils::HeaderHash)
-    assert normalized_headers['header_array'] == 'first_entry'
-    assert normalized_headers['header_non_array'] == :entry
-  end
-
-  def test_header_reconstruction
-    proxy_class = Rack::Proxy
-
-    header = proxy_class.send(:reconstruct_header_name, "HTTP_ABC")
-    assert header == "Abc"
-
-    header = proxy_class.send(:reconstruct_header_name, "HTTP_ABC_D")
-    assert header == "Abc-D"
-  end
-
-  def test_extract_http_request_headers
-    proxy_class = Rack::Proxy
-    env = {
-      'NOT-HTTP-HEADER' => 'test-value',
-      'HTTP_ACCEPT' => 'text/html',
-      'HTTP_CONNECTION' => nil,
-      'HTTP_CONTENT_MD5' => 'deadbeef',
-      'HTTP_HEADER.WITH.PERIODS' => 'stillmooing'
-    }
-
-    headers = proxy_class.extract_http_request_headers(env)
-    assert headers.key?('ACCEPT')
-    assert headers.key?('CONTENT-MD5')
-    assert headers.key?('HEADER.WITH.PERIODS')
-    assert !headers.key?('CONNECTION')
-    assert !headers.key?('NOT-HTTP-HEADER')
-  end
-
-  def test_duplicate_headers
-    proxy_class = Rack::Proxy
-    env = { 'Set-Cookie' => ["cookie1=foo", "cookie2=bar"] }
-
-    headers = proxy_class.normalize_headers(env)
-    assert headers['Set-Cookie'].include?('cookie1=foo'), "Include the first value"
-    assert headers['Set-Cookie'].include?("\n"), "Join multiple cookies with newlines"
-    assert headers['Set-Cookie'].include?('cookie2=bar'), "Include the second value"
-  end
-
-
-  def test_handles_missing_content_length
-    assert_nothing_thrown do
-      post "/", nil, "CONTENT_LENGTH" => nil
-    end
-  end
-
-  def test_response_header_included_Hop_by_hop
-    app({:streaming => true}).host = 'mockapi.io'
-    get 'https://example.com/oauth2/token/info?access_token=123'
-    assert !last_response.headers.key?('transfer-encoding')
-  end
-end