net-http-server 0.2.0 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35d57af683a4c0b327c281d5ae71f848e076b6be987e9fa4c1ee77d2aab41d68
+  data.tar.gz: 6cd05ef1952687d1ec6b0ac83bfe3ca7ba457fae04891a38fb32b53beee7beb7
+SHA512:
+  metadata.gz: 87305fc9592d5cde9ab305b0a98d22f365fc6af32808aca03323f0d0140b89384a95b9e19b5ccc23552ae611b65b600d02ad526b399d4d606793d7d0cfbd308b
+  data.tar.gz: ad2a7320a5aeb3b2106cf4b871fb589dd2f0ad0afb86d50ad9a41b75e88f76f7ef0115c2d78b450fc42020f4da4bc58d1605de83e43df464bddf2c49f50b7cb2

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 doc/
 pkg/
 vendor/

data/ChangeLog.md

@@ -1,3 +1,28 @@
+### 0.2.3 / 2022-06-18
+
+* Add [gserver] ~> 0.0 as a dependency.
+* Switched to using Ruby 2.x keyword arguments.
+* Fix a bug in {Rack::Handler::HTTP} where the URI `query` string was not being
+  properly loaded.
+* Fixed a bug in {Net::HTTP::Server::Parser} where the older `absnt?` method
+  was being used instead of the newer `absent?` method.
+
+### 0.2.2 / 2012-09-08
+
+* Added an example `rackup` command.
+
+#### Parser
+
+* Fixed the rule for escaped unicode characters (`%uXXXX`).
+* Added a rule for escaped characters (`%XX`).
+
+### 0.2.1 / 2011-10-14
+
+* Adjusted {Net::HTTP::Server::Parser} to include the leading `/` in the
+  `:path`.
+* Use `String#replace` to clear the buffer passed to
+  {Net::HTTP::Server::ChunkedStream#read}.
+
 ### 0.2.0 / 2011-08-23
 
 * Added support for handling Streams and Chunked Transfer-Encoding:
@@ -16,3 +41,5 @@
   * Added {Net::HTTP::Server::Responses}.
   * Added {Net::HTTP::Server::Daemon}.
   * Added {Rack::Handler::HTTP}.
+
+[gserver]: https://rubygems.org/gems/gserver

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.1'
+
+  gem 'rack'
+  gem 'rspec', '~> 3.0'
+
+  gem 'kramdown'
+  gem 'redcarpet', platform: :mri
+  gem 'yard', '~> 0.9'
+  gem 'yard-spellcheck'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Hal Brodigan
+Copyright (c) 2011-2022 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,8 @@
 # net-http-server
 
-* [Homepage](http://github.com/postmodern/net-http-server)
-* [Issues](http://github.com/postmodern/net-http-server/issues)
-* [Documentation](http://rubydoc.info/gems/net-http-server)
-* [Email](mailto:postmodern.mod3 at gmail.com)
+* [Homepage](https://github.com/postmodern/net-http-server#readme)
+* [Issues](https://github.com/postmodern/net-http-server/issues)
+* [Documentation](https://rubydoc.info/gems/net-http-server)
 
 ## Description
 
@@ -14,37 +13,50 @@
 * Pure Ruby.
 * Supports Streamed Request/Response Bodies.
 * Supports Chunked Transfer-Encoding.
-* Provides a [Rack](http://rack.rubyforge.org/) Handler.
+* Provides a [Rack](https://github.com/rack/rack#readme) Handler.
 
 ## Examples
 
 Simple HTTP Server:
 
-    require 'net/http/server'
-    require 'pp'
+```ruby
+require 'net/http/server'
+require 'pp'
 
-    Net::HTTP::Server.run(:port => 8080) do |request,stream|
-      pp request
+Net::HTTP::Server.run(:port => 8080) do |request,stream|
+  pp request
 
-      [200, {'Content-Type' => 'text/html'}, ['Hello World']]
-    end
+  [200, {'Content-Type' => 'text/html'}, ['Hello World']]
+end
+```
 
 Use it with Rack:
 
-    require 'rack/handler/http'
-    
-    Rack::Handler::HTTP.run app
+```ruby
+require 'rack/handler/http'
+
+Rack::Handler::HTTP.run app
+```
+
+Using it with `rackup`:
+
+```shell
+$ rackup -s HTTP
+```
 
 ## Requirements
 
-* [parslet](http://rubygems.org/gems/parslet) ~> 1.0
+* [parslet](http://kschiess.github.io/parslet/) ~> 1.0
+* [gserver](https://rubygems.org/gems/gserver) ~> 0.0
 
 ## Install
 
-    $ gem install net-http-server
+```shell
+$ gem install net-http-server
+```
 
 ## Copyright
 
-Copyright (c) 2011 Hal Brodigan
+Copyright (c) 2011-2022 Hal Brodigan
 
 See {file:LICENSE.txt} for details.

data/Rakefile

@@ -1,36 +1,19 @@
-require 'rubygems'
-require 'rake'
-
 begin
-  gem 'ore-tasks', '~> 0.4'
-  require 'ore/tasks'
-
-  Ore::Tasks.new
+  require 'bundler/setup'
 rescue LoadError => e
   warn e.message
-  warn "Run `gem install ore-tasks` to install 'ore/tasks'."
+  warn "Run `gem install bundler` to install Bundler"
+  exit -1
 end
 
-begin
-  gem 'rspec', '~> 2.4'
-  require 'rspec/core/rake_task'
+require 'rubygems/tasks'
+Gem::Tasks.new
 
-  RSpec::Core::RakeTask.new
-rescue LoadError => e
-  task :spec do
-    abort "Please run `gem install rspec` to install RSpec."
-  end
-end
-task :test => :spec
-task :default => :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-begin
-  gem 'yard', '~> 0.6.0'
-  require 'yard'
+task :test    => :spec
+task :default => :spec
 
-  YARD::Rake::YardocTask.new  
-rescue LoadError => e
-  task :yard do
-    abort "Please run `gem install yard` to install YARD."
-  end
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/gemspec.yml

@@ -4,13 +4,19 @@ description: A Rack compatible pure Ruby HTTP Server.
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: http://github.com/postmodern/net-http-server
+homepage: https://github.com/postmodern/net-http-server#readme
 has_yard: true
 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/net-http-server
+  source_code_uri:   https://github.com/postmodern/net-http-server
+  bug_tracker_uri:   https://github.com/postmodern/net-http-server/issues
+  changelog_uri:     https://github.com/postmodern/net-http-server/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
 dependencies:
   parslet: ~> 1.0
+  gserver: ~> 0.0
 
 development_dependencies:
-  ore-tasks: ~> 0.4
-  rspec: ~> 2.4
-  yard: ~> 0.6.0
+  bundler: ~> 2.0

data/lib/net/http/server/chunked_stream.rb

@@ -14,7 +14,7 @@ module Net
       class ChunkedStream < Stream
 
         #
-        # Initializes the chuked stream.
+        # Initializes the chunked stream.
         #
         # @param [#read, #write, #flush] socket
         #   The socket to read from and write to.
@@ -47,9 +47,8 @@ module Net
           end
 
           until @buffer.length >= length
-            length_line = @socket.readline("\r\n").chomp
-            chunk_length, chunk_extension = length_line.split(';',2)
-            chunk_length = chunk_length.to_i(16)
+            length_line  = @socket.readline("\r\n").chomp
+            chunk_length = length_line.split(';',2).first.to_i(16)
 
             # read the chunk
             @buffer << @socket.read(chunk_length)
@@ -62,7 +61,7 @@ module Net
           end
 
           # clear the buffer before appending
-          buffer.clear
+          buffer.replace('')
 
           unless @buffer.empty?
             # empty a slice of the buffer

data/lib/net/http/server/daemon.rb

@@ -26,22 +26,19 @@ module Net
 
         # Creates a new HTTP Daemon.
         #
-        # @param [Hash] options
-        #   Options for the daemon.
-        #
-        # @option options [String] :host (DEFAULT_HOST)
+        # @param [String] host
         #   The host to run on.
         #
-        # @option options [String] :port (DEFAULT_PORT)
+        # @param [String] port
         #   The port to listen on.
         #
-        # @option options [Integer] :max_connections (MAX_CONNECTIONS)
+        # @param [Integer] max_connections
         #   The maximum number of simultaneous connections.
         #
-        # @option options [IO] :log ($stderr)
+        # @param [IO] log
         #   The log to write errors to.
         #
-        # @option options [#call] :handler
+        # @param [#call] handler
         #   The HTTP Request Handler object.
         #
         # @yield [request, socket]
@@ -53,15 +50,18 @@ module Net
         # @yieldparam [TCPSocket] socket
         #   The TCP socket of the client.
         #
-        def initialize(options={},&block)
-          host = options.fetch(:host,DEFAULT_HOST)
-          port = options.fetch(:port,DEFAULT_PORT).to_i
-          max_connections = options.fetch(:max_connections,MAX_CONNECTIONS)
-          log = options.fetch(:log,$stderr)
-
-          super(port,host,max_connections,log,false,true)
+        # @raise [ArgumentError]
+        #   No `handler:` value was given.
+        #
+        def initialize(host: DEFAULT_HOST,
+                       port: DEFAULT_PORT,
+                       max_connections: MAX_CONNECTIONS,
+                       log: $stderr,
+                       handler: nil,
+                       &block)
+          super(port.to_i,host,max_connections,log,false,true)
 
-          handler(options[:handler],&block)
+          handler(handler,&block)
         end
 
         #
@@ -106,7 +106,7 @@ module Net
 
             begin
               request = parser.parse(raw_request)
-            rescue Parslet::ParseFailed => error
+            rescue Parslet::ParseFailed
               return Responses::BAD_REQUEST
             end
 

data/lib/net/http/server/parser.rb

@@ -9,7 +9,7 @@ module Net
       #
       # * [Thin](https://github.com/macournoyer/thin/blob/master/ext/thin_parser/common.rl)
       # * [Unicorn](https://github.com/defunkt/unicorn/blob/master/ext/unicorn_http/unicorn_http_common.rl)
-      # * [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616.html)
+      # * [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110.html)
       #
       class Parser < Parslet::Parser
 
@@ -30,7 +30,7 @@ module Net
         rule(:crlf) { str("\r\n") }
 
         rule(:ctl) { cntrl | str("\x7f") }
-        rule(:text) { lws | (ctl.absnt? >> ascii) }
+        rule(:text) { lws | (ctl.absent? >> ascii) }
 
         rule(:safe) { charset('$', '-', '_', '.') }
         rule(:extra) { charset('!', '*', "'", '(', ')', ',') }
@@ -39,12 +39,13 @@ module Net
 
         rule(:unsafe) { ctl | charset(' ', '#', '%') | sorta_safe }
         rule(:national) {
-          (alpha | digit | reserved | extra | safe | unsafe).absnt? >> any
+          (alpha | digit | reserved | extra | safe | unsafe).absent? >> any
         }
 
         rule(:unreserved) { alpha | digit | safe | extra | national }
-        rule(:escape) { str("%u").maybe >> xdigit >> xdigit }
-        rule(:uchar) { unreserved | escape | sorta_safe }
+        rule(:uescape) { str("%u") >> xdigit >> xdigit >> xdigit >> xdigit }
+        rule(:escape) { str("%") >> xdigit >> xdigit }
+        rule(:uchar) { unreserved | uescape | escape | sorta_safe }
         rule(:pchar) { uchar | charset(':', '@', '&', '=', '+') }
         rule(:separators) {
           lws | charset(
@@ -56,13 +57,13 @@ module Net
         #
         # Elements
         #
-        rule(:token) { (ctl | separators).absnt? >> ascii }
+        rule(:token) { (ctl | separators).absent? >> ascii }
 
-        rule(:comment_text) { (str('(') | str(')')).absnt? >> text }
+        rule(:comment_text) { (str('(') | str(')')).absent? >> text }
         rule(:comment) { str('(') >> comment_text.repeat >> str(')') }
 
         rule(:quoted_pair) { str("\\") >> ascii }
-        rule(:quoted_text) { quoted_pair | str('"').absnt? >> text }
+        rule(:quoted_text) { quoted_pair | str('"').absent? >> text }
         rule(:quoted_string) { str('"') >> quoted_text >> str('"') }
 
         #
@@ -86,23 +87,22 @@ module Net
         rule(:params) { param >> (str(';') >> param).repeat }
         rule(:frag) { (uchar | reserved).repeat }
 
-        rule(:relative_path) {
-          path.maybe.as(:path) >>
+        rule(:uri_path) {
+          (str('/').maybe >> path.maybe).as(:path) >>
           (str(';') >> params.as(:params)).maybe >>
           (str('?') >> query_string.as(:query)).maybe >>
           (str('#') >> frag.as(:fragment)).maybe
         }
-        rule(:absolute_path) { str('/').repeat(1) >> relative_path }
 
-        rule(:absolute_uri) {
+        rule(:uri) {
           scheme.as(:scheme) >> str(':') >> str('//').maybe >>
           (user_info.as(:user_info) >> str('@')).maybe >>
           host_name.as(:host) >>
           (str(':') >> digits.as(:port)).maybe >>
-          absolute_path
+          uri_path
         }
 
-        rule(:request_uri) { str('*') | absolute_uri | absolute_path }
+        rule(:request_uri) { str('*') | uri | uri_path }
 
         #
         # HTTP Elements
@@ -112,12 +112,12 @@ module Net
         rule(:version_number) { digits >> str('.') >> digits }
         rule(:http_version) { str('HTTP/') >> version_number.as(:version) }
         rule(:request_line) {
-          request_method.as(:method) >>
-          str(' ') >> request_uri.as(:uri) >>
-          str(' ') >> http_version
+          request_method.as(:method) >> str(' ') >>
+          request_uri.as(:uri) >> str(' ') >>
+          http_version
         }
 
-        rule(:header_name) { (str(':').absnt? >> token).repeat(1) }
+        rule(:header_name) { (str(':').absent? >> token).repeat(1) }
         rule(:header_value) {
           (text | token | separators | quoted_string).repeat(1)
         }

data/lib/net/http/server/requests.rb

@@ -7,7 +7,7 @@ module Net
         # Default ports for common URI schemes
         DEFAULT_PORTS = {
           'https' => 443,
-          'http' => 80
+          'http'  => 80
         }
 
         protected
@@ -65,7 +65,8 @@ module Net
         def normalize_uri(request)
           uri = request[:uri]
 
-          if uri.kind_of?(Hash)
+          case uri
+          when Hash
             if uri[:scheme]
               uri[:port] = unless uri[:port]
                              DEFAULT_PORTS[uri[:scheme]]
@@ -73,13 +74,7 @@ module Net
                              uri[:port].to_i
                            end
             end
-
-            unless uri[:path]
-              uri[:path] = '/'
-            else
-              uri[:path].insert(0,'/')
-            end
-          elsif uri == '*'
+          when '*'
             request[:uri] = {}
           end
         end
@@ -96,7 +91,7 @@ module Net
 
           unless headers.empty?
             headers.each do |header|
-              name = header[:name].to_s
+              name  = header[:name].to_s
               value = header[:value].to_s
 
               if normalized_headers.has_key?(name)

data/lib/net/http/server/responses.rb

@@ -87,7 +87,7 @@ module Net
         # @param [IO] stream
         #   The stream to write the headers back to.
         #
-        # @param [Hash{String => [String, Time, Array<String>}] headers
+        # @param [Hash{String => String,Time,Array<String>}] headers
         #   The headers of the HTTP Response.
         #
         def write_headers(stream,headers)
@@ -155,7 +155,7 @@ module Net
         # @param [Integer] status
         #   The status of the HTTP Response.
         #
-        # @param [Hash{String => [String, Time, Array<String>}] headers
+        # @param [Hash{String => String,Time,Array<String>}] headers
         #   The headers of the HTTP Response.
         #
         # @param [#each] body

data/lib/net/http/server/server.rb

@@ -8,23 +8,23 @@ module Net
       #
       # Starts the HTTP Server.
       #
-      # @param [Hash] options
-      #   Options for the server.
+      # @param [Boolean] background
+      #   Specifies whether to run the server in the background or
+      #   foreground.
       #
-      # @option options [String] :host (DEFAULT_HOST)
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments for {Daemon#initialize}.
+      #
+      # @option kwargs [String] :host (DEFAULT_HOST)
       #   The host to run on.
       #
-      # @option options [String] :port (DEFAULT_PORT)
+      # @option kwargs [String] :port (DEFAULT_PORT)
       #   The port to listen on.
       #
-      # @option options [Integer] :max_connections (MAX_CONNECTIONS)
+      # @option kwargs [Integer] :max_connections (MAX_CONNECTIONS)
       #   The maximum number of simultaneous connections.
       #
-      # @option options [Boolean] :background (false)
-      #   Specifies whether to run the server in the background or
-      #   foreground.
-      #
-      # @option options [#call] :handler
+      # @option kwargs [#call] :handler
       #   The HTTP Request Handler object.
       #
       # @yield [request, socket]
@@ -36,11 +36,14 @@ module Net
       # @yieldparam [TCPSocket] socket
       #   The TCP socket of the client.
       #
-      def Server.run(options={},&block)
-        daemon = Daemon.new(options,&block)
+      # @raise [ArgumentError]
+      #   No `handler:` value was given.
+      #
+      def Server.run(background: false, **kwargs,&block)
+        daemon = Daemon.new(**kwargs,&block)
 
         daemon.start
-        daemon.join unless options[:background]
+        daemon.join unless background
         return daemon
       end
 

data/lib/net/http/server/version.rb

@@ -4,7 +4,7 @@ module Net
   class HTTP < Protocol
     module Server
       # net-http-server version.
-      VERSION = '0.2.0'
+      VERSION = '0.2.3'
     end
   end
 end

data/lib/rack/handler/http.rb

@@ -37,7 +37,7 @@ module Rack
       # @param [#call] app
       #   The application the handler will be passing requests to.
       #
-      # @param [Hash] options
+      # @param [Hash{Symbol => Object}] options
       #   Additional options.
       #
       # @option options [String] :Host
@@ -46,11 +46,10 @@ module Rack
       # @option options [Integer] :Port
       #   The port to listen on.
       #
-      def initialize(app,options={})
-        @app = app
+      def initialize(app,**options)
+        @app     = app
         @options = options
-
-        @server = nil
+        @server  = nil
       end
 
       #
@@ -58,8 +57,8 @@ module Rack
       #
       # @see #initialize
       #
-      def self.run(app,options={})
-        new(app,options).run
+      def self.run(app,**options)
+        new(app,**options).run
       end
 
       #
@@ -67,9 +66,9 @@ module Rack
       #
       def run
         @server = Net::HTTP::Server::Daemon.new(
-          :host => @options[:Host],
-          :port => @options[:Port],
-          :handler => self
+          host:    @options[:Host],
+          port:    @options[:Port],
+          handler: self
         )
 
         @server.start
@@ -89,9 +88,9 @@ module Rack
       #   The response status, headers and body.
       #
       def call(request,stream)
-        request_uri = request[:uri]
+        request_uri    = request[:uri]
         remote_address = stream.socket.remote_address
-        local_address = stream.socket.local_address
+        local_address  = stream.socket.local_address
 
         env = {}
 
@@ -105,21 +104,21 @@ module Rack
           env['rack.url_scheme'] = request_uri[:scheme].to_s
         end
 
-        env['SERVER_NAME'] = local_address.getnameinfo[0]
-        env['SERVER_PORT'] = local_address.ip_port.to_s
+        env['SERVER_NAME']     = local_address.getnameinfo[0]
+        env['SERVER_PORT']     = local_address.ip_port.to_s
         env['SERVER_PROTOCOL'] = "HTTP/#{request[:http_version]}"
 
         env['REMOTE_ADDR'] = remote_address.ip_address
         env['REMOTE_PORT'] = remote_address.ip_port.to_s
 
         env['REQUEST_METHOD'] = request[:method].to_s
-        env['PATH_INFO'] = request_uri.fetch(:path,'*').to_s
-        env['QUERY_STRING'] = request_uri[:query_string].to_s
+        env['PATH_INFO']      = request_uri.fetch(:path,'*').to_s
+        env['QUERY_STRING']   = request_uri[:query].to_s
 
         # add the headers
         request[:headers].each do |name,value|
           key = name.dup
-          
+
           key.upcase!
           key.tr!('-','_')