protocol-grpc 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f745749ba7c9ac86eff356ee01f6d655c3996a1633ab9091c76e4776e41705
-  data.tar.gz: 9428aba4ba76ca6fb8d3ee751a102f7fc249e27a6630a961b27504da27b3444e
+  metadata.gz: 5ead258154cb8fe775c509d2b4aa05aadee904b18f052ff72163559c45ffdae0
+  data.tar.gz: 5af2daafbecc85fcd2fa722f9c8e02a262997e0a7fe1fdc0196fab7af80cf2aa
 SHA512:
-  metadata.gz: ba9a029154bfad46d73a4f844799508f5ca384042bbbfb832281b4f735dfdf93ddc8ff53f0363d636b8b94d52d6cabdfcefc7d624f2ba16f63e500700789bab8
-  data.tar.gz: 35c83469b178ad06bf0e3b36bb52683f07f8b8d4e7c2d9e331b32dde6b74bf74748ac925627f822a733c748b9bb84f3875675c5929742e3a1e5d164c265babd7
+  metadata.gz: 1e417c6adce8b055da14fd619381f3de243022ed2e9a27841cb2fab0c0c5232c57bbd559728cfcbf72e1ab61e49981f93d100cde21d3a4d194c0f17a89bc1087
+  data.tar.gz: 88290f4fb1f059056e0a545eaae4d90efcb4c7b01e69937ecfa17370392092edd66ce178ed1ebab68da3fbb90bfe879ff02ac6ea20f9768e377faa01c7445aa4

data/design.md

@@ -140,7 +140,7 @@ module Protocol
 			
 			# Parse service and method from gRPC path
 			# @parameter path [String] e.g., "/my_service.Greeter/SayHello"
-			# @returns [Array(String, String)] [service, method]
+			# @returns [Tuple(String, String)] of service and method.
 			def self.parse_path(path)
 				parts = path.split("/")
 				[parts[1], parts[2]]
@@ -287,7 +287,7 @@ module Protocol
 			
 			# Extract gRPC status message from headers
 			# @parameter headers [Protocol::HTTP::Headers]
-			# @returns [String, nil] Status message
+			# @returns [String | Nil] Status message
 			def self.extract_message(headers)
 				message = headers["grpc-message"]
 				message ? URI.decode_www_form_component(message) : nil
@@ -329,7 +329,7 @@ module Protocol
 				# @parameter body [Protocol::HTTP::Body::Readable] The underlying HTTP body
 				# @parameter message_class [Class, nil] Protobuf message class with .decode method
 				#   If nil, returns raw binary data (useful for channel adapters)
-				# @parameter encoding [String, nil] Compression encoding (from grpc-encoding header)
+				# @parameter encoding [String | Nil] Compression encoding (from grpc-encoding header)
 				def initialize(body, message_class: nil, encoding: nil)
 					super(body)
 					@message_class = message_class
@@ -408,7 +408,7 @@ module Protocol
 			# Writes length-prefixed gRPC messages
 			# This is the standard writable body for gRPC - all gRPC requests use message framing
 			class Writable < Protocol::HTTP::Body::Writable
-				# @parameter encoding [String, nil] Compression encoding (gzip, deflate, identity)
+				# @parameter encoding [String | Nil] Compression encoding (gzip, deflate, identity)
 				# @parameter level [Integer] Compression level if encoding is used
 				def initialize(encoding: nil, level: Zlib::DEFAULT_COMPRESSION, **options)
 					super(**options)
@@ -574,7 +574,7 @@ module Protocol
 			end
 			
 			# Get peer information (client address)
-			# @returns [String, nil]
+			# @returns [String | Nil]
 			def peer
 				@request.peer&.to_s
 			end

data/lib/protocol/grpc/header/message.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "uri"
+
+module Protocol
+	module GRPC
+		module Header
+			# The `grpc-message` header represents the gRPC status message.
+			#
+			# The `grpc-message` header contains a human-readable error message, URL-encoded according to RFC 3986.
+			# This header is optional and typically only present when there's an error (non-zero status code).
+			# This header can appear both as an initial header (for trailers-only responses) and as a trailer.
+			class Message < String
+				# Parse a message from a header value.
+				#
+				# @parameter value [String] The header value to parse.
+				# @returns [Message] A new Message instance.
+				def self.parse(value)
+					new(value)
+				end
+				
+				# Initialize the message header with the given value.
+				#
+				# @parameter value [String] The message value (will be URL-encoded if not already encoded).
+				def initialize(value)
+					super(value)
+				end
+				
+				# Decode the URL-encoded message.
+				#
+				# @returns [String] The decoded message.
+				def decode
+					::URI.decode_www_form_component(self)
+				end
+				
+				# Encode the message for use in headers.
+				#
+				# @parameter message [String] The message to encode.
+				# @returns [String] The URL-encoded message.
+				def self.encode(message)
+					URI.encode_www_form_component(message).gsub("+", "%20")
+				end
+				
+				# Merge another message value (takes the new value, as message should only appear once)
+				# @parameter value [String] The new message value
+				def <<(value)
+					replace(value.to_s)
+					
+					return self
+				end
+				
+				# Whether this header is acceptable in HTTP trailers.
+				# The `grpc-message` header can appear in trailers as per the gRPC specification.
+				# @returns [Boolean] `true`, as grpc-message can appear in trailers.
+				def self.trailer?
+					true
+				end
+			end
+		end
+	end
+end

data/lib/protocol/grpc/header/metadata.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "protocol/http"
+
+module Protocol
+	module GRPC
+		module Header
+			# Base class for custom gRPC metadata (allowed in trailers).
+			class Metadata < Protocol::HTTP::Header::Split
+				# Whether this header is acceptable in HTTP trailers.
+				# The `grpc-metadata` header can appear in trailers as per the gRPC specification.
+				# @returns [Boolean] `true`, as grpc-metadata can appear in trailers.
+				def self.trailer?
+					true
+				end
+			end
+		end
+	end
+end

data/lib/protocol/grpc/header/status.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module Protocol
+	module GRPC
+		module Header
+			# The `grpc-status` header represents the gRPC status code.
+			#
+			# The `grpc-status` header contains a numeric status code (0-16) indicating the result of the RPC call.
+			# Status code 0 indicates success (OK), while other codes indicate various error conditions.
+			# This header can appear both as an initial header (for trailers-only responses) and as a trailer.
+			class Status
+				# Parse a status code from a header value.
+				#
+				# @parameter value [String] The header value to parse.
+				# @returns [Status] A new Status instance.
+				def self.parse(value)
+					new(value.to_i)
+				end
+				
+				# Initialize the status header with the given value.
+				#
+				# @parameter value [String | Integer] The status code as a string or integer.
+				def initialize(value)
+					@value = value.to_i
+				end
+				
+				# Get the status code as an integer.
+				#
+				# @returns [Integer] The status code.
+				def to_i
+					@value
+				end
+				
+				# Serialize the status code to a string.
+				#
+				# @returns [String] The status code as a string.
+				def to_s
+					@value.to_s
+				end
+				
+				# Check equality with another status or integer value.
+				#
+				# @parameter other [Status | Integer] The value to compare with.
+				# @returns [Boolean] if the status codes are equal.
+				def ==(other)
+					@value == other.to_i
+				end
+				
+				alias eql? ==
+				
+				# Generate hash for use in Hash/Set collections.
+				#
+				# @returns [Integer] The hash value based on the status code.
+				def hash
+					@value.hash
+				end
+				
+				# Check if this status represents success (status code 0).
+				#
+				# @returns [Boolean] `true` if the status code is 0 (OK).
+				def ok?
+					@value == 0
+				end
+				
+				# Merge another status value (takes the new value, as status should only appear once)
+				# @parameter value [String | Integer] The new status code
+				def <<(value)
+					@value = value.to_i
+					
+					return self
+				end
+				
+				# Whether this header is acceptable in HTTP trailers.
+				# The `grpc-status` header can appear in trailers as per the gRPC specification.
+				# @returns [Boolean] `true`, as grpc-status can appear in trailers.
+				def self.trailer?
+					true
+				end
+			end
+		end
+	end
+end

data/lib/protocol/grpc/header.rb

@@ -4,120 +4,16 @@
 # Copyright, 2025, by Samuel Williams.
 
 require "protocol/http"
-require "uri"
 
 require_relative "status"
+require_relative "header/status"
+require_relative "header/message"
+require_relative "header/metadata"
 
 module Protocol
 	module GRPC
 		# @namespace
 		module Header
-			# The `grpc-status` header represents the gRPC status code.
-			#
-			# The `grpc-status` header contains a numeric status code (0-16) indicating the result of the RPC call.
-			# Status code 0 indicates success (OK), while other codes indicate various error conditions.
-			# This header can appear both as an initial header (for trailers-only responses) and as a trailer.
-			class Status
-				# Initialize the status header with the given value.
-				#
-				# @parameter value [String, Integer, Array] The status code as a string, integer, or array (takes first element).
-				def initialize(value)
-					@value = normalize_value(value)
-				end
-				
-				# Get the status code as an integer.
-				#
-				# @returns [Integer] The status code.
-				def to_i
-					@value
-				end
-				
-				# Serialize the status code to a string.
-				#
-				# @returns [String] The status code as a string.
-				def to_s
-					@value.to_s
-				end
-				
-				# Merge another status value (takes the new value, as status should only appear once)
-				# @parameter value [String, Integer, Array] The new status code
-				def <<(value)
-					@value = normalize_value(value)
-					self
-				end
-				
-			private
-				
-				# Normalize a value to an integer status code.
-				# Handles arrays (from external clients), strings, and integers.
-				# @parameter value [String, Integer, Array] The raw value
-				# @returns [Integer] The normalized status code
-				def normalize_value(value)
-					# Handle Array case (may occur with external clients)
-					actual_value = value.is_a?(Array) ? value.flatten.compact.first : value
-					actual_value.to_i
-				end
-				
-				# Whether this header is acceptable in HTTP trailers.
-				# The `grpc-status` header can appear in trailers as per the gRPC specification.
-				# @returns [Boolean] `true`, as grpc-status can appear in trailers.
-				def self.trailer?
-					true
-				end
-			end
-			
-			# The `grpc-message` header represents the gRPC status message.
-			#
-			# The `grpc-message` header contains a human-readable error message, URL-encoded according to RFC 3986.
-			# This header is optional and typically only present when there's an error (non-zero status code).
-			# This header can appear both as an initial header (for trailers-only responses) and as a trailer.
-			class Message < String
-				# Initialize the message header with the given value.
-				#
-				# @parameter value [String] The message value (will be URL-encoded if not already encoded).
-				def initialize(value)
-					super(value.to_s)
-				end
-				
-				# Decode the URL-encoded message.
-				#
-				# @returns [String] The decoded message.
-				def decode
-					URI.decode_www_form_component(self)
-				end
-				
-				# Encode the message for use in headers.
-				#
-				# @parameter message [String] The message to encode.
-				# @returns [String] The URL-encoded message.
-				def self.encode(message)
-					URI.encode_www_form_component(message).gsub("+", "%20")
-				end
-				
-				# Merge another message value (takes the new value, as message should only appear once)
-				# @parameter value [String] The new message value
-				def <<(value)
-					replace(value.to_s)
-					self
-				end
-				
-				# Whether this header is acceptable in HTTP trailers.
-				# The `grpc-message` header can appear in trailers as per the gRPC specification.
-				# @returns [Boolean] `true`, as grpc-message can appear in trailers.
-				def self.trailer?
-					true
-				end
-			end
-			
-			# Base class for custom gRPC metadata (allowed in trailers).
-			class Metadata < Protocol::HTTP::Header::Split
-				# Whether this header is acceptable in HTTP trailers.
-				# The `grpc-metadata` header can appear in trailers as per the gRPC specification.
-				# @returns [Boolean] `true`, as grpc-metadata can appear in trailers.
-				def self.trailer?
-					true
-				end
-			end
 		end
 		
 		# Custom header policy for gRPC.

data/lib/protocol/grpc/interface.rb

@@ -10,6 +10,8 @@ module Protocol
 		# Wrapper class to mark a message type as streamed.
 		# Used with the stream() helper method in RPC definitions.
 		class Streaming
+			# Initialize a new Streaming wrapper.
+			# @parameter message_class [Class] The message class being wrapped
 			def initialize(message_class)
 				@message_class = message_class
 			end
@@ -148,7 +150,7 @@ module Protocol
 			attr :name
 			
 			# Build gRPC path for a method.
-			# @parameter method_name [String, Symbol] Method name in PascalCase (e.g., :SayHello)
+			# @parameter method_name [String | Symbol] Method name in PascalCase (e.g., :SayHello)
 			# @returns [String] gRPC path with PascalCase method name
 			def path(method_name)
 				Methods.build_path(@name, method_name.to_s)

data/lib/protocol/grpc/methods.rb

@@ -20,7 +20,7 @@ module Protocol
 			
 			# Parse service and method from gRPC path.
 			# @parameter path [String] e.g., "/my_service.Greeter/SayHello"
-			# @returns [Array(String, String)] [service, method]
+			# @returns [Array(String | String)] [service, method]
 			def self.parse_path(path)
 				parts = path.split("/")
 				[parts[1], parts[2]]

data/lib/protocol/grpc/version.rb

@@ -7,7 +7,7 @@
 module Protocol
 	# @namespace
 	module GRPC
-		VERSION = "0.6.0"
+		VERSION = "0.7.0"
 	end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-grpc
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -109,6 +109,9 @@ files:
 - lib/protocol/grpc/call.rb
 - lib/protocol/grpc/error.rb
 - lib/protocol/grpc/header.rb
+- lib/protocol/grpc/header/message.rb
+- lib/protocol/grpc/header/metadata.rb
+- lib/protocol/grpc/header/status.rb
 - lib/protocol/grpc/health_check.rb
 - lib/protocol/grpc/interface.rb
 - lib/protocol/grpc/metadata.rb
@@ -139,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Protocol abstractions for gRPC, built on top of protocol-http.
 test_files: []