Make cache rules consistent. Closes #12

Author: aw

CHANGELOG.md

@@ -1,7 +1,14 @@
 # Changelog
 
+#  0.3.0 (2015-05-03)
+
+  * Make cache rules consistent based RFC spec
+  * Add required 'cached' headers to tests
+
 #  0.2.0 (2015-05-02)
 
+  * Version bump
+
 #  0.1.20 (2015-05-01)
 
   * Recently cached responses are cached correctly. Fixes issue #11

cache_rules.gemspec

@@ -6,7 +6,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'cache_rules'
-  s.version     = '0.2.0'
+  s.version     = '0.3.0'
 
   s.date        = Date.today.to_s
 

lib/helpers.rb

@@ -293,9 +293,9 @@ def helper_heuristic(now, cached, current_age)
     if cached['Last-Modified']
       result = (now - cached['Last-Modified']['timestamp']) / 10
 
-      # Don't cache heuristic responses more than 24 hours old, and avoid sending a 113 Warning ;)
+      # Don't return heuristic responses more than 24 hours old, and avoid sending a 113 Warning ;)
       # source: https://tools.ietf.org/html/rfc7234#section-4.2.2
-      current_age > 86400 ? 0 : (now + result)
+      current_age > 86400 ? 0 : result
     else
       0
     end

lib/validations.rb

@@ -51,6 +51,7 @@ def validate_expired?(headers)
                   headers[:cached]['Cache-Control']['max-age'] &&
                     current_age > headers[:cached]['Cache-Control']['max-age']['token'].to_i
 
+
     to_bit { (response_is_fresh != true) }
   end
 
@@ -82,23 +83,22 @@ def validate_must_revalidate?(headers)
     to_bit { (( cached = headers[:cached]['Cache-Control'] )) && ( cached['must-revalidate'] || cached['proxy-revalidate'] ) }
   end
 
-  # Verify if we're explicitly told not to cache the response
+  # Verify if we're explicitly told not to serve a response without revalidation
   def validate_no_cache?(headers)
     request_headers, cached_headers = headers.values_at :request, :cached
     return 1 if cached_headers.length == 0
 
     # Must revalidate if this request header exists
     # source: https://tools.ietf.org/html/rfc7234#section-5.2.1.4
-    if request_headers['Cache-Control']
-      _, current_age = helper_freshness_lifetime.call cached_headers
-
-      # If max-age is 0 or if the current age is above the max-age
-      # source: https://tools.ietf.org/html/rfc7234#section-5.2.1.1
-      return 1 if (( request = request_headers['Cache-Control'] )) &&
-        request['no-cache'] ||
-        (request['max-age'] &&
-          (request['max-age']['token'].to_s == "0" || current_age > request['max-age']['token'].to_i))
-    end
+    return 1 if (request_headers['Cache-Control'] && request_headers['Cache-Control']['no-cache'])
+
+    _, current_age = helper_freshness_lifetime.call cached_headers
+
+    # If max-age is 0 or if the current age is above the max-age
+    # source: https://tools.ietf.org/html/rfc7234#section-5.2.1.1
+    return 1 if request_headers['Cache-Control'] &&
+                  request_headers['Cache-Control']['max-age'] &&
+                    (request_headers['Cache-Control']['max-age']['token'].to_s == "0" || current_age > request_headers['Cache-Control']['max-age']['token'].to_i)
 
     # source: https://tools.ietf.org/html/rfc7234#section-5.2.2.2
     # source: https://tools.ietf.org/html/rfc7234#section-3.2

test/test_helpers.rb

@@ -362,7 +362,7 @@ def test_heuristic
     too_old       = CacheRules.helper_heuristic now, @cached_headers, 86401
     noop          = CacheRules.helper_heuristic(now, {}, 42)
 
-    assert_equal last_modified, 1420378785
+    assert_equal last_modified, 16560
     assert_equal not_public,    0
     assert_equal too_old,       0
     assert_equal noop,          0

test/test_validations.rb

@@ -168,23 +168,23 @@ def test_no_cache
     }
     headers2 = {
       :request => {},
-      :cached => {'Cache-Control' => {'no-cache'=>{'quoted_string'=>"Cookie"}}}
+      :cached => {'Cache-Control' => {'no-cache'=>{'quoted_string'=>"Cookie"}}, "Date" => {"httpdate" => "Thu, 01 Jan 2015 07:03:45 GMT", "timestamp"=>1420095825}, "X-Cache-Req-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "X-Cache-Res-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}}
     }
     headers2_nil = {
       :request => {},
-      :cached => {'Cache-Control' => {'no-cache'=>{'quoted_string'=>nil}}}
+      :cached => {'Cache-Control' => {'no-cache'=>{'quoted_string'=>nil}}, "Date" => {"httpdate" => "Thu, 01 Jan 2015 07:03:45 GMT", "timestamp"=>1420095825}, "X-Cache-Req-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "X-Cache-Res-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}}
     }
     headers3 = {
       :request => {},
-      :cached => {'Cache-Control' => {'s-maxage'=>{'token'=>"0"}}}
+      :cached => {'Cache-Control' => {'s-maxage'=>{'token'=>"0"}}, "Date" => {"httpdate" => "Thu, 01 Jan 2015 07:03:45 GMT", "timestamp"=>1420095825}, "X-Cache-Req-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "X-Cache-Res-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}}
     }
     headers4 = {
       :request => {},
-      :cached => {'Cache-Control' => {'max-age'=>{'token'=>0}}}
+      :cached => {'Cache-Control' => {'max-age'=>{'token'=>0}}, "Date" => {"httpdate" => "Thu, 01 Jan 2015 07:03:45 GMT", "timestamp"=>1420095825}, "X-Cache-Req-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "X-Cache-Res-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}}
     }
     headers5 = {
       :request => {'Pragma' => {'no-cache'=>{'token'=>nil}}},
-      :cached => {'Cache-Control' => {}}
+      :cached => {'Cache-Control' => {}, "Date" => {"httpdate" => "Thu, 01 Jan 2015 07:03:45 GMT", "timestamp"=>1420095825}, "X-Cache-Req-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "X-Cache-Res-Date" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}}
     }
 
     guard     = CacheRules.validate_no_cache? @no_headers