twirp-on-rails 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97395472e03e70358a2a271d158f7661df878b3b9ada26d79b220975065d4b35
-  data.tar.gz: b4188b09886154375a8f7e931d4d363c27bdf40a000044e73960e92266ccf2b1
+  metadata.gz: 308f1b4a611dd3496ffa026dae81410bffedffb0a2330ef009c4090b2ce71c24
+  data.tar.gz: dcfba3e14253882f6b7ba0943a89876789fb0d8e68015e397c6143e5417f7d35
 SHA512:
-  metadata.gz: '0729dc21f25c3c40eda3fb080a70a67c67d3864a3be85a740e27b9e41e2d9d8548ccec114ebe42b923f240a33234090111ea00ce00dfa8729ecf43c546707002'
-  data.tar.gz: 2d4d1bc20c93b7860356d431520ef7e5468ab3b1c45134ea63100bee64bf204517aefa768940c1429f105baadb8bf23eaa616e5e0d6b37cda8d8f1cf8cbdcd49
+  metadata.gz: 140d92258a215e8de86f641a39aeb7cf6e07034ee3c15e9ae187ed9a8f7d1d45d360a7240ecdc0599069dbe63558de7f2ba9ce15ecf7d7c538968bd96f784596
+  data.tar.gz: 3dcfdf03ddab84f16a8b8a052439b22e982456a7076c2ac54d2580244c16846b17cf70709a72bfa4a0be42743f139624bf338a97ff454d9fba83455be77eef90

data/.standard.yml

@@ -2,3 +2,6 @@ ruby_version: 2.7
 plugins:
   - standard-performance
   - standard-rails
+ignore:
+  - '**/*_pb.rb'
+  - '**/*_twirp.rb' 

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+
+## [1.2.0] - 2024-10-04
+
+- Support rescue_from in handlers.
+
+## [1.1.0] - 2024-09-12
+
+- Respect package namespace when looking for handlers.
+
 ## [0.1.0] - 2022-12-23
 
 - Initial release

data/Gemfile

@@ -10,6 +10,6 @@ gem "rake"
 gem "debug"
 gem "rspec-rails"
 gem "sqlite3", "~> 1.4"
-gem "standard"
+gem "standard", ">= 1.35.1"
 gem "standard-performance"
 gem "standard-rails"

data/README.md

@@ -86,12 +86,47 @@ end
 
 Each handler method should return the appropriate Protobuf, or a `Twirp::Error`.
 
-TODO: Give more examples of both
+#### Packages and Namespacing
+
+Handlers can live in directories that reflect the service's package. For example, `haberdasher.proto` defines:
+
+```protobuf
+package twirp.example.haberdasher;
+```
+
+You can use the full path, or because many projects have only one namespace, we also let you skip the namespace for simplicity:
+
+We look for the handler in either location:
+
+`app/handlers/twirp/example/haberdasher/haberdasher_service_handler.rb` defines `Twirp::Example::Haberdasher::HaberdasherServiceHandler`
+
+or
+
+`app/handlers/haberdasher_service_handler.rb` defines `HaberdasherServiceHandler`
+
+
+TODO: Give more examples of handlers
 
 ### Familiar Callbacks
 
 Use `before_action`, `around_action`, and other callbacks you're used to, as we build on [AbstractController::Callbacks](https://api.rubyonrails.org/classes/AbstractController/Callbacks.html).
 
+### rescue_from
+
+Use `rescue_from` just like you would in a controller: 
+
+```ruby
+class HaberdasherServiceHandler < Twirp::Rails::Handler
+  rescue_from "ArgumentError" do |error|
+    Twirp::Error.invalid_argument(error.message)
+  end
+
+  rescue_from "Pundit::NotAuthorizedError", :not_authorized
+
+  ...
+end
+```
+
 ### DRY Service Hooks
 
 Apply [Service Hooks](https://github.com/twitchtv/twirp-ruby/wiki/Service-Hooks) one time across multiple services.

data/lib/twirp/rails/dispatcher.rb

@@ -4,7 +4,13 @@ module Twirp
   module Rails
     class Dispatcher
       def initialize(service_class)
-        @service_handler = "#{service_class.service_name}Handler".constantize
+        # Check for a handler in the service's namespace, or in the root namespace
+        # e.g. Twirp::Example::Cobbler::CobblerHandler or ::CobblerHandler
+        @service_handler = if Object.const_defined?("#{service_class.module_parent}::#{service_class.service_name}Handler")
+          "#{service_class.module_parent}::#{service_class.service_name}Handler".constantize
+        else
+          "#{service_class.service_name}Handler".constantize
+        end
       end
 
       def respond_to_missing?(method, *)

data/lib/twirp/rails/handler.rb

@@ -4,6 +4,8 @@ module Twirp
   module Rails
     class Handler
       include Twirp::Rails::Callbacks
+      include ActiveSupport::Rescuable
+      using Twirp::Rails::Rescuable
 
       attr_reader :request, :env
       attr_reader :action_name
@@ -34,7 +36,11 @@ module Twirp
         ActiveSupport::Notifications.instrument("handler_run_callbacks.twirp_rails", handler: self.class.name, action: action_name, env: @env, request: @request) do
           run_callbacks(:process_action) do
             ActiveSupport::Notifications.instrument("handler_run.twirp_rails", handler: self.class.name, action: action_name, env: @env, request: @request) do |payload|
-              payload[:response] = send_action(name)
+              payload[:response] = begin
+                send_action(name)
+              rescue => exception
+                rescue_with_handler_and_return(exception) || raise
+              end
             end
           end
         end

data/lib/twirp/rails/rescuable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Twirp
+  module Rails
+    module Rescuable
+      refine ::ActiveSupport::Rescuable::ClassMethods do
+        # A slightly altered version of ActiveSupport::Rescuable#rescue_with_handler
+        # that returns the result rather than the handled exception
+        def rescue_with_handler_and_return(exception, object: self, visited_exceptions: [])
+          visited_exceptions << exception
+
+          if (handler = handler_for_rescue(exception, object: object))
+            handler.call exception
+          elsif exception
+            if visited_exceptions.include?(exception.cause)
+              nil
+            else
+              rescue_with_handler(exception.cause, object: object, visited_exceptions: visited_exceptions)
+            end
+          end
+        end
+      end
+
+      refine ::ActiveSupport::Rescuable do
+        def rescue_with_handler_and_return(exception)
+          self.class.rescue_with_handler_and_return exception, object: self
+        end
+      end
+    end
+  end
+end

data/lib/twirp/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Twirp
   module Rails
-    VERSION = "1.0.1"
+    VERSION = "1.2.0"
   end
 end

data/lib/twirp/rails.rb

@@ -15,6 +15,7 @@ require_relative "rails/callbacks"
 require_relative "rails/configuration"
 require_relative "rails/dispatcher"
 require_relative "rails/engine"
+require_relative "rails/rescuable"
 require_relative "rails/handler"
 
 module Twirp

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Morrison
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-20 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,6 +63,7 @@ files:
 - lib/twirp/rails/engine.rb
 - lib/twirp/rails/handler.rb
 - lib/twirp/rails/rack/conditional_post.rb
+- lib/twirp/rails/rescuable.rb
 - lib/twirp/rails/version.rb
 - sig/twirp/rails.rbs
 - twirp-rails.gemspec
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Use Twirp RPC with Rails