rack-rsi 0.0.1 → 0.0.2

data/CHANGELOG

@@ -0,0 +1,15 @@
+v 0.0.2
+-------
+* Improved Documentation
+* Recursive rsi_include upto 5 levels.
+* Application can choose to raise on errors or ignore erros when a
+target is included
+* Hello World Example extended to showcase rsi_include capability
+* In-case of redirect and rack.rsi header set then assembly is not
+invoked.
+
+v 0.0.1
+-------
+* Supports ETag Header Tag
+* Supports Cache-Control Header Tag
+* Supports Content-Length Header Tag

data/README.markdown

@@ -91,10 +91,31 @@ in view template foo_action.html.erb
     <%%= rsi_include( '/path/to_include' ) %>
     ...
 
+NOTE please make sure you write the target path as strings rather than
+method names e.g.:
+
+    ...
+    <%%= rsi_include( '/contacts/1' ) %>
+    ...
+
+Or if you want to use path helpers than trick ERB to generate ERB tags
+as follows:
+
+    ...
+    <%= "<%= rsi_include( '#{contact_path(1)}' ) ".html_safe %> %>
+    ...
+
 How do I use it with Bare Rack Apps
 -----------------------------------
 
-look for hello_world_app.rb in examples fold
+look for hello_world_app.rb in examples folder
+
+    cd examples
+    rackup
+    open http://127.0.0.1:9292/
+    open http://127.0.0.1:9292/recursive
+    open http://127.0.0.1:9292/noerror
+    open http://127.0.0.1:9292/error
 
 
 Limitations

data/examples/hello_world_app.rb

@@ -24,8 +24,64 @@ class HelloWorldApp
 
   private
 
-  ACTIONS = %<index header footer>
+  ACTIONS = %<index header footer recursive error noerror>
 
+  # Output /error
+  # Raises Exception
+  def error(request, response)
+    response['rack.rsi'] = '1'
+    response['Cache-Control'] = 'max-age=10'
+    # depth if set as a param will be string rather than integer
+    # depth + 1 in line 36 should raise error on recursive call
+    depth = request.params['depth'] || 1
+    response.write(%{
+      <%= rsi_include( "/error?depth=#{depth+1}", :raise_on_error ) %>
+      <p>Hello World! #{depth}</p>
+    }.gsub(/^\s*/, "").strip)
+  end
+
+  # Output /noerror
+  # Hello World! 1
+  def noerror(request, response)
+    response['rack.rsi'] = '1'
+    response['Cache-Control'] = 'max-age=10'
+    # depth if set as a param will be string rather than integer
+    # depth + 1 in line 36 should raise error on recursive call
+    # which is silently ignore
+    depth = request.params['depth'] || 1
+    response.write(%{
+      <%= rsi_include( "/error?depth=#{depth+1}" ) %>
+      <p>Hello World! #{depth}</p>
+    }.gsub(/^\s*/, "").strip)
+  end
+
+  # Output /recursive
+  # Hello World! 5
+  #
+  # Hello World! 4
+  #
+  # Hello World! 3
+  #
+  # Hello World! 2
+  #
+  # Hello World! 1
+  def recursive(request, response)
+    response['rack.rsi'] = '1'
+    response['Cache-Control'] = 'max-age=10'
+    depth = ( request.params['depth'] || 1 ).to_i
+    response.write(%{
+      <%= rsi_include( "/recursive?depth=#{depth+1}", :raise_on_error ) %>
+      <p>Hello World! #{depth}</p>
+    }.gsub(/^\s*/, "").strip)
+  end
+
+  # Output /
+  # Here comes header from Header Action exclusively for buzzmenot
+  #
+  # Hello World!
+  #
+  # Here comes footer from Footer Action exclusively for github
+  #
   def index(request, response)
     response['rack.rsi'] = '1'
     response['Cache-Control'] = 'max-age=3600'

data/lib/rack/rsi.rb

@@ -14,13 +14,13 @@ class Rack::RSI
 
   class RsiRender
 
-    def initialize( app, env, level = 0 )
+    def initialize( app, env, level = 1 )
       @app, @env, @level = app, env, level
       @headers, @body = {}, {}
     end
 
     def rack_rsi?
-      @headers.values.select{ |x| x && x['rack.esi'] }.any?
+      @headers.values.select{ |x| x && x['rack.rsi'] }.any?
     end
 
     def cache_control_headers
@@ -31,7 +31,8 @@ class Rack::RSI
       return binding( )
     end
 
-    def rsi_include( source )
+    def rsi_include( source, raise_on_error = false )
+      return "" unless @level < 5
       uri = URI.parse( source )
       include_env = @env.merge( "PATH_INFO" => uri.path,
                                "SCRIPT_NAME" => "",
@@ -42,6 +43,7 @@ class Rack::RSI
         @headers[ source ] = include_headers
         @body[ source ] = ( include_status == 200 ? include_body : [] )
       rescue Exception => message
+        raise message if raise_on_error
         @body[ source ] = []
       end
       value = ''
@@ -68,7 +70,10 @@ class Rack::RSI
     status, headers, enumerable_body = original_response = @app.call(env)
 
     rack_rsi_flag = headers.delete('rack.rsi')
-    return original_response unless rack_rsi_flag
+
+    # Assemble Pages if rack_rsi_flag is set and status is 200 ok
+    # otherwise return the original response
+    return original_response unless rack_rsi_flag && status == 200
 
     body = ""
     enumerable_body.each do |part|
@@ -78,7 +83,7 @@ class Rack::RSI
     cache_control_headers = Array( headers.delete( 'Cache-Control' ) || "max-age=0" )
 
     # Like Varnish supports upto 5 levels of ESI includes recursively
-    level = 0
+    level = 1
     while( rack_rsi_flag )
       erb = ERB.new( body, 0 )
       renderer = RsiRender.new( vanilla_app, vanilla_env, level )
@@ -94,7 +99,8 @@ class Rack::RSI
 
     # For Assembled Pages Cache-Control to be set as private, with
     # max-age=<minimum max-age of all the requests that are assembled>
-    # and should be revalidate on stale
+    # and should be revalidate on stale. If max-age is not set for even one of the
+    # requests then max-age is set to 0.
     min_max_age = cache_control_headers.collect{ |x| x.match(/max-age\s*=\s*(\d+)/).to_a[1].to_i }.min
 
     headers['Cache-Control'] = "private, max-age=#{min_max_age}, must-revalidate"
@@ -105,7 +111,7 @@ class Rack::RSI
     headers['Content-Length'] = Rack::Utils.bytesize( body ).to_s
 
     # For now whatever headers is set by the original action would be
-    # passed on. Expect for Cache-Control, ETag, Expires, Last-Modified
+    # passed on. Except for Cache-Control, ETag, Expires, Last-Modified
     # Cookies from the original action are passed on.
     [ status, headers, [ body ] ]
   end

data/lib/rack/rsi_version.rb

@@ -1,6 +1,6 @@
 module Rack
   class RSI
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end
 

metadata

@@ -2,7 +2,7 @@
 name: rack-rsi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ram Singla
@@ -35,6 +35,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE.markdown
 - README.markdown