forward-proxy 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3e94626ce91d870564fcbed5db9133ddee5a1167
-  data.tar.gz: 44c9c4e4ca3a4036a8c1e9698dac6a203c3fe367
+SHA256:
+  metadata.gz: 628359d25536c4190014c9e082fff41b2adef209f04a62d8a6b217c078f3b58b
+  data.tar.gz: 7834932b7242fd66c120d270a922e385a6a58ab63c65e8ce2b7957da43ba5a11
 SHA512:
-  metadata.gz: c13a9fa915fb77699702226408cbd160d61cd375789beb947299423c788594c7f5d7af3783624fcf5fb30e8521e8a5e98c4953e7f1b5c7e477a756bda153634b
-  data.tar.gz: 609126058336e8cc597c0df21b3a3cb65c4d1216d7af11d77dec09eda104c6277811d59b942d38c46f8776c0cf1b8f137d09778793343a88c138872f65b06b54
+  metadata.gz: 8c47ab1d691807a23ba779f1ae8d4feecd32300f8d840044f66a5cc2f40ccd33c095db60ca9e3f99fb3c8fd60c02ae46d5d8d07b6a4de6298bef24731fb57cb4
+  data.tar.gz: 609a35651496d98e4977f3691c7834efd58fe736615b3b4594e0bc61d11dad0088f11f535f6b287db85f95c1cc8ab55ea2a536447028b690d92ffd0aa3e60669

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.0
+
+- Extract errors into module.
+
 ## 0.1.5
 
 - stream http proxy requests.

data/README.md

@@ -2,7 +2,7 @@
 
 ![Gem Version][3] ![Gem][1] ![Build Status][2]
 
-100 LOC Ruby forward proxy using only standard libraries.
+Minimal forward proxy using 150LOC and only standard libraries. Useful for development, testing, and learning.
 
 ```
 $ forward-proxy --binding 0.0.0.0 --port 3182 --threads 2

data/exe/forward-proxy

@@ -7,7 +7,7 @@ options = {}
 OptionParser.new do |parser|
   parser.banner = "Usage: forward-proxy [options]"
 
-  parser.on("-pPORT", "--port=PORT", "Bind to specified port. Default: 9292", String) do |bind_port|
+  parser.on("-pPORT", "--port=PORT", String, "Bind to specified port. Default: 9292") do |bind_port|
     options[:bind_port] = bind_port
   end
 
@@ -26,6 +26,5 @@ OptionParser.new do |parser|
 end.parse!
 
 require_relative '../lib/forward_proxy'
-
 server = ForwardProxy::Server.new(options)
 server.start

data/lib/forward_proxy/errors/http_method_not_implemented.rb

@@ -0,0 +1,5 @@
+module ForwardProxy
+  module Errors
+    class HTTPMethodNotImplemented < StandardError; end
+  end
+end

data/lib/forward_proxy/errors/http_parse_error.rb

@@ -0,0 +1,5 @@
+module ForwardProxy
+  module Errors
+    class HTTPParseError < StandardError; end
+  end
+end

data/lib/forward_proxy/server.rb

@@ -1,12 +1,11 @@
-require 'forward_proxy/thread_pool'
 require 'socket'
 require 'webrick'
 require 'net/http'
+require 'forward_proxy/errors/http_method_not_implemented'
+require 'forward_proxy/errors/http_parse_error'
+require 'forward_proxy/thread_pool'
 
 module ForwardProxy
-  class HTTPMethodNotImplemented < StandardError; end
-  class HTTPParseError < StandardError; end
-
   class Server
     attr_reader :bind_address, :bind_port
 
@@ -19,20 +18,12 @@ module ForwardProxy
     def start
       thread_pool.start
 
-      @server = TCPServer.new(bind_address, bind_port)
+      @socket = TCPServer.new(bind_address, bind_port)
 
       log("Listening #{bind_address}:#{bind_port}")
 
       loop do
-        # The following comments are from https://stackoverflow.com/q/5124320/273101
-        #
-        # accept(): POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD (accept() first appeared in 4.2BSD).
-        #
-        # We see that POSIX.1-2008 is a viable reference (check this for a description of relevant
-        # standards for Linux systems). As already said in other answers, POSIX.1 standard specifies
-        # accept function as (POSIX-)thread safe (as defined in Base Definitions, section 3.399 Thread Safe)
-        # by not listing it on System Interfaces, section 2.9.1 Thread Safety.
-        thread_pool.schedule(server.accept) do |client_conn|
+        thread_pool.schedule(socket.accept) do |client_conn|
           begin
             req = parse_req(client_conn)
 
@@ -42,16 +33,9 @@ module ForwardProxy
             when METHOD_CONNECT then handle_tunnel(client_conn, req)
             when METHOD_GET, METHOD_POST then handle(client_conn, req)
             else
-              raise HTTPMethodNotImplemented
+              raise Errors::HTTPMethodNotImplemented
             end
           rescue => e
-            # The following comments are from the IETF document
-            # "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"
-            # https://tools.ietf.org/html/rfc7231#section-6.6.3
-
-            # The 502 (Bad Gateway) status code indicates that the server, while
-            # acting as a gateway or proxy, received an invalid response from an
-            # inbound server it accessed while attempting to fulfill the request.
             client_conn.puts <<~eos.chomp
               HTTP/1.1 502
               Via: #{HEADER_VIA}
@@ -71,13 +55,16 @@ module ForwardProxy
     end
 
     def shutdown
-      log("Stoping server...")
-      server.close if server
+      if socket
+        log("Shutting down")
+
+        socket.close 
+      end
     end
 
     private
 
-    attr_reader :server, :thread_pool
+    attr_reader :socket, :thread_pool
 
     METHOD_CONNECT = "CONNECT"
     METHOD_GET = "GET"
@@ -138,6 +125,12 @@ module ForwardProxy
             #{resp.each.map { |header, value| "#{header}: #{value}" }.join("\n")}\n\n
           eos
 
+          # The following comments are taken from: 
+          # https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Streaming+Response+Bodies
+          
+          # By default Net::HTTP reads an entire response into memory. If you are
+          # handling large files or wish to implement a progress bar you can 
+          # instead stream the body directly to an IO.
           resp.read_body do |chunk|
             client_conn << chunk
           end
@@ -152,13 +145,13 @@ module ForwardProxy
               when METHOD_GET then Net::HTTP::Get
               when METHOD_POST then Net::HTTP::Post
               else
-                raise HTTPMethodNotImplemented
+                raise Errors::HTTPMethodNotImplemented
               end
 
       klass.new(req.path, req_headers)
     end
 
-    def transfer(dest_conn, src_conn)
+    def transfer(src_conn, dest_conn)
       IO.copy_stream(src_conn, dest_conn)
     rescue => e
       log(e.message, "WARNING")
@@ -169,7 +162,7 @@ module ForwardProxy
         req.parse(client_conn)
       end
     rescue => e
-      throw HTTPParseError.new(e.message)
+      throw Errors::HTTPParseError.new(e.message)
     end
 
     def log(str, level = 'INFO')

data/lib/forward_proxy/version.rb

@@ -1,3 +1,3 @@
 module ForwardProxy
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Forward proxy using just Ruby standard libraries.
 email:
@@ -32,6 +32,8 @@ files:
 - exe/forward-proxy
 - forward-proxy.gemspec
 - lib/forward_proxy.rb
+- lib/forward_proxy/errors/http_method_not_implemented.rb
+- lib/forward_proxy/errors/http_parse_error.rb
 - lib/forward_proxy/server.rb
 - lib/forward_proxy/thread_pool.rb
 - lib/forward_proxy/version.rb
@@ -57,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Forward proxy.