grpc-rest 0.1.19 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c9a0fd0dc8a21c8ff8e5103a6bdffe98cc51cb522fb8dac59a65b2e9ceacc7c
-  data.tar.gz: a42ae7274e7a9db0161e3a40374d050a334312c742d8737652ab8fd8aaa55ec4
+  metadata.gz: '090bea208182dd067a0a1f0347e9cb4484610dca9a7a4f1c2f7689fa216d40e8'
+  data.tar.gz: 3695746b75dcbba972e88249ad2785551d7e0e4fbd9d8a01140496dfa4f2a002
 SHA512:
-  metadata.gz: 624a27f0b5345256376d3a3cbd418543339d9f604ef42866da442a4589fd0732702b61e02f37d14e31b1cb53f5d707d73a8924af45df9be65995942316b75d86
-  data.tar.gz: d548c211f158b8095ec655691e11c1cb815382ecdfce8a42ed014fdcf82d5286e333d2894a8c5bdb3564b861beba29387b2936a39c6d28108e7d3d472da6ff45
+  metadata.gz: 963b26c2d6141a20a3739341bd564005000a7dfdbe42a0bee3becffd04bc1f7d455a692135f21037399e12431c0bba91e73c17b4aa0d4bef6c75944fef4d2782
+  data.tar.gz: eaad993e480c9a9e7d05c55dedd4a7de06712666b3cd5601b6566bcd5da955a5b30e7528562b117b35297862cc4a6ad3930c8aabcc5eb81bbba6417ab3babae5

data/CHANGELOG

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 0.1.21 - 2024-09-12
+- Feature: Support gruf Interceptors.
+
+# 0.1.20 - 2024-09-10
+- Fix: Repeated float values weren't being treated as arrays and were crashing.
+
 # 0.1.19 - 2024-08-22
 
 - Add `emit_defaults` extension for JSON responses.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grpc-rest (0.1.19)
+    grpc-rest (0.1.21)
       grpc
       rails (>= 6.0)
 
@@ -91,8 +91,18 @@ GEM
     grpc (1.62.0-x86_64-linux)
       google-protobuf (~> 3.25)
       googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.64.0)
+    gruf (2.20.0)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      json (>= 2.3)
+      slop (>= 4.6)
+      zeitwerk (>= 2)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
+    json (2.7.2)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -169,6 +179,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
+    slop (4.10.1)
     thor (1.3.1)
     timeout (0.4.1)
     tzinfo (2.0.6)
@@ -184,6 +195,7 @@ PLATFORMS
 
 DEPENDENCIES
   grpc-rest!
+  gruf
   rspec-rails
 
 BUNDLED WITH

data/README.md

@@ -152,6 +152,10 @@ service MyService {
 }
 ```
 
+## Gruf Interceptors
+
+grpc-rest supports [gruf](https://github.com/bigcommerce/gruf) Interceptors. As long as you're not using a custom interceptor
+registry, your interceptors will be called normally around the controller.
 
 ## To Do
 

data/grpc-rest.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('rails', '>= 6.0')
 
   spec.add_development_dependency('rspec-rails')
+  spec.add_development_dependency('gruf')
 end

data/lib/grpc_rest/version.rb

@@ -1,3 +1,3 @@
 module GrpcRest
-  VERSION = '0.1.19'
+  VERSION = '0.1.21'
 end

data/lib/grpc_rest.rb

@@ -63,56 +63,55 @@ module GrpcRest
       end
     end
 
-    def map_proto_type(proto, params)
+    def map_proto_type(descriptor, val)
+      if descriptor.subtype.is_a?(Google::Protobuf::EnumDescriptor)
+        return handle_enum_values(descriptor, val)
+      end
+
+      case descriptor.type
+      when *%i(int32 int64 uint32 uint64 sint32 sint64 fixed32 fixed64 sfixed32 sfixed64)
+        return val.to_i
+      when *%i(float double)
+        return val.to_f
+      when :bool
+        return !!val
+      end
+
+      case descriptor.subtype&.name
+      when 'google.protobuf.Struct'
+        return Google::Protobuf::Struct.from_hash(val)
+      when 'google.protobuf.Timestamp'
+        if val.is_a?(Numeric)
+          return Google::Protobuf::Timestamp.from_time(Time.at(val))
+        else
+          return Google::Protobuf::Timestamp.from_time(Time.new(val))
+        end
+      when 'google.protobuf.Value'
+        return Google::Protobuf::Value.from_ruby(val)
+      when 'google.protobuf.ListValue'
+        return Google::Protobuf::ListValue.from_a(val)
+      else
+        return map_proto_record(descriptor.subtype, val)
+      end
+    end
+
+    def map_proto_record(proto, params)
       proto.to_a.each do |descriptor|
         field = descriptor.name
         val = params[field]
         next if val.nil?
-        if descriptor.subtype.is_a?(Google::Protobuf::EnumDescriptor)
-          if descriptor.label == :repeated
-            params[field] = val.map { |v| handle_enum_values(descriptor, v)}
-          else
-            params[field] = handle_enum_values(descriptor, val)
-          end
-          next
-        end
-
-        case descriptor.type
-        when *%i(int32 int64 uint32 uint64 sint32 sint64 fixed32 fixed64 sfixed32 sfixed64)
-          params[field] = val.to_i
-        when *%i(float double)
-          params[field] = val.to_f
-        when :bool
-          params[field] = !!val
-        end
 
-        case descriptor.subtype&.name
-        when 'google.protobuf.Struct'
-          params[field] = Google::Protobuf::Struct.from_hash(val)
-        when 'google.protobuf.Timestamp'
-          if val.is_a?(Numeric)
-            params[field] = Google::Protobuf::Timestamp.from_time(Time.at(val))
-          else
-            params[field] = Google::Protobuf::Timestamp.from_time(Time.new(val))
-          end
-        when 'google.protobuf.Value'
-          params[field] = Google::Protobuf::Value.from_ruby(val)
-        when 'google.protobuf.ListValue'
-          params[field] = Google::Protobuf::ListValue.from_a(val)
+        if descriptor.label == :repeated
+          params[field] = val.map { |v| map_proto_type(descriptor, v) }
         else
-          if params[field].is_a?(Array)
-            params[field].each do |item|
-              map_proto_type(descriptor.subtype, item)
-            end
-          else
-            map_proto_type(descriptor.subtype, params[field])
-          end
+          params[field] = map_proto_type(descriptor, val)
         end
       end
+      params
     end
 
     def init_request(request_class, params)
-      map_proto_type(request_class.descriptor, params)
+      map_proto_record(request_class.descriptor, params)
       request_class.decode_json(JSON.generate(params), ignore_unknown_fields: true)
     end
 
@@ -204,7 +203,18 @@ module GrpcRest
         active_call: nil,
         message: request
       )
-      handler.send(method.to_sym)
+      Gruf::Interceptors::Context.new(gruf_interceptors(request)).intercept! do
+        handler.send(method.to_sym)
+      end
+    end
+
+    # @param request [Google::Protobuf::AbstractMessage]
+    # @return [Array<Gruf::Interceptors::Base>]
+    def gruf_interceptors(request)
+      error = Gruf::Error.new
+      interceptors = Gruf.interceptors.prepare(request, error)
+      interceptors.delete_if { |k| k.class.name.split('::').first == 'Gruf' }
+      interceptors
     end
 
     def send_grpc_request(service, method, request)

data/protoc-gen-rails/testdata/test_service.proto

@@ -20,6 +20,7 @@ message TestRequest {
   repeated SubRecord sub_records = 10;
   int32 some_int = 11;
   TestEnum some_enum = 12;
+  repeated float repeated_float = 13;
 }
 
 message SubRecord {

data/spec/grpc_rest_spec.rb

@@ -67,6 +67,7 @@ RSpec.describe MyServiceController, type: :request do
     let(:params) do
       {
         test_id: 'abc',
+        repeated_float: [1.0, 2.0],
         some_int: "65",
         foobar: 'xyz',
         repeated_string: ['W', 'T', 'F'],
@@ -101,7 +102,7 @@ RSpec.describe MyServiceController, type: :request do
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
                                            '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,"someEnum":"TEST_ENUM_FOO"})
+                                           '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,"someEnum":"TEST_ENUM_FOO","repeatedFloat":[1,2]})
                                          })
     end
 
@@ -111,7 +112,7 @@ RSpec.describe MyServiceController, type: :request do
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
                                            '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,"someEnum":"TEST_ENUM_FOO"})
+                                           '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,"someEnum":"TEST_ENUM_FOO","repeatedFloat":[1,2]})
                                          })
     end
   end

data/spec/gruf_spec.rb

@@ -0,0 +1,51 @@
+require_relative './spec_helper'
+require_relative './test_service_services_pb'
+require 'gruf'
+
+class GrufServerImpl < Gruf::Controllers::Base
+
+  bind ::Testdata::MyService::Service
+
+  def test
+    Testdata::TestResponse.new(some_int: 1, full_response: request.message.to_json)
+  end
+
+  def test_2
+    Testdata::TestResponse.new(some_int: 2, full_response: request.message.to_json)
+  end
+
+  def test_3
+    Testdata::TestResponse.new(some_int: 3, full_response: request.message.to_json)
+  end
+
+  def test_4
+    Testdata::TestResponse.new(some_int: 4, full_response: request.message.to_json)
+  end
+
+  cattr_accessor :intercepted
+end
+
+class TestInterceptor < ::Gruf::Interceptors::ServerInterceptor
+  def call
+    GrufServerImpl.intercepted = true
+    yield
+  end
+end
+
+Gruf::Server.new.add_interceptor(TestInterceptor, option_foo: 'value 123')
+
+RSpec.describe MyServiceController, type: :request do
+  describe 'using get' do
+    it 'should be successful and call interceptors' do
+      GrufServerImpl.intercepted = false
+      get "/test/blah/xyz?test_id=abc"
+      expect(response).to be_successful
+      expect(response.parsed_body).to eq({
+                                           'someInt' => 1,
+                                           'fullResponse' => %({"testId":"abc","foobar":"xyz"}),
+                                           "ignoredKey" => ''
+                                         })
+      expect(GrufServerImpl.intercepted).to eq(true)
+    end
+  end
+end

data/spec/test_service_pb.rb

@@ -10,7 +10,7 @@ require 'google/protobuf/timestamp_pb'
 require 'protoc-gen-openapiv2/options/annotations_pb'
 
 
-descriptor_data = "\n\x12test_service.proto\x12\x08testdata\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a.protoc-gen-openapiv2/options/annotations.proto\"\xbf\x03\n\x0bTestRequest\x12\x0f\n\x07test_id\x18\x01 \x01(\t\x12\x0e\n\x06\x66oobar\x18\x02 \x01(\t\x12\x17\n\x0frepeated_string\x18\x03 \x03(\t\x12\'\n\nsub_record\x18\x04 \x01(\x0b\x32\x13.testdata.SubRecord\x12*\n\rsecond_record\x18\x05 \x01(\x0b\x32\x13.testdata.SubRecord\x12-\n\x0cstruct_field\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x33\n\x0ftimestamp_field\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12.\n\nlist_value\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12*\n\nbare_value\x18\t \x01(\x0b\x32\x16.google.protobuf.Value\x12(\n\x0bsub_records\x18\n \x03(\x0b\x32\x13.testdata.SubRecord\x12\x10\n\x08some_int\x18\x0b \x01(\x05\x12%\n\tsome_enum\x18\x0c \x01(\x0e\x32\x12.testdata.TestEnum\"/\n\tSubRecord\x12\x0e\n\x06sub_id\x18\x01 \x01(\t\x12\x12\n\nanother_id\x18\x02 \x01(\t\"L\n\x0cTestResponse\x12\x10\n\x08some_int\x18\x01 \x01(\x05\x12\x15\n\rfull_response\x18\x02 \x01(\t\x12\x13\n\x0bignored_key\x18\x03 \x01(\t*K\n\x08TestEnum\x12\x19\n\x15TEST_ENUM_UNSPECIFIED\x10\x00\x12\x11\n\rTEST_ENUM_FOO\x10\x01\x12\x11\n\rTEST_ENUM_BAR\x10\x02\x32\x83\x03\n\tMyService\x12x\n\x04Test\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"A\x92\x41!j\x1f\n\x19x-grpc-rest-emit-defaults\x12\x02 \x01\x82\xd3\xe4\x93\x02\x17\x12\x15/test/{foobar=blah/*}\x12U\n\x05Test2\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"\x1d\x82\xd3\xe4\x93\x02\x17\"\x06/test2:\rsecond_record\x12Z\n\x05Test3\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"\"\x82\xd3\xe4\x93\x02\x1c\"\x1a/test3/{sub_record.sub_id}\x12I\n\x05Test4\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"\x11\x82\xd3\xe4\x93\x02\x0b\"\x06/test4:\x01*b\x06proto3"
+descriptor_data = "\n\x12test_service.proto\x12\x08testdata\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a.protoc-gen-openapiv2/options/annotations.proto\"\xd7\x03\n\x0bTestRequest\x12\x0f\n\x07test_id\x18\x01 \x01(\t\x12\x0e\n\x06\x66oobar\x18\x02 \x01(\t\x12\x17\n\x0frepeated_string\x18\x03 \x03(\t\x12\'\n\nsub_record\x18\x04 \x01(\x0b\x32\x13.testdata.SubRecord\x12*\n\rsecond_record\x18\x05 \x01(\x0b\x32\x13.testdata.SubRecord\x12-\n\x0cstruct_field\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x33\n\x0ftimestamp_field\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12.\n\nlist_value\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12*\n\nbare_value\x18\t \x01(\x0b\x32\x16.google.protobuf.Value\x12(\n\x0bsub_records\x18\n \x03(\x0b\x32\x13.testdata.SubRecord\x12\x10\n\x08some_int\x18\x0b \x01(\x05\x12%\n\tsome_enum\x18\x0c \x01(\x0e\x32\x12.testdata.TestEnum\x12\x16\n\x0erepeated_float\x18\r \x03(\x02\"/\n\tSubRecord\x12\x0e\n\x06sub_id\x18\x01 \x01(\t\x12\x12\n\nanother_id\x18\x02 \x01(\t\"L\n\x0cTestResponse\x12\x10\n\x08some_int\x18\x01 \x01(\x05\x12\x15\n\rfull_response\x18\x02 \x01(\t\x12\x13\n\x0bignored_key\x18\x03 \x01(\t*K\n\x08TestEnum\x12\x19\n\x15TEST_ENUM_UNSPECIFIED\x10\x00\x12\x11\n\rTEST_ENUM_FOO\x10\x01\x12\x11\n\rTEST_ENUM_BAR\x10\x02\x32\x83\x03\n\tMyService\x12x\n\x04Test\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"A\x92\x41!j\x1f\n\x19x-grpc-rest-emit-defaults\x12\x02 \x01\x82\xd3\xe4\x93\x02\x17\x12\x15/test/{foobar=blah/*}\x12U\n\x05Test2\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"\x1d\x82\xd3\xe4\x93\x02\x17\"\x06/test2:\rsecond_record\x12Z\n\x05Test3\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"\"\x82\xd3\xe4\x93\x02\x1c\"\x1a/test3/{sub_record.sub_id}\x12I\n\x05Test4\x12\x15.testdata.TestRequest\x1a\x16.testdata.TestResponse\"\x11\x82\xd3\xe4\x93\x02\x0b\"\x06/test4:\x01*b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.21
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - daniel.orner@flipp.com
@@ -88,6 +102,7 @@ files:
 - protoc-gen-rails/testdata/test.proto
 - protoc-gen-rails/testdata/test_service.proto
 - spec/grpc_rest_spec.rb
+- spec/gruf_spec.rb
 - spec/protoc-gen-openapiv2/options/annotations_pb.rb
 - spec/protoc-gen-openapiv2/options/openapiv2_pb.rb
 - spec/spec_helper.rb
@@ -118,6 +133,7 @@ specification_version: 4
 summary: Generate Rails controllers and routes from gRPC definitions.
 test_files:
 - spec/grpc_rest_spec.rb
+- spec/gruf_spec.rb
 - spec/protoc-gen-openapiv2/options/annotations_pb.rb
 - spec/protoc-gen-openapiv2/options/openapiv2_pb.rb
 - spec/spec_helper.rb