runcite-gruf-rspec 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f607712911860632d9179a549daca3d08aeacd39623ecfbab881d9199c38d60d
+  data.tar.gz: ba30bcbd6d17b775c7cc19d141a855b298c8cd1f24f4f86745d32f3c3abb7477
+SHA512:
+  metadata.gz: d50618bb226b4e821bde4a152393950a0d01a295ddcb5e6bfc467b627b88b083f3e8a4f199aff3863063e03c5fba7f707501eadf32984501deef53912bfc1364
+  data.tar.gz: 6e850ec18c41f4115770d35c08f36341392b96b2bc203c710d0479279ee5d9066046e6875b98f149c8b0edf4e803dec922ace7fe37b800b31b663a9139810894

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+Changelog for the gruf-rspec gem.
+
+### Pending release
+
+### 0.1.2
+
+* Fix issue with RSPEC_NAMESPACE conflicts with other gems
+
+### 0.1.1
+
+* Add be_a_successful_rpc matcher that matches on success and the appropriate response class
+
+### 0.1.0
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at engineering@bigcommerce.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,143 @@
+# gruf-rspec
+
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-rspec/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-rspec/tree/master) [![Gem Version](https://badge.fury.io/rb/gruf-rspec.svg)](https://badge.fury.io/rb/gruf-rspec) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf-rspec.svg?branch=master)](https://inch-ci.org/github/bigcommerce/gruf-rspec?branch=master)
+
+Assistance helpers and custom type for easy testing [Gruf](https://github.com/bigcommerce/gruf) controllers with 
+[RSpec](https://github.com/rspec/rspec).
+
+## Installation
+
+```ruby
+gem 'gruf-rspec'
+```
+    
+Then add the following code to your `spec_helper.rb`:
+
+```ruby
+require 'gruf/rspec'
+``` 
+
+Note that this gem requires at least Gruf 2.5.1+ and RSpec 3.8+.
+
+## Usage
+
+* Add a test for a Gruf controller in `spec/rpc`
+* Run the `run_rpc` method with two args: The gRPC method name, and the request object
+* Validate the response
+
+## Example
+
+Let's assume you have a gruf controller named `ThingController` that is bound to the gRPC 
+service `Rpc::Things::Service`. That has a method `GetThing`:
+
+```ruby
+class ThingController < Gruf::Controllers::Base
+  bind ::Rpc::Things::Service
+  
+  def get_thing
+    Rpc::GetThingResponse.new(id: request.message.id)
+  end
+end
+```
+
+To test it, you'd create `spec/rpc/thing_controller_spec.rb`:
+
+```ruby
+describe ThingController do
+  describe '.get_thing' do
+    let(:request_proto) { Rpc::GetThingRequest.new(id: rand(1..100)) }
+    
+    subject { run_rpc(:GetThing, request_proto) }
+    
+    it 'will return the thing' do
+      expect(subject).to be_a(Rpc::GetThingResponse)
+      expect(subject.id).to eq request_proto.id
+    end
+  end
+end
+```
+
+Alternatively, you can pass a block:
+
+```ruby
+it 'will return the thing' do
+  run_rpc(:GetThing, request_proto) do |resp|
+    expect(resp).to be_a(Rpc::GetThingResponse)
+    expect(resp.id).to eq request_proto.id
+  end
+end
+```
+
+### Accessing the Bound Service
+
+Note that you can also access the bound gRPC service class:
+
+```ruby
+it 'binds the service correctly' do
+  expect(grpc_bound_service).to eq Rpc::Things::Service
+end
+``` 
+
+### Matching Errors
+
+You can match against errors as well:
+
+```ruby
+describe 'testing an error' do
+  let(:request_proto) { Rpc::GetThingRequest.new(id: rand(1..100)) }
+  
+  subject { run_rpc(:GetThing, request_proto) }
+  
+  it 'should fail with the appropriate error' do
+    expect { subject }.to raise_rpc_error(GRPC::InvalidArgument)
+  end
+end
+```
+
+Or further, even check your serialized error that is passed in metadata:
+
+```ruby
+it 'should fail with the appropriate error code' do
+  expect { subject }.to raise_rpc_error(GRPC::InvalidArgument).with_serialized { |err|
+    expect(err).to be_a(MyCustomErrorClass)
+    expect(err.error_code).to eq 'invalid_request'
+  
+    fe = err.field_errors.first
+    expect(fe.field_name).to eq 'name'
+    expect(fe.error_code).to eq 'invalid_name'
+    expect(fe.error_message).to eq 
+  }
+end
+```
+
+Note that when using `with_serialized`, you _must_ pass the block with `{ }`, not using
+`do` and `end`.
+
+
+### RSpec Controller Matcher Configuration
+
+By default, the type matcher for Gruf controllers matches in `/spec/rpc`. You can customize this by configuring it
+in the `Gruf::Rspec` confiugration block like so:
+
+```ruby
+Gruf::Rspec.configure do |c|
+  c.rpc_spec_path = '/spec/rpc_controllers'
+end
+```
+
+## License
+
+Copyright (c) 2018-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.

data/gruf-rspec.gemspec

@@ -0,0 +1,42 @@
+# Copyright (c) 2018-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.
+#
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gruf/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'runcite-gruf-rspec'
+  spec.version       = Gruf::Rspec::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['splittingred@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{RSpec assistance library for gruf}
+  spec.description   = %q{RSpec assistance library for gruf, including testing helpers}
+  spec.homepage      = 'https://github.com/runciteassociates/gruf-rspec'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-rspec.gemspec']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'gruf', '~> 2.5', '>= 2.5.1'
+  spec.add_dependency 'rspec', '~> 3.8'
+end

data/lib/gruf/rspec.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2018-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.
+#
+begin
+  require 'rspec/core'
+  require 'rspec/expectations'
+  GRUF_RSPEC_NAMESPACE = RSpec
+  GRUF_RSPEC_RUNNER = RSpec
+rescue LoadError # old rspec compat
+  require 'spec'
+  GRUF_RSPEC_NAMESPACE = Spec
+  GRUF_RSPEC_RUNNER = Spec::Runner
+end
+
+require_relative 'rspec/version'
+require_relative 'rspec/configuration'
+require_relative 'rspec/helpers'
+require_relative 'rspec/error_matcher'
+
+module Gruf
+  module Rspec
+    extend Gruf::Rspec::Configuration
+  end
+end
+
+Gruf::Rspec.reset # initial reset
+
+GRUF_RSPEC_RUNNER.configure do |config|
+  config.include Gruf::Rspec::Helpers
+
+  config.define_derived_metadata(file_path: Regexp.new(Gruf::Rspec.rpc_spec_path)) do |metadata|
+    metadata[:type] = :gruf_controller
+  end
+
+  config.before(:each, type: :gruf_controller) do
+    define_singleton_method :run_rpc do |method_name, request, metadata = {}, &block|
+      @gruf_controller = described_class.new(
+        method_key: method_name.to_s.underscore.to_sym,
+        service: grpc_bound_service,
+        rpc_desc: grpc_bound_service.rpc_descs[method_name.to_sym],
+        active_call: grpc_active_call(metadata),
+        message: request
+      )
+      resp = @gruf_controller.call(@gruf_controller.request.method_key)
+      block.call(resp) if block && block.is_a?(Proc)
+      resp
+    end
+
+    define_singleton_method :grpc_bound_service do
+      described_class.bound_service
+    end
+
+    define_singleton_method :gruf_controller do
+      @gruf_controller
+    end
+  end
+end
+
+GRUF_RSPEC_NAMESPACE::Matchers.define :raise_rpc_error do |expected_error_class|
+  supports_block_expectations
+
+  def with_serialized(&block)
+    @serialized_block = block
+    self
+  end
+
+  match do |rpc_call_proc|
+    @error_matcher = Gruf::Rspec::ErrorMatcher.new(
+      rpc_call_proc: rpc_call_proc,
+      expected_error_class: expected_error_class,
+      serialized_block: @serialized_block
+    )
+    @error_matcher.valid?
+  end
+
+  failure_message do |_|
+    @error_matcher.error_message
+  end
+end
+
+GRUF_RSPEC_NAMESPACE::Matchers.define :be_a_successful_rpc do |_|
+  match do |actual|
+    if !gruf_controller || actual.is_a?(GRPC::BadStatus) || actual.is_a?(GRPC::Core::CallError)
+      false
+    else
+      method_key = gruf_controller.request.method_key.to_s.camelcase.to_sym
+      expected_class = gruf_controller.class.bound_service.rpc_descs[method_key].output
+      expected_class == actual.class
+    end
+  end
+end

data/lib/gruf/rspec/authentication_hydrators/base.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2018-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 Rspec
+    module AuthenticationHydrators
+      ##
+      # Base authentication hydration class, performs a NOOP on hydration
+      #
+      class Base
+        ##
+        # @param [Hash] options
+        #
+        def initialize(options = {})
+          @options = options || {}
+        end
+
+        ##
+        # @param [Hash] metadata The incoming request metadata
+        # @return [Hash] The hydrated metadata
+        #
+        def hydrate(metadata)
+          metadata
+        end
+      end
+    end
+  end
+end

data/lib/gruf/rspec/authentication_hydrators/basic.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2018-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 Rspec
+    module AuthenticationHydrators
+      ##
+      # Automatically hydrate request metadata with basic authentication options
+      #
+      class Basic < ::Gruf::Rspec::AuthenticationHydrators::Base
+        ##
+        # @param [Hash] metadata The incoming request metadata
+        # @return [Hash] The hydrated metadata
+        #
+        def hydrate(metadata)
+          username = auth_opts.fetch(:username, '')
+          password = auth_opts.fetch(:password, '')
+          auth_string = username.to_s.empty? ? password : "#{username}:#{password}"
+          metadata[auth_opts.fetch(:header_key, 'authorization').to_s] = "Basic #{::Base64.encode64(auth_string)}" unless auth_string.empty?
+          metadata
+        end
+
+        private
+
+        def auth_opts
+          @auth_opts ||= @options.fetch(:authentication_options, {})
+        end
+      end
+    end
+  end
+end

data/lib/gruf/rspec/configuration.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 2018-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_hydrators/base'
+require_relative 'authentication_hydrators/basic'
+
+module Gruf
+  module Rspec
+    ##
+    # Represents configuration settings for the system
+    #
+    module Configuration
+      VALID_CONFIG_KEYS = {
+        authentication_hydrators: {
+          base: Gruf::Rspec::AuthenticationHydrators::Base,
+          basic: Gruf::Rspec::AuthenticationHydrators::Basic
+        },
+        rpc_spec_path: '/spec/rpc/'.freeze
+      }.freeze
+
+      attr_accessor *VALID_CONFIG_KEYS.keys
+
+      ##
+      # Whenever this is extended into a class, setup the defaults
+      #
+      def self.extended(base)
+        base.reset
+      end
+
+      ##
+      # Yield self for ruby-style initialization
+      #
+      # @yields [Gruf::Rspec::Configuration] The configuration object for gruf
+      # @return [Gruf::Rspec::Configuration] The configuration object for gruf
+      #
+      def configure
+        yield self
+      end
+
+      ##
+      # Return the current configuration options as a Hash
+      #
+      # @return [Hash] The configuration for gruf, represented as a Hash
+      #
+      def options
+        opts = {}
+        VALID_CONFIG_KEYS.each_key do |k|
+          opts.merge!(k => send(k))
+        end
+        opts
+      end
+
+      ##
+      # Set the default configuration onto the extended class
+      #
+      # @return [Hash] options The reset options hash
+      #
+      def reset
+        VALID_CONFIG_KEYS.each do |k, v|
+          send((k.to_s + '='), v)
+        end
+        self.rpc_spec_path = '/spec/rpc/'.freeze
+        options
+      end
+    end
+  end
+end

data/lib/gruf/rspec/error_matcher.rb

@@ -0,0 +1,117 @@
+# Copyright (c) 2018-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 Rspec
+    ##
+    # Match errors and properly handle validations
+    #
+    class ErrorMatcher
+      attr_writer :serialized_block
+      attr_reader :serialized_block_errors
+
+      ##
+      # @param [Proc] rpc_call_proc The underlying yielded controller proc to call
+      # @param [Class] expected_error_class The expected error class to occur
+      # @param [Proc|lambda|Nil] serialized_block If passed, the serialized block for inspecting errors
+      #
+      def initialize(rpc_call_proc:,
+                     expected_error_class:,
+                     serialized_block:)
+        @rpc_call_proc = rpc_call_proc
+        @expected_error_class = expected_error_class
+        @serialized_block = serialized_block
+
+        @error_class_matched = false
+        @error_serializer = Gruf.error_serializer
+        @serialized_block_errors = []
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      def valid?
+        run_rpc_call
+        run_serialized_block
+        error_class_matched? && !serialized_block_errors?
+      end
+
+      ##
+      # @return [String]
+      #
+      def error_message
+        if serialized_block_errors?
+          "Failed with serialized error validations: #{@serialized_block_errors.join("\n")}"
+        else
+          "Response class #{@rpc_response.class} did not match expected error class #{@expected_error_class}"
+        end
+      end
+
+      private
+
+      ##
+      # Did the error class match?
+      #
+      def error_class_matched?
+        @error_class_matched
+      end
+
+      ##
+      # Were there any downstream errors in the serialized block chain?
+      #
+      def serialized_block_errors?
+        @serialized_block_errors.any?
+      end
+
+      ##
+      # Was the method chain called with .with_serialized
+      #
+      # @return [Boolean]
+      #
+      def serialized_block?
+        @serialized_block
+      end
+
+      ##
+      # Run the actual rpc call
+      #
+      def run_rpc_call
+        @rpc_response = @rpc_call_proc.call
+      rescue StandardError => e
+        @error_class_matched = e.is_a?(@expected_error_class)
+        @rpc_response = e
+      end
+
+      ##
+      # Run the serialized block, if any, and if the error class matches
+      #
+      def run_serialized_block
+        return unless error_class_matched? && serialized_block?
+
+        @serialized_block.call(deserialize_error)
+        true
+      rescue ::RSpec::Expectations::ExpectationNotMetError, ::RSpec::Expectations::MultipleExpectationsNotMetError => e
+        @serialized_block_errors << e.message
+      end
+
+      ##
+      # Deserialize the error from the response
+      #
+      def deserialize_error
+        @error_serializer.new(@rpc_response.to_status.metadata[Gruf.error_metadata_key.to_sym]).deserialize if @error_serializer
+      end
+    end
+  end
+end

data/lib/gruf/rspec/helpers.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2018-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 'metadata_factory'
+
+module Gruf
+  module Rspec
+    module Helpers
+      ##
+      # @param [Hash] options
+      # @return [Double] The mocked call
+      #
+      def grpc_active_call(options = {})
+        md = _build_active_call_metadata(options)
+        double(:grpc_active_call, metadata: md, output_metadata: options.fetch(:output_metadata, {}))
+      end
+
+      private
+
+      ##
+      # @param [Hash] options
+      #
+      def _build_active_call_metadata(options)
+        Gruf::Rspec::MetadataFactory.new(options).build(options.fetch(:metadata, {}))
+      end
+    end
+  end
+end

data/lib/gruf/rspec/metadata_factory.rb

@@ -0,0 +1,53 @@
+# Copyright (c) 2018-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 Rspec
+    ##
+    # Factory for building metadata in an incoming controller request
+    #
+    class MetadataFactory
+      ##
+      # @param [Hash] options
+      #
+      def initialize(options = {})
+        @options = options || {}
+      end
+
+      ##
+      # @param [Hash] metadata
+      # @return [Hash]
+      #
+      def build(metadata = {})
+        metadata ||= {}
+        authentication_hydrator.hydrate(metadata)
+      end
+
+      private
+
+      ##
+      # @return [Gruf::Rspec::AuthenticationHydrator::Base]
+      #
+      def authentication_hydrator
+        unless @authentication_hydrator
+          auth_type = @options.fetch(:authentication_type, :basic).to_sym
+          auth_type = :base unless Gruf::Rspec.authentication_hydrators.key?(auth_type)
+          @authentication_hydrator = Gruf::Rspec.authentication_hydrators[auth_type].new(@options)
+        end
+        @authentication_hydrator
+      end
+    end
+  end
+end

data/lib/gruf/rspec/version.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2018-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 Rspec
+    VERSION = '0.1.2'.freeze
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: runcite-gruf-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: RSpec assistance library for gruf, including testing helpers
+email:
+- splittingred@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- gruf-rspec.gemspec
+- lib/gruf/rspec.rb
+- lib/gruf/rspec/authentication_hydrators/base.rb
+- lib/gruf/rspec/authentication_hydrators/basic.rb
+- lib/gruf/rspec/configuration.rb
+- lib/gruf/rspec/error_matcher.rb
+- lib/gruf/rspec/helpers.rb
+- lib/gruf/rspec/metadata_factory.rb
+- lib/gruf/rspec/version.rb
+homepage: https://github.com/runciteassociates/gruf-rspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: RSpec assistance library for gruf
+test_files: []