hurley-http-cache 0.1.0.beta → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb71f71333adf5e4e068bb81c474c092cc16a5f4
-  data.tar.gz: 55b436e2743064185ac7383b3e9ec71389dc0950
+  metadata.gz: b8f6cd27a44789b425f61cb2f6290640ec1895e6
+  data.tar.gz: a42afa9bf4a1308195da0d408c1c44ba7adb1bb2
 SHA512:
-  metadata.gz: ee330c420cb6080c33e2ecb673a1de0efc99e1498c413cac9861d4555e6c30c12fb056fa1a7c67dca2b49047d872860599c14c07a32a951467187b952c88940a
-  data.tar.gz: 19de7bdbe98a40d5fbc70f56c3e61c721f1a0cbcdf6c9c49ef9b3d040c6592492f80fe40b297c172211c6aba4453291030882912fe9ab62115590dae0930599b
+  metadata.gz: f6b829f62715e840786ba9c4583145992adf98ef16f682b322b376b30ea5e3ed622f5a0a8952cac8709666af39fccf498f06de74b14e05d9c146df836eafef26
+  data.tar.gz: fa0d454ada4b5413dd64a366d2928ebfb123ac487c992d5dc1c377be02a2867547696bf1b632a76ce9933806cae8e9f4ea9515af042e7a1a25e25e51abb2dfb9

data/lib/hurley/http_cache.rb

@@ -21,7 +21,7 @@ module Hurley
     #                (default: nil).
     # logger       - A Logger object (default: nil).
     #
-    # Examples:
+    # Examples
     #
     # # Initialize the connection with the Rails logger.
     # client = Hurley.new

data/lib/hurley/http_cache/cache_control.rb

@@ -97,7 +97,8 @@ module Hurley
       # and the exceeding will be treated as the value. If only the key is
       # present then the assigned value will default to true.
       #
-      # Examples:
+      # Examples
+      #
       #   parse('max-age=600')
       #   # => { 'max-age' => '600'}
       #

data/lib/hurley/http_cache/request.rb

@@ -17,6 +17,17 @@ module Hurley
         true
       end
 
+      # Internal: Check if a pair of existing request and response matches the
+      # current request object.
+      #
+      # request  - The Hash of the request that was cached.
+      # response - The Hash of the response that was cached.
+      #
+      # Returns true or false.
+      def matches?(request, response)
+        verb.to_s == request['verb'] && vary_matches?(request, response)
+      end
+
       # Internal: Check if the request can't be cached, accordingly to the
       # 'Cache-Control' header.
       #
@@ -39,6 +50,25 @@ module Hurley
 
       private
 
+      # Internal: Check if the header fields described in a response 'Vary'
+      # header matches between the current request and an existing request
+      # Hash. The 'Vary' header can be empty (meaning that the requests match),
+      # a '*' String (meaning that the request never match) or be a comma
+      # separated list of the headers that should be compared.
+      #
+      # request  - The Hash of the request that was cached.
+      # response - The Hash of the response that was cached.
+      #
+      # Returns true or false.
+      def vary_matches?(request, response)
+        response_headers = Hurley::Header.new(response['header'])
+        vary = response_headers['Vary'].to_s
+
+        vary.empty? || (vary != '*' && vary.split(/[\s,]+/).all? do |key|
+          header[key] == request['header'][key]
+        end)
+      end
+
       # Internal: Get a CacheControl object to inspect the directives in the
       # 'Cache-Control' header.
       #

data/lib/hurley/http_cache/response.rb

@@ -156,7 +156,7 @@ module Hurley
       # Internal: The logic behind cacheable_in_private_cache? and
       # cacheable_in_shared_cache? The logic is the same except for the
       # treatment of the private Cache-Control directive.
-      def cacheable?(shared:)
+      def cacheable?(shared: false)
         return false if (cache_control.private? && shared) || cache_control.no_store?
 
         cacheable_status_code? && (validateable? || fresh?)

data/lib/hurley/http_cache/storage.rb

@@ -32,7 +32,9 @@ module Hurley
         assert_valid_store!
       end
 
-      # Internal: Store a response inside the cache.
+      # Internal: Store a response inside the cache. Existing entries for the
+      # exact same request will be removed from the cache and replaced by the
+      # given response object.
       #
       # request  - A Hurley::HttpCache::::Request instance of the executed HTTP
       #            request.
@@ -41,16 +43,12 @@ module Hurley
       # Returns nothing.
       def write(request, response)
         key = cache_key_for(request.url)
-        entry = serialize_entry(request.serializable_hash, response.serializable_hash)
+        entry = read_entry(key) || []
 
-        entries = cache.read(key) || []
+        entry.reject! { |(req, res)| request.matches?(req, res) }
+        entry << [request.serializable_hash, response.serializable_hash]
 
-        entries.reject! do |(cached_request, cached_response)|
-          response_matches?(request, cached_request, cached_response)
-        end
-
-        entries << entry
-        cache.write(key, entries)
+        write_entry(key, entry)
       rescue Encoding::UndefinedConversionError => e
         warn { "Response could not be serialized: #{e.message}. Try using Marshal to serialize." }
         raise e
@@ -65,8 +63,8 @@ module Hurley
       # Returns a Hash.
       def read(request)
         cache_key = cache_key_for(request.url)
-        entries = cache.read(cache_key)
-        lookup_response(request, entries)
+        entry = read_entry(cache_key)
+        lookup_response(request, entry)
       end
 
       def delete(url)
@@ -76,61 +74,30 @@ module Hurley
 
       private
 
+      def read_entry(key)
+        entry = cache.read(key)
+        @serializer.load(entry) if entry
+      end
+
+      def write_entry(key, entry)
+        cache.write(key, @serializer.dump(entry))
+      end
+
       # Internal: Retrieve a response Hash from the list of entries that match
       # the given request.
       #
       # request  - A Hurley::HttpCache::::Request instance of the incoming HTTP
       #            request.
-      # entries  - An Array of pairs of Hashes (request, response).
+      # entry  - An Array of pairs of Hashes (request, response).
       #
       # Returns a Hash or nil.
-      def lookup_response(request, entries)
-        if entries
-          entries = entries.map { |entry| deserialize_entry(*entry) }
-          _, response = entries.find { |req, res| response_matches?(request, req, res) }
+      def lookup_response(request, entry)
+        if entry
+          _, response = entry.find { |req, res| request.matches?(req, res) }
           response
         end
       end
 
-      # Internal: Check if a cached response and request matches the given
-      # request.
-      #
-      # request         - A Hurley::HttpCache::::Request instance of the
-      #                   current HTTP request.
-      # cached_request  - The Hash of the request that was cached.
-      # cached_response - The Hash of the response that was cached.
-      #
-      # Returns true or false.
-      def response_matches?(request, cached_request, cached_response)
-        request.verb.to_s == cached_request['verb'] &&
-          vary_matches?(cached_response, request, cached_request)
-      end
-
-      def vary_matches?(cached_response, request, cached_request)
-        headers = Hurley::Header.new(cached_response['header'])
-        vary = headers['Vary'].to_s
-
-        vary.empty? || (vary != '*' && vary.split(/[\s,]+/).all? do |header|
-          request.header[header] == cached_request['header'][header]
-        end)
-      end
-
-      def serialize_entry(*objects)
-        objects.map { |object| serialize_object(object) }
-      end
-
-      def serialize_object(object)
-        @serializer.dump(object)
-      end
-
-      def deserialize_entry(*objects)
-        objects.map { |object| deserialize_object(object) }
-      end
-
-      def deserialize_object(object)
-        @serializer.load(object)
-      end
-
       # Internal: Computes the cache key for a specific request, taking in
       # account the current serializer to avoid cross serialization issues.
       #

data/test/http_cache/request_test.rb

@@ -55,6 +55,60 @@ class RequestTest < MiniTest::Test
     assert_predicate request, :no_cache?
   end
 
+  def test_request_verb_matches
+    request = new_request(verb: :get)
+
+    refute request.matches?({ 'verb' => 'post' }, {})
+    refute request.matches?({ 'verb' => 'delete' }, {})
+
+    assert request.matches?({ 'verb' => 'get' }, {})
+  end
+
+  def test_request_verb_and_Vary_matches
+    request = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0' })
+
+    req = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0' }).serializable_hash
+    res = { 'header' => { 'Vary' => 'User-Agent' } }
+
+    assert request.matches?(req, res)
+  end
+
+  def test_request_verb_and_multiple_Vary_matches
+    request = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0', 'Accept' => 'application/json' })
+
+    req = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0', 'Accept' => 'application/json' }).serializable_hash
+    res = { 'header' => { 'Vary' => 'User-Agent, Accept' } }
+
+    assert request.matches?(req, res)
+  end
+
+  def test_request_matches_wrong_Vary
+    request = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/2.0' })
+
+    req = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0' }).serializable_hash
+    res = { 'header' => { 'Vary' => 'User-Agent' } }
+
+    refute request.matches?(req, res)
+  end
+
+  def test_request_verb_and_any_wrong_Vary
+    request = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0', 'Accept' => 'application/json' })
+
+    req = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0', 'Accept' => 'text/html' }).serializable_hash
+    res = { 'header' => { 'Vary' => 'User-Agent, Accept' } }
+
+    refute request.matches?(req, res)
+  end
+
+  def test_request_Vary_star_never_matches
+    request = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0' })
+
+    req = new_request(verb: :get, header: { 'User-Agent' => 'FooBar/1.0' }).serializable_hash
+    res = { 'header' => { 'Vary' => '*' } }
+
+    refute request.matches?(req, res)
+  end
+
   def test_serializable_hash
     request = new_request(header: { 'User-Agent' => 'FooBar' })
     hash = request.serializable_hash

data/test/http_cache/storage_test.rb

@@ -26,7 +26,7 @@ module StorageTests
 
   def test_writes_the_response_object_to_the_underlying_cache
     @storage.write(@request, @response)
-    assert_kind_of Array, @storage.cache.read(cache_key)
+    refute_nil @storage.cache.read(cache_key)
   end
 
   def test_retrieves_the_response_from_the_cache

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hurley-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.0
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hurley
@@ -58,6 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
 description: Hurley connection to handle HTTP caching
 email:
 - opensource@plataformatec.com.br
@@ -95,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5