rack-cache 1.2 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d540010c6bce635d24b70fe8a0484d901d76fd1d
+  data.tar.gz: 5e114ab9a12b2465ddcd2852b5e68a7901e1774e
+SHA512:
+  metadata.gz: d85a27db86e5ce6980ff0e7287041f17a21f58a7be044f8614caab4470340f566a483fdb6ad9152d75452e0a705af654b755c7c139d31b1c6a5e3f046e1d9692
+  data.tar.gz: b481ec44add4cd159aa65750c1477dd4d8190b84154d9eacae03b10e529af9a8791a1cc15741ae78e45787082c82dd4160721e37263bdd0ddc0cda426f88ff46

data/README.md

@@ -0,0 +1,95 @@
+Rack::Cache
+===========
+
+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:
+
+  * Standards-based (RFC 2616)
+  * Freshness/expiration based caching
+  * Validation (If-Modified-Since / If-None-Match)
+  * Vary support
+  * Cache-Control: public, private, max-age, s-maxage, must-revalidate,
+    and proxy-revalidate.
+  * Portable: 100% Ruby / works with any Rack-enabled framework
+  * Disk, memcached, and heap memory storage backends
+
+For more information about Rack::Cache features and usage, see:
+
+http://rtomayko.github.com/rack-cache/
+
+Rack::Cache is not overly optimized for performance. The main goal of the
+project is to provide a portable, easy-to-configure, and standards-based
+caching solution for small to medium sized deployments. More sophisticated /
+high-performance caching systems (e.g., Varnish, Squid, httpd/mod-cache) may be
+more appropriate for large deployments with significant throughput requirements.
+
+Installation
+------------
+
+    gem install rack-cache
+
+Basic Usage
+-----------
+
+`Rack::Cache` is implemented as a piece of Rack middleware and can be used with
+any Rack-based application. If your application includes a rackup (`.ru`) file
+or uses Rack::Builder to construct the application pipeline, simply require
+and use as follows:
+
+```Ruby
+require 'rack/cache'
+
+use Rack::Cache,
+  :metastore   => 'file:/var/cache/rack/meta',
+  :entitystore => 'file:/var/cache/rack/body',
+  :verbose     => true
+
+run app
+```
+
+Assuming you've designed your backend application to take advantage of HTTP's
+caching features, no further code or configuration is required for basic
+caching.
+
+Using with Rails
+----------------
+
+Add this to your `config/environment.rb`:
+
+```Ruby
+config.middleware.use Rack::Cache,
+   :verbose => true,
+   :metastore   => 'file:/var/cache/rack/meta',
+   :entitystore => 'file:/var/cache/rack/body'
+```
+
+You should now see `Rack::Cache` listed in the middleware pipeline:
+
+    rake middleware
+
+See the following for more information:
+
+    http://snippets.aktagon.com/snippets/302
+
+Using with Dalli
+----------------
+
+Dalli is a high performance memcached client for Ruby.
+More information at: https://github.com/mperham/dalli
+
+```Ruby
+require 'dalli'
+require 'rack/cache'
+
+use Rack::Cache,
+  :verbose => true,
+  :metastore   => "memcached://localhost:11211/meta",
+  :entitystore => "memcached://localhost:11211/body"
+
+run app
+```
+
+License: MIT<br/>
+[![Build Status](https://travis-ci.org/rtomayko/rack-cache.png)](https://travis-ci.org/rtomayko/rack-cache)
+

data/lib/rack/cache/cachecontrol.rb

@@ -125,6 +125,20 @@ module Rack
       end
       alias_method :s_maxage, :shared_max_age
 
+      # If a response includes a r-maxage directive, then for a reverse cache
+      # (but not for a private or proxy cache), the maximum age specified by
+      # this directive overrides the maximum age specified by either the max-age
+      # directive, the s-maxage directive, or the Expires header. The r-maxage
+      # directive also implies the semantics of the proxy-revalidate directive.
+      # i.e., that the reverse cache must not use the entry after it becomes
+      # stale to respond to a subsequent request without first revalidating it
+      # with the origin server. The r-maxage directive is always ignored by
+      # private and proxy caches.
+      def reverse_max_age
+        self['r-maxage'].to_i  if key?('r-maxage')
+      end
+      alias_method :r_maxage, :reverse_max_age
+
       # Because a cache MAY be configured to ignore a server's specified
       # expiration time, and because a client request MAY include a max-
       # stale directive (which has a similar effect), the protocol also

data/lib/rack/cache/context.rb

@@ -45,7 +45,7 @@ module Rack::Cache
     # each request in a dup object unless the +rack.run_once+ variable is
     # set in the environment.
     def call(env)
-      if env['rack.run_once']
+      if env['rack.run_once'] && !env['rack.multithread']
         call! env
       else
         clone.call! env
@@ -79,7 +79,7 @@ module Rack::Cache
       if verbose?
         message = "cache: [%s %s] %s\n" %
           [@request.request_method, @request.fullpath, trace]
-        @env['rack.errors'].write(message)
+        log_info(message)
       end
 
       # tidy up response a bit
@@ -280,7 +280,20 @@ module Rack::Cache
     end
 
     def log_error(exception)
-      @env['rack.errors'].write("cache error: #{exception.message}\n#{exception.backtrace.join("\n")}\n")
+      message = "cache error: #{exception.message}\n#{exception.backtrace.join("\n")}\n"
+      log(:error, message)
+    end
+
+    def log_info(message)
+      log(:info, message)
+    end
+
+    def log(level, message)
+      if @env['rack.logger']
+        @env['rack.logger'].send(level, message)
+      else
+        @env['rack.errors'].write(message)
+      end
     end
   end
 end

data/lib/rack/cache/metastore.rb

@@ -64,7 +64,7 @@ module Rack::Cache
         end
         response.headers['X-Content-Digest'] = digest
         response.headers['Content-Length'] = size.to_s unless response.headers['Transfer-Encoding']
-        response.body = entity_store.open(digest)
+        response.body = entity_store.open(digest) || response.body
       end
 
       # read existing cache entries, remove non-varying, and add this one to

data/lib/rack/cache/options.rb

@@ -95,14 +95,12 @@ module Rack::Cache
     # Default: ['Authorization', 'Cookie']
     option_accessor :private_headers
 
-    # Specifies whether the client can force a cache reload by including a
-    # Cache-Control "no-cache" directive in the request. This is enabled by
-    # default for compliance with RFC 2616.
+    # Specifies whether a client can force cache reload by including a
+    # Cache-Control "no-cache" directive in the request. Disabled by default.
     option_accessor :allow_reload
 
-    # Specifies whether the client can force a cache revalidate by including
-    # a Cache-Control "max-age=0" directive in the request. This is enabled by
-    # default for compliance with RFC 2616.
+    # Specifies whether a client can force cache revalidate by including a
+    # Cache-Control "max-age=0" directive in the request. Disabled by default.
     option_accessor :allow_revalidate
 
     # Specifies whether the underlying entity store's native expiration should

data/lib/rack/cache/response.rb

@@ -151,13 +151,14 @@ module Rack::Cache
 
     # The number of seconds after the time specified in the response's Date
     # header when the the response should no longer be considered fresh. First
-    # check for a s-maxage directive, then a max-age directive, and then fall
-    # back on an expires header; return nil when no maximum age can be
-    # established.
+    # check for a r-maxage directive, then a s-maxage directive, then a max-age
+    # directive, and then fall back on an expires header; return nil when no
+    # maximum age can be established.
     def max_age
-      cache_control.shared_max_age ||
-        cache_control.max_age ||
-        (expires && (expires - date))
+      cache_control.reverse_max_age ||
+        cache_control.shared_max_age ||
+          cache_control.max_age ||
+           (expires && (expires - date))
     end
 
     # The value of the Expires header as a Time object.
@@ -177,6 +178,12 @@ module Rack::Cache
       self.cache_control = cache_control.merge('s-maxage' => value.to_s)
     end
 
+    # Like #shared_max_age= but sets the r-maxage directive, which applies only
+    # to reverse caches.
+    def reverse_max_age=(value)
+      self.cache_control = cache_control.merge('r-maxage' => value.to_s)
+    end
+
     # The response's time-to-live in seconds, or nil when no freshness
     # information is present in the response. When the responses #ttl
     # is <= 0, the response may not be served from cache without first

metadata

@@ -1,60 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: rack-cache
 version: !ruby/object:Gem::Version
-  version: '1.2'
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70248834703480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70248834703480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &70248834703100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248834703100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: memcached
-  requirement: &70248834702640 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248834702640
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dalli
-  requirement: &70248834702220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248834702220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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.
@@ -62,27 +101,13 @@ email: r@tomayko.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
-- COPYING
-- TODO
+- README.md
+- MIT-LICENSE
 - CHANGES
 files:
 - 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
+- MIT-LICENSE
+- README.md
 - lib/rack-cache.rb
 - lib/rack/cache.rb
 - lib/rack/cache/appengine.rb
@@ -95,57 +120,34 @@ files:
 - 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
-homepage: http://tomayko.com/src/rack-cache/
-licenses: []
+homepage: https://github.com/rtomayko/rack-cache
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --line-numbers
-- --inline-source
-- --title
+- "--line-numbers"
+- "--inline-source"
+- "--title"
 - Rack::Cache
-- --main
+- "--main"
 - Rack::Cache
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: HTTP Caching for Rack
-test_files:
-- 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/request_test.rb
-- test/response_test.rb
-- test/storage_test.rb
+test_files: []

data/Gemfile

@@ -1,2 +0,0 @@
-source :rubygems
-gemspec

data/README

@@ -1,126 +0,0 @@
-Rack::Cache
-===========
-
-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:
-
-  * Standards-based (RFC 2616)
-  * Freshness/expiration based caching
-  * Validation (If-Modified-Since / If-None-Match)
-  * Vary support
-  * Cache-Control: public, private, max-age, s-maxage, must-revalidate,
-    and proxy-revalidate.
-  * Portable: 100% Ruby / works with any Rack-enabled framework
-  * Disk, memcached, and heap memory storage backends
-
-For more information about Rack::Cache features and usage, see:
-
-http://tomayko.com/src/rack-cache/
-
-Rack::Cache is not overly optimized for performance. The main goal of the
-project is to provide a portable, easy-to-configure, and standards-based
-caching solution for small to medium sized deployments. More sophisticated /
-high-performance caching systems (e.g., Varnish, Squid, httpd/mod-cache) may be
-more appropriate for large deployments with significant throughput requirements.
-
-Installation
-------------
-
-From Gem:
-
-    $ sudo gem install rack-cache
-
-With a local working copy:
-
-    $ git clone git://github.com/rtomayko/rack-cache.git
-    $ rake package && sudo rake install
-
-Basic Usage
------------
-
-Rack::Cache is implemented as a piece of Rack middleware and can be used with
-any Rack-based application. If your application includes a rackup (`.ru`) file
-or uses Rack::Builder to construct the application pipeline, simply require
-and use as follows:
-
-    require 'rack/cache'
-
-    use Rack::Cache,
-      :metastore   => 'file:/var/cache/rack/meta',
-      :entitystore => 'file:/var/cache/rack/body',
-      :verbose     => true
-
-    run app
-
-Assuming you've designed your backend application to take advantage of HTTP's
-caching features, no further code or configuration is required for basic
-caching.
-
-Using with Rails
-----------------
-
-Add this to your `config/environment.rb`:
-
-   config.middleware.use Rack::Cache,
-       :verbose => true,
-       :metastore   => 'file:/var/cache/rack/meta',
-       :entitystore => 'file:/var/cache/rack/body'
-
-You should now see `Rack::Cache` listed in the middleware pipeline:
-
-    rake middleware
-
-See the following for more information:
-
-    http://snippets.aktagon.com/snippets/302
-
-Using with Dalli
-----------------
-
-Dalli is a high performance memcached client for Ruby.
-More information at: https://github.com/mperham/dalli
-
-    require 'dalli'
-    require 'rack/cache'
-
-    use Rack::Cache,
-      :verbose => true,
-      :metastore   => "memcached://localhost:11211/meta",
-      :entitystore => "memcached://localhost:11211/body"
-
-    run app
-
-Links
------
-
-Documentation:
-    http://tomayko.com/src/rack-cache/
-
-Mailing List:
-    http://groups.google.com/group/rack-cache
-
-GitHub:
-    http://github.com/rtomayko/rack-cache/
-
-License
--------
-
-Copyright (c) 2008 Ryan Tomayko <http://tomayko.com/about>
-
-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 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.