faraday-http-cache 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 942379737f4eb3fb24ad2aee9663f11f0a9a0e6a
-  data.tar.gz: 26bea5cb199a05a64c86bc10db16439fd44351fe
+  metadata.gz: 92ef39b3697fc4f6a5d9482310bcbe449c9e8707
+  data.tar.gz: 43dd20b8cfce84a09a94d66bfb8843ff5e229184
 SHA512:
-  metadata.gz: e83a8ad2f7020b72a74e7932d343228648e50e68cc0c08ab18002de0fafcfff78598c34c4146ae2b2fd5fa1a1764897767f16b845bedd529886e5974b7279a61
-  data.tar.gz: 8d50e77a3a902a432f8bdafb559fc9a8f30f5904826893ea68c0bbf04b352ad4eb3620d5af228f544cb8938dc3863b4ad693a5ffc2f103d86723945e0dc7b01e
+  metadata.gz: afd6c8d4f672f3aab445124dbb604930e35c959ad27478093d34c8cd070f474b8b7ed89d8420147a890aeeb564ff19dedd4beedfd9ffe3e4c1a9ded568e36f19
+  data.tar.gz: c74d2527626fc7ea4b67f83063006489ebb32a86b16edff9f0e2df5e240866d9156779d93cc3680ecd22c69e988753f372140c1b5cfdc7ba3deb6caa2f1d864f

data/lib/faraday/http_cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'faraday'
 
 require 'faraday/http_cache/storage'
@@ -43,15 +44,12 @@ module Faraday
   #     builder.use :http_cache, store: Rails.cache, instrumenter: ActiveSupport::Notifications
   #   end
   class HttpCache < Faraday::Middleware
-    # Internal: valid options for the 'initialize' configuration Hash.
-    VALID_OPTIONS = [:store, :serializer, :logger, :shared_cache, :instrumenter, :instrument_name].freeze
-
     UNSAFE_METHODS = [:post, :put, :delete, :patch].freeze
 
     ERROR_STATUSES = (400..499).freeze
 
     # The name of the instrumentation event.
-    EVENT_NAME = 'http_cache.faraday'.freeze
+    EVENT_NAME = 'http_cache.faraday'
 
     CACHE_STATUSES = [
       # The request was not cacheable.
@@ -79,13 +77,12 @@ module Faraday
     # Public: Initializes a new HttpCache middleware.
     #
     # app  - the next endpoint on the 'Faraday' stack.
-    # args - aditional options to setup the logger and the storage.
-    #             :logger          - A logger object.
-    #             :serializer      - A serializer that should respond to 'dump' and 'load'.
-    #             :shared_cache    - A flag to mark the middleware as a shared cache or not.
-    #             :store           - A cache store that should respond to 'read', 'write', and 'delete'.
-    #             :instrumenter    - An instrumentation object that should respond to 'instrument'.
-    #             :instrument_name - The String name of the instrument being reported on (optional).
+    # :store           - A cache store that should respond to 'read', 'write', and 'delete'.
+    # :serializer      - A serializer that should respond to 'dump' and 'load'.
+    # :shared_cache    - A flag to mark the middleware as a shared cache or not.
+    # :instrumenter    - An instrumentation object that should respond to 'instrument'.
+    # :instrument_name - The String name of the instrument being reported on (optional).
+    # :logger          - A logger object.
     #
     # Examples:
     #
@@ -102,15 +99,14 @@ 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, options = {})
+    def initialize(app, store: nil, serializer: nil, shared_cache: true, instrumenter: nil, instrument_name: EVENT_NAME, logger: nil) # rubocop:disable Metrics/ParameterLists
       super(app)
-      assert_valid_options!(options)
 
-      @logger = options[:logger]
-      @shared_cache = options.fetch(:shared_cache, true)
-      @instrumenter = options[:instrumenter]
-      @instrument_name = options.fetch(:instrument_name, EVENT_NAME)
-      @storage = create_storage(options)
+      @logger = logger
+      @shared_cache = shared_cache
+      @instrumenter = instrumenter
+      @instrument_name = instrument_name
+      @storage = Storage.new(store: store, serializer: serializer, logger: logger)
     end
 
     # Public: Process the request into a duplicate of this instance to
@@ -166,15 +162,6 @@ module Faraday
     # Internal: Gets the storage instance associated with the middleware.
     attr_reader :storage
 
-    # Public: Creates the Storage instance for this middleware.
-    #
-    # options - A Hash of options.
-    #
-    # Returns a Storage instance.
-    def create_storage(options)
-      Storage.new(options)
-    end
-
     private
 
     # Internal: Should this cache instance act like a "shared cache" according
@@ -362,21 +349,6 @@ module Faraday
     def extract_status(trace)
       CACHE_STATUSES.find { |status| trace.include?(status) }
     end
-
-    # Internal: Checks if the given 'options' Hash contains only
-    # valid keys. Please see the 'VALID_OPTIONS' constant for the
-    # acceptable keys.
-    #
-    # Raises an 'ArgumentError'.
-    #
-    # Returns nothing.
-    def assert_valid_options!(options)
-      options.each_key do |key|
-        unless VALID_OPTIONS.include?(key)
-          raise ArgumentError.new("Unknown option: #{key}. Valid options are :#{VALID_OPTIONS.join(', ')}")
-        end
-      end
-    end
   end
 end
 

data/lib/faraday/http_cache/cache_control.rb

@@ -1,3 +1,4 @@
+# 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,3 +1,4 @@
+# frozen_string_literal: true
 module Faraday
   class HttpCache < Faraday::Middleware
     # Internal: A class to represent a request
@@ -11,8 +12,10 @@ module Faraday
 
       attr_reader :method, :url, :headers
 
-      def initialize(options)
-        @method, @url, @headers = options.values_at(:method, :url, :headers)
+      def initialize(method:, url:, headers:)
+        @method = method
+        @url = url
+        @headers = headers
       end
 
       # Internal: Validates if the current request method is valid for caching.

data/lib/faraday/http_cache/response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'time'
 require 'faraday/http_cache/cache_control'
 
@@ -49,7 +50,7 @@ module Faraday
       #
       # Returns true if the response is fresh, otherwise false.
       def fresh?
-        !cache_control.no_cache? && ttl && ttl > 0
+        !cache_control.must_revalidate? && !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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 require 'digest/sha1'
 
@@ -8,29 +9,29 @@ module Faraday
     # Examples
     #
     #   # Creates a new Storage using a MemCached backend from ActiveSupport.
-    #   Faraday::HttpCache::Storage.new(:mem_cache_store)
+    #   mem_cache_store = ActiveSupport::Cache.lookup_store(:mem_cache_store, ['localhost:11211'])
+    #   Faraday::HttpCache::Storage.new(store: mem_cache_store)
     #
     #   # Reuse some other instance of an ActiveSupport::Cache::Store object.
-    #   Faraday::HttpCache::Storage.new(Rails.cache)
+    #   Faraday::HttpCache::Storage.new(store: Rails.cache)
     #
     #   # Creates a new Storage using Marshal for serialization.
-    #   Faraday::HttpCache::Storage.new(:memory_store, serializer: Marshal)
+    #   Faraday::HttpCache::Storage.new(store: Rails.cache, serializer: Marshal)
     class Storage
       # Public: Gets the underlying cache store object.
       attr_reader :cache
 
       # Internal: Initialize a new Storage object with a cache backend.
       #
-      # options - Storage options (default: {}).
-      #           :logger        - A Logger object to be used to emit warnings.
-      #           :store         - An cache store object that should
-      #                            respond to 'read', 'write', and 'delete'.
-      #           :serializer    - A serializer object that should
-      #                            respond to 'dump' and 'load'.
-      def initialize(options = {})
-        @cache = options[:store] || MemoryStore.new
-        @serializer = options[:serializer] || JSON
-        @logger = options[:logger]
+      # :logger     - A Logger object to be used to emit warnings.
+      # :store      - An cache store object that should respond to 'read',
+      #              'write', and 'delete'.
+      # :serializer - A serializer object that should respond to 'dump'
+      #               and 'load'.
+      def initialize(store: nil, serializer: nil, logger: nil)
+        @cache = store || MemoryStore.new
+        @serializer = serializer || JSON
+        @logger = logger
         assert_valid_store!
       end
 
@@ -68,7 +69,7 @@ module Faraday
       # klass    - The Class to be instantiated with the stored response.
       #
       # Returns an instance of 'klass'.
-      def read(request, klass = Faraday::HttpCache::Response)
+      def read(request, klass: Faraday::HttpCache::Response)
         cache_key = cache_key_for(request.url)
         entries = cache.read(cache_key)
         response = lookup_response(request, entries)

data/spec/binary_spec.rb

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

data/spec/cache_control_spec.rb

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

data/spec/http_cache_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Faraday::HttpCache do
@@ -289,7 +290,7 @@ describe Faraday::HttpCache do
     it 'uses the options to create a Cache Store' do
       store = double(read: nil, write: nil)
 
-      expect(Faraday::HttpCache::Storage).to receive(:new).with(store: store)
+      expect(Faraday::HttpCache::Storage).to receive(:new).with(hash_including(store: store))
       Faraday::HttpCache.new(app, store: store)
     end
   end

data/spec/instrumentation_spec.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 require 'spec_helper'
+require 'active_support'
+require 'active_support/notifications'
 
 describe 'Instrumentation' do
   let(:backend) { Faraday::Adapter::Test::Stubs.new }

data/spec/json_spec.rb

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

data/spec/request_spec.rb

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

data/spec/response_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Faraday::HttpCache::Response do
@@ -87,6 +88,14 @@ describe Faraday::HttpCache::Response do
 
       expect(response).not_to be_fresh
     end
+
+    it 'is not fresh if Cache Control has "must-revalidate"' do
+      date = (Time.now - 200).httpdate
+      headers = { 'Cache-Control' => 'max-age=400, must-revalidate', 'Date' => date }
+      response = Faraday::HttpCache::Response.new(response_headers: headers)
+
+      expect(response).not_to be_fresh
+    end
   end
 
   it 'sets the "Date" header if is not present' do

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'uri'
 require 'socket'
 

data/spec/storage_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Faraday::HttpCache::Storage do
@@ -44,7 +45,7 @@ describe Faraday::HttpCache::Storage do
 
       context 'when ASCII characters in response cannot be converted to UTF-8' do
         let(:response) do
-          body = "\u2665".force_encoding('ASCII-8BIT')
+          body = String.new("\u2665").force_encoding('ASCII-8BIT')
           double(:response, serializable_hash: { 'body' => body })
         end
 

data/spec/support/test_app.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sinatra/base'
 require 'json'
 

data/spec/support/test_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'net/http'
 
 class TestServer

data/spec/validation_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -64,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="