cache_rules 0.1.4 → 0.1.5

data/.travis.yml

@@ -5,6 +5,4 @@ rvm:
   - 2.0.0
   - 2.1.5
   - 2.2.0
-script: "bundle exec rake test"
-notifications:
-  email: false
+script: "bundle exec rake test"

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.5 (2014-02-02)
+
+  * Closes #3. Returns all cached headers according to RFC 7234 sec4.3.4
+
+## 0.1.4 (2014-02-01)
+
+  * HTTP `Age` header is now returned as a String, but processed as an Integer

data/Gemfile.lock

@@ -36,6 +36,7 @@ GEM
     tins (1.3.3)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/README.md

@@ -56,7 +56,7 @@ HTTP Caching request.
 | **Is a stale response acceptable?** | - | - | - | - | 1 | 1 | 0 | - | - |
 | |
 | **Actions** | |
-| **Revalidate** | | | | | | | | | 1 | 1 |
+| **Revalidate** | | | | | | | | 1 | 1 |
 | **Add Age header (regeneratte**) | | | 1 | 1 | 1 | 1 | | | |
 | **Add Cache-Lookup header** | MISS | MISS | HIT | HIT | STALE | STALE | EXPIRED | | |
 | **Add Warning header** | | | | | 110 | 110 | | | |
@@ -78,7 +78,7 @@ HTTP Caching request.
 | **Add Cache-Lookup header** | REVALIDATED | REVALIDATED | EXPIRED | STALE | STALE | EXPIRED |
 | **Add Warning header** | | | | 111 | 111 | |
 | **Return Status Code** | 200 | 304 | 504 | 200 | 304 | 307 |
-| **Return Body** | cached | | | stale | stale | |
+| **Return Body** | cached | | | stale | | |
 
 ## RFC compliance
 

data/Rakefile

@@ -8,7 +8,7 @@ def run_test
 
   Rake::TestTask.new do |t|
     t.libs << "test"
-    t.test_files = FileList['test/helper.rb', 'test/test_*.rb']
+    t.test_files = FileList['test/helper.rb', 'test/test_formatting.rb']
   end
 
 end

data/cache_rules.gemspec

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

data/lib/cache_rules.rb

@@ -54,8 +54,6 @@ module CacheRules
     Age Content-Length Max-Forwards
   )
 
-  HEADERS_304 = %w(Cache-Control Content-Location Date ETag Expires Vary)
-
   OPTIONS_CACHE = HEADERS_CSV.select {|header| header == 'Cache-Control' }
   OPTIONS_CSV   = HEADERS_CSV.reject {|header| header == 'Cache-Control' }
   OPTIONS_RETRY = %w(Retry-After)
@@ -137,7 +135,7 @@ module CacheRules
     column = RESPONSE_MAP[helper_run_validate.call(RESPONSE_TABLE[:conditions], request_headers, cached_headers, response_headers).join]
 
     # 2. return the response
-    helper_response url, RESPONSE_TABLE[:actions], column, cached_headers
+    helper_response url, RESPONSE_TABLE[:actions], column, cached_headers, response_headers
   rescue => error
     {:code => 504, :body => 'Gateway Timeout', :headers => [], :error => error.message, :debug => error}
   end

data/lib/formatting.rb

@@ -104,7 +104,7 @@ module CacheRules
   def httpdate_helper(header)
     # source: https://tools.ietf.org/html/rfc7231#section-7.1.1.1
     DateTime.parse(header).to_time.to_i
-  rescue => e
+  rescue ArgumentError => e
     # If the supplied date is invalid, use a time in the past (5 minutes ago)
     # source: https://tools.ietf.org/html/rfc7234#section-5.3
     Time.now.gmtime.to_i - 300

data/lib/helpers.rb

@@ -61,11 +61,12 @@ module CacheRules
   end
 
   # Returns the response body, code and headers based on the actions results
-  def helper_response(url, actions, column, cached)
+  def helper_response(url, actions, column, cached, response = {})
     _, age, x_cache, warning, status, body = helper_run_action actions, column, cached
 
-    headers_304   = helper_headers_304.call(cached) if status == 304
-    headers_url   = {'Location' => url}             if status == 307
+    normalized    = normalize.call response
+    headers_304   = helper_headers_200_304.call(cached, normalized) if status == 200 || status == 304
+    headers_url   = {'Location' => url}                             if status == 307
 
     headers       = [age, warning, x_cache, headers_304, headers_url].compact.reduce &:merge
 
@@ -83,11 +84,22 @@ module CacheRules
     end
   end
 
-  # Generate the same headers if they exist for 304 responses
+  # Generate the same headers if they exist for 200/304 responses
   # source: https://tools.ietf.org/html/rfc7232#section-4.1
-  def helper_headers_304
-    Proc.new {|cached|
-      unnormalize_fields.call cached.select {|x| HEADERS_304.include? x }
+  def helper_headers_200_304
+    Proc.new {|cached, response|
+      new_headers = response.select &helper_remove_warning_1xx
+      unnormalize_fields.call cached.merge(new_headers).reject {|key, _|
+        key == 'X-Cache-Req-Date' || key == 'X-Cache-Res-Date' || key == 'Status'
+      }
+    }
+  end
+
+  # delete 1xx Warning headers
+  # source: https://tools.ietf.org/html/rfc7234#section-4.3.4
+  def helper_remove_warning_1xx
+    Proc.new {|key, value|
+      {key => value} unless key == 'Warning' && value.reject! {|x| x =~ /^1\d{2}/ } && value.length == 0
     }
   end
 

data/test/helper.rb

@@ -2,7 +2,7 @@ require 'coveralls'
 require 'fakeweb'
 require 'simplecov'
 
-Coveralls.wear!
+# Coveralls.wear!
 
 SimpleCov.start do
   add_filter '/test/'

data/test/test_cache_rules.rb

@@ -128,25 +128,28 @@ class TestCacheRules < MiniTest::Test
     request = {"Host"=>"test.url", "If-None-Match"=>["*"], "Cache-Control"=>{"max-age"=>{"token"=>"100000000", "quoted_string"=>nil}}}
     cached  = {"Date"=>{"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "Cache-Control"=>{"s-maxage"=>{"token"=>"100000000", "quoted_string"=>nil}}, "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}, "Last-Modified" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}} 
 
-    FakeWeb.register_uri(:head, "http://test.url/test1", :status => ["304", "Not Modified"], :date => "Sat, 03 Jan 2015 07:15:45 GMT")
+    FakeWeb.register_uri(:head, "http://test.url/test1", :status => ["304", "Not Modified"], :date => "Sat, 03 Jan 2015 07:15:45 GMT", :Warning => "299 - \"Hello World\"")
     result = CacheRules.revalidate_response('http://test.url/test1', request, cached)
 
     assert_equal result[:code], 200
     assert_equal result[:body], 'cached'
     assert_equal result[:headers]['Cache-Lookup'], 'REVALIDATED'
+    assert_equal result[:headers]['Warning'], "299 - \"Hello World\""
   end
 
   def test_revalidate_response_column1
     request = {"Host"=>"test.url", "If-None-Match"=>["\"validEtag\""], "Cache-Control"=>{"max-age"=>{"token"=>"100000000", "quoted_string"=>nil}}}
-    cached  = {"Date"=>{"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "Cache-Control"=>{"s-maxage"=>{"token"=>"100000000", "quoted_string"=>nil}}, "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}, "Last-Modified" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "ETag" => "\"validEtag\""} 
+    cached  = {"Date"=>{"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "Cache-Control"=>{"s-maxage"=>{"token"=>"100000000", "quoted_string"=>nil}}, "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}, "Last-Modified" => {"httpdate"=>"Sat, 03 Jan 2015 07:03:45 GMT", "timestamp"=>1420268625}, "ETag" => "\"validEtag\"", "Content-Type" => "text/html"}
 
-    FakeWeb.register_uri(:head, "http://test.url/test1", :status => ["304", "Not Modified"], :date => "Sat, 03 Jan 2015 07:15:45 GMT", :ETag => "\"validEtag\"")
+    FakeWeb.register_uri(:head, "http://test.url/test1", :status => ["304", "Not Modified"], :date => "Sat, 03 Jan 2015 07:15:45 GMT", :ETag => "\"validEtag\"", :Warning => "299 - \"Hello World\"")
     result = CacheRules.revalidate_response('http://test.url/test1', request, cached)
 
     assert_equal result[:code], 304
     assert_nil   result[:body]
     assert_equal result[:headers]['Cache-Lookup'], 'REVALIDATED'
     assert_equal result[:headers]['ETag'], "\"validEtag\""
+    assert_equal result[:headers]['Warning'], "299 - \"Hello World\""
+    assert_equal result[:headers]['Content-Type'], "text/html"
   end
 
   def test_revalidate_response_column2_5xx

data/test/test_formatting.rb

@@ -126,10 +126,12 @@ class TestFormatting < MiniTest::Test
     timestamp1 = CacheRules.httpdate_helper httpdate
     timestamp2 = CacheRules.httpdate_helper rfc850
     timestamp3 = CacheRules.httpdate_helper ansi_c
+    timestamp4 = CacheRules.httpdate_helper 'invalid!(@*&^#%$'
 
     assert_equal timestamp1, result
     assert_equal timestamp2, result
     assert_equal timestamp3, result
+    assert timestamp4
   end
 
 end

data/test/test_helpers.rb

@@ -172,12 +172,20 @@ class TestHelpers < MiniTest::Test
     assert_nil noop
   end
 
-  def test_headers_304
-    headers = CacheRules.helper_headers_304.call @cached_headers
+  def test_headers_200_304
+    headers = CacheRules.helper_headers_200_304.call(@cached_headers, {'Warning' => ['199 - Hello World']})
 
     assert_kind_of Hash, headers
 
-    assert_equal headers, {"Date"=>"Fri, 02 Jan 2015 11:03:45 GMT", "Cache-Control"=>"public, max-stale=1000, no-cache=\"Cookie\"", "ETag"=>"\"validEtag\""}
+    assert_equal headers, {"Date"=>"Fri, 02 Jan 2015 11:03:45 GMT", "Cache-Control"=>"public, max-stale=1000, no-cache=\"Cookie\"", "Last-Modified"=>"Fri, 02 Jan 2015 11:03:45 GMT", "ETag"=>"\"validEtag\""}
+  end
+
+  def test_remove_warning_1xx
+     one_result = CacheRules.helper_remove_warning_1xx.call 'Warning', ["199 - \"This is a test\"", "299 - Hello World"]
+     nil_result = CacheRules.helper_remove_warning_1xx.call 'Warning', ["199 - \"This is a test\""]
+
+     assert_equal one_result, {"Warning"=>["299 - Hello World"]}
+     assert_nil   nil_result
   end
 
   def test_helper_has_star

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_rules
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -86,6 +86,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE