gruf 1.2.7 → 2.0.0

data/lib/gruf/authentication/base.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.
-#
-module Gruf
-  module Authentication
-    ##
-    # Base interface for Authentication strategies. All derived strategies must define the `valid?` method.
-    #
-    class Base
-      include Gruf::Loggable
-
-      # @return [String] The credentials sent in the request
-      attr_reader :credentials
-      # @return [Hash] A hash of authentication options
-      attr_reader :options
-
-      ##
-      # Initialize the authentication middleware
-      #
-      # @param [String] credentials The credentials sent in the request
-      # @param [Hash] options A hash of authentication options
-      #
-      def initialize(credentials, options = {})
-        opts = Gruf.authentication_options || {}
-        @credentials = credentials
-        @options = opts.merge(options)
-      end
-
-      ##
-      # Verify the credentials. Helper class method.
-      #
-      # @param [GRPC::ActiveCall] call The gRPC active call for the given operation
-      # @param [String] credentials The credentials sent in the request
-      # @param [Hash] options A hash of authentication options
-      #
-      def self.verify(call, credentials = '', options = {})
-        new(credentials, options).valid?(call)
-      end
-
-      ##
-      # Abstract method that is required to be implemented in every derivative class.
-      # Return true if the call is authenticated, false if a permission denied error is to be sent.
-      #
-      # @param [GRPC::ActiveCall] _call The gRPC active call for the given operation
-      # @return [Boolean] True if the call was authenticated
-      #
-      def valid?(_call)
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/gruf/authentication/basic.rb

@@ -1,74 +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 'base64'
-
-module Gruf
-  module Authentication
-    ##
-    # Handles basic authentication for gRPC requests
-    #
-    class Basic < Base
-      ##
-      # @param [GRPC::ActiveCall] _call The gRPC active call for the given operation
-      # @return [Boolean] True if the basic authentication was valid
-      #
-      def valid?(_call)
-        server_credentials.any? do |cred|
-          username = cred.fetch(:username, '').to_s
-          password = cred.fetch(:password, '').to_s
-          if username.empty?
-            request_password == password
-          else
-            request_credentials == "#{username}:#{password}"
-          end
-        end
-      end
-
-      private
-
-      ##
-      # @return [Array<Hash>] An array of valid server credentials for this service
-      #
-      def server_credentials
-        options.fetch(:credentials, [])
-      end
-
-      ##
-      # @return [String] The decoded request credentials
-      #
-      def request_credentials
-        Base64.decode64(credentials.to_s.gsub('Basic ', '').strip)
-      end
-
-      ##
-      # @return [String] The decoded request username
-      # @deprecated
-      # :nocov:
-      def request_username
-        @request_username ||= request_credentials.split(':').first
-      end
-      # :nocov:
-
-      ##
-      # @return [String] The decoded request password
-      #
-      def request_password
-        @request_password ||= request_credentials.split(':').last
-      end
-    end
-  end
-end

data/lib/gruf/authentication/strategies.rb

@@ -1,107 +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.
-#
-module Gruf
-  module Authentication
-    ##
-    # Provides a modifiable repository of strategies for authentication
-    #
-    class Strategies
-      ##
-      # Error class that represents when a strategy does not extend the base class
-      #
-      class StrategyDescendantError < StandardError; end
-
-      class << self
-        ##
-        # Add an authentication strategy, either through a class or a block
-        #
-        # @param [String] name The vanity name of the strategy being loaded
-        # @param [Class|NilClass] strategy (Optional) The class that represents the strategy
-        # @param [Proc] &block If given, will attempt to build a strategy class from the base class with this block
-        # @return [Class] The loaded strategy
-        #
-        def add(name, strategy = nil, &block)
-          base = Gruf::Authentication::Base
-          strategy ||= Class.new(base)
-          strategy.class_eval(&block) if block_given?
-
-          # all strategies require the valid? method
-          raise NoMethodError unless strategy.method_defined?(:valid?)
-
-          raise StrategyDescendantError, "Strategies must descend from #{base}" unless strategy.ancestors.include?(base)
-
-          _strategies[name.to_sym] = strategy
-        end
-
-        ##
-        # Return a strategy via a hash accessor syntax
-        #
-        # @param [Symbol] label The name of the strategy
-        # @return [Gruf::Authentication::Base] The requested strategy
-        #
-        def [](label)
-          _strategies[label.to_sym]
-        end
-
-        ##
-        # Iterate over each strategy and yield it to the caller
-        #
-        def each
-          _strategies.each do |s|
-            yield s
-          end
-        end
-
-        ##
-        # Return the loaded strategies as a hash
-        #
-        # @return [Hash<Class>] A name/strategy pair of loaded strategies
-        #
-        def to_h
-          _strategies
-        end
-
-        ##
-        # Return if there are any loaded strategies
-        #
-        # @return [Boolean] True if there are loaded strategies
-        #
-        def any?
-          to_h.keys.count > 0
-        end
-
-        ##
-        # Clear all given strategies
-        #
-        # @return [Hash] The newly empty hash
-        #
-        def clear
-          @strategies = {}
-        end
-
-        private
-
-        ##
-        # @return [Hash<Class>]
-        #
-        def _strategies
-          @strategies ||= {}
-        end
-      end
-    end
-  end
-end

data/lib/gruf/hooks/base.rb

@@ -1,66 +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.
-#
-module Gruf
-  module Hooks
-    ##
-    # Base class for a hook. Define before, around, outer_around, or after methods to utilize functionality.
-    #
-    class Base
-      include Gruf::Loggable
-
-      # @return [Gruf::Service] service The service to perform the hook against
-      attr_reader :service
-      # @return [Hash] options Options to use for the hook
-      attr_reader :options
-
-      ##
-      # Initialize the hook and run setup
-      #
-      # @param [Gruf::Service] service The gruf service that the hook will perform against
-      # @param [Hash] options (Optional) A hash of options for this hook
-      #
-      def initialize(service, options = {})
-        @service = service
-        @options = options
-        setup
-      end
-
-      ##
-      # Method that can be used to setup the hook prior to running it
-      #
-      def setup
-        # noop
-      end
-
-      ##
-      # @return [String] Returns the service name as a translated name separated by periods
-      #
-      def service_key
-        service.class.name.underscore.tr('/', '.')
-      end
-
-      ##
-      # Parse the method signature into a service.method name format
-      #
-      # @return [String] The parsed service method name
-      #
-      def method_key(call_signature)
-        "#{service_key}.#{call_signature.to_s.gsub('_without_intercept', '')}"
-      end
-    end
-  end
-end

data/lib/gruf/hooks/registry.rb

@@ -1,110 +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 'base'
-require_relative 'active_record/connection_reset'
-
-module Gruf
-  module Hooks
-    ##
-    # Registry of all hooks added
-    #
-    class Registry
-      ##
-      # Error class that represents when a gruf hook does not extend the base class
-      #
-      class HookDescendantError < StandardError; end
-
-      class << self
-        ##
-        # Add an authentication strategy, either through a class or a block
-        #
-        # @param [String] name The name to represent the hook as
-        # @param [Gruf::Hooks::Base|NilClass] hook The strategy class to add. If nil, will expect
-        # a block that can be built as a hook instead
-        # @return [Class] The hook that was added
-        #
-        def add(name, hook = nil, &block)
-          base = Gruf::Hooks::Base
-          hook ||= Class.new(base)
-          hook.class_eval(&block) if block_given?
-
-          # all hooks require either the before, after, or around method
-          raise NoMethodError unless hook.method_defined?(:before) || hook.method_defined?(:after) || hook.method_defined?(:around) || hook.method_defined?(:outer_around)
-
-          raise HookDescendantError, "Hooks must descend from #{base}" unless hook.ancestors.include?(base)
-
-          _registry[name.to_sym] = hook
-        end
-
-        ##
-        # Return a hook via a hash accessor syntax
-        #
-        # @return [Gruf::Instrumentation::Base|NilClass] The requested hook, if exists
-        #
-        def [](name)
-          _registry[name.to_sym]
-        end
-
-        ##
-        # Iterate over each hook in the registry
-        #
-        def each
-          _registry.each do |name, s|
-            yield name, s
-          end
-        end
-
-        ##
-        # @return [Hash<Class>] Return the registry represented as a Hash object
-        #
-        def to_h
-          _registry
-        end
-
-        ##
-        # @return [Boolean] Return true if there are any registered hooks
-        #
-        def any?
-          count > 0
-        end
-
-        ##
-        # @return [Integer] Return the number of registered hooks
-        #
-        def count
-          to_h.keys.count
-        end
-
-        ##
-        # @return [Hash] Clear all existing hooks from the registry
-        #
-        def clear
-          @_registry = {}
-        end
-
-        private
-
-        ##
-        # @return [Hash<Class>] Return the current registry
-        #
-        def _registry
-          @_registry ||= {}
-        end
-      end
-    end
-  end
-end

data/lib/gruf/instrumentation/base.rb

@@ -1,114 +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 'request_context'
-
-module Gruf
-  module Instrumentation
-    ##
-    # Base class for an instrumentation strategy. Define a call method to utilize functionality.
-    #
-    class Base
-      include Gruf::Loggable
-
-      # @return [Gruf::Service] service The service to instrument
-      attr_reader :service
-      # @return [Hash] options Options to use when instrumenting the call
-      attr_reader :options
-
-      ##
-      # @param [Gruf::Service] service The service to instrument
-      # @param [Hash] options (Optional) Options to use when instrumenting the call
-      #
-      def initialize(service, options = {})
-        @service = service
-        @options = options
-        setup
-      end
-
-      ##
-      # Useful for setting up an instrumentation module post instantiation
-      #
-      def setup
-        # noop
-      end
-
-      ##
-      # Was this call a success? If a response is a GRPC::BadStatus object, we assume that it was unsuccessful
-      #
-      # @param [Object] response The gRPC response object
-      # @return [Boolean] True if was a successful call
-      #
-      def success?(response)
-        !response.is_a?(GRPC::BadStatus)
-      end
-
-      ##
-      # Abstract method that is required for implementing an instrumentation strategy.
-      #
-      # @abstract
-      # @param [Gruf::Instrumentation::RequestContext] _rc The current request context for the call
-      #
-      def call(_rc)
-        raise NotImplementedError
-      end
-
-      ##
-      # Hook into the outer_around call to time the request, and pass that to the call method
-      #
-      # @param [Symbol] call_signature The method being called
-      # @param [Object] request The request object
-      # @param [GRPC::ActiveCall] active_call The gRPC active call object
-      # @param [Proc] &_block The execution block for the call
-      # @return [Object] result The result of the block that was called
-      #
-      def outer_around(call_signature, request, active_call, &_block)
-        timed = Timer.time do
-          yield
-        end
-        rc = RequestContext.new(
-          service: service,
-          request: request,
-          response: timed.result,
-          execution_time: timed.time,
-          call_signature: call_signature,
-          active_call: active_call
-        )
-        call(rc)
-        raise rc.response unless rc.success?
-        rc.response
-      end
-
-      ##
-      # @return [String] Returns the service name as a translated name separated by periods
-      #
-      def service_key
-        service.class.name.underscore.tr('/', '.')
-      end
-
-      ##
-      # Parse the method signature into a service.method name format
-      #
-      # @param [Symbol] call_signature The method call signature
-      # @param [String] delimiter The delimiter to separate service and method keys
-      # @return [String] The parsed service method name
-      #
-      def method_key(call_signature, delimiter: '.')
-        "#{service_key}#{delimiter}#{call_signature}"
-      end
-    end
-  end
-end