async-http-cache 0.1.5 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc8e38cbf05084350cc6d91e0f6f35cd612f14d3554b720c48ebb03abf3331ae
-  data.tar.gz: 05b44c8cbc06f3ff26b9f9b7d2fa8643278d7067adb902d8ce4b11726f23f6a6
+  metadata.gz: 4f2003b72015123e99c75069272771e6247c31abbd55163da86955dd462dc4d6
+  data.tar.gz: dd9798d6736f4e73c06e1a15a6010c192a663042081ee6d92484eddd4b924256
 SHA512:
-  metadata.gz: cd3729f3a2877372c7df040dd1798d6ef55e44688dbd9d8ae4d40e9ee4a0d4eba37d1cc53b0c6d512d3c1277bd9dc043b423c5a21b54d4085da827cf1481c753
-  data.tar.gz: e3a1951d11b75c3da93f585bcb8cb4254e93d16d73282a9b1f713d4208c28de2bbb991b3305516db7cb47c2b6cd0df343d5116cec962792a73d94e9f8fe09f87
+  metadata.gz: 9ba0a34a15023d0e2b3b66052aa233f3180b4706e28040b08c0d8605e288230cee7461ffc8ecc3602575ae57e8b0ca7e713181aa07a83453f201c76680e0a32a
+  data.tar.gz: 8722d2f6aa70df6e830ecd1482916b26bd42d8f18ccd070010fb6c7d5689982b503cceb3df604e14c359d4cd8cdc9b63a0612b0b8bbf7f40b52e7cb029817611

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

@@ -21,38 +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
+				TRAILER = 'trailer'
+				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 message, body
+							yield response, body
 						else
-							# Create a rewindable body wrapping the message body:
-							rewindable = ::Protocol::HTTP::Body::Rewindable.new(body)
+							# Insert a rewindable body so that we can cache the response body:
+							rewindable = ::Protocol::HTTP::Body::Rewindable.wrap(response)
 							
-							# Set the message body to the rewindable body:
-							message.body = rewindable
+							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(TRAILER, ETAG)
+							end
 							
-							# Wrap the message with the callback:
-							::Protocol::HTTP::Body::Streamable.wrap(message) do |error|
+							# Wrap the response with the callback:
+							::Protocol::HTTP::Body::Completable.wrap(response) do |error|
 								if error
-									Async.logger.error(self) {error}
+									Console.logger.error(self) {error}
 								else
-									yield message, rewindable.buffered
+									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|
-						Async.logger.debug(self) {"Updating cache for #{key}..."}
-						@store.insert(key, request, Response.new(message, body))
+					if request.head? and body = response.body
+						unless body.empty?
+							Console.logger.warn(self) {"HEAD request resulted in non-empty body!"}
+							
+							return response
+						end
+					end
+					
+					return Body.wrap(response) do |response, body|
+						Console.logger.debug(self) {"Updating cache for #{key}..."}
+						@store.insert(key, request, Response.new(response, body))
 					end
 				end
 				
@@ -104,10 +113,10 @@ module Async
 					
 					unless cache_control&.no_cache?
 						if response = @store.lookup(key, request)
-							Async.logger.debug(self) {"Cache hit for #{key}..."}
+							Console.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?
@@ -57,7 +67,7 @@ module Async
 					end
 					
 					if set_cookie = @headers[SET_COOKIE]
-						Async.logger.warn(self) {"Cannot cache response with set-cookie header!"}
+						Console.logger.warn(self) {"Cannot cache response with set-cookie header!"}
 						return false
 					end
 					

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

@@ -33,14 +33,14 @@ module Async
 						@miss = 0
 						@pruned = 0
 						
-						@gardener = Async do |task|
+						@gardener = Async(transient: true, annotation: self.class) do |task|
 							while true
 								task.sleep(60)
 								
 								pruned = self.prune
 								@pruned += pruned
 								
-								Async.logger.debug(self) do |buffer|
+								Console.logger.debug(self) do |buffer|
 									if pruned > 0
 										buffer.puts "Pruned #{pruned} entries."
 									end
@@ -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

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

@@ -23,7 +23,7 @@
 module Async
 	module HTTP
 		module Cache
-			VERSION = "0.1.5"
+			VERSION = "0.4.2"
 		end
 	end
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: async-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.4.2
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2021-05-13 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'
+        version: '0.56'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.56'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,34 +66,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/development.yml"
-- ".gitignore"
-- ".rspec"
-- Gemfile
-- README.md
-- Rakefile
-- async-http-cache.gemspec
 - lib/async/http/cache.rb
 - lib/async/http/cache/body.rb
 - lib/async/http/cache/general.rb
@@ -134,7 +84,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 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.0.dev
+signing_key:
 specification_version: 4
 summary: Standard-compliant cache for async-http.
 test_files: []

data/.github/workflows/development.yml

@@ -1,34 +0,0 @@
-name: Development
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        
-        ruby:
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
-        
-        include:
-          - os: 'ubuntu'
-            ruby: '2.6'
-            env: COVERAGE=PartialSummary,Coveralls
-    
-    runs-on: ${{matrix.os}}-latest
-    
-    steps:
-    - uses: actions/checkout@v1
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run tests
-      run: ${{matrix.env}} bundle exec rspec

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-Gemfile.lock
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in async-http-cache.gemspec
-gemspec

data/README.md

@@ -1,68 +0,0 @@
-# Async::HTTP::Cache
-
-Provides a cache middleware for `Async::HTTP` clients and servers.
-
-[![Development](https://github.com/socketry/async-http-cache/workflows/Development/badge.svg?branch=master)](https://github.com/socketry/async-http-cache/actions?workflow=Development)
-
-## Usage
-
-### Client Side
-
-```ruby
-require 'async'
-require 'async/http'
-require 'async/http/cache'
-
-endpoint = Async::HTTP::Endpoint.parse("https://www.oriontransfer.co.nz")
-client = Async::HTTP::Client.new(endpoint)
-cache = Async::HTTP::Cache::General.new(client)
-
-Async do
-	2.times do
-		response = cache.get("/products/index")
-		puts response.inspect
-		# <Async::HTTP::Protocol::HTTP2::Response ...>
-		# <Async::HTTP::Cache::Response ...>
-		response.finish
-	end
-ensure
-	cache.close
-end
-```
-
-## Vary
-
-The `vary` header creates a headache for proxy implementations, because it creates a combinatorial explosion of cache keys, even if the content is the same. Try to avoid it unless absolutely necessary.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

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

data/async-http-cache.gemspec

@@ -1,33 +0,0 @@
-
-require_relative 'lib/async/http/cache/version'
-
-Gem::Specification.new do |spec|
-	spec.name = "async-http-cache"
-	spec.version = Async::HTTP::Cache::VERSION
-	spec.authors = ["Samuel Williams"]
-	spec.email = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary = "Standard-compliant cache for async-http."
-	spec.homepage = "https://github.com/socketry/async-http-cache"
-	spec.license = "MIT"
-	
-	spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-	
-	# Specify which files should be added to the gem when it is released.
-	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-	spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-	end
-	
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "async-http"
-	spec.add_dependency "protocol-http", "~> 0.14"
-	
-	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"
-end