Improve as_json support for Body wrappers.

Author: samuel-williams-shopify

lib/protocol/http/body/completable.rb

@@ -54,6 +54,15 @@ def close(error = nil)
 					super
 				end
 
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						callback: @callback&.to_s
+					)
+				end
+				
 				# Inspect the completable body.
 				#
 				# @returns [String] a string representation of the completable body.

lib/protocol/http/body/deflate.rb

@@ -75,6 +75,17 @@ def ratio
 					end
 				end
 
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						input_length: @input_length,
+						output_length: @output_length,
+						compression_ratio: (ratio * 100).round(2)
+					)
+				end
+				
 				# Inspect the body, including the compression ratio.
 				#
 				# @returns [String] a string representation of the body.

lib/protocol/http/body/digestable.rb

@@ -64,6 +64,16 @@ def read
 						return nil
 					end
 				end
+				
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						digest_class: @digest.class.name,
+						callback: @callback&.to_s
+					)
+				end
 			end
 		end
 	end

lib/protocol/http/body/rewindable.rb

@@ -82,6 +82,16 @@ def rewindable?
 					true
 				end
 
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						index: @index,
+						chunks: @chunks.size
+					)
+				end
+				
 				# Inspect the rewindable body.
 				#
 				# @returns [String] a string representation of the body.

test/protocol/http/body/buffered.rb

@@ -150,7 +150,7 @@
 
 	with "#inspect" do
 		let(:body) {subject.new}
-
+		
 		it "generates string representation for empty body" do
 			expect(body.inspect).to be == "#<Protocol::HTTP::Body::Buffered empty>"
 		end

test/protocol/http/body/completable.rb

@@ -106,4 +106,24 @@
 			expect(events).to be == [:close2, :close1]
 		end
 	end
+	
+	with "#as_json" do
+		it "includes callback information" do
+			completable = subject.new(body, proc{events << :close})
+			
+			expect(completable.as_json).to have_keys(
+				class: be == "Protocol::HTTP::Body::Completable",
+				callback: be =~ /Proc/
+			)
+		end
+		
+		it "shows nil when no callback" do
+			completable = subject.new(body, nil)
+			
+			expect(completable.as_json).to have_keys(
+				class: be == "Protocol::HTTP::Body::Completable",
+				callback: be == nil
+			)
+		end
+	end
 end

test/protocol/http/body/deflate.rb

@@ -61,4 +61,15 @@
 			expect(compressed_body.inspect).to be == "#<Protocol::HTTP::Body::Buffered empty> | #<Protocol::HTTP::Body::Deflate 100.0%>"
 		end
 	end
+	
+	with "#as_json" do
+		it "includes compression information" do
+			expect(compressed_body.as_json).to have_keys(
+				class: be == "Protocol::HTTP::Body::Deflate",
+				input_length: be == 0,
+				output_length: be == 0,
+				compression_ratio: be == 100.0
+			)
+		end
+	end
 end

test/protocol/http/body/digestable.rb

@@ -50,4 +50,27 @@ def before
 			expect(body.etag(weak: true)).to be == 'W/"872e4e50ce9990d8b041330c47c9ddd11bec6b503ae9386a99da8584e9bb12c4"'
 		end
 	end
+	
+	with "#as_json" do
+		it "includes digest information" do
+			expect(body.as_json).to have_keys(
+				class: be == "Protocol::HTTP::Body::Digestable",
+				digest_class: be == "Digest::SHA256",
+				callback: be == nil
+			)
+		end
+		
+		with "callback" do
+			let(:callback) {proc {puts "digest complete"}}
+			let(:body) {subject.new(source, Digest::SHA256.new, callback)}
+			
+			it "includes callback information" do
+				expect(body.as_json).to have_keys(
+								class: be == "Protocol::HTTP::Body::Digestable",
+								digest_class: be == "Digest::SHA256",
+								callback: be =~ /Proc/
+							)
+			end
+		end
+	end
 end

test/protocol/http/body/rewindable.rb

@@ -104,4 +104,14 @@
 			expect(body.inspect).to be == "#<Protocol::HTTP::Body::Buffered empty> | #<Protocol::HTTP::Body::Rewindable 0/0 chunks read>"
 		end
 	end
+	
+	with "#as_json" do
+		it "includes rewind tracking information" do
+			expect(body.as_json).to have_keys(
+				class: be == "Protocol::HTTP::Body::Rewindable",
+				index: be == 0,
+				chunks: be == 0
+			)
+		end
+	end
 end