mongrel_output_compression 0.1.0

data/COPYING

@@ -0,0 +1,22 @@
+Copyright (c) 2007 Brian J. Landau
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007 Brian J. Landau
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,16 @@
+== Mongrel HTTP Output Compression Handler Plugin
+
+*Website*: http://rubyforge.org/projects/mongrel-compres
+
+=== Usage:
+
+To use this plugin you just need to create a mongrel config script with the line:
+
+    uri '', :handler => plugin('handlers/outputcompression')
+
+For those that have never used a mongrel config script: You could put this in a file called "mongrel.rb" in your Rails applications config directory, and then run, from your projects root directory:  <tt>mongrel_rails -S config/mongrel.rb</tt>.
+
+This is based on:
+* The {Better Output Compression Plugin}[http://wiki.rubyonrails.com/rails/pages/Better+Output+Compression+Plugin] by Tom Fakes, Dan Kubb, and Sebastian.
+* And the {Output Compression Plugin}[http://wiki.rubyonrails.org/rails/pages/Output+Compression+Plugin] by Jeremy Evans
+

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+include FileUtils
+
+version="0.1.0"
+name="mongrel_output_compression"
+
+spec = Gem::Specification.new do |s|
+   s.name = name
+   s.version = version
+   s.description = s.summary = "A mongrel plugin to gzip or deflate compress all output if the client supports it."
+   s.author = "Brian Landau"
+   s.homepage = "http://rubyforge.org/projects/mongrel-compres/"
+   s.rubyforge_project = "mongrel-compres"
+   s.add_dependency('gem_plugin', '>= 0.2.3')
+   s.add_dependency('mongrel', '>= 1.1.1')
+
+
+   s.platform = Gem::Platform::RUBY
+   s.has_rdoc = true
+   s.extra_rdoc_files = ["README"]
+
+   s.files = %w(COPYING LICENSE README Rakefile) +
+    Dir.glob("{bin,doc/rdoc,test,lib}/**/*") + 
+    Dir.glob("resources/**/*")
+
+   s.require_path = "lib"
+   s.bindir = "bin"
+   s.test_files = Dir.glob('test/*.rb')
+   
+   s.signing_key = '/Users/brianlandau/private/gem-private_key.pem'
+   s.cert_chain = ['/Users/brianlandau/.gem/gem-public_cert.pem']
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+   p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :install => [:test, :package] do
+   sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [:clean] do
+   sh %{sudo gem uninstall #{name}}
+end
+
+Rake::TestTask.new do |t|
+   t.libs << "test"
+   t.test_files = FileList['test/test*.rb']
+   t.verbose = true
+end
+
+Rake::RDocTask.new do |rdoc|
+   rdoc.rdoc_dir = 'doc/rdoc'
+   rdoc.options << '--line-numbers'
+   rdoc.rdoc_files.add ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', 'doc/**/*.rdoc']
+   rdoc.options << '--main' << 'README'
+end
+
+task :default => [:test, :package]
+
+CLEAN.include ['build/*', '**/*.o', '**/*.so', '**/*.a', 'lib/*-*', '**/*.log', 'pkg', 'lib/*.bundle', '*.gem', '.config']
+

data/doc/rdoc/classes/OutputCompression.html

@@ -0,0 +1,152 @@
+<?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: OutputCompression</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">OutputCompression</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/mongrel_output_compression/init_rb.html">
+                lib/mongrel_output_compression/init.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                GemPlugin::Plugin&quot;/handlers&quot;
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <h2>HTTP Output Compression Handler Plugin</h2>
+<p>
+This class is a Mongrel web server plugin to handle a gzip/deflate response
+if the client supports it.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">process</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name">Mongrel::HttpHandlerPlugin</span>
+      </div>
+    </div>
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="OutputCompression.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('OutputCompression.src/M000001.html');return false;">
+          <span class="method-name">process</span><span class="method-args">(request, response)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </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>

data/doc/rdoc/classes/OutputCompression.src/M000001.html

@@ -0,0 +1,53 @@
+<?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>
+<head>
+  <title>process (OutputCompression)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/mongrel_output_compression/init.rb, line 20</span>
+20:    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">response</span>)
+21:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">COMPRESSION_DISABLED</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value str">&quot;HTTP_ACCEPT_ENCODING&quot;</span>].<span class="ruby-identifier">nil?</span>
+22:       <span class="ruby-keyword kw">begin</span>
+23:          <span class="ruby-identifier">request</span>.<span class="ruby-identifier">params</span>[<span class="ruby-value str">&quot;HTTP_ACCEPT_ENCODING&quot;</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/\s*,\s*/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">encoding</span><span class="ruby-operator">|</span>
+24:            <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">encoding</span>
+25:               <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\Agzip\b/</span>
+26:                  <span class="ruby-identifier">strio</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>
+27:                  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">strio</span>.<span class="ruby-identifier">close</span>
+28:                     <span class="ruby-identifier">rewind</span> 
+29:                  <span class="ruby-keyword kw">end</span>
+30:                  <span class="ruby-identifier">gz</span> = <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">GzipWriter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">strio</span>)
+31:                  <span class="ruby-identifier">gz</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">string</span>)
+32:                  <span class="ruby-identifier">gz</span>.<span class="ruby-identifier">close</span>
+33:                  <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">strio</span>
+34:                  <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">rewind</span>
+35:               <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\Adeflate\b/</span>
+36:                  <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">Deflate</span>.<span class="ruby-identifier">deflate</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">string</span>))
+37:                  <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">rewind</span>
+38:               <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\Aidentity\b/</span>
+39:                  <span class="ruby-comment cmt"># do nothing for identity</span>
+40:               <span class="ruby-keyword kw">else</span>
+41:                  <span class="ruby-keyword kw">next</span> <span class="ruby-comment cmt"># the encoding is not supported, try the next one</span>
+42:            <span class="ruby-keyword kw">end</span>
+43:            <span class="ruby-ivar">@content_type</span> = <span class="ruby-identifier">encoding</span>
+44:            <span class="ruby-keyword kw">break</span>    <span class="ruby-comment cmt"># the encoding is supported, stop</span>
+45:          <span class="ruby-keyword kw">end</span>
+46:          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">header</span>[<span class="ruby-value str">'Content-Encoding'</span>] = <span class="ruby-ivar">@content_type</span>
+47:          <span class="ruby-comment cmt"># if response.header['Vary'] != '*'</span>
+48:          <span class="ruby-comment cmt">#    head['Vary'] = response.header['Vary'].to_s.split(',').push('Accept-Encoding').uniq.join(',')</span>
+49:          <span class="ruby-comment cmt"># end</span>
+50:          <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Response body was encoded with #{@content_type}\n&quot;</span>
+51:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+52:          <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Error with HTTP Compression: #{e.to_s}\n&quot;</span>
+53:          <span class="ruby-identifier">response</span>.<span class="ruby-identifier">start</span>(<span class="ruby-value">500</span>, <span class="ruby-keyword kw">true</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">head</span>, <span class="ruby-identifier">out</span><span class="ruby-operator">|</span>
+54:             <span class="ruby-identifier">out</span>.<span class="ruby-identifier">write</span> <span class="ruby-node">&quot;error proceessing #{request.params['REQUEST_PATH']}\n&quot;</span>
+55:          <span class="ruby-keyword kw">end</span>
+56:       <span class="ruby-keyword kw">end</span>
+57:    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/created.rid

@@ -0,0 +1 @@
+Tue, 04 Dec 2007 22:24:28 -0500

data/doc/rdoc/files/COPYING.html

@@ -0,0 +1,129 @@
+<?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>File: COPYING</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="fileHeader">
+    <h1>COPYING</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>COPYING
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Tue Dec 04 15:42:49 -0500 2007</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Copyright (c) 2007 Brian J. Landau
+</p>
+<p>
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+&quot;Software&quot;), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+</p>
+<p>
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+</p>
+<p>
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>