faraday-http-cache 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 92ef39b3697fc4f6a5d9482310bcbe449c9e8707
-  data.tar.gz: 43dd20b8cfce84a09a94d66bfb8843ff5e229184
+SHA256:
+  metadata.gz: 962b23db73b9799330e7229f9a6d6e252705a55f3c3ad316f810132160a30522
+  data.tar.gz: 51a43a544f924e75c00ffffd777368cf995000a3855e1ea7b9b86fb54b5f6b2a
 SHA512:
-  metadata.gz: afd6c8d4f672f3aab445124dbb604930e35c959ad27478093d34c8cd070f474b8b7ed89d8420147a890aeeb564ff19dedd4beedfd9ffe3e4c1a9ded568e36f19
-  data.tar.gz: c74d2527626fc7ea4b67f83063006489ebb32a86b16edff9f0e2df5e240866d9156779d93cc3680ecd22c69e988753f372140c1b5cfdc7ba3deb6caa2f1d864f
+  metadata.gz: 57de8b27682d5aa8367fd7612ec3814c300a0856ba7e1ee61354646117a2370f216981b60f5224662236444a44669a70840fb07118602a82b66a0c886ae1540d
+  data.tar.gz: d8e1644ed674c3c7a6c8f44adfe83eda6f9268590235330eaf0ed62ec41795a97a35f28f52bddf7c3103a8cef6c849330167b1b708a6c8124da642e371bf434b

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/cache_control.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Faraday
   class HttpCache < Faraday::Middleware
     # Internal: A class to represent the 'Cache-Control' header options.

data/lib/faraday/http_cache/request.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Faraday
   class HttpCache < Faraday::Middleware
     # Internal: A class to represent a request
@@ -24,6 +25,7 @@ module Faraday
       def cacheable?
         return false if method != :get && method != :head
         return false if cache_control.no_store?
+
         true
       end
 
@@ -39,7 +41,7 @@ module Faraday
       def serializable_hash
         {
           method: @method,
-          url: @url,
+          url: @url.to_s,
           headers: @headers
         }
       end

data/lib/faraday/http_cache/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'time'
 require 'faraday/http_cache/cache_control'
 
@@ -50,7 +51,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.
@@ -204,7 +205,7 @@ module Faraday
       # Returns nothing.
       def ensure_date_header!
         date
-      rescue
+      rescue StandardError
         headers['Date'] = @now.httpdate
       end
 

data/lib/faraday/http_cache/storage.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'json'
 require 'digest/sha1'
 
@@ -56,7 +57,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
@@ -167,7 +168,7 @@ module Faraday
       end
 
       def warn(message)
-        @logger.warn(message) if @logger
+        @logger&.warn(message)
       end
     end
 

data/lib/faraday/http_cache.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'faraday'
 
 require 'faraday/http_cache/storage'
@@ -19,7 +20,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
   #
@@ -44,7 +45,7 @@ module Faraday
   #     builder.use :http_cache, store: Rails.cache, instrumenter: ActiveSupport::Notifications
   #   end
   class HttpCache < Faraday::Middleware
-    UNSAFE_METHODS = [:post, :put, :delete, :patch].freeze
+    UNSAFE_METHODS = %i[post put delete patch].freeze
 
     ERROR_STATUSES = (400..499).freeze
 
@@ -61,7 +62,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 +71,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.
@@ -99,14 +100,21 @@ module Faraday
     #   # Initialize the middleware with a MemoryStore and logger
     #   store = ActiveSupport::Cache.lookup_store
     #   Faraday::HttpCache.new(app, store: store, logger: my_logger)
-    def initialize(app, store: nil, serializer: nil, shared_cache: true, instrumenter: nil, instrument_name: EVENT_NAME, logger: nil) # rubocop:disable Metrics/ParameterLists
+    def initialize(app, options = {})
       super(app)
 
-      @logger = logger
-      @shared_cache = shared_cache
-      @instrumenter = instrumenter
-      @instrument_name = instrument_name
-      @storage = Storage.new(store: store, serializer: serializer, logger: logger)
+      options = options.dup
+      @logger = options.delete(:logger)
+      @shared_cache = options.delete(:shared_cache) { true }
+      @instrumenter = options.delete(:instrumenter)
+      @instrument_name = options.delete(:instrument_name) { EVENT_NAME }
+
+      store = options.delete(:store)
+      serializer = options.delete(:serializer)
+
+      raise ArgumentError, "Unknown options: #{options.inspect}" unless options.empty?
+
+      @storage = Storage.new(store: store, serializer: serializer, logger: @logger)
     end
 
     # Public: Process the request into a duplicate of this instance to
@@ -132,15 +140,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 +194,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
 
@@ -270,7 +271,7 @@ module Faraday
     end
 
     def delete(request, response)
-      headers = %w(Location Content-Location)
+      headers = %w[Location Content-Location]
       headers.each do |header|
         url = response.headers[header]
         @storage.delete(url) if url
@@ -304,7 +305,7 @@ module Faraday
 
       {
         status: hash[:status],
-        body: hash[:body],
+        body: hash[:body] || hash[:response_body],
         response_headers: hash[:response_headers]
       }
     end

data/spec/binary_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache do
@@ -10,7 +11,7 @@ describe Faraday::HttpCache do
       stack.adapter adapter.to_sym
     end
   end
-  let(:data) { IO.binread File.expand_path('../support/empty.png', __FILE__) }
+  let(:data) { IO.binread File.expand_path('support/empty.png', __dir__) }
 
   it 'works fine with binary data' do
     expect(client.get('image').body).to eq data

data/spec/cache_control_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache::CacheControl do

data/spec/http_cache_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache do
@@ -36,7 +37,7 @@ describe Faraday::HttpCache do
 
   it 'adds a trace of the actions performed to the env' do
     response = client.post('post')
-    expect(response.env[:http_cache_trace]).to eq([:unacceptable, :delete])
+    expect(response.env[:http_cache_trace]).to eq(%i[unacceptable delete])
   end
 
   describe 'cache invalidation' do
@@ -180,9 +181,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 +228,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 +239,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 +278,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/instrumentation_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 require 'active_support'
 require 'active_support/notifications'

data/spec/json_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache do

data/spec/request_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache::Request do

data/spec/response_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache::Response do
@@ -89,8 +90,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)
 
@@ -220,11 +229,11 @@ describe Faraday::HttpCache::Response do
   describe 'remove age before caching and normalize max-age if non-zero age present' do
     it 'is fresh if the response still has some time to live' do
       headers = {
-          'Age' => 6,
-          'Cache-Control' => 'public, max-age=40',
-          'Date' => (Time.now - 38).httpdate,
-          'Expires' => (Time.now - 37).httpdate,
-          'Last-Modified' => (Time.now - 300).httpdate
+        'Age' => 6,
+        'Cache-Control' => 'public, max-age=40',
+        'Date' => (Time.now - 38).httpdate,
+        'Expires' => (Time.now - 37).httpdate,
+        'Last-Modified' => (Time.now - 300).httpdate
       }
       response = Faraday::HttpCache::Response.new(response_headers: headers)
       expect(response).to be_fresh

data/spec/spec_helper.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
+
 require 'uri'
 require 'socket'
 
 require 'faraday-http-cache'
-require 'faraday_middleware'
 
-# https://github.com/rails/rails/pull/14667
-require 'active_support/per_thread_registry'
+if Gem::Version.new(Faraday::VERSION) < Gem::Version.new('1.0')
+  require 'faraday_middleware'
+elsif ENV['FARADAY_ADAPTER'] == 'em_http'
+  require 'faraday/em_http'
+end
+
+require 'active_support'
 require 'active_support/cache'
 
 require 'support/test_app'

data/spec/storage_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache::Storage do
@@ -43,7 +44,7 @@ describe Faraday::HttpCache::Storage do
       let(:serializer) { JSON }
       it_behaves_like 'A storage with serialization'
 
-      context 'when ASCII characters in response cannot be converted to UTF-8' do
+      context 'when ASCII characters in response cannot be converted to UTF-8', if: Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.1') do
         let(:response) do
           body = String.new("\u2665").force_encoding('ASCII-8BIT')
           double(:response, serializable_hash: { 'body' => body })
@@ -55,7 +56,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.'
           )
@@ -111,11 +112,11 @@ describe Faraday::HttpCache::Storage do
   describe 'remove age before caching and normalize max-age if non-zero age present' do
     it 'is fresh if the response still has some time to live' do
       headers = {
-          'Age' => 6,
-          'Cache-Control' => 'public, max-age=40',
-          'Date' => (Time.now - 38).httpdate,
-          'Expires' => (Time.now - 37).httpdate,
-          'Last-Modified' => (Time.now - 300).httpdate
+        'Age' => 6,
+        'Cache-Control' => 'public, max-age=40',
+        'Date' => (Time.now - 38).httpdate,
+        'Expires' => (Time.now - 37).httpdate,
+        'Last-Modified' => (Time.now - 300).httpdate
       }
       response = Faraday::HttpCache::Response.new(response_headers: headers)
       expect(response).to be_fresh

data/spec/support/test_app.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'sinatra/base'
 require 'json'
 
@@ -27,7 +28,7 @@ class TestApp < Sinatra::Base
   end
 
   get '/image' do
-    image = File.expand_path('../empty.png', __FILE__)
+    image = File.expand_path('empty.png', __dir__)
     data  = IO.binread(image)
     [200, { 'Cache-Control' => 'max-age=400', 'Content-Type' => 'image/png' }, data]
   end
@@ -88,6 +89,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'

data/spec/support/test_server.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'net/http'
 
 class TestServer
@@ -27,11 +28,11 @@ class TestServer
       log = File.open('log/test.log', 'w+')
       log.sync = true
       webrick_opts = {
-       Port: @port,
-       Logger:  WEBrick::Log.new(log),
-       AccessLog: [[log, '[%{X-Faraday-Adapter}i] %m  %U  ->  %s %b']]
+        Port: @port,
+        Logger: WEBrick::Log.new(log),
+        AccessLog: [[log, '[%{X-Faraday-Adapter}i] %m  %U  ->  %s %b']]
       }
-      Rack::Handler::WEBrick.run(TestApp, webrick_opts)
+      Rack::Handler::WEBrick.run(TestApp, **webrick_opts)
     end
   end
 
@@ -39,7 +40,7 @@ class TestServer
     conn = Net::HTTP.new @host, @port
     conn.open_timeout = conn.read_timeout = 0.1
 
-    responsive = ->(path) { # rubocop:disable Style/BlockDelimiters
+    responsive = ->(path) {
       begin
         res = conn.start { conn.get(path) }
         res.is_a?(Net::HTTPSuccess)
@@ -51,6 +52,7 @@ class TestServer
     server_pings = 0
     loop do
       break if responsive.call('/ping')
+
       server_pings += 1
       sleep 0.05
       abort 'test server did not managed to start' if server_pings >= 50
@@ -61,6 +63,6 @@ class TestServer
     server = TCPServer.new(@host, 0)
     server.addr[1]
   ensure
-    server.close if server
+    server&.close
   end
 end

data/spec/validation_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Faraday::HttpCache do

metadata

@@ -1,32 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.0
 platform: ruby
 authors:
-- Lucas Mazza
-autorequire: 
+- George Guimarães
+- Gustavo Araujo
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
 description: Middleware to handle HTTP caching
 email:
-- opensource@plataformatec.com.br
+- opensource@sourcelevel.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -52,11 +53,11 @@ 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
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,29 +65,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+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