twirp 1.7.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f17d89c29073da7ebffa780c9e8577e10f2537e28900344d8a055e098aa5f3d
-  data.tar.gz: 2932fb1abec1db6b14c3b39e8b7d2f81e318c0bdc02639d83a99bdfacd26001f
+  metadata.gz: 2564512dae1e9dcb9345119a0e09ffa0a65bba37c3800a9c6ac6c77c900701cf
+  data.tar.gz: da232ae6c1526bb650fbc32b106191c533e8aa6c11b682d6d28044d612f0def8
 SHA512:
-  metadata.gz: aca9edc089a15abfe4426880e8db8a8e2cac3f47ff056703e686dc14a3fe879a952a2b96c2de8bb06301b7406262601102c29fe48af6f9ead8775e9e2c76e35b
-  data.tar.gz: 10fc31c496e2fa4020ff9a643e08aa9ba333b0baa2324d1a42444ca6916d672a449eeef7ab22e674de81cc7a3e906d82fc97736714dfab29a999bfb4dd191f75
+  metadata.gz: 41cbdba9e68278362f8674d6b28336c97a13da955535abbbc5b148f006cee1e1413f76df3daa9e93fb1c80297fcfa7d6c1828591a44680bcd4025ca340f0aacc
+  data.tar.gz: b381e1be9c43e0836bf47f60b98e14dc14cdf5ceb444597abd8cc7587e8162b4f7c8feff4f821e50cafa9a68e5db060359c474d8c2d30a5903a16d6e5db24454

data/lib/twirp/client.rb

@@ -160,6 +160,31 @@ module Twirp
       body = Encoding.encode(input, rpcdef[:input_class], content_type)
 
       resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, content_type, req_opts, body)
+
+      rpc_response_thennable(resp) do |resp|
+        rpc_response_to_clientresp(resp, content_type, rpcdef)
+      end
+    end
+
+    private
+
+    # Executes the post-processing on 'resp' in the provided block,
+    # either in a call to ".then { ... }" as a promise-like interface,
+    # or just execute it directly if the object doesn't support "then".
+    # On Ruby 2.6+ all objects have ".then", but they behave the same as
+    # a promise-like object, so this behaves identically.
+    #
+    # This allows extensions of Faraday that return promises to work
+    # natively with twirp-ruby. For normal Faraday, this is a noop.
+    def rpc_response_thennable(resp)
+      return yield resp unless resp.respond_to?(:then)
+      
+      resp.then do |resp|
+        yield resp
+      end
+    end
+
+    def rpc_response_to_clientresp(resp, content_type, rpcdef)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end

data/lib/twirp/client_json.rb

@@ -36,6 +36,15 @@ module Twirp
 
       encoding = @strict ? Encoding::JSON_STRICT : Encoding::JSON
       resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, encoding, req_opts, body)
+
+      rpc_response_thennable(resp) do |resp|
+        rpc_response_to_clientresp(resp)
+      end
+    end
+
+    private
+
+    def rpc_response_to_clientresp(resp)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end

data/lib/twirp/service.rb

@@ -136,7 +136,9 @@ module Twirp
 
       input = nil
       begin
-        input = Encoding.decode(rack_request.body.read, env[:input_class], content_type)
+        body_str = rack_request.body.read
+        rack_request.body.rewind # allow other middleware to read again (https://github.com/twitchtv/twirp-ruby/issues/50)
+        input = Encoding.decode(body_str, env[:input_class], content_type)
       rescue => e
         error_msg = "Invalid request body for rpc method #{method_name.inspect} with Content-Type=#{content_type}"
         if e.is_a?(Google::Protobuf::ParseError)

data/lib/twirp/version.rb

@@ -12,5 +12,5 @@
 # permissions and limitations under the License.
 
 module Twirp
-  VERSION = "1.7.2"
+  VERSION = "1.9.0"
 end

data/test/client_json_test.rb

@@ -29,6 +29,30 @@ class ClientJSONTest < Minitest::Test
     assert_equal 3, resp.data["blah_resp"]
   end
 
+  def test_client_json_thennable
+    c = Twirp::ClientJSON.new(conn_stub_thennable("/my.pkg.Talking/Blah") {|req|
+      assert_equal "application/json", req.request_headers['Content-Type']
+      assert_equal '{"blah1":1,"blah2":2}', req.body # body is json
+
+      [200, {}, '{"blah_resp": 3}']
+    }, package: "my.pkg", service: "Talking")
+
+    resp_thennable = c.rpc :Blah, blah1: 1, blah2: 2
+    # the final `.then {}` call will yield a ClientResp
+    assert resp_thennable.is_a?(Thennable)
+    resp = resp_thennable.value
+    assert resp.is_a?(Twirp::ClientResp)
+
+    # the final Thennable will have come from one with a faraday response
+    assert resp_thennable.parent.is_a?(Thennable)
+    assert resp_thennable.parent.value.is_a?(Faraday::Response)
+
+    # the final ClientResp should look the same as when then isn't used
+    assert_nil resp.error
+    refute_nil resp.data
+    assert_equal 3, resp.data["blah_resp"]
+  end
+
   def test_client_json_strict_encoding
     c = Twirp::ClientJSON.new(conn_stub("/my.pkg.Talking/Blah") {|req|
       assert_equal "application/json; strict=true", req.request_headers['Content-Type']
@@ -77,4 +101,31 @@ class ClientJSONTest < Minitest::Test
     end
   end
 
+  # mock of a promise-like thennable, allowing a call to ".then" to get the real value
+  class Thennable
+    attr_reader :value, :parent
+
+    def initialize(value, parent = nil)
+      @value = value
+      @parent = parent
+    end
+
+    def then(&block)
+      # similar to a promise, but runs immediately
+      Thennable.new(block.call(@value), self)
+    end
+  end
+
+  module ThennableFaraday
+    def post(*)
+      Thennable.new(super)
+    end
+  end
+
+  def conn_stub_thennable(path, &block)
+    s = conn_stub(path, &block)
+    s.extend(ThennableFaraday)
+    s
+  end
+
  end

data/test/client_test.rb

@@ -17,7 +17,7 @@ class ClientTest < Minitest::Test
 
   def test_new_with_invalid_url
     assert_raises URI::InvalidURIError do
-      EmptyClient.new("lulz")
+      EmptyClient.new("invalid uri with unescaped spaces")
     end
   end
 
@@ -72,6 +72,27 @@ class ClientTest < Minitest::Test
     assert_equal "red", resp.data.color
   end
 
+  def test_proto_thennable
+    c = Example::HaberdasherClient.new(conn_stub_thennable("/example.Haberdasher/MakeHat") {|req|
+      [200, protoheader, proto(Example::Hat, inches: 99, color: "red")]
+    })
+    resp_thennable = c.make_hat({})
+
+    # the final `.then {}` call will yield a ClientResp
+    assert resp_thennable.is_a?(Thennable)
+    resp = resp_thennable.value
+    assert resp.is_a?(Twirp::ClientResp)
+
+    # the final Thennable will have come from one with a faraday response
+    assert resp_thennable.parent.is_a?(Thennable)
+    assert resp_thennable.parent.value.is_a?(Faraday::Response)
+
+    # the final ClientResp should look the same as when then isn't used
+    assert_nil resp.error
+    assert_equal 99, resp.data.inches
+    assert_equal "red", resp.data.color
+  end
+
   def test_proto_send_headers
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       assert_equal "Bar", req.request_headers['My-Foo-Header']
@@ -196,6 +217,27 @@ class ClientTest < Minitest::Test
     assert_equal "red", resp.data.color
   end
 
+  def test_json_thennable
+    c = Example::HaberdasherClient.new(conn_stub_thennable("/example.Haberdasher/MakeHat") {|req|
+      [200, jsonheader, '{"inches": 99, "color": "red"}']
+    }, content_type: "application/json")
+
+    resp_thennable = c.make_hat({})
+    # the final `.then {}` call will yield a ClientResp
+    assert resp_thennable.is_a?(Thennable)
+    resp = resp_thennable.value
+    assert resp.is_a?(Twirp::ClientResp)
+
+    # the final Thennable will have come from one with a faraday response
+    assert resp_thennable.parent.is_a?(Thennable)
+    assert resp_thennable.parent.value.is_a?(Faraday::Response)
+
+    # the final ClientResp should look the same as when then isn't used
+    assert_nil resp.error
+    assert_equal 99, resp.data.inches
+    assert_equal "red", resp.data.color
+  end
+
   def test_json_send_headers
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       assert_equal "Bar", req.request_headers['My-Foo-Header']
@@ -337,4 +379,31 @@ class ClientTest < Minitest::Test
     end
   end
 
+  # mock of a promise-like thennable, allowing a call to ".then" to get the real value
+  class Thennable
+    attr_reader :value, :parent
+
+    def initialize(value, parent = nil)
+      @value = value
+      @parent = parent
+    end
+
+    def then(&block)
+      # similar to a promise, but runs immediately
+      Thennable.new(block.call(@value), self)
+    end
+  end
+
+  module ThennableFaraday
+    def post(*)
+      Thennable.new(super)
+    end
+  end
+
+  def conn_stub_thennable(path, &block)
+    s = conn_stub(path, &block)
+    s.extend(ThennableFaraday)
+    s
+  end
+
 end

data/test/service_test.rb

@@ -168,7 +168,7 @@ class ServiceTest < Minitest::Test
     assert_equal({
       "code" => 'malformed',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/json: ' +
-                "Error occurred during parsing: Parse error at 'bad json'",
+                "Error occurred during parsing: Error parsing JSON @1:0: Expected: '{'",
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
   end
@@ -183,7 +183,7 @@ class ServiceTest < Minitest::Test
     assert_equal({
       "code" => 'malformed',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/protobuf: ' +
-                'Error occurred during parsing: Unexpected EOF inside skipped data',
+                'Error occurred during parsing',
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
   end
@@ -206,7 +206,7 @@ class ServiceTest < Minitest::Test
     assert_equal({
       "code" => 'malformed',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/json; strict=true: ' +
-                "Error occurred during parsing: No such field: fake",
+                "Error occurred during parsing: Error parsing JSON @1:20: No such field: fake",
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
   end
@@ -850,4 +850,3 @@ class ServiceTest < Minitest::Test
     end)
   end
 end
-

data/twirp.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'google-protobuf', '~> 3.0', '>= 3.7.0'
   spec.add_runtime_dependency 'faraday', '< 2' # for clients
 
-  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'minitest', '>= 5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rack', '>= 2.2.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -51,14 +51,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement