protocol-grpc 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 034feb2e3b17d2cdf00697215d48a3d62d328c37df11f437b410ac6a0878b16f
-  data.tar.gz: 3a94f6c1431029e2449383ef0f51196cc4aa7dd5e60f33d938270ffa05e877a8
+  metadata.gz: 2195318192e11fc3cafc54e82ccb65b4111e1e5ab9d1772ec8e4e002e6251136
+  data.tar.gz: 9916efb3e3966c9242cbefca5534d233f82d079d363a4ecec86c4808dd707bcf
 SHA512:
-  metadata.gz: 141ad27dd57585879827d433964c3e8de3895cd41347b49b909bc5d33bc92bc87f5825bfd46bc167b01c99d3d7a37cd83741b2f3e473391af2148b25d427993c
-  data.tar.gz: 8997edac6e081b1681cc8bbee2b5d4ea49de5f6af12dacd55946353a301f32d9446ab9487bf6ec27df15209303b264afa231ef5f7fbc67e7fb2bf2f03d440761
+  metadata.gz: 8236e53f25377fc556da30e47e36e8828a20fb7b2064d7a2b8046309f23ab26e98f3a8338842fb429f47fb510e58361ebcc1e06f24d097f4d37507159eb050b6
+  data.tar.gz: 2941d6b8edb774e16c6530b20cc76d330fccc05021564a32bb5bf8b4e5448c4e664001d3a59bd71cf584d4c276688b84749c6096582ff2661be6e761ca729650

data/context/getting-started.md

@@ -18,8 +18,8 @@ $ bundle add protocol-grpc
   - A {ruby Protocol::GRPC::Body::Readable} class which handles reading gRPC messages from HTTP request/response bodies with automatic framing and decoding.
   - A {ruby Protocol::GRPC::Body::Writable} class which handles writing gRPC messages to HTTP request/response bodies with automatic framing and encoding.
   - A {ruby Protocol::GRPC::Middleware} abstract base class for building gRPC server applications.
-  - A {ruby Protocol::GRPC::Call} class which represents the context of a single gRPC RPC call, including deadline tracking.
-  - A {ruby Protocol::GRPC::Status} module with gRPC status code constants.
+  - A {ruby Protocol::GRPC::Call} class which represents the request, response, metadata, and deadline for a single gRPC RPC call.
+  - A {ruby Protocol::GRPC::Status} module with gRPC status code constants and names.
   - A {ruby Protocol::GRPC::Error} hierarchy for gRPC-specific error handling.
 
 ## Integration
@@ -103,6 +103,9 @@ if status != Protocol::GRPC::Status::OK
 	message = Protocol::GRPC::Metadata.extract_message(response.headers)
 	raise Protocol::GRPC::Error.for(status, message)
 end
+
+# Use canonical gRPC status names for logging, metrics, or serialization:
+Protocol::GRPC::Status::NAMES[status] # => "OK"
 ```
 
 ### Server Middleware
@@ -132,13 +135,14 @@ end
 ``` ruby
 require "protocol/grpc/call"
 
-call = Protocol::GRPC::Call.new(request, deadline: deadline)
+call = Protocol::GRPC::Call.new(request, response, deadline: deadline)
 
 # Access request
 call.request  # => Protocol::HTTP::Request
 
-# Check deadline
+# Check deadline and status
 call.deadline.exceeded?  # => false
+call.status  # => Protocol::GRPC::Status::OK
 
 # Access peer information
 call.peer  # => Protocol::HTTP::Address

data/design.md

@@ -496,25 +496,25 @@ module Protocol
 			DATA_LOSS = 15
 			UNAUTHENTICATED = 16
 			
-			# Status code descriptions
-			DESCRIPTIONS = {
+			# Status code names
+			NAMES = {
 				OK => "OK",
-				CANCELLED => "Cancelled",
-				UNKNOWN => "Unknown",
-				INVALID_ARGUMENT => "Invalid Argument",
-				DEADLINE_EXCEEDED => "Deadline Exceeded",
-				NOT_FOUND => "Not Found",
-				ALREADY_EXISTS => "Already Exists",
-				PERMISSION_DENIED => "Permission Denied",
-				RESOURCE_EXHAUSTED => "Resource Exhausted",
-				FAILED_PRECONDITION => "Failed Precondition",
-				ABORTED => "Aborted",
-				OUT_OF_RANGE => "Out of Range",
-				UNIMPLEMENTED => "Unimplemented",
-				INTERNAL => "Internal",
-				UNAVAILABLE => "Unavailable",
-				DATA_LOSS => "Data Loss",
-				UNAUTHENTICATED => "Unauthenticated"
+				CANCELLED => "CANCELLED",
+				UNKNOWN => "UNKNOWN",
+				INVALID_ARGUMENT => "INVALID_ARGUMENT",
+				DEADLINE_EXCEEDED => "DEADLINE_EXCEEDED",
+				NOT_FOUND => "NOT_FOUND",
+				ALREADY_EXISTS => "ALREADY_EXISTS",
+				PERMISSION_DENIED => "PERMISSION_DENIED",
+				RESOURCE_EXHAUSTED => "RESOURCE_EXHAUSTED",
+				FAILED_PRECONDITION => "FAILED_PRECONDITION",
+				ABORTED => "ABORTED",
+				OUT_OF_RANGE => "OUT_OF_RANGE",
+				UNIMPLEMENTED => "UNIMPLEMENTED",
+				INTERNAL => "INTERNAL",
+				UNAVAILABLE => "UNAVAILABLE",
+				DATA_LOSS => "DATA_LOSS",
+				UNAUTHENTICATED => "UNAUTHENTICATED"
 			}.freeze
 		end
 	end
@@ -535,7 +535,6 @@ module Protocol
 			def initialize(request, deadline: nil)
 				@request = request
 				@deadline = deadline
-				@cancelled = false
 			end
 			
 			# @attribute [Protocol::HTTP::Request] The underlying HTTP request
@@ -562,17 +561,6 @@ module Protocol
 				@deadline ? [@deadline - Time.now, 0].max : nil
 			end
 			
-			# Mark this call as cancelled
-			def cancel!
-				@cancelled = true
-			end
-			
-			# Check if call was cancelled
-			# @returns [Boolean]
-			def cancelled?
-				@cancelled
-			end
-			
 			# Get peer information (client address)
 			# @returns [String | Nil]
 			def peer
@@ -597,7 +585,7 @@ module Protocol
 				@status_code = status_code
 				@details = details
 				@metadata = metadata
-				super(message || Status::DESCRIPTIONS[status_code])
+				super(message || Status::NAMES[status_code])
 			end
 		end
 		

data/lib/protocol/grpc/call.rb

@@ -31,7 +31,6 @@ module Protocol
 				@request = request
 				@response = response
 				@deadline = deadline
-				@cancelled = false
 			end
 			
 			# @attribute [Protocol::HTTP::Request] The underlying HTTP request.
@@ -67,15 +66,12 @@ module Protocol
 				@deadline&.remaining
 			end
 			
-			# Mark this call as cancelled.
-			def cancel!
-				@cancelled = true
-			end
-			
-			# Check if the call was cancelled.
-			# @returns [Boolean] `true` if the call was cancelled, `false` otherwise
-			def cancelled?
-				@cancelled
+			# Get the current gRPC status of the call.
+			# @returns [Integer | Nil] The current gRPC status code, if available.
+			def status
+				if headers = @response&.headers
+					headers["grpc-status"]&.to_i
+				end
 			end
 			
 			# Get peer information (client address).

data/lib/protocol/grpc/error.rb

@@ -17,7 +17,7 @@ module Protocol
 				@status_code = status_code
 				@details = details
 				@metadata = metadata
-				super(message || Status::DESCRIPTIONS[status_code])
+				super(message || Status::NAMES[status_code])
 			end
 			
 			# Map status code to error class

data/lib/protocol/grpc/status.rb

@@ -5,7 +5,7 @@
 
 module Protocol
 	module GRPC
-		# Provides gRPC status codes and their descriptions.
+		# Provides gRPC status codes and their names.
 		module Status
 			OK = 0
 			CANCELLED = 1
@@ -25,25 +25,25 @@ module Protocol
 			DATA_LOSS = 15
 			UNAUTHENTICATED = 16
 			
-			# Status code descriptions
-			DESCRIPTIONS = {
+			# Status code names, as defined by the gRPC specification.
+			NAMES = {
 				OK => "OK",
-				CANCELLED => "Cancelled",
-				UNKNOWN => "Unknown",
-				INVALID_ARGUMENT => "Invalid Argument",
-				DEADLINE_EXCEEDED => "Deadline Exceeded",
-				NOT_FOUND => "Not Found",
-				ALREADY_EXISTS => "Already Exists",
-				PERMISSION_DENIED => "Permission Denied",
-				RESOURCE_EXHAUSTED => "Resource Exhausted",
-				FAILED_PRECONDITION => "Failed Precondition",
-				ABORTED => "Aborted",
-				OUT_OF_RANGE => "Out of Range",
-				UNIMPLEMENTED => "Unimplemented",
-				INTERNAL => "Internal",
-				UNAVAILABLE => "Unavailable",
-				DATA_LOSS => "Data Loss",
-				UNAUTHENTICATED => "Unauthenticated"
+				CANCELLED => "CANCELLED",
+				UNKNOWN => "UNKNOWN",
+				INVALID_ARGUMENT => "INVALID_ARGUMENT",
+				DEADLINE_EXCEEDED => "DEADLINE_EXCEEDED",
+				NOT_FOUND => "NOT_FOUND",
+				ALREADY_EXISTS => "ALREADY_EXISTS",
+				PERMISSION_DENIED => "PERMISSION_DENIED",
+				RESOURCE_EXHAUSTED => "RESOURCE_EXHAUSTED",
+				FAILED_PRECONDITION => "FAILED_PRECONDITION",
+				ABORTED => "ABORTED",
+				OUT_OF_RANGE => "OUT_OF_RANGE",
+				UNIMPLEMENTED => "UNIMPLEMENTED",
+				INTERNAL => "INTERNAL",
+				UNAVAILABLE => "UNAVAILABLE",
+				DATA_LOSS => "DATA_LOSS",
+				UNAUTHENTICATED => "UNAUTHENTICATED"
 			}.freeze
 		end
 	end

data/lib/protocol/grpc/version.rb

@@ -7,7 +7,7 @@
 module Protocol
 	# @namespace
 	module GRPC
-		VERSION = "0.13.1"
+		VERSION = "0.15.0"
 	end
 end
 

data/readme.md

@@ -28,6 +28,15 @@ 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.15.0
+
+  - **Breaking**: Removed `Protocol::GRPC::Status::DESCRIPTIONS`. Use `Protocol::GRPC::Status::NAMES` for canonical gRPC status names.
+
+### v0.14.0
+
+  - **Breaking**: Removed the unused `Protocol::GRPC::Call#cancel!` and `Protocol::GRPC::Call#cancelled?` methods.
+  - Added `Protocol::GRPC::Call#status` to report the status assigned to the response.
+
 ### v0.13.1
 
   - **Breaking**: Removed the deprecated `Protocol::GRPC::Methods` module. Use `Protocol::GRPC::Route`, `Protocol::GRPC::Metadata`, and `Protocol::GRPC::Header::Timeout` instead.
@@ -66,10 +75,6 @@ Please see the [project releases](https://socketry.github.io/protocol-grpc/relea
 
   - `RPC#method` is always defined (snake case).
 
-### v0.1.0
-
-  - Initial design.
-
 ## See Also
 
   - [async-grpc](https://github.com/socketry/async-grpc) — Asynchronous gRPC client and server implementation using this interface.

data/releases.md

@@ -1,5 +1,14 @@
 # Releases
 
+## v0.15.0
+
+  - **Breaking**: Removed `Protocol::GRPC::Status::DESCRIPTIONS`. Use `Protocol::GRPC::Status::NAMES` for canonical gRPC status names.
+
+## v0.14.0
+
+  - **Breaking**: Removed the unused `Protocol::GRPC::Call#cancel!` and `Protocol::GRPC::Call#cancelled?` methods.
+  - Added `Protocol::GRPC::Call#status` to report the status assigned to the response.
+
 ## v0.13.1
 
   - **Breaking**: Removed the deprecated `Protocol::GRPC::Methods` module. Use `Protocol::GRPC::Route`, `Protocol::GRPC::Metadata`, and `Protocol::GRPC::Header::Timeout` instead.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-grpc
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams