gruf 2.8.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9118663c1224b49c07fe40743b6766121b1be507301e4ca64f2f3e7ef18a5b25
-  data.tar.gz: 2025ab3f6f93b8c13bdb983e869a003415d3933340e94f15eb866d65826f954b
+  metadata.gz: d00ffbd4089fa41fd29adb1848564ee695725576045f447255173ebb170df586
+  data.tar.gz: 55c8ca35a37cae3e5c03bec59c1073fe40e3ed919586cb33bdfd83dad7da2b54
 SHA512:
-  metadata.gz: ffd6e423548aeb8785e7063618875298b9f13570e8e1fc6b5cf24d2426059d4e98c9d3414f179a4fd071d6b4263f279666c38ca2439dfa0e7937cc2dfa79af84
-  data.tar.gz: 5ee7fbe4964edbda7b90192ff5432a3d61897d08896a84676ae19d5c105aab6287c48f6c02368a10c0e75d9eaa1e784f8748564cc86dc2c7bf0762106b27b4fe
+  metadata.gz: 44acc6b979feb388fc7fee273848d36b8bb4db4228d7fab6b678ab2ed69b90742e927705c1982643f23a4170be8e8918a1cab96beb146071f191871f39c54bcc
+  data.tar.gz: cf79b333165e7eb458a44c9f09b8069135ff7c2fa7041193abbdd0af7fcf5ff20dd2e45ffeec94d036aa7822f2c8fffd3f3c969a2d41fcf3fbd17f1181c8ebe4

data/CHANGELOG.md

@@ -2,6 +2,41 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.11.0
+
+- Restrict grpc gem to <= 1.41.0 due to regressions in grpc 1.42.x 
+- Fallback to stdout logger at INFO if no logger is setup
+- Better handling of namespace collisions with Rails
+- Add `GRPC_SERVER_HOST` and `GRPC_SERVER_PORT` for ENV configuration of the server host+port
+- Add `GRPC_BACKTRACE_ON_ERROR` as available ENV configuration
+- Add default ENV-based configuration of the GRPC server pool
+  - `GRPC_SERVER_POOL_SIZE` - sets the size of the GRPC server pool
+  - `GRPC_SERVER_POOL_KEEP_ALIVE` - keep alive time for threads spawned by the server pool
+  - `GRPC_SERVER_POLL_PERIOD` - period in seconds to poll for workers in the gRPC server pool
+- Improve Yardoc support across the library
+- Added attribute-based documentation for Gruf configuration options
+- Add mfa required for gemspec metadata
+
+### 2.10.0
+
+- Drop support for Ruby 2.4/2.5 to align with Ruby EOL schedule, supporting 2.6+ only
+- Allow for float/TimeSpec timeout values on clients
+
+### 2.9.1
+
+- Allow for float/TimeSpec timeout values on clients (backport from 2.10.0)
+
+### 2.9.0
+
+- Change to racially neutral terminology across library
+  - blacklist->blocklist
+  - master->main branch
+- Explicitly declare development dependencies in gemspec
+- Add script/e2e test for full e2e test in regression suite
+- Explicitly declare [json gem](https://rubygems.org/gems/json) dependency
+- Update to Rubocop 1.4, add in rubocop-rspec for spec tests
+- Add Ruby 2.7, 3.0 support
+
 ### 2.8.1
 
 - Fix issue with --suppress-default-interceptors not working [#95]
@@ -145,11 +180,11 @@ Gruf 2.0 is a major shift from Gruf 1.0. See [UPGRADING.md](UPGRADING.md) for de
 ### 1.2.4
 
 - Loosen explicit Protobuf dependency now that 3.4.0.2 is released
-- Guard against nil params in logger blacklist
+- Guard against nil params in logger blocklist
 
 ### 1.2.3
 
-- Support nested blacklist parameters in path.to.key format
+- Support nested blocklist parameters in path.to.key format
 
 ### 1.2.2
 
@@ -171,7 +206,7 @@ Gruf 2.0 is a major shift from Gruf 1.0. See [UPGRADING.md](UPGRADING.md) for de
 - Add configuration to set the error message when an uncaught exception is
   handled by gruf.
 - Add a request logging hook for Rails-style request logging, with optional
-  parameter logging, blacklists, and formatter support
+  parameter logging, blocklists, and formatter support
 - Optimizations around Symbol casting within service calls
 
 ### 1.1.0

data/README.md

@@ -1,6 +1,6 @@
 # gruf - gRPC Ruby Framework
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/master) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=master)](https://inch-ci.org/github/bigcommerce/gruf?branch=master)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=main)](https://inch-ci.org/github/bigcommerce/gruf?branch=main)
 
 gruf is a Ruby framework that wraps the [gRPC Ruby library](https://github.com/grpc/grpc/tree/master/src/ruby) to
 provide a more streamlined integration into Ruby and Ruby on Rails applications.
@@ -17,7 +17,7 @@ up fast and efficiently at scale. Some of its features include:
   still preserving gRPC BadStatus codes
 * Server and client execution timings in responses
 
-gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-2.6.
+gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-3.0.
 gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any Ruby framework
 (such as [Grape](https://github.com/ruby-grape/grape) or [dry-rb](https://dry-rb.org/), for instance).
 

data/gruf.gemspec

@@ -15,7 +15,7 @@
 # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'gruf/version'
 
 Gem::Specification.new do |spec|
@@ -30,19 +30,38 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/bigcommerce/gruf'
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf.gemspec']
-  spec.executables   << 'gruf'
+  spec.executables << 'gruf'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.4'
+  spec.required_ruby_version = '>= 2.6', '< 3.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_development_dependency 'bundler-audit', '>= 0.6'
+  # rubocop:disable Gemspec/RubyVersionGlobalsUsage
+  spec.add_development_dependency(
+    'factory_bot',
+    (Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5') ? '>= 6.1' : '~> 5.2')
+  )
+  # rubocop:enable Gemspec/RubyVersionGlobalsUsage
+  spec.add_development_dependency 'ffaker', '>= 2.15'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '>= 3.9'
   spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rspec', '>= 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
+  spec.add_development_dependency 'rubocop', '>= 1.0'
+  spec.add_development_dependency 'rubocop-performance', '>= 0.0.1'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.0'
+  spec.add_development_dependency 'rubocop-thread_safety', '>= 0.3'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
 
-  spec.add_runtime_dependency 'grpc', '~> 1.10'
-  spec.add_runtime_dependency 'grpc-tools', '~> 1.10'
   spec.add_runtime_dependency 'activesupport', '> 4'
-
   spec.add_runtime_dependency 'concurrent-ruby', '> 1'
-  spec.add_runtime_dependency 'slop', '~> 4.6'
+  spec.add_runtime_dependency 'e2mmap', '>= 0.1'
+  spec.add_runtime_dependency 'grpc', '~> 1.10', '<= 1.41.0'
+  spec.add_runtime_dependency 'grpc-tools', '~> 1.10', '<= 1.41.0'
+  spec.add_runtime_dependency 'json', '>= 2.3'
+  spec.add_runtime_dependency 'slop', '>= 4.6'
+  spec.add_runtime_dependency 'thwait', '>= 0.1'
 end

data/lib/gruf/cli/executor.rb

@@ -38,7 +38,7 @@ module Gruf
         @services = services || Gruf.services
         @hook_executor = hook_executor || Gruf::Hooks::Executor.new(hooks: Gruf.hooks&.prepare)
         @server = server || Gruf::Server.new(Gruf.server_options)
-        @logger = logger || Gruf.logger || ::Logger.new(STDERR)
+        @logger = logger || Gruf.logger || ::Logger.new($stderr)
       end
 
       ##

data/lib/gruf/client/error.rb

@@ -23,7 +23,8 @@ module Gruf
     # GRPC::BadStatus error
     #
     class Error < StandardError
-      # @return [Object] error The deserialized error
+      # @!attribute [r] error
+      #   @return [Object] error The deserialized error
       attr_reader :error
 
       ##
@@ -33,6 +34,7 @@ module Gruf
       #
       def initialize(error)
         @error = error
+        super
       end
     end
 
@@ -57,6 +59,7 @@ module Gruf
       class FailedPrecondition < Error; end
       class Internal < Error; end
       class PermissionDenied < Error; end
+      class ResourceExhausted < Error; end
       class Unauthenticated < Error; end
       class Unavailable < Error; end
       class Unimplemented < Error; end

data/lib/gruf/client.rb

@@ -38,11 +38,14 @@ module Gruf
   class Client < SimpleDelegator
     include Gruf::Loggable
 
-    # @return [Class] The base, friendly name of the service being requested
+    # @!attribute [r] base_klass
+    #   @return [Class] The base, friendly name of the service being requested
     attr_reader :base_klass
-    # @return [Class] The class name of the gRPC service being requested
+    # @!attribute [r] service_klass
+    #   @return [Class] The class name of the gRPC service being requested
     attr_reader :service_klass
-    # @return [Hash] A hash of options for the client
+    # @!attribute [r] opts
+    #   @return [Hash] A hash of options for the client
     attr_reader :opts
 
     ##
@@ -62,8 +65,8 @@ module Gruf
       @opts[:hostname] = @opts.fetch(:hostname, Gruf.default_client_host)
       @opts[:channel_credentials] = @opts.fetch(:channel_credentials, Gruf.default_channel_credentials)
       @error_factory = Gruf::Client::ErrorFactory.new
-      client_options[:timeout] = client_options[:timeout].to_i if client_options.key?(:timeout)
-      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, client_options)
+      client_options[:timeout] = parse_timeout(client_options[:timeout]) if client_options.key?(:timeout)
+      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, **client_options)
       super(client)
     end
 
@@ -216,5 +219,27 @@ module Gruf
         Gruf::Serializers::Errors::Json
       end
     end
+
+    ##
+    # Handle various timeout values and prevent improper value setting
+    #
+    # @see GRPC::Core::TimeConsts#from_relative_time
+    # @param [mixed] timeout
+    # @return [Float]
+    # @return [GRPC::Core::TimeSpec]
+    #
+    def parse_timeout(timeout)
+      if timeout.nil?
+        GRPC::Core::TimeConsts::ZERO
+      elsif timeout.is_a?(GRPC::Core::TimeSpec)
+        timeout
+      elsif timeout.is_a?(Numeric) # rubocop:disable Lint/DuplicateBranch
+        timeout
+      elsif timeout.respond_to?(:to_f)
+        timeout.to_f
+      else
+        raise ArgumentError, 'timeout is not a valid value: does not respond to to_f'
+      end
+    end
   end
 end

data/lib/gruf/configuration.rb

@@ -20,6 +20,63 @@ module Gruf
   # Represents configuration settings for the system
   #
   module Configuration
+    # @!attribute root_path
+    #   @return [String] The root path for your application
+    # @!attribute server_binding_url
+    #   @return [String] The full hostname:port that the gRPC server should bind to
+    # @!attribute server_options
+    #   @return [Hash] A hash of options to pass to the server instance
+    # @!attribute interceptors
+    #   @return [::Gruf::Interceptors::Registry] A registry of Gruf server interceptors
+    # @!attribute hooks
+    #   @return [::Gruf::Hooks::Registry] A registry of Gruf hooks for the server
+    # @!attribute default_channel_credentials
+    #   @return [NilClass]
+    #   @return [Symbol]
+    #   @return [Hash]
+    # @!attribute default_client_host
+    #   @return [String] The default host for all new Gruf::Client objects to use as their target host
+    # @!attribute use_ssl
+    #   @return [Boolean] If true, will setup the server to use TLS
+    # @!attribute ssl_crt_file
+    #   @return [String] If use_ssl is true, the relative path from the root_path to the CRT file for the server
+    # @!attribute ssl_key_file
+    #   @return [String] If use_ssl is true, the relative path from the root_path to the key file for the server
+    # @!attribute controllers_path
+    #   @return [String] The relative path from root_path to locate Gruf Controllers in
+    # @!attribute services
+    #   @return [Array<Class>] An array of services to serve with this Gruf server
+    # @!attribute logger
+    #   @return [Logger] The logger class for Gruf-based logging
+    # @!attribute grpc_logger
+    #   @return [Logger] The logger to use with GRPC's core logger (which logs plaintext). It is recommended to set
+    #      this to an STDOUT logger and use a logging pipeline that can translate plaintext logs given GRPC's
+    #      unformatted logging.
+    # @!attribute error_metadata_key
+    #   @return [Symbol] The metadata key to use for error messages sent back in trailing metadata.
+    # @!attribute error_serializer
+    #   @return [NilClass|::Gruf::Serializers::Errors::Base] The error serializer to use for error messages sent
+    #      back in trailing metadata. Defaults to the base JSON serializer.
+    # @!attribute append_server_errors_to_trailing_metadata
+    #   @return [Boolean] If true, will append all server error information into the trailing metadata in the response
+    #      from the server
+    # @!attribute use_default_interceptors
+    #   @return [Boolean] If true, will use the default ActiveRecord and Timer interceptors for servers
+    # @!attribute backtrace_on_error
+    #   @return [Boolean] If true, will return the backtrace on any errors in servers in the trailing metadata
+    # @!attribute backtrace_limit
+    #   @return [Integer] The limit of lines to use in backtraces returned
+    # @!attribute use_exception_message
+    #   @return [String] If true, will pass the actual exception message from the error in a server
+    # @!attribute internal_error_message
+    #   @return [String] If use_exception_message is false, this message will be used instead as a replacement
+    # @!attribute event_listener_proc
+    #   @return [NilClass]
+    #   @return [Proc] If set, this will be used during GRPC events (such as pool exhaustions)
+    # @!attribute synchronized_client_internal_cache_expiry
+    #   @return [Integer] Internal cache expiry period (in seconds) for the SynchronizedClient
+    # @!attribute rpc_server_options
+    #   @return [Hash] A hash of RPC options for GRPC server configuration
     VALID_CONFIG_KEYS = {
       root_path: '',
       server_binding_url: '0.0.0.0:9001',
@@ -61,8 +118,8 @@ module Gruf
     # Whenever this is extended into a class, setup the defaults
     #
     def self.extended(base)
-      if defined?(Rails)
-        Gruf::Integrations::Rails::Railtie.config.before_initialize { base.reset }
+      if defined?(::Rails)
+        ::Gruf::Integrations::Rails::Railtie.config.before_initialize { base.reset }
       else
         base.reset
       end
@@ -98,24 +155,30 @@ module Gruf
     #
     def reset
       VALID_CONFIG_KEYS.each do |k, v|
-        send((k.to_s + '='), v)
+        send("#{k}=", v)
       end
-      self.interceptors = Gruf::Interceptors::Registry.new
-      self.hooks = Gruf::Hooks::Registry.new
-      self.root_path = Rails.root.to_s.chomp('/') if defined?(Rails)
-      if defined?(Rails) && Rails.logger
-        self.logger = Rails.logger
-      else
-        require 'logger'
-        self.logger = ::Logger.new(STDOUT)
-      end
-      self.grpc_logger = logger if grpc_logger.nil?
+      self.server_binding_url = "#{::ENV.fetch('GRPC_SERVER_HOST',
+                                               '0.0.0.0')}:#{::ENV.fetch('GRPC_SERVER_PORT', 9_001)}"
+      self.interceptors = ::Gruf::Interceptors::Registry.new
+      self.hooks = ::Gruf::Hooks::Registry.new
+      self.root_path = ::Rails.root.to_s.chomp('/') if defined?(::Rails)
+      determine_loggers
       self.ssl_crt_file = "#{root_path}config/ssl/#{environment}.crt"
       self.ssl_key_file = "#{root_path}config/ssl/#{environment}.key"
       self.controllers_path = root_path.to_s.empty? ? 'app/rpc' : "#{root_path}/app/rpc"
+      self.backtrace_on_error = ::ENV.fetch('GRPC_BACKTRACE_ON_ERROR', 0).to_i.positive?
+      self.rpc_server_options = {
+        max_waiting_requests: ::ENV.fetch('GRPC_SERVER_MAX_WAITING_REQUESTS',
+                                          GRPC::RpcServer::DEFAULT_MAX_WAITING_REQUESTS).to_i,
+        pool_size: ::ENV.fetch('GRPC_SERVER_POOL_SIZE', GRPC::RpcServer::DEFAULT_POOL_SIZE).to_i,
+        pool_keep_alive: ::ENV.fetch('GRPC_SERVER_POOL_KEEP_ALIVE', GRPC::Pool::DEFAULT_KEEP_ALIVE),
+        poll_period: ::ENV.fetch('GRPC_SERVER_POLL_PERIOD', GRPC::RpcServer::DEFAULT_POLL_PERIOD),
+        connect_md_proc: nil,
+        server_args: {}
+      }
       if use_default_interceptors
-        interceptors.use(Gruf::Interceptors::ActiveRecord::ConnectionReset)
-        interceptors.use(Gruf::Interceptors::Instrumentation::OutputMetadataTimer)
+        interceptors.use(::Gruf::Interceptors::ActiveRecord::ConnectionReset)
+        interceptors.use(::Gruf::Interceptors::Instrumentation::OutputMetadataTimer)
       end
       options
     end
@@ -128,11 +191,30 @@ module Gruf
     # @return [String] The current Ruby environment
     #
     def environment
-      if defined?(Rails)
-        Rails.env.to_s
+      if defined?(::Rails)
+        ::Rails.env.to_s
       else
         (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development').to_s
       end
     end
+
+    ##
+    # Dynamically determine the appropriate logger
+    #
+    def determine_loggers
+      if defined?(::Rails) && ::Rails.logger
+        self.logger = ::Rails.logger
+      else
+        require 'logger'
+        self.logger = ::Logger.new($stdout)
+        log_level = ::ENV.fetch('LOG_LEVEL', 'info').to_s.upcase
+        begin
+          logger.level = ::Logger::Severity.const_get(log_level)
+        rescue NameError => _e
+          logger.level = ::Logger::Severity::INFO
+        end
+      end
+      self.grpc_logger = logger if grpc_logger.nil?
+    end
   end
 end

data/lib/gruf/controllers/base.rb

@@ -26,13 +26,16 @@ module Gruf
     class Base
       include Gruf::Errors::Helpers
 
-      # @var [Gruf::Controller::Request] request
+      # @!attribute [r] request
+      #   @return [Gruf::Controller::Request] The incoming request
       attr_reader :request
-      # @var [Gruf::Error] error
+      # @!attribute [r] error
+      #   @return [Gruf::Error] The current error on the controller
       attr_reader :error
 
       class << self
-        # @var [GRPC::GenericService] bound_service
+        # @!attribute [r] bound_service
+        #   @return [GRPC::GenericService] bound_service The bound gRPC service class
         attr_reader :bound_service
       end
 
@@ -65,7 +68,9 @@ module Gruf
       def self.bind(service)
         service_class = service.name.constantize
         Gruf.services << service_class
+        # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
         @bound_service = service_class
+        # rubocop:enable ThreadSafety/InstanceVariableInClassMethod
         ServiceBinder.new(service_class).bind!(self)
       end
 

data/lib/gruf/controllers/request.rb

@@ -21,15 +21,20 @@ module Gruf
     # Encapsulates a request for a controller
     #
     class Request
-      # @var [Object] message
+      # @!attribute [r] message
+      #   @return [Object] The protobuf message in the request
       attr_reader :message
-      # @var [GRPC::ActiveCall] active_call
+      # @!attribute [r] active_call
+      #   @return [GRPC::ActiveCall] The active call object used for this request
       attr_reader :active_call
-      # @var [Symbol] method_key
+      # @!attribute [r] method_key
+      #   @return [Symbol] The method name being requested
       attr_reader :method_key
-      # @var [Gruf::Controllers::Request::Type] type
+      # @!attribute [r] type
+      #   @return [Gruf::Controllers::Request::Type] The type of request
       attr_reader :type
-      # @var [Class] service
+      # @!attribute [r] service
+      #   @return [Class] The GRPC service class for this request
       attr_reader :service
 
       delegate :metadata, to: :active_call
@@ -58,7 +63,7 @@ module Gruf
       # @param [Class] service The class of the service being executed against
       # @param [GRPC::RpcDesc] rpc_desc The RPC descriptor of the call
       # @param [GRPC::ActiveCall] active_call The restricted view of the call
-      # @param [Object] message The protobuf message (or messages) of the request
+      # @param [Object|Google::Protobuf::MessageExts] message The protobuf message (or messages) of the request
       #
       def initialize(method_key:, service:, rpc_desc:, active_call:, message:)
         @method_key = method_key
@@ -76,7 +81,7 @@ module Gruf
       # @return [String] The mapped service key
       #
       def service_key
-        @service.name.underscore.tr('/', '.').gsub('.service', '')
+        @service.name.to_s.underscore.tr('/', '.').gsub('.service', '')
       end
 
       ##
@@ -99,21 +104,24 @@ module Gruf
       # @return [String] The parsed service method name
       #
       def method_name
-        "#{service_key}.#{method_key}"
+        "#{service_key}.#{@method_key}"
       end
 
       ##
       # Return all messages for this request, properly handling different request types
       #
-      # @return Enumerable<Object> All messages for this request
+      # @return [Enumerable<Object>] All messages for this request
+      # @return [Object] If a bidi streamed request, will return the message object
       #
       def messages
         if client_streamer?
-          message.call { |msg| yield msg }
+          # rubocop:disable Style/ExplicitBlockArgument
+          @message.call { |msg| yield msg }
+          # rubocop:enable Style/ExplicitBlockArgument
         elsif bidi_streamer?
-          message
+          @message
         else
-          [message]
+          [@message]
         end
       end
     end

data/lib/gruf/controllers/service_binder.rb

@@ -38,7 +38,7 @@ module Gruf
       ##
       # Bind all methods on the service to the passed controller
       #
-      # @param [Gruf::Controllers::Base] controller
+      # @param [Class<Gruf::Controllers::Base>] controller
       #
       def bind!(controller)
         rpc_methods.each { |name, desc| bind_method(controller, name, desc) }

data/lib/gruf/error.rb

@@ -59,20 +59,28 @@ module Gruf
     METADATA_SIZE_EXCEEDED_CODE = 'metadata_size_exceeded'
     METADATA_SIZE_EXCEEDED_MSG = 'Metadata too long, risks exceeding http2 trailing metadata limit.'
 
-    # @return [Symbol] The given internal gRPC code for the error
+    # @!attribute code
+    #   @return [Symbol] The given internal gRPC code for the error
     attr_accessor :code
-    # @return [Symbol] An arbitrary application code that can be used for logical processing of the error by the client
+    # @!attribute app_code
+    #   @return [Symbol] An arbitrary application code that can be used for logical processing of the error
+    #     by the client
     attr_accessor :app_code
-    # @return [String] The error message returned by the server
+    # @!attribute message
+    #   @return [String] The error message returned by the server
     attr_accessor :message
-    # @return [Array] An array of field errors that can be returned by the server
+    # @!attribute field_errors
+    #   @return [Array] An array of field errors that can be returned by the server
     attr_accessor :field_errors
-    # @return [Errors::DebugInfo] A object containing debugging information, such as a stack trace and exception name,
-    # that can be used to debug an given error response. This is sent by the server over the trailing metadata.
+    # @!attribute debug_info
+    #   @return [Errors::DebugInfo] A object containing debugging information, such as a stack trace and exception name,
+    #     that can be used to debug an given error response. This is sent by the server over the trailing metadata.
     attr_accessor :debug_info
-    # @return [GRPC::BadStatus] The gRPC BadStatus error object that was generated
+    # @!attribute [w] grpc_error
+    #   @return [GRPC::BadStatus] The gRPC BadStatus error object that was generated
     attr_writer :grpc_error
-    # @return [Hash] The trailing metadata that was attached to the error
+    # @!attribute [r] metadata
+    #   @return [Hash] The trailing metadata that was attached to the error
     attr_reader :metadata
 
     ##
@@ -126,7 +134,7 @@ module Gruf
     # @return [Hash] The newly set metadata
     #
     def metadata=(metadata)
-      @metadata = metadata.map { |k, str| [k, str.to_s] }.to_h
+      @metadata = metadata.transform_values(&:to_s)
     end
 
     ##

data/lib/gruf/errors/debug_info.rb

@@ -21,9 +21,11 @@ module Gruf
     # Represents debugging information for an exception that occurred in a gRPC service
     #
     class DebugInfo
-      # @return [String] The detail message of the exception
+      # @!attribute [r] detail
+      #   @return [String] The detail message of the exception
       attr_reader :detail
-      # @return [Array<String>] The stack trace generated by the exception as an array of strings
+      # @!attribute [r] stack_trace
+      #   @return [Array<String>] The stack trace generated by the exception as an array of strings
       attr_reader :stack_trace
 
       ##

data/lib/gruf/errors/field.rb

@@ -21,11 +21,14 @@ module Gruf
     # Represents a field-specific error
     #
     class Field
-      # @return [Symbol] The name of the field as a Symbol
+      # @!attribute [r] field_name
+      #   @return [Symbol] The name of the field as a Symbol
       attr_reader :field_name
-      # @return [Symbol] The application error code for the field, e.g. :job_not_found
+      # @!attribute [r] error_code
+      #   @return [Symbol] The application error code for the field, e.g. :job_not_found
       attr_reader :error_code
-      # @return [String] The error message for the field, e.g. "Job with ID 123 not found"
+      # @!attribute [r] message
+      #   @return [String] The error message for the field, e.g. "Job with ID 123 not found"
       attr_reader :message
 
       ##

data/lib/gruf/hooks/executor.rb

@@ -39,7 +39,7 @@ module Gruf
         @hooks.each do |hook|
           next unless hook.respond_to?(name)
 
-          hook.send(name, arguments)
+          hook.send(name, **arguments)
         end
       end
     end

data/lib/gruf/interceptors/base.rb

@@ -21,11 +21,14 @@ module Gruf
     # Base class for interception requests
     #
     class Base
-      # @var [Gruf::Controllers::Request] request
+      # @!attribute [r] request
+      #   @return [Gruf::Controllers::Request] request
       attr_reader :request
-      # @var [Gruf::Error] error
+      # @!attribute [r] error
+      #   @return [Gruf::Error] error
       attr_reader :error
-      # @var [Hash] options
+      # @!attribute [r] options
+      #   @return [Hash] options
       attr_reader :options
 
       ##