narf 0.5.1 → 0.6.1

data/ChangeLog

@@ -1,4 +1,48 @@
 ------------------------------------------------------------------------
+rev 62:  patsplat | 2004-11-03 00:39:47 -0500 (Wed, 03 Nov 2004) | 1 line
+
+Updated ChangeLog for 0.6.0
+------------------------------------------------------------------------
+rev 61:  patsplat | 2004-11-03 00:35:31 -0500 (Wed, 03 Nov 2004) | 1 line
+
+added escapeHTML methods from cgi.rb; setup tarpit to accept IP ranges ~ pat
+------------------------------------------------------------------------
+rev 60:  patsplat | 2004-10-31 17:04:24 -0500 (Sun, 31 Oct 2004) | 1 line
+
+fixed multipart bug ~pat
+------------------------------------------------------------------------
+rev 59:  patsplat | 2004-10-04 00:47:29 -0400 (Mon, 04 Oct 2004) | 1 line
+
+re-arrangements ~ pat
+------------------------------------------------------------------------
+rev 58:  patsplat | 2004-10-03 11:42:02 -0400 (Sun, 03 Oct 2004) | 1 line
+
+documention tweaks ~ pat
+------------------------------------------------------------------------
+rev 57:  patsplat | 2004-10-03 11:27:46 -0400 (Sun, 03 Oct 2004) | 1 line
+
+re-arranged documentation ~ pat
+------------------------------------------------------------------------
+rev 56:  patsplat | 2004-10-03 10:45:08 -0400 (Sun, 03 Oct 2004) | 1 line
+
+made Web::env case insensitive (because who cares about case anyways?) ~ pat
+------------------------------------------------------------------------
+rev 55:  patsplat | 2004-10-01 20:25:15 -0400 (Fri, 01 Oct 2004) | 1 line
+
+added Web::clear & fixed trivial failures in test.assertincludes.rb for 1.6 -> 1.8 ~ pat
+------------------------------------------------------------------------
+rev 54:  patsplat | 2004-09-04 01:06:48 -0400 (Sat, 04 Sep 2004) | 1 line
+
+more documentation fixes ~ pat
+------------------------------------------------------------------------
+rev 52:  patsplat | 2004-09-03 18:21:33 -0400 (Fri, 03 Sep 2004) | 1 line
+
+Updated ChangeLog for 0.5.1
+------------------------------------------------------------------------
+rev 51:  patsplat | 2004-09-03 18:20:36 -0400 (Fri, 03 Sep 2004) | 1 line
+
+added inatallation notes ~ pat
+------------------------------------------------------------------------
 rev 49:  patsplat | 2004-09-03 18:19:24 -0400 (Fri, 03 Sep 2004) | 1 line
 
 Updated ChangeLog for 0.5.0

data/README

@@ -52,7 +52,9 @@ this:
 === Hello World
 
     require 'web'
-    Web << 'Hello World'
+    Web::process do
+      Web << 'Hello World'
+    end
 
 === Testing an App
 
@@ -66,7 +68,9 @@ where script.rb is:
     #!/usr/bin/ruby
     require 'web'
 
-    Web << "param is #{Web["param"]}"
+    Web::process do
+      Web << "param is #{Web["param"]}"
+    end
 
 and test.rb is:
     

data/README~

@@ -0,0 +1,124 @@
+=== Purpose
+  
+NARF is a replacement for, and derivative of, the Ruby CGI
+library. It exists one reason:
+
+* To trivialize web development
+
+We hope that these 3 lines of development will accomplish our task:
+
+* To provide a clean API for writing Web applications.
+
+* To make it very easy to write testable Web applications (using
+  Web::Testing), and provide a template system (Web::Narflates).
+
+* To test the above goals by developing integrated, high quality,
+  configurable versions of common web apps in a simple and easy
+  to use manner.  The heart of http://www.narf-lib.org, Web::Wiki
+  is an easy to use wiki.  Not the only one, but it does make
+  us eat our own dogfood :-)
+
+NARF does all of this as a regular CGI application.  It also runs in-process under fastcgi, mod_ruby, and webrick.  View these files for details:
+
+* sapi/fastcgi/INSTALL.txt
+* sapi/mod_ruby/INSTALL.txt
+* sapi/webrick/INSTALL.txt
+
+=== Installation
+
+Run the installer for NARF:
+
+    ruby build.rb test (optional)
+
+    ruby install.rb config
+    ruby install.rb setup
+    ruby install.rb install
+
+=== Dependencies
+
+NARF requires the following packages on ruby 1.6.  These packages are included in ruby 1.8:
+
+testunit (unit testing framework):
+http://testunit.talbott.ws/packages/testunit-0.1.6.tar.gz
+
+strscan (string scanner library):
+http://www.loveruby.net/archive/strscan/strscan-0.6.5.tar.gz
+
+You can use raa-install (http://www.ruby-lang.org/raa/list.rhtml?id=729) for
+this:
+    raa-install -i testunit
+    raa-install -i strscan 
+
+=== Hello World
+
+    require 'web'
+    Web << 'Hello World'
+
+=== Testing an App
+
+If you haven't noticed, NARF has a cgi style api.  It's also has a testing api.  Given these files:
+
+    script.rb
+    test.rb
+
+where script.rb is:
+
+    #!/usr/bin/ruby
+    require 'web'
+
+    Web << "param is #{Web["param"]}"
+
+and test.rb is:
+    
+    require 'web'
+    require 'test/unit'
+
+    class MyAppTest < Test::Unit::TestCase
+        include Web::Testing
+
+        def test_prints_content
+            do_request "script.rb", "param" => "THIS!"
+            assert_content "param is THIS!"
+	end
+    end
+
+Do this to run tests:
+
+     ruby test.rb
+
+See Web::Testing for more examples.
+
+=== Websites
+
+Home page:
+http://www.narf-lib.org
+
+Project info page, including downloads and CVS instructions:
+http://www.sourceforge.net/projects/narf-lib
+  
+=== Credits
+
+Narf was written by Tom Clarke and Patrick May, partly based on cgi.rb
+written by Wakou Aoyama. It makes significant use of ruby-htmltools,
+written by Ned Konz.  Also, Keunwoo Lee patched Request.read_multipart
+to be cleaner.  
+
+NARF contains code from the following projects, and we are in their debt:
+
+ruby-htmltools::
+    This is a Ruby library for building trees representing HTML structure.
+    http://bike-nomad.com/ruby
+sgml-parser::
+    The html-parser package is a variant language implementation of the
+    Python's SGML parser (sgmllib.py), HTML parser (htmllib.py) and
+    Formatter (formatter.py).
+    http://www.jin.gr.jp/%7Enahi/Ruby/html-parser/README.html
+webunit::
+    WebUnit is Ruby API for testing html/cgi without browser, and is
+    idealy suited for automated unit testing of web sites when combined
+    with a Ruby unit test framework such as RubyUnit. It was designed
+    and implemented by Masaki Suketa.
+    http://www.xpenguin.biz/download/webunit/index-en.html
+
+Thanks also go to http://www.sourceforge.net for hosting the
+project's CVS and website

data/build.rb

@@ -169,13 +169,14 @@ Target.new( "test", "run narf unit tests" ) {
     require 'test/unit'
     require 'test/unit/ui/console/testrunner'
 
-    $:.replace(['./lib/'].concat($:)) 
-
+    $:.replace( ['./lib/'].concat($:) ) 
+    
     require 'web'
     require 'web/wiki'
 
     def setup_wiki
       File.rm_rf( Web::Wiki::store_dir )
+      Web::Wiki::wipe
     end
     
     alias :teardown_wiki :setup_wiki

data/build.rb~

@@ -109,7 +109,7 @@ end
 
 Target.new( "upload_doc", "upload doc" ) {
     Target.run( "rdoc" )
-    `scp -r rdoc/* patsplat@ssh.narf-lib.org:~/narf-lib.org/doc`
+    `scp -r doc/rdoc/* patsplat@ssh.narf-lib.org:~/narf-lib.org/doc`
 }
 
   Target.new( "rdoc", "build rdoc" ) {

data/doc/apache_cgi.txt

@@ -10,8 +10,4 @@ Copy this file where ever you like, make it executable, and tell apache to run i
 
     #!/usr/local/bin/narf
 
-This file may likely has a buffer overflow in it.  Please be cautious with this until I can get verification that it is ok.
-
-Cheers,
-
-patrick@hexane.org
+This file may have a buffer overflow in it.  Please be cautious with this until I can get verification that it is ok.

data/doc/apache_cgi.txt~

@@ -0,0 +1,17 @@
+The main advantage of this executable is that this runner can print syntax errors to the screen.  To compile, run this from the project root (/narf):
+
+    ruby build.rb compile_narf_runner
+
+The compiled binary will be in
+
+    /narf/apache_cgi/bin/narf
+
+Copy this file where ever you like, make it executable, and tell apache to run it with a shebang:
+
+    #!/usr/local/bin/narf
+
+This file may likely has a buffer overflow in it.  Please be cautious with this until I can get verification that it is ok.
+
+Cheers,
+
+patrick@hexane.org

data/doc/fastcgi.txt

@@ -10,7 +10,7 @@ You can find a list of FastCGI servers here:
 
 After installing and configuring the appropriate libraries for your server, you will need to make sure that the cgi script executes in a Web::process block:
 
-    #!/usr/local/bin/ruby
+    #!/usr/local/bin/ruby -rweb
 
     Web::process{
       Web << 'Hello World!'

data/doc/fastcgi.txt~

@@ -0,0 +1,19 @@
+== FastCGI
+
+FastCGI support for narf requires the 'fcgi' libary:
+
+    http://raa.ruby-lang.org/list.rhtml?name=fcgi
+
+You can find a list of FastCGI servers here:
+
+    http://www.fastcgi.com
+
+After installing and configuring the appropriate libraries for your server, you will need to make sure that the cgi script executes in a Web::process block:
+
+    #!/usr/local/bin/ruby
+
+    Web::process{
+      Web << 'Hello World!'
+    }
+
+There is a neat continuation trick that matz discussed in [ruby-talk:13428] that makes the Web::process block unnecessary.  I've had some trouble getting it too work; when I do, I'll update these docs.

data/doc/rdoc/classes/Web.html

@@ -87,12 +87,15 @@ module delegates to a <a href="Web/CGI.html">Web::CGI</a> object, which
 does the actual work.
 </p>
 <pre>
-    #!/usr/bin/narf
-    Web[&quot;field&quot;]                      # access parameters
-    Web.cookies[&quot;muppet&quot;]             # access cookies
-    Web.session[&quot;key&quot;] ||= &quot;value&quot;    # get and set session values
-    Web.set_cookie( &quot;muppet&quot;, &quot;cookie monster&quot; ) # set cookies
-    Web.puts &quot;something&quot;              # print 'something' out
+    #!/usr/bin/ruby
+    require 'web'
+    Web::process do
+      Web[&quot;field&quot;]                      # access parameters
+      Web.cookies[&quot;muppet&quot;]             # access cookies
+      Web.session[&quot;key&quot;] ||= &quot;value&quot;    # get and set session values
+      Web.set_cookie( &quot;muppet&quot;, &quot;cookie monster&quot; ) # set cookies
+      Web.puts &quot;something&quot;              # print 'something' out
+    end
 </pre>
 <p>
 If the request contained multipart/form-data, uploaded files are returned

data/doc/rdoc/classes/Web.src/M000002.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 162</span>
+<pre><span class="cmt"># File lib/web.rb, line 165</span>
       <span class="kw">def</span> method_missing(method, *args, &amp;block)
         CGI.get_cgi.send(method,*args, &amp;block)
       <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web.src/M000003.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 166</span>
+<pre><span class="cmt"># File lib/web.rb, line 169</span>
       <span class="kw">def</span> set_cgi( cgi )
         CGI.set_cgi( cgi )
       <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web.src/M000004.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 170</span>
+<pre><span class="cmt"># File lib/web.rb, line 173</span>
       <span class="kw">def</span> get_cgi
         CGI.get_cgi
       <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web.src/M000005.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 174</span>
+<pre><span class="cmt"># File lib/web.rb, line 177</span>
       <span class="kw">def</span> process(options={}, &amp;block)
         CGI.process(options, &amp;block)
       <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web.src/M000006.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 180</span>
+<pre><span class="cmt"># File lib/web.rb, line 183</span>
     <span class="kw">def</span> Web::html_encode(string)
       <span class="kw">return</span> <span class="kw">nil</span> <span class="kw">unless</span> string
       newstring = string.dup

data/doc/rdoc/classes/Web.src/M000007.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 191</span>
+<pre><span class="cmt"># File lib/web.rb, line 194</span>
     <span class="kw">def</span> Web::escape(string)
       <span class="kw">return</span> <span class="kw">nil</span> <span class="kw">unless</span> string
       string.gsub(<span class="re">/([^ a-zA-Z0-9_.-]+)/n</span>) <span class="kw">do</span>

data/doc/rdoc/classes/Web.src/M000008.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 200</span>
+<pre><span class="cmt"># File lib/web.rb, line 203</span>
     <span class="kw">def</span> Web::unescape(string)
       <span class="kw">return</span> <span class="kw">nil</span> <span class="kw">unless</span> string
       string.tr(<span class="str">'+'</span>, <span class="str">' '</span>).gsub(<span class="re">/((?:%[0-9a-fA-F]{2})+)/n</span>) <span class="kw">do</span>

data/doc/rdoc/classes/Web.src/M000009.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web.rb, line 211</span>
+<pre><span class="cmt"># File lib/web.rb, line 214</span>
     <span class="kw">def</span> Web::rfc1123_date(time)
       t = time.clone.gmtime
       <span class="kw">return</span> format(<span class="str">&quot;%s, %.2d %s %.4d %.2d:%.2d:%.2d GMT&quot;</span>,

data/doc/rdoc/classes/Web/CGD.src/M000038.html

@@ -14,8 +14,9 @@
       @input    = options[:in]  || $stdin
       @output   = options[:out] || $stdout
       @env      = downcase_env( options[:env] || ENV )
-      
+
       @env[<span class="str">'document_root'</span>] = options[:document_root] || Web.get_docroot || @env[<span class="str">'document_root'</span>]
+      @env[<span class="str">'script_name'</span> ]  = options[:script_name] || @env[<span class="str">'script_name'</span>]
       
       parse_request
     <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web/CGD.src/M000039.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web/cgi.rb, line 541</span>
+<pre><span class="cmt"># File lib/web/cgi.rb, line 542</span>
     <span class="kw">def</span> close
       
     <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web/CGD.src/M000040.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web/cgi.rb, line 546</span>
+<pre><span class="cmt"># File lib/web/cgi.rb, line 547</span>
     <span class="kw">def</span> nph?
       @options[:nph] || <span class="re">/IIS/</span>.match(env[<span class="str">&quot;server_software&quot;</span>])
     <span class="kw">end</span></pre>

data/doc/rdoc/classes/Web/CGD.src/M000041.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web/cgi.rb, line 550</span>
+<pre><span class="cmt"># File lib/web/cgi.rb, line 551</span>
     <span class="kw">def</span> send_header( header )
       send_nph_header( header ) <span class="kw">if</span> (nph?)
     

data/doc/rdoc/classes/Web/CGI.src/M000105.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web/cgi.rb, line 577</span>
+<pre><span class="cmt"># File lib/web/cgi.rb, line 578</span>
     <span class="kw">def</span> report_error( err )
       <span class="kw">self</span>.puts <span class="str">&quot;&lt;h3&gt;ruby error:&lt;/h3&gt;&quot;</span>
       <span class="kw">self</span>.puts Dir.pwd

data/doc/rdoc/classes/Web/CGI.src/M000106.html

@@ -7,7 +7,7 @@
 <link rel=StyleSheet href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body bgcolor="white">
-<pre><span class="cmt"># File lib/web/cgi.rb, line 592</span>
+<pre><span class="cmt"># File lib/web/cgi.rb, line 593</span>
     <span class="kw">def</span> CGI::server_sniff
       <span class="kw">if</span>( Object.const_defined?( <span class="str">&quot;Apache&quot;</span> ) \
           &amp;&amp; Apache.const_defined?( <span class="str">&quot;Request&quot;</span> ) \