faraday-http-cache 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f19d02b8f8069a385636da706ab6ac31f03ed794
-  data.tar.gz: 86052f071b2b1cee24dc7fa8af957cd59fd95244
+SHA256:
+  metadata.gz: 962b23db73b9799330e7229f9a6d6e252705a55f3c3ad316f810132160a30522
+  data.tar.gz: 51a43a544f924e75c00ffffd777368cf995000a3855e1ea7b9b86fb54b5f6b2a
 SHA512:
-  metadata.gz: 3c14cd6befa55a2df9e08c24df11fb92a437384e0490a705193506905ac1532fcb43e6439867bc8243b35dafd1610a965fa5a3bbf6feabfe4321544e7cbe1664
-  data.tar.gz: 764cc0374795c32d68bb64399698450c367916b7ef69612d07a91b9619c893fa5b35b65cb76930e9fb129e3d53694bde6a11a99c4ee14238b9beac4f1dd1e2ea
+  metadata.gz: 57de8b27682d5aa8367fd7612ec3814c300a0856ba7e1ee61354646117a2370f216981b60f5224662236444a44669a70840fb07118602a82b66a0c886ae1540d
+  data.tar.gz: d8e1644ed674c3c7a6c8f44adfe83eda6f9268590235330eaf0ed62ec41795a97a35f28f52bddf7c3103a8cef6c849330167b1b708a6c8124da642e371bf434b

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
 

data/lib/faraday/http_cache/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'time'
 require 'faraday/http_cache/cache_control'
 
@@ -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'
 
@@ -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'
@@ -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
 
@@ -71,7 +72,7 @@ module Faraday
       :uncacheable,
 
       # The request was cached but need to be revalidated by the server.
-      :must_revalidate,
+      :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
@@ -263,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

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

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
@@ -228,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 })
@@ -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

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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
-- Lucas Mazza
 - George Guimarães
-autorequire: 
+- Gustavo Araujo
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -55,9 +55,9 @@ files:
 - spec/validation_spec.rb
 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
@@ -65,16 +65,15 @@ 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.6.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A Faraday middleware that stores and validates cache expiration.
 test_files: