rack-gzip-file 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4daaaab6c65f1ffdf55d1da33916e1050469a6c9
+  data.tar.gz: 813746448715814f30db50db8104120882778833
+SHA512:
+  metadata.gz: b63d8090b6e9c22ddd67113a1e6339b3335204b20037965ac17d895215ee2cdfa80e851adebe96b656c25d9f8f98515ec02ed8dfe4f45650c1e6a6d9cdc76193
+  data.tar.gz: 41f80cc1fedbc3360f7d07bcdf28c8d22beb5dfdc66a3c98cab62220484cbedab2f83eff72d4943c9a61d748f541961656dc04fc12fc4ed934b28f884019e9e1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) 2014 Yuji Miyane
+
+MIT License
+
+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.ja.md

@@ -0,0 +1,37 @@
+# Rack::GzipFile, Rack::GzipStatic
+
+[English](README.md) | 日本語
+
+Rack::GzipFileは[Rack::File](http://rack.rubyforge.org/doc/Rack/File.html)と同機能で、次に示す2つの拡張機能を持ちます。
+
+* gzipで事前圧縮されたファイルに対する最適化機能をサポートします(Nginxのgzip\_staticモジュールと同機能)。クライアントがgzip圧縮に対応している場合は`.gz`ファイルを先に検索してそれをそのままgzip圧縮されたbodyとして返します。
+* さらに`.gz`ファイルがあり、クライアントがgzipに対応していない場合はファイルを解凍してbodyとして返します。これで元の非圧縮ファイルを残しておく必要がなくなり、サーバリソースを削減できます。
+
+Rack::GzipStaticも[Rack::Static](http://rack.rubyforge.org/doc/Rack/Static.html)と同じで、上記2点の機能拡張を加えたものです。
+
+# インストール
+
+```
+gem install rack-gzip-file
+```
+
+# 使用法
+
+Rack::File及びRack::Staticの上位互換で、機能は全く同じです。
+
+```
+require 'rack/gzip_file'
+run Rack::GzipFile.new('public')
+```
+
+```
+require 'rack/gzip_static
+use Rack::Static, :urls => {"/" => 'index.html'}, :root => 'public'
+run lambda {|env|}
+```
+
+## ライセンス
+
+MIT (See [LICENCE.txt](LICENCE.txt))
+
+

data/README.md

@@ -0,0 +1,36 @@
+# Rack::GzipFile, Rack::GzipStatic
+
+English | [日本語](README.ja.md)
+
+Rack::GzipFile is the identical as [Rack::File](http://rack.rubyforge.org/doc/Rack/File.html) with the following two extensions.
+
+* Supports gzip pre-compressed file optimization (same function as Nginx gzip\_static module).  If a client support gzip-encoding, it searchs `.gz` file from the same directory first and returns a gzipped body.
+* Furthermore, if `.gz` file exists and a client does not support gzip, it inflates `.gz` file and returns as a body (you do not have to keep an non-gzipped original file). 
+
+Rack::GzipStatic is also identical to [Rack::Static](http://rack.rubyforge.org/doc/Rack/Static.html) with the extensions shown above.
+
+## Install
+
+```
+gem install rack-gzip-file
+```
+
+## Usage
+
+Upper-compatible to Rack::File and Rack::Static.
+
+```
+require 'rack/gzip_file'
+run Rack::GzipFile.new('public')
+```
+
+```
+require 'rack/gzip_static
+use Rack::Static, :urls => {"/" => 'index.html'}, :root => 'public'
+run lambda {|env|}
+```
+
+## Licence
+
+MIT (See [LICENCE.txt](LICENCE.txt))
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format doc --color'
+end
+
+task default: :spec

data/lib/rack/gzip_file.rb

@@ -0,0 +1,48 @@
+require 'zlib'
+require 'rack/file'
+
+module Rack
+  # Rack::File with gzip pre-compressed files support and
+  # extraction for a client whitch does not support gzip.
+  class GzipFile
+    PATH_INFO = 'PATH_INFO'
+    DOT_GZ = '.gz'
+    TEXT_PLAIN = 'text/plain'
+    CONTENT_TYPE = 'Content-Type'
+    HTTP_ACCEPT_ENCODING = 'HTTP_ACCEPT_ENCODING'
+    GZIP = 'gzip'
+    CONTENT_ENCODING = 'Content-Encoding'
+    CONTENT_LENGTH = 'Content-Length'
+
+    def initialize(*args)
+      @file_server = Rack::File.new(*args)
+      @default_mime = args[2] || TEXT_PLAIN
+    end
+
+    def call(env)
+      path = env[PATH_INFO]
+      env[PATH_INFO] = path + DOT_GZ
+      status, headers, body = result = @file_server.call(env)
+      case status
+      when 200  # OK
+        mime = Rack::Mime.mime_type(::File.extname(path), @default_mime)
+        headers[CONTENT_TYPE] = mime if mime
+        enc = env[HTTP_ACCEPT_ENCODING]
+        if enc && enc.include?(GZIP)
+          headers[CONTENT_ENCODING] = GZIP
+        else
+          # inflate body for a client which does not support gzip
+          body = [Zlib::GzipReader.open(body.to_path) {|f| f.read }]
+          headers[CONTENT_LENGTH] = body[0].bytesize.to_s
+          headers.delete CONTENT_ENCODING
+        end
+        [status, headers, body]
+      when 304  # not modified
+        result
+      else      # retry with the original path
+        env[PATH_INFO] = path
+        @file_server.call(env)
+      end
+    end
+  end
+end

data/lib/rack/gzip_static.rb

@@ -0,0 +1,12 @@
+require 'rack/static'
+require 'rack/gzip_file'
+
+module Rack
+  # Rack::Static with gzip pre-compressed files support.
+  class GzipStatic < Static
+    def initialize(app, options = {})
+      super
+      @file_server = Rack::GzipFile.new(options[:root] || Dir.pwd, @headers)
+    end
+  end
+end

data/spec/gzip_file_spec.rb

@@ -0,0 +1,66 @@
+require 'rack/gzip_file'
+require 'rack/mock'
+
+describe Rack::GzipFile do
+  before do
+    @root = 'spec/site'
+    @server = Rack::MockRequest.new(
+      Rack::GzipFile.new @root
+    )
+    @plain_content = "plain text\n"
+    @gzip_inflated_content = "gzipped text\n"
+  end
+
+  describe '#call' do
+    describe 'when gzip-precompressed file does not exist' do
+      it 'should serve non-gzipped file if exist' do
+        res = @server.get '/plain.txt'
+        res.status.should be 200
+        res.headers['Content-Encoding'].should be_nil
+        res.body.should eql @plain_content
+      end
+
+      it 'should respond 304 if If-Modified-Since matches' do
+        date = File.mtime("#{@root}/plain.txt").httpdate
+        res = @server.get '/plain.txt', 'HTTP_IF_MODIFIED_SINCE' => date
+        res.status.should be 304
+        res.headers.empty?.should be_true
+        res.body.empty?.should be_true
+      end
+
+      it 'should respond 404 if not exist' do
+        @server.get('/not-exist.txt').status.should be 404
+      end
+    end
+
+    describe 'when gzip-precompressed file exists' do
+      it 'should respond 304 if If-Modified-Since matches' do
+        date = File.mtime("#{@root}/gzipped.txt.gz").httpdate
+        res = @server.get '/gzipped.txt', 'HTTP_IF_MODIFIED_SINCE' => date
+        res.status.should be 304
+        res.headers.empty?.should be_true
+        res.body.empty?.should be_true
+      end
+
+      describe 'when request supports gzip encoding' do
+        it 'should serve gzipped body' do
+          res = @server.get '/gzipped.txt', 'HTTP_ACCEPT_ENCODING' => 'gzip'
+          res.status.should be 200
+          res.headers['Content-Encoding'].should eql 'gzip'
+          Zlib::GzipReader.new StringIO.new(res.body) do |f|
+            f.read.should eql @gzip_inflated_content
+          end
+        end
+      end
+
+      describe 'when request does not support gzip encoding' do
+        it 'should inflate gzipped file and serve it as body' do
+          res = @server.get '/gzipped.txt'
+          res.status.should be 200
+          res.headers['Content-Encoding'].should be_nil
+          res.body.should eql @gzip_inflated_content
+        end
+      end
+    end
+  end
+end

data/spec/gzip_static_spec.rb

@@ -0,0 +1,66 @@
+require 'rack/gzip_static'
+require 'rack/mock'
+
+describe Rack::GzipStatic do
+  before do
+    @root = 'spec/site'
+    @server = Rack::MockRequest.new(
+      Rack::GzipStatic.new lambda {|env|}, urls: [''], root: @root
+    )
+    @plain_content = "plain text\n"
+    @gzip_inflated_content = "gzipped text\n"
+  end
+
+  describe '#call' do
+    describe 'when gzip-precompressed file does not exist' do
+      it 'should serve non-gzipped file if exist' do
+        res = @server.get '/plain.txt'
+        res.status.should be 200
+        res.headers['Content-Encoding'].should be_nil
+        res.body.should eql @plain_content
+      end
+
+      it 'should respond 304 if If-Modified-Since matches' do
+        date = File.mtime("#{@root}/plain.txt").httpdate
+        res = @server.get '/plain.txt', 'HTTP_IF_MODIFIED_SINCE' => date
+        res.status.should be 304
+        res.headers.empty?.should be_true
+        res.body.empty?.should be_true
+      end
+
+      it 'should respond 404 if not exist' do
+        @server.get('/not-exist.txt').status.should be 404
+      end
+    end
+
+    describe 'when gzip-precompressed file exists' do
+      it 'should respond 304 if If-Modified-Since matches' do
+        date = File.mtime("#{@root}/gzipped.txt.gz").httpdate
+        res = @server.get '/gzipped.txt', 'HTTP_IF_MODIFIED_SINCE' => date
+        res.status.should be 304
+        res.headers.empty?.should be_true
+        res.body.empty?.should be_true
+      end
+
+      describe 'when request supports gzip encoding' do
+        it 'should serve gzipped body' do
+          res = @server.get '/gzipped.txt', 'HTTP_ACCEPT_ENCODING' => 'gzip'
+          res.status.should be 200
+          res.headers['Content-Encoding'].should eql 'gzip'
+          Zlib::GzipReader.new StringIO.new(res.body) do |f|
+            f.read.should eql @gzip_inflated_content
+          end
+        end
+      end
+
+      describe 'when request does not support gzip encoding' do
+        it 'should inflate gzipped file and serve it as body' do
+          res = @server.get '/gzipped.txt'
+          res.status.should be 200
+          res.headers['Content-Encoding'].should be_nil
+          res.body.should eql @gzip_inflated_content
+        end
+      end
+    end
+  end
+end

data/spec/site/plain.txt

@@ -0,0 +1 @@
+plain text

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rack-gzip-file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuji Miyane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Extends Rack::File and Rack::Static with gzip pre-compression optimization support. Also supports gzipped file extraction for clients which do not support gzip encoding.'
+email: myuj1964@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/gzip_file.rb
+- lib/rack/gzip_static.rb
+- spec/site/plain.txt
+- spec/site/gzipped.txt.gz
+- spec/gzip_file_spec.rb
+- spec/gzip_static_spec.rb
+- README.md
+- README.ja.md
+- Rakefile
+- LICENSE.txt
+homepage: https://github.com/higuma/rack-gzip-file
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rack::GzipFile, Rack::GzipStatic
+test_files:
+- spec/site/plain.txt
+- spec/site/gzipped.txt.gz
+- spec/gzip_file_spec.rb
+- spec/gzip_static_spec.rb