async-http-cache 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08cba1514e099ffea868d2c6db065da163f3b71197dc0481be150177c8eef70f'
-  data.tar.gz: f70d55aad88205d2d61d1f995e483fd8596ea3814cf2dcc2d09dd165665872b3
+  metadata.gz: 533b151a2683c0394fdab5d6948380152636f30f7eae85b5442a7dfe08c0039e
+  data.tar.gz: 002b42c3b6f1e3a871a870fd94b1697f0ca19c3761021224e9cc301a16aa8bbe
 SHA512:
-  metadata.gz: 91623e4eba7d1028daeb40b132da3d92167f84981f590e810a2a8170a426a1b625a59ae886ee3f0a0cff7b6e44a5ff61eba62adc0ea786f093b9d1859e4c1f7d
-  data.tar.gz: 72a68261b04e66422a81b4a9b9a6ff87937a0b72b42c7f68a6010e8e1021693e231bb4ef3bd80921e4aecf968e45f0111d49d4bdb331525ebf6a313732ad67d8
+  metadata.gz: bbee2bef91a871bb45d2161ee37a77d6db22690925e6894ed568b3617734eebe0996e77fd8cdfe74c34215857a21a3a6edc788cf7abb8288a9055f434d9e8b95
+  data.tar.gz: 396c077f925cc2359072f9da2244783c43eaa6a8cc87988dc79c1330f0ca5328b7b57a665fafc98d7718bc4dde14a08067133bee5786b6c7143a06fbd0f14b66

data/.github/workflows/development.yml

@@ -11,7 +11,6 @@ jobs:
           - macos
         
         ruby:
-          - 2.4
           - 2.5
           - 2.6
           - 2.7

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in async-http-cache.gemspec
 gemspec
+
+# gem "async-http", path: "../async-http"
+# gem "protocol-http", path: "../protocol-http"
+# gem "protocol-http1", path: "../protocol-http1"

data/async-http-cache.gemspec

@@ -21,13 +21,12 @@ Gem::Specification.new do |spec|
 	
 	spec.require_paths = ["lib"]
 	
-	spec.add_dependency "async-http"
-	spec.add_dependency "protocol-http", "~> 0.14.4"
+	spec.add_dependency "async-http", "~> 0.53"
 	
 	spec.add_development_dependency "async-rspec", "~> 1.10"
 	
 	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rspec"
-	spec.add_development_dependency "rake"
+	spec.add_development_dependency "bake-bundler"
 end

data/lib/async/http/cache/body.rb

@@ -21,33 +21,49 @@
 # THE SOFTWARE.
 
 require 'protocol/http/body/rewindable'
-require 'protocol/http/body/streamable'
+require 'protocol/http/body/completable'
+require 'protocol/http/body/digestable'
 
 module Async
 	module HTTP
 		module Cache
 			module Body
-				def self.wrap(message, &block)
-					if body = message.body
-						# Create a rewindable body wrapping the message body:
-						rewindable = ::Protocol::HTTP::Body::Rewindable.new(body)
-						
-						# Set the message body to the rewindable body:
-						message.body = rewindable
-						
-						# Wrap the message with the callback:
-						::Protocol::HTTP::Body::Streamable.wrap(message) do |error|
-							if error
-								Async.logger.error(self) {error}
-							else
-								yield message, rewindable.buffered
+				TRAILERS = 'trailers'
+				ETAG = 'etag'
+				
+				def self.wrap(response, &block)
+					if body = response.body
+						if body.empty?
+							# A body that is empty? at the outset, is immutable. This generally only applies to HEAD requests.
+							yield response, body
+						else
+							# Insert a rewindable body so that we can cache the response body:
+							rewindable = ::Protocol::HTTP::Body::Rewindable.wrap(response)
+							
+							unless response.headers.include?(ETAG)
+								# Compute a digest and add it to the response headers:
+								::Protocol::HTTP::Body::Digestable.wrap(response) do |wrapper|
+									response.headers.add(ETAG, wrapper.etag)
+								end
+								
+								# Ensure the etag is listed as a trailer:
+								response.headers.add(TRAILERS, ETAG)
+							end
+							
+							# Wrap the response with the callback:
+							::Protocol::HTTP::Body::Completable.wrap(response) do |error|
+								if error
+									Async.logger.error(self) {error}
+								else
+									yield response, rewindable.buffered
+								end
 							end
 						end
 					else
-						yield message, nil
+						yield response, nil
 					end
 					
-					return message
+					return response
 				end
 			end
 		end

data/lib/async/http/cache/general.rb

@@ -31,6 +31,7 @@ module Async
 		module Cache
 			class General < ::Protocol::HTTP::Middleware
 				CACHE_CONTROL  = 'cache-control'
+				
 				CONTENT_TYPE = 'content-type'
 				AUTHORIZATION = 'authorization'
 				COOKIE = 'cookie'
@@ -91,9 +92,17 @@ module Async
 						return response
 					end
 					
-					return Body.wrap(response) do |message, body|
+					if request.head? and body = response.body
+						unless body.empty?
+							Async.logger.warn(self) {"HEAD request resulted in non-empty body!"}
+							
+							return response
+						end
+					end
+					
+					return Body.wrap(response) do |response, body|
 						Async.logger.debug(self) {"Updating cache for #{key}..."}
-						@store.insert(key, request, Response.new(message, body))
+						@store.insert(key, request, Response.new(response, body))
 					end
 				end
 				
@@ -107,7 +116,7 @@ module Async
 							Async.logger.debug(self) {"Cache hit for #{key}..."}
 							@count += 1
 							
-							# Create a dup of the response:
+							# Return the cached response:
 							return response
 						end
 					end

data/lib/async/http/cache/response.rb

@@ -29,6 +29,9 @@ module Async
 			class Response < ::Protocol::HTTP::Response
 				CACHE_CONTROL = 'cache-control'
 				SET_COOKIE = 'set-cookie'
+				ETAG = 'etag'
+				
+				X_CACHE = 'x-cache'
 				
 				def initialize(response, body)
 					@generated_at = Async::Clock.now
@@ -36,16 +39,23 @@ module Async
 					super(
 						response.version,
 						response.status,
-						response.headers.dup,
+						response.headers.flatten,
 						body,
 						response.protocol
 					)
 					
 					@max_age = @headers[CACHE_CONTROL]&.max_age
+					@etag = nil
+					
+					@headers.set(X_CACHE, 'hit')
 				end
 				
 				attr :generated_at
 				
+				def etag
+					@etag ||= @headers[ETAG]
+				end
+				
 				def cachable?
 					if cache_control = @headers[CACHE_CONTROL]
 						if cache_control.private? || !cache_control.public?

data/lib/async/http/cache/store/memory.rb

@@ -64,6 +64,9 @@ module Async
 					
 					attr :index
 					
+					IF_NONE_MATCH = 'if-none-match'
+					NOT_MODIFIED = ::Protocol::HTTP::Response[304]
+					
 					def lookup(key, request)
 						if response = @index[key]
 							if response.expired?
@@ -74,6 +77,12 @@ module Async
 								return nil
 							end
 							
+							if etags = request.headers[IF_NONE_MATCH]
+								if etags.include?(response.etag)
+									return NOT_MODIFIED
+								end
+							end
+							
 							@hit += 1
 							
 							return response.dup
@@ -86,7 +95,8 @@ module Async
 					
 					def insert(key, request, response)
 						if @index.size < @limit
-							if response.body.length < 1024*64
+							length = response.body&.length
+							if length.nil? or length < 1024*64
 								@index[key] = response
 							end
 						end

data/lib/async/http/cache/version.rb

@@ -23,7 +23,7 @@
 module Async
 	module HTTP
 		module Cache
-			VERSION = "0.1.2"
+			VERSION = "0.3.0"
 		end
 	end
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: async-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2020-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: protocol-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.4
+        version: '0.53'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.4
+        version: '0.53'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bake-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - samuel.williams@oriontransfer.co.nz
 executables: []
@@ -120,7 +106,6 @@ files:
 - ".rspec"
 - Gemfile
 - README.md
-- Rakefile
 - async-http-cache.gemspec
 - lib/async/http/cache.rb
 - lib/async/http/cache/body.rb
@@ -134,7 +119,7 @@ homepage: https://github.com/socketry/async-http-cache
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Standard-compliant cache for async-http.
 test_files: []

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec