protocol-grpc 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27870f6774a55a9ea77ac67685009adc591273272ba29dc43a41d9362c32d933
-  data.tar.gz: 754b918b3865e479cbf853c2d0f4e3e7b8a5041e00ff95e6bc14f91a15341836
+  metadata.gz: a889e5eb3f6b74e8609a27a4667b62611ab8dc0515d24d9ecf70c4fee7e25b11
+  data.tar.gz: 56b5bc9e9d8a767db66ead55bcc97404e8092ef6a75a008d4bd893624391b808
 SHA512:
-  metadata.gz: 686459772400743ad026f2ea4ee001e3967ce2e5d584ba041cb1edf5a25200c77893dd919b70e90984f340b8008eb6d2c7faca70731c67c46bd4665915ae4f68
-  data.tar.gz: d1c6c68e07e91936ce968e15a942ca2c77dd5229d32d8eb778d351e8e19e6d52056bd9752abdb4757f2acfec810fc0f9216d6fa33ac6dc190ebe1a47c391513b
+  metadata.gz: 6aab2ee9f75421070a6348c39da680c7cd320e31021b9492f48d48832ab4caf580ffa77113a792e336cd87158890d22ed12d9e4650079954b33c99c7da85e422
+  data.tar.gz: 67c0e25c06ed8f5c8ad431233506f6133655d64a6e546d9767c74049d85b0fa6b54e37384e15e6458c429f0431779fad96c8b01e30821acd8f7952a260ccf3de

data/context/getting-started.md

@@ -130,3 +130,4 @@ call.deadline.exceeded?  # => false
 call.peer  # => Protocol::HTTP::Address
 ```
 
+

data/lib/protocol/grpc/body/readable_body.rb

@@ -4,6 +4,7 @@
 # Copyright, 2025, by Samuel Williams.
 
 require "protocol/http"
+require "protocol/http/body/wrapper"
 require "zlib"
 
 module Protocol
@@ -12,56 +13,36 @@ module Protocol
 		module Body
 			# Represents a readable body for gRPC messages with length-prefixed framing.
 			# This is the standard readable body for gRPC - all gRPC responses use message framing.
-			class ReadableBody
+			# Wraps the underlying HTTP body and transforms raw chunks into decoded gRPC messages.
+			class ReadableBody < Protocol::HTTP::Body::Wrapper
+				def self.wrap(message, **options)
+					if body = message.body
+						message.body = self.new(body, **options)
+					end
+					
+					return message.body
+				end
+				
 				# Initialize a new readable body for gRPC messages.
 				# @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)
 				def initialize(body, message_class: nil, encoding: nil)
-					@body = body
+					super(body)
 					@message_class = message_class
 					@encoding = encoding
 					@buffer = String.new.force_encoding(Encoding::BINARY)
-					@closed = false
 				end
 				
-				# @attribute [Protocol::HTTP::Body::Readable] The underlying HTTP body.
-				attr_reader :body
-				
 				# @attribute [String | Nil] The compression encoding.
 				attr_reader :encoding
 				
-				# Close the input body.
-				# @parameter error [Exception | Nil] Optional error that caused the close
-				# @returns [Nil]
-				def close(error = nil)
-					@closed = true
-					
-					if @body
-						@body.close(error)
-						@body = nil
-					end
-					
-					nil
-				end
-				
-				# Check if the stream has been closed.
-				# @returns [Boolean] `true` if the stream is closed, `false` otherwise
-				def closed?
-					@closed or @body.nil?
-				end
-				
-				# Check if there are any input chunks remaining.
-				# @returns [Boolean] `true` if the body is empty, `false` otherwise
-				def empty?
-					@body.nil?
-				end
-				
 				# Read the next gRPC message.
+				# Overrides Wrapper#read to transform raw HTTP body chunks into decoded gRPC messages.
 				# @returns [Object | String | Nil] Decoded message, raw binary, or `Nil` if stream ended
 				def read
-					return nil if closed?
+					return nil if @body.nil? || @body.empty?
 					
 					# Read 5-byte prefix: 1 byte compression flag + 4 bytes length
 					prefix = read_exactly(5)
@@ -87,24 +68,6 @@ module Protocol
 					end
 				end
 				
-				# Enumerate all messages until finished, then invoke {close}.
-				# @yields {|message| ...} The block to call with each message.
-				def each
-					return to_enum unless block_given?
-					
-					error = nil
-					begin
-						while (message = read)
-							yield message
-						end
-					rescue StandardError => e
-						error = e
-						raise
-					ensure
-						close(error)
-					end
-				end
-				
 			private
 				
 				# Read exactly n bytes from the underlying body.
@@ -113,28 +76,18 @@ module Protocol
 				def read_exactly(n)
 					# Fill buffer until we have enough data:
 					while @buffer.bytesize < n
-						return nil if closed?
+						return nil if @body.nil? || @body.empty?
 						
 						# Read chunk from underlying body:
 						chunk = @body.read
 						
 						if chunk.nil?
 							# End of stream:
-							if @body && !@closed
-								@body.close
-								@closed = true
-							end
 							return nil
 						end
 						
 						# Append to buffer:
 						@buffer << chunk.force_encoding(Encoding::BINARY)
-						
-						# Check if body is empty and close if needed:
-						if @body.empty?
-							@body.close
-							@closed = true
-						end
 					end
 					
 					# Extract the required data:

data/lib/protocol/grpc/call.rb

@@ -12,9 +12,11 @@ module Protocol
 		class Call
 			# Initialize a new RPC call context.
 			# @parameter request [Protocol::HTTP::Request] The HTTP request
+			# @parameter response [Protocol::HTTP::Response | Nil] The HTTP response (for setting metadata and trailers)
 			# @parameter deadline [Async::Deadline | Nil] Deadline for the call
-			def initialize(request, deadline: nil)
+			def initialize(request, response = nil, deadline: nil)
 				@request = request
+				@response = response
 				@deadline = deadline
 				@cancelled = false
 			end
@@ -22,6 +24,9 @@ module Protocol
 			# @attribute [Protocol::HTTP::Request] The underlying HTTP request.
 			attr_reader :request
 			
+			# @attribute [Protocol::HTTP::Response | Nil] The HTTP response.
+			attr_reader :response
+			
 			# @attribute [Async::Deadline | Nil] The deadline for this call.
 			attr_reader :deadline
 			

data/lib/protocol/grpc/header.rb

@@ -20,9 +20,9 @@ module Protocol
 			class Status
 				# Initialize the status header with the given value.
 				#
-				# @parameter value [String, Integer] The status code as a string or integer.
+				# @parameter value [String, Integer, Array] The status code as a string, integer, or array (takes first element).
 				def initialize(value)
-					@value = value.is_a?(String) ? value.to_i : value.to_i
+					@value = normalize_value(value)
 				end
 				
 				# Get the status code as an integer.
@@ -40,12 +40,24 @@ module Protocol
 				end
 				
 				# Merge another status value (takes the new value, as status should only appear once)
-				# @parameter value [String, Integer] The new status code
+				# @parameter value [String, Integer, Array] The new status code
 				def <<(value)
-					@value = value.is_a?(String) ? value.to_i : value.to_i
+					@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.

data/lib/protocol/grpc/interface.rb

@@ -7,16 +7,23 @@ require_relative "methods"
 
 module Protocol
 	module GRPC
-		# RPC method definition
-		RPC = Struct.new(:request_class, :response_class, :streaming, :method, keyword_init: true) do
-			def initialize(request_class:, response_class:, streaming: :unary, method: nil)
-				super
-			end
-		end
-		
 		# Represents an interface definition for gRPC methods.
 		# Can be used by both client stubs and server implementations.
 		class Interface
+			# RPC method definition
+			RPC = Struct.new(:request_class, :response_class, :streaming, :method, keyword_init: true) do
+				def initialize(request_class:, response_class:, streaming: :unary, method: nil)
+					super
+				end
+				
+				# Check if this RPC is a streaming RPC (server, client, or bidirectional).
+				# Server-side handlers for streaming RPCs are expected to block until all messages are sent.
+				# @returns [Boolean] `true` if streaming, `false` if unary
+				def streaming?
+					streaming != :unary
+				end
+			end
+			
 			# Hook called when a subclass is created.
 			# Initializes the RPC hash for the subclass.
 			# @parameter subclass [Class] The subclass being created
@@ -33,6 +40,9 @@ module Protocol
 			# @parameter streaming [Symbol] Streaming type (:unary, :server_streaming, :client_streaming, :bidirectional)
 			# @parameter method [Symbol | Nil] Optional explicit Ruby method name (snake_case). If not provided, automatically converts PascalCase to snake_case.
 			def self.rpc(name, **options)
+				# Ensure snake_case method name is always available
+				options[:method] ||= pascal_case_to_snake_case(name.to_s).to_sym
+				
 				@rpcs[name] = RPC.new(**options)
 			end
 			
@@ -44,12 +54,15 @@ module Protocol
 				klass = self
 				while klass && klass != Interface
 					if klass.instance_variable_defined?(:@rpcs)
-						rpc = klass.instance_variable_get(:@rpcs)[name]
-						return rpc if rpc
+						if rpc = klass.instance_variable_get(:@rpcs)[name]
+							return rpc
+						end
 					end
 					klass = klass.superclass
 				end
-				nil
+				
+				# Not found:
+				return nil
 			end
 			
 			# Get all RPC definitions from this class and all parent classes.
@@ -69,21 +82,33 @@ module Protocol
 				all_rpcs
 			end
 			
-			# @attribute [String] The service name (e.g., "hello.Greeter").
-			attr :name
-			
 			# Initialize a new interface instance.
 			# @parameter name [String] Service name
 			def initialize(name)
 				@name = name
 			end
 			
+			# @attribute [String] The service name (e.g., "hello.Greeter").
+			attr :name
+			
 			# Build gRPC path for a method.
 			# @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)
 			end
+			
+		private
+			
+			# Convert PascalCase to snake_case.
+			# @parameter pascal_case [String] PascalCase string (e.g., "SayHello")
+			# @returns [String] snake_case string (e.g., "say_hello")
+			def self.pascal_case_to_snake_case(pascal_case)
+				pascal_case
+					.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')  # Insert underscore before capital letters followed by lowercase
+					.gsub(/([a-z\d])([A-Z])/, '\1_\2')      # Insert underscore between lowercase/digit and uppercase
+					.downcase
+			end
 		end
 	end
 end

data/lib/protocol/grpc/metadata.rb

@@ -33,8 +33,22 @@ module Protocol
 					status.to_i
 				else
 					# Fallback for when header policy isn't used
-					status_value = status.is_a?(Array) ? status.first : status.to_s
-					status_value.to_i
+					# Handle Array case (may occur with external clients)
+					status_value = if status.is_a?(Array)
+						# Flatten and take first non-nil value, recursively handle nested arrays
+						flattened = status.flatten.compact.first
+						# If still an array, take first element
+						flattened.is_a?(Array) ? flattened.first : flattened
+					else
+						status
+					end
+					
+					# Convert to string then integer to handle various types
+					# Handle case where status_value might still be an array somehow
+					if status_value.is_a?(Array)
+						status_value = status_value.first
+					end
+					status_value.to_s.to_i
 				end
 			end
 			

data/lib/protocol/grpc/version.rb

@@ -7,6 +7,7 @@
 module Protocol
 	# @namespace
 	module GRPC
-		VERSION = "0.1.0"
+		VERSION = "0.3.0"
 	end
 end
+

data/readme.md

@@ -28,6 +28,16 @@ Please see the [project documentation](https://socketry.github.io/protocol-grpc/
 
 Please see the [project releases](https://socketry.github.io/protocol-grpc/releases/index) for all releases.
 
+### v0.3.0
+
+  - **Breaking**: `Protocol::GRPC::Call` now takes a `response` object parameter instead of separate `response_headers`.
+  - **Breaking**: Removed `Call#response_headers` method. Use `call.response.headers` directly.
+  - Added `RPC#streaming?` method to check if an RPC is streaming.
+
+### v0.2.0
+
+  - `RPC#method` is always defined (snake case).
+
 ### v0.1.0
 
   - Initial design.

data/releases.md

@@ -1,5 +1,15 @@
 # Releases
 
+## v0.3.0
+
+  - **Breaking**: `Protocol::GRPC::Call` now takes a `response` object parameter instead of separate `response_headers`.
+  - **Breaking**: Removed `Call#response_headers` method. Use `call.response.headers` directly.
+  - Added `RPC#streaming?` method to check if an RPC is streaming.
+
+## v0.2.0
+
+  - `RPC#method` is always defined (snake case).
+
 ## v0.1.0
 
   - Initial design.

data.tar.gz.sig

@@ -0,0 +1,2 @@
+H��
���\�{̡���鴋V�D X�7���^:6'�B�C��ںR�w�x��͂�~˜��"c�q(?Ս���׻�v%sz���01�D�1�z��V���ۘL�~�'�/z�W?�1�-�6|��F�$����륁���`�y>�ˡqua�6��<n�\�
+�<��x���x<$�O�O���u� ߣ̕�
�]]�s���#�X7'�^Һ�&��]�%o4��&6�
�+��{��w!�h��#A��=��j]�y����Z��

metadata

@@ -1,12 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: protocol-grpc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
 bindir: bin
-cert_chain: []
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency