twirp 1.2.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 83302ec929694b2ac96f016518ad5585de1fa65e
-  data.tar.gz: c79097cde99163118952b003b1402332f83b8c7f
+SHA256:
+  metadata.gz: 764fa4b20e00cd8c88643863bdcbc7d51d35bc17e60aa53ab86c8eb35e61a761
+  data.tar.gz: 1a8c622d398aff28244a6a9c3bec6a6a74d22a8f5cf6c71e65273e06021c501b
 SHA512:
-  metadata.gz: ba357830275b3b4af11bc6f7319118a17a4405c338592ccb26293a0fed95622612b7f6d167214254eb6b0c05664d91f2ca5c847aeceb171e7c3dd0395f73d7ec
-  data.tar.gz: '05581b8cb43081e0e0103f6e3c50af6dfa0280b67355307418d287086e0c109e335bd0708f84eed4561eca7c288f1aa98884e71524a797ad07fe081a737efa3f'
+  metadata.gz: 521bdc421efb85856bfcab5ea2c9446d21072296cba21b007ec4f9015ec345ce14a166db5c8e078c8f754d61aaa9d19d039c96ab2b2a0d291c5768a4ef7dd5e8
+  data.tar.gz: db8f9343a888c4385cd4452a61020afc85664041f4e4b676e4b89220043ef03b2daddf8558435e71406c53d43f2ba38f9e0f40c1777c20e0d1ea73b47ad983b7

data/README.md

@@ -2,19 +2,21 @@
 
 [Twirp is a protocol](https://twitchtv.github.io/twirp/docs/spec_v5.html) for routing and serialization of services defined in a [.proto file](https://developers.google.com/protocol-buffers/docs/proto3), allowing easy implementation of RPC services with auto-generated clients in different languages.
 
-The [canonical implementation](https://github.com/twitchtv/twirp) is in Golang. The Twirp-Ruby project in this repository is the Ruby implementation.
+The [canonical implementation](https://github.com/twitchtv/twirp) is in Golang. The Twirp-Ruby project is the official implementation in Ruby for both server and clients.
 
 
 ## Install
 
 Add `gem "twirp"` to your Gemfile, or install with `gem install twirp`.
 
+To auto-generate Ruby code from a proto file, use the `protoc` plugin and the `--ruby_out` option ([see Wiki page](https://github.com/twitchtv/twirp-ruby/wiki/Code-Generation)).
+
 
 ## Documentation
 
-[Go to the Wiki](https://github.com/twitchtv/twirp-ruby/wiki).
+[On the wiki](https://github.com/twitchtv/twirp-ruby/wiki).
 
 
 ## Contributing
 
-[Go to the CONTRIBUTING file](CONTRIBUTING.md).
+[On the CONTRIBUTING file](CONTRIBUTING.md).

data/lib/twirp/error.rb

@@ -49,10 +49,10 @@ module Twirp
       ERROR_CODES_TO_HTTP_STATUS.key? code # one of the valid symbols
     end
 
-    # Use this constructors to ensure the errors have valid error codes. Example:
+    # Code constructors to ensure valid error codes. Example:
     #     Twirp::Error.internal("boom")
-    #     Twirp::Error.invalid_argument("foo is mandatory", argument: "foo")
-    #     Twirp::Error.permission_denied("thou shall not pass!", target: "Balrog")
+    #     Twirp::Error.invalid_argument("foo is mandatory", mymeta: "foobar")
+    #     Twirp::Error.permission_denied("Thou shall not pass!", target: "Balrog")
     ERROR_CODES.each do |code|
       define_singleton_method code do |msg, meta=nil|
         new(code, msg, meta)
@@ -62,7 +62,7 @@ module Twirp
     # Wrap another error as a Twirp::Error :internal.
     def self.internal_with(err)
       twerr = internal err.message, cause: err.class.name
-      twerr.cause = err
+      twerr.cause = err # availabe in error hook for inspection, but not in the response
       twerr
     end
 
@@ -80,6 +80,7 @@ module Twirp
       @meta = validate_meta(meta)
     end
 
+    # Key-value representation of the error. Can be directly serialized into JSON.
     def to_h
       h = {
         code: @code,

data/lib/twirp/service.rb

@@ -23,10 +23,19 @@ module Twirp
     extend ServiceDSL
 
     class << self
-      # Raise exceptions instead of handling them with exception_raised hooks.
+
+      # Whether to raise exceptions instead of handling them with exception_raised hooks.
       # Useful during tests to easily debug and catch unexpected exceptions.
-      # Default false.
-      attr_accessor :raise_exceptions
+      attr_accessor :raise_exceptions # Default: false
+
+      # Rack response with a Twirp::Error
+      def error_response(twerr)
+        status = Twirp::ERROR_CODES_TO_HTTP_STATUS[twerr.code]
+        headers = {'Content-Type' => Encoding::JSON} # Twirp errors are always JSON, even if the request was protobuf
+        resp_body = Encoding.encode_json(twerr.to_h)
+        [status, headers, [resp_body]]
+      end
+
     end
 
     def initialize(handler)
@@ -181,11 +190,7 @@ module Twirp
     def error_response(twerr, env)
       begin
         @on_error.each{|hook| hook.call(twerr, env) }
-
-        status = Twirp::ERROR_CODES_TO_HTTP_STATUS[twerr.code]
-        resp_body = Encoding.encode_json(twerr.to_h)
-        [status, error_response_headers, [resp_body]]
-
+        self.class.error_response(twerr)
       rescue => e
         return exception_response(e, env)
       end
@@ -193,6 +198,7 @@ module Twirp
 
     def exception_response(e, env)
       raise e if self.class.raise_exceptions
+
       begin
         @exception_raised.each{|hook| hook.call(e, env) }
       rescue => hook_e
@@ -200,13 +206,7 @@ module Twirp
       end
 
       twerr = Twirp::Error.internal_with(e)
-      resp_body = Encoding.encode_json(twerr.to_h)
-      [500, error_response_headers, [resp_body]]
-    end
-
-    def error_response_headers
-      # Twirp errors are always JSON, even if the request was protobuf
-      {'Content-Type' => Encoding::JSON}
+      self.class.error_response(twerr)
     end
 
   end

data/lib/twirp/version.rb

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

data/test/error_test.rb

@@ -3,7 +3,7 @@ require 'minitest/autorun'
 require_relative '../lib/twirp/error'
 
 class TestErrorCodes < Minitest::Test
-  
+
   def test_error_codes
     assert_equal 17, Twirp::ERROR_CODES.size
 
@@ -13,7 +13,7 @@ class TestErrorCodes < Minitest::Test
     end
 
     # check some codes
-    assert_includes Twirp::ERROR_CODES, :internal 
+    assert_includes Twirp::ERROR_CODES, :internal
     assert_includes Twirp::ERROR_CODES, :not_found
     assert_includes Twirp::ERROR_CODES, :invalid_argument
   end
@@ -52,7 +52,7 @@ class TestTwirpError < Minitest::Test
   end
 
   def test_invalid_constructor # Make sure that only supported codes are implemented (prevent bad metaprogramming)
-    assert_raises NoMethodError do 
+    assert_raises NoMethodError do
       Twirp::invalid_code_error "should fail"
     end
   end
@@ -67,7 +67,7 @@ class TestTwirpError < Minitest::Test
   def test_new_with_valid_metadata
     err = Twirp::Error.new(:internal, "woops", "meta" => "data", "for this" => "error")
     assert_equal "data", err.meta["meta"]
-    assert_equal "error", err.meta["for this"] 
+    assert_equal "error", err.meta["for this"]
     assert_nil err.meta["something else"]
 
     err = Twirp::Error.new(:internal, "woops", meta: "data")
@@ -78,11 +78,11 @@ class TestTwirpError < Minitest::Test
   def test_invalid_metadata
     Twirp::Error.new(:internal, "woops") # ensure the base case doesn't error
 
-    assert_raises ArgumentError do 
+    assert_raises ArgumentError do
       Twirp::Error.new(:internal, "woops", "string key" => :non_string_value)
     end
 
-    assert_raises ArgumentError do 
+    assert_raises ArgumentError do
       Twirp::Error.new(:internal, "woops", "valid key" => "valid val", "bad_one" => 666)
     end
   end
@@ -91,8 +91,8 @@ class TestTwirpError < Minitest::Test
     # returns a hash with attributes
     err = Twirp::Error.new(:internal, "err msg", "key" => "val")
     assert_equal({code: :internal, msg: "err msg", meta: {"key" => "val"}}, err.to_h)
-  
-    # skips meta if not included 
+
+    # skips meta if not included
     err = Twirp::Error.new(:internal, "err msg")
     assert_equal({code: :internal, msg: "err msg"}, err.to_h)
   end

data/test/service_test.rb

@@ -12,6 +12,15 @@ class ServiceTest < Minitest::Test
     Example::Haberdasher.raise_exceptions = true # configure for testing to make debugging easier
   end
 
+  # Class method to make a Rack response with a Twirp errpr
+  def test_service_error_response
+    twerr = Twirp::Error.invalid_argument('foo')
+    resp = Twirp::Service.error_response(twerr)
+    assert_equal 400, resp[0]
+    assert_equal 'application/json', resp[1]['Content-Type']
+    assert_equal '{"code":"invalid_argument","msg":"foo"}', resp[2][0]
+  end
+
   # The rpc DSL should properly build the base Twirp environment for each rpc method.
   def test_rpcs_accessor
     assert_equal 1, Example::Haberdasher.rpcs.size

data/twirp.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   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'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,28 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2019-12-31 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'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +87,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
 description: Twirp is a simple RPC framework with protobuf service definitions. The
   Twirp gem provides native support for Ruby.
 email:
@@ -134,15 +148,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Twirp services in Ruby.
 test_files:
-- test/client_json_test.rb
 - test/client_test.rb
 - test/error_test.rb
-- test/fake_services.rb
 - test/license_header_test.rb
+- test/fake_services.rb
 - test/service_test.rb
+- test/client_json_test.rb