rack_ssi 0.0.2

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,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-ssi.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thibaut Sacreste
+
+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,39 @@
+# Rack::SSI
+
+Rack middleware for processing SSI based on the [nginx HttpSsiModule](http://wiki.nginx.org/HttpSsiModule).
+Directives currently supported: `block` and `include`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack_ssi', :git => "git@github.com:forward/rack-ssi.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_ssi
+
+## Usage
+
+    require 'rack_ssi'
+    
+### Sinatra
+
+    configure do
+      use Rack::SSI, {
+        :logging => :on,
+        :when => lambda {|env| not env['SOME_CUSTOM_HEADER'] == 'ON'},
+        :locations => {
+          %r{^/includes} => "http://includes.mydomain.com"
+        }
+      }
+    end
+    
+### Rails
+
+    config.middleware.use Rack::SSI, { ... }    
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rack_ssi.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../ssi_processor', __FILE__)
+require 'rest_client'
+require 'logger'
+
+module Rack
+  class SSI
+    
+    def initialize(app, options = {})
+      @app = app
+      @logging = options[:logging] == :on
+      @locations = options[:locations] || {}
+      @predicate = options[:when] || lambda {|_| true}
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      unprocessed = [status, headers, body]
+      
+      return unprocessed unless @predicate.call(env)
+      return unprocessed unless headers["Content-Type"] && headers["Content-Type"].include?("text/html")
+      return unprocessed unless status == 200
+      
+      ssi = Rack::SSIProcessor.new
+      ssi.locations = @locations
+      ssi.logger = logger(env) if @logging
+      new_body = ssi.process(body)      
+      headers["Content-Length"] = (new_body.reduce(0) {|sum, part| sum + part.bytesize}).to_s
+
+      [status, headers, new_body]
+    end
+    
+    private
+    def logger(env)
+      if defined?(Rails)
+        return Rails.logger
+      end
+      env['rack.logger']
+    end
+
+  end
+end

data/lib/ssi_processor.rb

@@ -0,0 +1,69 @@
+module Rack
+  class SSIProcessor
+    
+    attr_accessor :logger, :locations
+    
+    def process(body)
+      # see http://wiki.nginx.org/HttpSsiModule
+      # currently only supporting 'block' and 'include' directives
+      blocks = {}
+      output = []
+      body.each do |part|
+        new_part = process_block(part) {|name, content| blocks[name] = content}
+        output << process_include(new_part, blocks)
+      end
+      output
+    end
+    
+    def process_block(part)
+      part.gsub(/<!--#\s+block\s+name="(\w+)"\s+-->(.*?)<!--#\s+endblock\s+-->/) do
+        name, content = $1, $2
+        _info "processing block directive with name=#{name}"
+        yield [name, content]
+        ""
+      end
+    end
+    
+    def process_include(part, blocks)
+      part.gsub(/<!--#\s+include\s+(?:virtual|file)="([^"]+)"(?:\s+stub="(\w+)")?\s+-->/) do
+        location, stub = $1, $2
+        _info "processing include directive with location=#{location}"
+        status, _, body = fetch location
+        if stub && (status != 200 || body.nil? || body == "")
+          blocks[stub] 
+        else
+          body
+        end
+      end
+    end
+    
+    def fetch(location)
+      locations.select{|k,v| k.is_a?(String)}.each do |pattern, host|
+        return _get("#{host}#{location}") if location == pattern
+      end
+      locations.select{|k,v| k.is_a?(Regexp)}.each do |pattern, host|
+        return _get("#{host}#{location}") if location =~ pattern
+      end
+      _error "no match found for location=#{location}"
+    end
+    
+    private
+    
+    def _get(url)
+      _info "fetching #{url}"
+      RestClient.get(url) do |response, request, result|
+        _error "error fetching #{url}: #{response.code} response" if response.code != 200
+        [response.code, response.headers, response.body]
+      end
+    end
+    
+    def _info(message)
+      logger.info "Rack::SSI #{message}" if logger
+    end
+
+    def _error(message)
+      logger.info "Rack::SSI #{message}" if logger
+    end
+    
+  end
+end

data/rack-ssi.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thibaut Sacreste"]
+  gem.email         = ["thibaut.sacreste@gmail.com"]
+  gem.description   = <<-EOS
+    Rack middleware for processing SSI based on the nginx HttpSsiModule.
+    Directives currently supported: 'block' and 'include'
+  EOS
+  gem.summary       = "Rack middleware for processing SSI based on the nginx HttpSsiModule."
+  gem.homepage      = "https://github.com/forward/rack-ssi"
+
+  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.name          = "rack_ssi"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.2"
+  gem.add_dependency "rest-client"
+end

data/spec/rack_ssi_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Rack::SSI do
+  describe "#call" do
+
+    it "should not process response if the when predicate returns false" do
+      app = double
+      body = ["I am a response"]      
+      app.stub(:call).and_return([200, {"Content-Type" => ["text/html"]}, body])
+      rack_ssi = Rack::SSI.new(app, :when => lambda {|env| false })
+      
+      Rack::SSIProcessor.any_instance.should_not_receive(:process).and_return([""])
+      
+      rack_ssi.call({})
+    end
+
+    it "should process response if the when predicate returns true" do
+      app = double
+      body = ["I am a response"]      
+      app.stub(:call).and_return([200, {"Content-Type" => ["text/html"]}, body])
+      rack_ssi = Rack::SSI.new(app, :when => lambda {|env| true })
+      
+      Rack::SSIProcessor.any_instance.should_receive(:process).with(body).once.and_return([""])
+      
+      rack_ssi.call({})
+    end
+  
+    it "should process html responses only" do
+      app = double
+      body = ["I am a response"]      
+      app.stub(:call).and_return(
+        [200, {"Content-Type" => ["text/html"]}, body],
+        [200, {"Content-Type" => ["text/css"]}, []])
+      rack_ssi = Rack::SSI.new(app)
+      
+      Rack::SSIProcessor.any_instance.should_receive(:process).with(body).once.and_return([""])      
+      
+      rack_ssi.call({})
+    end
+    
+    it "should process 200 responses only" do
+      app = double
+      body = ["I am a response"]      
+      app.stub(:call).and_return(
+        [200, {"Content-Type" => ["text/html"]}, body],
+        [500, {"Content-Type" => ["text/html"]}, []])
+      rack_ssi = Rack::SSI.new(app)
+      
+      Rack::SSIProcessor.any_instance.should_receive(:process).with(body).once.and_return([""])      
+      
+      rack_ssi.call({})
+    end
+    
+    it "should return the processed response and update the Content-Length header" do
+      body = ["I am a response"]
+      app = double(:call => [200, {"Content-Type" => ["text/html"], "Content-Length" => "15"}, body])
+      rack_ssi = Rack::SSI.new(app)
+      Rack::SSIProcessor.any_instance.stub(:process => ["I am a bigger response"])
+      
+      _, headers, new_body = rack_ssi.call({})
+      
+      new_body.should == ["I am a bigger response"]
+      headers["Content-Length"].should == "22"
+    end
+  
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path('../../lib/rack_ssi', __FILE__)

data/spec/ssi_processor_spec.rb

@@ -0,0 +1,197 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Rack::SSIProcessor do
+  
+  describe "#process_block" do
+    it "should yield block directives and strip them out of the html" do
+      html = <<-eos
+        <html>
+          <body>
+            <!--# block name="shush" --><!--# endblock -->
+            <p>some content</p>
+            <!--# block name="shouty" --><h1>ERROR!</h1><!--# endblock -->
+          </body>
+        </html>
+      eos
+      
+      expected = <<-eos.gsub /\s+/, ""
+        <html>
+          <body>
+            <p>some content</p>
+          </body>
+        </html>
+      eos
+     
+      ssi = Rack::SSIProcessor.new
+      blocks = []
+
+      processed = ssi.process_block(html) {|block| blocks << block}
+
+      processed.gsub(/\s+/, "").should == expected
+      blocks.should == [["shush", ""], ["shouty", "<h1>ERROR!</h1>"]]      
+    end
+  end
+  
+  describe "#process_include" do
+    context "the SSI include request returns a valid response" do
+      it "should replace include directives with appropriate content" do
+        html = <<-eos
+          <html>
+            <body>
+              <!--# include virtual="/some/location" -->
+              <!--# include virtual="/some/other/location" -->
+            </body>
+          </html>
+        eos
+      
+        expected = <<-eos.gsub /\s+/, ""
+          <html>
+            <body>
+              <p>some content</p>
+              <p>some more content</p>
+            </body>
+          </html>
+        eos
+     
+        ssi = Rack::SSIProcessor.new
+        ssi.stub(:fetch).with("/some/location").and_return([200, {}, "<p>some content</p>"])
+        ssi.stub(:fetch).with("/some/other/location").and_return([200, {}, "<p>some more content</p>"])
+
+        processed = ssi.process_include(html, {})
+
+        processed.gsub(/\s+/, "").should == expected
+      end
+    end
+    
+    context "the SSI include request returns an empty response" do
+      it "should replace include directives with the content of the block specified by the 'stub' parameter" do
+        html = <<-eos
+          <html>
+            <body>
+              <!--# include virtual="/some/broken/location" stub="oops" -->
+            </body>
+          </html>
+        eos
+      
+        expected = <<-eos.gsub /\s+/, ""
+          <html>
+            <body>
+              <p>oops, something went wrong!</p>
+            </body>
+          </html>
+        eos
+     
+        ssi = Rack::SSIProcessor.new
+        ssi.stub(:fetch).with("/some/broken/location").and_return([200, {}, ""])
+
+        processed = ssi.process_include(html, {"oops" => "<p>oops, something went wrong!</p>"})
+
+        processed.gsub(/\s+/, "").should == expected
+      end
+      
+      it "should replace include directives with the empty response if no 'stub' parameter" do
+        html = <<-eos
+          <html>
+            <body>
+              <!--# include virtual="/some/broken/location" -->
+            </body>
+          </html>
+        eos
+        
+        ssi = Rack::SSIProcessor.new
+        ssi.stub(:fetch).with("/some/broken/location").and_return([200, {}, ""])
+
+        processed = ssi.process_include(html, {})
+
+        processed.gsub(/\s+/, "").should == "<html><body></body></html>"
+      end
+    end
+    
+    context "the SSI include request returns an error response" do
+      it "should replace include directives with the content of the block specified by the 'stub' parameter" do
+        html = <<-eos
+          <html>
+            <body>
+              <!--# include virtual="/some/broken/location" stub="oops" -->
+            </body>
+          </html>
+        eos
+      
+        expected = <<-eos.gsub /\s+/, ""
+          <html>
+            <body>
+              <p>oops, something went wrong!</p>
+            </body>
+          </html>
+        eos
+     
+        ssi = Rack::SSIProcessor.new
+        ssi.stub(:fetch).with("/some/broken/location").and_return([500, {}, "<crap>"])
+
+        processed = ssi.process_include(html, {"oops" => "<p>oops, something went wrong!</p>"})
+
+        processed.gsub(/\s+/, "").should == expected
+      end
+      
+      it "should replace include directives with the error response if no 'stub' parameter" do
+        html = <<-eos
+          <html>
+            <body>
+              <!--# include virtual="/some/broken/location" -->
+            </body>
+          </html>
+        eos
+        
+        ssi = Rack::SSIProcessor.new
+        ssi.stub(:fetch).with("/some/broken/location").and_return([500, {}, "<bang>"])
+
+        processed = ssi.process_include(html, {})
+
+        processed.gsub(/\s+/, "").should == "<html><body><bang></body></html>"
+      end
+    end
+    
+  end
+  
+  describe "#fetch" do
+    it "should resolve locations by exact match first" do
+      ssi = Rack::SSIProcessor.new
+      ssi.locations = {
+        /\/pants/ => "http://host1",
+        "/pants" => "http://host2"
+      }
+      
+      RestClient.should_receive(:get).with("http://host2/pants")
+      ssi.fetch("/pants")      
+    end
+    
+    it "should resolve locations by regex if no exact match" do
+      ssi = Rack::SSIProcessor.new
+      ssi.locations = {
+        /^\/pants\/.*/ => "http://host1",
+        "/pants" => "http://host2"
+      }
+      
+      RestClient.should_receive(:get).with("http://host1/pants/on/fire")
+      ssi.fetch("/pants/on/fire")      
+    end
+  end
+  
+  describe "#process" do
+    it "should do it all!" do
+      body = [
+        '<html><body>',
+        '<!--# block name="shouty" --><p>ERROR!</p><!--# endblock -->',
+        '<!--# include virtual="/includes/broken" stub="shouty" -->',
+        '<!--# include virtual="/includes/header" -->',
+        '</body></html>'
+      ]
+      ssi = Rack::SSIProcessor.new
+      ssi.stub(:fetch).with("/includes/broken").and_return([500, {}, "<p>pants!</p>"])
+      ssi.stub(:fetch).with("/includes/header").and_return([200, {}, "<h1>Hello</h1>"])
+      
+      ssi.process(body).join.should == "<html><body><p>ERROR!</p><h1>Hello</h1></body></html>"
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: rack_ssi
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Thibaut Sacreste
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "    Rack middleware for processing SSI based on the nginx HttpSsiModule.\n    Directives currently supported: 'block' and 'include'\n"
+email: 
+- thibaut.sacreste@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack_ssi.rb
+- lib/ssi_processor.rb
+- rack-ssi.gemspec
+- spec/rack_ssi_spec.rb
+- spec/spec_helper.rb
+- spec/ssi_processor_spec.rb
+homepage: https://github.com/forward/rack-ssi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware for processing SSI based on the nginx HttpSsiModule.
+test_files: 
+- spec/rack_ssi_spec.rb
+- spec/spec_helper.rb
+- spec/ssi_processor_spec.rb