rack_gzfile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d17f0629b61d4802b40da6dd088ab82277c09412
+  data.tar.gz: 3f0fb225709a01983227b70f014985505e324a13
+SHA512:
+  metadata.gz: 1c2af2da13f9473883c6868aeac25763229da118e9f7d0eac8c7284cf6396a6a9d6512e8fb6261d8dd02a00f5a72ae60b6e585baf911edb8a37b50ea4d53daf5
+  data.tar.gz: 7c7bf53188977357a6a3bd7daaaf123886328d0653b2d3555a8072ec54dcdcf286484ed0200945d9b9ec6ecab93d7540f816c2fb516d515a1b66e0f6563b57a0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack_gzfile.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Alexander
+
+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.md

@@ -0,0 +1,41 @@
+# RackGzfile
+
+By default, `rake assets:precompile` generates gzipped versions of certain types of files. Servers (like Nginx with the GzipStatic module) can then serve these gzipped assets so they can get the reduced bandwidth of gzip without needing to compress the file on every request. [This pull request](https://github.com/rack/rack/pull/479) will hopefully bring this functionality to Rack. In the meantime, this gem can be used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack_gzfile'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+`Rack::GzFile` can be used as a drop-in replacement for [`Rack::File`](https://github.com/rack/rack/blob/master/lib/rack/file.rb).
+
+### Usage with `Rack::Static`
+
+Unfortunately, `Rack::Static` is hardcoded to use `Rack::File`. [Hopefully this will be changed](https://github.com/rack/rack/pull/479#issuecomment-21907789), but in the meantime you can do an ugly monkey patch like this:
+
+```ruby
+Rack::Static.class_eval do
+  def initialize_with_gzip_file_server(app, options={})
+    initialize_without_gzip_file_server(app, options)
+
+    root = options[:root] || Dir.pwd
+    @file_server = Rack::GzFile.new(root, @headers)
+  end
+  alias_method_chain :initialize, :gzip_file_server
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack/gz_file/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class GzFile
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/gz_file.rb

@@ -0,0 +1,45 @@
+module Rack
+  # Rack::GzFile behaves exactly the same as Rack::File, except that it will
+  # also serve up a gzip encoding of a file, if one is available on the
+  # filesystem.
+  #
+  # For each request, Rack::GzFile first checks the filesystem for a file with a
+  # .gz extension. If one is found, the appropriate encoding headers are added
+  # to the response and the gzip file is served.
+  #
+  # If no .gz file is found, Rack::GzFile will behave exactly like Rack::File.
+  class GzFile
+    def initialize(root, headers={}, default_mime = 'text/plain')
+      @file_server = if Rack::File.instance_method(:initialize).arity.abs == 2
+        Rack::File.new(root, headers) # for Rack < 1.5.0
+      else
+        Rack::File.new(root, headers, default_mime)
+      end
+      @default_mime = default_mime
+    end
+
+    def call(env)
+      path_info = env['PATH_INFO']
+      status = nil
+
+      if env['HTTP_ACCEPT_ENCODING'] =~ /\bgzip\b/
+        status, headers, body = @file_server.call(
+          env.merge('PATH_INFO' => path_info + '.gz')
+        )
+      end
+
+      case status
+      when 200
+        headers['Content-Type']     = Mime.mime_type(::File.extname(path_info), @default_mime)
+        headers['Content-Encoding'] = 'gzip'
+      when 304
+      else
+        status, headers, body = @file_server.call(env)
+      end
+
+      headers['Vary'] = 'Accept-Encoding'
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/rack_gzfile.rb

@@ -0,0 +1,2 @@
+require "rack/gz_file"
+require "rack/gz_file/version"

data/rack_gzfile.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/gz_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack_gzfile"
+  spec.version       = Rack::GzFile::VERSION
+  spec.authors       = ["Brian Alexander"]
+  spec.email         = ["balexand@gmail.com"]
+  spec.description   = %q{Rack::File meets gzip_static}
+  spec.summary       = %q{Rack::File meets gzip_static}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures/foo.html

@@ -0,0 +1 @@
+I can't has gzip!

data/spec/fixtures/i_can_has_gzip.html

@@ -0,0 +1 @@
+I can has gzip!

data/spec/lib/rack/gz_file_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Rack::GzFile do
+
+  let(:root) { File.expand_path("../../../fixtures", __FILE__) }
+  let(:request) { Rack::MockRequest.new(Rack::Lint.new(Rack::GzFile.new(root))) }
+
+  describe "#call" do
+
+    context "non-gzipped file requested" do
+
+      it "renders non-gzipped file" do
+        res = request.get('/i_can_has_gzip.html')
+        expect(res.status).to eq 200
+        expect(res.body).to eq "I can has gzip!\n"
+        expect(res.headers.key?('Content-Encoding')).to eq false
+        expect(res.headers['Vary']).to eq 'Accept-Encoding'
+        expect(res.headers['Content-Length']).to eq "I can has gzip!\n".size.to_s
+      end
+
+    end
+
+    context "gzipped file requested" do
+
+      it "renders gzipped file if it exists" do
+        res = request.get('/i_can_has_gzip.html', 'HTTP_ACCEPT_ENCODING' => 'gzip')
+        expect(res.status).to eq 200
+        expect(Zlib::GzipReader.new(StringIO.new(res.body)).read).to eq "I can has gzip!\n"
+        expect(res.headers['Content-Encoding']).to eq 'gzip'
+        expect(res.headers['Vary']).to eq 'Accept-Encoding'
+        expect(res.headers['Content-Length']).to eq File.size(File.join(root, "i_can_has_gzip.html.gz")).to_s
+      end
+
+      it "renders non-gzipped file if gzipped file not present" do
+        res = request.get('/foo.html', 'HTTP_ACCEPT_ENCODING' => 'gzip')
+        expect(res.status).to eq 200
+        expect(res.body).to eq "I can't has gzip!\n"
+        expect(res.headers.key?('Content-Encoding')).to eq false
+        expect(res.headers['Vary']).to eq 'Accept-Encoding'
+        expect(res.headers['Content-Length']).to eq "I can't has gzip!\n".size.to_s
+      end
+
+      it "renders passes 304 response for gzipped file without updating headers" do
+        date = Time.new(2012,12,25)
+        File.utime date, date, File.join(root, "i_can_has_gzip.html.gz")
+        res = request.get('/i_can_has_gzip.html', 'HTTP_ACCEPT_ENCODING' => 'gzip', 'HTTP_IF_MODIFIED_SINCE' => date.httpdate)
+
+        expect(res.status).to eq 304
+        expect(res.body).to eq ""
+        expect(res.headers.key?('Content-Encoding')).to eq false
+        expect(res.headers['Vary']).to eq 'Accept-Encoding'
+        expect(res.headers.key?('Content-Length')).to eq false
+      end
+
+      it "renders normal file if arbitrary status is returned for gzipped file" do
+        Rack::File.any_instance.stub(:call) do |env|
+          case env['PATH_INFO']
+          when "/i_can_has_gzip.html.gz"
+            [500, {}, ["Something went wrong"]]
+          else
+            [200, {"Content-Type" => "text/plain"}, ["Got the non-gzipped version"]]
+          end
+        end
+
+        res = request.get('/i_can_has_gzip.html', 'HTTP_ACCEPT_ENCODING' => 'gzip')
+        expect(res.status).to eq 200
+        expect(res.body).to eq "Got the non-gzipped version"
+        expect(res.headers.key?('Content-Encoding')).to eq false
+        expect(res.headers['Vary']).to eq 'Accept-Encoding'
+        expect(res.headers['Content-Length']).to eq "Got the non-gzipped version".size.to_s
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rack_gzfile'
+require 'rack/lint'
+require 'rack/mock'
+require 'zlib'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rack_gzfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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: Rack::File meets gzip_static
+email:
+- balexand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/gz_file.rb
+- lib/rack/gz_file/version.rb
+- lib/rack_gzfile.rb
+- rack_gzfile.gemspec
+- spec/fixtures/foo.html
+- spec/fixtures/i_can_has_gzip.html
+- spec/fixtures/i_can_has_gzip.html.gz
+- spec/lib/rack/gz_file_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Rack::File meets gzip_static
+test_files:
+- spec/fixtures/foo.html
+- spec/fixtures/i_can_has_gzip.html
+- spec/fixtures/i_can_has_gzip.html.gz
+- spec/lib/rack/gz_file_spec.rb
+- spec/spec_helper.rb