gruf-rspec 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1796bb825639ddd8df3ab127a6a2cf03e5976f0d12dca68b8a74a24332faf2e
-  data.tar.gz: 8423df9c7ca13a86db3933cbff4a65174a13cbbab91a14185398e5afedd7cfd1
+  metadata.gz: da3a95acbe4bf299a1d82f383b43361bdf204473916d06942850fe4fcad330f1
+  data.tar.gz: bf96d2fa48d250c87a660873bbb8568e019e99983aaba8d783688514bec5bd18
 SHA512:
-  metadata.gz: 5f875ab023f68ff4ce0a280db9487a0a265ee872c518e929fd1cd64676207d8493a0ba4f1fcba5f44f2e507523cef29ddaeefd9a24c9fcc9a58ee710c20cac69
-  data.tar.gz: 68ec5d8b6099362e4b06e7bd527d678dc029aa52559911903c6c48386b5c28c2c0d7e4736482f49f9cdb8c93f62774594facde57e372f61d42abcabed93a9024
+  metadata.gz: f73ab1c615fc25f28be00829d70994a54b16bde6b99a2382dfd5f08fc804c863ac0114c44ae9e2ec21be344a694f4586c5979ca2caff99c7800f8fda51ae954f
+  data.tar.gz: 66ea42f5022790b21e539c155d809c74e63c1dd13604a7cf39aef085216b92817f3f69fc8eceace95579a7b4486597397fdb5e1fe658e79db73a4ba75405a191

data/CHANGELOG.md

@@ -2,6 +2,33 @@ Changelog for the gruf-rspec gem.
 
 ### Pending release
 
+### 0.4.0
+
+- Remove unnecessarily strict dev dependencies
+- Adds support for Ruby 3.0 into test suite
+
+### 0.3.0
+
+- [#7] Fix issue where RPC_SPEC_PATH defaulting is hardcoded 
+- Drop support for Ruby < 2.6, add 2.7 tests
+- Update rubocop to 1.0
+
+### 0.2.2
+
+* Loosen rspec dependency
+
+### 0.2.1
+
+* Loosen rack dependency
+
+### 0.2.0
+
+* Deprecate support for Ruby < 2.4
+
+### 0.1.3
+
+* Add ability to include metadata in rpc callsa
+
 ### 0.1.2
 
 * Fix issue with RSPEC_NAMESPACE conflicts with other gems

data/README.md

@@ -1,6 +1,6 @@
 # gruf-rspec
 
-[![Build Status](https://travis-ci.com/bigcommerce/gruf-rspec.svg?token=D3Cc4LCF9BgpUx4dpPpv&branch=master)](https://travis-ci.com/bigcommerce/gruf-rspec) [![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)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-rspec/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-rspec/tree/main) [![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=main)](https://inch-ci.org/github/bigcommerce/gruf-rspec?branch=main)
 
 Assistance helpers and custom type for easy testing [Gruf](https://github.com/bigcommerce/gruf) controllers with 
 [RSpec](https://github.com/rspec/rspec).
@@ -17,12 +17,13 @@ Then add the following code to your `spec_helper.rb`:
 require 'gruf/rspec'
 ``` 
 
-Note that this gem requires at least Gruf 2.5.1+ and RSpec 3.8+.
+Note that this gem requires at least Ruby 2.6+, 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
+* Run the `run_rpc` method with three args: The gRPC method name, the request object
+and the active_call_options. The third argument is optional.
 * Validate the response
 
 ## Example
@@ -46,9 +47,12 @@ To test it, you'd create `spec/rpc/thing_controller_spec.rb`:
 describe ThingController do
   describe '.get_thing' do
     let(:request_proto) { Rpc::GetThingRequest.new(id: rand(1..100)) }
-    
-    subject { run_rpc(:GetThing, request_proto) }
-    
+    let(:metadata) {
+      { 'user_id' => 'axj42i' }
+    }
+
+    subject { run_rpc(:GetThing, request_proto, active_call_options: { metadata: metadata }) }
+
     it 'will return the thing' do
       expect(subject).to be_a(Rpc::GetThingResponse)
       expect(subject.id).to eq request_proto.id
@@ -125,6 +129,23 @@ Gruf::Rspec.configure do |c|
 end
 ```
 
+Alternatively, you can pass configuration of the path via ENV. For example, where 
+`RPC_SPEC_PATH="/spec/rpc_controllers"` is set in a `.env` file:
+
+```bash
+bundle exec dotenv rspec
+```
+
+Or, add `require: false` to the gemspec for the `gruf-rspec` gem, and then explicitly require it after setting the ENV
+var:
+
+```ruby
+Dotenv.load # assuming the .env file has the RPC_SPEC_PATH var set
+# or:
+ENV['RPC_SPEC_PATH'] = '/spec/rpc_controllers'
+require 'gruf/rspec'
+```
+
 ## License
 
 Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved

data/gruf-rspec.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -13,7 +15,7 @@
 # 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__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gruf/rspec/version'
 
@@ -24,19 +26,21 @@ Gem::Specification.new do |spec|
   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.summary       = 'RSpec assistance library for gruf'
+  spec.description   = 'RSpec assistance library for gruf, including testing helpers'
   spec.homepage      = 'https://github.com/bigcommerce/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.required_ruby_version = '>= 2.6'
+
   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_development_dependency 'bundler-audit', '>= 0.6'
+  spec.add_development_dependency 'pry', '>= 0.13'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
+  spec.add_development_dependency 'rubocop', '>= 0.82'
+  spec.add_development_dependency 'simplecov', '>= 0.15'
 
-  spec.add_dependency 'gruf', '~> 2.5', '>= 2.5.1'
-  spec.add_dependency 'rspec', '~> 3.8'
+  spec.add_runtime_dependency 'gruf', '~> 2.5', '>= 2.5.1'
+  spec.add_runtime_dependency 'rspec', '>= 3.8'
 end

data/lib/gruf/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -29,7 +31,13 @@ require_relative 'rspec/configuration'
 require_relative 'rspec/helpers'
 require_relative 'rspec/error_matcher'
 
+##
+# Base gruf module
+#
 module Gruf
+  ##
+  # Base gruf-rspec module
+  #
   module Rspec
     extend Gruf::Rspec::Configuration
   end
@@ -45,16 +53,16 @@ GRUF_RSPEC_RUNNER.configure do |config|
   end
 
   config.before(:each, type: :gruf_controller) do
-    define_singleton_method :run_rpc do |method_name, request, &block|
+    define_singleton_method :run_rpc do |method_name, request, active_call_options: {}, &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,
+        active_call: grpc_active_call(active_call_options),
         message: request
       )
       resp = @gruf_controller.call(@gruf_controller.request.method_key)
-      block.call(resp) if block && block.is_a?(Proc)
+      block.call(resp) if block.is_a?(Proc)
       resp
     end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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

data/lib/gruf/rspec/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -22,12 +24,14 @@ module Gruf
     # Represents configuration settings for the system
     #
     module Configuration
+      DEFAULT_RSPEC_PATH = '/spec/rpc/'
+
       VALID_CONFIG_KEYS = {
         authentication_hydrators: {
           base: Gruf::Rspec::AuthenticationHydrators::Base,
           basic: Gruf::Rspec::AuthenticationHydrators::Basic
         },
-        rpc_spec_path: '/spec/rpc/'.freeze
+        rpc_spec_path: ENV.fetch('RPC_SPEC_PATH', DEFAULT_RSPEC_PATH).to_s
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys
@@ -69,9 +73,9 @@ module Gruf
       #
       def reset
         VALID_CONFIG_KEYS.each do |k, v|
-          send((k.to_s + '='), v)
+          send("#{k}=", v)
         end
-        self.rpc_spec_path = '/spec/rpc/'.freeze
+        self.rpc_spec_path = ::ENV.fetch('RPC_SPEC_PATH', DEFAULT_RSPEC_PATH).to_s
         options
       end
     end

data/lib/gruf/rspec/error_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -110,7 +112,7 @@ module Gruf
       # 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
+        @error_serializer&.new(@rpc_response.to_status.metadata[Gruf.error_metadata_key.to_sym])&.deserialize
       end
     end
   end

data/lib/gruf/rspec/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -17,6 +19,9 @@ require_relative 'metadata_factory'
 
 module Gruf
   module Rspec
+    ##
+    # Module for including rspec helpers
+    #
     module Helpers
       ##
       # @param [Hash] options

data/lib/gruf/rspec/metadata_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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

data/lib/gruf/rspec/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -15,6 +17,6 @@
 #
 module Gruf
   module Rspec
-    VERSION = '0.1.2'.freeze
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: gruf-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.82'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: gruf
   requirement: !ruby/object:Gem::Requirement
@@ -76,14 +104,14 @@ dependencies:
   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
@@ -109,7 +137,7 @@ homepage: https://github.com/bigcommerce/gruf-rspec
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,15 +145,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.17
+signing_key:
 specification_version: 4
 summary: RSpec assistance library for gruf
 test_files: []