faraday-http-cache 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92ef39b3697fc4f6a5d9482310bcbe449c9e8707
-  data.tar.gz: 43dd20b8cfce84a09a94d66bfb8843ff5e229184
+  metadata.gz: a2147bf25b6776f94d77ce49cd1147a790978446
+  data.tar.gz: cd45d9ddd630c3b627595e32826629a5c1e1d848
 SHA512:
-  metadata.gz: afd6c8d4f672f3aab445124dbb604930e35c959ad27478093d34c8cd070f474b8b7ed89d8420147a890aeeb564ff19dedd4beedfd9ffe3e4c1a9ded568e36f19
-  data.tar.gz: c74d2527626fc7ea4b67f83063006489ebb32a86b16edff9f0e2df5e240866d9156779d93cc3680ecd22c69e988753f372140c1b5cfdc7ba3deb6caa2f1d864f
+  metadata.gz: 432baf735bfa450affe7fa9a88aff70667a8a37b93fcbcb490ccd75f8b69498459716f273af9b32093f6435680a4f20f9d2d1ef9212d91646eba2ef53ad73745
+  data.tar.gz: ceb797b25268e5ef954684f7332ed790c49db1ca0f9709be87e4722a94553d806787932d5021e4829b65952be15982338266b377b65432da441584255f8712e1

data/LICENSE

@@ -1,5 +1,3 @@
-Copyright 2012-2014 Plataformatec.
-
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

data/README.md

@@ -1,6 +1,6 @@
 # Faraday Http Cache
 
-[![Build Status](https://secure.travis-ci.org/plataformatec/faraday-http-cache.svg?branch=master)](https://travis-ci.org/plataformatec/faraday-http-cache)
+[![Build Status](https://secure.travis-ci.org/sourcelevel/faraday-http-cache.svg?branch=master)](https://travis-ci.org/sourcelevel/faraday-http-cache)
 
 a [Faraday](https://github.com/lostisland/faraday) middleware that respects HTTP cache,
 by checking expiration and validation of the stored responses.
@@ -53,9 +53,16 @@ This type of store **might not be persisted across multiple processes or connect
 so it is probably not suitable for most production environments.
 Make sure that you configure a store that is suitable for you.
 
-the stdlib `JSON` module is used for serialization by default.
-If you expect to be dealing with images, you can use [Marshal][marshal] instead, or
-if you want to use another json library like `oj` or `yajl-ruby`.
+The stdlib `JSON` module is used for serialization by default, which can struggle with unicode 
+characters in responses. For example, if your JSON returns `"name": "Raül"` then you might see 
+errors like:
+
+```
+Response could not be serialized: "\xC3" from ASCII-8BIT to UTF-8. Try using Marshal to serialize.
+```
+
+For full unicode support, or if you expect to be dealing with images, you can use 
+[Marshal][marshal] instead. Alternatively you could use another json library like `oj` or `yajl-ruby`.
 
 ```ruby
 client = Faraday.new do |builder|
@@ -120,7 +127,7 @@ end
 
 ## See it live
 
-You can clone this repository, install it's dependencies with Bundler (run `bundle install`) and
+You can clone this repository, install its dependencies with Bundler (run `bundle install`) and
 execute the files under the `examples` directory to see a sample of the middleware usage.
 
 ## What gets cached?
@@ -153,6 +160,7 @@ client.get('http://site/api/some-private-resource') # => will be cached
 
 ## License
 
-Copyright (c) 2012-2014 Plataformatec. See LICENSE file.
+Copyright (c) 2012-2018 Plataformatec.
+Copyright (c) 2019 SourceLevel and contributors.
 
   [marshal]: http://www.ruby-doc.org/core-2.0/Marshal.html

data/lib/faraday/http_cache.rb

@@ -19,7 +19,7 @@ module Faraday
   #
   #   # Using the middleware with a simple client:
   #   client = Faraday.new do |builder|
-  #     builder.user :http_cache, store: my_store_backend
+  #     builder.use :http_cache, store: my_store_backend
   #     builder.adapter Faraday.default_adapter
   #   end
   #
@@ -61,7 +61,7 @@ module Faraday
       # The response was cached and the server has validated it with a 304 response.
       :valid,
 
-      # The response was cache but was revalidated by the sserver.
+      # The response was cached but was not revalidated by the server.
       :invalid,
 
       # No response was found in the cache.
@@ -70,8 +70,8 @@ module Faraday
       # The response can't be cached.
       :uncacheable,
 
-      # The request decided to ignore the cache.
-      :bypass
+      # The request was cached but need to be revalidated by the server.
+      :must_revalidate,
     ].freeze
 
     # Public: Initializes a new HttpCache middleware.
@@ -132,15 +132,7 @@ module Faraday
       response = nil
 
       if @request.cacheable?
-        response = if @request.no_cache?
-          trace :bypass
-          @app.call(env).on_complete do |fresh_env|
-            response = Response.new(create_response(fresh_env))
-            store(response)
-          end
-        else
-          process(env)
-        end
+        response = process(env)
       else
         trace :unacceptable
         response = @app.call(env)
@@ -194,10 +186,11 @@ module Faraday
 
       return fetch(env) if entry.nil?
 
-      if entry.fresh?
+      if entry.fresh? && !@request.no_cache?
         response = entry.to_response(env)
         trace :fresh
       else
+        trace :must_revalidate
         response = validate(entry, env)
       end
 

data/lib/faraday/http_cache/request.rb

@@ -39,7 +39,7 @@ module Faraday
       def serializable_hash
         {
           method: @method,
-          url: @url,
+          url: @url.to_s,
           headers: @headers
         }
       end

data/lib/faraday/http_cache/response.rb

@@ -50,7 +50,7 @@ module Faraday
       #
       # Returns true if the response is fresh, otherwise false.
       def fresh?
-        !cache_control.must_revalidate? && !cache_control.no_cache? && ttl && ttl > 0
+        !cache_control.no_cache? && ttl && ttl > 0
       end
 
       # Internal: Checks if the Response returned a 'Not Modified' status.

data/lib/faraday/http_cache/storage.rb

@@ -56,7 +56,7 @@ module Faraday
         entries << entry
 
         cache.write(key, entries)
-      rescue Encoding::UndefinedConversionError => e
+      rescue ::Encoding::UndefinedConversionError => e
         warn "Response could not be serialized: #{e.message}. Try using Marshal to serialize."
         raise e
       end

data/spec/http_cache_spec.rb

@@ -180,9 +180,12 @@ describe Faraday::HttpCache do
   end
 
   context 'when the request has a "no-cache" directive' do
-    it 'by-passes the cache' do
-      client.get('get', nil, 'Cache-Control' => 'no-cache')
-      expect(client.get('get', nil, 'Cache-Control' => 'no-cache').body).to eq('2')
+    it 'revalidates the cache' do
+      expect(client.get('etag').body).to eq('1')
+      expect(client.get('etag', nil, 'Cache-Control' => 'no-cache').body).to eq('1')
+
+      expect(client.get('get', nil).body).to eq('2')
+      expect(client.get('etag', nil, 'Cache-Control' => 'no-cache').body).to eq('3')
     end
 
     it 'caches the response' do
@@ -224,7 +227,7 @@ describe Faraday::HttpCache do
 
   it 'logs that the request with "Last-Modified" was revalidated' do
     client.get('timestamped')
-    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /timestamped] valid, store') }
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /timestamped] must_revalidate, valid, store') }
     expect(client.get('timestamped').body).to eq('1')
   end
 
@@ -235,7 +238,7 @@ describe Faraday::HttpCache do
 
   it 'logs that the request with "ETag" was revalidated' do
     client.get('etag')
-    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /etag] valid, store') }
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /etag] must_revalidate, valid, store') }
     expect(client.get('etag').body).to eq('1')
   end
 
@@ -274,6 +277,11 @@ describe Faraday::HttpCache do
     expect(first_vary).not_to eql(second_vary)
   end
 
+  it 'caches non-stale response with "must-revalidate" directive' do
+    client.get('must-revalidate')
+    expect(client.get('must-revalidate').body).to eq('1')
+  end
+
   it 'raises an error when misconfigured' do
     expect {
       client = Faraday.new(url: ENV['FARADAY_SERVER']) do |stack|

data/spec/response_spec.rb

@@ -89,8 +89,16 @@ describe Faraday::HttpCache::Response do
       expect(response).not_to be_fresh
     end
 
-    it 'is not fresh if Cache Control has "must-revalidate"' do
+    it 'is fresh if the response contains "must-revalidate" and is not stale' do
       date = (Time.now - 200).httpdate
+      headers = { 'Cache-Control' => 'public, max-age=23880, must-revalidate, no-transform', 'Date' => date }
+      response = Faraday::HttpCache::Response.new(response_headers: headers)
+
+      expect(response).to be_fresh
+    end
+
+    it 'is not fresh if Cache Control has "must-revalidate" and is stale' do
+      date = (Time.now - 500).httpdate
       headers = { 'Cache-Control' => 'max-age=400, must-revalidate', 'Date' => date }
       response = Faraday::HttpCache::Response.new(response_headers: headers)
 

data/spec/storage_spec.rb

@@ -55,7 +55,7 @@ describe Faraday::HttpCache::Storage do
 
           expect {
             storage.write(request, response)
-          }.to raise_error(Encoding::UndefinedConversionError)
+          }.to raise_error(::Encoding::UndefinedConversionError)
           expect(logger).to have_received(:warn).with(
             'Response could not be serialized: "\xE2" from ASCII-8BIT to UTF-8. Try using Marshal to serialize.'
           )

data/spec/support/test_app.rb

@@ -88,6 +88,10 @@ class TestApp < Sinatra::Base
     [200, { 'Date' => settings.yesterday, 'Expires' => settings.yesterday }, increment_counter]
   end
 
+  get '/must-revalidate' do
+    [200, { 'Date' => Time.now.httpdate, 'Cache-Control' => 'public, max-age=23880, must-revalidate, no-transform' }, increment_counter]
+  end
+
   get '/timestamped' do
     settings.counter += 1
     header = settings.counter > 2 ? '1' : '2'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Lucas Mazza
+- George Guimarães
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -26,7 +27,7 @@ dependencies:
         version: '0.8'
 description: Middleware to handle HTTP caching
 email:
-- opensource@plataformatec.com.br
+- opensource@sourcelevel.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -52,7 +53,7 @@ files:
 - spec/support/test_app.rb
 - spec/support/test_server.rb
 - spec/validation_spec.rb
-homepage: https://github.com/plataformatec/faraday-http-cache
+homepage: https://github.com/sourcelevel/faraday-http-cache
 licenses:
 - Apache 2.0
 metadata: {}
@@ -72,21 +73,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Faraday middleware that stores and validates cache expiration.
 test_files:
-- spec/binary_spec.rb
-- spec/cache_control_spec.rb
-- spec/http_cache_spec.rb
-- spec/instrumentation_spec.rb
-- spec/json_spec.rb
-- spec/request_spec.rb
-- spec/response_spec.rb
 - spec/spec_helper.rb
+- spec/validation_spec.rb
+- spec/json_spec.rb
+- spec/instrumentation_spec.rb
 - spec/storage_spec.rb
-- spec/support/empty.png
+- spec/http_cache_spec.rb
+- spec/binary_spec.rb
 - spec/support/test_app.rb
+- spec/support/empty.png
 - spec/support/test_server.rb
-- spec/validation_spec.rb
+- spec/request_spec.rb
+- spec/cache_control_spec.rb
+- spec/response_spec.rb