serverside 0.2.5 → 0.2.6

data/CHANGELOG

@@ -1,3 +1,13 @@
+*SVN*
+
+* Refactored HTTP-related code into a new HTTP::Request class and a simplified HTTP::Connection.
+
+* Another small change to docs.
+
+* Fixed small error in Rakefile that prevented doc_rforge task from updating the docs.
+
+* Fixed minor documentation error.
+
 *0.2.5*
 
 * Added template serving to static file module.

data/README

@@ -12,9 +12,9 @@ clusters of servers.
 * {Bug tracking}[http://code.google.com/p/serverside/issues/list]
 * {RubyForge page}[http://rubyforge.org/projects/serverside/]
 
-To check out the repository, just perform:
+To check out the source code:
   
-  svn co {http://serverside.googlecode.com/svn/}[http://serverside.googlecode.com/svn/]
+  svn co http://serverside.googlecode.com/svn/trunk
 
 == Installation
 
@@ -48,7 +48,7 @@ By default ServerSide serves static files, but you can change the behavior by
 creating custom {routing rules}[classes/ServerSide/Connection/Router.html].
 Here's a simple routing rule:
 
-  ServerSide.route(:path => '/hello/:name') {
+  ServerSide::Router.route(:path => '/hello/:name') {
     send_response(200, 'text', "Hello #{@parameters[:name]}!")
   }
 

data/Rakefile

@@ -7,7 +7,7 @@ require 'fileutils'
 include FileUtils
 
 NAME = "serverside"
-VERS = "0.2.5"
+VERS = "0.2.6"
 CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "ServerSide Documentation",
   "--opname", "index.html",
@@ -68,7 +68,7 @@ task :uninstall => [:clean] do
 end
 
 task :doc_rforge do
-  Rake::Task['doc'].execute
+  sh %{rake doc}
   sh %{scp -r doc/rdoc/* ciconia@rubyforge.org:/var/www/gforge-projects/serverside}
 end
 
@@ -105,8 +105,8 @@ end
 
 desc 'Run all tests, specs and finish with rcov'
 task :aok do
-  Rake::Task['rcov'].execute
-  Rake::Task['spec'].execute
+  sh %{rake rcov}
+  sh %{rake spec}
 end
 
 ##############################################################################

data/bin/serverside

@@ -64,8 +64,8 @@ else
   fn = File.join(path, 'serverside.rb')
   require fn if File.file?(fn)
 end
-unless ServerSide::Connection::Router.has_routes?
-  ServerSide.route_default {serve_static('.'/@path)}
+unless ServerSide::Router.has_routes?
+  ServerSide::Router.route_default {serve_static('.'/@path)}
 end
 
 if $cmd == 'serve'
@@ -75,8 +75,8 @@ if $cmd == 'serve'
   end
   puts "Serving at #{$cmd_config[:host]}:#{$cmd_config[:ports].begin}..."
   trap('INT') {exit}
-  ServerSide::Server.new($cmd_config[:host], $cmd_config[:ports].begin,
-    ServerSide::Connection::Router)
+  ServerSide::HTTP::Server.new($cmd_config[:host], $cmd_config[:ports].begin,
+    ServerSide::Router)
 else
   ServerSide::Application.daemonize($cmd_config, $cmd)
 end

data/doc/rdoc/classes/Daemon.html

@@ -55,13 +55,13 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../files/lib/serverside/daemon_rb.html">
-                lib/serverside/daemon.rb
-                </a>
-        <br />
                 <a href="../files/lib/serverside/cluster_rb.html">
                 lib/serverside/cluster.rb
                 </a>
+        <br />
+                <a href="../files/lib/serverside/daemon_rb.html">
+                lib/serverside/daemon.rb
+                </a>
         <br />
             </td>
         </tr>

data/doc/rdoc/classes/ServerSide.html

@@ -58,10 +58,6 @@
                 <a href="../files/lib/serverside_rb.html">
                 lib/serverside.rb
                 </a>
-        <br />
-                <a href="../files/lib/serverside/server_rb.html">
-                lib/serverside/server.rb
-                </a>
         <br />
                 <a href="../files/lib/serverside/application_rb.html">
                 lib/serverside/application.rb
@@ -71,13 +67,21 @@
                 lib/serverside/connection.rb
                 </a>
         <br />
-                <a href="../files/lib/serverside/static_rb.html">
-                lib/serverside/static.rb
+                <a href="../files/lib/serverside/request_rb.html">
+                lib/serverside/request.rb
                 </a>
         <br />
                 <a href="../files/lib/serverside/routing_rb.html">
                 lib/serverside/routing.rb
                 </a>
+        <br />
+                <a href="../files/lib/serverside/server_rb.html">
+                lib/serverside/server.rb
+                </a>
+        <br />
+                <a href="../files/lib/serverside/static_rb.html">
+                lib/serverside/static.rb
+                </a>
         <br />
                 <a href="../files/lib/serverside/template_rb.html">
                 lib/serverside/template.rb
@@ -103,7 +107,8 @@ easy to create custom light-weight web applications. It contains the
 following functionalities:
 </p>
 <ol>
-<li>A fast multithreaded HTTP server with support for persistent connections
+<li>A fast multithreaded <a href="ServerSide/HTTP.html">HTTP</a> server with
+support for persistent connections
 
 </li>
 </ol>
@@ -130,14 +135,6 @@ and streaming.
 
    </div>
 
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000022">route</a>&nbsp;&nbsp;
-      <a href="#M000023">route_default</a>&nbsp;&nbsp;
-      </div>
-    </div>
 
   </div>
 
@@ -150,9 +147,9 @@ and streaming.
       <h3 class="section-bar">Classes and Modules</h3>
 
       Module <a href="ServerSide/Application.html" class="link">ServerSide::Application</a><br />
-Module <a href="ServerSide/Connection.html" class="link">ServerSide::Connection</a><br />
+Module <a href="ServerSide/HTTP.html" class="link">ServerSide::HTTP</a><br />
 Module <a href="ServerSide/StaticFiles.html" class="link">ServerSide::StaticFiles</a><br />
-Class <a href="ServerSide/Server.html" class="link">ServerSide::Server</a><br />
+Class <a href="ServerSide/Router.html" class="link">ServerSide::Router</a><br />
 Class <a href="ServerSide/Template.html" class="link">ServerSide::Template</a><br />
 
     </div>
@@ -164,63 +161,6 @@ Class <a href="ServerSide/Template.html" class="link">ServerSide::Template</a><b
 
 
     <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000022" class="method-detail">
-        <a name="M000022"></a>
-
-        <div class="method-heading">
-          <a href="#M000022" class="method-signature">
-          <span class="method-name">route</span><span class="method-args">(rule, &amp;block)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Adds a routing rule. This is a convenience method.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000022-source">
-<pre>
-     <span class="ruby-comment cmt"># File lib/serverside/routing.rb, line 132</span>
-132:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">route</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-133:     <span class="ruby-constant">Connection</span><span class="ruby-operator">::</span><span class="ruby-constant">Router</span>.<span class="ruby-identifier">route</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-134:   <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000023" class="method-detail">
-        <a name="M000023"></a>
-
-        <div class="method-heading">
-          <a href="#M000023" class="method-signature">
-          <span class="method-name">route_default</span><span class="method-args">(&amp;block)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Sets the default request handler. This is a convenience method.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000023-source">
-<pre>
-     <span class="ruby-comment cmt"># File lib/serverside/routing.rb, line 137</span>
-137:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">route_default</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-138:     <span class="ruby-constant">Connection</span><span class="ruby-operator">::</span><span class="ruby-constant">Router</span>.<span class="ruby-identifier">route_default</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-139:   <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-
-    </div>
 
 
   </div>

data/doc/rdoc/classes/ServerSide/Application.html

@@ -80,8 +80,8 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000028">config=</a>&nbsp;&nbsp;
-      <a href="#M000029">daemonize</a>&nbsp;&nbsp;
+      <a href="#M000026">config=</a>&nbsp;&nbsp;
+      <a href="#M000027">daemonize</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -103,19 +103,19 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000028" class="method-detail">
-        <a name="M000028"></a>
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
 
         <div class="method-heading">
-          <a href="#M000028" class="method-signature">
+          <a href="#M000026" class="method-signature">
           <span class="method-name">config=</span><span class="method-args">(c)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000028-source">
+            onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000026-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/serverside/application.rb, line 9</span>
  9:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">config=</span>(<span class="ruby-identifier">c</span>)
@@ -126,19 +126,19 @@
         </div>
       </div>
 
-      <div id="method-M000029" class="method-detail">
-        <a name="M000029"></a>
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
 
         <div class="method-heading">
-          <a href="#M000029" class="method-signature">
+          <a href="#M000027" class="method-signature">
           <span class="method-name">daemonize</span><span class="method-args">(config, cmd)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000029-source">
+            onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000027-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/serverside/application.rb, line 13</span>
 13:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">cmd</span>)
@@ -146,7 +146,7 @@
 15:       <span class="ruby-identifier">daemon_class</span> = <span class="ruby-constant">Class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Daemon</span><span class="ruby-operator">::</span><span class="ruby-constant">Cluster</span>) <span class="ruby-keyword kw">do</span>
 16:         <span class="ruby-identifier">meta_def</span>(<span class="ruby-identifier">:pid_fn</span>) {<span class="ruby-constant">Daemon</span><span class="ruby-operator">::</span><span class="ruby-constant">WorkingDirectory</span><span class="ruby-operator">/</span><span class="ruby-value str">'serverside.pid'</span>}
 17:         <span class="ruby-identifier">meta_def</span>(<span class="ruby-identifier">:server_loop</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">port</span><span class="ruby-operator">|</span>
-18:           <span class="ruby-constant">ServerSide</span><span class="ruby-operator">::</span><span class="ruby-constant">Server</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>[<span class="ruby-identifier">:host</span>], <span class="ruby-identifier">port</span>, <span class="ruby-constant">ServerSide</span><span class="ruby-operator">::</span><span class="ruby-constant">Connection</span><span class="ruby-operator">::</span><span class="ruby-constant">Router</span>)
+18:           <span class="ruby-constant">ServerSide</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Server</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>[<span class="ruby-identifier">:host</span>], <span class="ruby-identifier">port</span>, <span class="ruby-constant">ServerSide</span><span class="ruby-operator">::</span><span class="ruby-constant">Router</span>)
 19:         <span class="ruby-keyword kw">end</span>
 20:         <span class="ruby-identifier">meta_def</span>(<span class="ruby-identifier">:ports</span>) {<span class="ruby-identifier">config</span>[<span class="ruby-identifier">:ports</span>]}
 21:       <span class="ruby-keyword kw">end</span>

data/doc/rdoc/classes/ServerSide/{Connection.html → HTTP.html}

@@ -5,7 +5,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>Module: ServerSide::Connection</title>
+  <title>Module: ServerSide::HTTP</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
@@ -50,7 +50,7 @@
         <table class="header-table">
         <tr class="top-aligned-row">
           <td><strong>Module</strong></td>
-          <td class="class-name-in-header">ServerSide::Connection</td>
+          <td class="class-name-in-header">ServerSide::HTTP</td>
         </tr>
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
@@ -59,8 +59,12 @@
                 lib/serverside/connection.rb
                 </a>
         <br />
-                <a href="../../files/lib/serverside/routing_rb.html">
-                lib/serverside/routing.rb
+                <a href="../../files/lib/serverside/request_rb.html">
+                lib/serverside/request.rb
+                </a>
+        <br />
+                <a href="../../files/lib/serverside/server_rb.html">
+                lib/serverside/server.rb
                 </a>
         <br />
             </td>
@@ -76,17 +80,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-The <a href="Connection.html">Connection</a> module takes care of HTTP
-connection. While most HTTP servers (at least the OO ones) will define
-separate classes for request and response, I chose to use the concept of a
-connection both for better performance, and also because a single
-connection might handle multiple requests, if using HTTP 1.1 persistent
-connection.
-</p>
-
-    </div>
 
 
    </div>
@@ -102,9 +95,10 @@ connection.
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
 
-      Module <a href="Connection/Const.html" class="link">ServerSide::Connection::Const</a><br />
-Class <a href="Connection/Base.html" class="link">ServerSide::Connection::Base</a><br />
-Class <a href="Connection/Router.html" class="link">ServerSide::Connection::Router</a><br />
+      Module <a href="HTTP/Const.html" class="link">ServerSide::HTTP::Const</a><br />
+Class <a href="HTTP/Connection.html" class="link">ServerSide::HTTP::Connection</a><br />
+Class <a href="HTTP/Request.html" class="link">ServerSide::HTTP::Request</a><br />
+Class <a href="HTTP/Server.html" class="link">ServerSide::HTTP::Server</a><br />
 
     </div>
 

data/doc/rdoc/classes/ServerSide/HTTP/Connection.html

@@ -0,0 +1,200 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: ServerSide::HTTP::Connection</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">ServerSide::HTTP::Connection</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/serverside/connection_rb.html">
+                lib/serverside/connection.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="../../Object.html">
+                Object
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The <a href="Connection.html">Connection</a> class represents <a
+href="../HTTP.html">HTTP</a> connections. Each connection instance creates
+a separate thread for execution and processes incoming requests in a loop
+until the connection is closed by either server or client, thus
+implementing <a href="../HTTP.html">HTTP</a> 1.1 persistent connections.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000039">new</a>&nbsp;&nbsp;
+      <a href="#M000040">process</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000039" class="method-detail">
+        <a name="M000039"></a>
+
+        <div class="method-heading">
+          <a href="#M000039" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(conn, request_class)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Initializes the request instance. A new thread is created for processing
+requests.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000039-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/serverside/connection.rb, line 13</span>
+13:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">conn</span>, <span class="ruby-identifier">request_class</span>)
+14:         <span class="ruby-ivar">@conn</span>, <span class="ruby-ivar">@request_class</span> = <span class="ruby-identifier">conn</span>, <span class="ruby-identifier">request_class</span>
+15:         <span class="ruby-ivar">@thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> {<span class="ruby-identifier">process</span>}
+16:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000040" class="method-detail">
+        <a name="M000040"></a>
+
+        <div class="method-heading">
+          <a href="#M000040" class="method-signature">
+          <span class="method-name">process</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Processes incoming requests by parsing them and then responding. If any
+error occurs, or the connection is not persistent, the connection is
+closed.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000040-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/serverside/connection.rb, line 21</span>
+21:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process</span>
+22:         <span class="ruby-keyword kw">while</span> <span class="ruby-keyword kw">true</span>
+23:           <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@request_class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@conn</span>).<span class="ruby-identifier">process</span>
+24:         <span class="ruby-keyword kw">end</span>
+25:       <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+26:         <span class="ruby-comment cmt"># We don't care. Just close the connection.</span>
+27:       <span class="ruby-keyword kw">ensure</span>
+28:         <span class="ruby-ivar">@conn</span>.<span class="ruby-identifier">close</span>
+29:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>