butler_static 0.0.3

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)test\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thomas Klemm
+
+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,29 @@
+# Butler
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'butler_static'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install butler_static
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,12 @@
+# Gem
+require 'bundler/gem_tasks'
+
+# Tests
+require 'guard'
+task :test do
+  Guard.setup
+  Guard.guards('minitest').run_all
+end
+
+# Alias default task to test
+task default: :test

data/butler.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'butler/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "butler_static"
+  gem.version       = Butler::VERSION
+  gem.authors       = ["Thomas Klemm"]
+  gem.email         = ["github@tklemm.eu"]
+  gem.description   = "Butler is a Rack Middleware that serves static assets for your Rails app."
+  gem.summary       = "Butler is a Rack Middleware that serves static assets for your Rails app. It allows you to set HTTP headers for individual files or folders based on rules."
+  gem.homepage      = "https://github.com/thomasklemm/butler"
+
+  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"]
+
+  # Dependencies
+  gem.add_dependency 'rack'
+
+  # Tests
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'guard-minitest'
+  gem.add_development_dependency 'turn'
+  # Only ActiveSupport and ActionController nescessary
+  # gem.add_development_dependency 'rails', '~> 3.2.8'
+  gem.add_development_dependency 'activesupport', '~> 3.2.8'
+  gem.add_development_dependency 'actionpack', '~> 3.2.8'
+end

data/lib/butler/asset.rb

@@ -0,0 +1,147 @@
+require 'time'
+require 'rack/utils'
+require 'rack/mime'
+
+module Butler
+  #
+  # Butler::Asset
+  #
+  # Sends a single requested file out to the user
+  # The code has been largely taken from Rack::File
+  # but adjusted to support sending custuom HTTP headers
+  #
+  # Usage:
+  #   Butler::Asset.new(root_directory, headers: {
+  #     'Cache-Control' => 'public, max-age=31536000',
+  #     'Some custom header' => 'Content for some custom header'
+  #   })
+  #
+  class Asset
+    SEPS = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact)
+    ALLOWED_VERBS = %w[GET HEAD]
+
+    attr_accessor :root, :path
+    alias :to_path :path
+
+    def initialize(root, options={})
+      @root = root
+      @headers = options[:headers] || {}
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    F = File
+
+    def _call(env)
+      unless ALLOWED_VERBS.include? env["REQUEST_METHOD"]
+        return fail(405, "Method Not Allowed")
+      end
+
+      path_info = Rack::Utils.unescape(env["PATH_INFO"])
+      parts = path_info.split SEPS
+
+      parts.inject(0) do |depth, part|
+        case part
+        when '', '.'
+          depth
+        when '..'
+          return fail(404, "Not Found") if depth - 1 < 0
+          depth - 1
+        else
+          depth + 1
+        end
+      end
+
+      @path = F.join(@root, *parts)
+
+      available = begin
+        F.file?(@path) && F.readable?(@path)
+      rescue SystemCallError
+        false
+      end
+
+      if available
+        serving(env)
+      else
+        fail(404, "File not found: #{path_info}")
+      end
+    end
+
+    def serving(env)
+      last_modified = F.mtime(@path).httpdate
+      return [304, {}, []] if env['HTTP_IF_MODIFIED_SINCE'] == last_modified
+      response = [
+        200,
+        {
+          "Last-Modified"  => last_modified,
+          "Content-Type"   => Rack::Mime.mime_type(F.extname(@path), 'text/plain')
+        },
+        env["REQUEST_METHOD"] == "HEAD" ? [] : self
+      ]
+
+      # Set headers
+      @headers.each { |field, content| response[1][field] = content } if @headers
+
+      # NOTE:
+      #   We check via File::size? whether this file provides size info
+      #   via stat (e.g. /proc files often don't), otherwise we have to
+      #   figure it out by reading the whole file into memory.
+      size = F.size?(@path) || Utils.bytesize(F.read(@path))
+
+      ranges = Rack::Utils.byte_ranges(env, size)
+      if ranges.nil? || ranges.length > 1
+        # No ranges, or multiple ranges (which we don't support):
+        # TODO: Support multiple byte-ranges
+        response[0] = 200
+        @range = 0..size-1
+      elsif ranges.empty?
+        # Unsatisfiable. Return error, and file size:
+        response = fail(416, "Byte range unsatisfiable")
+        response[1]["Content-Range"] = "bytes */#{size}"
+        return response
+      else
+        # Partial content:
+        @range = ranges[0]
+        response[0] = 206
+        response[1]["Content-Range"] =
+          "bytes #{@range.begin}-#{@range.end}/#{size}"
+        size = @range.end - @range.begin + 1
+      end
+
+      response[1]["Content-Length"] = size.to_s
+      response
+    end
+
+    def each
+      F.open(@path, "rb") do |file|
+        file.seek(@range.begin)
+        remaining_len = @range.end-@range.begin+1
+        while remaining_len > 0
+          part = file.read([8192, remaining_len].min)
+          break unless part
+          remaining_len -= part.length
+
+          yield part
+        end
+      end
+    end
+
+    private
+
+    def fail(status, body)
+      body += "\n"
+      [
+        status,
+        {
+          "Content-Type" => "text/plain",
+          "Content-Length" => body.size.to_s,
+          "X-Cascade" => "pass"
+        },
+        [body]
+      ]
+    end
+
+  end
+end

data/lib/butler/handler.rb

@@ -0,0 +1,92 @@
+require 'rack/utils'
+require 'active_support/core_ext/uri'
+require 'butler/asset'
+
+module Butler
+  #
+  # Butler::Handler
+  #
+  # The link between Butler::Static and Butler::Asset
+  # Transforms HTTP header rules into actual HTTP headers
+  # for a single file to be set by Butler::Asset
+  #
+  # Code adapted from Rails' ActionDispatch::FileHandler
+  #
+  class Handler
+    def initialize(root, options={})
+      @root          = root.chomp('/')
+      @compiled_root = /^#{Regexp.escape(root)}/
+      @headers       = {}
+      @header_rules  = options[:header_rules] || {}
+      @file_server   = Butler::Asset.new(@root, headers: @headers)
+    end
+
+    def match?(path)
+      path = path.dup
+
+      full_path = path.empty? ? @root : File.join(@root,
+        escape_glob_chars(unescape_path(path)))
+      paths = "#{full_path}#{ext}"
+
+      matches = Dir[paths]
+      match = matches.detect { |m| File.file?(m) }
+      if match
+        match.sub!(@compiled_root, '')
+        ::Rack::Utils.escape(match)
+      end
+    end
+
+    def call(env)
+      @path = env['PATH_INFO']
+      set_headers
+      @file_server.call(env)
+    end
+
+    def ext
+      @ext ||= begin
+        ext = ::ActionController::Base.page_cache_extension
+        "{,#{ext},/index#{ext}}"
+      end
+    end
+
+    def unescape_path(path)
+      URI.parser.unescape(path)
+    end
+
+    def escape_glob_chars(path)
+      path.force_encoding('binary') if path.respond_to? :force_encoding
+      path.gsub(/[*?{}\[\]]/, "\\\\\\&")
+    end
+
+    # Convert header rules to headers
+    def set_headers
+      @header_rules.each do |rule, result|
+        case rule
+        when :global
+          set_header(result)
+        when :fonts
+          set_header(result) if @path.match(%r{\.(?:ttf|otf|eot|woff|svg)\z})
+        when Regexp
+          set_header(result) if @path.match(rule)
+        when Array
+          # Extensions
+          extensions = rule.join('|')
+          set_header(result) if @path.match(%r{\.(#{extensions})\z})
+        when String
+          # Folder
+          path = ::Rack::Utils.unescape(@path)
+          set_header(result) if
+            (path.start_with?(rule) || path.start_with?('/' + rule))
+        else
+        end
+      end
+    end
+
+    def set_header(result)
+      result.each do |field, content|
+        @headers[field] = content
+      end
+    end
+
+  end
+end

data/lib/butler/railtie.rb

@@ -0,0 +1,6 @@
+require 'butler'
+
+module Butler
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/butler/static.rb

@@ -0,0 +1,97 @@
+require 'rack/utils'
+require 'butler/handler'
+
+module Butler
+  #
+  # Butler::Static
+  #
+  # is a Static Web Server based on ActionDispatch::Static.
+  # It is intended to be used with Rails in an environment
+  # where serving static assets through a specialized web
+  # server such as nginx is technically not an option.
+  #
+  # Butler::Static extends ActionDispatch::Static's func-
+  # tionality to allow a the developer to set custom rules
+  # for the HTTP headers that the files sent should carry.
+  #
+  # The author's intent was to allow Rails to serve static
+  # assets with custom HTTP Headers.
+  # This allows for example serving webfonts or icon fonts
+  # carrying the appropriate HTTP headers via a Content
+  # Delivery Network (CDN) such as Amazon's Cloudfront.
+  # Files requested by the CDN will need to carry the headers
+  # the file should be sent with to the visitor's browser
+  # already when being sent from the web server.
+  #
+  # ActionDispatch::Static, Rack::Static et al. don't allow
+  # (yet) to add custom HTTP headers to files because the
+  # underlying Rack::File implementation only allows for
+  # setting a static 'Cache-Control' header.
+  #
+  # Code adapted from Rails' ActionDispatch::Static.
+  #
+  # If no matching file can be found in the precompiled assets
+  # the request will bubble up to the Rails stack to decide
+  # how to handle it
+  #
+  # Usage:
+  #  config.middleware.delete ActionDispatch::Static
+  #  config.middleware.insert_before Rack::Cache, Butler::Static
+  #
+  #  # Provide the header rules like so
+  #  config.assets.header_rules = {
+  #    rule         => { header_field => content },
+  #    another_rule => { header_field => content }
+  #  }
+  #
+  #  # These rules are shipped along
+  #  # 1) Global
+  #  :global => Matches every file
+  #
+  #  # 2) Folders
+  #  '/folder' => Matches all files in a certain folder
+  #  '/folder/subfolder' => ...
+  #    Note: Provide the folder as a string,
+  #          with or without the starting slash
+  #
+  #  # 3) File Extensions
+  #  ['css', 'js'] => Will match all files ending in .css or .js
+  #  %w(css js) => ...
+  #    Note: Provide the file extensions in an array,
+  #          use any ruby syntax you like to set that array up
+  #
+  #  # 4) Regular Expressions / Regexp
+  #  %r{\.(?:css|js)\z} => will match all files ending in .css or .js
+  #  /\.(?:eot|ttf|otf|woff|svg)\z/ => will match all files ending
+  #     in the most common web font formats
+  #
+  #  # 5) Shortcuts
+  #  There is currently only one shortcut defined.
+  #  :fonts => will match all files ending in eot, ttf, otf, woff, svg
+  #     using the Regexp stated above
+  #
+  #  Note: The rules will be applied in the order the are listed,
+  #        thus more special rules further down below can override
+  #        general global HTTP header settings
+  #
+  class Static
+    def initialize(app, path, options={})
+      @app = app
+      @header_rules = options[:header_rules] || {}
+      @file_handler = Butler::Handler.new(path, header_rules: @header_rules)
+    end
+
+    def call(env)
+      case env['REQUEST_METHOD']
+      when 'GET', 'HEAD'
+        path = env['PATH_INFO'].chomp('/')
+        if match = @file_handler.match?(path)
+          env['PATH_INFO'] = match
+          return @file_handler.call(env)
+        end
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/butler/version.rb

@@ -0,0 +1,3 @@
+module Butler
+  VERSION = "0.0.3"
+end

data/lib/butler.rb

@@ -0,0 +1,9 @@
+require 'butler/version'
+require 'butler/static'
+require 'butler/handler'
+require 'butler/asset'
+require 'butler/railtie'
+
+module Butler
+  # Butler
+end

data/spec/butler/asset_spec.rb

@@ -0,0 +1,226 @@
+require 'minitest_helper'
+require 'butler/asset'
+require 'rack/mock'
+
+describe Butler::Asset do
+  DOCROOT = File.expand_path(File.dirname(__FILE__))
+
+  def file(*args)
+    Butler::Asset.new(*args)
+  end
+
+  before do
+    @file = Rack::MockRequest.new(file(DOCROOT))
+  end
+
+  describe 'when serving files' do
+    #
+    # Serve Files
+    #
+    it 'should serve available files' do
+      res = @file.get('files/index.html')
+
+      res.status.must_equal 200
+      res.body.must_equal '<html>Index</html>'
+    end
+
+    it 'should return status 404 if file cannot be found' do
+      res = @file.get('files/unknown.html')
+
+      res.status.must_equal 404
+    end
+
+    #
+    # Request Methods
+    #
+    it 'should only support GET and HEAD requests' do
+      file = 'files/index.html'
+
+      allowed = %w(get head)
+      allowed.each do |method|
+        res = @file.send(method, file)
+        res.status.must_equal 200
+      end
+
+      forbidden = %w(post put delete) # patch is breaking
+      forbidden.each do |method|
+        res = @file.send(method, file)
+        res.status.must_equal 405
+      end
+    end
+
+    #
+    #  Headers
+    #
+    it 'should set header Last-Modified' do
+      file = 'files/index.html'
+      path = File.join(DOCROOT, file)
+      res = @file.get(file)
+
+      res.status.must_equal 200
+      res['Last-Modified'].must_equal File.mtime(path).httpdate
+    end
+    it "should set Content-Length correctly for HEAD requests" do
+      res = @file.head('files/index.html')
+
+      res.status.must_equal 200
+      res['Content-Length'].must_equal '18'
+    end
+
+    it 'should set provided headers' do
+      file = Butler::Asset.new(DOCROOT,
+        headers: {'Cache-Control' => 'public, max-age=42'})
+      req = Rack::MockRequest.new(file)
+
+      res = req.get('files/index.html')
+
+      res.status.must_equal 200
+      res['Cache-Control'].must_equal 'public, max-age=42'
+    end
+
+    #
+    # Modified / unmodified Files (304 / 200)
+    #
+    it 'should return status 304 if file is not modified since last serve' do
+      file = 'files/index.html'
+      path = File.join(DOCROOT, file)
+      time = File.mtime(path).httpdate
+      res = @file.get(file, 'HTTP_IF_MODIFIED_SINCE' => time)
+
+      res.status.must_equal 304
+      res.body.must_be_empty
+    end
+
+    it 'should serve the file if it is modified since last serve' do
+      file = 'files/index.html'
+      path = File.join(DOCROOT, file)
+      time = (File.mtime(path) - 60).httpdate
+      res = @file.get(file, 'HTTP_IF_MODIFIED_SINCE' => time)
+
+      res.status.must_equal 200
+      res.body.must_equal '<html>Index</html>'
+    end
+
+    #
+    # URL-encoded filenames
+    #
+    it 'should serve files with URL encoded filenames' do
+      res = @file.get('files/%69%6E%64%65%78%2Ehtml')
+
+      res.status.must_equal 200
+      res.body.must_equal '<html>Index</html>'
+    end
+
+    it 'should allow safe directory traversal' do
+      res = @file.get('files/../asset_spec.rb')
+      res.status.must_equal 200
+
+      res = @file.get('files/../files/index.html')
+      res.status.must_equal 200
+
+      res = @file.get('.')
+      res.status.must_equal 404
+
+      res = @file.get('files/..')
+      res.status.must_equal 404
+    end
+
+    #
+    # Directory Traversal
+    #
+    it 'should not allow unsafe directory traversal' do
+      res = @file.get('../minitest_helper.rb')
+      res.status.must_equal 404
+
+      res = @file.get('/../minitest_helper.rb')
+      res.status.must_equal 404
+
+      res = @file.get('../butler/files/index.html')
+      res.status.must_equal 404
+
+      # Ensure file existance
+      res = @file.get('files/index.html')
+      res.status.must_equal 200
+    end
+
+    it 'should allow safe directory traversal with encoded periods' do
+      res = @file.get('files/%2E%2E/asset_spec.rb')
+      res.status.must_equal 200
+
+      res = @file.get('files/%2E%2E/files/index.html')
+      res.status.must_equal 200
+
+      res = @file.get('%2E')
+      res.status.must_equal 404
+
+      res = @file.get('files/%2E')
+      res.status.must_equal 404
+    end
+
+    it 'should not allow unsafe directory traversal with encoded periods' do
+      res = @file.get('%2E%2E/minitest_helper.rb')
+      res.status.must_equal 404
+
+      res = @file.get('/%2E%2E/minitest_helper.rb')
+      res.status.must_equal 404
+    end
+
+    it 'should allow files with .. in their name' do
+      res = @file.get('files/..test')
+      res.status.must_equal 404
+
+      res = @file.get('files/test..')
+      res.status.must_equal 404
+
+      res = @file.get('files../test..')
+      res.status.must_equal 404
+    end
+
+    it 'should detect SystemCallErrors' do
+      res = @file.get('/cgi')
+      res.status.must_equal 404
+
+      res = @file.get('cgi')
+      res.status.must_equal 404
+
+      res = @file.get('/files')
+      res.status.must_equal 404
+
+      res = @file.get('files')
+      res.status.must_equal 404
+    end
+
+    it 'should return bodies that respond to #to_path' do
+      file = 'files/index.html'
+      path = File.join(DOCROOT, file)
+      env = Rack::MockRequest.env_for(file)
+      status, _, body = Butler::Asset.new(DOCROOT).call(env)
+
+      status.must_equal 200
+      body.must_respond_to :to_path
+      body.to_path.must_equal path
+    end
+
+    #
+    # Byte Ranges
+    #
+    it 'should return correct byte range in body' do
+      res = @file.get('files/index.html', 'HTTP_RANGE' => 'bytes=2-12')
+
+      res.status.must_equal 206
+      res.body.must_equal 'tml>Index</'
+
+      res['Content-Length'].must_equal '11'
+      # before: res['Content-Range'].must_equal 'bytes=2-12'
+      res['Content-Range'].must_equal 'bytes 2-12/18'
+    end
+
+    it 'should return error for unsatisfiable byte range' do
+      res = @file.get('files/index.html', 'HTTP_RANGE' => 'bytes=1234-5678')
+
+      res.status.must_equal 416
+      res['Content-Range'].must_equal 'bytes */18'
+    end
+
+  end
+end

data/spec/butler/files/index.html

@@ -0,0 +1 @@
+<html>Index</html>

data/spec/minitest_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'turn'
+
+Turn.config do |c|
+  # use one of output formats:
+  # :outline  - turn's original case/test outline mode [default]
+  # :progress - indicates progress with progress bar
+  # :dotted   - test/unit's traditional dot-progress mode
+  # :pretty   - new pretty reporter
+  # :marshal  - dump output as YAML (normal run mode only)
+  # :cue      - interactive testing
+  c.format  = :pretty
+  # turn on invoke/execute tracing, enable full backtrace
+  c.trace   = false
+  # use humanized test names (works only with :outline format)
+  c.natural = true
+end

data/test/butler/fixtures/public/.gitignore

@@ -0,0 +1 @@
+absolute/*

data/test/butler/fixtures/public/404.html

@@ -0,0 +1 @@
+404 error fixture

data/test/butler/fixtures/public/500.da.html

@@ -0,0 +1 @@
+500 localized error fixture

data/test/butler/fixtures/public/500.html

@@ -0,0 +1 @@
+500 error fixture

data/test/butler/fixtures/public/elsewhere/cools.js

@@ -0,0 +1 @@
+// cools.js

data/test/butler/fixtures/public/elsewhere/file.css

@@ -0,0 +1 @@
+/*file.css*/

data/test/butler/fixtures/public/foo/bar.html

@@ -0,0 +1 @@
+/foo/bar.html

data/test/butler/fixtures/public/foo/baz.css

@@ -0,0 +1,3 @@
+body {
+background: #000;
+}

data/test/butler/fixtures/public/foo/index.html

@@ -0,0 +1 @@
+/foo/index.html

data/test/butler/fixtures/public/foo//343/201/223/343/202/223/343/201/253/343/201/241/343/201/257.html

@@ -0,0 +1 @@
+means hello in Japanese

data/test/butler/fixtures/public/index.html

@@ -0,0 +1 @@
+/index.html

data/test/butler/fixtures/public/javascripts/application.js

@@ -0,0 +1 @@
+// application js

data/test/butler/fixtures/public/javascripts/bank.js

@@ -0,0 +1 @@
+// bank js

data/test/butler/fixtures/public/javascripts/common.javascript

@@ -0,0 +1 @@
+// common.javascript

data/test/butler/fixtures/public/javascripts/controls.js

@@ -0,0 +1 @@
+// controls js

data/test/butler/fixtures/public/javascripts/dragdrop.js

@@ -0,0 +1 @@
+// dragdrop js

data/test/butler/fixtures/public/javascripts/effects.js

@@ -0,0 +1 @@
+// effects js

data/test/butler/fixtures/public/javascripts/prototype.js

@@ -0,0 +1 @@
+// prototype js

data/test/butler/fixtures/public/javascripts/robber.js

@@ -0,0 +1 @@
+// robber js

data/test/butler/fixtures/public/javascripts/subdir/subdir.js

@@ -0,0 +1 @@
+// subdir js

data/test/butler/fixtures/public/javascripts/version.1.0.js

@@ -0,0 +1 @@
+// version.1.0 js

data/test/butler/fixtures/public/stylesheets/bank.css

@@ -0,0 +1 @@
+/* bank.css */

data/test/butler/fixtures/public/stylesheets/random.styles

@@ -0,0 +1 @@
+/* random.styles */

data/test/butler/fixtures/public/stylesheets/robber.css

@@ -0,0 +1 @@
+/* robber.css */

data/test/butler/fixtures/public/stylesheets/subdir/subdir.css

@@ -0,0 +1 @@
+/* subdir.css */

data/test/butler/fixtures/public/stylesheets/version.1.0.css

@@ -0,0 +1 @@
+/* version.1.0.css */

data/test/butler/fixtures/public/stylesheets/webfont.eot

@@ -0,0 +1 @@
+/* Webfont */

data/test/butler/static_test.rb

@@ -0,0 +1,195 @@
+# encoding: utf-8
+require 'minitest/autorun'
+require 'butler/static'
+require 'rack/mock'
+require 'action_controller'
+
+FIXTURE_LOAD_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+
+module StaticTests
+  def test_serves_dynamic_content
+    assert_equal "Hello, World!", get("/nofile").body
+  end
+
+  def test_handles_urls_with_bad_encoding
+    assert_equal "Hello, World!", get("/doorkeeper%E3E4").body
+  end
+
+  def test_serves_static_index_at_root
+    assert_html "/index.html", get("/index.html")
+    assert_html "/index.html", get("/index")
+    assert_html "/index.html", get("/")
+    assert_html "/index.html", get("")
+  end
+
+  def test_serves_static_file_in_directory
+    assert_html "/foo/bar.html", get("/foo/bar.html")
+    assert_html "/foo/bar.html", get("/foo/bar/")
+    assert_html "/foo/bar.html", get("/foo/bar")
+  end
+
+  def test_serves_static_index_file_in_directory
+    assert_html "/foo/index.html", get("/foo/index.html")
+    assert_html "/foo/index.html", get("/foo/")
+    assert_html "/foo/index.html", get("/foo")
+  end
+
+  def test_served_static_file_with_non_english_filename
+    assert_html "means hello in Japanese\n", get("/foo/#{Rack::Utils.escape("こんにちは.html")}")
+  end
+
+
+  def test_serves_static_file_with_exclamation_mark_in_filename
+    with_static_file "/foo/foo!bar.html" do |file|
+      assert_html file, get("/foo/foo%21bar.html")
+      assert_html file, get("/foo/foo!bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_dollar_sign_in_filename
+    with_static_file "/foo/foo$bar.html" do |file|
+      assert_html file, get("/foo/foo%24bar.html")
+      assert_html file, get("/foo/foo$bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_ampersand_in_filename
+    with_static_file "/foo/foo&bar.html" do |file|
+      assert_html file, get("/foo/foo%26bar.html")
+      assert_html file, get("/foo/foo&bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_apostrophe_in_filename
+    with_static_file "/foo/foo'bar.html" do |file|
+      assert_html file, get("/foo/foo%27bar.html")
+      assert_html file, get("/foo/foo'bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_parentheses_in_filename
+    with_static_file "/foo/foo(bar).html" do |file|
+      assert_html file, get("/foo/foo%28bar%29.html")
+      assert_html file, get("/foo/foo(bar).html")
+    end
+  end
+
+  def test_serves_static_file_with_plus_sign_in_filename
+    with_static_file "/foo/foo+bar.html" do |file|
+      assert_html file, get("/foo/foo%2Bbar.html")
+      assert_html file, get("/foo/foo+bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_comma_in_filename
+    with_static_file "/foo/foo,bar.html" do |file|
+      assert_html file, get("/foo/foo%2Cbar.html")
+      assert_html file, get("/foo/foo,bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_semi_colon_in_filename
+    with_static_file "/foo/foo;bar.html" do |file|
+      assert_html file, get("/foo/foo%3Bbar.html")
+      assert_html file, get("/foo/foo;bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_at_symbol_in_filename
+    with_static_file "/foo/foo@bar.html" do |file|
+      assert_html file, get("/foo/foo%40bar.html")
+      assert_html file, get("/foo/foo@bar.html")
+    end
+  end
+
+  # Windows doesn't allow \ / : * ? " < > | in filenames
+  unless RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+    def test_serves_static_file_with_colon
+      with_static_file "/foo/foo:bar.html" do |file|
+        assert_html file, get("/foo/foo%3Abar.html")
+        assert_html file, get("/foo/foo:bar.html")
+      end
+    end
+
+    def test_serves_static_file_with_asterisk
+      with_static_file "/foo/foo*bar.html" do |file|
+        assert_html file, get("/foo/foo%2Abar.html")
+        assert_html file, get("/foo/foo*bar.html")
+      end
+    end
+  end
+
+  #
+  # Headers
+  #
+  def test_sets_headers_global_via_global_shortcut
+    response = get("/index.html")
+    assert_html "/index.html", response
+    assert_equal "public, max-age=100", response.headers["Cache-Control"]
+  end
+
+  def test_sets_headers_fonts_via_fonts_shortcut
+    response = get("/stylesheets/webfont.eot")
+    assert_equal "public, max-age=200", response.headers["Cache-Control"]
+  end
+
+  def test_set_headers_for_file_extensions_via_array
+    response = get("/images/rails.png")
+    assert_equal "public, max-age=300", response.headers["Cache-Control"]
+  end
+
+  def test_set_headers_for_folder_via_string
+    response = get("/javascripts/subdir/subdir.js")
+    assert_equal "public, max-age=400", response.headers["Cache-Control"]
+
+    response = get("/foo/bar.html")
+    assert_equal "public, max-age=500", response.headers["Cache-Control"]
+  end
+
+  def test_set_headers_flexibely_via_regexp
+    response = get("/elsewhere/file.css")
+    assert_equal "public, max-age=600", response.headers["Cache-Control"]
+  end
+
+  private
+
+    def assert_html(body, response)
+      assert_equal body, response.body
+      assert_equal "text/html", response.headers["Content-Type"]
+    end
+
+    def get(path)
+      Rack::MockRequest.new(@app).request("GET", path)
+    end
+
+    def with_static_file(file)
+      path = "#{FIXTURE_LOAD_PATH}/public" + file
+      File.open(path, "wb+") { |f| f.write(file) }
+      yield file
+    ensure
+      File.delete(path)
+    end
+end
+
+class StaticTest < MiniTest::Unit::TestCase
+  DummyApp = lambda { |env|
+    [200, {"Content-Type" => "text/plain"}, ["Hello, World!"]]
+  }
+
+  header_rules = {
+    :global => {'Cache-Control' => 'public, max-age=100'},
+    :fonts  => {'Cache-Control' => 'public, max-age=200'},
+    %w(png) => {'Cache-Control' => 'public, max-age=300'},
+    'javascripts/subdir' => {'Cache-Control' => 'public, max-age=400'},
+    '/foo' => {'Cache-Control' => 'public, max-age=500'},
+    /\.(css|erb)\z/ => {'Cache-Control' => 'public, max-age=600'},
+  }
+
+  App = Butler::Static.new(DummyApp, "#{FIXTURE_LOAD_PATH}/public", header_rules: header_rules)
+
+  def setup
+    @app = App
+  end
+
+  include StaticTests
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: butler_static
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Klemm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: Butler is a Rack Middleware that serves static assets for your Rails
+  app.
+email:
+- github@tklemm.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- butler.gemspec
+- lib/butler.rb
+- lib/butler/asset.rb
+- lib/butler/handler.rb
+- lib/butler/railtie.rb
+- lib/butler/static.rb
+- lib/butler/version.rb
+- spec/butler/asset_spec.rb
+- spec/butler/files/index.html
+- spec/minitest_helper.rb
+- test/butler/fixtures/public/.gitignore
+- test/butler/fixtures/public/404.html
+- test/butler/fixtures/public/500.da.html
+- test/butler/fixtures/public/500.html
+- test/butler/fixtures/public/elsewhere/cools.js
+- test/butler/fixtures/public/elsewhere/file.css
+- test/butler/fixtures/public/foo/bar.html
+- test/butler/fixtures/public/foo/baz.css
+- test/butler/fixtures/public/foo/index.html
+- test/butler/fixtures/public/foo/こんにちは.html
+- test/butler/fixtures/public/images/rails.png
+- test/butler/fixtures/public/index.html
+- test/butler/fixtures/public/javascripts/application.js
+- test/butler/fixtures/public/javascripts/bank.js
+- test/butler/fixtures/public/javascripts/common.javascript
+- test/butler/fixtures/public/javascripts/controls.js
+- test/butler/fixtures/public/javascripts/dragdrop.js
+- test/butler/fixtures/public/javascripts/effects.js
+- test/butler/fixtures/public/javascripts/prototype.js
+- test/butler/fixtures/public/javascripts/robber.js
+- test/butler/fixtures/public/javascripts/subdir/subdir.js
+- test/butler/fixtures/public/javascripts/version.1.0.js
+- test/butler/fixtures/public/stylesheets/bank.css
+- test/butler/fixtures/public/stylesheets/random.styles
+- test/butler/fixtures/public/stylesheets/robber.css
+- test/butler/fixtures/public/stylesheets/subdir/subdir.css
+- test/butler/fixtures/public/stylesheets/version.1.0.css
+- test/butler/fixtures/public/stylesheets/webfont.eot
+- test/butler/static_test.rb
+homepage: https://github.com/thomasklemm/butler
+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: Butler is a Rack Middleware that serves static assets for your Rails app.
+  It allows you to set HTTP headers for individual files or folders based on rules.
+test_files:
+- spec/butler/asset_spec.rb
+- spec/butler/files/index.html
+- spec/minitest_helper.rb
+- test/butler/fixtures/public/.gitignore
+- test/butler/fixtures/public/404.html
+- test/butler/fixtures/public/500.da.html
+- test/butler/fixtures/public/500.html
+- test/butler/fixtures/public/elsewhere/cools.js
+- test/butler/fixtures/public/elsewhere/file.css
+- test/butler/fixtures/public/foo/bar.html
+- test/butler/fixtures/public/foo/baz.css
+- test/butler/fixtures/public/foo/index.html
+- test/butler/fixtures/public/foo/こんにちは.html
+- test/butler/fixtures/public/images/rails.png
+- test/butler/fixtures/public/index.html
+- test/butler/fixtures/public/javascripts/application.js
+- test/butler/fixtures/public/javascripts/bank.js
+- test/butler/fixtures/public/javascripts/common.javascript
+- test/butler/fixtures/public/javascripts/controls.js
+- test/butler/fixtures/public/javascripts/dragdrop.js
+- test/butler/fixtures/public/javascripts/effects.js
+- test/butler/fixtures/public/javascripts/prototype.js
+- test/butler/fixtures/public/javascripts/robber.js
+- test/butler/fixtures/public/javascripts/subdir/subdir.js
+- test/butler/fixtures/public/javascripts/version.1.0.js
+- test/butler/fixtures/public/stylesheets/bank.css
+- test/butler/fixtures/public/stylesheets/random.styles
+- test/butler/fixtures/public/stylesheets/robber.css
+- test/butler/fixtures/public/stylesheets/subdir/subdir.css
+- test/butler/fixtures/public/stylesheets/version.1.0.css
+- test/butler/fixtures/public/stylesheets/webfont.eot
+- test/butler/static_test.rb
+has_rdoc: