twirp_rails 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a92255521f3ac2df3ae47a597caa01c1815a03c60a5ab0b7e8d459162a32dd9
-  data.tar.gz: 7c6bc605775f5bbf1fafa1292bd116be996ab536a602335bc83c0b43cdedf529
+  metadata.gz: b29d60d23232039677f98e1adc290f50536ceba50a1175ff133739100c04321f
+  data.tar.gz: 25583997b7634a2ee6028b2faa3de4a7ad8d2ba5a9cd4973ec8f54805b0e07d0
 SHA512:
-  metadata.gz: b515cb51dd041ded6089f55fde625cc8b52c23b3526179a102ef4145e6c12f38953c052cdf5fbc987fe0c177acc938fc959128d8f1cab5dc87ef8ac6800118fb
-  data.tar.gz: 12b4c238b0ce754a205b84d49f00fb3edef603fe0152a49bc08d6b565886f59cc46932c6808824bbd9e678aeb00e22b45197ef1757b394de22827c2c36104ee2
+  metadata.gz: eea47f4d6fcd5b910a5d3a6b7803946cd971a6e357fc530e5aebc5ceb0b6eee5a385513c1ff1aa78e52ec32f6aa6acb561176c908d37faa0ef3467a1d7dc2110
+  data.tar.gz: 25d5c11dbba73159d0a08b30706e9d880ef1d92a81f8c4ce1183d810e83ba2b5be7ef21b316f64ebabc05cec1c646048c20122194ac7ba632f83184edc81ca18

data/CHANGELOG.md

@@ -4,6 +4,19 @@ 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.2.0 - 2020-02-21
+
+### Breaking changes
+- `mount_twirp` now (by default) mounts to path /twirp/Service instead of /Service. If you want to use old 
+behavior add `scope: nil` argument.
+
+### Added
+- Services mounted by `mount_twirp` now correctly report errors to `Raven` (if `raven` gem used) and instrument
+calls via `ActiveSupport::Notifications`.
+
+### Changed
+- initial install rspec helper code moved to the ```twirp:rspec``` generator.
+
 ## 0.1.7 - 2020-02-11
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.1.7)
+    twirp_rails (0.2.0)
       railties (~> 6.0)
       twirp (~> 1)
 

data/lib/twirp_rails/engine.rb

@@ -1,6 +1,8 @@
 require 'rails/engine'
 require 'twirp_rails/routes'
 require 'twirp_rails/twirp'
+require 'twirp_rails/logging_adapter'
+require 'twirp_rails/raven_adapter'
 
 module TwirpRails
   module Routes
@@ -9,6 +11,14 @@ module TwirpRails
         TwirpRails::Routes::Helper.install
       end
 
+      initializer 'twirp_rails.raven' do
+        TwirpRails::RavenAdapter.install
+      end
+
+      initializer 'twirp_rails.logging' do
+        TwirpRails::LoggingAdapter.install
+      end
+
       initializer 'twirp_rails.require_generated_files' do
         TwirpRails::Twirp.auto_require_twirp_files
       end

data/lib/twirp_rails/logging_adapter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'twirp_rails/routes'
+
+module TwirpRails
+  module LoggingAdapter # :nodoc:
+    def self.install
+      return unless defined?(ActiveSupport::Notifications)
+
+      TwirpRails::Routes::Helper.on_create_service do |service|
+        LoggingAdapter.instrument service
+      end
+    end
+
+    def self.instrument(service)
+      instrumenter = ActiveSupport::Notifications.instrumenter
+
+      service.before do |rack_env, env|
+        payload = {
+          rack_env: rack_env,
+          env: env
+        }
+        instrumenter.start 'instrumenter.twirp', payload
+      end
+
+      service.on_error do |_twerr, _env|
+        instrumenter.finish 'instrumenter.twirp', nil
+      end
+
+      service.on_success do |_env|
+        instrumenter.finish 'instrumenter.twirp', nil
+      end
+
+      service.exception_raised do |e, env|
+        env[:exception] = {
+          class: e.class,
+          message: e.message,
+          backtrace: e.backtrace.join("\n")
+        }
+      end
+    end
+  end
+end

data/lib/twirp_rails/raven_adapter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'twirp_rails/routes'
+
+module TwirpRails
+  module RavenAdapter # :nodoc:
+    def self.install
+      return unless defined?(::Raven)
+
+      TwirpRails::Routes::Helper.on_create_service do |service|
+        RavenAdapter.attach service
+      end
+    end
+
+    def self.attach(service)
+      service.exception_raised do |e, _env|
+        ::Raven.capture_exception e
+      end
+    end
+  end
+end

data/lib/twirp_rails/routes.rb

@@ -3,7 +3,7 @@ require 'action_dispatch'
 module TwirpRails
   module Routes # :nodoc:
     module Helper
-      def mount_twirp(name, handler: nil)
+      def mount_twirp(name, handler: nil, scope: 'twirp')
         case name
         when Class
           raise 'handler param required when name is a class' unless handler&.is_a?(Class)
@@ -11,7 +11,10 @@ module TwirpRails
           service_class = name
 
         when String, Symbol
-          service_class = "#{name}_service".camelize.constantize rescue name.camelize.constantize
+          service_class = Helper.constantize_first "#{name}_service", name
+
+          raise "#{name.camelize}Service or #{name.camelize} is not found" unless service_class
+
           handler ||= "#{name}_handler".camelize.constantize
 
         else
@@ -19,11 +22,44 @@ module TwirpRails
         end
 
         service = service_class.new(handler.new)
-        mount service, at: service.full_name
+        Helper.run_create_hooks service
+
+        if scope
+          scope scope do
+            mount service, at: service.full_name
+          end
+        else
+          mount service, at: service.full_name
+        end
+      end
+
+      def self.constantize_first(*variants)
+        variants.each do |name|
+          clazz = name.to_s.camelize.constantize
+
+          return clazz if clazz
+        end
+
+        nil
       end
 
       def self.install
-        ActionDispatch::Routing::Mapper.send :include, TwirpRails::Routes::Helper
+        ActionDispatch::Routing::Mapper.include TwirpRails::Routes::Helper
+      end
+
+      cattr_accessor :create_service_hooks
+
+      def self.on_create_service(&block)
+        Helper.create_service_hooks ||= []
+        Helper.create_service_hooks << block
+      end
+
+      def self.run_create_hooks(service)
+        return unless Helper.create_service_hooks
+
+        Helper.create_service_hooks.each do |hook|
+          hook.call service
+        end
       end
     end
   end

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.1.7'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -145,6 +145,8 @@ files:
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/twirp_generator.rb
 - lib/twirp_rails/generators/twirp/twirp_rspec_generator.rb
+- lib/twirp_rails/logging_adapter.rb
+- lib/twirp_rails/raven_adapter.rb
 - lib/twirp_rails/routes.rb
 - lib/twirp_rails/rspec/helper.rb
 - lib/twirp_rails/twirp.rb