webrick 1.3.1 → 1.4.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24fd7f86aee41c3b6f2d1017f780739cd68103a1
+  data.tar.gz: a6ce1434723786cd182d31042dbb658dbe8f1cef
+SHA512:
+  metadata.gz: 1f4874e7a0e49a67c93d35237b7eeaa12778d1a5bdf3201809101b426336ddb2e6663ec9f747c42482937c515085bcb31975fce182e3dfc78bd15b7728f3c55f
+  data.tar.gz: 5c7f0c2b427a27bc2b6dd7f2b4248e47221207e9909ff4d4ed9a303bed8e8dad83f55fa36b2a2497be8eff84a55ea769abfdc49c100094d27c138a0b3db5de77

data/lib/webrick.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # = WEB server toolkit.
 #
@@ -6,9 +7,9 @@
 # logging of both server operations and HTTP access.  WEBrick supports both
 # basic and digest authentication in addition to algorithms not in RFC 2617.
 #
-# A WEBrick servers can be composed of multiple WEBrick servers or servlets to
+# A WEBrick server can be composed of multiple WEBrick servers or servlets to
 # provide differing behavior on a per-host or per-path basis.  WEBrick
-# includes servlets for handling CGI scripts, ERb pages, ruby blocks and
+# includes servlets for handling CGI scripts, ERB pages, Ruby blocks and
 # directory listings.
 #
 # WEBrick also includes tools for daemonizing a process and starting a process
@@ -42,7 +43,7 @@
 #     res.body = 'Hello, world!'
 #   end
 #
-# Remember that <tt>server.mount_proc</tt> must <tt>server.start</tt>.
+# Remember that +server.mount_proc+ must precede +server.start+.
 #
 # == Servlets
 #
@@ -129,9 +130,8 @@
 #
 #   trap 'INT' do proxy.shutdown end
 #
-# Proxies may modifier the content of the response through the
-# +:ProxyContentHandler+ callback which will be invoked with the request and
-# respone after the remote content has been fetched.
+# See WEBrick::HTTPProxy for further details including modifying proxied
+# responses.
 #
 # == Basic and Digest authentication
 #

data/lib/webrick/accesslog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #--
 # accesslog.rb -- Access log handling utilities
 #
@@ -85,7 +86,7 @@ module WEBrick
     # %q:: Request query string
     # %r:: First line of the request
     # %s:: Request status
-    # %t:: Time the request was recieved
+    # %t:: Time the request was received
     # %T:: Time taken to process the request
     # %u:: Remote user from auth
     # %U:: Unparsed URI
@@ -115,6 +116,10 @@ module WEBrick
       params
     end
 
+    ##
+    # Formats +params+ according to +format_string+ which is described in
+    # setup_params.
+
     def format(format_string, params)
       format_string.gsub(/\%(?:\{(.*?)\})?>?([a-zA-Z%])/){
          param, spec = $1, $2
@@ -140,6 +145,9 @@ module WEBrick
       }
     end
 
+    ##
+    # Escapes control characters in +data+
+
     def escape(data)
       if data.tainted?
         data.gsub(/[[:cntrl:]\\]+/) {$&.dump[1...-1]}.untaint

data/lib/webrick/cgi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # cgi.rb -- Yet another CGI library
 #
@@ -13,10 +14,44 @@ require "webrick/config"
 require "stringio"
 
 module WEBrick
+
+  # A CGI library using WEBrick requests and responses.
+  #
+  # Example:
+  #
+  #   class MyCGI < WEBrick::CGI
+  #     def do_GET req, res
+  #       res.body = 'it worked!'
+  #       res.status = 200
+  #     end
+  #   end
+  #
+  #   MyCGI.new.start
+
   class CGI
+
+    # The CGI error exception class
+
     CGIError = Class.new(StandardError)
 
-    attr_reader :config, :logger
+    ##
+    # The CGI configuration.  This is based on WEBrick::Config::HTTP
+
+    attr_reader :config
+
+    ##
+    # The CGI logger
+
+    attr_reader :logger
+
+    ##
+    # Creates a new CGI interface.
+    #
+    # The first argument in +args+ is a configuration hash which would update
+    # WEBrick::Config::HTTP.
+    #
+    # Any remaining arguments are stored in the <code>@options</code> instance
+    # variable for use by a subclass.
 
     def initialize(*args)
       if defined?(MOD_RUBY)
@@ -41,10 +76,17 @@ module WEBrick
       @options = args
     end
 
+    ##
+    # Reads +key+ from the configuration
+
     def [](key)
       @config[key]
     end
 
+    ##
+    # Starts the CGI process with the given environment +env+ and standard
+    # input and output +stdin+ and +stdout+.
+
     def start(env=ENV, stdin=$stdin, stdout=$stdout)
       sock = WEBrick::CGI::Socket.new(@config, env, stdin, stdout)
       req = HTTPRequest.new(@config)
@@ -108,6 +150,10 @@ module WEBrick
       end
     end
 
+    ##
+    # Services the request +req+ which will fill in the response +res+.  See
+    # WEBrick::HTTPServlet::AbstractServlet#service for details.
+
     def service(req, res)
       method_name = "do_" + req.request_method.gsub(/-/, "_")
       if respond_to?(method_name)
@@ -118,7 +164,10 @@ module WEBrick
       end
     end
 
-    class Socket
+    ##
+    # Provides HTTP socket emulation from the CGI environment
+
+    class Socket # :nodoc:
       include Enumerable
 
       private

data/lib/webrick/compat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # compat.rb -- cross platform compatibility
 #
@@ -9,7 +10,7 @@
 # $IPR: compat.rb,v 1.6 2002/10/01 17:16:32 gotoyuzo Exp $
 
 ##
-# System call error module used by webrick for cross platform compatability.
+# System call error module used by webrick for cross platform compatibility.
 #
 # EPROTO:: protocol error
 # ECONNRESET:: remote host reset the connection request

data/lib/webrick/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # config.rb -- Default configurations.
 #
@@ -16,11 +17,17 @@ require 'webrick/log'
 
 module WEBrick
   module Config
-    LIBDIR = File::dirname(__FILE__)
+    LIBDIR = File::dirname(__FILE__) # :nodoc:
 
     # for GenericServer
-    General = {
-      :ServerName     => Utils::getservername,
+    General = Hash.new { |hash, key|
+      case key
+      when :ServerName
+        hash[key] = Utils.getservername
+      else
+        nil
+      end
+    }.update(
       :BindAddress    => nil,   # "0.0.0.0" or "::" or nil
       :Port           => nil,   # users MUST specify this!!
       :MaxClients     => 100,   # maximum number of the concurrent connections
@@ -33,9 +40,9 @@ module WEBrick
       :StartCallback  => nil,
       :StopCallback   => nil,
       :AcceptCallback => nil,
-      :DoNotReverseLookup => nil,
+      :DoNotReverseLookup => true,
       :ShutdownSocketWithoutClose => false,
-    }
+    )
 
     # for HTTPServer, HTTPRequest, HTTPResponse ...
     HTTP = General.dup.update(
@@ -67,6 +74,30 @@ module WEBrick
       :Escape8bitURI  => false
     )
 
+    ##
+    # Default configuration for WEBrick::HTTPServlet::FileHandler
+    #
+    # :AcceptableLanguages::
+    #   Array of languages allowed for accept-language.  There is no default
+    # :DirectoryCallback::
+    #   Allows preprocessing of directory requests.  There is no default
+    #   callback.
+    # :FancyIndexing::
+    #   If true, show an index for directories.  The default is true.
+    # :FileCallback::
+    #   Allows preprocessing of file requests.  There is no default callback.
+    # :HandlerCallback::
+    #   Allows preprocessing of requests.  There is no default callback.
+    # :HandlerTable::
+    #   Maps file suffixes to file handlers.  DefaultFileHandler is used by
+    #   default but any servlet can be used.
+    # :NondisclosureName::
+    #   Do not show files matching this array of globs.  .ht* and *~ are
+    #   excluded by default.
+    # :UserDir::
+    #   Directory inside ~user to serve content from for /~user requests.
+    #   Only works if mounted on /.  Disabled by default.
+
     FileHandler = {
       :NondisclosureName => [".ht*", "*~"],
       :FancyIndexing     => false,
@@ -78,6 +109,12 @@ module WEBrick
       :AcceptableLanguages => []  # ["en", "ja", ... ]
     }
 
+    ##
+    # Default configuration for WEBrick::HTTPAuth::BasicAuth
+    #
+    # :AutoReloadUserDB:: Reload the user database provided by :UserDB
+    #                     automatically?
+
     BasicAuth = {
       :AutoReloadUserDB     => true,
     }

data/lib/webrick/cookie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # cookie.rb -- Cookie class
 #
@@ -12,14 +13,56 @@ require 'time'
 require 'webrick/httputils'
 
 module WEBrick
+
+  ##
+  # Processes HTTP cookies
+
   class Cookie
 
+    ##
+    # The cookie name
+
     attr_reader :name
-    attr_accessor :value, :version
-    attr_accessor :domain, :path, :secure
-    attr_accessor :comment, :max_age
+
+    ##
+    # The cookie value
+
+    attr_accessor :value
+
+    ##
+    # The cookie version
+
+    attr_accessor :version
+
+    ##
+    # The cookie domain
+    attr_accessor :domain
+
+    ##
+    # The cookie path
+
+    attr_accessor :path
+
+    ##
+    # Is this a secure cookie?
+
+    attr_accessor :secure
+
+    ##
+    # The cookie comment
+
+    attr_accessor :comment
+
+    ##
+    # The maximum age of the cookie
+
+    attr_accessor :max_age
+
     #attr_accessor :comment_url, :discard, :port
 
+    ##
+    # Creates a new cookie with the given +name+ and +value+
+
     def initialize(name, value)
       @name = name
       @value = value
@@ -29,14 +72,25 @@ module WEBrick
       @expires = @comment_url = @discard = @port = nil
     end
 
+    ##
+    # Sets the cookie expiration to the time +t+.  The expiration time may be
+    # a false value to disable expiration or a Time or HTTP format time string
+    # to set the expiration date.
+
     def expires=(t)
       @expires = t && (t.is_a?(Time) ? t.httpdate : t.to_s)
     end
 
+    ##
+    # Retrieves the expiration time as a Time
+
     def expires
       @expires && Time.parse(@expires)
     end
 
+    ##
+    # The cookie string suitable for use in an HTTP header
+
     def to_s
       ret = ""
       ret << @name << "=" << @value
@@ -50,14 +104,16 @@ module WEBrick
       ret
     end
 
-    # Cookie::parse()
-    #   It parses Cookie field sent from the user agent.
+    ##
+    # Parses a Cookie field sent from the user-agent.  Returns an array of
+    # cookies.
+
     def self.parse(str)
       if str
         ret = []
         cookie = nil
         ver = 0
-        str.split(/[;,]\s+/).each{|x|
+        str.split(/;\s+/).each{|x|
           key, val = x.split(/=/,2)
           val = val ? HTTPUtils::dequote(val) : ""
           case key
@@ -76,6 +132,9 @@ module WEBrick
       end
     end
 
+    ##
+    # Parses the cookie in +str+
+
     def self.parse_set_cookie(str)
       cookie_elem = str.split(/;/)
       first_elem = cookie_elem.shift
@@ -101,6 +160,9 @@ module WEBrick
       return cookie
     end
 
+    ##
+    # Parses the cookies in +str+
+
     def self.parse_set_cookies(str)
       return str.split(/,(?=[^;,]*=)|,$/).collect{|c|
         parse_set_cookie(c)

data/lib/webrick/htmlutils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #--
 # htmlutils.rb -- HTMLUtils Module
 #
@@ -15,12 +16,13 @@ module WEBrick
     # Escapes &, ", > and < in +string+
 
     def escape(string)
-      str = string ? string.dup : ""
+      return "" unless string
+      str = string.b
       str.gsub!(/&/n, '&amp;')
       str.gsub!(/\"/n, '&quot;')
       str.gsub!(/>/n, '&gt;')
       str.gsub!(/</n, '&lt;')
-      str
+      str.force_encoding(string.encoding)
     end
     module_function :escape
 

data/lib/webrick/httpauth.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #
 # httpauth.rb -- HTTP access authentication
 #

data/lib/webrick/httpauth/authenticator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 #--
 # httpauth/authenticator.rb -- Authenticator mix-in module.
 #
@@ -16,10 +17,10 @@ module WEBrick
 
     module Authenticator
 
-      RequestField      = "Authorization"
-      ResponseField     = "WWW-Authenticate"
-      ResponseInfoField = "Authentication-Info"
-      AuthException     = HTTPStatus::Unauthorized
+      RequestField      = "Authorization" # :nodoc:
+      ResponseField     = "WWW-Authenticate" # :nodoc:
+      ResponseInfoField = "Authentication-Info" # :nodoc:
+      AuthException     = HTTPStatus::Unauthorized # :nodoc:
 
       ##
       # Method of authentication, must be overridden by the including class
@@ -43,6 +44,8 @@ module WEBrick
 
       private
 
+      # :stopdoc:
+
       ##
       # Initializes the authenticator from +config+
 
@@ -96,6 +99,8 @@ module WEBrick
           log(:info, fmt, *args)
         end
       end
+
+      # :startdoc:
     end
 
     ##
@@ -103,10 +108,10 @@ module WEBrick
     # authentication schemes for proxies.
 
     module ProxyAuthenticator
-      RequestField  = "Proxy-Authorization"
-      ResponseField = "Proxy-Authenticate"
-      InfoField     = "Proxy-Authentication-Info"
-      AuthException = HTTPStatus::ProxyAuthenticationRequired
+      RequestField  = "Proxy-Authorization" # :nodoc:
+      ResponseField = "Proxy-Authenticate" # :nodoc:
+      InfoField     = "Proxy-Authentication-Info" # :nodoc:
+      AuthException = HTTPStatus::ProxyAuthenticationRequired # :nodoc:
     end
   end
 end