twirp 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8d83ed2c83e7cebf51801f40168dc7605e9e5be
-  data.tar.gz: cb2ce6ebc8517f887dfc4db4015f612330b85b8b
+  metadata.gz: 18ad030c26be19ad5b9f8ed10be469b2f5387989
+  data.tar.gz: be7fbfb03aa836b315a100800da5906e3aed3b66
 SHA512:
-  metadata.gz: ca5336f98853c5b86a85e60f5757f6c259d43c9635092937e40edd5f77b2e7756e7f7144335a9b3bb4a8e17f2d00dbccbd6aff52703f24beddb2c58fb471d254
-  data.tar.gz: 20c0c0f7b52e6e6fb041cdc9ec818ea096ce52535df779969c979fe450036a31bcfff031c9e89df02372e9cdcbf9ee5d6b0809734c2e80795bb06134a712526a
+  metadata.gz: 0a5f2f6dd28b761a5516c55fc0f0a4d5707d0e5cc01564fd4b0dd7b8e520ff22ed580769e92dc9c65e13a6caaf5c7d2f44a7f1870e0bb1ac07e82dc6e372073a
+  data.tar.gz: f17cf86a2661244cf2833d5d8ddd626046093797cc61eae7a4419eeeb88807d921491a50d2c263120abf7cbb6fa720188cb9b6d141aee9af6a45400e68677782

data/lib/twirp/client.rb

@@ -36,11 +36,11 @@ module Twirp
         end
       end
 
-      # Hook for ServiceDSL#rpc to define a new method client.<ruby_method>(input, opts).
+      # Hook for ServiceDSL#rpc to define a new method client.<ruby_method>(input, req_opts).
       def rpc_define_method(rpcdef)
         unless method_defined? rpcdef[:ruby_method] # collision with existing rpc method
-          define_method rpcdef[:ruby_method] do |input|
-            rpc(rpcdef[:rpc_method], input)
+          define_method rpcdef[:ruby_method] do |input, req_opts=nil|
+            rpc(rpcdef[:rpc_method], input, req_opts)
           end
         end
       end
@@ -109,11 +109,17 @@ module Twirp
         status >= 300 && status <= 399
       end
 
-      def make_http_request(conn, service_full_name, rpc_method, content_type, body)
+      def make_http_request(conn, service_full_name, rpc_method, content_type, req_opts, body)
         conn.post do |r|
           r.url "#{service_full_name}/#{rpc_method}"
           r.headers['Content-Type'] = content_type
           r.body = body
+
+          if req_opts && req_opts[:headers]
+            req_opts[:headers].each do |k, v|
+              r.headers[k] = v
+            end
+          end
         end
       end
 
@@ -142,25 +148,27 @@ module Twirp
     # or the attributes (Hash) to instantiate it. Returns a ClientResp instance with an instance of
     # output_class, or a Twirp::Error. The input and output classes are the ones configued with the rpc DSL.
     # If rpc_method was not defined with the rpc DSL then a response with a bad_route error is returned instead.
-    def rpc(rpc_method, input)
+    def rpc(rpc_method, input, req_opts=nil)
       rpcdef = self.class.rpcs[rpc_method.to_s]
       if !rpcdef
         return ClientResp.new(nil, Twirp::Error.bad_route("rpc not defined on this client"))
       end
 
+      content_type = (req_opts && req_opts[:headers] && req_opts[:headers]['Content-Type']) || @content_type
+
       input = rpcdef[:input_class].new(input) if input.is_a? Hash
-      body = Encoding.encode(input, rpcdef[:input_class], @content_type)
+      body = Encoding.encode(input, rpcdef[:input_class], content_type)
 
-      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, @content_type, body)
+      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, content_type, req_opts, body)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end
 
-      if resp.headers['Content-Type'] != @content_type
-        return ClientResp.new(nil, Twirp::Error.internal("Expected response Content-Type #{@content_type.inspect} but found #{resp.headers['Content-Type'].inspect}"))
+      if resp.headers['Content-Type'] != content_type
+        return ClientResp.new(nil, Twirp::Error.internal("Expected response Content-Type #{content_type.inspect} but found #{resp.headers['Content-Type'].inspect}"))
       end
 
-      data = Encoding.decode(resp.body, rpcdef[:output_class], @content_type)
+      data = Encoding.decode(resp.body, rpcdef[:output_class], content_type)
       return ClientResp.new(data, nil)
     end
 

data/lib/twirp/client_json.rb

@@ -30,10 +30,10 @@ module Twirp
 
     # This implementation does not use the defined Protobuf messages to serialize/deserialize data;
     # the request attrs can be anything and the response data is always a plain Hash of attributes.
-    def rpc(rpc_method, attrs={})
+    def rpc(rpc_method, attrs={}, req_opts=nil)
       body = Encoding.encode_json(attrs)
 
-      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, Encoding::JSON, body)
+      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, Encoding::JSON, req_opts, body)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end

data/lib/twirp/version.rb

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

data/test/client_test.rb

@@ -72,6 +72,17 @@ class ClientTest < Minitest::Test
     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']
+      [200, protoheader, proto(Example::Hat, inches: 99, color: "red")]
+    })
+    resp = c.make_hat({}, headers: {"My-Foo-Header": "Bar"})
+    assert_nil resp.error
+    assert_equal 99, resp.data.inches
+    assert_equal "red", resp.data.color
+  end
+
   def test_proto_serialized_request_body_attrs
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       size = Example::Size.decode(req.body) # body is valid protobuf
@@ -185,6 +196,17 @@ class ClientTest < Minitest::Test
     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']
+      [200, jsonheader, '{"inches": 99, "color": "red"}']
+    }, content_type: "application/json")
+    resp = c.make_hat({}, headers: {"My-Foo-Header": "Bar"})
+    assert_nil resp.error
+    assert_equal 99, resp.data.inches
+    assert_equal "red", resp.data.color
+  end
+
   def test_json_serialized_request_body_attrs
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       assert_equal "application/json", req.request_headers['Content-Type']
@@ -246,6 +268,17 @@ class ClientTest < Minitest::Test
     assert_equal "out", resp.data.foo
   end
 
+  def test_rpc_send_headers
+    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
+      assert_equal "Bar", req.request_headers['My-Foo-Header']
+      [200, protoheader, proto(Foo, foo: "out")]
+    })
+    resp = c.rpc :Foo, {foo: "in"}, headers: {"My-Foo-Header": "Bar"}
+    assert_nil resp.error
+    refute_nil resp.data
+    assert_equal "out", resp.data.foo
+  end
+
   def test_rpc_error
     c = FooClient.new(conn_stub("/Foo/Foo") {|req|
       [400, {}, json(code: "invalid_argument", msg: "dont like empty")]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf