grpc-rest 0.1.24 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4e105820176e2fb387f9ff63ae82a086de8d1b291d372f8e8ba3d38dfc34859
-  data.tar.gz: 1e480bc608d0524821ba06d408681830294ab34c9e36bd330b881f48128f8e33
+  metadata.gz: 57ad95cccdb8e4034e4635b2f373dd3db5e31ff4e4a5bddfbd6d977f9b93bf29
+  data.tar.gz: '09b6320949f7894835e1596721ea0f38df5543998b19a7598172be1f1b79d188'
 SHA512:
-  metadata.gz: c8118e6cbb88e44bc3577e66c4639f3e5b87ff18515f1c27d9dd5d458caacac52030f39afbd4a108b2009115b7e28ce9c9c7a810419517f700894538febfe3de
-  data.tar.gz: e591ab5d4d0481048f4e61814d1552d83c782f91191fd4f3f1aa430bacfc257aaac2ff3225152767b5acb7e13f1dcc75c42cb86ae93919d6b3cfc483b7bea53d
+  metadata.gz: 605c7f2ea415104673b4693acaf5a1d90079172affb814bc4684ddbaa9698c2558abaaff19355b80e2cbced8715e7367b58541b4e49bf341d436b540b7a3d5ec
+  data.tar.gz: e4ff129327451f1101a8a3dec623a4a80b4e8eec3882f6d9ab0f52ed450c4a403226178391633001c4f3f6a3dbecc8130ae7afd55adc9e74102dfd878645305a

data/.github/workflows/CI.yml

@@ -8,23 +8,6 @@ on:
   workflow_dispatch:
 
 jobs:
-  test-go:
-    runs-on: [ubuntu-latest]
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Setup Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: '1.21'
-    - name: Install Protoc
-      uses: arduino/setup-protoc@v2
-    - run: git reset --hard
-    - run: git clean -f -d
-    - run: cd protoc-gen-rails && go test ./...
-
   test-ruby:
     runs-on: [ubuntu-latest]
     steps:
@@ -37,28 +20,6 @@ jobs:
       with:
         ruby-version: '3.3'
         bundler-cache: true
+    - name: Install Protoc
+      uses: arduino/setup-protoc@v2
     - run: bundle exec rspec
-
-  build_and_deploy:
-    needs: [test-go, test-ruby]
-    runs-on: [ubuntu-latest]
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Setup Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: '1.21'
-    - run: git reset --hard
-    - run: git clean -f -d
-    - name: Run GoReleaser
-      uses: goreleaser/goreleaser-action@v3
-      with:
-        distribution: goreleaser
-        version: latest
-        workdir: ./protoc-gen-rails
-        args: release --clean
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  Exclude:
+    - "**/*_pb.rb"

data/CHANGELOG

@@ -7,8 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+- Rewrite protobuf plugin in Ruby.
+
+# 0.1.25 - 2025-04-30
+- Fix for crash when parsing map fields
+
 # 0.1.24 - 2024-12-09
-- Log error backtraces. 
+- Log error backtraces.
 
 # 0.1.23 - 2024-11-25
 - Fix: Return a 400 status code when payload is invalid JSON

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    grpc-rest (0.1.22)
+    grpc-rest (0.2.0)
+      google-protobuf (>= 4.30.2)
       grpc
       rails (>= 6.0)
 
@@ -73,7 +74,10 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    awesome_print (1.9.2)
+    bigdecimal (3.1.9)
     builder (3.2.4)
+    byebug (12.0.0)
     concurrent-ruby (1.2.3)
     crass (1.0.6)
     date (3.3.4)
@@ -81,15 +85,13 @@ GEM
     erubi (1.12.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    google-protobuf (3.25.3-arm64-darwin)
-    google-protobuf (3.25.3-x86_64-linux)
-    googleapis-common-protos-types (1.14.0)
-      google-protobuf (~> 3.18)
-    grpc (1.62.0-arm64-darwin)
-      google-protobuf (~> 3.25)
-      googleapis-common-protos-types (~> 1.0)
-    grpc (1.62.0-x86_64-linux)
-      google-protobuf (~> 3.25)
+    google-protobuf (4.30.2-arm64-darwin)
+      bigdecimal
+      rake (>= 13)
+    googleapis-common-protos-types (1.19.0)
+      google-protobuf (>= 3.18, < 5.a)
+    grpc (1.71.0-arm64-darwin)
+      google-protobuf (>= 3.25, < 5.0)
       googleapis-common-protos-types (~> 1.0)
     grpc-tools (1.64.0)
     gruf (2.20.0)
@@ -162,6 +164,10 @@ GEM
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.0)
@@ -178,6 +184,9 @@ GEM
       rspec-expectations (~> 3.13)
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
+    rspec-snapshot (2.0.3)
+      awesome_print (> 1.0.0)
+      rspec (> 3.0.0)
     rspec-support (3.13.1)
     slop (4.10.1)
     thor (1.3.1)
@@ -194,9 +203,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug
   grpc-rest!
   gruf
   rspec-rails
+  rspec-snapshot
 
 BUNDLED WITH
    2.5.6

data/README.md

@@ -23,15 +23,15 @@ The protobuf generator uses the same annotations as [grpc-gateway](https://githu
 
 ## Installation
 
-First, download `protoc-gen-rails` from the releases page on the right and unzip it. Ensure the binary is somewhere in your PATH.
-
-Then, add the following to your `Gemfile`:
+Add the following to your `Gemfile`:
 
 ```ruby
 gem 'grpc-rest'
 ```
 
-and run `bundle install`.
+and run `bundle install`. Then when using `protoc` or `buf generate`, ensure you prefix the command with `bundle exec`, e.g.
+
+`bundle exec buf generate`
 
 ## Example
 
@@ -78,6 +78,9 @@ plugins:
       - paths=source_relative
   - name: rails
     out: .
+    opt:
+      # this should be the same directory as the output of your Ruby plugin
+      - require=app/gen 
 ```
 
 Then, you can run `buf generate` to generate the Ruby files. This will generate:
@@ -172,10 +175,6 @@ module Interceptors
 end
 ```
 
-## To Do
-
-* Replace Go implementation with Ruby (+ executable)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/grpc-rest.

data/bin/protoc-gen-rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/generator'
+
+$stdout << ProtocGenRails.process($stdin.read)

data/grpc-rest.gemspec

@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency('google-protobuf', '>= 4.30.2')
   spec.add_runtime_dependency('grpc')
   spec.add_runtime_dependency('rails', '>= 6.0')
 
-  spec.add_development_dependency('rspec-rails')
+  spec.add_development_dependency('byebug')
   spec.add_development_dependency('gruf')
+  spec.add_development_dependency('rspec-rails')
+  spec.add_development_dependency('rspec-snapshot')
 end

data/lib/generator/controller.rb.erb

@@ -0,0 +1,27 @@
+####### THIS FILE IS AUTOMATICALLY GENERATED BY protoc-gen-rails. DO NOT MODIFY. #######
+
+require 'grpc_rest'
+class <%= service.name.demodulize %>Controller < 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 GRPC::BadStatus do |e|
+		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 = <%= service.methods.to_h { |m| [m.name.underscore, m.path_info.map(&:to_h)]}.pretty_inspect %>.freeze
+
+<% 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))
+    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
+<% end %>
+end

data/lib/generator/grpc.rb.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+####### THIS FILE IS AUTOMATICALLY GENERATED BY protoc-gen-rails. DO NOT MODIFY. #######
+
+<% services.each do |service| -%>
+<% service.methods.each do |method| %>
+<%= method.http_method %> '<%= method.sanitized_path %>' => '<%= service.name.demodulize.underscore %>#<%= method.name.underscore %>' <% -%>
+<% end %>
+<% end %>

data/lib/generator/method.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ProtocGenRails
+  class Method
+    PathInfo = Struct.new(:name, :val, :split_name)
+
+    attr_accessor :http_method, :path, :path_info, :rest_options
+
+    # @param proto_method [Google::Protobuf::MethodDescriptor]
+    def initialize(proto_method)
+      @method = proto_method
+      @rest_options = extract_rest_options
+      @options = extract_options
+      @http_method, @path = method_and_path
+      @path_info = extract_path_info
+    end
+
+    # @return [String]
+    def option_body = @options&.body
+    # @return [String]
+    def name = @method.name.underscore
+
+    # @return [String]
+    def request_type
+      @method.input_type.name.split('.').map(&:camelcase).join('::')
+    end
+
+    # @return [String]
+    def sanitized_path
+      path = @path
+      re = /\{(.*?)}/
+      matches = path.scan(re)
+      matches.each do |match|
+        repl = match[0]
+        equal = repl.index('=')
+        repl = repl[0...equal] if equal
+        dot = repl.index('.')
+        repl = repl[(dot + 1)..] if dot
+        path = path.sub("{#{match[0]}}", "*#{repl}")
+      end
+      path
+    end
+
+    # @return [Google::Api::HttpRule]
+    def extract_options
+      return nil if @method.options.nil?
+
+      extension = Google::Protobuf::DescriptorPool.generated_pool.lookup('google.api.http')
+      extension.get(@method.options)
+    end
+
+    # @return [Hash]
+    def extract_rest_options
+      return nil if @method.options.nil?
+
+      extension = Google::Protobuf::DescriptorPool.generated_pool
+                                                  .lookup('grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation')
+      result = extension.get(@method.options)
+      return {} if result.nil?
+
+      emit_defaults = result.extensions['x-grpc-rest-emit-defaults']&.bool_value || false
+      {
+        emit_defaults: emit_defaults
+      }
+    end
+
+    # @return [String, String]
+    def method_and_path
+      return if @options.nil?
+
+      if @options.pattern == :custom
+        [@options.custom.kind, @options.custom.path]
+      else
+        [@options.pattern, @options.send(@options.pattern)]
+      end
+    end
+
+    # @return [PathInfo]
+    def extract_path_info
+      @path.scan(/\{(.*?)}/).map do |match|
+        name = match[0]
+        val = ''
+        equal = name.index('=')
+        if equal
+          val = name[equal..]
+          name = name[0..equal - 1]
+        end
+        PathInfo.new(
+          name: name,
+          val: val,
+          split_name: name.split('.')
+        )
+      end
+    end
+  end
+end

data/lib/generator/output.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ProtocGenRails
+  module Output
+    class << self
+      # @param files [Array<FileResult>]
+      # @return [String]
+      def response(files)
+        response = Google::Protobuf::Compiler::CodeGeneratorResponse.new
+        response.supported_features = Google::Protobuf::Compiler::CodeGeneratorResponse::Feature::FEATURE_PROTO3_OPTIONAL
+        files.each do |file|
+          response.file << Google::Protobuf::Compiler::CodeGeneratorResponse::File.new(name: file.name,
+                                                                                       content: file.content)
+        end
+        response.to_proto
+      end
+
+      # @param error [String]
+      def exit_with_error(error)
+        response = Google::Protobuf::Compiler::CodeGeneratorResponse.new
+        response.error = error
+        $stderr << "#{error}\n"
+        $stdout << response.to_proto
+        exit(1)
+      end
+    end
+  end
+end

data/lib/generator/plugin_pb.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/protobuf/compiler/plugin.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/descriptor_pb'
+
+descriptor_data = "\n%google/protobuf/compiler/plugin.proto\x12\x18google.protobuf.compiler\x1a google/protobuf/descriptor.proto\"F\n\x07Version\x12\r\n\x05major\x18\x01 \x01(\x05\x12\r\n\x05minor\x18\x02 \x01(\x05\x12\r\n\x05patch\x18\x03 \x01(\x05\x12\x0e\n\x06suffix\x18\x04 \x01(\t\"\x81\x02\n\x14\x43odeGeneratorRequest\x12\x18\n\x10\x66ile_to_generate\x18\x01 \x03(\t\x12\x11\n\tparameter\x18\x02 \x01(\t\x12\x38\n\nproto_file\x18\x0f \x03(\x0b\x32$.google.protobuf.FileDescriptorProto\x12\x45\n\x17source_file_descriptors\x18\x11 \x03(\x0b\x32$.google.protobuf.FileDescriptorProto\x12;\n\x10\x63ompiler_version\x18\x03 \x01(\x0b\x32!.google.protobuf.compiler.Version\"\x92\x03\n\x15\x43odeGeneratorResponse\x12\r\n\x05\x65rror\x18\x01 \x01(\t\x12\x1a\n\x12supported_features\x18\x02 \x01(\x04\x12\x17\n\x0fminimum_edition\x18\x03 \x01(\x05\x12\x17\n\x0fmaximum_edition\x18\x04 \x01(\x05\x12\x42\n\x04\x66ile\x18\x0f \x03(\x0b\x32\x34.google.protobuf.compiler.CodeGeneratorResponse.File\x1a\x7f\n\x04\x46ile\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x17\n\x0finsertion_point\x18\x02 \x01(\t\x12\x0f\n\x07\x63ontent\x18\x0f \x01(\t\x12?\n\x13generated_code_info\x18\x10 \x01(\x0b\x32\".google.protobuf.GeneratedCodeInfo\"W\n\x07\x46\x65\x61ture\x12\x10\n\x0c\x46\x45\x41TURE_NONE\x10\x00\x12\x1b\n\x17\x46\x45\x41TURE_PROTO3_OPTIONAL\x10\x01\x12\x1d\n\x19\x46\x45\x41TURE_SUPPORTS_EDITIONS\x10\x02\x42r\n\x1c\x63om.google.protobuf.compilerB\x0cPluginProtosZ)google.golang.org/protobuf/types/pluginpb\xaa\x02\x18Google.Protobuf.Compiler"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Google
+  module Protobuf
+    module Compiler
+      Version = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('google.protobuf.compiler.Version').msgclass
+      CodeGeneratorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('google.protobuf.compiler.CodeGeneratorRequest').msgclass
+      CodeGeneratorResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('google.protobuf.compiler.CodeGeneratorResponse').msgclass
+      CodeGeneratorResponse::File = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('google.protobuf.compiler.CodeGeneratorResponse.File').msgclass
+      CodeGeneratorResponse::Feature = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('google.protobuf.compiler.CodeGeneratorResponse.Feature').enummodule
+    end
+  end
+end

data/lib/generator/service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'method'
+
+module ProtocGenRails
+  class Service
+    attr_accessor :methods
+
+    # @param service_proto [Google::Protobuf::ServiceDescriptorProto]
+    # @param package [String]
+    def initialize(service_proto, package)
+      # see https://github.com/protocolbuffers/protobuf/issues/21091 for why this is needed
+      # this will return a Google::Protobuf::ServiceDescriptor
+      @service = Google::Protobuf::DescriptorPool.generated_pool.lookup("#{package}.#{service_proto.name}")
+      if @service.nil?
+        ProtocGenRails::Output.exit_with_error("Could not find generated service: #{package}.#{service_proto.name}")
+      end
+      @methods = []
+      @package = package
+      @service.each do |m|
+        # m is a Google::Protobuf::MethodDescriptor
+        @methods.push(ProtocGenRails::Method.new(m))
+      end
+    end
+
+    # @return [String]
+    def name
+      @service.name.split('.').map(&:camelcase).join('::').demodulize
+    end
+
+    # @return [String]
+    def namespace
+      @package.split('.').map(&:camelcase).join('::')
+    end
+  end
+end

data/lib/generator.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'google/protobuf'
+require 'erb'
+require 'active_support/all'
+require 'google/protobuf/well_known_types'
+require 'pp'
+
+require_relative 'generator/output'
+require_relative 'generator/service'
+require_relative 'generator/plugin_pb'
+
+module ProtocGenRails
+  FileResult = Struct.new(:name, :content)
+
+  class << self
+
+    # @param params [String]
+    def require_directories(params)
+      params.split(',').each do |param|
+        key, value = param.split('=')
+        next unless key == 'require'
+
+        dirs = value.split(',')
+        dirs.each do |v|
+          $LOAD_PATH.unshift(v)
+          dir = File.expand_path(v)
+          Dir["#{dir}/**/*.rb"].each { |file| require file }
+        end
+      end
+    end
+
+    # @param input [String]
+    # @return [String]
+    def process(input)
+      request = Google::Protobuf::Compiler::CodeGeneratorRequest.decode(input)
+      files = []
+
+      require_directories(request.parameter)
+
+      services = []
+      request.proto_file.each do |proto_file|
+        next if request.file_to_generate.exclude?(proto_file.name)
+        next if proto_file.service.none?
+
+        proto_file.service.each do |service_descriptor|
+          service = ProtocGenRails::Service.new(service_descriptor, proto_file.package)
+          services.push(service)
+          file = process_service(service)
+          files.push(file) if file
+        end
+      end
+      if files.any?
+        route_output = route_file(services)
+        files.push(route_output) if route_output
+      end
+      Output.response(files)
+    end
+
+    # @param service [ProtocGenRails::Service]
+    # @return [FileResult]
+    def process_service(service)
+      content = parse_erb('controller', { service: service })
+      FileResult.new(
+        content: content,
+        name: "app/controllers/#{service.name.underscore}_controller.rb"
+      )
+    end
+
+    # @param services [Array<ProtocGenRails::Service>]
+    # @return [FileResult]
+    def route_file(services)
+      content = parse_erb('grpc', { services: services })
+      FileResult.new(
+        name: 'config/routes/grpc.rb',
+        content: content
+      )
+    end
+
+    # @param filename [String]
+    # @param data [Object]
+    # @return [String]
+    def parse_erb(filename, data)
+      erb = File.read("#{__dir__}/generator/#{filename}.rb.erb")
+      ERB.new(erb, trim_mode: '-').result_with_hash(data.to_h)
+    end
+  end
+end

data/lib/grpc_rest/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrpcRest
-  VERSION = '0.1.24'
+  VERSION = '0.2.0'
 end