rack_page_cache 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+gem "rack"
+gem "mime-types"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler"
+  gem "jeweler"
+  gem 'simplecov', :require => false
+  gem "ruby-debug19"
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.0)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mime-types (1.18)
+    multi_json (1.3.4)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  mime-types
+  rack
+  ruby-debug19
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 radiospiel
+
+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.rdoc

@@ -0,0 +1,19 @@
+= simple_cache
+
+Description goes here.
+
+== Contributing to simple_cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 radiospiel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rack_page_cache"
+  gem.homepage = "http://github.com/radiospiel/rack_page_cache"
+  gem.license = "MIT"
+  gem.summary = %Q{A rack middleware to cache requests in static files, a la Rails' page_cache}
+  gem.description = %Q{A rack middleware to cache requests in static files, a la Rails' page_cache}
+  gem.email = "eno@open-lab.org"
+  gem.authors = ["radiospiel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

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

data/lib/rack/page_cache.rb

@@ -0,0 +1,66 @@
+require 'rack'
+require 'mime/types'
+require 'fileutils'
+
+# PageCache is a Rack middleware that caches responses for successful GET requests
+# to disk. This works similar to Rails' page caching, allowing you to cache dynamic
+# pages to static files that can be served directly by a front end webserver.
+class Rack::PageCache
+  # Initialize a new ReponseCache object with the given arguments.  Arguments:
+  # * app : The next middleware in the chain.  This is always called.
+  # * cache : all cached files will use this directory as the root directory.
+  def initialize(app, cache, &block)
+    @app = app
+    @cache = cache.sub(/\/*$/, "/") # normalize path to have a single trailing slash.
+  end
+
+  def call(env)
+    res = @app.call(env)
+    page_cache(env, res)
+    res
+  end
+  
+  def page_cache(env, res)
+    # If the request was successful (response status 200), was a GET request, and
+    # had an empty query string, this request is probably cacheable.
+    return res unless env['REQUEST_METHOD'] == 'GET' and res[0] == 200 and env['QUERY_STRING'] == ""
+    
+    # But the content_type, that can be derived from the request path - and is what
+    # the web server would use in the next request - must match the content type
+    # in the response.
+    return unless matching_content_type?(env, res)
+
+    # Build path for cache file. The path must not contain '..', to prevent directory
+    # traversal attacks.
+    path = env['PATH_INFO']
+    return if path.include?('..')
+    
+    # We cannot use File.join here, because this would eat the double slashes in the path_info.
+    # The @cache instance variable, however, is normalized to end in a single slash.
+    path = "#{@cache}/#{path}" 
+    
+    # If the cache file exists already, then we run inside rackup. 
+    # The cached file will be delivered by Rack::Static, and we don't need
+    # (and don't want to: this zeroes the file, for some reason) to rewrite the path
+    return if File.exists?(path)
+    
+    FileUtils.mkdir_p(File.dirname(path))
+    File.open(path, 'wb') do |f| 
+      res[2].each do |c| 
+        f.write(c)
+      end
+    end
+  end
+
+  def matching_content_type?(env, res)
+    return unless content_type = res[1]['Content-Type']
+    
+    path_info = env['PATH_INFO']
+    mime_types = MIME::Types.type_for(path_info)
+    mime_types = [ "text/html" ] if mime_types.empty?
+
+    mime_types.any? do |mime_type|
+      content_type.index(mime_type)
+    end
+  end 
+end

data/test/page_cache_test.rb

@@ -0,0 +1,8 @@
+require_relative 'test_helper'
+
+class PageCacheTest < Test::Unit::TestCase
+  def test_page_cache
+    Rack::PageCache
+    assert false, "Implement me"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'ruby-debug'
+require 'simplecov'
+require 'test/unit'
+SimpleCov.start do
+  add_filter "test/*.rb"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rack/page_cache'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rack_page_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70256037206540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256037206540
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &70256037205700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256037205700
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70256037204860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256037204860
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70256037203940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256037203940
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70256037202780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256037202780
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70256037202000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256037202000
+description: A rack middleware to cache requests in static files, a la Rails' page_cache
+email: eno@open-lab.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/page_cache.rb
+- test/page_cache_test.rb
+- test/test_helper.rb
+homepage: http://github.com/radiospiel/rack_page_cache
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1645301882133738243
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A rack middleware to cache requests in static files, a la Rails' page_cache
+test_files: []