rack-zippy 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*
+*.iml
+.ruby-version
+vendor

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 / 2013-08-21
+
+Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-zippy.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rack-test'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Eliot Sykes
+
+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,39 @@
+# rack-zippy
+
+rack-zippy is a Rack middleware for serving static gzipped assets precompiled by the Rails asset pipeline into the public/assets directory. Use it
+on Heroku if you want to serve the precompiled gzipped assets to gzip-capable clients with sensible caching headers.
+
+By default, Rails + Heroku will not serve *.gz assets even though they are generated at deploy time.
+
+rack-zippy replaces the ActionDispatch::Static middleware used by Rails, which is not capable of serving the gzipped assets created by
+the `rake assets:precompile` task. rack-zippy will serve non-gzipped assets where they are not available or not supported by the
+requesting client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-zippy'
+
+And then execute:
+
+    $ bundle
+
+Add this line to config/application.rb:
+
+    config.middleware.swap(ActionDispatch::Static, Rack::Zippy::AssetServer)
+
+## Usage
+
+Follow the installation instructions above and rack-zippy will serve any static assets, including gzipped assets, from your
+application's public/ directory and will respond with sensible caching headers.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run tests (`rake test`)
+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,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/rack-zippy.rb

@@ -0,0 +1,108 @@
+require "rack-zippy/version"
+
+module Rack
+  module Zippy
+    class AssetServer
+
+      def initialize(app, asset_root='public')
+        @app = app
+        @asset_root = asset_root
+      end
+
+      def call(env)
+        path_info = env['PATH_INFO']
+        assert_legal_path path_info
+
+        if serve?(path_info)
+
+          file_path = "#{@asset_root}#{path_info}"
+
+          if ::File.exists?(file_path)
+            headers = {
+                'Content-Type'  => Rack::Mime.mime_type(::File.extname(path_info)),
+                'Last-Modified' => 'Mon, 10 Jan 2005 10:00:00 GMT',
+                'Cache-Control' => "public, max-age=#{max_age_in_secs(path_info)}"
+            }
+
+            gzipped_file_path = "#{file_path}.gz"
+            gzipped_file_present = ::File.exists?(gzipped_file_path)
+
+            if gzipped_file_present
+              headers['Vary'] = 'Accept-Encoding'
+
+              if client_accepts_gzip?(env)
+                file_path = gzipped_file_path
+                headers['Content-Encoding'] = 'gzip'
+              end
+            end
+
+            status = 200
+            headers['Content-Length'] = ::File.size(file_path).to_s
+            response_body = [::File.read(file_path)]
+          else
+            status = 404
+            headers = {}
+            response_body = ['Not Found']
+          end
+          return [status, headers, response_body]
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      SECONDS_IN = {
+          :day => 24*60*60,
+          :month => 31*(24*60*60),
+          :year => 365*(24*60*60)
+      }.freeze
+
+      STATIC_EXTENSION_REGEX = /\.(?:css|js|html|htm|txt|ico|png|jpg|jpeg|gif|pdf|svg|zip|gz|eps|psd|ai)\z/i
+
+      PRECOMPILED_ASSETS_SUBDIR_REGEX = /\A\/assets\//
+
+      ACCEPTS_GZIP_REGEX = /\bgzip\b/
+
+      ILLEGAL_PATH_REGEX = /(\.\.|\/\.)/
+
+      def serve?(path_info)
+        is_compilable_asset = (path_info =~ PRECOMPILED_ASSETS_SUBDIR_REGEX)
+        if is_compilable_asset
+          return should_assets_be_compiled_already?
+        end
+        return has_static_extension?(path_info)
+      end
+
+      def should_assets_be_compiled_already?
+        !::Rails.configuration.assets.compile
+      end
+
+      def max_age_in_secs(path_info)
+        case path_info
+          when PRECOMPILED_ASSETS_SUBDIR_REGEX
+            max_age = SECONDS_IN[:year]
+          when '/favicon.ico'
+            max_age = SECONDS_IN[:month]
+          else
+            max_age = SECONDS_IN[:day]
+        end
+
+        return max_age
+      end
+
+      def client_accepts_gzip?(rack_env)
+        rack_env['HTTP_ACCEPT_ENCODING'] =~ ACCEPTS_GZIP_REGEX
+      end
+
+      def has_static_extension?(path)
+        path =~ STATIC_EXTENSION_REGEX
+      end
+
+      def assert_legal_path(path_info)
+        raise SecurityError.new('Illegal path requested') if path_info =~ ILLEGAL_PATH_REGEX
+      end
+
+    end
+  end
+end

data/lib/rack-zippy/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Zippy
+    VERSION = '0.1.0'
+  end
+end

data/rack-zippy.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-zippy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-zippy"
+  gem.version       = Rack::Zippy::VERSION
+  gem.authors       = ["Eliot Sykes"]
+  gem.email         = ["e@jetbootlabs.com"]
+  gem.description   = %q{Rack middleware for serving static gzipped assets generated by the Rails asset pipeline}
+  gem.summary       = %q{Rack middleware for serving static gzipped assets generated by the Rails asset pipeline}
+  gem.homepage      = "https://github.com/eliotsykes/rack-zippy"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/asset_server_test.rb

@@ -0,0 +1,283 @@
+require_relative 'test_helper'
+
+class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def setup
+    ensure_correct_working_directory
+    ::Rails.configuration.assets.compile = false
+  end
+
+  def teardown
+    revert_to_original_working_directory
+  end
+
+  def app
+    response = 'Up above the streets and houses'
+    headers = {}
+    status = 200
+    rack_app = lambda { |env| [status, headers, response] }
+    Rack::Zippy::AssetServer.new(rack_app)
+  end
+
+  def test_does_not_serve_assets_subdir_request_when_assets_compile_enabled
+    ::Rails.configuration.assets.compile = true
+    get '/assets/application.css'
+    assert_response_ok
+    assert_equal 'Up above the streets and houses', last_response.body
+  end
+
+  def test_serve_returns_true_if_request_has_static_extension
+    assert app.send(:serve?, '/about.html')
+  end
+
+  def test_serve_returns_false_if_request_does_not_have_static_extension
+    assert !app.send(:serve?, '/about')
+  end
+
+  def test_serve_returns_true_for_assets_subdir_request_when_assets_compile_disabled
+    assert app.send(:serve?, '/assets/application.css')
+  end
+
+  def test_serve_returns_false_for_assets_subdir_request_when_assets_compile_enabled
+    ::Rails.configuration.assets.compile = true
+    assert !app.send(:serve?, '/assets/application.css')
+  end
+
+  def test_should_assets_be_compiled_already_returns_false_if_assets_compile_enabled
+    ::Rails.configuration.assets.compile = true
+    assert ::Rails.configuration.assets.compile
+    assert !app.send(:should_assets_be_compiled_already?)
+  end
+
+  def test_should_assets_be_compiled_already_returns_true_if_assets_compile_disabled
+    assert !::Rails.configuration.assets.compile
+    assert app.send(:should_assets_be_compiled_already?)
+  end
+
+  def test_responds_with_gzipped_css_to_gzip_capable_clients
+    params = {}
+    get '/assets/application.css', params, env_for_gzip_capable_client
+    assert_response_ok
+    assert_content_length 'public/assets/application.css.gz'
+    assert_content_type 'text/css'
+    assert_cache_max_age :year
+    assert_cache_friendly_last_modified
+    assert_equal 'gzip', last_response.headers['content-encoding']
+    assert_vary_accept_encoding_header
+  end
+
+  def test_responds_with_gzipped_js_to_gzip_capable_clients
+    params = {}
+    get '/assets/application.js', params, env_for_gzip_capable_client
+    assert_response_ok
+    assert_content_length 'public/assets/application.js.gz'
+    assert_content_type 'application/javascript'
+    assert_cache_max_age :year
+    assert_cache_friendly_last_modified
+    assert_equal 'gzip', last_response.headers['content-encoding']
+    assert_vary_accept_encoding_header
+  end
+
+  def test_responds_with_maximum_cache_headers_for_assets_subdir_requests
+    get '/assets/favicon.ico'
+    assert_response_ok
+    assert_cache_max_age :year
+    assert_cache_friendly_last_modified
+  end
+
+  def test_responds_with_month_long_cache_headers_for_root_favicon
+    get '/favicon.ico'
+    assert_response_ok
+    assert_cache_max_age :month
+    assert_cache_friendly_last_modified
+  end
+
+  def test_responds_with_day_long_cache_headers_for_robots_txt
+    get '/robots.txt'
+    assert_response_ok
+    assert_cache_max_age :day
+    assert_cache_friendly_last_modified
+  end
+
+  def test_responds_with_day_long_cache_headers_for_root_html_requests
+    get '/thanks.html'
+    assert_response_ok
+    assert_cache_max_age :day
+    assert_cache_friendly_last_modified
+  end
+
+  def test_max_cache_and_vary_accept_encoding_headers_present_for_css_requests_by_non_gzip_clients
+    get '/assets/application.css'
+    assert_response_ok
+    assert_content_length 'public/assets/application.css'
+    assert_content_type 'text/css'
+    assert_cache_max_age :year
+    assert_cache_friendly_last_modified
+    assert_nil last_response.headers['content-encoding']
+    assert_vary_accept_encoding_header
+  end
+
+  def test_max_cache_and_vary_accept_encoding_headers_present_for_js_requests_by_non_gzip_clients
+    get '/assets/application.js'
+    assert_response_ok
+    assert_content_type 'application/javascript'
+    assert_content_length 'public/assets/application.js'
+    assert_cache_max_age :year
+    assert_cache_friendly_last_modified
+    assert_nil last_response.headers['content-encoding']
+    assert_vary_accept_encoding_header
+  end
+
+  def test_vary_header_not_present_if_gzipped_asset_unavailable
+    get '/assets/rails.png'
+    assert_response_ok
+    assert_nil last_response.headers['vary']
+  end
+
+  def assert_raises_illegal_path_error(path)
+    e = assert_raises SecurityError do
+      get path
+    end
+    assert_equal 'Illegal path requested', e.message
+  end
+
+  def test_throws_exception_if_path_contains_hidden_dir
+    paths = ['.confidential/secret-plans.pdf', '/.you-aint-seen-me/index.html', '/nothing/.to/see/here.jpg']
+    paths.each do |path|
+      assert_raises_illegal_path_error path
+    end
+  end
+
+  def test_throws_exception_if_path_ends_with_hidden_file
+    hidden_files = ['.htaccess', '/.top-secret', '/assets/.shhh']
+    hidden_files.each do |path|
+      assert_raises_illegal_path_error path
+    end
+  end
+
+  def test_throws_exception_if_path_contains_consecutive_periods
+    assert_raises_illegal_path_error '/hello/../sensitive/file'
+  end
+
+  def test_serves_html
+    get '/thanks.html'
+    assert_response_ok
+    assert_content_type 'text/html'
+    assert_content_length 'public/thanks.html'
+  end
+
+  def test_serves_robots_txt
+    get '/robots.txt'
+    assert_response_ok
+    assert_content_type 'text/plain'
+    assert_content_length 'public/robots.txt'
+  end
+
+  def test_has_static_extension_handles_non_lowercase_chars
+    ['pNG', 'JPEG', 'HTML', 'HtM', 'GIF', 'Ico'].each do |extension|
+      assert app.send(:has_static_extension?, "/some-asset.#{extension}")
+    end
+  end
+
+  def test_has_static_extension_returns_false_for_asset_paths_without_period
+    ['/assets/somepng', '/indexhtml', '/assets/applicationcss'].each do |path|
+      assert !app.send(:has_static_extension?, path)
+    end
+  end
+
+  def test_passes_non_asset_requests_onto_app
+    get '/about'
+    assert_underlying_app_responded
+  end
+
+  def test_does_not_pass_not_found_asset_requests_onto_app
+    get '/index.html'
+    assert_not_found
+  end
+
+  def test_responds_with_favicon_in_assets_dir
+    get '/assets/favicon.ico'
+    assert_response_ok
+    assert_content_type 'image/vnd.microsoft.icon'
+    assert_content_length 'public/assets/favicon.ico'
+  end
+
+  def test_responds_with_favicon_at_root
+    get '/favicon.ico'
+    assert_response_ok
+    assert_content_type 'image/vnd.microsoft.icon'
+    assert_content_length 'public/favicon.ico'
+  end
+
+  def test_responds_404_not_found_for_non_existent_image
+    get '/assets/pot-of-gold.png'
+    assert_not_found
+  end
+
+  def test_responds_404_not_found_for_non_existent_css
+    get '/assets/unicorn.css'
+    assert_not_found
+  end
+
+  def test_responds_404_not_found_for_non_existent_js
+    get '/assets/dragon.js'
+    assert_not_found
+  end
+
+  private
+
+  DURATIONS_IN_SECS = {:year => 31536000, :month => 2678400, :day => 86400}.freeze
+
+  def env_for_gzip_capable_client
+    {'HTTP_ACCEPT_ENCODING' => 'deflate,gzip,sdch'}
+  end
+
+  def assert_vary_accept_encoding_header
+    assert_equal 'Accept-Encoding', last_response.headers['vary']
+  end
+
+  def assert_cache_max_age(duration)
+    assert_equal "public, max-age=#{DURATIONS_IN_SECS[duration]}", last_response.headers['cache-control']
+  end
+
+  # Browsers favour caching assets with older Last Modified dates IIRC
+  def assert_cache_friendly_last_modified
+    assert_equal 'Mon, 10 Jan 2005 10:00:00 GMT', last_response.headers['last-modified']
+  end
+
+  def assert_underlying_app_responded
+    assert_response_ok
+    assert_equal 'Up above the streets and houses', last_response.body
+  end
+
+  def assert_response_ok
+    assert_equal 200, last_response.status
+  end
+
+  def assert_content_type(expected_content_type)
+    assert_equal expected_content_type, last_response.headers['content-type']
+  end
+
+  def assert_content_length(path)
+    assert_equal ::File.size(path).to_s, last_response.headers['content-length']
+  end
+
+  def assert_not_found
+    assert_equal 404, last_response.status
+    assert_equal 'Not Found', last_response.body
+  end
+
+  def ensure_correct_working_directory
+    is_project_root_working_directory = File.exists?('rack-zippy.gemspec')
+    if is_project_root_working_directory
+      @original_dir = Dir.pwd
+      Dir.chdir 'test'
+    end
+  end
+
+  def revert_to_original_working_directory
+    Dir.chdir @original_dir if @original_dir
+  end
+
+end

data/test/public/assets/application.css

@@ -0,0 +1,3 @@
+body {
+  font-family: "Comic Sans";
+}

data/test/public/assets/application.js

@@ -0,0 +1 @@
+var zippyMessage = 'Hello World!';

data/test/public/robots.txt

@@ -0,0 +1 @@
+# This is robots.txt

data/test/public/thanks.html

@@ -0,0 +1,6 @@
+<html>
+<head><title>Hello and thanks</title></head>
+<body>
+<h1>Thanks!</h1>
+</body>
+</html>

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require :default, :development
+
+require 'test/unit'
+require 'rack/test'
+
+module Rails
+
+  @configuration = Struct.new(:assets).new
+  @configuration.assets = Struct.new(:compile).new
+
+  def self.configuration
+    @configuration
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rack-zippy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Eliot Sykes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies: []
+description: Rack middleware for serving static gzipped assets generated by the Rails
+  asset pipeline
+email:
+- e@jetbootlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-zippy.rb
+- lib/rack-zippy/version.rb
+- rack-zippy.gemspec
+- test/asset_server_test.rb
+- test/public/assets/application.css
+- test/public/assets/application.css.gz
+- test/public/assets/application.js
+- test/public/assets/application.js.gz
+- test/public/assets/favicon.ico
+- test/public/assets/rails.png
+- test/public/favicon.ico
+- test/public/robots.txt
+- test/public/thanks.html
+- test/test_helper.rb
+homepage: https://github.com/eliotsykes/rack-zippy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rack middleware for serving static gzipped assets generated by the Rails
+  asset pipeline
+test_files:
+- test/asset_server_test.rb
+- test/public/assets/application.css
+- test/public/assets/application.css.gz
+- test/public/assets/application.js
+- test/public/assets/application.js.gz
+- test/public/assets/favicon.ico
+- test/public/assets/rails.png
+- test/public/favicon.ico
+- test/public/robots.txt
+- test/public/thanks.html
+- test/test_helper.rb