httparty-cache 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff16750de74919a4428091908be24f05775deded7885af69960c38265ee1679b
-  data.tar.gz: 12ccabffc3f4d24dfeef6327a3ac5649560b275051840826f31c3482e2075b2d
+  metadata.gz: 6b5ee7949c1ff90bad003ea68a65b11de85f2aba908c3aa3b733e53976d15b33
+  data.tar.gz: d7f636874b72c75534ec6e060fc44c1fd3eb3191f80986b0a69bdc6c41e29279
 SHA512:
-  metadata.gz: f2d9b8a53ed1ef26b0ab22dc64108ea69cecfc76c13505b4d184e2df0823ddb78857ccf815152bc1adf202a94a0b1a3010af4c7714012842f675ee3428c6109e
-  data.tar.gz: 5b33148ca9f3d650218f66ca59964c04c91e87dfa730f8cd997aaad87fe36d19decdf1833463512ecc3f457cbe1bb8b5fbe7c5f4527325fe686cde1718b335e7
+  metadata.gz: 9af68ad0b61042517beea619be96074c5e0f8c87c99e8f1094a6d6efdc63da87a5dcb31349435d17ae61755ac34ba7a9c50709f71b4b22ed87ff93db309bca60
+  data.tar.gz: 59fcbe7267b2eb0670605770bdf450784d06290089cbe8c0e66cd18919283564c77b798ba7556c4c24010e6c058e0c013b4018ca723fb1ddb60862732a7ab1c5

data/README.md

@@ -33,8 +33,51 @@ class Client
 end
 ```
 
+### Caching requisites
+
+* GET requests only.
+
+* The server must send a `Cache-Control` header.  Otherwise this gem
+  will always revalidate.
+
+* A request is revalidated when:
+  * The server sends a `no-store` directive.
+  * The server sends a `no-cache` directive.
+  * The server sends a `max-age=0,must-revalidate` directive.
+
+* A request is stale when its age is greater than `max-age`.
+
 ### Cache stores
 
+Requests are stored by their URL and a cache key, and point at the
+latest response.
+
+The cache key is generated from requested URL and headers used.  If the
+headers change for every request or are sensitive (X-* headers used for
+bespoke authentication), you can add the `cache_key: 'string'` option to
+the request.
+
+```ruby
+url = 'https://example.org'
+sensitive_token = 'token'
+
+HTTParty.get(
+  url,
+  headers: { 'X-Token': sensitive_token },
+  cache_key: url
+)
+```
+
+Otherwise you'll see many requests cached all pointing to the same
+response.
+
+`Date`, `Authorization`, `Signature` and `Cookie` headers are already
+ignored.
+
+Responses are stored by their URL and a cache key composed by its `Vary`
+headers.  This way if you send a request header that could change the
+response, you'll get a new one.
+
 #### Redis
 
 If you want to use Redis as a cache store:

data/lib/httparty/cache/request.rb

@@ -6,6 +6,7 @@ module HTTParty
     #
     # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching}
     module Request
+      SENSITIVE_HEADERS = %w[Cookie Authorization Date Signature].freeze
       CACHE_REVALIDATION_HEADERS = {
         'ETag' => 'If-None-Match',
         'Last-Modified' => 'If-Modified-Since'
@@ -15,7 +16,14 @@ module HTTParty
       #
       # @return [String]
       def cache_key
-        @cache_key ||= "request:#{uri}##{URI.encode_www_form(options[:headers] || {})}"
+        @cache_key ||= "http-party-cache:request:#{uri}##{URI.encode_www_form(cache_params)}"
+      end
+
+      # @return [Hash]
+      def cache_params
+        return { 'X-Cache-Key' => options[:cache_key] } if options.key? :cache_key
+
+        options[:headers].to_h.except(*SENSITIVE_HEADERS) || {}
       end
 
       def validate
@@ -24,14 +32,21 @@ module HTTParty
         raise ArgumentError, 'Caching is enabled but store was not provided' if caching? && cache_store.nil?
       end
 
+      # A cacheable request
+      #
+      # @return [Boolean]
+      def cacheable?
+        caching? && http_method == Net::HTTP::Get
+      end
+
       # Patch HTTParty::Request#perform to provide caching for GET
       # requests
       #
       # @return [HTTParty::Response]
       def perform(&block)
-        return super(&block) unless caching? && http_method == Net::HTTP::Get
+        return super(&block) unless cacheable?
 
-        if cached?
+        if response_cached?
           handle_revalidation
         else
           super(&block).tap do |response|
@@ -46,24 +61,27 @@ module HTTParty
       # evicted from cache or is corrupted
       #
       # @return [Bool]
-      def cached?
+      def response_cached?
         cache_store.key?(cache_key) &&
           cache_store.key?(cache_store.get(cache_key)) &&
-          cache_store.get(cache_store.get(cache_key)).is_a?(HTTParty::Response)
+          cached_response.is_a?(HTTParty::Response)
       end
 
       def caching?
         !!options[:caching]
       end
 
+      # @return [HTTParty::Response]
+      def cached_response
+        @cached_response ||= cache_store.get(cache_store.get(cache_key))
+      end
+
       private
 
       # Revalidates request
       #
       # @return [HTTParty::Response]
       def handle_revalidation
-        cached_response = cache_store.get(cache_store.get(cache_key))
-
         if cached_response.revalidate? || cached_response.stale?
           self.http_method = Net::HTTP::Head
           options[:cached_response] = cached_response
@@ -80,7 +98,7 @@ module HTTParty
             # Remove from cache so we can perform the request, otherwise
             # we produce an infinite loop
             cache_store.delete(cache_key)
-            response = perform
+            @cached_response = response = perform
           end
 
           cache_store.set(response.cache_key, response)

data/lib/httparty/cache/response.rb

@@ -6,11 +6,6 @@ module HTTParty
     #
     # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching}
     module Response
-      # Detects if response is cached
-      def cached?
-        code == 304
-      end
-
       # Parses Cache-Control headers
       #
       # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/cache-control}
@@ -54,7 +49,13 @@ module HTTParty
       # @see {https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching#force_revalidation}
       # @return [Bool]
       def revalidate?
-        !!(cache_control[:no_cache] || (cache_control[:max_age]&.zero? && cache_control[:must_revalidate]))
+        cache_control.empty? ||
+          cache_control[:no_store] ||
+          cache_control[:no_cache] ||
+          (
+            cache_control[:max_age]&.zero? &&
+            cache_control[:must_revalidate]
+          )
       end
 
       # Returns the request headers that vary responses
@@ -68,7 +69,7 @@ module HTTParty
       #
       # @return [String]
       def cache_key
-        @cache_key ||= "response:#{request.uri}##{URI.encode_www_form vary}"
+        @cache_key ||= "httparty-cache:response:#{request.uri}##{URI.encode_www_form vary}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httparty-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -129,35 +129,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.14.0
 - !ruby/object:Gem::Dependency
-  name: redis-client
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: redis-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,7 +171,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="