grpc-rest 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8debc27710d5f67910234915d93e7bd9f05cb5d1e58c58c5095b0f52a0ebd5ed
-  data.tar.gz: ce3c4bfc2867bcf8b4b7bd46414b13420a6422d4195798925effc2937c27a3b2
+  metadata.gz: 628c8c0d79cbe90cfcb02c74d1f4e785ed25d7d56267bd1da54d4fe911ba0daa
+  data.tar.gz: a14292a527e3b1ae8c3455b3146c5aa9d3760d4cb11c5a1f206bba22e7690a67
 SHA512:
-  metadata.gz: 8f42517bdc9bf2ddc7cdac30f24aee1b350f5adcb70449e714e75e661237709af10a3ad95df3c8736e429167de87997ccf3d6059599af903fe372d7ff49b2fc7
-  data.tar.gz: 2ec236acb2c9e9b25f6ac0caeb309988434dc4269d66812928de885b2d1527d17dfe5a9c05bff4d53847cd8823257f98309d5d6700a1fb23e1083a868d9d7c03
+  metadata.gz: 64227c2f740fd93e1f9c1bcb3e4779fac6de80c47c5f85848b1ab785a5cde39347a03eee6184ab906937eac465ef40e601adcf0c625aeae97128440d9f8f6c55
+  data.tar.gz: 7c1a0b6bdc6f7d56380646b388fc8eca4755ad750d6a4054d1151d0052e2b661a2dafa4299b72cf883a7dc15fc71b0892fa166c64513b2c28d7f806010110cf6

data/CHANGELOG

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 0.3.0 - 2025-06-11
+
+- Feature: Add `strict_mode` configuration for rejecting invalid JSON fields.
+- Fixes for test failures that were caused by changes in 0.2.0 - test files weren't correctly regenerated.
+
 # 0.2.1 - 2025-05-06
 - Fix: Use `Array.wrap` to prevent grpc-rest from crashing when query parameters don't have `[]` suffixed.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grpc-rest (0.2.0)
+    grpc-rest (0.2.1)
       google-protobuf (>= 4.30.2)
       grpc
       rails (>= 6.0)

data/README.md

@@ -175,6 +175,14 @@ module Interceptors
 end
 ```
 
+### Configuration
+
+GrpcRest currently has one configuration option, `strict_mode`, which defaults to false. When set to true, any JSON request that includes an unknown field will be rejected.
+
+```ruby
+GrpcRest.strict_mode = true
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/grpc-rest.
@@ -182,7 +190,13 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-
 To regenerate Ruby protobuf code for tests, install the `grpc-tools` gem and run this from the base directory:
 
 ```
-grpc_tools_ruby_protoc -I=./protoc-gen-rails/testdata --proto_path=./protoc-gen-rails/google-deps --ruby_out=./spec --grpc_out=./spec ./protoc-gen-rails/testdata/test_service.proto
+grpc_tools_ruby_protoc -I=./spec/testdata --proto_path=./spec/google-deps --ruby_out=./spec --grpc_out=./spec ./spec/testdata/test_service.proto
+```
+
+To regenerate the controller and route files for tests, run:
+
+```
+bundle exec grpc_tools_ruby_protoc -I=./spec/testdata --proto_path=./spec/google-deps --rails_out=spec/testdata/base --rails_opt=require=spec/gen  ./spec/testdata/test_service.proto
 ```
 
 ## License

data/lib/generator/controller.rb.erb

@@ -17,9 +17,9 @@ class <%= service.name.demodulize %>Controller < ActionController::Base
 
 <% service.methods.each do |method| %>
 	def <%= method.name %>
-    fields = <%= method.request_type %>.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(<%= method.request_type %>, parameters.slice(*fields))
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action <%= service.name.underscore %>))
+    grpc_request = GrpcRest.init_request(<%= method.request_type %>, parameters)
     GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["<%= method.name.underscore %>"], "<%= method.option_body %>", request.parameters)
     render json: GrpcRest.send_request("<%= service.namespace %>::<%= service.name.classify %>", "<%= method.name.underscore %>", grpc_request, <%= method.rest_options.inspect %>)
   end

data/lib/generator/method.rb

@@ -82,7 +82,7 @@ module ProtocGenRails
         val = ''
         equal = name.index('=')
         if equal
-          val = name[equal..]
+          val = name[equal+1..]
           name = name[0..equal - 1]
         end
         PathInfo.new(

data/lib/generator.rb

@@ -14,7 +14,6 @@ module ProtocGenRails
   FileResult = Struct.new(:name, :content)
 
   class << self
-
     # @param params [String]
     def require_directories(params)
       params.split(',').each do |param|

data/lib/grpc_rest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrpcRest
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/grpc_rest.rb

@@ -6,6 +6,8 @@ require 'grpc/core/status_codes'
 
 module GrpcRest
   class << self
+    attr_accessor :strict_mode
+
     def underscore(s)
       GRPC::GenericService.underscore(s)
     end
@@ -110,13 +112,16 @@ module GrpcRest
         end
       end
 
-
       params
     end
 
     def init_request(request_class, params)
       map_proto_record(request_class.descriptor, params)
-      request_class.decode_json(JSON.generate(params), ignore_unknown_fields: true)
+      if GrpcRest.strict_mode
+        request_class.decode_json(JSON.generate(params))
+      else
+        request_class.decode_json(JSON.generate(params), ignore_unknown_fields: true)
+      end
     end
 
     def assign_params(request, param_hash, body_string, params)

data/spec/__snapshots__/service.snap

@@ -14,7 +14,7 @@ class MyServiceController < ActionController::Base
   rescue_from ActionDispatch::Http::Parameters::ParseError, Google::Protobuf::TypeError do |e|
     render json: GrpcRest.error_msg(e), status: :bad_request
   end
-  METHOD_PARAM_MAP = {"test"=>[{:name=>"foobar", :val=>"=blah/*", :split_name=>["foobar"]}],
+  METHOD_PARAM_MAP = {"test"=>[{:name=>"foobar", :val=>"blah/*", :split_name=>["foobar"]}],
  "test2"=>[],
  "test3"=>
   [{:name=>"sub_record.sub_id",
@@ -25,33 +25,33 @@ class MyServiceController < ActionController::Base
 
 
 	def test
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
     GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test"], "", request.parameters)
     render json: GrpcRest.send_request("Testdata::MyService", "test", grpc_request, {:emit_defaults=>true})
   end
 
 	def test2
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
     GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test2"], "second_record", request.parameters)
     render json: GrpcRest.send_request("Testdata::MyService", "test2", grpc_request, {})
   end
 
 	def test3
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
     GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test3"], "", request.parameters)
     render json: GrpcRest.send_request("Testdata::MyService", "test3", grpc_request, {})
   end
 
 	def test4
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
     GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test4"], "*", request.parameters)
     render json: GrpcRest.send_request("Testdata::MyService", "test4", grpc_request, {})
   end

data/spec/grpc_rest_spec.rb

@@ -10,15 +10,15 @@ class ServerImpl < Testdata::MyService::Service
     Testdata::TestResponse.new(some_int: 1, full_response: req.to_json)
   end
 
-  def test_2(req)
+  def test2(req)
     Testdata::TestResponse.new(some_int: 2, full_response: req.to_json)
   end
 
-  def test_3(req)
+  def test3(req)
     Testdata::TestResponse.new(some_int: 3, full_response: req.to_json)
   end
 
-  def test_4(req)
+  def test4(req)
     Testdata::TestResponse.new(some_int: 4, full_response: req.to_json)
   end
 end
@@ -44,6 +44,7 @@ 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
+      puts response.body
       expect(response).to be_successful
       expect(response.parsed_body).to eq({
                                            'someInt' => 2,
@@ -103,6 +104,20 @@ RSpec.describe MyServiceController, type: :request do
       }
     end
 
+    it 'should pass with incorrect field' do
+      params[:blarg] = 'himom'
+      post '/test4', params: params, as: :json
+      expect(response).to be_successful
+    end
+
+    it 'should fail in strict mode' do
+      GrpcRest.strict_mode = true
+      params[:blarg] = 'himom'
+      post '/test4', params: params, as: :json
+      expect(response).not_to be_successful
+      GrpcRest.strict_mode = false
+    end
+
     it 'should be successful' do
       post '/test4', params: params, as: :json
       expect(response).to be_successful
@@ -111,7 +126,7 @@ RSpec.describe MyServiceController, type: :request do
       expect(full_response).to eq(
         { 'testId' => 'abc',
           'foobar' => 'xyz',
-          "mapField" => {"foo"=>{"anotherId"=>"id6", "subId"=>"id5"}},
+          'mapField' => { 'foo' => { 'anotherId' => 'id6', 'subId' => 'id5' } },
           'repeatedString' => %w[W T F],
           'subRecord' => { 'subId' => 'id1', 'anotherId' => 'id2' },
           'secondRecord' => { 'subId' => 'id3', 'anotherId' => 'id4' },
@@ -141,7 +156,7 @@ RSpec.describe MyServiceController, type: :request do
       expect(full_response).to eq(
         { 'testId' => 'abc',
           'foobar' => 'xyz',
-          "mapField" => {"foo"=>{"anotherId"=>"id6", "subId"=>"id5"}},
+          'mapField' => { 'foo' => { 'anotherId' => 'id6', 'subId' => 'id5' } },
           'repeatedString' => %w[W T F],
           'subRecord' => { 'subId' => 'id1', 'anotherId' => 'id2' },
           'secondRecord' => { 'subId' => 'id3', 'anotherId' => 'id4' },

data/spec/gruf_spec.rb

@@ -11,15 +11,15 @@ class GrufServerImpl < Gruf::Controllers::Base
     Testdata::TestResponse.new(some_int: 1, full_response: request.message.to_json)
   end
 
-  def test_2
+  def test2
     Testdata::TestResponse.new(some_int: 2, full_response: request.message.to_json)
   end
 
-  def test_3
+  def test3
     Testdata::TestResponse.new(some_int: 3, full_response: request.message.to_json)
   end
 
-  def test_4
+  def test4
     Testdata::TestResponse.new(some_int: 4, full_response: request.message.to_json)
   end
 

data/spec/testdata/base/app/controllers/my_service_controller.rb

@@ -1,65 +1,58 @@
-# frozen_string_literal: true
-
 ####### THIS FILE IS AUTOMATICALLY GENERATED BY protoc-gen-rails. DO NOT MODIFY. #######
 
 require 'grpc_rest'
 class MyServiceController < ActionController::Base
   protect_from_forgery with: :null_session
 
-  rescue_from StandardError do |e|
-    render json: GrpcRest.error_msg(e), status: :internal_server_error
-  end
+	rescue_from StandardError do |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: GrpcRest.grpc_http_status(e.code)
+		render json: GrpcRest.error_msg(e), status: GrpcRest.grpc_http_status(e.code)
   end
   rescue_from ActionDispatch::Http::Parameters::ParseError, Google::Protobuf::TypeError do |e|
     render json: GrpcRest.error_msg(e), status: :bad_request
   end
-
-  METHOD_PARAM_MAP = {
-
-    'test' => [
-      { name: 'foobar', val: 'blah/*', split_name: ['foobar'] }
-    ],
-
-    'test_2' => [],
-
-    'test_3' => [
-      { name: 'sub_record.sub_id', val: nil, split_name: %w[sub_record sub_id] }
-    ],
-
-    'test_4' => []
-  }.freeze
-
-  def test
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
-    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP['test'], '', request.parameters)
-    render json: GrpcRest.send_request('Testdata::MyService', 'test', grpc_request, { emit_defaults: true })
+  METHOD_PARAM_MAP = {"test"=>[{:name=>"foobar", :val=>"blah/*", :split_name=>["foobar"]}],
+ "test2"=>[],
+ "test3"=>
+  [{:name=>"sub_record.sub_id",
+    :val=>"",
+    :split_name=>["sub_record", "sub_id"]}],
+ "test4"=>[]}
+.freeze
+
+
+	def test
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
+    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test"], "", request.parameters)
+    render json: GrpcRest.send_request("Testdata::MyService", "test", grpc_request, {:emit_defaults=>true})
   end
 
-  def test_2
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
-    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP['test_2'], 'second_record', request.parameters)
-    render json: GrpcRest.send_request('Testdata::MyService', 'test_2', grpc_request, {})
+	def test2
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
+    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test2"], "second_record", request.parameters)
+    render json: GrpcRest.send_request("Testdata::MyService", "test2", grpc_request, {})
   end
 
-  def test_3
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
-    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP['test_3'], '', request.parameters)
-    render json: GrpcRest.send_request('Testdata::MyService', 'test_3', grpc_request, {})
+	def test3
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
+    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test3"], "", request.parameters)
+    render json: GrpcRest.send_request("Testdata::MyService", "test3", grpc_request, {})
   end
 
-  def test_4
-    fields = Testdata::TestRequest.descriptor.to_a.map(&:name)
-    parameters = request.parameters.to_h.deep_transform_keys(&:underscore)
-    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters.slice(*fields))
-    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP['test_4'], '*', request.parameters)
-    render json: GrpcRest.send_request('Testdata::MyService', 'test_4', grpc_request, {})
+	def test4
+    parameters = request.parameters.to_h.deep_transform_keys(&:underscore).
+      except(*%w(controller action my_service))
+    grpc_request = GrpcRest.init_request(Testdata::TestRequest, parameters)
+    GrpcRest.assign_params(grpc_request, METHOD_PARAM_MAP["test4"], "*", request.parameters)
+    render json: GrpcRest.send_request("Testdata::MyService", "test4", grpc_request, {})
   end
+
 end

data/spec/testdata/base/config/routes/grpc.rb

@@ -2,7 +2,9 @@
 
 ####### THIS FILE IS AUTOMATICALLY GENERATED BY protoc-gen-rails. DO NOT MODIFY. #######
 
-get '/test/*foobar' => 'my_service#test'
-post '/test2' => 'my_service#test_2'
-post '/test3/*sub_id' => 'my_service#test_3'
-post '/test4' => 'my_service#test_4'
+
+get '/test/*foobar' => 'my_service#test' 
+post '/test2' => 'my_service#test2' 
+post '/test3/*sub_id' => 'my_service#test3' 
+post '/test4' => 'my_service#test4' 
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc-rest
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf