grpc-rest 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bfe3edbd1ceece344b2dff703ce619a0d829e40cec4022fe4676fe61ab77940
-  data.tar.gz: a86fd6b8b0fd11479510e3db9296431d4f36490ec2ad1037ce2a1e80fcac2578
+  metadata.gz: 0713304a9f049b5c4cdd88510c9e2b32f9bfd9df2a66987a6b313212be2d6376
+  data.tar.gz: 33ca8e2b7014e3abd546967dcd55a8a9c422852026e6dd4275255c66f1c8eed2
 SHA512:
-  metadata.gz: c08004595c9f8db0c3e7f6a0f9b15c35fa91f83229ed2741a303633fd174a6f1dba521ba73fb989a17ea901fd5c46177f842449845fd5493c45182bcc232bde4
-  data.tar.gz: 4010b037a9bd33eb3b5b80896dbc73449f4adb2fccc51771ecec9d0bea1017365181eb9c4e23e87763c8c62cbf15a43da9e5bf2c0b2ef8ae5e6f4f6da870d1ec
+  metadata.gz: 8707159314407984f4b83c5ae31247580c12de1958a0775de68e40a615ba083bfca6445070d566109a8b473b1f7bf7a8070fa94769ce5f3e3ff2222fd04ee924
+  data.tar.gz: 2ec048673f1f4ae4adbf42a7d61393aeebe9df4c6247535b2250d554d8c46c41576440133074dda527cf4cfb37b18786088399bcb9f027c1b904d7e83736271e

data/CHANGELOG

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 0.1.14 - 2024-06-25
+- Emit the correct error code on failure.
+
+# 0.1.13 - 2024-06-24
+- Use grpc's `to_json` methods to output fields correctly.
+
 # 0.1.12 - 2024-05-15
 - Parse numbers into Ruby number objects.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grpc-rest (0.1.11)
+    grpc-rest (0.1.12)
       grpc
       rails (>= 6.0)
 

data/lib/grpc_rest/version.rb

@@ -1,3 +1,3 @@
 module GrpcRest
-  VERSION = '0.1.12'
+  VERSION = '0.1.14'
 end

data/lib/grpc_rest.rb

@@ -1,5 +1,6 @@
 require 'google/protobuf/well_known_types'
 require 'grpc'
+require 'grpc/core/status_codes'
 
 module GrpcRest
   class << self
@@ -79,7 +80,7 @@ module GrpcRest
 
     def init_request(request_class, params)
       map_proto_type(request_class.descriptor, params)
-      request_class.new(params)
+      request_class.decode_json(JSON.generate(params))
     end
 
     def assign_params(request, param_hash, body_string, params)
@@ -105,16 +106,60 @@ module GrpcRest
       end
     end
 
+    # Ported from https://github.com/grpc-ecosystem/grpc-gateway/blob/main/runtime/errors.go#L36
+    def grpc_http_status(code)
+      case code
+      when GRPC::Core::StatusCodes::OK
+        :ok
+      when GRPC::Core::StatusCodes::CANCELLED
+        499
+      when GRPC::Core::StatusCodes::INVALID_ARGUMENT,
+        GRPC::Core::StatusCodes::FAILED_PRECONDITION,
+        GRPC::Core::StatusCodes::OUT_OF_RANGE
+        :bad_request
+      when GRPC::Core::StatusCodes::DEADLINE_EXCEEDED
+        :gateway_timeout
+      when GRPC::Core::StatusCodes::NOT_FOUND
+        :not_found
+      when GRPC::Core::StatusCodes::ALREADY_EXISTS, GRPC::Core::StatusCodes::ABORTED
+        :conflict
+      when GRPC::Core::StatusCodes::PERMISSION_DENIED
+        :forbidden
+      when GRPC::Core::StatusCodes::UNAUTHENTICATED
+        :unauthorized
+      when GRPC::Core::StatusCodes::RESOURCE_EXHAUSTED
+        :too_many_requests
+      when GRPC::Core::StatusCodes::UNIMPLEMENTED
+        :not_implemented
+      when GRPC::Core::StatusCodes::UNAVAILABLE
+        :service_unavailable
+      else
+        :internal_server_error
+      end
+    end
+
     def error_msg(error)
+      if error.respond_to?(:code)
       {
-          code: 3,
-          message: "InvalidArgument: #{error.message}",
+          code: error.code,
+          message: error.message,
           details: [
                     {
                       backtrace: error.backtrace
                     }
           ]
       }
+      else
+        {
+            code: 3,
+            message: "InvalidArgument: #{error.message}",
+            details: [
+                      {
+                        backtrace: error.backtrace
+                      }
+            ]
+        }
+      end
     end
 
     def send_gruf_request(klass, service_obj, method, request)
@@ -141,10 +186,10 @@ module GrpcRest
           k.bound_service == service_obj
         end
         if klass
-          return send_gruf_request(klass, service_obj, method, request).to_h
+          return send_gruf_request(klass, service_obj, method, request)
         end
       end
-      send_grpc_request(service, method, request).to_h
+      send_grpc_request(service, method, request)
     end
   end
 

data/protoc-gen-rails/internal/output.go

@@ -46,8 +46,14 @@ class {{.ControllerName}}Controller < ActionController::Base
   protect_from_forgery with: :null_session
 
 	rescue_from StandardError do |e|
-		render json: GrpcRest.error_msg(e)
+		render json: GrpcRest.error_msg(e), status: :internal_server_error
 	end
+  rescue_from GRPC::BadStatus do |e|
+		render json: GrpcRest.error_msg(e), status: :internal_server_error
+  end
+  rescue_from Google::Protobuf::TypeError do |e|
+    render json: GrpcRest.error_msg(e), status: :bad_request
+  end
   METHOD_PARAM_MAP = {
 {{range .Methods }}
     "{{.Name}}" => [

data/protoc-gen-rails/testdata/base/app/controllers/my_service_controller.rb

@@ -6,8 +6,14 @@ class MyServiceController < ActionController::Base
   protect_from_forgery with: :null_session
 
 	rescue_from StandardError do |e|
-		render json: GrpcRest.error_msg(e)
+		render json: GrpcRest.error_msg(e), status: :internal_server_error
 	end
+  rescue_from GRPC::BadStatus do |e|
+		render json: GrpcRest.error_msg(e), status: :internal_server_error
+  end
+  rescue_from Google::Protobuf::TypeError do |e|
+    render json: GrpcRest.error_msg(e), status: :bad_request
+  end
   METHOD_PARAM_MAP = {
 
     "test" => [

data/spec/grpc_rest_spec.rb

@@ -28,8 +28,8 @@ RSpec.describe MyServiceController, type: :request do
       get "/test/blah/xyz?test_id=abc"
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
-                                           'some_int' => 1,
-                                           'full_response' => %({"testId":"abc","foobar":"xyz"})
+                                           'someInt' => 1,
+                                           'fullResponse' => %({"testId":"abc","foobar":"xyz"})
                                          })
     end
   end
@@ -44,8 +44,8 @@ RSpec.describe MyServiceController, type: :request do
       post '/test2?test_id=abc&foobar=xyz&timestamp_field=2024-04-03+01:02:03+UTC', params: params, as: :json
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
-                                           'some_int' => 2,
-                                           'full_response' => %({"testId":"abc","foobar":"xyz","secondRecord":{"subId":"id1","anotherId":"id2"},"timestampField":"2024-04-03T01:02:03Z"})
+                                           'someInt' => 2,
+                                           'fullResponse' => %({"testId":"abc","foobar":"xyz","secondRecord":{"subId":"id1","anotherId":"id2"},"timestampField":"2024-04-03T01:02:03Z"})
                                          })
     end
 
@@ -56,8 +56,8 @@ RSpec.describe MyServiceController, type: :request do
       post '/test3/xyz?test_id=abc'
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
-                                           'some_int' => 3,
-                                           'full_response' => %({"testId":"abc","subRecord":{"subId":"xyz"}})
+                                           'someInt' => 3,
+                                           'fullResponse' => %({"testId":"abc","subRecord":{"subId":"xyz"}})
                                          })
     end
   end
@@ -95,8 +95,8 @@ RSpec.describe MyServiceController, type: :request do
       post '/test4', params: params, as: :json
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
-                                           'some_int' => 4,
-                                           'full_response' => %({"testId":"abc","foobar":"xyz","repeatedString":["W","T","F"],"subRecord":{"subId":"id1","anotherId":"id2"},"secondRecord":{"subId":"id3","anotherId":"id4"},"structField":{"bool_key":true,"str_key":"val","nil_key":null,"list_key":[{"inner_key":"inner_val"}],"int_key":123},"timestampField":"2024-04-03T01:02:03Z","listValue":["F","Y","I"],"bareValue":45,\"someInt\":65})
+                                           'someInt' => 4,
+                                           'fullResponse' => %({"testId":"abc","foobar":"xyz","repeatedString":["W","T","F"],"subRecord":{"subId":"id1","anotherId":"id2"},"secondRecord":{"subId":"id3","anotherId":"id4"},"structField":{"bool_key":true,"str_key":"val","nil_key":null,"list_key":[{"inner_key":"inner_val"}],"int_key":123},"timestampField":"2024-04-03T01:02:03Z","listValue":["F","Y","I"],"bareValue":45,\"someInt\":65})
                                          })
     end
   end
@@ -109,8 +109,8 @@ RSpec.describe MyServiceController, type: :request do
       post "/test4", params: params, as: :json
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
-                                           'some_int' => 4,
-                                           'full_response' => %({"timestampField":"2024-04-09T19:54:12Z"})
+                                           'someInt' => 4,
+                                           'fullResponse' => %({"timestampField":"2024-04-09T19:54:12Z"})
                                          })
     end
   end
@@ -127,8 +127,8 @@ RSpec.describe MyServiceController, type: :request do
       post '/test4', params:, as: :json
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
-                                           'some_int' => 4,
-                                           'full_response' => %({"subRecords":[{"subId":"id1","anotherId":"id2"}]})
+                                           'someInt' => 4,
+                                           'fullResponse' => %({"subRecords":[{"subId":"id1","anotherId":"id2"}]})
                                          })
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-15 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc