gruf 1.2.7 → 2.0.0

data/lib/gruf/interceptors/registry.rb

@@ -0,0 +1,131 @@
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Gruf
+  module Interceptors
+    ##
+    # Handles registration of interceptors
+    #
+    class Registry
+      class InterceptorNotFoundError < StandardError; end
+
+      def initialize
+        @registry ||= []
+      end
+
+      ##
+      # Add an interceptor to the registry
+      #
+      # @param [Gruf::Interceptors::Base] interceptor_class The class of the interceptor to add
+      # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      #
+      def use(interceptor_class, options = {})
+        interceptors_mutex do
+          @registry << {
+            klass: interceptor_class,
+            options: options
+          }
+        end
+      end
+
+      ##
+      # Insert an interceptor before another specified interceptor
+      #
+      # @param [Gruf::Interceptors::Base] before_class The interceptor to insert before
+      # @param [Gruf::Interceptors::Base] interceptor_class The class of the interceptor to add
+      # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      #
+      def insert_before(before_class, interceptor_class, options = {})
+        interceptors_mutex do
+          pos = @registry.find_index { |opts| opts.fetch(:klass, '') == before_class }
+          raise InterceptorNotFoundError if pos.nil?
+          @registry.insert(
+            pos,
+            klass: interceptor_class,
+            options: options
+          )
+        end
+      end
+
+      ##
+      # Insert an interceptor after another specified interceptor
+      #
+      # @param [Gruf::Interceptors::Base] after_class The interceptor to insert after
+      # @param [Gruf::Interceptors::Base] interceptor_class The class of the interceptor to add
+      # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      #
+      def insert_after(after_class, interceptor_class, options = {})
+        interceptors_mutex do
+          pos = @registry.find_index { |opts| opts.fetch(:klass, '') == after_class }
+          raise InterceptorNotFoundError if pos.nil?
+          @registry.insert(
+            (pos + 1),
+            klass: interceptor_class,
+            options: options
+          )
+        end
+      end
+
+      ##
+      # Load and return all interceptors for the given request
+      #
+      # @param [Gruf::Controllers::Request] request
+      # @param [Gruf::Error] error
+      # @return [Array<Gruf::Interceptors::Base>]
+      #
+      def prepare(request, error)
+        is = []
+        interceptors_mutex do
+          @registry.each do |o|
+            is << o[:klass].new(request, error, o[:options])
+          end
+        end
+        is
+      end
+
+      ##
+      # Clear the registry
+      #
+      def clear
+        interceptors_mutex do
+          @registry = []
+        end
+      end
+
+      ##
+      # @return [Integer] The number of interceptors currently loaded
+      #
+      def count
+        interceptors_mutex do
+          @registry ||= []
+          @registry.count
+        end
+      end
+
+      private
+
+      ##
+      # Handle mutations to the interceptor registry in a thread-safe manner
+      #
+      def interceptors_mutex(&block)
+        @interceptors_mutex ||= begin
+          require 'monitor'
+          Monitor.new
+        end
+        @interceptors_mutex.synchronize(&block)
+      end
+    end
+  end
+end

data/lib/gruf/{authentication/none.rb → interceptors/server_interceptor.rb}

@@ -15,17 +15,18 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  module Authentication
+  module Interceptors
     ##
-    # No authentication strategy
+    # Intercepts server requests
     #
-    class None < Base
+    class ServerInterceptor < Base
+      include Gruf::Errors::Helpers
+
       ##
-      # @param [GRPC::ActiveCall] _call The gRPC active call for the given operation
-      # @return [TrueClass] Always true for this passthrough strategy.
+      # Call the interceptor
       #
-      def valid?(_call)
-        true
+      def call
+        raise NotImplementedError
       end
     end
   end

data/lib/gruf/interceptors/timer.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Gruf
+  module Interceptors
+    ##
+    # Utility class that can be used by interceptors to time requests
+    #
+    class Timer
+      ##
+      # Represents a timed result for an interceptor
+      #
+      class Result
+        attr_reader :message
+        attr_reader :elapsed
+
+        def initialize(message, elapsed, successful)
+          @message = message
+          @elapsed = elapsed.to_f
+          @successful = successful ? true : false
+        end
+
+        ##
+        # @return [Boolean] True if this was a successful request
+        #
+        def successful?
+          @successful
+        end
+
+        ##
+        # @return [String] The name of the message class
+        #
+        def message_class_name
+          @message.class.name
+        end
+
+        ##
+        # Return the execution time rounded to a specified precision
+        #
+        # @param [Integer] precision The amount of decimal places to round to
+        # @return [Float] The execution time rounded to the appropriate decimal point
+        #
+        def elapsed_rounded(precision: 2)
+          @elapsed.to_f.round(precision)
+        end
+      end
+
+      ##
+      # Time a given code block and return a Timer::Result object
+      #
+      # @return [Gruf::Interceptors::Timer::Result]
+      #
+      def self.time
+        start_time = Time.now
+        message = yield
+        end_time = Time.now
+        elapsed = (end_time - start_time) * 1000.0
+        Result.new(message, elapsed, true)
+      rescue GRPC::BadStatus => e
+        end_time = Time.now
+        elapsed = (end_time - start_time) * 1000.0
+        Result.new(e, elapsed, false)
+      end
+    end
+  end
+end

data/lib/gruf/response.rb

@@ -63,8 +63,7 @@ module Gruf
     # @return [Float] The execution time of the response
     #
     def internal_execution_time
-      key = Gruf.instrumentation_options.fetch(:output_metadata_timer, {}).fetch(:metadata_key, 'timer')
-      trailing_metadata[key].to_f
+      trailing_metadata['timer'].to_f
     end
   end
 end

data/lib/gruf/server.rb

@@ -22,21 +22,24 @@ module Gruf
   class Server
     include Gruf::Loggable
 
-    # @return [Array<Class>] The services this server is handling
-    attr_accessor :services
     # @return [GRPC::RpcServer] The underlying GRPC server instance
     attr_reader :server
     # @return [Integer] The port the server is bound to
     attr_reader :port
+    # @return [Hash] Hash of options passed into the server
+    attr_reader :options
 
     ##
     # Initialize the server and load and setup the services
     #
-    # @param [Array<Class>] services The services that this server should handle
+    # @param [Hash] options
     #
-    def initialize(services: [])
+    def initialize(options = {})
+      @options = options || {}
+      @interceptors = options.fetch(:interceptor_registry, Gruf.interceptors)
+      @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry)
+      @services = []
       setup!
-      load_services(services)
     end
 
     ##
@@ -44,11 +47,9 @@ module Gruf
     #
     def server
       unless @server
-        @server = GRPC::RpcServer.new(Gruf.server_options)
-        @port = @server.add_http2_port(Gruf.server_binding_url, ssl_credentials)
-        services.each do |s|
-          @server.handle(s)
-        end
+        @server = GRPC::RpcServer.new(options)
+        @port = @server.add_http2_port(options.fetch(:hostname, Gruf.server_binding_url), ssl_credentials)
+        @services.each { |s| @server.handle(s) }
       end
       @server
     end
@@ -64,34 +65,48 @@ module Gruf
     end
     # :nocov:
 
-    private
+    ##
+    # @param [Class] klass
+    #
+    def add_service(klass)
+      @services << klass unless @services.include?(klass)
+    end
 
     ##
-    # Return all loaded gRPC services
+    # Add an interceptor to the server
     #
-    # @param [Array<Class>] svcs An array of service classes that will be handled by this server
-    # @return [Array<Class>] The given services that were added
+    # @param [Gruf::Interceptors::Base]
+    # @param [Hash]
     #
-    def load_services(svcs)
-      unless @services
-        @services = Gruf.services.concat(svcs)
-        @services.uniq!
-      end
-      @services
+    def add_interceptor(klass, opts = {})
+      @interceptors.use(klass, opts)
     end
 
+    private
+
     ##
     # Auto-load all gRPC handlers
     #
     # :nocov:
     def setup!
-      Dir["#{Gruf.servers_path}/**/*.rb"].each do |f|
+      return unless File.directory?(controllers_path)
+      path = File.realpath(controllers_path)
+      $LOAD_PATH.unshift(path)
+      Dir["#{path}/**/*.rb"].each do |f|
+        next if f.include?('_pb') # exclude if people include proto generated files in app/rpc
         logger.info "- Loading gRPC service file: #{f}"
-        require f
+        load File.realpath(f)
       end
     end
     # :nocov:
 
+    ##
+    # @param [String]
+    #
+    def controllers_path
+      options.fetch(:controllers_path, Gruf.controllers_path)
+    end
+
     ##
     # Load the SSL/TLS credentials for this server
     #
@@ -99,9 +114,9 @@ module Gruf
     #
     # :nocov:
     def ssl_credentials
-      if Gruf.use_ssl
-        private_key = File.read Gruf.ssl_key_file
-        cert_chain = File.read Gruf.ssl_crt_file
+      if options.fetch(:use_ssl, Gruf.use_ssl)
+        private_key = File.read(options.fetch(:ssl_key_file, Gruf.ssl_key_file))
+        cert_chain = File.read(options.fetch(:ssl_crt_file, Gruf.ssl_crt_file))
         certs = [nil, [{ private_key: private_key, cert_chain: cert_chain }], false]
         GRPC::Core::ServerCredentials.new(*certs)
       else

data/lib/gruf/version.rb

@@ -15,5 +15,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '1.2.7'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 2.0.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,35 +108,34 @@ files:
 - bin/gruf
 - gruf.gemspec
 - lib/gruf.rb
-- lib/gruf/authentication.rb
-- lib/gruf/authentication/base.rb
-- lib/gruf/authentication/basic.rb
-- lib/gruf/authentication/none.rb
-- lib/gruf/authentication/strategies.rb
 - lib/gruf/client.rb
 - lib/gruf/configuration.rb
+- lib/gruf/controllers/base.rb
+- lib/gruf/controllers/request.rb
+- lib/gruf/controllers/service_binder.rb
 - lib/gruf/error.rb
 - lib/gruf/errors/debug_info.rb
 - lib/gruf/errors/field.rb
-- lib/gruf/hooks/active_record/connection_reset.rb
-- lib/gruf/hooks/base.rb
-- lib/gruf/hooks/registry.rb
-- lib/gruf/instrumentation/base.rb
-- lib/gruf/instrumentation/output_metadata_timer.rb
-- lib/gruf/instrumentation/registry.rb
-- lib/gruf/instrumentation/request_context.rb
-- lib/gruf/instrumentation/request_logging/formatters/base.rb
-- lib/gruf/instrumentation/request_logging/formatters/logstash.rb
-- lib/gruf/instrumentation/request_logging/formatters/plain.rb
-- lib/gruf/instrumentation/request_logging/hook.rb
-- lib/gruf/instrumentation/statsd.rb
+- lib/gruf/errors/helpers.rb
+- lib/gruf/interceptors/active_record/connection_reset.rb
+- lib/gruf/interceptors/authentication/basic.rb
+- lib/gruf/interceptors/base.rb
+- lib/gruf/interceptors/context.rb
+- lib/gruf/interceptors/instrumentation/output_metadata_timer.rb
+- lib/gruf/interceptors/instrumentation/request_logging/formatters/base.rb
+- lib/gruf/interceptors/instrumentation/request_logging/formatters/logstash.rb
+- lib/gruf/interceptors/instrumentation/request_logging/formatters/plain.rb
+- lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb
+- lib/gruf/interceptors/instrumentation/statsd.rb
+- lib/gruf/interceptors/registry.rb
+- lib/gruf/interceptors/server_interceptor.rb
+- lib/gruf/interceptors/timer.rb
 - lib/gruf/loggable.rb
 - lib/gruf/logging.rb
 - lib/gruf/response.rb
 - lib/gruf/serializers/errors/base.rb
 - lib/gruf/serializers/errors/json.rb
 - lib/gruf/server.rb
-- lib/gruf/service.rb
 - lib/gruf/timer.rb
 - lib/gruf/version.rb
 homepage: https://github.com/bigcommerce/gruf

data/lib/gruf/authentication.rb

@@ -1,65 +0,0 @@
-# coding: utf-8
-# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
-# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
-# persons to whom the Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
-# Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-require_relative 'authentication/strategies'
-require_relative 'authentication/base'
-require_relative 'authentication/basic'
-require_relative 'authentication/none'
-
-module Gruf
-  ##
-  # Handles authentication for gruf services
-  #
-  module Authentication
-    ##
-    # Custom error class for handling unauthorized requests
-    #
-    class UnauthorizedError < StandardError; end
-
-    ##
-    # Verify a given gruf request
-    #
-    # @param [GRPC::ActiveCall] call The gRPC active call with marshalled data that is being executed
-    # @param [Symbol] strategy The authentication strategy to use
-    # @return [Boolean]
-    #
-    def self.verify(call)
-      credentials = call && call.respond_to?(:metadata) ? call.metadata[Gruf.authorization_metadata_key] : nil
-
-      if Gruf::Authentication::Strategies.any?
-        verified = false
-        Gruf::Authentication::Strategies.each do |_label, klass|
-          begin
-            # if a strategy passes, we've successfully authenticated and can proceed
-            if klass.verify(call, credentials)
-              verified = true
-              break
-            end
-          rescue => e
-            Gruf.logger.error "#{e.message} - #{e.backtrace[0..4].join("\n")}"
-            # NOOP, we don't want to fail other strategies because of a bad neighbor
-            # or if a strategy throws an exception because of a failed auth
-            # we should just proceed to the next strategy
-          end
-        end
-        verified
-      else
-        # we're not using any strategies, so no auth
-        true
-      end
-    end
-  end
-end