rails-threaded-proxy 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d445144a447e246d05ce8b70eeb0d7d12f209f842bc0c7253e47d1aa172aa6
-  data.tar.gz: 2fa990229d510d47e56f787f2a8901d0f837988d2d979a94fd6627ade95bf1b9
+  metadata.gz: fbc7f9b0318c1136497926119e07a245bacd9d017126add8a1da34e7426d79e0
+  data.tar.gz: 6506ac75b092ad1530ef54ceaf5d4c75775b3589cb1db2648afef0598e54c9de
 SHA512:
-  metadata.gz: eb263f91b43ecea9118da5a0c8612577c56dee6f395d027b66d0f6b80aa0ded6cf0a6a6b3ffc329c24aa0d2b383713ca8d02fafd20504134fedfb62671807814
-  data.tar.gz: cf2d19158dd8784f9f2a66a1ae82ae5529b9393e6108da7a11df9e1869bd3e8d2f9d4a56119ef207db3250ee121d7648e23f4b5e5dd3fa6a864dc28f216bb5d2
+  metadata.gz: 38bfa986e8033530bdddcf28a201ce18648bb8d8b46cd7d6738c8addc736aee573f685fc355d45072f6dcd4b632f22e5280891a67d56f7ccb75d9391d92300bb
+  data.tar.gz: 5a03daa8831574b0dc693916f11a7ebc8bfe8f409578a45e1de82f0f849b60c76dab4c929bf7c91322030f74ce6060df0eb99fdbab28390641df81f195844959

data/.rubocop.yml

@@ -0,0 +1,39 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'bin/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+   - 'lib/rails-threaded-proxy.rb'
+   - 'lib/threaded-proxy.rb'

data/Gemfile

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "actionpack"
-gem "addressable"
+gem 'actionpack'
+gem 'addressable'
 
 group :development do
-  gem "bundler", "~> 2.0"
-  gem "jeweler", "~> 2.3.9"
-  gem "nokogiri", ">= 1.16.7"
-  gem "rdoc", "~> 6.7.0"
-  gem "rspec", ">= 0"
-  gem "webrick", ">= 0"
+  gem 'bundler', '~> 2.0'
+  gem 'jeweler', '~> 2.3.9'
+  gem 'nokogiri', '>= 1.16.7'
+  gem 'rdoc', '~> 6.7.0'
+  gem 'rspec', '>= 0'
+  gem 'rubocop', '>= 0'
+  gem 'webrick', '>= 0'
 end

data/Gemfile.lock

@@ -30,6 +30,7 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.4.0)
+    ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
@@ -69,8 +70,10 @@ GEM
       rake
       rdoc
       semver2
+    json (2.7.2)
     jwt (2.9.3)
       base64
+    language_server-protocol (3.17.0.3)
     logger (1.6.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
@@ -99,6 +102,10 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
     psych (5.1.2)
       stringio
     racc (1.8.1)
@@ -114,10 +121,12 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
+    rainbow (3.1.1)
     rake (13.2.1)
     rchardet (1.8.0)
     rdoc (6.7.0)
       psych (>= 4.0.0)
+    regexp_parser (2.9.2)
     reline (0.5.10)
       io-console (~> 0.5)
     rspec (3.13.0)
@@ -133,12 +142,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     securerandom (0.3.1)
     semver2 (3.4.2)
     stringio (3.1.1)
     thread_safe (0.3.6)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
     useragent (0.16.10)
     webrick (1.8.2)
 
@@ -158,6 +181,7 @@ DEPENDENCIES
   nokogiri (>= 1.16.7)
   rdoc (~> 6.7.0)
   rspec
+  rubocop
   webrick
 
 BUNDLED WITH

data/Rakefile

@@ -1,12 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -14,13 +14,13 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "rails-threaded-proxy"
-  gem.homepage = "http://github.com/mnutt/rails-threaded-proxy"
-  gem.license = "MIT"
-  gem.summary = %Q{Threaded reverse proxy for Ruby on Rails}
-  gem.description = %Q{Threaded reverse proxy for Ruby on Rails}
-  gem.email = "michael@nuttnet.net"
-  gem.authors = ["Michael Nutt"]
+  gem.name = 'rails-threaded-proxy'
+  gem.homepage = 'http://github.com/mnutt/rails-threaded-proxy'
+  gem.license = 'MIT'
+  gem.summary = %(Threaded reverse proxy for Ruby on Rails)
+  gem.description = %(Threaded reverse proxy for Ruby on Rails)
+  gem.email = 'michael@nuttnet.net'
+  gem.authors = ['Michael Nutt']
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/lib/rails-threaded-proxy.rb

@@ -1 +1,3 @@
-require File.dirname(__FILE__) + '/threaded_proxy'
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/threaded_proxy"

data/lib/threaded-proxy.rb

@@ -1 +1,3 @@
-require File.dirname(__FILE__) + '/threaded_proxy'
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/threaded_proxy"

data/lib/threaded_proxy/client.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require 'addressable/uri'
+require 'active_support/notifications'
 require 'net/http'
 require_relative 'http'
 
 module ThreadedProxy
   class Client
-    DISALLOWED_RESPONSE_HEADERS = %w[keep-alive]
+    DISALLOWED_RESPONSE_HEADERS = %w[keep-alive].freeze
 
     METHODS = {
       'get' => Net::HTTP::Get,
@@ -14,62 +17,69 @@ module ThreadedProxy
       'head' => Net::HTTP::Head,
       'options' => Net::HTTP::Options,
       'trace' => Net::HTTP::Trace
-    }
+    }.freeze
 
     DEFAULT_OPTIONS = {
       headers: {},
-      debug: false
-    }
+      debug: false,
+      method: :get
+    }.freeze
 
-    def initialize(origin_url, options={})
+    def initialize(origin_url, options = {})
       @origin_url = Addressable::URI.parse(origin_url)
       @options = DEFAULT_OPTIONS.merge(options)
     end
 
     def log(message)
-      $stderr.puts message if @options[:debug]
+      warn message if @options[:debug]
     end
 
     def start(socket)
-      request_method = METHODS[(@options[:method] || 'GET').to_s.downcase]
-      http_request = request_method.new(@origin_url, @options[:headers].merge('Connection' => 'close'))
+      request_method = @options[:method].to_s.downcase
+      request_headers = @options[:headers].merge('Connection' => 'close')
+
+      request_class = METHODS[request_method]
+      http_request = request_class.new(@origin_url, request_headers)
       if @options[:body].respond_to?(:read)
         http_request.body_stream = @options[:body]
-      elsif String === @options[:body]
+      elsif @options[:body].is_a?(String)
         http_request.body = @options[:body]
       end
 
-      http = HTTP.new(@origin_url.host, @origin_url.port || default_port(@origin_url))
-      http.use_ssl = (@origin_url.scheme == 'https')
-      http.set_debug_output($stderr) if @options[:debug]
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @options[:ignore_ssl_errors]
+      ActiveSupport::Notifications.instrument('threaded_proxy.fetch', method: request_method, url: @origin_url.to_s,
+                                                                      headers: request_headers) do
+        http = HTTP.new(@origin_url.host, @origin_url.port || default_port(@origin_url))
+        http.use_ssl = (@origin_url.scheme == 'https')
+        http.set_debug_output($stderr) if @options[:debug]
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @options[:ignore_ssl_errors]
 
-      http.start do
-        http.request(http_request) do |client_response|
-          # We don't support reusing connections once we have disconnected them from rack
-          client_response['connection'] = 'close'
+        http.start do
+          http.request(http_request) do |client_response|
+            # We don't support reusing connections once we have disconnected them from rack
+            client_response['connection'] = 'close'
 
-          yield client_response if block_given?
+            yield client_response if block_given?
 
-          # start writing response
-          log("Writing response status and headers")
-          socket.write "HTTP/1.1 #{client_response.code} #{client_response.message}\r\n"
+            # start writing response
+            log('Writing response status and headers')
+            socket.write "HTTP/1.1 #{client_response.code} #{client_response.message}\r\n"
 
-          client_response.each_header do |key, value|
-            socket.write "#{key}: #{value}\r\n" unless DISALLOWED_RESPONSE_HEADERS.include?(key.downcase)
-          end
+            client_response.each_header do |key, value|
+              socket.write "#{key}: #{value}\r\n" unless DISALLOWED_RESPONSE_HEADERS.include?(key.downcase)
+            end
 
-          # Done with headers
-          socket.write "\r\n"
+            # Done with headers
+            socket.write "\r\n"
 
-          # There may have been some existing data in client_response's read buffer, flush it out
-          # before we manually connect the raw sockets
-          log("Flushing existing response buffer to client")
-          http.flush_existing_buffer_to(socket)
+            # There may have been some existing data in client_response's read buffer, flush it out
+            # before we manually connect the raw sockets
+            log('Flushing existing response buffer to client')
+            http.flush_existing_buffer_to(socket)
 
-          # Copy the rest of the client response to the socket
-          log("Copying response body to client")
-          http.copy_to(socket)
+            # Copy the rest of the client response to the socket
+            log('Copying response body to client')
+            http.copy_to(socket)
+          end
         end
       end
     end
@@ -80,8 +90,6 @@ module ThreadedProxy
         80
       when 'https'
         443
-      else
-        nil
       end
     end
   end

data/lib/threaded_proxy/controller.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'client'
 
 module ThreadedProxy
   module Controller
-    def proxy_fetch(origin_url, options={})
+    def proxy_fetch(origin_url, options = {})
       # hijack the response so we can take it outside of the rack request/response cycle
       request.env['rack.hijack'].call
       socket = request.env['rack.hijack_io']
@@ -17,12 +19,10 @@ module ThreadedProxy
           elsif request.env['CONTENT_LENGTH']
             options[:headers]['content-length'] = request.env['CONTENT_LENGTH'].to_s
           else
-            raise "Cannot proxy a non-chunked POST request without content-length"
+            raise 'Cannot proxy a non-chunked POST request without content-length'
           end
 
-          if request.env['CONTENT_TYPE']
-            options[:headers]['Content-Type'] = request.env['CONTENT_TYPE']
-          end
+          options[:headers]['Content-Type'] = request.env['CONTENT_TYPE'] if request.env['CONTENT_TYPE']
         end
 
         client = Client.new(origin_url, options)

data/lib/threaded_proxy/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 
 module ThreadedProxy
@@ -5,6 +7,7 @@ module ThreadedProxy
     def flush_existing_buffer_to(dest_socket)
       while (data = @socket.send(:rbuf_consume))
         break if data.empty?
+
         dest_socket.write data
       end
 
@@ -27,7 +30,7 @@ module ThreadedProxy
 
     # We read the response ourselves; don't need net/http to try to read it again
     def hijack_response(res)
-      res.instance_variable_set("@read", true)
+      res.instance_variable_set('@read', true)
       res
     end
   end

data/lib/threaded_proxy.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 require 'threaded_proxy/client'
 require 'threaded_proxy/controller'
 
 module ThreadedProxy
   def version
-    File.open(File.expand_path("../../VERSION", __FILE__)).read.strip
+    File.open(File.expand_path('../VERSION', __dir__)).read.strip
   end
-
-  extend self
 end

data/rails-threaded-proxy.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rails-threaded-proxy 0.2.0 ruby lib
+# stub: rails-threaded-proxy 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails-threaded-proxy".freeze
-  s.version = "0.2.0".freeze
+  s.version = "0.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -14,13 +14,14 @@ Gem::Specification.new do |s|
   s.date = "2024-10-14"
   s.description = "Threaded reverse proxy for Ruby on Rails".freeze
   s.email = "michael@nuttnet.net".freeze
-  s.executables = ["bundle".freeze, "htmldiff".freeze, "jeweler".freeze, "ldiff".freeze, "nokogiri".freeze, "racc".freeze, "rackup".freeze, "rake".freeze, "rdoc".freeze, "ri".freeze, "rspec".freeze, "semver".freeze]
+  s.executables = ["bundle".freeze, "htmldiff".freeze, "jeweler".freeze, "ldiff".freeze, "nokogiri".freeze, "racc".freeze, "rackup".freeze, "rake".freeze, "rdoc".freeze, "ri".freeze, "rspec".freeze, "rubocop".freeze, "semver".freeze]
   s.extra_rdoc_files = [
     "LICENSE"
   ]
   s.files = [
     ".bundle/config",
     ".rspec",
+    ".rubocop.yml",
     ".ruby-version",
     "Gemfile",
     "Gemfile.lock",
@@ -38,6 +39,7 @@ Gem::Specification.new do |s|
     "bin/rdoc",
     "bin/ri",
     "bin/rspec",
+    "bin/rubocop",
     "bin/semver",
     "lib/rails-threaded-proxy.rb",
     "lib/threaded-proxy.rb",
@@ -63,6 +65,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<nokogiri>.freeze, [">= 1.16.7".freeze])
   s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.7.0".freeze])
   s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rubocop>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<webrick>.freeze, [">= 0".freeze])
 end
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webrick'
 
 RSpec.configure do |config|

data/spec/threaded_proxy/client_spec.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 require 'rails-threaded-proxy'
 require 'json'
 
-RSpec.describe ThreadedProxy::Client do
-  BACKEND_PORT = 38293
+BACKEND_STUB_PORT = 38_293
 
+RSpec.describe ThreadedProxy::Client do
   before(:all) do
-    @backend_server = WEBrick::HTTPServer.new(Port: BACKEND_PORT,
-                                              Logger: WEBrick::Log.new("/dev/null"),
+    @backend_server = WEBrick::HTTPServer.new(Port: BACKEND_STUB_PORT,
+                                              Logger: WEBrick::Log.new('/dev/null'),
                                               AccessLog: [])
     @backend_server.mount_proc '/get' do |req, res|
       raise unless req.request_method == 'GET'
+
       res.body = "Received request: #{req.path}"
     end
 
     @backend_server.mount_proc '/post' do |req, res|
       raise unless req.request_method == 'POST'
+
       res.content_type = 'application/json'
       res.body = JSON.generate(path: req.path,
                                headers: req.header,
@@ -29,19 +33,19 @@ RSpec.describe ThreadedProxy::Client do
     @server_thread.kill
   end
 
-  it "proxies a GET request" do
+  it 'proxies a GET request' do
     socket = StringIO.new
 
-    client = ThreadedProxy::Client.new("http://localhost:#{BACKEND_PORT}/get")
+    client = ThreadedProxy::Client.new("http://localhost:#{BACKEND_STUB_PORT}/get")
     client.start(socket)
 
-    expect(socket.string).to include("Received request: /get")
+    expect(socket.string).to include('Received request: /get')
   end
 
-  it "proxies a POST request with content-length" do
+  it 'proxies a POST request with content-length' do
     socket = StringIO.new
 
-    client = ThreadedProxy::Client.new("http://localhost:#{BACKEND_PORT}/post",
+    client = ThreadedProxy::Client.new("http://localhost:#{BACKEND_STUB_PORT}/post",
                                        method: 'post',
                                        body: 'hello world')
     client.start(socket)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-threaded-proxy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Nutt
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ executables:
 - rdoc
 - ri
 - rspec
+- rubocop
 - semver
 extensions: []
 extra_rdoc_files:
@@ -143,6 +158,7 @@ extra_rdoc_files:
 files:
 - ".bundle/config"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -160,6 +176,7 @@ files:
 - bin/rdoc
 - bin/ri
 - bin/rspec
+- bin/rubocop
 - bin/semver
 - lib/rails-threaded-proxy.rb
 - lib/threaded-proxy.rb