rack-cache 1.2 → 1.3.0

data/doc/rack-cache.css

@@ -1,362 +0,0 @@
-/* rack-cache.css
- *---------------------------------------------------------------------------
- * Copyright (C) 2005-08 Ryan Tomayko <r@tomayko.com>
- */
-
-
-/* 18px base font size / 25px baseline */
-body {
-	font-size:112.5%;   /* 18px (probably) */
-	line-height:1.3888; /* 25px */
-	letter-spacing:-0.02em;
-	margin:0 10px;
-	font-family: 'lucida sans unicode', 'lucida grande',
-		helvetica, 'bitstream vera sans', sans-serif;
-	color:#556;
-	background-color:#fff;
-}
-
-#container {
-	max-width:45em;
-	margin:0 auto;
-}
-
-h1, h2, h3 {
-	font-family:georgia, 'bitstream vera sans serif', 'lucida grande',
-		helvetica, verdana, sans-serif;
-	font-weight:normal;
-	letter-spacing:-0.05em;
-	color:#000;
-}
-i, em {
-	font-style:italic;
-}
-b, strong {
-	font-weight:normal;
-	color:#000;
-}
-blockquote {
-	color:#555;
-}
-blockquote em {
-	color:#333;
-	font-style:italic;
-}
-blockquote strong {
-	color:#333;
-	font-weight: normal;
-}
-dt {
-	font-weight:bold;
-	color:#000;
-}
-tt, pre, code, samp, kbd {
-	font-family: consolas, 'lucida console', 'bitstream vera sans mono',
-		'courier new', monospace;
-	color: #000;
-}
-pre {
-	color:#333;
-	background-color:#f9f9f9;
-}
-code {
-	color:#007A00;
-}
-pre code {
-	color:#333;
-}
-pre.license {
-	border:0;
-	background:#fff;
-	padding:0;
-	font-size:1.1em;
-}
-a, a:link {
-	color:#023;
-	background:#eef;
-}
-a:visited {
-	color:#345;
-	background:#fff;
-}
-a:hover {
-	background:#ccf;
-	color:#000;
-	text-decoration:none;
-}
-
-
-/* TYPOGRAPHY */
-
-p, ul, ol, dl, pre, blockquote, table, form {
-	margin:1em 0;
-}
-dl {
-	margin-left:2em;
-}
-hr {
-	color:#eee;
-	background-color:#ccc;
-	border:0;
-	height:1px;
-	margin:1.5em 0;
-}
-blockquote {
-	font-size:0.83333em;  /* 15px */
-	line-height:1.66666;   /* 25px */
-	margin:1.2em 3em;
-	padding:0;
-}
-tt, pre, code, samp, kbd {
-	font-size: 16px;
-	line-height:1.1;
-}
-pre {
-	margin:1.5em 0;
-	padding:6px 4px 4px 6px;
-	border:1px solid #eee;
-	border-left-width:20px;
-	overflow:auto;
-}
-h1 {
-	font-size:2.3333em;      /* 42px */
-	line-height:1.1904;      /* 50px */
-	margin:0.5952em 0;       /* 25px */
-}
-h2 {
-	font-size:1.66666667em;  /* 30px */
-	line-height:1.2;         /* 36px */
-	margin:1em 0;
-}
-h3 {
-	font-size:1.33333333em;  /* 22px */
-	line-height:1.13636363;  /* 25px */
-	margin:1em 0;
-}
-h3 code{
-	font-size:0.95em;
-	color:#000;
-}
-h4 {
-	font-size:1em;
-	font-weight:bold;
-	line-height:1.5;
-	margin:1em 0;
-}
-p small {
-	font-size:0.8333;       /* 15px */
-	line-height:1.2;
-}
-
-/* Tables
---------------------------------------------------------------------------- */
-
-table {
-	width:100%;
-	border-style:none;
-	border-color:#ddd;
-	padding:0;
-}
-
-th, td {
-	padding: 4px 10px 4px 5px;
-	border-style:solid;
-	border-color:#fff;
-}
-
-th {
-	font-weight: bold;
-	background: #eef;
-}
-
-td {
-	background: #f9f9f9;
-}
-
-tfoot {
-	font-style: italic;
-}
-
-caption {
-	background: #eee;
-}
-
-/* Header / Titling
---------------------------------------------------------------------------- */
-
-#header {
-	text-align:left;
-	margin:1.5em auto 2em;
-	float:left;
-	width:100%;
-	padding-bottom:1.5em;
-	border-bottom:1px solid #777;
-}
-#header h1 {
-	font-family: 'lucida sans unicode', 'lucida grande',
-		helvetica, 'bitstream vera sans', sans-serif;
-	font-size:5em;
-	font-weight:bold;
-	line-height:1;
-	margin:0;
-	float:left;
-	color:#000;
-	letter-spacing:-0.08em;
-}
-#header h1 a, #header h1 a:link, #header h1 a:visited, #header h1 a:hover {
-	color:#000;
-	text-decoration:none;
-	background:transparent;
-}
-#header p {
-	margin: 0;
-	line-height:1.8;
-	color: #777;
-	text-transform:capitalize;
-	font-variant:small-caps;
-	float:right;
-}
-#header a, #header a:link, #header a:visited {
-	color:#445;
-	background:#fff;
-}
-#header a:hover {
-	background:#ccf;
-	color:#000;
-	text-decoration:none;
-}
-#content {
-	clear:both;
-}
-
-/* FOOTER */
-
-#footer {
-	clear:both;
-	color:#555;
-	font-size:0.88888888em;
-	line-height:1.5625;
-	border-top:1px solid #ddd;
-	padding:19px 0 0 0;
-	margin:40px 0 20px 0;
-	text-align:center;
-}
-#footer p {
-	margin:0;
-}
-#footer form {
-	float:right;
-}
-#footer input{
-	font-size:10px;
-}
-
-/* MISC HELPER STYLES */
-
-ul.clean, ol.clean {
-	list-style-type: none;
-	padding-left: 0;
-}
-.caps {
-	font-variant:small-caps;
-}
-.clear {
-	clear:both;
-}
-.left{
-	float:left;
-}
-.right{
-	float:right;
-}
-.center{
-	text-align:center;
-}
-.intro {
-	font-size:0.833333em;  /* 15px */
-	line-height:1.666667;  /* 25px */
-	border:1px solid #ccc;
-	padding:0.5em;
-	font-style:italic;
-	color:#555;
-}
-a.hash,
-a.hash:link,
-a.hash:visited {
-	display:block;
-	float:right;
-	background:#fff;
-	font-size:0.8em;
-	text-decoration:none;
-	line-height:2;
-	color:#999;
-}
-a.hash:hover {
-	color:MediumOrchid;
-}
-
-/* PRINT */
-
-@media print {
-	html, body, #container {
-		margin:0;
-	}
-	#container {
-		width:100%;
-		max-width:100%;
-	}
-	#header {
-		margin-top:0;
-	}
-	#header p {
-		display:none;
-	}
-	#footer {
-		display:none;
-	}
-	a, a:link, a:visited {
-		color:#000;
-		background:#fff;
-		text-decoration:none;
-	}
-	pre.license {
-		font-size:0.95em;
-	}
-	@page {
-		size:8.5in 11in;
-	}
-}
-
-/* PRETTIFICATION OF SOURCE CODE */
-
-.str { color: #181; font-style:italic; }
-.kwd { color: #369; }
-.com { color: #666; }
-.typ { color: #c40; }
-.lit { color: #900; }
-.pun { color: #000; font-weight: bold; }
-.pln { color: #333; }
-.tag { color: #369; font-weight: bold; }
-.atn { color: #939; font-weight: bold }
-.atv { color: #181; }
-.dec { color: #606; }
-
-@media print {
-	.str { color: #060; }
-	.kwd { color: #006; font-weight: bold; }
-	.com { color: #600; font-style: italic; }
-	.typ { color: #404; font-weight: bold; }
-	.lit { color: #044; }
-	.pun { color: #440; }
-	.pln { color: #000; }
-	.tag { color: #006; font-weight: bold; }
-	.atn { color: #404; }
-	.atv { color: #060; }
-}
-
-/* FUCKING IE */
-
-* html body{width:40em}
-* html div.index{width:34.5em}
-
-/* vim: set ft=css ts=4 sw=4 noexpandtab: */

data/doc/server.ru

@@ -1,34 +0,0 @@
-# Rackup config that serves the contents of Rack::Cache's
-# doc directory. The documentation is rebuilt on each request.
-
-# Rewrites URLs like conventional web server configs.
-class Rewriter < Struct.new(:app)
-  def call(env)
-    if env['PATH_INFO'] =~ /\/$/
-      env['PATH_INFO'] += 'index.html'
-    elsif env['PATH_INFO'] !~ /\.\w+$/
-      env['PATH_INFO'] += '.html'
-    end
-    app.call(env)
-  end
-end
-
-# Rebuilds documentation on each request.
-class DocBuilder < Struct.new(:app)
-  def call(env)
-    if env['PATH_INFO'] !~ /\.(css|js|gif|jpg|png|ico)$/
-      env['rack.errors'] << "*** rebuilding documentation (rake -s doc)\n"
-      system "rake -s doc"
-    end
-    app.call(env)
-  end
-end
-
-use Rack::CommonLogger
-use DocBuilder
-use Rewriter
-use Rack::Static, :root => File.dirname(__FILE__), :urls => ["/"]
-
-run(lambda{|env| [404,{},'<h1>Not Found</h1>']})
-
-# vim: ft=ruby

data/doc/storage.markdown

@@ -1,164 +0,0 @@
-Storage
-=======
-
-__Rack::Cache__ runs within each of your backend application processes and does not
-rely on a single intermediary process like most types of proxy cache
-implementations. Because of this, the storage subsystem has implications on not
-only where cache data is stored but whether the cache is properly distributed
-between multiple backend processes. It is highly recommended that you read and
-understand the following before choosing a storage implementation.
-
-Storage Areas
--------------
-
-__Rack::Cache__ stores cache entries in two separate configurable storage
-areas: a _MetaStore_ and an _EntityStore_.
-
-The _MetaStore_ keeps high level information about each cache entry, including
-the request/response headers and other status information. When a request is
-received, the core caching logic uses this meta information to determine whether
-a fresh cache entry exists that can satisfy the request.
-
-The _EntityStore_ is where the actual response body content is stored. When a
-response is entered into the cache, a SHA1 digest of the response body content
-is calculated and used as a key. The entries stored in the MetaStore reference
-their response bodies using this SHA1 key.
-
-Separating request/response meta-data from response content has a few important
-advantages:
-
-  * Different storage types can be used for meta and entity storage. For
-    example, it may be desirable to use memcached to store meta information
-    while using the filesystem for entity storage.
-
-  * Cache entry meta-data may be retrieved quickly without also retrieving
-    response bodies. This avoids significant overhead when the cache misses
-    or only requires validation.
-
-  * Multiple different responses may include the same exact response body. In
-    these cases, the actual body content is stored once and referenced from
-    each of the meta store entries.
-
-You should consider how the meta and entity stores differ when choosing a storage
-implementation. The MetaStore does not require nearly as much memory as the
-EntityStore and is accessed much more frequently. The EntityStore can grow quite
-large and raw performance is less of a concern. Using a memory based storage
-implementation (`heap` or `memcached`) for the MetaStore is strongly advised,
-while a disk based storage implementation (`file`) is often satisfactory for
-the EntityStore and uses much less memory.
-
-Storage Configuration
----------------------
-
-The MetaStore and EntityStore used for a particular request is determined by
-inspecting the `rack-cache.metastore` and `rack-cache.entitystore` Rack env
-variables. The value of these variables is a URI that identifies the storage
-type and location (URI formats are documented in the following section).
-
-The `heap:/` storage is assumed if either storage type is not explicitly
-provided. This storage type has significant drawbacks for most types of
-deployments so explicit configuration is advised.
-
-The default metastore and entitystore values can be specified when the
-__Rack::Cache__ object is added to the Rack middleware pipeline as follows:
-
-    use Rack::Cache,
-      :metastore => 'file:/var/cache/rack/meta',
-      :entitystore => 'file:/var/cache/rack/body'
-
-Alternatively, the `rack-cache.metastore` and `rack-cache.entitystore`
-variables may be set in the Rack environment by an upstream component.
-
-Storage Implementations
------------------------
-
-__Rack::Cache__ includes meta and entity storage implementations backed by local
-process memory ("heap storage"), the file system ("disk storage"), and
-memcached. This section includes information on configuring __Rack::Cache__ to
-use a specific storage implementation as well as pros and cons of each.
-
-### Heap Storage
-
-Uses local process memory to store cached entries.
-
-    use Rack::Cache,
-      :metastore   => 'heap:/',
-      :entitystore => 'heap:/'
-
-The heap storage backend is simple, fast, and mostly useless. All cache
-information is stored in each backend application's local process memory (using
-a normal Hash, in fact), which means that data cached under one backend is
-invisible to all other backends. This leads to low cache hit rates and excessive
-memory use, the magnitude of which is a function of the number of backends in
-use. Further, the heap storage provides no mechanism for purging unused entries
-so memory use is guaranteed to exceed that available, given enough time and
-utilization.
-
-Use of heap storage is recommended only for testing purposes or for very
-simple/single-backend deployment scenarios where the number of resources served
-is small and well understood.
-
-### Disk Storage
-
-Stores cached entries on the filesystem.
-
-    use Rack::Cache,
-      :metastore   => 'file:/var/cache/rack/meta',
-      :entitystore => 'file:/var/cache/rack/body'
-
-The URI may specify an absolute, relative, or home-rooted path:
-
-  * `file:/storage/path` - absolute path to storage directory.
-  * `file:storage/path` - relative path to storage directory, rooted at the
-    process's current working directory (`Dir.pwd`).
-  * `file:~user/storage/path` - path to storage directory, rooted at the
-    specified user's home directory.
-  * `file:~/storage/path` - path to storage directory, rooted at the current
-    user's home directory.
-
-File system storage is simple, requires no special daemons or libraries, has a
-tiny memory footprint, and allows multiple backends to share a single cache; it
-is one of the slower storage implementations, however. Its use is recommended in
-cases where memory is limited or in environments where more complex storage
-backends (i.e., memcached) are not available. In many cases, it may be
-acceptable (and even optimal) to use file system storage for the entitystore and
-a more performant storage implementation (i.e. memcached) for the metastore.
-
-__NOTE:__ When both the metastore and entitystore are configured to use file
-system storage, they should be set to different paths to prevent any chance of
-collision.
-
-### Memcached Storage
-
-Stores cached entries in a remote [memcached](http://www.danga.com/memcached/)
-instance.
-
-    use Rack::Cache,
-      :metastore   => 'memcached://localhost:11211/meta',
-      :entitystore => 'memcached://localhost:11211/body'
-
-The URI must specify the host and port of a remote memcached daemon. The path
-portion is an optional (but recommended) namespace that is prepended to each
-cache key.
-
-The memcached storage backend requires either the `dalli` or `memcached`
-libraries. By default, the `dalli` library is used; require the `memcached`
-library explicitly to use it instead.
-
-    gem install dalli
-
-Memcached storage is reasonably fast and allows multiple backends to share a
-single cache. It is also the only storage implementation that allows the cache
-to reside somewhere other than the local machine. The memcached daemon stores
-all data in local process memory so using it for the entitystore can result in
-heavy memory usage. It is by far the best option for the metastore in
-deployments with multiple backend application processes since it allows the
-cache to be properly distributed and provides fast access to the
-meta-information required to perform cache logic. Memcached is considerably more
-complex than the other storage implementations, requiring a separate daemon
-process and extra libraries. Still, its use is recommended in all cases where
-you can get away with it.
-
-[e]: http://blog.evanweaver.com/files/doc/fauna/memcached/files/README.html
-[f]: http://blog.evanweaver.com/articles/2008/01/21/b-the-fastest-u-can-b-memcached/
-[l]: http://tangent.org/552/libmemcached.html

data/example/sinatra/app.rb

@@ -1,21 +0,0 @@
-require 'sinatra'
-require 'rack/cache'
-
-use Rack::Cache do
-  set :verbose, true
-  set :metastore,   'heap:/'
-  set :entitystore, 'heap:/'
-end
-
-before do
-  last_modified $updated_at ||= Time.now
-end
-
-get '/' do
-  erb :index
-end
-
-put '/' do
-  $updated_at = nil
-  redirect '/'
-end

data/example/sinatra/views/index.erb

@@ -1,44 +0,0 @@
-<html>
-  <head>
-    <title>Sample Rack::Cache Sinatra app</title>
-    <style type="text/css" media="screen">
-      body {
-        font-family: Georgia;
-        font-size: 24px;
-        text-align: center;
-      }
-
-      #headers {
-        font-size: 16px;
-      }
-
-      input {
-        font-size: 24px;
-        cursor: pointer;
-      }
-    </style>
-  </head>
-  <body>
-    <h1>Last updated at: <%= $updated_at.strftime('%l:%m:%S%P') %></h1>
-
-    <p>
-      <form action="/" method="post">
-        <input type="hidden" name="_method" value="PUT">
-        <input type="submit" value="Expire the cache.">
-      </form>
-    </p>
-
-    <div id="headers">
-      <h3>Headers:</h3>
-
-      <% response.headers.each do |key, value| %>
-        <p><%= key %>: <%= value %></p>
-      <% end %>
-
-      <h3>Params:</h3>
-      <% params.each do |key, value| %>
-        <p><%= key %>: <%= value || '(blank)' %></p>
-      <% end %>
-    </div>
-  </body>
-</html>

data/rack-cache.gemspec

@@ -1,75 +0,0 @@
-Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-
-  s.name = 'rack-cache'
-  s.version = '1.2'
-  s.date = '2012-03-05'
-
-  s.summary     = "HTTP Caching for Rack"
-  s.description = "Rack::Cache is suitable as a quick drop-in component to enable HTTP caching for Rack-based applications that produce freshness (Expires, Cache-Control) and/or validation (Last-Modified, ETag) information."
-
-  s.authors = ["Ryan Tomayko"]
-  s.email = "r@tomayko.com"
-
-  # = MANIFEST =
-  s.files = %w[
-    CHANGES
-    COPYING
-    Gemfile
-    README
-    Rakefile
-    TODO
-    doc/configuration.markdown
-    doc/faq.markdown
-    doc/index.markdown
-    doc/layout.html.erb
-    doc/license.markdown
-    doc/rack-cache.css
-    doc/server.ru
-    doc/storage.markdown
-    example/sinatra/app.rb
-    example/sinatra/views/index.erb
-    lib/rack-cache.rb
-    lib/rack/cache.rb
-    lib/rack/cache/appengine.rb
-    lib/rack/cache/cachecontrol.rb
-    lib/rack/cache/context.rb
-    lib/rack/cache/entitystore.rb
-    lib/rack/cache/key.rb
-    lib/rack/cache/metastore.rb
-    lib/rack/cache/options.rb
-    lib/rack/cache/request.rb
-    lib/rack/cache/response.rb
-    lib/rack/cache/storage.rb
-    rack-cache.gemspec
-    test/cache_test.rb
-    test/cachecontrol_test.rb
-    test/context_test.rb
-    test/entitystore_test.rb
-    test/key_test.rb
-    test/metastore_test.rb
-    test/options_test.rb
-    test/pony.jpg
-    test/request_test.rb
-    test/response_test.rb
-    test/spec_setup.rb
-    test/storage_test.rb
-  ]
-  # = MANIFEST =
-
-  s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/}
-
-  s.extra_rdoc_files = %w[README COPYING TODO CHANGES]
-  s.add_dependency 'rack', '>= 0.4'
-
-  s.add_development_dependency 'bacon'
-  s.add_development_dependency 'memcached'
-  s.add_development_dependency 'dalli'
-
-  s.has_rdoc = true
-  s.homepage = "http://tomayko.com/src/rack-cache/"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rack::Cache", "--main", "Rack::Cache"]
-  s.require_paths = %w[lib]
-  s.rubygems_version = '1.1.1'
-end