grpc_kit 0.1.14 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ec1c9378ba22652effa01e9aa66474cc3cd1796777d5818556a9edf4994a07
-  data.tar.gz: 76ad9686c486526f7024d59d86e28d2f5d3c275d60d41adc854ea09c4255af84
+  metadata.gz: bb504e4e1ba14e8e0a411336254cd5f7b3b20a39305cc31e506ae4d0d81cd77a
+  data.tar.gz: 2595cda7ac23058f72e76e0e8955b70d305c585fe34d63e1bd183d1fc40c104e
 SHA512:
-  metadata.gz: 18e6fee2fb90e49fad73264fabe145aa7b1b989aff8d8b8228b8e76b929871e7efb94d5e10aa65b22442a0189821be0eae92b63ef0e38dcdddc0b5e563f62df7
-  data.tar.gz: 90c5c08f4b147629e5cf6805402426feb48cf3c30c613ecf2914e62c0dae5d4efc179b1630f6ed0aaf8258e2b80772071a55af4c33eeeadf98125c7c47540757
+  metadata.gz: f00be6d6aace37b66fa123f50b89903998b6520446369e067dc56afc4342b1d62153f15f631f170fb0aed6b0dba27f0db270d94edd78ad7ccd5f712eb0163b5b
+  data.tar.gz: 83671c633699f7a0e49adbfffbf9fe383a7eae57216d7876760b9bbd6114018cf606183420135807406ece0ebbbd6fdb6a5fd251956b5e1cd59adef6c68f4369

data/.rubocop.yml

@@ -29,6 +29,9 @@ Style/IfUnlessModifier:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 

data/README.md

@@ -59,6 +59,10 @@ puts message
 $ bundle install
 ```
 
+## Projects using grpc_kit
+
+* [griffin](https://github.com/ganmacs/griffin) Multi process gRPC server in Ruby
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ganmacs/grpc_kit.

data/examples/interceptors/call_stream.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'grpc_kit'
+require 'forwardable'
+
+class CallStream < GrpcKit::Call
+  extend Forwardable
+  delegate %i[send_msg recv] => :@inner
+
+  # @params call [GrpcKit::Call]
+  def initialize(inner)
+    @inner = inner
+  end
+
+  def method_missing(name, *args, &block)
+    @inner.public_send(name, *args, &block)
+  end
+end

data/examples/interceptors/client_logging_interceptor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'grpc_kit'
+require_relative 'call_stream'
 
 class LoggingInterceptor < GRPC::ClientInterceptor
   def request_response(request: nil, method: nil, **)
@@ -26,28 +27,16 @@ class LoggingInterceptor < GRPC::ClientInterceptor
     yield(LoggingStream.new(call))
   end
 
-  class LoggingStream
-    def initialize(stream)
-      @stream = stream
-    end
-
-    def send_msg(msg, **opts)
+  class LoggingStream < CallStream
+    def send_msg(msg)
       GrpcKit.logger.info("logging interceptor send #{msg.inspect}")
-      @stream.send_msg(msg, opts)
+      super
     end
 
-    def recv(**opt)
-      @stream.recv(opt).tap do |v|
+    def recv
+      super.tap do |v|
         GrpcKit.logger.info("logging interceptor recv #{v.inspect}")
       end
     end
-
-    def close_and_recv
-      @stream.close_and_recv
-    end
-
-    def close_and_send
-      @stream.close_and_send
-    end
   end
 end

data/examples/interceptors/server_logging_interceptor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'grpc_kit'
+require_relative 'call_stream'
 
 class LoggingInterceptor < GRPC::ServerInterceptor
   def request_response(request: nil, call: nil, method: nil)
@@ -26,18 +27,14 @@ class LoggingInterceptor < GRPC::ServerInterceptor
     yield(LoggingStream.new(call))
   end
 
-  class LoggingStream
-    def initialize(stream)
-      @stream = stream
-    end
-
-    def send_msg(msg, **opt)
+  class LoggingStream < CallStream
+    def send_msg(msg)
       GrpcKit.logger.info("logging interceptor send #{msg.inspect}")
-      @stream.send_msg(msg, opt)
+      super
     end
 
-    def recv(**opt)
-      @stream.recv(**opt).tap do |v|
+    def recv
+      super.tap do |v|
         GrpcKit.logger.info("logging interceptor recv #{v.inspect}")
       end
     end

data/examples/routeguide_client.rb

@@ -15,7 +15,7 @@ def get_feature(stub)
   GRPC.logger.info('===== get_feature =====')
   points = [
     Routeguide::Point.new(latitude:  409_146_138, longitude: -746_188_906),
-    Routeguide::Point.new(latitude:  0, longitude: 0)
+    Routeguide::Point.new(latitude:  0, longitude: 0),
   ]
 
   points.each do |pt|
@@ -36,9 +36,7 @@ def list_features(stub)
   )
 
   stream = stub.list_features(rect)
-
-  loop do
-    r = stream.recv
+  stream.each do |r|
     GRPC.logger.info("Found #{r.name} at #{r.location.inspect}")
   end
 end
@@ -55,13 +53,13 @@ def record_route(stub, size)
   size.times do
     location = features.sample['location']
     point = Routeguide::Point.new(latitude: location['latitude'], longitude: location['longitude'])
-    puts "Next point is #{point.inspect}"
+    GRPC.logger.info("Next point is #{point.inspect}")
     stream.send_msg(point)
     sleep(rand(0..1))
   end
 
-  resp = stream.close_and_recv
-  puts "summary: #{resp[0].inspect}"
+  resp = stream.recv
+  GRPC.logger.info("summary: #{resp.inspect}")
 end
 
 ROUTE_CHAT_NOTES = [
@@ -79,9 +77,8 @@ def route_chat(stub)
   call = stub.route_chat({})
 
   t = Thread.new do
-    loop do
-      rn = call.recv
-      GRPC.logger.info("Got message #{rn.message} at point point(#{rn.location.latitude}, #{rn.location.longitude})")
+    call.each do |rn|
+      GRPC.logger.info("Got message #{rn.message} at point (#{rn.location.latitude}, #{rn.location.longitude})")
     end
   end
 

data/examples/routeguide_server.rb

@@ -20,6 +20,7 @@ class Server < Routeguide::RouteGuide::Service
   end
 
   def get_feature(point, ctx)
+    GRPC.logger.info('===== get_feature =====')
     name = @features.fetch({ 'longitude' => point.longitude, 'latitude' => point.latitude }, '')
     GRPC.logger.info("Point longitude=#{point.longitude}, latitude=#{point.latitude}, metadata=#{ctx.metadata}")
     Routeguide::Feature.new(location: point, name: name)
@@ -48,8 +49,7 @@ class Server < Routeguide::RouteGuide::Service
     start_at = Time.now.to_i
     last = nil
 
-    loop do
-      point = stream.recv # XXX: raise StopIteration
+    stream.each do |point|
       GRPC.logger.info(point)
 
       count += 1
@@ -71,8 +71,8 @@ class Server < Routeguide::RouteGuide::Service
   end
 
   def route_chat(call)
-    loop do
-      rn = call.recv
+    GRPC.logger.info('===== record_chat =====')
+    call.each do |rn|
       GRPC.logger.info("route_note location=#{rn.location.inspect}, message=#{rn.message}")
       key = "#{rn.location.latitude} #{rn.location.longitude}"
       saved_msgs = @route_notes[key]
@@ -115,8 +115,6 @@ class Server < Routeguide::RouteGuide::Service
 end
 
 sock = TCPServer.new(50051)
-GrpcKit.logger = Logger.new('hoge', level: :debug)
-
 opts = {}
 
 if ENV['GRPC_INTERCEPTOR']

data/lib/grpc_kit.rb

@@ -23,7 +23,7 @@ module GrpcKit
 
     # @param level [String] :debug, :info, :warn, :error, :fatal or :unknown
     # @return [void]
-    def self.loglevel=(level)
+    def loglevel=(level)
       logger.level = level
     end
   end

data/lib/grpc_kit/call.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GrpcKit
+  class Call
+    Name = Struct.new(:name, :receiver)
+    Reciver = Struct.new(:class)
+    Klass = Struct.new(:service_name)
+
+    # @return [GrpcKit::Call::Name] gRPC method object
+    attr_reader :method
+
+    # @return [Symbol] gRPC method name
+    attr_reader :method_name
+
+    # @return [String] gRPC service name
+    attr_reader :service_name
+
+    # @return [Hash<String, String>] gRPC metadata
+    attr_reader :metadata
+
+    # @param stream [GrpcKit::Stream::ServerStream|GrpcKit::Stream::ClientStream]
+    # @param config [GrpcKit::MethodConfig]
+    # @param metadata [Hash<String,String>]
+    def initialize(stream:, config:, metadata:, timeout: nil)
+      @config = config
+      @metadata = metadata
+      @method_name = @config.method_name
+      @service_name = @config.service_name
+      @protobuf = @config.protobuf
+      @timeout = timeout
+      @stream = stream
+
+      # for compatible
+      klass = Klass.new(@service_name)
+      @method ||= Name.new(@method_name, Reciver.new(klass))
+    end
+
+    # @return [Time] deadline of this rpc call
+    def deadline
+      return @deadline if instance_variable_defined?(:@deadline)
+
+      @deadline = @timeout && @timeout.to_absolute_time
+    end
+  end
+end

data/lib/grpc_kit/calls.rb

@@ -2,57 +2,7 @@
 
 module GrpcKit
   module Calls
-    class Call
-      Name = Struct.new(:name, :receiver)
-      Reciver = Struct.new(:class)
-      Klass = Struct.new(:service_name)
-
-      # @return [GrpcKit::Calls::Call::Name] gRPC method object
-      attr_reader :method
-
-      # @return [Symbol] gRPC method name
-      attr_reader :method_name
-
-      # @return [String] gRPC service name
-      attr_reader :service_name
-
-      # @return [Hash<String, String>] gRPC metadata
-      attr_reader :metadata
-
-      # @param stream [GrpcKit::Stream::ServerStream|GrpcKit::Stream::ClientStream]
-      # @param config [GrpcKit::MethodConfig]
-      # @param metadata [Hash<String,String>]
-      def initialize(stream:, config:, metadata:, timeout: nil)
-        @config = config
-        @metadata = metadata
-        @method_name = @config.method_name
-        @service_name = @config.service_name
-        @protobuf = @config.protobuf
-        @timeout = timeout
-        @stream = stream
-
-        # for compatible
-        klass = Klass.new(@service_name)
-        @method ||= Name.new(@method_name, Reciver.new(klass))
-        @restrict = false
-      end
-
-      # @return [void]
-      def restrict_mode
-        @restrict = true
-      end
-
-      # @return [void]
-      def normal_mode
-        @restrict = false
-      end
-
-      # @return [Time] deadline of this rpc call
-      def deadline
-        return @deadline if instance_variable_defined?(:@deadline)
-
-        @deadline = @timeout && @timeout.to_absolute_time
-      end
-    end
+    module Client; end
+    module Server; end
   end
 end

data/lib/grpc_kit/calls/client_bidi_streamer.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'grpc_kit/call'
 require 'grpc_kit/calls'
 
 module GrpcKit
   module Calls::Client
-    class BidiStreamer < GrpcKit::Calls::Call
+    class BidiStreamer < GrpcKit::Call
+      include Enumerable
+
       alias outgoing_metadata metadata
 
       def initialize(*)
@@ -14,17 +17,14 @@ module GrpcKit
       end
 
       # @param data [Object] request message
-      # @param last [Boolean]
       # @return [void]
-      def send_msg(data, last: false)
-        raise 'No method error' if @restrict
-
+      def send_msg(data)
         if @reason
           raise "Upstream returns an error status: #{@reason}"
         end
 
         @mutex.synchronize do
-          @stream.send_msg(data, last: last, metadata: outgoing_metadata)
+          @stream.send_msg(data, metadata: outgoing_metadata)
         end
 
         @send = true
@@ -32,16 +32,13 @@ module GrpcKit
 
       # This method not is expected to be call in the main thread where #send_msg is called
       #
-      # @param last [Boolean]
       # @return [Object] response object
-      def recv(last: false)
-        raise 'No method error' if @restrict
-
+      def recv
         sleep 0.1 until @send
 
         loop do
           msg = @mutex.synchronize do
-            @stream.recv_msg(last: last, blocking: false)
+            @stream.recv_msg(blocking: false)
           end
 
           unless msg == :wait_readable
@@ -60,6 +57,11 @@ module GrpcKit
           @stream.close_and_send
         end
       end
+
+      # @yieldparam response [Object] each response object of bidi streaming RPC
+      def each
+        loop { yield(recv) }
+      end
     end
   end
 end

data/lib/grpc_kit/calls/client_client_streamer.rb

@@ -1,31 +1,21 @@
 # frozen_string_literal: true
 
+require 'grpc_kit/call'
 require 'grpc_kit/calls'
 
 module GrpcKit
   module Calls::Client
-    class ClientStreamer < GrpcKit::Calls::Call
+    class ClientStreamer < GrpcKit::Call
       alias outgoing_metadata metadata
 
       # @param data [Object] request message
-      # @param last [Boolean]
       # @return [void]
-      def send_msg(data, last: false)
-        raise 'No method error' if @restrict
-
-        @stream.send_msg(data, last: last, metadata: outgoing_metadata)
+      def send_msg(data)
+        @stream.send_msg(data, metadata: outgoing_metadata)
       end
 
-      # @param last [Boolean]
       # @return [Object] response object
-      def recv(last: false)
-        raise 'No method error' if @restrict
-
-        @stream.recv_msg(last: last)
-      end
-
-      # @return [Array<Object>] response objects
-      def close_and_recv
+      def recv
         @stream.close_and_recv
       end
     end

data/lib/grpc_kit/calls/client_request_response.rb

@@ -1,27 +1,22 @@
 # frozen_string_literal: true
 
+require 'grpc_kit/call'
 require 'grpc_kit/calls'
 
 module GrpcKit
   module Calls::Client
-    class RequestResponse < GrpcKit::Calls::Call
+    class RequestResponse < GrpcKit::Call
       alias outgoing_metadata metadata
 
       # @param data [Object] request message
-      # @param last [Boolean]
       # @return [void]
-      def send_msg(data, last: false)
-        raise 'No method error' if @restrict
-
-        @stream.send_msg(data, last: last, metadata: outgoing_metadata)
+      def send_msg(data)
+        @stream.send_msg(data, last: true, metadata: outgoing_metadata)
       end
 
-      # @param last [Boolean]
       # @return [Object] response object
-      def recv(last: false)
-        raise 'No method error' if @restrict
-
-        @stream.recv_msg(last: last)
+      def recv
+        @stream.recv_msg(last: true)
       end
     end
   end