gruf 1.0.0

data/bin/gruf

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# 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 'rubygems'
+require 'bundler/setup'
+require 'gruf'
+require 'rails' rescue nil
+load 'config/environment.rb' if defined?(Rails)
+
+begin
+  server = Gruf::Server.new
+  server.start!
+rescue => e
+  Gruf.logger.fatal "FATAL ERROR: #{e.message} #{e.backtrace.join("\n")}"
+end

data/gruf.gemspec

@@ -0,0 +1,41 @@
+# 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.
+#
+$:.push File.expand_path("../lib", __FILE__)
+require 'gruf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf'
+  spec.version       = Gruf::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['shaun.mccormick@bigcommerce.com']
+
+  spec.summary       = %q{gRPC Ruby Framework}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/bigcommerce/gruf'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf.gemspec']
+  spec.executables   << 'gruf'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'grpc', '~> 1.4'
+  spec.add_runtime_dependency 'grpc-tools', '~> 1.4'
+  spec.add_runtime_dependency 'activesupport'
+end

data/lib/gruf.rb

@@ -0,0 +1,38 @@
+# 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 'grpc'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'base64'
+require_relative 'gruf/version'
+require_relative 'gruf/logging'
+require_relative 'gruf/loggable'
+require_relative 'gruf/configuration'
+require_relative 'gruf/authentication'
+require_relative 'gruf/hooks/registry'
+require_relative 'gruf/instrumentation/registry'
+require_relative 'gruf/service'
+require_relative 'gruf/timer'
+require_relative 'gruf/response'
+require_relative 'gruf/error'
+require_relative 'gruf/client'
+require_relative 'gruf/server'
+
+module Gruf
+  extend Configuration
+end

data/lib/gruf/authentication.rb

@@ -0,0 +1,57 @@
+# 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
+  module Authentication
+    class UnauthorizedError < StandardError; end
+
+    ##
+    # @param [GRPC::ActiveCall] call
+    # @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

data/lib/gruf/authentication/base.rb

@@ -0,0 +1,57 @@
+# 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
+    #
+    class Base
+      include Gruf::Loggable
+
+      attr_reader :credentials, :options
+
+      ##
+      #
+      # @param [String] credentials
+      #
+      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
+      # @param [String] credentials
+      # @param [Hash] options
+      #
+      def self.verify(call, credentials = '', options = {})
+        new(credentials, options).valid?(call)
+      end
+
+      ##
+      # @param [GRPC::ActiveCall] _call
+      # @return [Boolean]
+      #
+      def valid?(_call)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/gruf/authentication/basic.rb

@@ -0,0 +1,74 @@
+# 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
+      # @return [Boolean]
+      #
+      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>]
+      #
+      def server_credentials
+        options.fetch(:credentials, [])
+      end
+
+      ##
+      # @return [String]
+      #
+      def request_credentials
+        Base64.decode64(credentials.to_s.gsub('Basic ', '').strip)
+      end
+
+      ##
+      # @return [String]
+      # @deprecated
+      # :nocov:
+      def request_username
+        @request_username ||= request_credentials.split(':').first
+      end
+      # :nocov:
+
+      ##
+      # @return [String]
+      #
+      def request_password
+        @request_password ||= request_credentials.split(':').last
+      end
+    end
+  end
+end

data/lib/gruf/authentication/none.rb

@@ -0,0 +1,32 @@
+# 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
+    ##
+    # No authentication strategy
+    #
+    class None < Base
+      ##
+      # @param [GRPC::ActiveCall] _call
+      # @return [TrueClass]
+      #
+      def valid?(_call)
+        true
+      end
+    end
+  end
+end

data/lib/gruf/authentication/strategies.rb

@@ -0,0 +1,94 @@
+# 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
+      class StrategyDescendantError < StandardError; end
+
+      class << self
+        ##
+        # Add an authentication strategy, either through a class or a block
+        #
+        # @param [String] name
+        # @param [Class|NilClass] strategy
+        # @return [Class]
+        #
+        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
+        #
+        def [](label)
+          _strategies[label.to_sym]
+        end
+
+        ##
+        # Iterate over each
+        #
+        def each
+          _strategies.each do |s|
+            yield s
+          end
+        end
+
+        ##
+        # @return [Hash<Class>]
+        #
+        def to_h
+          _strategies
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def any?
+          to_h.keys.count > 0
+        end
+
+        ##
+        # @return [Hash]
+        #
+        def clear
+          @strategies = {}
+        end
+
+        private
+
+        ##
+        # @return [Hash<Class>]
+        #
+        def _strategies
+          @strategies ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/gruf/client.rb

@@ -0,0 +1,141 @@
+# 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
+  class Client < SimpleDelegator
+    include Gruf::Loggable
+
+    class Error < StandardError
+      attr_reader :error
+
+      def initialize(error)
+        @error = error
+      end
+    end
+
+    attr_reader :base_klass, :service_klass, :opts
+
+    ##
+    # @param [Module] service The namespace of the client Stub that is desired to load
+    # @param [Hash] options
+    # @option options [String] :password The password for basic authentication for the service.
+    # @option options [String] :hostname The hostname of the service. Defaults to linkerd.
+    #
+    def initialize(service:, options: {})
+      @base_klass = service
+      @service_klass = "#{base_klass}::Service".constantize
+      @opts = options || {}
+      @opts[:password] = options.fetch(:password, '').to_s
+      @opts[:hostname] = options.fetch(:hostname, Gruf.default_client_host)
+      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials)
+      super(client)
+    end
+
+    ##
+    # Call the client's method with given params
+    #
+    def call(request_method, params = {}, metadata = {})
+      req = request_object(request_method, params)
+      md = build_metadata(metadata)
+      call_sig = call_signature(request_method)
+
+      raise NotImplementedError, "The method #{request_method} has not been implemented in this service." unless call_sig
+
+      execute(call_sig, req, md)
+    rescue GRPC::BadStatus => e
+      emk = Gruf.error_metadata_key.to_s
+      raise Gruf::Client::Error, error_deserializer_class.new(e.metadata[emk]).deserialize if e.respond_to?(:metadata) && e.metadata.key?(emk)
+      raise # passthrough
+    end
+
+    private
+
+    ##
+    # @param [Symbol] call_sig The call signature being executed
+    # @param [Object] req
+    # @param [Hash] md
+    #
+    def execute(call_sig, req, md)
+      timed = Timer.time do
+        send(call_sig, req, return_op: true, metadata: md)
+      end
+      Gruf::Response.new(timed.result, timed.time)
+    end
+
+    ##
+    # @return [Struct<GRPC::RpcDesc>]
+    #
+    def rpc_desc(request_method)
+      service_klass.rpc_descs[request_method.to_sym]
+    end
+
+    ##
+    # @return [Class] The request object
+    #
+    def request_object(request_method, params = {})
+      desc = rpc_desc(request_method)
+      desc && desc.input ? desc.input.new(params) : nil
+    end
+
+    ##
+    # @return [Symbol]
+    #
+    def call_signature(request_method)
+      desc = rpc_desc(request_method)
+      desc && desc.name ? desc.name.to_s.underscore.to_sym : nil
+    end
+
+    ##
+    # @return [Hash]
+    #
+    def build_metadata(metadata = {})
+      unless opts[:password].empty?
+        username = opts.fetch(:username, 'grpc').to_s
+        username = username.empty? ? '' : "#{username}:"
+        auth_string = Base64.encode64("#{username}#{opts[:password]}")
+        metadata[:authorization] = "Basic #{auth_string}".tr("\n", '')
+      end
+      metadata
+    end
+
+    ##
+    # @return [Symbol|GRPC::Core::ChannelCredentials]
+    #
+    # :nocov:
+    def build_ssl_credentials
+      cert = nil
+      if opts[:ssl_certificate_file]
+        cert = File.read(opts[:ssl_certificate_file]).to_s.strip
+      elsif opts[:ssl_certificate]
+        cert = opts[:ssl_certificate].to_s.strip
+      end
+
+      cert ? GRPC::Core::ChannelCredentials.new(cert) : :this_channel_is_insecure
+    end
+    # :nocov:
+
+    ##
+    # @return [Class]
+    #
+    def error_deserializer_class
+      if Gruf.error_serializer
+        Gruf.error_serializer.is_a?(Class) ? Gruf.error_serializer : Gruf.error_serializer.to_s.constantize
+      else
+        Gruf::Serializers::Errors::Json
+      end
+    end
+  end
+end