rack-varnish-esi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a00a01acc17dceb937143491e5935ca5f733ce5e
+  data.tar.gz: 6fca9d2effea264c73af087b51c6f39432467a17
+SHA512:
+  metadata.gz: d3257838b5b959daacb5221475bc2d4097ebf8e1e80837ca2220da007f0c12ffcbb8ebae0bd75e1adb3ab732fcc695ae7b52bcc035424519d97875f73f34951e
+  data.tar.gz: 73b93a7e86c546a20e4f7491e02a042ecd66d203472b164ab0ea292effd5e1345dee22c545f0399889d8988c024412bafa6af47635e6efe1d4aeccc911d4de3a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Marek
+
+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,79 @@
+# rack-varnish-esi
+
+rack-varnish-esi is a Varnish ESI middleware implementation for Rack which is as close as possible to Varnish's own ESI implementation.
+
+__Note:__ This gem should only be used in development.
+
+
+## Installation
+
+### With Gemfile
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-varnish-esi'
+```
+
+And then execute:
+
+    $ bundle
+
+### Without Gemfile
+
+    $ gem install rack-varnish-esi
+
+
+## Usage
+
+### rackup
+
+```ruby
+use Rack::VarnishEsi, options
+run Application.new
+```
+
+### Rails: config/environments/development.rb
+
+```ruby
+config.middleware.insert 0, Rack::VarnishEsi, options
+```
+
+### Options
+
+```ruby
+options = {
+  :locations => {
+    /\/esi\/*/ => "http://my-esi-host.com", # Resolves /esi/* to http://my-esi-host.com/esi/*
+    "/banners/header.html" => "http://localhost:8080", # Resolves /banners/header.html to http://localhost:8080/banners/header.html
+  }
+}
+```
+
+
+## Test environment
+
+    $ rake test
+
+### Update varnish fixtures
+
+Start varnish in one terminal:
+
+    $ test/fixtures/run_varnish.sh
+
+Start static server in another terminal:
+
+    $ rackup test/static_server/config.ru
+
+And then update varnish fixtures:
+
+    $ wget http://localhost:6081 -O test/fixtures/varnish_output.html
+
+
+## Contributing
+
+1. Fork it ( https://github.com/tmak/rack-varnish-esi/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test
+

data/lib/rack-varnish-esi.rb

@@ -0,0 +1 @@
+require 'rack/varnish_esi'

data/lib/rack/varnish_esi.rb

@@ -0,0 +1,23 @@
+require 'rack/varnish_esi_version'
+require 'rack/varnish_esi_processor'
+
+module Rack
+  class VarnishEsi
+    def initialize(app, options={})
+      @app = app
+      @processor = Rack::VarnishEsiProcessor.new(options[:locations] || {})
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      if headers['Content-Type'] =~ /text\/html/
+        body.close if body.respond_to?(:close)
+        body = @processor.process(body)
+        headers['Content-Length'] = (body.reduce(0) {|sum, part| sum + part.bytesize}).to_s
+      end
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/rack/varnish_esi_processor.rb

@@ -0,0 +1,52 @@
+require 'net/http'
+
+module Rack
+  class VarnishEsiProcessor
+    def initialize(locations)
+      @locations = locations
+    end
+
+    def process(body)
+      output = []
+
+      body.each do |part|
+        part = process_remove(part)
+        part = process_comment(part)
+        output << process_include(part)
+      end
+
+      output
+    end
+
+  protected
+
+    def process_remove(part)
+      part.gsub(/<esi:remove>.*<\/esi:remove>/m, '')
+    end
+
+    def process_comment(part)
+      part.gsub(/<!--esi(.*)-->/m, '\1')
+    end
+
+    def process_include(part)
+      part.gsub(/<esi:include src="([^"]+)"(?: +alt="([^"]+)")?\/?>/) do
+        fetch($1)
+      end
+    end
+
+    def fetch(src)
+      location = src.gsub(/https?:\/\/[^\/]+/, '')
+      location = "/#{location}" unless location.start_with?('/')
+
+      @locations.each do |pattern, host|
+        if (pattern.is_a?(String) && location == pattern) || (pattern.is_a?(Regexp) && location =~ pattern)
+          return get("#{host}#{location}")
+        end
+      end
+    end
+
+    def get(uri)
+      Net::HTTP.get(URI(uri))
+    end
+  end
+end

data/lib/rack/varnish_esi_version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class VarnishEsi
+    VERSION = "0.0.1"
+  end
+end

data/rack-varnish-esi.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/varnish_esi_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-varnish-esi"
+  spec.version       = Rack::VarnishEsi::VERSION
+  spec.authors       = ["Thomas Marek"]
+  spec.email         = ["thomas_marek@gmx.net"]
+  spec.summary       = %q{Varnish ESI middleware implementation for Rack.}
+  spec.description   = %q{<<-EOF
+rack-varnish-esi is a Varnish ESI middleware implementation for Rack which is as close as possible to Varnish's own ESI implementation.
+Note: This gem should only be used in development.
+EOF}
+  spec.homepage      = "https://github.com/tmak/rack-varnish-esi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "rack"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/fixtures/run_varnish.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+CURRENT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+
+sudo varnishd \
+         -F \
+         -a :6081 \
+         -T localhost:6082 \
+         -f ${CURRENT_DIR}/varnish.vcl \
+         -s malloc,32m

data/test/fixtures/varnish.vcl

@@ -0,0 +1,15 @@
+vcl 4.0;
+
+backend default {
+  .host = "127.0.0.1";
+  .port = "9292";
+}
+
+
+sub vcl_recv {
+  return (pass);
+}
+
+sub vcl_backend_response {
+  set beresp.do_esi = true;
+}

data/test/fixtures/varnish_output.html

@@ -0,0 +1,20 @@
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+</head>
+<body>
+  XML notation: Marek<br>
+  HTML notation: Thomas<br>
+  Recursive: <span>Thomas Marek</span><br>
+  Unicode: €10<br>
+  Alternative option: File not found: /unknown
+<br>
+  Different host: Thomas<br>
+  No leading slash: Thomas<br>
+  
+  
+  Commented out
+  Thomas
+  
+</body>
+</html>

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rack/varnish_esi'
+
+require 'minitest/autorun'

data/test/static_server/app.rb

@@ -0,0 +1,19 @@
+require 'rack'
+
+module StaticServer
+  class App
+    def initialize(extra_middleware=nil, extra_middleware_options={})
+      @static = Rack::Static.new(self, :urls => [""], :root => File.expand_path('../public', __FILE__), :index => "index.html")
+
+      if extra_middleware
+        @middleware = extra_middleware.new(@static, extra_middleware_options)
+      else
+        @middleware = @static
+      end
+    end
+
+    def call(env)
+      @middleware.call(env)
+    end
+  end
+end

data/test/static_server/config.ru

@@ -0,0 +1,3 @@
+require File.expand_path('../app', __FILE__)
+
+run StaticServer::App.new

data/test/static_server/public/first_name.txt

@@ -0,0 +1 @@
+Thomas

data/test/static_server/public/index.html

@@ -0,0 +1,22 @@
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+</head>
+<body>
+  XML notation: <esi:include src="/last_name.txt"/><br>
+  HTML notation: <esi:include src="/first_name.txt"><br>
+  Recursive: <esi:include src="/subdir/full_name.html"/><br>
+  Unicode: <esi:include src="/unicode.txt"/><br>
+  Alternative option: <esi:include src="/unknown" alt="/first_name.txt"/><br>
+  Different host: <esi:include src="http://www.google.com/first_name.txt"/><br>
+  No leading slash: <esi:include src="first_name.txt"/><br>
+  <esi:remove>
+    Removed
+    <esi:include src="/first_name.txt"/>
+  </esi:remove>
+  <!--esi
+  Commented out
+  <esi:include src="/first_name.txt"/>
+  -->
+</body>
+</html>

data/test/static_server/public/last_name.txt

@@ -0,0 +1 @@
+Marek

data/test/static_server/public/subdir/full_name.html

@@ -0,0 +1 @@
+<span><esi:include src="/first_name.txt"/> <esi:include src="/last_name.txt"/></span>

data/test/static_server/public/unicode.txt

@@ -0,0 +1 @@
+€10

data/test/test_rack_varnish_esi.rb

@@ -0,0 +1,46 @@
+require 'minitest_helper'
+require 'net/http'
+require 'rack'
+require 'webrick'
+require File.expand_path('../static_server/app', __FILE__)
+
+class TestRackVarnishEsi < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Rack::VarnishEsi::VERSION
+  end
+
+  def test_that_it_has_the_same_behavior_as_varnish
+    http_server_thread = start_http_server_with_varnish_esi_middleware(
+      :locations => {/.*/ => 'http://localhost:8080'},
+    )
+
+    begin
+      assert_equal File.read(File.expand_path('../fixtures/varnish_output.html', __FILE__)), Net::HTTP.get(URI('http://localhost:8080')).force_encoding('UTF-8')
+    ensure
+      http_server_thread.exit
+    end
+  end
+
+protected
+
+  def start_http_server_with_varnish_esi_middleware(varnish_esi_options)
+    http_server_log_file = File.open(File.expand_path('../http_server.log', __FILE__), 'a')
+
+    http_server_options = {
+      :Port => 8080,
+      :Logger => WEBrick::Log.new(http_server_log_file),
+      :AccessLog => [
+          [ http_server_log_file, WEBrick::AccessLog::COMMON_LOG_FORMAT ],
+          [ http_server_log_file, WEBrick::AccessLog::REFERER_LOG_FORMAT ]
+      ]
+    }
+
+    http_server_thread = Thread.new do
+      Rack::Handler::WEBrick.run(StaticServer::App.new(::Rack::VarnishEsi, varnish_esi_options), http_server_options)
+    end
+
+    sleep(0.5)
+
+    http_server_thread
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rack-varnish-esi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Marek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest
+  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: |-
+  <<-EOF
+  rack-varnish-esi is a Varnish ESI middleware implementation for Rack which is as close as possible to Varnish's own ESI implementation.
+  Note: This gem should only be used in development.
+  EOF
+email:
+- thomas_marek@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-varnish-esi.rb
+- lib/rack/varnish_esi.rb
+- lib/rack/varnish_esi_processor.rb
+- lib/rack/varnish_esi_version.rb
+- rack-varnish-esi.gemspec
+- test/fixtures/run_varnish.sh
+- test/fixtures/varnish.vcl
+- test/fixtures/varnish_output.html
+- test/minitest_helper.rb
+- test/static_server/app.rb
+- test/static_server/config.ru
+- test/static_server/public/first_name.txt
+- test/static_server/public/index.html
+- test/static_server/public/last_name.txt
+- test/static_server/public/subdir/full_name.html
+- test/static_server/public/unicode.txt
+- test/test_rack_varnish_esi.rb
+homepage: https://github.com/tmak/rack-varnish-esi
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Varnish ESI middleware implementation for Rack.
+test_files:
+- test/fixtures/run_varnish.sh
+- test/fixtures/varnish.vcl
+- test/fixtures/varnish_output.html
+- test/minitest_helper.rb
+- test/static_server/app.rb
+- test/static_server/config.ru
+- test/static_server/public/first_name.txt
+- test/static_server/public/index.html
+- test/static_server/public/last_name.txt
+- test/static_server/public/subdir/full_name.html
+- test/static_server/public/unicode.txt
+- test/test_rack_varnish_esi.rb