gruf 2.8.1 → 2.11.0

data/lib/gruf/interceptors/client_interceptor.rb

@@ -43,7 +43,7 @@ module Gruf
       # @param [Hash] metadata A hash of outgoing metadata
       # @return [Object] The response message
       #
-      def request_response(request: nil, call: nil, method: nil, metadata: nil)
+      def request_response(request: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :request_response,
           requests: [request],
@@ -51,9 +51,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
 
       ##
@@ -65,7 +63,7 @@ module Gruf
       # @param [Hash] metadata A hash of outgoing metadata
       # @return [Object] The response message
       #
-      def client_streamer(requests: nil, call: nil, method: nil, metadata: nil)
+      def client_streamer(requests: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :client_streamer,
           requests: requests,
@@ -73,9 +71,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
 
       ##
@@ -87,7 +83,7 @@ module Gruf
       # @param [Hash] metadata A hash of outgoing metadata
       # @return [Object] The response message
       #
-      def server_streamer(request: nil, call: nil, method: nil, metadata: nil)
+      def server_streamer(request: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :server_streamer,
           requests: [request],
@@ -95,9 +91,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
 
       ##
@@ -108,7 +102,7 @@ module Gruf
       # @param [Method] method The method being called
       # @param [Hash] metadata A hash of outgoing metadata
       #
-      def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil)
+      def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :bidi_streamer,
           requests: requests,
@@ -116,9 +110,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
     end
   end

data/lib/gruf/interceptors/context.rb

@@ -28,14 +28,14 @@ module Gruf
       #
       # @param [Array<Gruf::Interceptors::ServerInterceptor>] interceptors
       #
-      def initialize(interceptors = [])
-        @interceptors = interceptors
+      def initialize(interceptors = nil)
+        @interceptors = interceptors || []
       end
 
       ##
       # Intercept the given request and run interceptors in a FIFO execution order
       #
-      def intercept!
+      def intercept!(&block)
         return yield if @interceptors.none?
 
         i = @interceptors.pop
@@ -45,7 +45,7 @@ module Gruf
 
         i.call do
           if @interceptors.any?
-            intercept! { yield }
+            intercept!(&block)
           else
             yield
           end

data/lib/gruf/interceptors/instrumentation/output_metadata_timer.rb

@@ -27,12 +27,10 @@ module Gruf
         ##
         # Handle the instrumented response. Note: this will only instrument timings of _successful_ responses.
         #
-        def call
+        def call(&block)
           return unless active_call.respond_to?(:output_metadata)
 
-          result = Gruf::Interceptors::Timer.time do
-            yield
-          end
+          result = Gruf::Interceptors::Timer.time(&block)
           output_metadata.update(metadata_key => result.elapsed.to_s)
 
           raise result.message unless result.successful?

data/lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb

@@ -61,12 +61,10 @@ module Gruf
           #
           # @return [String]
           #
-          def call
-            return yield if options.fetch(:ignore_methods, []).include?(request.method_name)
+          def call(&block)
+            return yield if options.fetch(:ignore_methods, [])&.include?(request.method_name)
 
-            result = Gruf::Interceptors::Timer.time do
-              yield
-            end
+            result = Gruf::Interceptors::Timer.time(&block)
 
             # Fetch log level options and merge with default...
             log_level_map = LOG_LEVEL_MAP.merge(options.fetch(:log_levels, {}))
@@ -113,7 +111,7 @@ module Gruf
           # @return [::Gruf::Logger]
           #
           def logger
-            @logger ||= options.fetch(:logger, ::Gruf.logger)
+            @logger ||= (options.fetch(:logger, nil) || Gruf.logger)
           end
 
           ##
@@ -164,26 +162,26 @@ module Gruf
           end
 
           ##
-          # Redact any blacklisted params and return an updated hash
+          # Redact any blocklisted params and return an updated hash
           #
           # @param [Hash] params The hash of parameters to sanitize
           # @return [Hash] The sanitized params in hash form
           #
           def sanitize(params = {})
-            blacklists = options.fetch(:blacklist, []).map(&:to_s)
-            redacted_string = options.fetch(:redacted_string, 'REDACTED')
-            blacklists.each do |blacklist|
-              parts = blacklist.split('.').map(&:to_sym)
+            blocklists = (options.fetch(:blocklist, []) || []).map(&:to_s)
+            redacted_string = options.fetch(:redacted_string, nil) || 'REDACTED'
+            blocklists.each do |blocklist|
+              parts = blocklist.split('.').map(&:to_sym)
               redact!(parts, 0, params, redacted_string)
             end
             params
           end
 
           ##
-          # Helper method to recursively redact based on the black list
+          # Helper method to recursively redact based on the blocklist
           #
-          # @param [Array] parts The blacklist. ex. 'data.schema' -> [:data, :schema]
-          # @param [Integer] idx The current index of the blacklist
+          # @param [Array] parts The blocklist. ex. 'data.schema' -> [:data, :schema]
+          # @param [Integer] idx The current index of the blocklist
           # @param [Hash] params The hash of parameters to sanitize
           # @param [String] redacted_string The custom redact string
           #

data/lib/gruf/interceptors/instrumentation/statsd.rb

@@ -25,7 +25,7 @@ module Gruf
         ##
         # Push data to StatsD, only doing so if a client is set
         #
-        def call
+        def call(&block)
           unless client
             Gruf.logger.error 'Statsd module loaded, but no client configured!'
             return yield
@@ -33,9 +33,7 @@ module Gruf
 
           client.increment(route_key)
 
-          result = Gruf::Interceptors::Timer.time do
-            yield
-          end
+          result = Gruf::Interceptors::Timer.time(&block)
 
           client.increment("#{route_key}.#{postfix(result.successful?)}")
           client.timing(route_key, result.elapsed)

data/lib/gruf/interceptors/timer.rb

@@ -24,8 +24,15 @@ module Gruf
       ##
       # Represents a timed result for an interceptor
       #
+      # @property [Object] message The protobuf message
+      # @property [Float] elapsed The elapsed time of the request
+      #
       class Result
+        # @!attribute [r] message
+        #   @return [Object] The returned protobuf message
         attr_reader :message
+        # @return [r] elapsed
+        #   @return [Float] The time elapsed for this interceptor to execute
         attr_reader :elapsed
 
         ##
@@ -50,7 +57,7 @@ module Gruf
         # @return [String] The name of the message class
         #
         def message_class_name
-          @message.class.name
+          @message.class.name.to_s
         end
 
         ##

data/lib/gruf/outbound/request_context.rb

@@ -21,15 +21,20 @@ module Gruf
     # Encapsulates the context of an outbound client request
     #
     class RequestContext
-      # @var [Symbol]
+      # @!attribute [r] type
+      #   @return [Symbol]
       attr_reader :type
-      # @var [Enumerable] requests
+      # @!attribute [r] requests
+      #   @return [Enumerable] requests
       attr_reader :requests
-      # @var [GRPC::ActiveCall]
+      # @!attribute [r] call
+      #   @return [GRPC::ActiveCall]
       attr_reader :call
-      # @var [Method] method
+      # @!attribute [r] method
+      #   @return [Method] method
       attr_reader :method
-      # @var [Hash] metadata
+      # @!attribute [r] metadata
+      #   @return [Hash] metadata
       attr_reader :metadata
 
       ##
@@ -55,7 +60,7 @@ module Gruf
       # @return [String]
       #
       def method_name
-        @method.to_s.split('/').last
+        @method.to_s.split('/').last.to_s
       end
 
       ##
@@ -64,7 +69,7 @@ module Gruf
       # @return [String]
       #
       def route_key
-        @method[1..-1].underscore.tr('/', '.')
+        @method[1..].to_s.underscore.tr('/', '.')
       end
     end
   end

data/lib/gruf/response.rb

@@ -20,17 +20,23 @@ module Gruf
   # Wraps the active call operation to provide metadata and timing around the request
   #
   class Response
-    # @return [GRPC::ActiveCall::Operation] The operation that was executed for the given request
+    # @!attribute [r] operation
+    #   @return [GRPC::ActiveCall::Operation] The operation that was executed for the given request
     attr_reader :operation
-    # @return [Hash] The metadata that was attached to the operation
+    # @!attribute [r] metadata
+    #   @return [Hash] The metadata that was attached to the operation
     attr_reader :metadata
-    # @return [Hash] The trailing metadata that the service returned
+    # @!attribute [r] trailing_metadata
+    #   @return [Hash] The trailing metadata that the service returned
     attr_reader :trailing_metadata
-    # @return [Time] The set deadline on the call
+    # @!attribute [r] deadline
+    #   @return [Time] The set deadline on the call
     attr_reader :deadline
-    # @return [Boolean] Whether or not the operation was cancelled
+    # @!attribute [r] cancelled
+    #   @return [Boolean] Whether or not the operation was cancelled
     attr_reader :cancelled
-    # @return [Float] The time that the request took to execute
+    # @!attribute [r] execution_time
+    #   @return [Float] The time that the request took to execute
     attr_reader :execution_time
 
     ##

data/lib/gruf/serializers/errors/base.rb

@@ -22,7 +22,8 @@ module Gruf
       # Base class for serialization of errors for transport across the grpc protocol
       #
       class Base
-        # @return [Gruf::Error|String] The error being serialized
+        # @!attribute [r] error
+        #   @return [Gruf::Error|String] The error being serialized
         attr_reader :error
 
         ##

data/lib/gruf/server.rb

@@ -25,9 +25,11 @@ module Gruf
 
     include Gruf::Loggable
 
-    # @return [Integer] The port the server is bound to
+    # @!attribute [r] port
+    #   @return [Integer] The port the server is bound to
     attr_reader :port
-    # @return [Hash] Hash of options passed into the server
+    # @!attribute [r] options
+    #   @return [Hash] Hash of options passed into the server
     attr_reader :options
 
     ##
@@ -69,9 +71,9 @@ module Gruf
 
           server = if @event_listener_proc
                      server_options[:event_listener_proc] = @event_listener_proc
-                     Gruf::InstrumentableGrpcServer.new(server_options)
+                     Gruf::InstrumentableGrpcServer.new(**server_options)
                    else
-                     GRPC::RpcServer.new(server_options)
+                     GRPC::RpcServer.new(**server_options)
                    end
 
           @port = server.add_http2_port(@hostname, ssl_credentials)

data/lib/gruf/synchronized_client.rb

@@ -23,6 +23,8 @@ module Gruf
   # to mitigate thundering herds.
   #
   class SynchronizedClient < Gruf::Client
+    # @!attribute [r] unsynchronized_methods
+    #   @return [Array]
     attr_reader :unsynchronized_methods
 
     ##

data/lib/gruf/timer.rb

@@ -29,10 +29,15 @@ module Gruf
     #   result.time # => 1.10123
     #   result.result # => 'my_thing_is_done'
     #
+    # @property [Object] result The result of the block that was called
+    # @property [Float] time The time, in ms, of the block execution
+    #
     class Result
-      # @return [Object] result The result of the block that was called
+      # @!attribute [r] result
+      #   @return [mixed]
       attr_reader :result
-      # @return [Float] time The time, in ms, of the block execution
+      # @!attribute [r] time
+      #   @return [Float]
       attr_reader :time
 
       ##

data/lib/gruf/version.rb

@@ -16,5 +16,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '2.8.1'
+  VERSION = '2.11.0'
 end

data/lib/gruf.rb

@@ -40,7 +40,7 @@ require_relative 'gruf/client'
 require_relative 'gruf/synchronized_client'
 require_relative 'gruf/instrumentable_grpc_server'
 require_relative 'gruf/server'
-require_relative 'gruf/integrations/rails/railtie' if defined?(Rails)
+require_relative 'gruf/integrations/rails/railtie' if defined?(::Rails)
 
 ##
 # Initializes configuration of gruf core module