rack-rsi 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rack-rsi.gemspec
+gemspec

data/LICENSE.markdown

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2011 [Ram Singla](https://github.com/ramsingla)
+
+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.markdown

@@ -0,0 +1,110 @@
+Rack Side Include
+=================
+
+Description
+-----------
+
+Rack::RSI is an rack middleware which helps you assemble pages on
+similar lines of ESI without leaving the comfort of Ruby. Rack Side
+Include only support one feature of ESI i.e. <esi:include>. One of
+the key differentiator from esi standard it uses ERB rather than XML
+tags to assemble pages and it does not assemble pages outside the
+Application.
+
+Rationale
+---------
+
+A fair bit of what ESI offers, is in the ESI language because Akamais
+customers cannot configure the Akamai edge proxies. While this is
+perfectly sensible for the Akamai business model, it is of little
+relevance for WebApps where the content-provider is in control of the
+servers.
+
+Also if you do not want to use a separate tier for ESI, the ESI standard
+is too heavy to implement as a Rack Middleware.
+
+ERB is much simpler to render and less CPU intensive interms of XML
+parsing and generating response.
+
+Assembling pages inside the applications is chosen deliberately because
+the content for assembly is fetched from within the Rack stack without
+firing any HTTP requests to the server.
+
+Potential Scenarios
+-------------------
+
+#### Pages Decorated with Short Lived Information
+
+Consider a case of high volume news website. Most pages on this website
+contains one article decorated by ads and a "hot news" box. Without the
+assembly the TTL for each of these articles need to be kept low, to keep
+decorations and in particular "hot news" box fresh.
+
+Rack Server Include assembly middleware allows you to break the page
+into different fragments which can be cached differently and are
+assembled just before serving the request to the client. In above case
+article can be cached for an infinitely long time, with a directive to
+tell the middle where what and where to include the "hot news" box from.
+
+Each part of the section and the page containing the rack side include
+directive can be cached differently.
+
+#### Creating Dashboards
+
+Consider an admin dashboard of an ecommerce website which shows the new
+orders and new products added on the system.
+
+If we are not using assembly middleware you would require to populate
+relevant order and product object in dashboard controller which is not
+well organized. Ideally orders controller should fetch order objects and
+products controller should fetch the products.
+
+Rack Server Include assembly lets you achieve this by calling two
+include directives. One to new orders and one to new products which will
+be served by orders and products controller respectively.
+
+This can really help you keep you application slim and well-organized.
+
+How do I use in Rails 3
+-----------------------
+
+in Gemfile
+
+    gem 'rack-rsi', :require => 'rack/rsi'
+
+in config/application.rb
+
+    # Rack::RSI should be loaded high up the Rack Middleware Stack
+    config.middleware.insert_before ActionDispatch::Callbacks, Rack::RSI
+
+in controller action
+
+    def foo_action
+      # Notify Rack::RSI to process this request
+      headers['rack.rsi'] = '1'
+      ...
+    end
+
+in view template foo_action.html.erb
+
+    ...
+    <%%= rsi_include( '/path/to_include' ) %>
+    ...
+
+How do I use it with Bare Rack Apps
+-----------------------------------
+
+look for hello_world_app.rb in examples fold
+
+
+Limitations
+------------
+
+* Only GET requests are supported as rack side includes
+* Include requests should not return redirect response
+* There should be no ERB tags other than ones invoking *rsi_include*.
+
+License
+-------
+
+Copyright &copy; 2011 Ram Singla. Released under MIT License.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/TODO

@@ -0,0 +1,3 @@
+* Write Specs
+* Write More Documentation
+* Create an EM machine version which makes requests in Parallel.

data/examples/config.ru

@@ -0,0 +1,13 @@
+require "pathname"
+
+$LOAD_PATH.unshift(Pathname(__FILE__).expand_path.dirname)
+$LOAD_PATH.unshift(Pathname(__FILE__).expand_path.dirname.parent.join("lib"))
+
+require "rack/rsi"
+require "hello_world_app"
+
+use Rack::ShowExceptions
+use Rack::Runtime
+use Rack::RSI
+use Rack::CommonLogger
+run HelloWorldApp.new

data/examples/hello_world_app.rb

@@ -0,0 +1,51 @@
+require "rack"
+
+class HelloWorldApp
+
+  def call(env)
+    request  = Rack::Request.new(env)
+    response = Rack::Response.new
+
+    if request.path_info == "/"
+      action = "index"
+    else
+      action = request.path_info[1..-1].gsub(/\?.*$/, '')
+    end
+
+    if ACTIONS.include?(action)
+      send(action, request, response)
+    else
+      response.status = 404
+      response.write("404 Not Found")
+    end
+
+    response.finish
+  end
+
+  private
+
+  ACTIONS = %<index header footer>
+
+  def index(request, response)
+    response['rack.rsi'] = '1'
+    response['Cache-Control'] = 'max-age=3600'
+    response.write(%{
+      <title>HelloWorld</title>
+      <%= rsi_include( "/header?user=buzzmenot" ) %>
+      <p>Hello World!</p>
+      <%= rsi_include( "/footer?company=github" ) %>
+    }.gsub(/^\s*/, "").strip)
+  end
+
+  def header(request, response)
+    response['Cache-Control'] = 'max-age=60'
+    response.write( "Here comes header from Header Action exclusively for #{request.params['user']}" )
+  end
+
+  def footer(request, response)
+    response['Cache-Control'] = 'max-age=120'
+    response.write( "Here comes footer from Footer Action exclusively for #{request.params['company']}" )
+  end
+
+end
+

data/lib/rack/rsi.rb

@@ -0,0 +1,114 @@
+# Copyright Ram Singla (c) 2011.
+# Released under MIT License
+
+require 'rack'
+require 'erb'
+require 'uri'
+require 'digest/md5'
+require 'rack/rsi_version'
+
+class Rack::RSI
+
+  class Error < ::RuntimeError
+  end
+
+  class RsiRender
+
+    def initialize( app, env, level = 0 )
+      @app, @env, @level = app, env, level
+      @headers, @body = {}, {}
+    end
+
+    def rack_rsi?
+      @headers.values.select{ |x| x && x['rack.esi'] }.any?
+    end
+
+    def cache_control_headers
+      @headers.values.collect{ |x| ( x ? x['Cache-Control'] : nil ) || 'max-age=0' }
+    end
+
+    def get_binding
+      return binding( )
+    end
+
+    def rsi_include( source )
+      uri = URI.parse( source )
+      include_env = @env.merge( "PATH_INFO" => uri.path,
+                               "SCRIPT_NAME" => "",
+                               "QUERY_STRING" => uri.query,
+                               "REQUEST_METHOD" => "GET" )
+      begin
+        include_status, include_headers, include_body = @app.dup.call(include_env)
+        @headers[ source ] = include_headers
+        @body[ source ] = ( include_status == 200 ? include_body : [] )
+      rescue Exception => message
+        @body[ source ] = []
+      end
+      value = ''
+      @body[ source ].each{ |part| value << part }
+      value
+    end
+
+  end
+
+  def initialize( app )
+    @app = app
+  end
+
+  def call( env )
+    assemble_response( env )
+  end
+
+  # Assemble Response
+  def assemble_response( env )
+    vanilla_env = env.dup
+    vanilla_app = @app.dup
+
+    # calling app and env on orignal request
+    status, headers, enumerable_body = original_response = @app.call(env)
+
+    rack_rsi_flag = headers.delete('rack.rsi')
+    return original_response unless rack_rsi_flag
+
+    body = ""
+    enumerable_body.each do |part|
+      body << part
+    end
+
+    cache_control_headers = Array( headers.delete( 'Cache-Control' ) || "max-age=0" )
+
+    # Like Varnish supports upto 5 levels of ESI includes recursively
+    level = 0
+    while( rack_rsi_flag )
+      erb = ERB.new( body, 0 )
+      renderer = RsiRender.new( vanilla_app, vanilla_env, level )
+      body = erb.result( renderer.get_binding )
+      renderer.cache_control_headers.inject( cache_control_headers ){ |s,x| s.push( x ) }
+      rack_rsi_flag = renderer.rack_rsi?
+      level += 1
+    end
+
+    # Set ETag for the Request
+    headers['ETag'] = Digest::MD5.hexdigest( body )
+    headers.delete( 'Last-Modified' )
+
+    # 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
+    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"
+    headers.delete( 'Expires' )
+    headers['Expires'] = ( Time.now.utc + min_max_age ).strftime("%a, %d %m %Y %T %Z") if min_max_age > 0
+
+    # Create Correct Content-Length
+    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
+    # Cookies from the original action are passed on.
+    [ status, headers, [ body ] ]
+  end
+
+end
+

data/lib/rack/rsi_version.rb

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

data/rack-rsi.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/rsi_version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-rsi"
+  s.version     = Rack::RSI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ram Singla"]
+  s.email       = ["ram.singla@gmail.com"]
+  s.homepage    = "https://github.com/ramsingla/rack-rsi"
+  s.summary     = %q{Rack Middleware: Rack Side Include}
+  s.description = %q{Rack Side Include helps you assemble pages like Edge Side Include (ESI) using ERB tags.}
+
+  s.rubyforge_project = "rack-rsi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_rubygems_version = ">= 1.3.7"
+  s.add_dependency "rack"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: rack-rsi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ram Singla
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-13 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Rack Side Include helps you assemble pages like Edge Side Include (ESI) using ERB tags.
+email: 
+- ram.singla@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.markdown
+- README.markdown
+- Rakefile
+- TODO
+- examples/config.ru
+- examples/hello_world_app.rb
+- lib/rack/rsi.rb
+- lib/rack/rsi_version.rb
+- rack-rsi.gemspec
+has_rdoc: true
+homepage: https://github.com/ramsingla/rack-rsi
+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: 1.3.7
+requirements: []
+
+rubyforge_project: rack-rsi
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: "Rack Middleware: Rack Side Include"
+test_files: []
+