twirp_rails 0.4.1 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7fbba3b1fe02ffed0c06b8a421f52577aab8634e0c3628c079721415c22df56
-  data.tar.gz: 25ab97b4b24fd79ea5c338bbef35f124e082c3ce34a9588b0d66658858936f77
+  metadata.gz: 81fc1779265896c8e94b3e133dcb859f9cb88b8c50b243887ba40894ccfb5840
+  data.tar.gz: 481e078b49b5ffce44787f011e8702919efc0c6c1e657c14dd13e13d08065b78
 SHA512:
-  metadata.gz: 11e6b0f20cfc055c2b0d89b06e7a79011b3ca28b5d0f4456d8872b62c67e6c22e8ca50728f6d1c3700fbf8c6bc04b5bcef0245c37392eb3f687b1329603446d2
-  data.tar.gz: 2ee3fb02db058cea267475e4e872cc5049f732a3877a4454677ff9b4cbf9445f2c83b00fc654fae274f8994d822cdefdabb2656c178c886070ccd9ef02fd29fb
+  metadata.gz: 13fd0e6576cb5189487ffe8cfd48c7443faaf4ab94bfdb9c7500d2d7104ddf3cab9a4a0f74acce5e80616c6e998c3b757c75ece1fb0e62d59b3c6fc5ff71afa4
+  data.tar.gz: 281573e3920d9c57f7089ac0b2d5fdf418c70a30de16845ea6ec719b1d7753fac00862022523262abff254e086f60be4f09d97aa1bce38d36a09bf0c266a7d53

data/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.4.4 - 2020-05-05
+
+### Added
+
+- ability to translate twirp errors to exceptions and vise versa.
+
+## 0.4.3 - 2020-04-14
+
+### Fixed
+
+- autorequire all ruby files from `lib/twirp_clients` folder.
+
+## 0.4.2 - 2020-04-01
+
+### Added
+
+- `to_twirp` extension use model method unless attribute found 
+
 ## 0.4.1 - 2020-03-30
 
 ### Added

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.4.1)
+    twirp_rails (0.4.5)
       railties (~> 6.0)
       twirp (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.2.1)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     builder (3.2.4)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     crass (1.0.6)
     diff-lcs (1.3)
     erubi (1.9.0)
@@ -38,22 +38,22 @@ GEM
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    google-protobuf (3.11.4-universal-darwin)
+    google-protobuf (3.12.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    loofah (2.4.0)
+    loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multipart-post (2.1.1)
-    nokogiri (1.10.8)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.1.1)
+    rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -61,13 +61,13 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -91,12 +91,12 @@ GEM
     rspec-support (3.9.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    twirp (1.4.1)
-      faraday (~> 0)
+    twirp (1.5.0)
+      faraday (< 2)
       google-protobuf (~> 3.0, >= 3.0.0)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -105,7 +105,7 @@ DEPENDENCIES
   bundler (~> 1.17)
   generator_spec (~> 0.9)
   pry (~> 0.12)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec-rails (~> 3.0)
   twirp_rails!

data/README.md

@@ -9,6 +9,7 @@ TwirpRails helps to use [twirp-ruby gem](https://github.com/twitchtv/twirp-ruby)
  * `mount_twirp` route helper to mount handlers
  * `rpc` helper to dry your handlers specs
  * ability to log twirp calls by Rails logger
+ * DSL to translate handler exceptions to twirp errors and client twirp errors to ruby exceptions 
 
 ## Installation
 
@@ -151,6 +152,53 @@ generated by
 $ rails g twirp:init
 ```
 
+## Exception handling
+
+Translate handler exceptions to twirp errors and client twirp errors to ruby exceptions.
+
+This feature allow to use ruby style exception handling flow in ruby code.
+
+Create class to describe translate error rules
+```ruby
+  class ErrorTranslator < TwirpRails::ErrorHandling::Base
+    # rules to translate exception raised by handler to twirp
+    translate_exception ArgumentError, with: :invalid_argument
+    translate_exception ActiveRecord::NotFound do |exception, handler|
+      Twirp::Error.not_found
+    end
+    
+    # rules to translate twirp errors returned from client to exception
+    translate_error :invalid_argument, with: ArgumentError
+    translate_error :not_found do |error, client|
+      ActiveRecord::NotFound.new(error.msg)
+    end
+  end
+``` 
+
+And configure TwirpRails to use it:
+```ruby
+# config/initializers/twirp_ruby.rb
+# ...
+  config.twirp_exception_translator_class = 'ErrorTranslator' 
+# ... 
+```
+
+Services mounted by ```mount_twirp``` translates raised exception to twirp errors by this rules.
+
+To raise errors by clients, you should create client by `TwirpRails.client`
+
+```ruby
+client = TwirpRails.client(PeopleClient, 'http://localhost:3000/twirp')
+
+client.get_name(uid: 'not found').error 
+# Twirp::Error code:not_found msg:"Couldn't find User with 'uid'='not found'"
+client.get_name(uid: 'not found').data.name # NoMethodError: undefined method `name' for nil:NilClass
+
+# use bang method to raise translated error and didn't check each twirp call result error
+client.get_name!(uid: 'not found').data.name # ActiveRecord::NotFound: undefined method `name' for nil:NilClass
+``` 
+
+
 ## API acronym
 
 Gem adds inflector acronym `API` to correct using services with suffix `API`. 

data/lib/twirp_rails.rb

@@ -5,6 +5,7 @@ require 'twirp_rails/engine'
 require 'twirp_rails/generators/generators'
 require 'twirp_rails/active_record_extension'
 require 'twirp_rails/log_subscriber'
+require 'twirp_rails/error_handling/error_handling'
 
 module TwirpRails
   class Error < StandardError; end
@@ -61,6 +62,8 @@ module TwirpRails
     config_param :purge_old_twirp_code, true
 
     config_param :add_api_acronym, true
+
+    config_param :twirp_exception_translator_class, nil
   end
 
   def self.configuration
@@ -119,4 +122,21 @@ module TwirpRails
 
     Time.zone.at seconds
   end
+
+  # Utility for converting a Ruby Time instance to a
+  # Google::Protobuf::Timestamp.
+  #
+  # @param time [Time] The Time to be converted.
+  #
+  # @return [Google::Protobuf::Timestamp] The converted
+  #   Google::Protobuf::Timestamp.
+  def self.time_to_timestamp(time)
+    Google::Protobuf::Timestamp.new(seconds: time.to_i, nanos: time.nsec)
+  end
+
+  def self.client(klass, url)
+    client = klass.new(url)
+
+    TwirpRails::ErrorHandling.wrap_client(client)
+  end
 end

data/lib/twirp_rails/active_record_extension.rb

@@ -26,29 +26,32 @@ module TwirpRails
     # used by relation method to_twirp
     # @param [Array|Class] fields_or_class - array of converted fields or message class to
     def to_twirp(*fields_or_class)
-      fields = fields_or_class
-      result = attributes
-
-      if fields.empty? && self.class.twirp_message_class
-        fields = [self.class.twirp_message_class]
+      if fields_or_class.empty? && self.class.twirp_message_class
+        to_twirp_as_class(self.class.twirp_message_class)
+      elsif fields_or_class.one? && fields_or_class.first.is_a?(Class)
+        to_twirp_as_class(fields_or_class.first)
+      elsif fields_or_class.any?
+        to_twirp_as_fields(fields_or_class)
+      else
+        attributes
       end
+    end
 
-      if fields.one? && fields.first.is_a?(Class)
-        message_class = fields.first
+    private
 
-        unless message_class.respond_to?(:descriptor)
-          raise "Class #{message_class} must me a protobuf message class"
-        end
+    def to_twirp_as_class(klass)
+      unless klass.respond_to?(:descriptor)
+        raise "Class #{klass} must be a protobuf message class"
+      end
 
-        # TODO performance optimization needed
-        fields = message_class.descriptor.map &:name
+      # TODO performance optimization needed
+      to_twirp_as_fields(klass.descriptor.map &:name)
+    end
 
-        result = result.slice(*fields)
-      elsif fields.any?
-        result = result.slice(*fields)
+    def to_twirp_as_fields(fields)
+      fields.each_with_object({}) do |field, h|
+        h[field] = attributes.fetch(field) { public_send(field) }
       end
-
-      result
     end
   end
 end

data/lib/twirp_rails/error_handling/base.rb

@@ -0,0 +1,114 @@
+require 'twirp'
+
+module TwirpRails
+  module ErrorHandling
+    class Base
+      ExceptionHandler = Struct.new(:exception, :proc) do
+        def match?(exception)
+          exception.is_a?(self.exception)
+        end
+
+        def handle(exception, handler)
+          proc.call(exception, handler)
+        end
+
+        def process(exception, handler)
+          match?(exception) ? handle(exception, handler) : nil
+        end
+      end
+
+      ErrorHandler = Struct.new(:code, :proc) do
+        def match?(error)
+          error.code == self.code
+        end
+
+        def handle(error, client)
+          proc.call(error, client)
+        end
+
+        def process(error, client)
+          match?(error) ? handle(error, client) : nil
+        end
+      end
+
+      class << self
+        # translate_exception InvalidArgument, :invalid_argument
+        #
+        # translate_exception StandardError { |exception, service| Twirp::Error.internal_with exception }
+        def translate_exception(*exceptions, with: nil, &block)
+          raise 'unexpected with and block' if block_given? && with
+          raise 'with or block must be defined' unless block_given? || with
+
+
+          proc = if with
+                   raise "invalid twirp code #{with}" unless ::Twirp::ERROR_CODES.include?(with)
+
+                   proc do |exception, _service|
+                     ::Twirp::Error.new(with, exception.message).tap { |t| t.cause = exception }
+                   end
+                 else
+                   proc { |exception, service| block.call(exception, service) }
+                 end
+
+          exceptions.each do |exception|
+            exception_handlers << ExceptionHandler.new(exception, proc)
+          end
+        end
+
+        # translate_error :invalid_argument, InvalidArgument
+        #
+        # translate_error :internal_error { |error, client| StandardError.new(error.msg) }
+        def translate_error(*codes, with: nil, &block)
+          raise 'unexpected with and block' if block_given? && with.nil?
+          raise 'with or block must be defined' unless block_given? || !with.nil?
+          raise "invalid twirp code(s) #{codes - ::Twirp::ERROR_CODES}" if (codes - ::Twirp::ERROR_CODES).any?
+
+          proc = if with
+                   raise 'with should be a exception class' unless with.is_a?(Class)
+
+                   proc { |error, _client| with.new error.msg }
+                 else
+                   proc { |error, client| block.call(error, client) }
+                 end
+
+          codes.each do |code|
+            error_handlers << ErrorHandler.new(code, proc)
+          end
+        end
+
+        def exception_handlers
+          @exception_handlers ||= []
+        end
+
+        def error_handlers
+          @error_handlers ||= []
+        end
+
+        def exception_to_twirp(exception, handler)
+          result = nil
+
+          exception_handlers.take_while do |exception_handler|
+            result = exception_handler.process(exception, handler)
+
+            result.nil?
+          end
+
+          result || ::Twirp::Error.internal_with(exception)
+        end
+
+        def twirp_to_exception(error, client)
+          result = nil
+
+          error_handlers.take_while do |handler|
+            result = handler.process(error, client)
+
+            result.nil?
+          end
+
+          result || StandardError.new(error.msg)
+        end
+      end
+    end
+  end
+end
+

data/lib/twirp_rails/error_handling/error_handling.rb

@@ -0,0 +1,2 @@
+require 'twirp_rails/error_handling/base'
+require 'twirp_rails/error_handling/error_handling_factory'

data/lib/twirp_rails/error_handling/error_handling_factory.rb

@@ -0,0 +1,82 @@
+module TwirpRails
+  class ErrorHandlingFactory
+    class HandlerProxy
+      attr_reader :handler, :translator_class
+
+      def initialize(handler, translator_class)
+        @handler = handler
+        @translator_class = translator_class
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method, *args)
+        handler.public_send method, *args
+      rescue => e
+        translator_class.exception_to_twirp(e, handler)
+      end
+      # rubocop:enable Style/MethodMissingSuper
+
+      def respond_to_missing?(method, include_all = false)
+        handler.respond_to?(method, include_all)
+      end
+    end
+
+    class ClientProxy
+      attr_reader :client, :translator_class
+
+      def initialize(client, translator_class)
+        @client = client
+        @translator_class = translator_class
+      end
+
+      def raise_on_error(twirp_result)
+        if twirp_result.error
+          exception = translator_class.twirp_to_exception(twirp_result.error)
+          raise exception
+        else
+          twirp_result
+        end
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method, *args)
+        if method =~ /!$/
+          # when we call a bang version of client method - raise exception translated from error
+          method = method[0..-2]
+          raise_on_error client.public_send(method, args)
+        else
+          client.public_send method, args
+        end
+      end
+      # rubocop:enable Style/MethodMissingSuper
+
+      def respond_to_missing?(method, include_all = false)
+        handler.respond_to?(method, include_all)
+      end
+    end
+
+    class << self
+      attr_reader :translator_class
+
+      def wrap_handler(handler)
+        enable_handling? ? HandlerProxy.new(handler, translator_class) : handler
+      end
+
+      def wrap_client(client)
+        enable_handling? ? ClientProxy.new(client, translator_class) : client
+      end
+
+      def enable_handling?
+        if @enable_handling.nil?
+          if (@translator_class = TwirpRails.configuration.twirp_exception_translator_class)
+            @translator_class = @translator_class.constantize unless @translator_class.is_a?(Class)
+            @enable_handling = true
+          else
+            @enable_handling = false
+          end
+        end
+        @enable_handling
+      end
+    end
+  end
+end

data/lib/twirp_rails/generators/twirp/init/templates/twirp_rails.rb

@@ -25,4 +25,18 @@ TwirpRails.configure do |config|
   #
   # Add API acronym to inflector
   # config.add_api_acronym = true
+  #
+  # Translate exceptions to Twirp::Error on services and
+  # Twirp::Error to exceptions. To use service translation you
+  # should mount service via mount_twirp. To use client translation
+  # create client via TwirpRails.client(ClientClass, url) and
+  # call bang methods. E.g. client.hello! throws exception if returns error.
+  #
+  # class SampleTranslator < TwirpRails::ErrorHandling::Base
+  #   translate_exception Mongoid::Errors::DocumentNotFound, with: :not_found
+  #   translate_error :not_found, with: Mongoid::Errors::DocumentNotFound
+  # end
+  # config.twirp_exception_translator_class = 'SampleTranslator'
+  # default:
+  # config.twirp_exception_translator_class = nil
 end

data/lib/twirp_rails/routes.rb

@@ -25,7 +25,7 @@ module TwirpRails
             raise 'twirp service name required'
           end
 
-          service = service_class.new(handler.new)
+          service = service_class.new(ErrorHandlingFactory.wrap_handler(handler.new))
           Helper.run_create_hooks service
 
           if scope

data/lib/twirp_rails/rspec/helper.rb

@@ -65,7 +65,7 @@ module TwirpRails
       end
 
       included do
-        let(:handler) { described_class.new }
+        let(:handler) { TwirpRails::ErrorHandlingFactory.wrap_handler(described_class.new) }
         let(:service) { service_class.new(handler) }
       end
     end

data/lib/twirp_rails/twirp.rb

@@ -4,7 +4,7 @@ module TwirpRails
       # protoc generates require without path in a _pb files
       $LOAD_PATH.unshift(twirp_path) unless $LOAD_PATH.include?(twirp_path)
 
-      Dir.glob(Rails.root.join('lib/twirp/**/*_twirp.rb')).sort.each do |file|
+      Dir.glob(Rails.root.join(twirp_path, '**/*_twirp.rb')).sort.each do |file|
         require file
       end
     end

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.6'.freeze
 end

data/twirp_rails.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'railties', '~> 6.0'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-rails', '~> 3.0'
   spec.add_development_dependency 'generator_spec', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.6
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,9 @@ files:
 - lib/twirp_rails.rb
 - lib/twirp_rails/active_record_extension.rb
 - lib/twirp_rails/engine.rb
+- lib/twirp_rails/error_handling/base.rb
+- lib/twirp_rails/error_handling/error_handling.rb
+- lib/twirp_rails/error_handling/error_handling_factory.rb
 - lib/twirp_rails/generators/generators.rb
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/clients/USAGE
@@ -179,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Use twirp-ruby from rails.