mongrel_esi 0.5.0 → 0.5.1

data/lib/esi/router.rb

@@ -23,7 +23,6 @@ module ESI
   # default:
   #   host: 127.0.01
   #   port: 3001
-  #   cache_ttl: 300
   #
   # This example will cache all requests for 300 seconds, by default.
   #
@@ -72,16 +71,6 @@ module ESI
       "http://" + (config[:host] + ":" + (config[:port] || "").to_s + "/" + request_uri).squeeze("/")
     end
 
-    def cache_ttl( request_uri )
-      return 600 if request_uri.match(/http:\/\//) # default cache for absolute URLs
-      # locate the first entry to match the given uri
-      config = @hosts.find do |cfg|
-        Regexp.new(cfg[:match_url]).match(request_uri)
-      end
-      config = @default unless config
-      (config[:cache_ttl] || 600).to_i
-    end
-
   end
 
 end

data/lib/esi/tag/attempt.rb

@@ -1,9 +1,10 @@
 # Copyright (c) 2008 Todd A. Fisher
 # see LICENSE
+require 'esi/tag/container'
 
 module ESI
   module Tag
-    class Attempt < Base
+    class Attempt < Container
     end
   end
 end

data/lib/esi/tag/base.rb

@@ -9,7 +9,6 @@ module ESI
       attr_reader :attributes, :children, :name, :closed, :cache
  
       include ESI::Log
-      extend ESI::Log
 
       def initialize(router,headers,http_params,name,attrs,cache)
         @router = router
@@ -17,16 +16,12 @@ module ESI
         @http_params = http_params
         @attributes = attrs
         @cache = cache
-        @children = []
         @name = name
-        @unclosed = nil
-        @closed = false
       end
  
       def self.create(router,headers,http_params,tag_name,attrs,cache)
-        tag_name.gsub!(/esi:/,'')
         raise "Unsupport ESI tag: #{tag_name}" unless Validate.include?(tag_name)
-        eval(tag_name.capitalize).new(router,headers,http_params,tag_name,attrs,cache)
+        eval(tag_name.sub(/esi:/,'').capitalize).new(router,headers,http_params,tag_name,attrs,cache)
       rescue => e
         log_debug "Failed while creating tag: #{tag_name}, with error: #{e.message}"
         raise e
@@ -41,24 +36,6 @@ module ESI
       end
 
       def close( output, options = {} )
-        @closed = true
-      end
-
-      def close_child( output, name )
-        name = name.gsub(/esi:/,'')
-        if @unclosed and @unclosed.name == name
-          @unclosed.close( output )
-          @unclosed = nil
-        end
-      end
-
-      def add_child(tag)
-        if @unclosed
-          @unclosed.add_child(tag)
-        else
-          @unclosed = tag
-          @children << tag
-        end
       end
 
       # :startdoc:

data/lib/esi/tag/container.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2008 Todd A. Fisher
+# see LICENSE
+require 'esi/logger'
+require 'esi/tag/base'
+
+module ESI
+  module Tag
+    class Container < ESI::Tag::Base
+      include ESI::Log
+      extend ESI::Log
+      attr_reader :children, :name, :closed, :cache
+
+      def initialize(router,headers,http_params,name,attrs,cache)
+        super
+        @children = []
+        @unclosed = nil
+      end
+
+      def close_child( output, name )
+        name = name.sub(/esi:/,'')
+        if @unclosed and @unclosed.name == name
+          @unclosed.close( output )
+          @unclosed = nil
+        end
+      end
+
+      def add_child(tag)
+        if @unclosed
+          #puts "add as child of(#{self.name}): #{tag.name} #{tag.attributes.inspect} to #{@unclosed.name}"
+          @unclosed.add_child(tag)
+        else
+          #puts "add: #{tag.name} #{tag.attributes.inspect} to #{self.name}"
+          @unclosed = tag if tag.respond_to?(:add_child)
+          @children << tag
+        end
+      end
+
+    end
+  end
+end

data/lib/esi/tag/except.rb

@@ -1,8 +1,10 @@
 # Copyright (c) 2008 Todd A. Fisher
 # see LICENSE
+require 'esi/tag/container'
+
 module ESI
   module Tag
-    class Except < Base
+    class Except < Container
       attr_reader :buffers
 
       def initialize(uri,headers,http_params,name,attrs,cache)

data/lib/esi/tag/include.rb

@@ -34,34 +34,34 @@ module ESI
           @headers = forward_headers
         end
 
-        def request(uri, timeout = 1, alt_failover=nil, follow_limit=3)
-          uri = URI.parse(uri) if uri.is_a?(String)
+        def request(url, timeout = 1, alt_failover=nil, follow_limit=3)
+          uri = URI.parse(url)
           Net::HTTP.start(uri.host, uri.port) do|http|
             http.read_timeout = timeout if timeout and timeout > 0
             rp = uri.query ? "#{uri.path}?#{uri.query}" : uri.path
             http.request_get( rp, @headers ) do|response|
               case response
               when Net::HTTPSuccess
-                yield true, response, uri
+                yield true, response, url
               when Net::HTTPRedirection
                 ir = Request.new(@headers)
-                ir.request(URI.parse(response['location']), timeout, alt_failover, follow_limit - 1) do|s,r|
-                  yield s, r, URI.parse(response['location'])
+                ir.request(response['location'], timeout, alt_failover, follow_limit - 1) do|s,r|
+                  yield s, r, response['location']
                 end
               else
                 if alt_failover
                   ir = Request.new(@headers)
                   ir.request(alt_failover, timeout, nil, follow_limit) do|s,r|
-                    yield s, r, URI.parse(alt_failover)
+                    yield s, r, alt_failover
                   end
                 else
-                  yield false, Error.new("Failed to request fragment: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}", response), uri
+                  yield false, Error.new("Failed to request fragment: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}", response), url
                 end
               end
             end
           end
         rescue Timeout::Error => e
-          yield false, Error.new("Failed to request fragment: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}, timeout error: #{e.message}", nil), uri
+          yield false, Error.new("Failed to request fragment: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}, timeout error: #{e.message}", nil), url
         end
 
       end
@@ -93,7 +93,7 @@ module ESI
         if @cache.cached?( src, @http_params )
           send_from_cache( src )
         else
-          send_from_surrogate( src, alt, raise_on_error )
+          send_from_origin( src, alt, raise_on_error )
         end
 
       end
@@ -102,75 +102,29 @@ module ESI
       def prepare_parser
         if parse_fragment?
           @parser = ESI::Parser.new( @output, @router, @cache, @max_depth )
-          @parser.prepare( @headers, @http_params ) do|chars|
-            if @parser.response.active_buffer.closed_write?
-              @parser.response.open_active_buffer
-              @parser.response.send
-            end
-            @parser.response.active_buffer << chars
-          end
+          @parser.prepare( @headers, @http_params )
           @parser.depth = (@depth+1) # increment the depth
         end
       end
 
       def send_from_cache( src )
         cached_fragment = @cache.get( src, @headers ).body
-        log_request "C"
-        if parse_fragment?
+        #log_request "C"
 
+        if parse_fragment? and cached_fragment.match(/<esi:/)
           @parser.process cached_fragment
           @parser.finish
-
         else
           @output << cached_fragment 
         end
 
       end
 
-      def send_from_surrogate( src, alt, raise_on_error )
-        ir = Request.new(@http_params)
-        #timer = Time.now
-        ir.request(src, @attributes['timeout'].to_i, alt ) do|status,response,uri|
+      def send_from_origin( src, alt, raise_on_error )
+        #log_request "R"
+        Request.new(@http_params).request(src, @attributes['timeout'].to_i, alt ) do|status,response,url|
           if status
-            # NOTE: it's important that we cache the unprocessed markup, because we need to 
-            # reprocess the esi:include vars even for cached content, this way we can have cached content
-            # with HTTP_COOKIE vars and avoid re-requesting content
-            cache_buffer = ""
-            response.read_body do|s|
-              cache_buffer << s
-              if parse_fragment?
-                @parser.process s
-              else
-                @output << s
-              end
-            end
-
-            if parse_fragment?
-              @parser.finish
-            end
-
-            if src != uri # these won't be equal if the fragment followed a redirect or used the alt condition
-              if uri.query
-                request_uri = "#{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}?#{uri.query}"
-              else
-                request_uri =  "#{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}"
-              end
-            else
-              request_uri = src
-            end
-
-            cache_ttl = (@attributes['max-age']||600) # defaults to 600... maybe should have this be configurable?
-            if cache_ttl.respond_to?(:match) and cache_ttl.match(/\+/)
-              total=0
-              cache_ttl.split('+').each {|comp| total+=comp.to_i}
-              cache_ttl = total
-            else
-              cache_ttl = cache_ttl.to_i
-            end
-
-            @cache.put(request_uri, @http_params, cache_ttl, cache_buffer )
-            #log_request "R #{src} #{Time.now - timer}\n"
-
+            process_successful_response( url, status, response )
           else
             # error/ check if the include has an onerror specifier
             return if @attributes['onerror'] == 'continue'
@@ -182,6 +136,43 @@ module ESI
         end
       end
 
+      def process_successful_response( url, status, response )
+        # NOTE: it's important that we cache the unprocessed markup, because we need to 
+        # reprocess the esi:include vars even for cached content, this way we can have cached content
+        # with HTTP_COOKIE vars and avoid re-requesting content
+        cache_buffer = ""
+        if parse_fragment?
+          response.read_body do|s|
+            cache_buffer << s
+          end
+          if cache_buffer.match(/<esi:/)
+            @parser.process cache_buffer
+            @parser.finish
+          else
+            @output << cache_buffer
+          end
+        else
+          response.read_body do|s|
+            cache_buffer << s
+          end
+          @output << cache_buffer
+        end
+
+        request_uri = url
+
+        cache_ttl = (@attributes['max-age']||600) # defaults to 600... maybe should have this be configurable?
+        if cache_ttl.respond_to?(:match) and cache_ttl.match(/\+/)
+          total=0
+          cache_ttl.split('+').each {|comp| total+=comp.to_i}
+          cache_ttl = total
+        else
+          cache_ttl = cache_ttl.to_i
+        end
+
+        @cache.put(request_uri, @http_params, cache_ttl, cache_buffer )
+        #log_request "R #{src} #{Time.now - timer}\n"
+      end
+
 
     end
 

data/lib/esi/tag/try.rb

@@ -2,34 +2,32 @@
 # see LICENSE
 
 require 'esi/logger'
+require 'esi/tag/container'
 
 module ESI
   module Tag
-    class Try < Base
-      include ESI::Log
-      
+    class Try < Container
+ 
       def close( output )
         super(output)
         begin
-          attempt = @children.detect{|tag| tag.name == "attempt" }
-          attempt.children.each do|tag|
-            tag.close( output, :raise => true )
+          @children.each do |tag|
+            if tag.name == "attempt"
+              tag.children.each do|ctag|
+                ctag.close( output, :raise => true )
+              end
+            end
           end
         rescue => e
           log_error e.message
-          except = @children.detect{|tag| tag.name == "except" }
-          except.children.each_with_index do|tag,index|
-            if( output.respond_to?('<<') )
-              output << except.buffers[index]
-            else
-              output.call except.buffers[index]
+          @children.each do |tag|
+            if tag.name == "except"
+              tag.children.each_with_index do|ctag,index|
+                output << tag.buffers[index]
+                ctag.close( output )
+              end
+              output << tag.buffers[tag.children.size]
             end
-            tag.close( output )
-          end
-          if( output.respond_to?('<<') )
-            output << except.buffers[except.children.size]
-          else
-            output.call except.buffers[except.children.size]
           end
         end
       end

data/lib/esi/version.rb

@@ -0,0 +1,9 @@
+module ESI #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 5
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/integration/handler_test.rb

@@ -15,16 +15,48 @@ class HandlerTest < Test::Unit::TestCase
 		end
     check_status results, String
 	end
-  
+
+  def simple_response_assertions(res)
+    assert_not_nil res
+    assert_not_nil res.header
+    assert_not_nil res.body
+    assert_equal Net::HTTPOK, res.header.class
+    assert_match '<html>', res.body, "Missing document head"
+    assert_match $fragment_test1, res.body, "Fragment not found"
+    assert_match $fragment_test2, res.body, "Fragment not found"
+    assert_match '</html>', res.body, "Missing document footer"
+    assert_equal %{<html>\n<head>\n</head>\n<body>\n  <h1>This is a test document</h1>\n  \n      valid\n      \n    <div>test1</div>\n\n  \n      \n    <div>test2</div>\n\n</body>\n</html>\n}, res.body
+    assert_no_match /<esi:/, res.body # assert there are no esi tags in the result
+  end
+
   def test_simple_esi
     Net::HTTP.start("localhost", 9997) do |h|
-      req = h.get("/esi_test_content.html")
-      assert_not_nil req
-      assert_not_nil req.header
-      assert_not_nil req.body
-      assert_equal Net::HTTPOK, req.header.class
-			assert_match $fragment_test1, req.body, "Fragment not found"
-			assert_match $fragment_test2, req.body, "Fragment not found"
+      res = h.get("/esi_test_content.html")
+      simple_response_assertions(res)
+    end
+  end
+
+  def test_simple_esi_http10
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/esi_test_content.html",{"VERSION" => "HTTP/1.0"})
+      simple_response_assertions(res)
+    end
+  end
+
+  def test_page_surrogate_control_max_age
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/surrogate-test",{"Surrogate-Control" => %{max-age=10, content="ESI/1.0"}})
+      simple_response_assertions(res)
+      assert res.header.to_hash.key?("transfer-encoding")
+      assert !res.header.to_hash.key?("content-length")
+      assert_equal "chunked", res.header["transfer-encoding"]
+    end
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/surrogate-test",{"Surrogate-Control" => %{max-age=10, content="ESI/1.0"}})
+      simple_response_assertions(res)
+      assert !res.header.to_hash.key?("transfer-encoding")
+      assert res.header.to_hash.key?("content-length")
+      assert_equal "156", res.header["content-length"]
     end
   end
 
@@ -36,6 +68,9 @@ class HandlerTest < Test::Unit::TestCase
       assert_not_nil req.body
       assert_equal Net::HTTPOK, req.header.class
 			assert_match $fragment_test1, req.body, "Fragment not found"
+			assert_match "</html>", req.body, "End tag not found"
+			assert_no_match /<p>sorry<\/p>/, req.body, "Should not see any fragment failures"
+			assert_no_match /<esi:/, req.body # assert there are no esi tags in the result
       # should have 37 fragments
       count = 0
       req.body.scan $fragment_test1 do|m|
@@ -87,7 +122,7 @@ class HandlerTest < Test::Unit::TestCase
       assert_equal "/esi_test_content.html", res["Location"]
     end
   end
-  
+
   # test that we're including http headers as part of the request fragment cache
   def test_ajax_caching
     # start by making the request using the X-Requested-With Header
@@ -196,9 +231,11 @@ class HandlerTest < Test::Unit::TestCase
       assert_not_nil res.body
       #puts res.body
       assert_equal Net::HTTPOK, res.header.class, res.body
-			assert_match /<div>test1<\/div>/, res.body, "Normal esi include tags failed"
-			assert_match /<div>test1<\/div>/, res.body, "Normal esi include tags failed"
-			assert_match /<a href="www.akamai.com">www.example.com <\/a>/, res.body, "Static Failover failed"
+      assert_match "<html>", res.body
+			assert_match "<div>test1</div>", res.body, "Normal esi include tags failed"
+			assert_match "<div>test1</div>", res.body, "Normal esi include tags failed"
+			assert_match %{<a href="www.akamai.com">www.example.com </a>}, res.body, "Static Failover failed"
+      assert_match "</html>", res.body
     end
   end