cache_rules 0.1.2 → 0.1.3

data/.travis.yml

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

data/README.md

@@ -1,6 +1,6 @@
 ## What is CacheRules
 
-_CacheRules_ is a well-behaved HTTP caching library aimed at being RFC 7234 complaint.
+_CacheRules_ is a well-behaved HTTP caching library aimed at being [RFC 7234](https://tools.ietf.org/html/rfc7234) complaint.
 
 This library does **not actually _cache_ anything**, and it is **not a _proxy_**.
 It validates HTTP headers and returns the appropriate response to determine
@@ -9,7 +9,7 @@ if a request can be served from the cache.
 It is up to the HTTP Cache implementation to store the cached results
 and serve responses from the cache if necessary.
 
-[![Build Status](https://travis-ci.org/aw/CacheRules.svg?branch=master)](https://travis-ci.org/aw/CacheRules) [![Coverage Status](https://coveralls.io/repos/aw/CacheRules/badge.svg?branch=master)](https://coveralls.io/r/aw/CacheRules?branch=master)
+[![Build Status](https://travis-ci.org/aw/CacheRules.svg?branch=master)](https://travis-ci.org/aw/CacheRules) [![Coverage Status](https://coveralls.io/repos/aw/CacheRules/badge.svg?branch=master)](https://coveralls.io/r/aw/CacheRules?branch=master) [![Gem Version](https://badge.fury.io/rb/cache_rules.svg)](http://badge.fury.io/rb/cache_rules)
 
 ## Getting started
 
@@ -119,7 +119,7 @@ These are somewhat based on [CloudFlare's](https://support.cloudflare.com/hc/en-
 
 ## Tests
 
-Tests must cover 100% in order to pass. To run the tests, type:
+To run the tests, type:
 
   `bundle exec rake test`
 
@@ -136,6 +136,13 @@ C.R.E.A.M. is an influencial lyrical masterpiece from the 90s performed by the [
 
 It's also the premise of this [troll video](http://cacheruleseverythingaround.me/)
 
+## Further reading
+
+Some useful articles explaining HTTP Caching:
+
+  * [Caching is hard, draw me a picture](http://www.bizcoder.com/caching-is-hard-draw-me-a-picture)
+  * [A Beginner's Guide to HTTP Cache Headers](http://www.mobify.com/blog/beginners-guide-to-http-cache-headers/)
+
 ## LICENSE
 
 This Source Code Form is subject to the terms of the Mozilla Public

data/cache_rules.gemspec

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

data/lib/validations.rb

@@ -16,8 +16,12 @@ module CacheRules
   # The If-Match and If-Unmodified-Since conditional header fields are not applicable to a cache.
   # source: https://tools.ietf.org/html/rfc7234#section-4.3.2
 
+  def to_bit(&predicate)
+    predicate.call ? 1 : 0
+  end
+
   def validate_cached?(headers)
-    headers[:cached].length > 0 ? 1 : 0
+    to_bit { headers[:cached].length > 0 }
   end
 
   # Precedence: If-None-Match (ETag), then If-Modified-Since (Last-Modified)
@@ -29,9 +33,9 @@ module CacheRules
     # Return when the If-None-Match header exists, ignore If-Modified-Since
     # source: https://tools.ietf.org/html/rfc7232#section-3.3
     etag_match = helper_etag(request, cached)
-    return etag_match ? 1 : 0 unless etag_match.nil?
+    return to_bit { etag_match } unless etag_match.nil?
 
-    helper_last_modified(request, cached) ? 1 : 0
+    to_bit { helper_last_modified(request, cached) }
   end
 
   # Compare headers to see if the cached request is expired (Freshness)
@@ -43,11 +47,11 @@ module CacheRules
 
     response_is_fresh = freshness_lifetime.to_i > current_age
 
-    response_is_fresh ? 0 : 1
+    to_bit { response_is_fresh != true }
   end
 
   def validate_only_if_cached?(headers)
-    headers[:request]['Cache-Control'] && headers[:request]['Cache-Control']['only-if-cached'] ? 1 : 0
+    to_bit { headers[:request]['Cache-Control'] && headers[:request]['Cache-Control']['only-if-cached'] }
   end
 
   # Serving Stale Responses
@@ -61,7 +65,7 @@ module CacheRules
     max_stale = helper_max_stale.call request['Cache-Control'], freshness_lifetime, current_age
     min_fresh = helper_min_fresh.call request['Cache-Control'], freshness_lifetime, current_age
 
-    (max_stale && min_fresh != false) || (max_stale.nil? && min_fresh) ? 1 : 0
+    to_bit { (max_stale && min_fresh != false) || (max_stale.nil? && min_fresh) }
   end
 
   # Response Cache-Control Directives
@@ -71,7 +75,7 @@ module CacheRules
 
     # source: https://tools.ietf.org/html/rfc7234#section-5.2.2.1
     # source: https://tools.ietf.org/html/rfc7234#section-5.2.2.7
-    (( cached = headers[:cached]['Cache-Control'] )) && ( cached['must-revalidate'] || cached['proxy-revalidate'] ) ? 1 : 0
+    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
@@ -100,12 +104,12 @@ module CacheRules
   end
 
   def validate_is_error?(headers)
-    headers[:response]['Status'].to_i.between?(500,599) ? 1 : 0
+    to_bit { headers[:response]['Status'].to_i.between?(500,599) }
   end
 
   def validate_validator_match?(headers)
     request, response = headers.values_at :request, :response
-    response['ETag'] && request['If-None-Match'] && request['If-None-Match'].include?(response['ETag']) ? 1 : 0
+    to_bit { response['ETag'] && request['If-None-Match'] && request['If-None-Match'].include?(response['ETag']) }
   end
 
 end

data/test/helper.rb

@@ -2,6 +2,8 @@ require 'coveralls'
 require 'fakeweb'
 require 'simplecov'
 
+Coveralls.wear!
+
 SimpleCov.start do
   add_filter '/test/'
   add_filter '.bundle'
@@ -14,5 +16,3 @@ require 'minitest/unit'
 require 'minitest/reporters'
 
 Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
-
-Coveralls.wear!

data/test/test_validations.rb

@@ -70,6 +70,14 @@ class TestValidations < MiniTest::Test
     }
   end
 
+  def test_to_bit
+    one   = CacheRules.to_bit { true }
+    zero  = CacheRules.to_bit { false }
+
+    assert_equal one,  1
+    assert_equal zero, 0
+  end
+
   def test_cached
     one   = CacheRules.validate_cached? @headers
     zero  = CacheRules.validate_cached? @no_headers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_rules
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb