twirp 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 764fa4b20e00cd8c88643863bdcbc7d51d35bc17e60aa53ab86c8eb35e61a761
-  data.tar.gz: 1a8c622d398aff28244a6a9c3bec6a6a74d22a8f5cf6c71e65273e06021c501b
+  metadata.gz: '07397331bd18c688d70740c3ad5cec2401103a325bab3331dda34d3072223c89'
+  data.tar.gz: 684074c539bb00ddb32e814601378b6d3e0f967b48e8c758832a56a74ceba0a2
 SHA512:
-  metadata.gz: 521bdc421efb85856bfcab5ea2c9446d21072296cba21b007ec4f9015ec345ce14a166db5c8e078c8f754d61aaa9d19d039c96ab2b2a0d291c5768a4ef7dd5e8
-  data.tar.gz: db8f9343a888c4385cd4452a61020afc85664041f4e4b676e4b89220043ef03b2daddf8558435e71406c53d43f2ba38f9e0f40c1777c20e0d1ea73b47ad983b7
+  metadata.gz: '079722ee218b74194884e10383fc9ebb53febf02e215d7fa001c14c864e3c2eff9fddee8079c29e06396a766901efab7e696c14d9f9e0afd6df1034a10e5aa56'
+  data.tar.gz: d91d578d6cbd5245b38d5b1838892db43bc53730cdfb00391a1cad266d3193522625d87c3b5e2bfb0fc807bb90e6d1cd90063c95a139c5096ea4ef425106e2f7

data/lib/twirp/error.rb

@@ -16,9 +16,10 @@ module Twirp
   # Valid Twirp error codes and their mapping to related HTTP status.
   # This can also be used to check if a code is valid (check if not nil).
   ERROR_CODES_TO_HTTP_STATUS = {
-    canceled:             408, # RequestTimeout
-    invalid_argument:     400, # BadRequest
-    deadline_exceeded:    408, # RequestTimeout
+    canceled:             408, # Request Timeout
+    invalid_argument:     400, # Bad Request
+    malformed:            400, # Bad Request
+    deadline_exceeded:    408, # Request Timeout
     not_found:            404, # Not Found
     bad_route:            404, # Not Found
     already_exists:       409, # Conflict

data/lib/twirp/service.rb

@@ -107,29 +107,30 @@ module Twirp
   private
 
     # Parse request and fill env with rpc data.
-    # Returns a bad_route error if something went wrong.
+    # Returns a bad_route error if could not be properly routed to a Twirp method.
+    # Returns a malformed error if could not decode the body (either bad JSON or bad Protobuf)
     def route_request(rack_env, env)
       rack_request = Rack::Request.new(rack_env)
 
       if rack_request.request_method != "POST"
-        return bad_route_error("HTTP request method must be POST", rack_request)
+        return route_err(:bad_route, "HTTP request method must be POST", rack_request)
       end
 
       content_type = rack_request.get_header("CONTENT_TYPE")
       if !Encoding.valid_content_type?(content_type)
-        return bad_route_error("Unexpected Content-Type: #{content_type.inspect}. Content-Type header must be one of #{Encoding.valid_content_types.inspect}", rack_request)
+        return route_err(:bad_route, "Unexpected Content-Type: #{content_type.inspect}. Content-Type header must be one of #{Encoding.valid_content_types.inspect}", rack_request)
       end
       env[:content_type] = content_type
 
       path_parts = rack_request.fullpath.split("/")
       if path_parts.size < 3 || path_parts[-2] != self.full_name
-        return bad_route_error("Invalid route. Expected format: POST {BaseURL}/#{self.full_name}/{Method}", rack_request)
+        return route_err(:bad_route, "Invalid route. Expected format: POST {BaseURL}/#{self.full_name}/{Method}", rack_request)
       end
       method_name = path_parts[-1]
 
       base_env = self.class.rpcs[method_name]
       if !base_env
-        return bad_route_error("Invalid rpc method #{method_name.inspect}", rack_request)
+        return route_err(:bad_route, "Invalid rpc method #{method_name.inspect}", rack_request)
       end
       env.merge!(base_env) # :rpc_method, :input_class, :output_class
 
@@ -141,7 +142,7 @@ module Twirp
         if e.is_a?(Google::Protobuf::ParseError)
           error_msg += ": #{e.message.strip}"
         end
-        return bad_route_error(error_msg, rack_request)
+        return route_err(:malformed, error_msg, rack_request)
       end
 
       env[:input] = input
@@ -149,12 +150,11 @@ module Twirp
       return
     end
 
-    def bad_route_error(msg, req)
-      Twirp::Error.bad_route msg, twirp_invalid_route: "#{req.request_method} #{req.fullpath}"
+    def route_err(code, msg, req)
+      Twirp::Error.new code, msg, twirp_invalid_route: "#{req.request_method} #{req.fullpath}"
     end
 
 
-
     # Call handler method and return a Protobuf Message or a Twirp::Error.
     def call_handler(env)
       m = env[:ruby_method]

data/lib/twirp/version.rb

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

data/test/error_test.rb

@@ -5,7 +5,7 @@ require_relative '../lib/twirp/error'
 class TestErrorCodes < Minitest::Test
 
   def test_error_codes
-    assert_equal 17, Twirp::ERROR_CODES.size
+    assert_equal 18, Twirp::ERROR_CODES.size
 
     # all codes should be symbols
     Twirp::ERROR_CODES.each do |code|
@@ -19,7 +19,7 @@ class TestErrorCodes < Minitest::Test
   end
 
   def test_codes_to_http_status
-    assert_equal 17, Twirp::ERROR_CODES_TO_HTTP_STATUS.size
+    assert_equal 18, Twirp::ERROR_CODES_TO_HTTP_STATUS.size
 
     assert_equal 404, Twirp::ERROR_CODES_TO_HTTP_STATUS[:not_found]
     assert_equal 500, Twirp::ERROR_CODES_TO_HTTP_STATUS[:internal]

data/test/service_test.rb

@@ -145,10 +145,10 @@ class ServiceTest < Minitest::Test
       method: "POST", input: 'bad json', "CONTENT_TYPE" => "application/json"
     status, headers, body = haberdasher_service.call(rack_env)
 
-    assert_equal 404, status
+    assert_equal 400, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route',
+      "code" => 'malformed',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/json: ' +
                 "Error occurred during parsing: Parse error at 'bad json'",
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
@@ -160,10 +160,10 @@ class ServiceTest < Minitest::Test
       method: "POST", input: 'bad protobuf', "CONTENT_TYPE" => "application/protobuf"
     status, headers, body = haberdasher_service.call(rack_env)
 
-    assert_equal 404, status
+    assert_equal 400, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route',
+      "code" => 'malformed',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/protobuf: ' +
                 'Error occurred during parsing: Unexpected EOF inside skipped data',
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},

data/twirp.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9'
   spec.add_runtime_dependency 'google-protobuf', '~> 3.0', '>= 3.0.0'
-  spec.add_runtime_dependency 'faraday', '~> 0' # for clients
+  spec.add_runtime_dependency 'faraday', '< 2' # for clients
 
   spec.add_development_dependency 'bundler', '~> 1'
   spec.add_development_dependency 'minitest', '>= 5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -35,16 +35,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement