httparty-cache 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b5ee7949c1ff90bad003ea68a65b11de85f2aba908c3aa3b733e53976d15b33
-  data.tar.gz: d7f636874b72c75534ec6e060fc44c1fd3eb3191f80986b0a69bdc6c41e29279
+  metadata.gz: 0fede8274e3bf761ebaa8b53d8ad10ab957e92c6bfba35391de1de907bd91800
+  data.tar.gz: 1b5ac5dcaf6da720d56f7b9e9b6c88ff706f4b7be2fe48383eec4ecd4359619c
 SHA512:
-  metadata.gz: 9af68ad0b61042517beea619be96074c5e0f8c87c99e8f1094a6d6efdc63da87a5dcb31349435d17ae61755ac34ba7a9c50709f71b4b22ed87ff93db309bca60
-  data.tar.gz: 59fcbe7267b2eb0670605770bdf450784d06290089cbe8c0e66cd18919283564c77b798ba7556c4c24010e6c058e0c013b4018ca723fb1ddb60862732a7ab1c5
+  metadata.gz: a515bd37ba299cfa32ffb50cae4b073592652073e6857a505a48e80195c998a21eeb464384806f4703a8855b861f0013cf9ff2fe84e8284ddca6f2f998fedfc0
+  data.tar.gz: 171aac5d0d92adf07222824047462c20e88a3bf806426de0e0aaae08572ac4272767b10e6279415e2f1d7502bbbe1a7191b4a8f6edc7577bf084a8cc01878e5e

data/README.md

@@ -123,3 +123,11 @@ class Client
     # or
     cache_store HTTParty::Cache::Store::Jekyll.new(name: 'My::Jekyll::Cache')
 end
+```
+
+## Caveats!
+
+* Response marshaling has been changed to prevent stack level too deep
+  exceptions while marshaling the request.  Bringing a response from the
+  cache will have a request with the original HTTP method, path and
+  headers sent.

data/lib/httparty/cache/request.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require 'digest/sha2'
+
 module HTTParty
   module Cache
     # Extends HTTParty::Request with caching methods
     #
     # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching}
     module Request
-      SENSITIVE_HEADERS = %w[Cookie Authorization Date Signature].freeze
+      SENSITIVE_HEADERS = %w[cookie authorization date signature].freeze
       CACHE_REVALIDATION_HEADERS = {
         'ETag' => 'If-None-Match',
         'Last-Modified' => 'If-Modified-Since'
@@ -16,14 +18,18 @@ module HTTParty
       #
       # @return [String]
       def cache_key
-        @cache_key ||= "http-party-cache:request:#{uri}##{URI.encode_www_form(cache_params)}"
+        @cache_key ||=
+          begin
+            key = "#{uri}##{URI.encode_www_form(cache_params)}"
+            "httpparty-cache:request:#{Digest::SHA2.hexdigest(key)}"
+          end
       end
 
       # @return [Hash]
       def cache_params
-        return { 'X-Cache-Key' => options[:cache_key] } if options.key? :cache_key
+        return { 'x-cache-key' => options[:cache_key] } if options.key? :cache_key
 
-        options[:headers].to_h.except(*SENSITIVE_HEADERS) || {}
+        options[:headers].to_h.transform_keys(&:downcase).except(*SENSITIVE_HEADERS)
       end
 
       def validate
@@ -47,7 +53,7 @@ module HTTParty
         return super(&block) unless cacheable?
 
         if response_cached?
-          handle_revalidation
+          handle_revalidation(&block)
         else
           super(&block).tap do |response|
             # Point current request to cached response
@@ -81,24 +87,26 @@ module HTTParty
       # Revalidates request
       #
       # @return [HTTParty::Response]
-      def handle_revalidation
+      def handle_revalidation(&block)
         if cached_response.revalidate? || cached_response.stale?
           self.http_method = Net::HTTP::Head
-          options[:cached_response] = cached_response
 
           add_cache_revalidation_headers
 
+          # Don't run the block here
           response = perform
 
           if response.not_modified?
             cached_response.headers['date'] = response.headers['date']
             response = cached_response
+            response.hit!
           else
             self.http_method = Net::HTTP::Get
             # Remove from cache so we can perform the request, otherwise
             # we produce an infinite loop
             cache_store.delete(cache_key)
-            @cached_response = response = perform
+            @cached_response = response = perform(&block)
+            response.miss!
           end
 
           cache_store.set(response.cache_key, response)
@@ -120,7 +128,7 @@ module HTTParty
         options[:headers] ||= {}
 
         CACHE_REVALIDATION_HEADERS.each_pair do |original_header, revalidation_header|
-          next if (value = options[:cached_response].headers[original_header]).nil?
+          next if (value = cached_response.headers[original_header]).nil?
 
           options[:headers][revalidation_header] ||= value
         end

data/lib/httparty/cache/response.rb

@@ -1,11 +1,56 @@
 # frozen_string_literal: true
 
+require 'digest/sha2'
+
 module HTTParty
   module Cache
     # Extends HTTParty::Response with caching methods
     #
     # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching}
     module Response
+      X_HEADER = 'x-httparty-cache'
+      HIT = 'hit'
+      MISS = 'miss'
+
+      # Prevent stack too deep errors while keeping important
+      # information
+      def _dump(_level)
+        _request = HTTParty::Request.new(request.http_method, request.path, headers: request.options[:headers]&.to_hash)
+        _body = response.instance_variable_get(:@body)
+        _read_adapter = _body.is_a?(Net::ReadAdapter)
+
+        response.instance_variable_set(:@body, nil) if _read_adapter
+
+        Marshal.dump([_request, response, parsed_response, body]).tap do
+          response.instance_variable_set(:@body, _body) if _read_adapter
+        end
+      end
+
+      def hit!
+        response[X_HEADER] = headers[X_HEADER] = HIT
+      end
+
+      def miss!
+        response[X_HEADER] = headers[X_HEADER] = MISS
+      end
+
+      def fresh!
+        response.delete(X_HEADER)
+        headers.delete(X_HEADER)
+      end
+
+      def hit?
+        headers[X_HEADER] == HIT
+      end
+
+      def miss?
+        headers[X_HEADER] == MISS
+      end
+
+      def reused?
+        headers.key?(X_HEADER)
+      end
+
       # Parses Cache-Control headers
       #
       # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/cache-control}
@@ -62,18 +107,22 @@ module HTTParty
       #
       # @return [Hash]
       def vary
-        @vary ||= request.options[:headers].to_h.slice(*headers['Vary'].to_s.split(',').map(&:strip).sort)
+        @vary ||= request.options[:headers].to_h.slice(*headers['vary'].to_s.split(',').map(&:strip).sort).transform_keys(&:downcase)
       end
 
       # Generates a cache key
       #
       # @return [String]
       def cache_key
-        @cache_key ||= "httparty-cache:response:#{request.uri}##{URI.encode_www_form vary}"
+        @cache_key ||=
+          begin
+            key = "#{uri}##{URI.encode_www_form(vary)}"
+            "httparty-cache:response:#{Digest::SHA2.hexdigest(key)}"
+          end
       end
     end
   end
 end
 
 # Patch HTTParty::Response
-HTTParty::Response.include HTTParty::Cache::Response
+HTTParty::Response.prepend HTTParty::Cache::Response

data/lib/httparty/cache/store/jekyll.rb

@@ -21,6 +21,14 @@ module HTTParty
           @store = ::Jekyll::Cache.new(name)
         end
 
+        def _dump(_)
+          Marshal.dump(options[:name])
+        end
+
+        def self._load(string)
+          new(name: Marshal.load(string))
+        end
+
         def set(key, response)
           @store[key] = response
           response

data/lib/httparty/cache/store/memory.rb

@@ -19,6 +19,14 @@ module HTTParty
           clear
         end
 
+        def _dump(_)
+          Marshal.dump(nil)
+        end
+
+        def self._load(_)
+          new
+        end
+
         def getset(key)
           store[key] ||= yield
         end

data/lib/httparty/cache/store/redis.rb

@@ -21,6 +21,14 @@ module HTTParty
 
         # @param :redis_url [String]
         def initialize(redis_url: nil)
+          marshal_load(redis_url)
+        end
+
+        def marshal_dump
+          options[:redis_url]
+        end
+
+        def marshal_load(redis_url)
           @options = {}
           @options[:redis_url] = redis_url || ENV['REDIS_URL']
           @config = RedisClient.config(url: @options[:redis_url])
@@ -28,6 +36,16 @@ module HTTParty
           @redis.call('PING')
         end
 
+        # I couldn't get this to work! It's never called even if I dump
+        # the store directly
+        def _dump(level)
+          options[:redis_url]
+        end
+
+        def self._load(string)
+          new(redis_url: string)
+        end
+
         # Retrieves a key
         #
         # @param :key [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httparty-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty