protocol-http 0.26.3 → 0.26.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd49532afd66aa61fc45281ce3fd9493e241790cd3daaf59c071793f91b5b42a
-  data.tar.gz: a8b0cefa5ad518293558a66a2db77fb4bd9ef3ba381134d9051d24ad1bcb64a5
+  metadata.gz: ec1274383518ed67d583ca4bd675984a61c34b2bc4b19600a064fd80e595548a
+  data.tar.gz: cdf454fb4d8c1513dab3f9e1dd48a2b8bf466af01cbb97fcee256fd79d7ec91c
 SHA512:
-  metadata.gz: 8d243e058e7cd0dd9825c44de883e5badf0df4aa150608ffdc034e4c0259412d64699cb97e0132e2d9307bcf874a2ce67f03e02046d00c761415d71c5c0a7941
-  data.tar.gz: 0d29c9fd133dede2b2d7a545405df8e64dcfb497477c1252bb34e41fffac7fc9540142b9d1961a146d2e4afcedc86fb4cb9ce2e75d55a5c1a5e4ac4c0ced8659
+  metadata.gz: af8dc10e55a1079c3862fe05316d8e1716a0ff4af45e705927e310f707c49fb2c10a13954af9ddee21cca9814037faddeed035691bbc35136bbe058facf354ac
+  data.tar.gz: fdf5fcbb3d7a184aa77e55b3016820fcd34863b401301901232f188cc350c357e76590448ee67a74c032c931f064b9a833291c2b95c48a7da69f767e6887df69

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'wrapper'
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2023, by Bruno Sutic.
 
 module Protocol
@@ -93,7 +93,7 @@ module Protocol
 					end
 				end
 				
-				def as_json
+				def as_json(...)
 					{
 						class: self.class.name,
 						length: self.length,
@@ -102,6 +102,10 @@ module Protocol
 						empty: self.empty?
 					}
 				end
+				
+				def to_json(...)
+					as_json.to_json(...)
+				end
 			end
 		end
 	end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'readable'
 
@@ -51,13 +51,17 @@ module Protocol
 					@body.read
 				end
 				
-				def as_json
+				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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 require_relative 'header/split'
 require_relative 'header/multiple'

data/lib/protocol/http/middleware/builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative '../middleware'
 
@@ -30,7 +30,13 @@ module Protocol
 			def self.build(&block)
 				builder = Builder.new
 				
-				builder.instance_eval(&block)
+				if block_given?
+					if block.arity == 0
+						builder.instance_exec(&block)
+					else
+						yield builder
+					end
+				end
 				
 				return builder.to_app
 			end

data/lib/protocol/http/request.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'body/buffered'
 require_relative 'body/reader'
@@ -73,7 +73,7 @@ module Protocol
 				@method != Methods::POST && (@body.nil? || @body.empty?)
 			end
 			
-			def as_json
+			def as_json(...)
 				{
 					scheme: @scheme,
 					authority: @authority,
@@ -86,6 +86,10 @@ module 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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'body/buffered'
 require_relative 'body/reader'
@@ -104,7 +104,7 @@ module Protocol
 				Response[500, Headers['content-type' => 'text/plain'], ["#{exception.class}: #{exception.message}"]]
 			end
 			
-			def as_json
+			def as_json(...)
 				{
 					version: @version,
 					status: @status,
@@ -114,6 +114,10 @@ module 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.3"
+		VERSION = "0.26.5"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.26.3
+  version: 0.26.5
 platform: ruby
 authors:
 - Samuel Williams
@@ -47,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-05-04 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
@@ -99,6 +98,7 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/protocol-http/
+  source_code_uri: https://github.com/socketry/protocol-http.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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)