grpc_kit 0.1.8 → 0.1.9

data/lib/grpc_kit/transport/packable.rb

@@ -3,14 +3,16 @@
 module GrpcKit
   module Transport
     module Packable
-      # @params data [String]
-      # @params compress [Boolean]
+      # @param data [String]
+      # @param compress [Boolean]
+      # @return [String] packed value
       def pack(data, compress = false)
         c = compress ? 1 : 0
         [c, data.bytesize, data].pack('CNa*')
       end
 
-      # @params data [String]
+      # @param data [String]
+      # @return [String]
       def unpack(data)
         unpacker.feed(data) if data
 
@@ -29,14 +31,18 @@ module GrpcKit
           @data = +''.b
         end
 
+        # @return [Boolean]
         def data_exist?
           !@data.empty?
         end
 
+        # @param data [String]
+        # @return [void]
         def feed(data)
           @data << data
         end
 
+        # @return [nil, Array<Boolean, Integer, String>]
         def read
           return nil if @data.empty?
 

data/lib/grpc_kit/transport/server_transport.rb

@@ -7,40 +7,53 @@ module GrpcKit
     class ServerTransport
       include GrpcKit::Transport::Packable
 
-      # @params session [GrpcKit::Session::ServerSession]
-      # @params stream [GrpcKit::Session::Stream]
+      # @param session [GrpcKit::Session::ServerSession]
+      # @param stream [GrpcKit::Session::Stream]
       def initialize(session, stream)
         @session = session
         @stream = stream
       end
 
+      # @param headers [Hash<String, String>]
+      # @return [void]
       def start_response(headers)
         @session.submit_response(@stream.stream_id, headers)
         send_data
       end
 
+      # @param headers [Hash<String, String>]
+      # @return [void]
       def submit_headers(headers)
         @session.submit_headers(@stream.stream_id, headers)
       end
 
+      # @param buf [String]
+      # @param last [Boolean]
+      # @return [void]
       def write_data(buf, last: false)
         @stream.write_send_data(pack(buf), last: last)
         send_data(last: last)
       end
 
+      # @param last [Boolean]
+      # @return [nil,String]
       def read_data(last: false)
         unpack(recv_data(last: last))
       end
 
+      # @param trailer [Hash<String, String>]
+      # @return [void]
       def write_trailers(trailer)
         @stream.write_trailers_data(trailer)
         send_data(last: true)
       end
 
+      # @return [void]
       def end_write
         @stream.end_write
       end
 
+      # @return [Hash<String,String>]
       def recv_headers
         @stream.headers
       end

data/lib/grpc_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrpcKit
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - ganmacs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ds9
@@ -152,7 +152,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.md
 - bin/console
 - bin/nghttp2
 - bin/setup
@@ -173,9 +172,11 @@ files:
 - lib/grpc.rb
 - lib/grpc_kit.rb
 - lib/grpc_kit/calls.rb
+- lib/grpc_kit/calls/client_bidi_streamer.rb
 - lib/grpc_kit/calls/client_client_streamer.rb
 - lib/grpc_kit/calls/client_request_response.rb
 - lib/grpc_kit/calls/client_server_streamer.rb
+- lib/grpc_kit/calls/server_bidi_streamer.rb
 - lib/grpc_kit/calls/server_client_streamer.rb
 - lib/grpc_kit/calls/server_request_response.rb
 - lib/grpc_kit/calls/server_server_streamer.rb
@@ -188,9 +189,11 @@ files:
 - lib/grpc_kit/grpc/stream.rb
 - lib/grpc_kit/grpc_time.rb
 - lib/grpc_kit/interceptors.rb
+- lib/grpc_kit/interceptors/client_bidi_streamer.rb
 - lib/grpc_kit/interceptors/client_client_streamer.rb
 - lib/grpc_kit/interceptors/client_request_response.rb
 - lib/grpc_kit/interceptors/client_server_streamer.rb
+- lib/grpc_kit/interceptors/server_bidi_streamer.rb
 - lib/grpc_kit/interceptors/server_client_streamer.rb
 - lib/grpc_kit/interceptors/server_request_response.rb
 - lib/grpc_kit/interceptors/server_server_streamer.rb

data/TODO.md

@@ -1,71 +0,0 @@
-## Features
-
-### request response
-
-- [x] recv/send msg
-- [x] metadata (client)
-- [x] metadata (server)
-- [x] interceptor (client)
-- [x] interceptor (server)
-- [x] deadline (client)
-- [x] deadline (server)
-
-### server streamer
-
-- [x] recv/send msg
-- [x] metadata (client)
-- [x] metadata (server)
-- [x] interceptor (client)
-- [x] interceptor (server)
-- [ ] deadline (client)
-- [ ] deadline (server)
-
-### client streamer
-
-- [x] recv/send msg
-- [x] metadata (client)
-- [x] metadata (server)
-- [x] interceptor (client)
-- [x] interceptor (server)
-- [ ] deadline (client)
-- [ ] deadline (server)
-
-### bidi_streamer
-
-- [ ] recv/send msg
-- [ ] metadata (client)
-- [ ] metadata (server)
-- [ ] interceptor (client)
-- [ ] interceptor (server)
-- [ ] deadline (client)
-- [ ] deadline (server)
-
-## Error handling
-
-- [x] resouce exhausted (body size is to large)
-- [x] internal
-- [ ] resouce exhausted (worker is exhausted)
-- [x] duration parse in header
-- [x] send `grpc-status` along with header frame if possible
-   - need to support  https://nghttp2.org/documentation/nghttp2_submit_response.html, data_prd is not NULL
-- [x] unimplemented error
-- [ ] goaway
-- [ ] cancel
-- [ ] support h2's header continuation
-
-## Others
-
-- [x] multi thread (griffin)
-- [x] mutli process (griffin)
-- [ ] connection persistent (client, griffin)
-- [ ] send metadata in trailrs frame
-- [ ] add server request spec
-- [ ] add client request spec
-- [ ] handle RST FRAME
-
-## bugs
-
-- [x] status_check is invoked twice
-- [x] undefined local variable or method `finish' for #<GrpcKit::Sessions::ClientSession:0x00007f9ae3abf970> (NameError)
-- [x] clients don't use same object even if thier connections alive
-