gzip_filter 0.2

data/COPYING

@@ -0,0 +1,55 @@
+This GzipFilter GemPlugin is copyrighted free software by Eden Li
+(eden.li@gmail.com). You can redistribute it and/or modify it under
+either the terms of the GPL or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+     a) place your modifications in the Public Domain or otherwise make them
+     Freely Available, such as by posting said modifications to Usenet or an
+     equivalent medium, or by allowing the author to include your
+     modifications in the software.
+
+     b) use the modified software only within your corporation or
+        organization.
+
+     c) rename any non-standard executables so the names do not conflict with
+     standard executables, which must also be provided.
+
+     d) make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or executable
+   form, provided that you do at least ONE of the following:
+
+     a) distribute the executables and library files of the software,
+     together with instructions (in the manual page or equivalent) on where
+     to get the original distribution.
+
+     b) accompany the distribution with the machine-readable source of the
+     software.
+
+     c) give non-standard executables non-standard names, with
+        instructions on where to get the original software distribution.
+
+     d) make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under this terms.
+
+5. The scripts and library files supplied as input to or produced as 
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them, 
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.
+
+

data/LICENSE

@@ -0,0 +1,55 @@
+This GzipFilter GemPlugin is copyrighted free software by Eden Li
+(eden.li@gmail.com). You can redistribute it and/or modify it under
+either the terms of the GPL or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+     a) place your modifications in the Public Domain or otherwise make them
+     Freely Available, such as by posting said modifications to Usenet or an
+     equivalent medium, or by allowing the author to include your
+     modifications in the software.
+
+     b) use the modified software only within your corporation or
+        organization.
+
+     c) rename any non-standard executables so the names do not conflict with
+     standard executables, which must also be provided.
+
+     d) make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or executable
+   form, provided that you do at least ONE of the following:
+
+     a) distribute the executables and library files of the software,
+     together with instructions (in the manual page or equivalent) on where
+     to get the original distribution.
+
+     b) accompany the distribution with the machine-readable source of the
+     software.
+
+     c) give non-standard executables non-standard names, with
+        instructions on where to get the original software distribution.
+
+     d) make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under this terms.
+
+5. The scripts and library files supplied as input to or produced as 
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them, 
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.
+
+

data/README

@@ -0,0 +1,30 @@
+= Gzip Filter GemPlugin
+
+This GemPlugin hands back HTTP responses compressed using gzip if the
+client requests it.  It's been tested in IE6, Mozilla Firefox 1.5 and 2.0.
+
+== Install, config, run
+$ sudo gem install gzip_filter
+$ echo 'uri "/", :handler => plugin("/handlers/gzipfilter")' >> config/mongrel.conf
+$ mongrel_rails -S config/mongrel.conf
+
+== Using with mongrel_cluster
+Add the following line to your config/mongrel_cluster.yml file:
+
+config_script: config/mongrel.conf
+
+== ChangeLog
+
+2006/10/25 -- 0.2
+ * Added :gzip_condition => proc{|request|} to GzipFilter's constructor.
+   You can now write some Ruby code to gzip responses based on what was
+	 given to you in the request.
+
+   Example (in mongrel.conf):
+      # Gzip only for non IE6 requests
+      uri "/", :handler => GzipFilter.new(:gzip_condition => proc {|request|
+        request.params['HTTP_USER_AGENT'] !~ /MSIE\s+6\.0/i
+      })
+
+2006/10/23 -- 0.1
+ * Initial release

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'tools/rakehelp'
+require 'fileutils'
+include FileUtils
+
+setup_tests
+setup_clean ["pkg", "lib/*.bundle", "*.gem", ".config"]
+
+setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', 'doc/**/*.rdoc']
+
+desc "Does a full compile, test run"
+task :default => [:test, :package]
+
+version="0.2"
+name="gzip_filter"
+
+setup_gem(name, version) do |spec|
+  spec.summary = "The GzipFilter GemPlugin"
+  spec.description = "Compresses your Mongrel's HTTP responses using gzip."
+  spec.author="Eden Li (eden.li@gmail.com)"
+  spec.add_dependency('mongrel', '>= 0.3.13.0')
+  spec.add_dependency('gem_plugin', '>= 0.2')
+  spec.files += Dir.glob("resources/**/*")
+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
+

data/lib/gzip_filter/init.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2006 Eden Li (eden.li@gmail.com)
+# You can redistribute it and/or modify it under terms listed in the LICENSE
+# file accompanying this package.
+#
+require 'mongrel'
+require 'gem_plugin'
+require 'zlib'
+
+# The GzipFilter compresses an HTTP response using Ruby's Zlib::GzipWriter.
+# It only does this if the client sends an Accept-Encoding header containing
+# the gzip string.
+#
+# You can tell mongrel to use this filter by placing the following line in
+# a config file and passing that file to mongrel using the -S option.
+# 
+# Example mongrel.conf:
+#   uri "/", :handler => GzipFilter.new
+#
+# Another example using the gzip_condition:
+#   uri "/", :handler => GzipFilter.new(:gzip_condition => proc {|request|
+#     request.params['HTTP_USER_AGENT'] !~ /MSIE\s+6\.0/i
+#   })
+#
+# Example:
+#
+#   $ echo 'uri "/", :handler => GzipFilter.new' >> config/mongrel.conf
+#   $ mongrel_rails -S config/mongrel.conf
+#
+class GzipFilter < GemPlugin::Plugin "/handlers"
+  include Mongrel::HttpHandlerPlugin
+
+  # You can pass in a conditional function that will be used to determine
+  # if the response should be gzipped or not.  It'll get passed the
+  # request object for validation.  This is called in addition to checks
+  # on the Accept-Encoding header.
+  #
+  # GzipFilter.new(:gzip_condition => proc {|request|
+  #   request.params['HTTP_USER_AGENT'] !~ /MSIE\s+6\.0/i
+  # })
+  #
+  def initialize(opts = {})
+    @conditions = opts[:gzip_condition]
+  end
+
+  def process(request, response)
+    if should_gzip(request, response)
+      response.header["Content-Encoding"] = "gzip"
+      response.body = gzip_stream(response.body)
+    end
+  end
+
+  private
+    def should_gzip(request, response)
+      (@conditions ? @conditions.call(request) : true) &&
+        !response.body_sent &&
+        request.params["HTTP_ACCEPT_ENCODING"] &&
+        request.params["HTTP_ACCEPT_ENCODING"].downcase.include?("gzip")
+    end
+
+    def gzip_stream(stream, close = true)
+      z = Zlib::GzipWriter.new(gzipped = StringIO.new)
+      stream.rewind
+      z.write(stream.read)
+      z.finish
+      stream.close if close
+
+      gzipped
+    end
+end
+

data/test/test_gzip_filter.rb

@@ -0,0 +1,91 @@
+require 'test/unit'
+require 'net/http'
+require 'mongrel'
+require 'zlib'
+require 'lib/gzip_filter/init'
+
+class SimpleHandler < Mongrel::HttpHandler
+  CONTENT = "<html><head><title></title></head><body>lkjlkj</body></html>"
+  def process(request, response)
+    response.start do |head, out|
+      head["Content-Type"] = "text/html"
+      out << CONTENT
+    end
+  end
+end
+
+class GzipFilterTest < Test::Unit::TestCase
+  def setup
+    @mongrel = Mongrel::HttpServer.new("127.0.0.1", 121212)
+    @mongrel.register("/", SimpleHandler.new)
+    @mongrel.register("/", GzipFilter.new)
+
+    @mongrel.register("/more/ie/goodness", SimpleHandler.new)
+    @mongrel.register("/more/ie/goodness",
+      GzipFilter.new(:gzip_condition => proc { |r|
+        r.params["HTTP_USER_AGENT"] !~ /msie\s+6\.0/i
+      })
+    )
+    @mongrel.run
+  end
+
+  def teardown
+    @mongrel.stop if @mongrel
+  end
+
+  def test_ungzipped
+    assert_content(get("http://localhost:121212"))
+  end
+
+  def test_gzipped
+    response = get("http://localhost:121212/", {"Accept-Encoding" => "gzip"})
+    assert_content(response, :gzip)
+
+    response = get("http://localhost:121212/", {"Accept-Encoding" => "GZip"})
+    assert_content(response, :gzip)
+  end
+
+  def test_deflate
+    response = get("http://localhost:121212/", {"Accept-Encoding" => "deflate"})
+    assert_content(response)
+  end
+
+  def test_both
+    response = get("http://localhost:121212/", {"Accept-Encoding" => "deflate,gzip"})
+    assert_content(response, :gzip)
+  end
+
+  def test_condition
+    response = get("http://localhost:121212/more/ie/goodness",
+      {"User-Agent" => "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)",
+       "Accept-Encoding" => "deflate,gzip"})
+    assert_content(response)
+
+    response = get("http://localhost:121212/more/ie/goodness",
+      {"User-Agent" => "User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1) Gecko/20061010 Firefox/2.0",
+       "Accept-Encoding" => "deflate,gzip"})
+    assert_content(response, :gzip)
+  end
+
+  private
+    def assert_content(response, encoding = nil)
+      if encoding == :gzip
+        assert response.header['Content-Encoding'].include?('gzip')
+        text = Zlib::GzipReader.new(StringIO.new(response.body)).read
+        assert_equal SimpleHandler::CONTENT, text
+      else
+        assert !response.header['Content-Encoding'] ||
+          !response.header['Content-Encoding'].include?('gzip')
+        assert_equal SimpleHandler::CONTENT, response.body
+      end
+    end
+
+    def get(url, headers = {})
+      url = URI.parse(url)
+      response = nil
+      Net::HTTP.start(url.host, url.port) do |h|
+        response = h.get(url.path != '' ? url.path : '/', headers)
+      end
+      response
+    end
+end

data/tools/rakehelp.rb

@@ -0,0 +1,106 @@
+
+def make(makedir)
+    Dir.chdir(makedir) do
+        sh(PLATFORM =~ /win32/ ? 'nmake' : 'make')
+    end
+end
+
+
+def extconf(dir)
+    Dir.chdir(dir) do ruby "extconf.rb" end
+end
+
+
+def setup_tests
+    Rake::TestTask.new do |t|
+        t.libs << "test"
+        t.test_files = FileList['test/test*.rb']
+        t.verbose = true
+    end
+end
+
+
+def setup_clean otherfiles
+    files = ['build/*', '**/*.o', '**/*.so', '**/*.a', 'lib/*-*', '**/*.log'] + otherfiles
+    CLEAN.include(files)
+end
+
+
+def setup_rdoc files
+    Rake::RDocTask.new do |rdoc|
+        rdoc.rdoc_dir = 'doc/rdoc'
+        rdoc.options << '--line-numbers'
+        rdoc.rdoc_files.add(files)
+    end
+end
+
+
+def setup_extension(dir, extension)
+    ext = "ext/#{dir}"
+    ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
+    ext_files = FileList[
+    "#{ext}/*.c",
+    "#{ext}/*.h",
+    "#{ext}/extconf.rb",
+    "#{ext}/Makefile",
+    "lib"
+    ] 
+    
+    task "lib" do
+        directory "lib"
+    end
+
+    desc "Builds just the #{extension} extension"
+    task extension.to_sym => ["#{ext}/Makefile", ext_so ]
+
+    file "#{ext}/Makefile" => ["#{ext}/extconf.rb"] do
+        extconf "#{ext}"
+    end
+
+    file ext_so => ext_files do
+        make "#{ext}"
+        cp ext_so, "lib"
+    end
+end
+
+
+def base_gem_spec(pkg_name, pkg_version)
+  pkg_version = pkg_version
+  pkg_name    = pkg_name
+  pkg_file_name = "#{pkg_name}-#{pkg_version}"
+  Gem::Specification.new do |s|
+    s.name = pkg_name
+    s.version = pkg_version
+    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("ext/**/*.{h,c,rb}") +
+      Dir.glob("examples/**/*.rb") +
+      Dir.glob("tools/*.rb")
+    
+    s.require_path = "lib"
+    s.extensions = FileList["ext/**/extconf.rb"].to_a
+    s.bindir = "bin"
+  end
+end
+
+def setup_gem(pkg_name, pkg_version)
+  spec = base_gem_spec(pkg_name, pkg_version)
+  yield spec if block_given?
+    
+  Rake::GemPackageTask.new(spec) do |p|
+    p.gem_spec = spec
+    # win32 chokes on this
+    p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+  end
+end
+
+def setup_win32_gem(pkg_name, pkg_version)
+  spec = base_gem_spec(pkg_name, pkg_version)
+  yield spec if block_given?
+
+  Gem::Builder.new(spec).build
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: gzip_filter
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+date: 2006-10-25 00:00:00 +08:00
+summary: The GzipFilter GemPlugin
+require_paths: 
+- lib
+email: 
+homepage: 
+rubyforge_project: 
+description: Compresses your Mongrel's HTTP responses using gzip.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Eden Li (eden.li@gmail.com)
+files: 
+- COPYING
+- LICENSE
+- README
+- Rakefile
+- test/test_gzip_filter.rb
+- lib/gzip_filter
+- lib/gzip_filter/init.rb
+- tools/rakehelp.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.13.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gem_plugin
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.2"
+    version: