protocol-http 0.26.2 → 0.26.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ad7cebabada676314b89eb107ccd52dc5b4ca39ae06286189da63e48732020
-  data.tar.gz: b6d949c575e5beebe00e2fd3b88be34ea3600380ebb65a88ef95f206cc615de6
+  metadata.gz: '0817ddd3e60c6de45f9e5a73ecedb00e60c11c8171bcddca6b1da0b3bc898708'
+  data.tar.gz: bac2be42911aab9457374fc16d80ca4db76e9b7b4a9bacb5d6937e63e5520298
 SHA512:
-  metadata.gz: 6b934b6150bef7f73a113720dd2091f84605f424ac6daf9591828c28890ddacc0cfe3a143674e3d1f9b399b9ecf59b566e117b8a89fa5f7198a931456fd8314c
-  data.tar.gz: 7e9cb8d0d7c1fa9fd39cb4adf1048cb88e284b8fb4513b27c8910ca5c7df4eabf277c2b1545ddc3da8054cacda2cb025c26944613a307900d4afb85dee836d3f
+  metadata.gz: f78f1dcb03b5d203fae96a278a2152ee938ac8256692bf379819d44742104bc3c310ed1e6ce09f652f71ac86a08b1157705e7500974a4b2cdfdba7a00ed5a6fb
+  data.tar.gz: 1bba3d55382e65a7a79f60c81d089c129dde3b4bc2ab5e550172797a86be0d962426d1beb4910710c96a418f5b4460c2578f34bcac15cb34e1e0f93f1fdcf253

data/lib/protocol/http/body/readable.rb

@@ -92,6 +92,20 @@ module Protocol
 						return buffer
 					end
 				end
+				
+				def as_json(...)
+					{
+						class: self.class.name,
+						length: self.length,
+						stream: self.stream?,
+						ready: self.ready?,
+						empty: self.empty?
+					}
+				end
+				
+				def to_json(...)
+					as_json.to_json(...)
+				end
 			end
 		end
 	end

data/lib/protocol/http/body/wrapper.rb

@@ -51,6 +51,17 @@ module Protocol
 					@body.read
 				end
 				
+				def as_json(...)
+					{
+						class: self.class.name,
+						body: @body&.as_json
+					}
+				end
+				
+				def to_json(...)
+					as_json.to_json(...)
+				end
+				
 				def inspect
 					@body.inspect
 				end

data/lib/protocol/http/headers.rb

@@ -299,6 +299,8 @@ module Protocol
 				end
 			end
 			
+			alias as_json to_h
+			
 			def inspect
 				"#<#{self.class} #{@fields.inspect}>"
 			end

data/lib/protocol/http/request.rb

@@ -73,6 +73,23 @@ module Protocol
 				@method != Methods::POST && (@body.nil? || @body.empty?)
 			end
 			
+			def as_json(...)
+				{
+					scheme: @scheme,
+					authority: @authority,
+					method: @method,
+					path: @path,
+					version: @version,
+					headers: @headers&.as_json,
+					body: @body&.as_json,
+					protocol: @protocol
+				}
+			end
+			
+			def to_json(...)
+				as_json.to_json(...)
+			end
+			
 			def to_s
 				"#{@scheme}://#{@authority}: #{@method} #{@path} #{@version}"
 			end

data/lib/protocol/http/response.rb

@@ -104,6 +104,20 @@ module Protocol
 				Response[500, Headers['content-type' => 'text/plain'], ["#{exception.class}: #{exception.message}"]]
 			end
 			
+			def as_json(...)
+				{
+					version: @version,
+					status: @status,
+					headers: @headers&.as_json,
+					body: @body&.as_json,
+					protocol: @protocol
+				}
+			end
+			
+			def to_json(...)
+				as_json.to_json(...)
+			end
+			
 			def to_s
 				"#{@status} #{@version}"
 			end

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.26.2"
+		VERSION = "0.26.4"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.26.2
+  version: 0.26.4
 platform: ruby
 authors:
 - Samuel Williams
@@ -47,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -55,7 +55,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- design.md
 - lib/protocol/http.rb
 - lib/protocol/http/accept_encoding.rb
 - lib/protocol/http/body/buffered.rb

data/design.md

@@ -1,167 +0,0 @@
-# Middleware Design
-
-`Body::Writable` is a queue of String chunks.
-
-## Request Response Model
-
-~~~ruby
-class Request
-	attr :verb
-	attr :target
-	attr :body
-end
-
-class Response
-	attr :status
-	attr :headers
-	attr :body
-end
-
-def call(request)
-	return response
-end
-
-def call(request)
-	return @app.call(request)
-end
-~~~
-
-## Stream Model
-
-~~~ruby
-class Stream
-	attr :verb
-	attr :target
-	
-	def respond(status, headers) = ...
-	
-	attr_accessor :input
-	attr_accessor :output
-end
-
-class Response
-	def initialize(verb, target)
-		@input = Body::Writable.new
-		@output = Body::Writable.new
-	end
-	
-	def request(verb, target)
-		# Create a request stream suitable for writing into the buffered response:
-		Stream.new(verb, target, @input, @output)
-	end
-	
-	def write(...)
-		@input.write(...)
-	end
-	
-	def read
-		@output.read
-	end
-end
-
-def call(stream)
-	# nothing. maybe error
-end
-
-def call(stream)
-	@app.call(stream)
-end
-~~~
-
-# Client Design
-
-## Request Response Model
-
-~~~ruby
-request = Request.new("GET", url)
-response = call(request)
-
-response.headers
-response.read
-~~~
-
-## Stream Model
-
-~~~ruby
-response = Response.new
-call(response.request("GET", url))
-
-response.headers
-response.read
-~~~
-
-## Differences
-
-The request/response model has a symmetrical design which naturally uses the return value for the result of executing the request. The result encapsulates the behaviour of how to read the response status, headers and body. Because of that, streaming input and output becomes a function of the result object itself. As in:
-
-~~~ruby
-def call(request)
-	body = Body::Writable.new
-	
-	Fiber.schedule do
-		while chunk = request.input.read
-			body.write(chunk.reverse)
-		end
-	end
-	
-	return Response[200, [], body]
-end
-
-input = Body::Writable.new
-response = call(... body ...)
-
-input.write("Hello World")
-input.close
-response.read -> "dlroW olleH"
-~~~
-
-The streaming model does not have the same symmetry, and instead opts for a uni-directional flow of information.
-
-~~~ruby
-def call(stream)
-	Fiber.schedule do
-		while chunk = stream.read
-			stream.write(chunk.reverse)
-		end
-	end
-end
-
-input = Body::Writable.new
-response = Response.new(...input...)
-call(response.stream)
-
-input.write("Hello World")
-input.close
-response.read -> "dlroW olleH"
-~~~
-
-The value of this uni-directional flow is that it is natural for the stream to be taken out of the scope imposed by the nested `call(request)` model. However, the user must explicitly close the stream, since it's no longer scoped to the client and/or server.
-
-## Connection Upgrade
-
-### HTTP/1
-
-```
-GET /path/to/websocket HTTP/1.1
-connection: upgrade
-upgrade: websocket
-```
-
-Request.new(GET, ..., protocol = websocket)
--> Response.new(101, ..., protocol = websocket)
-
-```
-101 Switching Protocols
-upgrade: websocket
-```
-
-### HTTP/2
-
-```
-:method CONNECT
-:path /path/to/websocket
-:protocol websocket
-```
-
-Request.new(CONNECT, ..., protocol = websocket)
--> Response.new(200, ..., protocol = websocket)