grpc_kit 0.1.8 → 0.1.9

data/lib/grpc_kit/client.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 require 'grpc_kit/grpc_time'
 require 'grpc_kit/session/io'
@@ -8,6 +8,10 @@ require 'grpc_kit/transport/client_transport'
 
 module GrpcKit
   class Client
+    # @param sock [TCPSocket]
+    # @param authority [nil, String]
+    # @param interceptors [Array<GrpcKit::GRPC::ClientInterceptor>] list of interceptors
+    # @param timeout [nil, Integer, String]
     def initialize(sock, authority: nil, interceptors: [], timeout: nil)
       @sock = sock
       @authority =
@@ -23,31 +27,45 @@ module GrpcKit
       build_rpcs(interceptors)
     end
 
+    # @param rpc [GrpcKit::Rpcs::Client::RequestResponse]
+    # @param request [Object]
+    # @param opts [Hash]
     def request_response(rpc, request, opts = {})
       GrpcKit.logger.debug('Calling request_respose')
       do_request(rpc, request, opts)
     end
 
+    # @param rpc [GrpcKit::Rpcs::Client::ClientStreamer]
+    # @param opts [Hash]
     def client_streamer(rpc, opts = {})
       GrpcKit.logger.debug('Calling client_streamer')
       do_request(rpc, nil, opts)
     end
 
+    # @param rpc [GrpcKit::Rpcs::Client::ServerStreamer]
+    # @param request [Object]
+    # @param opts [Hash]
     def server_streamer(rpc, request, opts = {})
       GrpcKit.logger.debug('Calling server_streamer')
       do_request(rpc, request, opts)
     end
 
-    def bidi_streamer(rpc, requests, opts = {})
+    # @param rpc [GrpcKit::Rpcs::Client::ServerStreamer]
+    # @param _requests [Object] it's for compatibility, no use
+    # @param opts [Hash]
+    def bidi_streamer(rpc, _requests, opts = {})
       GrpcKit.logger.debug('Calling bidi_streamer')
+      do_request(rpc, nil, opts)
     end
 
     private
 
     def do_request(rpc, request, **opts)
       t = GrpcKit::Transport::ClientTransport.new(session)
-      cs = GrpcKit::Stream::ClientStream.new(t, rpc.config, authority: @authority, timeout: @timeout)
-      rpc.invoke(cs, request, opts.merge(timeout: @timeout))
+      timeout = (opts[:timeout] && GrpcKit::GrpcTime.new(opts[:timeout])) || @timeout
+
+      cs = GrpcKit::Stream::ClientStream.new(t, rpc.config, authority: @authority, timeout: timeout)
+      rpc.invoke(cs, request, timeout: timeout, **opts)
     end
 
     def session

data/lib/grpc_kit/errors.rb

@@ -6,13 +6,22 @@ module GrpcKit
   module Errors
     # https://github.com/grpc/grpc/blob/23b5b1a5a9c7084c5b64d4998ee15af0f77bd589/doc/statuscodes.md
 
+    # @param code [String] GrpcKit::StatusCodes's value
+    # @param message [String]
+    # @return [GrpcKit::Errors::BadStatus]
     def self.from_status_code(code, message)
       CODES.fetch(code).new(message)
     end
 
     class BadStatus < StandardError
-      attr_reader :code, :reason
+      # @return [String]
+      attr_reader :code
 
+      # @return [String]
+      attr_reader :reason
+
+      # @param code [String] GrpcKit::StatusCodes's value
+      # @param reason [String]
       def initialize(code, reason)
         @code = code
         @reason = reason
@@ -21,32 +30,37 @@ module GrpcKit
     end
 
     class Unknown < BadStatus
-      def initialize(mesage)
-        super(GrpcKit::StatusCodes::UNKNOWN, mesage)
+      # @param message [String]
+      def initialize(message)
+        super(GrpcKit::StatusCodes::UNKNOWN, message)
       end
     end
 
     class DeadlineExceeded < BadStatus
-      def initialize(mesage)
-        super(GrpcKit::StatusCodes::DEADLINE_EXCEEDED, mesage)
+      # @param message [String]
+      def initialize(message)
+        super(GrpcKit::StatusCodes::DEADLINE_EXCEEDED, message)
       end
     end
 
     class Unimplemented < BadStatus
-      def initialize(mesage)
-        super(GrpcKit::StatusCodes::UNIMPLEMENTED, mesage)
+      # @param message [String]
+      def initialize(message)
+        super(GrpcKit::StatusCodes::UNIMPLEMENTED, message)
       end
     end
 
     class ResourceExhausted < BadStatus
-      def initialize(mesage)
-        super(GrpcKit::StatusCodes::RESOURCE_EXHAUSTED, mesage)
+      # @param message [String]
+      def initialize(message)
+        super(GrpcKit::StatusCodes::RESOURCE_EXHAUSTED, message)
       end
     end
 
     class Internal < BadStatus
-      def initialize(mesage)
-        super(GrpcKit::StatusCodes::INTERNAL, mesage)
+      # @param message [String]
+      def initialize(message)
+        super(GrpcKit::StatusCodes::INTERNAL, message)
       end
     end
 

data/lib/grpc_kit/grpc/dsl.rb

@@ -8,13 +8,24 @@ require 'grpc_kit/grpc/stream'
 module GrpcKit
   module GRPC
     module Dsl
-      attr_writer :service_name, :marshal_class_method, :unmarshal_class_method
+      # @param value [String]
+      attr_writer :service_name
+
+      # @param value [Symbol]
+      attr_writer :marshal_class_method
+
+      # @param value [Symbol]
+      attr_writer :unmarshal_class_method
 
       def inherited(subclass)
         subclass.rpc_descs.merge!(rpc_descs)
         subclass.service_name = @service_name
       end
 
+      # @param name [Symbol] gRPC method name
+      # @param marshal [Class, GrpcKit::GRPC::Stream] marshaling object
+      # @param unmarshal [Class, GrpcKit::GRPC::Stream] unmarshaling object
+      # @return [void]
       def rpc(name, marshal, unmarshal)
         if rpc_descs.key?(name)
           raise "rpc (#{name}) is already defined"
@@ -38,15 +49,18 @@ module GrpcKit
         )
         rpc_descs[rpc_desc.path] = rpc_desc
 
-        define_method(rpc_desc.ruby_style_name) do |_, _|
+        # Should use `*` since each rpc's sigunature is different.
+        define_method(rpc_desc.ruby_style_name) do |*|
           raise GrpcKit::Errors::Unimplemented, "Method not found: #{name}"
         end
       end
 
+      # @return [GrpcKit::GRPC::Stream]
       def stream(cls)
         GrpcKit::GRPC::Stream.new(cls)
       end
 
+      # @return [GrpcKit::Client]
       def rpc_stub_class
         rpc_descs_ = {}
         rpc_descs.each_value do |rpc_desc|
@@ -90,6 +104,7 @@ module GrpcKit
         end
       end
 
+      # @return [Hash<String,GrpcKit::RpcDesc>]
       def rpc_descs
         @rpc_descs ||= {}
       end

data/lib/grpc_kit/grpc/generic_service.rb

@@ -7,19 +7,6 @@ module GrpcKit
     module GenericService
       def self.included(obj)
         obj.extend(GrpcKit::GRPC::Dsl)
-
-        # return unless obj.service_name.nil?
-        # if obj.name.nil?
-        #   obj.service_name = 'GenericService'
-        # else
-        # modules = obj.name.split('::')
-        # obj.service_name =
-        #   if modules.length > 2
-        #     modules[modules.length - 2]
-        #   else
-        #     modules.first
-        #   end
-        # end
       end
     end
   end

data/lib/grpc_kit/grpc/interceptor.rb

@@ -13,18 +13,34 @@ module GrpcKit
     class ClientInterceptor < Interceptor
       # rubocop:disable Lint/UnusedMethodArgument
 
+      # @param request [Object,nil] An object which cliet will send
+      # @param call [GrpcKit::Calls::Client::RequestResponse,nil]
+      # @param metadata [Hash<String,String>,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def request_response(request: nil, call: nil, method: nil, metadata: nil)
         yield
       end
 
+      # @param requests [Object,nil] comptibility with grpc gem, no use
+      # @param call [GrpcKit::Calls::Client::ClientStreamer,nil]
+      # @param metadata [Hash<String,String>,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def client_streamer(requests: nil, call: nil, method: nil, metadata: nil)
         yield
       end
 
+      # @param request [Object,nil] An object which cliet will send
+      # @param call [GrpcKit::Calls::Client::ServerStreamer,nil]
+      # @param metadata [Hash<String,String>,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def server_streamer(request: nil, call: nil, method: nil, metadata: nil)
         yield
       end
 
+      # @param requests [Object,nil] comptibility with grpc gem, no use
+      # @param call [GrpcKit::Calls::Client::BidiStreamer,nil]
+      # @param metadata [Hash<String,String>,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil)
         yield
       end
@@ -35,18 +51,29 @@ module GrpcKit
     class ServerInterceptor < Interceptor
       # rubocop:disable Lint/UnusedMethodArgument
 
+      # @param request [Object] An object which server received
+      # @param call [GrpcKit::Calls::Server::RequestResponse,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def request_response(request: nil, call: nil, method: nil)
         yield
       end
 
+      # @param call [GrpcKit::Calls::Server::ClientStreamer,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def client_streamer(call: nil, method: nil)
         yield
       end
 
+      # @param request [Object] An object which server received
+      # @param call [GrpcKit::Calls::Server::ServerStreamer,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def server_streamer(request: nil, call: nil, method: nil)
         yield
       end
 
+      # @param requests [Object,nil] comptibility with grpc gem, no use
+      # @param call [GrpcKit::Calls::Server::BidiStreamer,nil]
+      # @param method [GrpcKit::Calls::Call::Name,nil]
       def bidi_streamer(requests: nil, call: nil, method: nil)
         yield
       end

data/lib/grpc_kit/grpc/logger.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 module GrpcKit
   module GRPC
     module DefaultLogger
-      def self.logger
+      # @return [Logger]
+      def logger
         LOGGER
       end
 

data/lib/grpc_kit/grpc_time.rb

@@ -4,7 +4,7 @@ module GrpcKit
   class GrpcTime
     MAX = 10**9 - 1
 
-    # @params value [String|Integer]
+    # @param value [String,Integer]
     def initialize(value)
       @unit = nil
       @value = nil
@@ -38,10 +38,12 @@ module GrpcKit
       end
     end
 
+    # @return [String]
     def to_s
       "#{@value}#{@unit}"
     end
 
+    # @return [Time]
     def to_absolute_time
       case @unit
       when 'S'

data/lib/grpc_kit/interceptors.rb

@@ -4,10 +4,12 @@ module GrpcKit
   module Interceptors
     module Client
       class Streaming
+        # @param interceptors [Array<GrpcKit::GRPC::ClientInterceptor>]
         def initialize(interceptors)
           @interceptors = interceptors
         end
 
+        # @param metadata [Hash<String,String>]
         def intercept(call, metadata, &block)
           if @interceptors && !@interceptors.empty?
             do_intercept(@interceptors.dup, call, metadata, &block)
@@ -35,6 +37,7 @@ module GrpcKit
 
     module Server
       class Streaming
+        # @param interceptors [Array<GrpcKit::GRPC::ServerInterceptor>]
         def initialize(interceptors)
           @interceptors = interceptors
         end

data/lib/grpc_kit/interceptors/client_bidi_streamer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/interceptors'
+
+module GrpcKit
+  module Interceptors::Client
+    class BidiStreamer < Streaming
+      private
+
+      # @param interceptor [GrpcKit::GRPC::ClientInterceptor]
+      # @param call [GrpcKit::Calls::Client::BidiStreamer]
+      # @param metadata [Hash<String,String>]
+      def invoke(interceptor, call, metadata)
+        interceptor.bidi_streamer(requests: nil, call: call, method: call.method, metadata: metadata) do
+          yield(call, metadata)
+        end
+      end
+    end
+  end
+end

data/lib/grpc_kit/interceptors/client_client_streamer.rb

@@ -7,6 +7,9 @@ module GrpcKit
     class ClientStreamer < Streaming
       private
 
+      # @param interceptor [GrpcKit::GRPC::ClientInterceptor]
+      # @param call [GrpcKit::Calls::Client::ClientStreamer]
+      # @param metadata [Hash<String,String>]
       def invoke(interceptor, call, metadata)
         # We don't need a `:requests` parameter but,
         # it shuoldn't remove from paramters due to having a compatibility of grpc gem.

data/lib/grpc_kit/interceptors/client_request_response.rb

@@ -5,10 +5,13 @@ require 'grpc_kit/interceptors'
 module GrpcKit
   module Interceptors::Client
     class RequestResponse
+      # @param interceptors [Array<GrpcKit::GRPC::ClientInterceptor>]
       def initialize(interceptors)
         @interceptors = interceptors
       end
 
+      # @param call [GrpcKit::Calls::Client::RequestResponse]
+      # @param metadata [Hash<String,String>]
       def intercept(request, call, metadata, &block)
         if @interceptors && !@interceptors.empty?
           do_intercept(@interceptors.dup, request, call, metadata, &block)

data/lib/grpc_kit/interceptors/client_server_streamer.rb

@@ -7,6 +7,9 @@ module GrpcKit
     class ServerStreamer < Streaming
       private
 
+      # @param interceptor [GrpcKit::GRPC::ClientInterceptor]
+      # @param call [GrpcKit::Calls::Client::ServerStreamer]
+      # @param metadata [Hash<String,String>]
       def invoke(interceptor, call, metadata)
         # We don't need a `:request` parameter but,
         # it shuoldn't remove from paramters due to having a compatibility of grpc gem.

data/lib/grpc_kit/interceptors/server_bidi_streamer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/interceptors'
+
+module GrpcKit
+  module Interceptors::Server
+    class BidiStreamer < Streaming
+      # @param interceptor [GrpcKit::GRPC::ServerInterceptor]
+      # @param call [GrpcKit::Calls::Client::BidiStreamer]
+      def invoke(interceptor, call)
+        interceptor.bidi_streamer(call: call, method: call.method) do
+          yield(call)
+        end
+      end
+    end
+  end
+end

data/lib/grpc_kit/interceptors/server_client_streamer.rb

@@ -5,6 +5,8 @@ require 'grpc_kit/interceptors'
 module GrpcKit
   module Interceptors::Server
     class ClientStreamer < Streaming
+      # @param interceptor [GrpcKit::GRPC::ServerInterceptor]
+      # @param call [GrpcKit::Calls::Client::ClientStreamer]
       def invoke(interceptor, call)
         interceptor.client_streamer(call: call, method: call.method) do
           yield(call)

data/lib/grpc_kit/interceptors/server_request_response.rb

@@ -5,10 +5,12 @@ require 'grpc_kit/interceptors'
 module GrpcKit
   module Interceptors::Server
     class RequestResponse
+      # @param interceptors [Array<GrpcKit::GRPC::ServerInterceptor>]
       def initialize(interceptors)
         @interceptors = interceptors
       end
 
+      # @param call [GrpcKit::Calls::Client::RequestResponse]
       def intercept(request, call, &block)
         if @interceptors && !@interceptors.empty?
           do_intercept(@interceptors.dup, request, call, &block)

data/lib/grpc_kit/interceptors/server_server_streamer.rb

@@ -5,6 +5,8 @@ require 'grpc_kit/interceptors'
 module GrpcKit
   module Interceptors::Server
     class ServerStreamer < Streaming
+      # @param interceptor [GrpcKit::GRPC::ServerInterceptor]
+      # @param call [GrpcKit::Calls::Client::ServerStreamer]
       def invoke(interceptor, call)
         # We don't need a `:request` parameter but,
         # it shuoldn't remove from paramters due to having a compatibility of grpc gem.