webricknio 0.6.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012, Pradeep Singh (pradeep ... pradeeplogs .. com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* The name Pradeep Singh may not be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL PRADEEP SINGH BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,58 @@
+**Summary** -
+
+Use WEBrickNIO as highly scalable server for JRuby apps. Taking advantage of JRuby, WEBrick’s code has been littered with Java NIO code and the result is WEBrickNIO. epoll and thread pool have been added to WEBrickNIO so that it uses the same technology that make eventmachine and nginx so scalable.
+
+- - -
+
+**Installation** -
+
+In your Gemfile -
+
+gem "webricknio", "~> 0.5.0"
+
+then -
+
+bundle install
+
+This will install webricknio-{version}.gem
+
+To run, at your rails root -
+
+rails s wnio
+
+To get the configuration file in your config directory -
+
+rails g webricknio - this creates a file webricknio.rb in the 'config' directory (not in config/initialzers)
+
+Some properties of inerest in the config file -
+
+:LogLevel       => ::WEBrick::Log::DEBUG
+
+:NumThreads     => 10,
+
+These properties are all overriden by command line options.
+
+Currently, it does not support file uploads and websockets. With the addition of these two it will be ready to move to version 1.0
+
+Use it by itself,
+
+or behind nginx -
+
+    upstream www.server.com {
+      server 127.0.0.1:3002;
+      keepalive 8;
+    }
+    
+    server {
+      listen 80
+      server_name  .server.com;
+      
+        location / {
+            proxy_pass http://www.server.com;
+            proxy_http_version 1.1;
+            proxy_set_header Connection "";
+        }    
+    }
+        
+    
+    

data/lib/generator/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a configuration file for WebrickNIO
+
+Example:
+    rails generate webricknio
+
+    This will create a file config/webricknio.rb
+

data/lib/generator/webricknio.rb

@@ -0,0 +1,57 @@
+#--
+# webricknio.rb
+#
+# Author: Pradeep Singh
+# Copyright (c) 2012 Pradeep Singh
+# All rights reserved.
+
+General = {
+    :ServerName     => ::WEBrick::Utils::getservername,
+    :BindAddress    => nil,   # "0.0.0.0" or "::" or nil
+    :Port           => nil,   # users MUST specify this!!
+    :MaxClients     => 100,   # maximum number of the concurrent connections
+    :ServerType     => nil,   # default: WEBrick::SimpleServer
+    :Logger         => nil,   # default: WEBrick::Log.new
+    #:ServerSoftware => "WEBrickNIO/#{WEBrickNIO::VERSION} " +
+    #                   "(Ruby/#{RUBY_VERSION}/#{RUBY_RELEASE_DATE})",
+    :ServerSoftware => "pks/#{WEBrickNIO::VERSION} ",
+    :TempDir        => ENV['TMPDIR']||ENV['TMP']||ENV['TEMP']||'/tmp',
+    :DoNotListen    => false,
+    :StartCallback  => nil,
+    :StopCallback   => nil,
+    :AcceptCallback => nil,
+    :DoNotReverseLookup => nil,
+    :ShutdownSocketWithoutClose => false,
+}
+
+HTTP = General.dup.update(
+    :Port           => 80,
+    :RequestTimeout => 5,
+    :NumThreads     => 20,
+    :HTTPVersion    => ::WEBrick::HTTPVersion.new("1.1"),
+    :AccessLog      => nil,
+    :LogLocation    => nil, #"log/webrick.log"
+    :LogLevel       => ::WEBrick::Log::INFO,
+    :MimeTypes      => ::WEBrick::HTTPUtils::DefaultMimeTypes,
+    :DirectoryIndex => ["index.html","index.htm","index.cgi","index.rhtml"],
+    :DocumentRoot   => nil,
+    :DocumentRootOptions => { :FancyIndexing => true },
+    :RequestCallback => nil,
+    :ServerAlias    => nil,
+    :InputBufferSize  => 65536, # input buffer size in reading request body
+    :OutputBufferSize => 65536, # output buffer size in sending File or IO
+
+    # for HTTPProxyServer
+    :ProxyAuthProc  => nil,
+    :ProxyContentHandler => nil,
+    :ProxyVia       => true,
+    :ProxyTimeout   => true,
+    :ProxyURI       => nil,
+
+    :CGIInterpreter => nil,
+    :CGIPathEnv     => nil,
+
+    # workaround: if Request-URIs contain 8bit chars,
+    # they should be escaped before calling of URI::parse().
+    :Escape8bitURI  => false
+)

data/lib/generator/webricknio_generator.rb

@@ -0,0 +1,15 @@
+#--
+# webricknio_generator.rb
+#
+# Author: Pradeep Singh
+# Copyright (c) 2012 Pradeep Singh
+# All rights reserved.
+
+class WebricknioGenerator < Rails::Generators::Base
+  source_root File.expand_path('../', __FILE__)
+
+  def copy_initializer_file
+    copy_file "webricknio.rb", "config/webricknio.rb"
+  end
+
+end

data/lib/rack/handler/webricknio.rb

@@ -0,0 +1,88 @@
+#--
+# webricknio.rb
+#
+# Author: others and Pradeep Singh
+# Copyright (c) 2012 Pradeep Singh
+# All rights reserved.
+
+require 'webricknio'
+require 'stringio'
+require 'rack/content_length'
+
+module Rack
+  module Handler
+    class WEBrickNIO < ::WEBrick::HTTPServlet::AbstractServlet
+      def self.run(app, options={})
+        options[:BindAddress] = options.delete(:Host) if options[:Host]
+        @server = ::WEBrickNIO::HTTPServer.new(options)
+        @server.mount "/", ::Rack::Handler::WEBrickNIO, app
+        yield @server  if block_given?
+        @server.start
+      end
+
+      def self.valid_options
+        {
+            "Host=HOST" => "Hostname to listen on (default: localhost)",
+            "Port=PORT" => "Port to listen on (default: 8080)",
+        }
+      end
+
+      def self.shutdown
+        @server.shutdown
+        @server = nil
+      end
+
+      def initialize(server, app)
+        #super server
+        @app = app
+      end
+
+      def service(req, res)
+        env = req.meta_vars
+        env.delete_if { |k, v| v.nil? }
+
+        rack_input = StringIO.new(req.body.to_s)
+        rack_input.set_encoding(Encoding::BINARY) if rack_input.respond_to?(:set_encoding)
+
+        env.update({"rack.version" => Rack::VERSION,
+                    "rack.input" => rack_input,
+                    "rack.errors" => $stderr,
+
+                    "rack.multithread" => true,
+                    "rack.multiprocess" => false,
+                    "rack.run_once" => false,
+
+                    "rack.url_scheme" => ["yes", "on", "1"].include?(ENV["HTTPS"]) ? "https" : "http"
+                   })
+
+        env["HTTP_VERSION"] ||= env["SERVER_PROTOCOL"]
+        env["QUERY_STRING"] ||= ""
+        unless env["PATH_INFO"] == ""
+          path, n = req.request_uri.path, env["SCRIPT_NAME"].length
+          env["PATH_INFO"] = path[n, path.length-n]
+        end
+        env["REQUEST_PATH"] ||= [env["SCRIPT_NAME"], env["PATH_INFO"]].join
+
+        status, headers, body = @app.call(env)
+        begin
+          res.status = status.to_i
+          headers.each { |k, vs|
+            if k.downcase == "set-cookie"
+              res.cookies.concat vs.split("\n")
+            else
+              # Since WEBrick won't accept repeated headers,
+              # merge the values per RFC 1945 section 4.2.
+              res[k] = vs.split("\n").join(", ")
+            end
+          }
+          body.each { |part|
+            res.body << part
+          }
+        ensure
+          body.close  if body.respond_to? :close
+        end
+      end
+
+    end
+  end
+end

data/lib/webricknio.rb

@@ -0,0 +1,237 @@
+##
+# = WEB server toolkit.
+#
+# WEBrick is an HTTP server toolkit that can be configured as an HTTPS server,
+# a proxy server, and a virtual-host server.  WEBrick features complete
+# 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
+# provide differing behavior on a per-host or per-path basis.  WEBrick
+# 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
+# at a higher privilege level and dropping permissions.
+#
+# == Starting an HTTP server
+#
+# To create a new WEBrick::HTTPServer that will listen to connections on port
+# 8000 and serve documents from the current user's public_html folder:
+#
+#   require 'webrick'
+#
+#   root = File.expand_path '~/public_html'
+#   server = WEBrick::HTTPServer.new :Port => 8000, :DocumentRoot => root
+#
+# To run the server you will need to provide a suitable shutdown hook as
+# starting the server blocks the current thread:
+#
+#   trap 'INT' do server.shutdown end
+#
+#   server.start
+#
+# == Custom Behavior
+#
+# The easiest way to have a server perform custom operations is through
+# WEBrick::HTTPServer#mount_proc.  The block given will be called with a
+# WEBrick::HTTPRequest with request info and a WEBrick::HTTPResponse which
+# must be filled in appropriately:
+#
+#   server.mount_proc '/' do |req, res|
+#     res.body = 'Hello, world!'
+#   end
+#
+# Remember that <tt>server.mount_proc</tt> must <tt>server.start</tt>.
+#
+# == Servlets
+#
+# Advanced custom behavior can be obtained through mounting a subclass of
+# WEBrick::HTTPServlet::AbstractServlet.  Servlets provide more modularity
+# when writing an HTTP server than mount_proc allows.  Here is a simple
+# servlet:
+#
+#   class Simple < WEBrick::HTTPServlet::AbstractServlet
+#     def do_GET request, response
+#       status, content_type, body = do_stuff_with request
+#
+#       response.status = 200
+#       response['Content-Type'] = 'text/plain'
+#       response.body = 'Hello, World!'
+#     end
+#   end
+#
+# To initialize the servlet you mount it on the server:
+#
+#   server.mount '/simple', Simple
+#
+# See WEBrick::HTTPServlet::AbstractServlet for more details.
+#
+# == Virtual Hosts
+#
+# A server can act as a virtual host for multiple host names.  After creating
+# the listening host, additional hosts that do not listen can be created and
+# attached as virtual hosts:
+#
+#   server = WEBrick::HTTPServer.new # ...
+#
+#   vhost = WEBrick::HTTPServer.new :ServerName => 'vhost.example',
+#                                   :DoNotListen => true, # ...
+#   vhost.mount '/', ...
+#
+#   server.virtual_host vhost
+#
+# If no +:DocumentRoot+ is provided and no servlets or procs are mounted on the
+# main server it will return 404 for all URLs.
+#
+# == HTTPS
+#
+# To create an HTTPS server you only need to enable SSL and provide an SSL
+# certificate name:
+#
+#   require 'webrick'
+#   require 'webrick/https'
+#
+#   cert_name = [
+#     %w[CN localhost],
+#   ]
+#
+#   server = WEBrick::HTTPServer.new(:Port => 8000,
+#                                    :SSLEnable => true,
+#                                    :SSLCertName => cert_name)
+#
+# This will start the server with a self-generated self-signed certificate.
+# The certificate will be changed every time the server is restarted.
+#
+# To create a server with a pre-determined key and certificate you can provide
+# them:
+#
+#   require 'webrick'
+#   require 'webrick/https'
+#   require 'openssl'
+#
+#   cert = OpenSSL::X509::Certificate.new File.read '/path/to/cert.pem'
+#   pkey = OpenSSL::PKey::RSA.new File.read '/path/to/pkey.pem'
+#
+#   server = WEBrick::HTTPServer.new(:Port => 8000,
+#                                    :SSLEnable => true,
+#                                    :SSLCertificate => cert,
+#                                    :SSLPrivateKey => pkey)
+#
+# == Proxy Server
+#
+# WEBrick can act as a proxy server:
+#
+#   require 'webrick'
+#   require 'webrick/httpproxy'
+#
+#   proxy = WEBrick::HTTPProxyServer.new :Port => 8000
+#
+#   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.
+#
+# == Basic and Digest authentication
+#
+# WEBrick provides both Basic and Digest authentication for regular and proxy
+# servers.  See WEBrick::HTTPAuth, WEBrick::HTTPAuth::BasicAuth and
+# WEBrick::HTTPAuth::DigestAuth.
+#
+# == WEBrick as a Production Web Server
+#
+# WEBrick can be run as a production server for small loads.
+#
+# === Daemonizing
+#
+# To start a WEBrick server as a daemon simple run WEBrick::Daemon.start
+# before starting the server.
+#
+# === Dropping Permissions
+#
+# WEBrick can be started as one user to gain permission to bind to port 80 or
+# 443 for serving HTTP or HTTPS traffic then can drop these permissions for
+# regular operation.  To listen on all interfaces for HTTP traffic:
+#
+#   sockets = WEBrick::Utils.create_listeners nil, 80
+#
+# Then drop privileges:
+#
+#   WEBrick::Utils.su 'www'
+#
+# Then create a server that does not listen by default:
+#
+#   server = WEBrick::HTTPServer.new :DoNotListen => true, # ...
+#
+# Then overwrite the listening sockets with the port 80 sockets:
+#
+#   server.listeners.replace sockets
+#
+# === Logging
+#
+# WEBrick can separately log server operations and end-user access.  For
+# server operations:
+#
+#   log_file = File.open '/var/log/webrick.log', 'a+'
+#   log = WEBrick::Log.new log_file
+#
+# For user access logging:
+#
+#   access_log = [
+#     [log_file, WEBrick::AccessLog::COMBINED_LOG_FORMAT],
+#   ]
+#
+#   server = WEBrick::HTTPServer.new :Logger => log, :AccessLog => access_log
+#
+# See WEBrick::AccessLog for further log formats.
+#
+# === Log Rotation
+#
+# To rotate logs in WEBrick on a HUP signal (like syslogd can send), open the
+# log file in 'a+' mode (as above) and trap 'HUP' to reopen the log file:
+#
+#   trap 'HUP' do log_file.reopen '/path/to/webrick.log', 'a+'
+#
+# == Copyright
+#
+# Author: IPR -- Internet Programming with Ruby -- writers, Pradeep Singh
+#
+# Copyright (c) 2000 TAKAHASHI Masayoshi, GOTOU YUUZOU
+# Copyright (c) 2002 Internet Programming with Ruby writers
+# Copyright (c) 2012 Pradeep Singh
+# All rights reserved.
+#--
+# $IPR: webrick.rb,v 1.12 2002/10/01 17:16:31 gotoyuzo Exp $
+
+module WEBrickNIO
+end
+
+require 'webrick/compat.rb'
+
+require 'webricknio/version'
+require 'webricknio/config'
+require 'webrick/log.rb'
+require 'webricknio/log'
+require 'webrick/utils.rb'
+require 'webricknio/accesslog'
+
+require 'webrick/htmlutils.rb'
+require 'webrick/httputils.rb'
+require 'webrick/cookie.rb'
+require 'webrick/httpversion.rb'
+require 'webrick/httpstatus.rb'
+require 'webricknio/httprequest'
+require 'webricknio/httpresponse'
+require 'webricknio/httpserver'
+require 'webrick/httpservlet.rb'
+require 'webrick/httpauth.rb'
+
+require 'rack/handler'
+
+if defined?(Rails) && defined?(Rails::Generators)
+  require 'generator/webricknio_generator'
+end
+
+Rack::Handler::autoload :WEBrickNIO, "rack/handler/webricknio"
+Rack::Handler::register 'wnio', 'Rack::Handler::WEBrickNIO'