ventilation 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.yardoc
+
+## PROJECT::SPECIFIC

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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,40 @@
+Ventilation
+===========
+
+Ventilation makes developing with ESI a snap.
+
+ESI helps scale your website by allowing you to break it down into fragments
+which can be cached independently and reconstructed on the fly. This allows
+your server to spend the majority of its time creating the truly dynamic
+sections of your site and the rest to be reused and mixed in at the edge.
+
+Using ESI means you need to develop behind varnish or something capable of
+composing the response.  Ventilation however, removes this dependecny which
+means you can develop with esi using nothing more the script/server. There is
+no need to run a local varnish server (you still can if you want to).
+Ventilation will automatically compose the page as if it was run through
+varnish while you are in development.  When you move out of development or put
+your ventilation powered application behind varnish the composed content will
+be replaced with esi tags allowing varnish to work it's magic.
+
+WARNING: Using Varnish without Ventilation may result in death!
+
+Example
+=======
+
+Include from a content delivery network.
+
+    <%= esi "http://cdn.megadomain.com/network_nav" %>
+
+Include from somewhere else within your application.
+
+    <%= esi :header %>
+    <%= esi :header, :controller => :site %>
+
+Copyright (c) 2010 [name of plugin creator], released under the MIT license
+
+Resources
+=========
+  * [Ventilation Home](http://github.com/agoragames/ventilation)
+  * [ESI Language Specification 1.0](http://www.w3.org/TR/esi-lang)
+  * [Edge Side Includes - Wikipedia](http://en.wikipedia.org/wiki/Edge_Side_Includes)

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ventilation"
+    gem.summary = %Q{Fancy ESI integration for your high prefomance web apps.}
+    gem.description = %Q{Helper methods for building esi tags, simplifies development bypassing the need for varnish.}
+    gem.email = "btaylor@agoragames.com"
+    gem.homepage = "http://github.com/agoragames/ventilation"
+    gem.authors = ["Blake Taylor"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Test ventilation.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+task :test => :check_dependencies
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ventilation #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'ventilation'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/helpers/esi_helper.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'uri'
+require 'action_controller'
+require 'ventilation/deep_stack'
+
+module Ventilation
+  module EsiHelper
+
+    # Render resource on the edge
+    def esi(resource, options = {})
+      env = ENV['RAILS_ENV']
+
+      # If we were passed a url...
+      if resource =~ /^(http:\/\/)?[a-zA-Z0-9\-\.]+\.(com|org|net|mil|edu)[a-zA-Z0-9\-\.\/]+$/i
+        # ...fetch and render an external resource...
+        case env
+        when 'production'
+          %%<esi:include src="#{resource}" />%
+        else
+          url = URI.parse(resource)
+          res = Net::HTTP.start(url.host, url.port) {|http|
+            http.get(url.path)
+          }
+          res.body
+        end
+      else
+        # ...otherwise render as an action.
+        case env
+        when 'production'
+          %%<esi:include src="#{url_for url_options.merge(:action => resource)}" />%
+        else
+          if controller = options[:controller]
+            controller = "#{controller.to_s.camelcase}Controller".constantize
+          else
+            controller = @controller.class
+          end
+          deep_stack = DeepStack.new(controller)
+          action = resource
+          deep_stack.get(action).body
+        end
+      end
+    end
+  end
+end
+
+# Include EsiHelper in the Application
+module ApplicationHelper
+  include Ventilation::EsiHelper
+end

data/lib/tasks/ventilation.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ventilation do
+#   # Task goes here
+# end

data/lib/ventilation/deep_stack.rb

@@ -0,0 +1,19 @@
+module Ventilation
+  # Simulate concurrency by serving request recursively.
+  class DeepStack
+    include ActionController::TestProcess
+
+    def initialize(controller_class)
+      @request = ActionController::TestRequest.new
+      @response = ActionController::TestResponse.new
+
+      @controller = controller_class.new
+
+      if @controller
+        @controller.request = @request
+        @controller.params = {}
+        @controller.send(:initialize_current_url)
+      end
+    end
+  end
+end

data/lib/ventilation.rb

@@ -0,0 +1 @@
+require 'app/helpers/esi_helper'

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ventilation'
+
+class Test::Unit::TestCase
+end

data/test/ventilation_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+require 'ventilation/deep_stack'
+
+class TestVentilation < Test::Unit::TestCase
+
+  context "a test consumer"do
+    setup do
+      FakeWeb.allow_net_connect = false
+      @consumer = TestConsumer.new
+    end
+
+    should "render external resource" do
+      expected = "response_from_example.com"
+      FakeWeb.register_uri(:get, "http://example.com/", :body => expected)
+
+      actual = @consumer.esi 'http://example.com/'
+
+      assert_equal expected, actual, "Expected response was not rendered by esi method"
+    end
+
+    should "use DeepStack to render internal resource" do
+      expected = 'rendered string'
+      response = mock()
+      response.expects(:body).returns(expected)
+      deep_stack = mock()
+      deep_stack.expects(:get).with(:index).returns(response)
+      Ventilation::DeepStack.expects(:new).with(WelcomeController).returns(deep_stack)
+
+      actual = @consumer.esi :index, :controller => :welcome
+
+      assert_equal expected, actual
+    end
+
+  end
+
+end
+ # A consumer of the ApplicationHelper for testing purposes.
+class TestConsumer
+  include ApplicationHelper
+end
+
+class WelcomeController
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

data/ventilation.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ventilation}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blake Taylor"]
+  s.date = %q{2010-09-24}
+  s.description = %q{Helper methods for building esi tags, simplifies development bypassing the need for varnish.}
+  s.email = %q{btaylor@agoragames.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/app/helpers/esi_helper.rb",
+     "lib/tasks/ventilation.rake",
+     "lib/ventilation.rb",
+     "lib/ventilation/deep_stack.rb",
+     "test/test_helper.rb",
+     "test/ventilation_test.rb",
+     "uninstall.rb",
+     "ventilation.gemspec"
+  ]
+  s.homepage = %q{http://github.com/agoragames/ventilation}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Fancy ESI integration for your high prefomance web apps.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/ventilation_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: ventilation
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Blake Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id003
+description: Helper methods for building esi tags, simplifies development bypassing the need for varnish.
+email: btaylor@agoragames.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/app/helpers/esi_helper.rb
+- lib/tasks/ventilation.rake
+- lib/ventilation.rb
+- lib/ventilation/deep_stack.rb
+- test/test_helper.rb
+- test/ventilation_test.rb
+- uninstall.rb
+- ventilation.gemspec
+has_rdoc: true
+homepage: http://github.com/agoragames/ventilation
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Fancy ESI integration for your high prefomance web apps.
+test_files: 
+- test/test_helper.rb
+- test/ventilation_test.rb