twirp 1.5.0 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '07397331bd18c688d70740c3ad5cec2401103a325bab3331dda34d3072223c89'
-  data.tar.gz: 684074c539bb00ddb32e814601378b6d3e0f967b48e8c758832a56a74ceba0a2
+  metadata.gz: 3f17d89c29073da7ebffa780c9e8577e10f2537e28900344d8a055e098aa5f3d
+  data.tar.gz: 2932fb1abec1db6b14c3b39e8b7d2f81e318c0bdc02639d83a99bdfacd26001f
 SHA512:
-  metadata.gz: '079722ee218b74194884e10383fc9ebb53febf02e215d7fa001c14c864e3c2eff9fddee8079c29e06396a766901efab7e696c14d9f9e0afd6df1034a10e5aa56'
-  data.tar.gz: d91d578d6cbd5245b38d5b1838892db43bc53730cdfb00391a1cad266d3193522625d87c3b5e2bfb0fc807bb90e6d1cd90063c95a139c5096ea4ef425106e2f7
+  metadata.gz: aca9edc089a15abfe4426880e8db8a8e2cac3f47ff056703e686dc14a3fe879a952a2b96c2de8bb06301b7406262601102c29fe48af6f9ead8775e9e2c76e35b
+  data.tar.gz: 10fc31c496e2fa4020ff9a643e08aa9ba333b0baa2324d1a42444ca6916d672a449eeef7ab22e674de81cc7a3e906d82fc97736714dfab29a999bfb4dd191f75

data/lib/twirp/client_json.rb

@@ -24,6 +24,7 @@ module Twirp
 
       package = opts[:package].to_s
       service = opts[:service].to_s
+      @strict = opts.fetch( :strict, false )
       raise ArgumentError.new("Missing option :service") if service.empty?
       @service_full_name = package.empty? ? service : "#{package}.#{service}"
     end
@@ -33,7 +34,8 @@ module Twirp
     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, req_opts, body)
+      encoding = @strict ? Encoding::JSON_STRICT : Encoding::JSON
+      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, encoding, req_opts, body)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end

data/lib/twirp/encoding.rb

@@ -17,13 +17,18 @@ module Twirp
 
   module Encoding
     JSON = "application/json"
+    # An opt-in content type useful when curling or manually testing a twirp
+    # service.  This will fail if unknown fields are encountered. The return
+    # content type will be application/json.
+    JSON_STRICT = "application/json; strict=true"
     PROTO = "application/protobuf"
 
     class << self
 
       def decode(bytes, msg_class, content_type)
         case content_type
-        when JSON  then msg_class.decode_json(bytes)
+        when JSON then msg_class.decode_json(bytes, ignore_unknown_fields: true)
+        when JSON_STRICT then msg_class.decode_json(bytes, ignore_unknown_fields: false)
         when PROTO then msg_class.decode(bytes)
         else raise ArgumentError.new("Invalid content_type")
         end
@@ -31,7 +36,7 @@ module Twirp
 
       def encode(msg_obj, msg_class, content_type)
         case content_type
-        when JSON  then msg_class.encode_json(msg_obj)
+        when JSON, JSON_STRICT then msg_class.encode_json(msg_obj, emit_defaults: true)
         when PROTO then msg_class.encode(msg_obj)
         else raise ArgumentError.new("Invalid content_type")
         end
@@ -46,7 +51,7 @@ module Twirp
       end
 
       def valid_content_type?(content_type)
-        content_type == JSON || content_type == PROTO
+        content_type == JSON || content_type == PROTO || content_type == JSON_STRICT
       end
 
       def valid_content_types

data/lib/twirp/error.rb

@@ -25,7 +25,7 @@ module Twirp
     already_exists:       409, # Conflict
     permission_denied:    403, # Forbidden
     unauthenticated:      401, # Unauthorized
-    resource_exhausted:   403, # Forbidden
+    resource_exhausted:   429, # Too Many Requests
     failed_precondition:  412, # Precondition Failed
     aborted:              409, # Conflict
     out_of_range:         400, # Bad Request

data/lib/twirp/version.rb

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

data/test/client_json_test.rb

@@ -29,6 +29,20 @@ class ClientJSONTest < Minitest::Test
     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']
+      assert_equal '{"blah1":1,"blah2":2}', req.body # body is json
+
+      [200, {}, '{"blah_resp": 3}']
+    }, package: "my.pkg", service: "Talking", strict: true)
+
+    resp = c.rpc :Blah, blah1: 1, blah2: 2
+    assert_nil resp.error
+    refute_nil resp.data
+    assert_equal 3, resp.data["blah_resp"]
+  end
+
   def test_client_json_error
     c = Twirp::ClientJSON.new(conn_stub("/Foo/Foomo") {|req|
       [400, {}, '{"code": "invalid_argument", "msg": "dont like empty"}']

data/test/service_test.rb

@@ -64,6 +64,24 @@ class ServiceTest < Minitest::Test
     assert_equal({"inches" => 10, "color" => "white"}, JSON.parse(body[0]))
   end
 
+  def test_successful_json_strict_request_emit_defaults
+    rack_env = json_strict_req "/example.Haberdasher/MakeHat", inches: 0 # default int value
+    status, headers, body = haberdasher_service.call(rack_env)
+
+    assert_equal 200, status
+    assert_equal 'application/json; strict=true', headers['Content-Type']
+    assert_equal({"inches" => 0, "color" => "white"}, JSON.parse(body[0]))
+  end
+
+  def test_successful_json_request_emit_defaults
+    rack_env = json_req "/example.Haberdasher/MakeHat", inches: 0 # default int value
+    status, headers, body = haberdasher_service.call(rack_env)
+
+    assert_equal 200, status
+    assert_equal 'application/json', headers['Content-Type']
+    assert_equal({"inches" => 0, "color" => "white"}, JSON.parse(body[0]))
+  end
+
   def test_successful_proto_request
     rack_env = proto_req "/example.Haberdasher/MakeHat", Example::Size.new(inches: 10)
     status, headers, body = haberdasher_service.call(rack_env)
@@ -170,6 +188,29 @@ class ServiceTest < Minitest::Test
     }, JSON.parse(body[0]))
   end
 
+  def test_json_request_ignores_unknown_fields
+    rack_env = json_req "/example.Haberdasher/MakeHat", inches: 10, fake: 3
+    status, headers, body = haberdasher_service.call(rack_env)
+
+    assert_equal 200, status
+    assert_equal 'application/json', headers['Content-Type']
+    assert_equal({"inches" => 10, "color" => "white"}, JSON.parse(body[0]))
+  end
+
+  def test_json_strict_request_fails_unknown_fields
+    rack_env = json_strict_req "/example.Haberdasher/MakeHat", inches: 10, fake: 3
+    status, headers, body = haberdasher_service.call(rack_env)
+
+    assert_equal 400, status
+    assert_equal 'application/json', headers['Content-Type']
+    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",
+      "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
+    }, JSON.parse(body[0]))
+  end
+
   def test_bad_route_triggers_on_error_hooks
     svc = haberdasher_service
 
@@ -791,6 +832,12 @@ class ServiceTest < Minitest::Test
       "CONTENT_TYPE" => "application/json"
   end
 
+  def json_strict_req(path, attrs)
+    Rack::MockRequest.env_for path, method: "POST",
+      input: JSON.generate(attrs),
+      "CONTENT_TYPE" => "application/json; strict=true"
+  end
+
   def proto_req(path, proto_message)
     Rack::MockRequest.env_for path, method: "POST",
       input: proto_message.class.encode(proto_message),

data/twirp.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 1.9'
-  spec.add_runtime_dependency 'google-protobuf', '~> 3.0', '>= 3.0.0'
+  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 'minitest', '>= 5'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rack', '>= 2.0.8'
+  spec.add_development_dependency 'rack', '>= 2.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.2
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,28 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.8
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.8
+        version: 2.2.3
 description: Twirp is a simple RPC framework with protobuf service definitions. The
   Twirp gem provides native support for Ruby.
 email: