rspec-graphql_response 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67d1e0d86474c6b5f5e99c3d19e3d1645fe35819d5a47a4fd7007af9c9a5700e
+  data.tar.gz: d27339cca95c74fdb174fa0ca6a43116039b449e0b22ef6397ccd76e8eb472d1
+SHA512:
+  metadata.gz: b427ec094b4a8e19865e3d610a14abb32625189f7ea190ca61dbcde61e8582abca4464980e2790bb2d30b8ecbb83912034f4a95bcc1cd8744410328a646ad755
+  data.tar.gz: d0864628a5e6beb9096fe8901f67dd6f75d824af26631e1b66ea97894bd30da4061f6ceb25ffc692461a1e54a50f7e7c56405f89cce6275e919d624c9dd29dc8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.pryrc

@@ -0,0 +1,7 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 'e', 'exit'
+  Pry.commands.alias_command 'f', 'finish'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 's', 'step'
+end

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 [testdouble.com](https://testdouble.com). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rspec-graphql_response.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    rspec-graphql_response (0.1.0)
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    graphql (1.12.4)
+    method_source (1.0.0)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  graphql (~> 1.12)
+  pry
+  pry-byebug
+  rake
+  rspec-graphql_response!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Test Double, Inc.
+
+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/README.md

@@ -0,0 +1,220 @@
+# Rspec::GraphQLResponse
+
+RSpec::GraphQLResponse provides a series of RSpec matchers, helper methods, and other configuration to help simplify
+the testing of responses from the `graphql-ruby` gem and the `<GraphQLSchemaName>.execute` method.
+
+## Installation
+
+Your app must have `graphql-ruby` and `rspec`. With that done, add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-graphql_response'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-graphql_response
+
+## Full Documentation
+
+The full documentation for RSpec::GraphQLResponse can be found in the `/docs`
+folder.
+
+Custom Matchers:
+* [have_errors matcher](/docs/have_errors.md) - validates errors, or lack of, on
+  the GraphQL response
+
+Helper Methods:
+* [operation](/docs/operation.md) - retrieves the results of a named operation
+  from the GraphQL response
+
+Internal API / Development
+
+* [.add_matcher](/docs/add_matcher.md) - add a custom RSpec matcher to the
+  GraphQLResponse matchers
+* [.add_validator](/docs/add_validator.md) - add a custom validator to be used
+  by the custom matchers
+
+## Configuration
+
+To get things rolling, add a configuration block to your `spec_helper.rb` (or other file that gets included in specs, as
+desired). Within this block, you'll need to provide the GraphQL Schema to use for query execution.
+
+```ruby
+RSpec::GraphQLResponse.configure |config| do
+
+  config.graphql_schema = MyGraphQLSchema
+
+end
+```
+
+## Getting Started
+
+There are a number of built-in helper methods and matchers that will allow you to skip the copy & paste work of executing
+a GraphQL Schema `.execute`. These include:
+
+Spec types:
+
+* `type: :graphql`
+
+Helper methods:
+
+* `execute_graphql`
+* `response`
+* `operation`
+
+Matchers:
+
+* `have_errors`
+
+### The `:graphql` Spec Type
+
+To use these custom helpers and matchers, you need to specificy `type: :graphql` as part of your spec's description. For exmaple,
+
+```ruby
+RSpec.describe Some::Thing, type: :graphql do
+
+  # ... 
+
+end
+```
+
+With this `type` set, your specs will have access to all of the `RSpec::GraphQLResponse` code.
+
+### Helper Methods
+
+Executing a GraphQL call from RSpec is not the most challening code to write:
+
+```ruby
+let(:query) do
+  <<-GQL
+    query ListCharacters{
+      characters {
+        id
+        name
+      }
+    }
+  GQL
+end
+
+subject do
+  MySchema.execute(query)
+end
+
+it "does something" do
+  response = subject.to_h
+
+  # expect(response) ...
+end
+```
+
+But copy & paste is often considered a design error, and this code is likely going to be littered throughout your spec files.
+
+#### Use the Built-In `execute_graphql`
+
+To help reduce the copy & paste, `RSpec::GraphQLResponse` has a built-in `execute_graphql` method that looks for a `query` variable
+in your specs.
+
+```ruby
+RSpec.describe Some::Thing, type: :graphql do
+  let(:query) do
+    <<-GQL
+      query ListCharacters{
+        characters {
+          id
+          name
+        }
+      }
+    GQL
+  end
+
+  it "executes the query" do
+    response = execute_graphql.to_h
+
+    # expect(response) ...
+  end
+end
+```
+
+#### Use the Built-In `response`
+
+The reduction in code is good, but the copy & paste of `response = execute_graphql.to_h` will quickly become an issue in the same
+way. The reduce this, `RSpec::GraphQLResponse` provides a built-in `response` helper.
+
+```ruby
+RSpec.describe Some::Thing, type: :graphql do
+  let(:query) do
+    <<-GQL
+      query {
+        characters {
+          id
+          name
+        }
+      }
+    GQL
+  end
+
+  it "executes the query" do
+    expect(response).to include(
+      "data" => {
+        "characters" => { ... }
+      }
+    )
+  end
+end
+```
+
+#### Retrieve operation results with `operation`
+
+Now that the GraphQL query has been executed and a response has been obtained, it's time to check for the results of a GraphQL
+operation. In the previous example, the spec is expecting to find `data` with `characters` in the response hash. To reduce the
+nested hash checking, use the built-in `operation` method to retrieve the `characters`:
+
+```ruby
+RSpec.describe Some::Thing, type: :graphql do
+  let(:query) do
+    <<-GQL
+      query {
+        characters {
+          id
+          name
+        }
+      }
+    GQL
+  end
+
+  it "executes the query" do
+    characters = operation(:characters)
+
+    expect(characters).to include(
+      # ... 
+    )
+  end
+end
+```
+
+Note the lack of `response` use here. Internally, the `operation` method uses the `response` to obtain the data requested. This
+means the entire chain of operations from executing the GraphQL request, to converting the response into a hash, and digging
+through the results to find the correction operation, has been handled behind the scenes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/testdouble/rspec-graphql_response. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rspec::GraphQLResponse project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/testdouble/rspec-graphql_response/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql_response"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/add_matcher.md

@@ -0,0 +1,48 @@
+# Adding RSpec Matchers
+
+RSpec::GraphQLResponse provides a thin layer around RSpec's native `matcher`
+syntax to ensure the matchers you are adding will be included correctly.
+
+This is usefurl whether you are developing new matchers to be included in
+this gem directly, or adding them to your application for your specific needs.
+
+## RSpec::GraphQLResponse.add_matcher
+
+To add a new matcher, call `RSpec::GraphQLResponse.add_matcher`.
+
+```ruby
+RSpec::GraphQLResponse.add_matcher do |some_option|
+  # ... this is a standard RSpec `matcher` block
+  # where you can do anything you would do in RSpec
+
+  match :foo_bar do
+    # do your validation here
+  end
+end
+```
+
+This call is only a wrapper around RSpec's `matcher`. For information on how to
+build your matcher, see the [RSpec project documentation](https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/custom-matchers/define-a-custom-matcher).
+
+## Combined with a Custom Validator
+
+RSpec::GraphQLResponse provides a means of keeping your matcher code clean while
+also making it easy to unit test the logic and messages supplied from the
+matcher, using [RSpec::GraphQLResponse.add_validator](/docs/add_validator.md).
+
+Once a validator has been created, it can be called from a matcher.
+
+```ruby
+RSpec::GraphQLResponse.add_matcher :foo_bar do
+  match do |response|
+    have_errors = RSpec::GraphQLResponse.validator(:foo_bar)
+    @result = have_errors.validate
+  end
+
+  failure_message do |response|
+    @result.reason
+  end
+end
+```
+
+For information on creating a valdator, see the [add validators documentation](/docs/add_validator.md).

data/docs/add_validator.md

@@ -0,0 +1,10 @@
+# Adding Validators
+
+Adding your own matcher is well [documented by the RSpec project](https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/custom-matchers/define-a-custom-matcher).
+What this documentation doesn't cover, however, is unit testing and cleanly
+organizing your matcher code. 
+
+To solve this, RSpec::GraphQLResponse introduced validators - code that is
+called to manage the validation of a graphql response, and provide the failure
+messages. Validators allow your code to be well organized, and unit tested,
+while providing a clean implementation of the matcher, as shown here:

data/docs/have_errors.md

@@ -0,0 +1,127 @@
+# Using the `have_errors` Matcher
+
+The `have_errors` matchers will verify the presence of errors in a graphql
+execution's response. This matcher provides both `.to` and `.not_to` matching
+and messages for all options.
+
+## Basic Use
+
+Check for the presence of `response["errors"]`
+
+```ruby
+it "should have errors" do
+  expect(response).to have_errors
+end
+```
+
+Ensure there are no errors in the `response`
+
+```ruby
+it "should not have errors" do
+  expect(response).to_not have_errors
+end
+```
+
+## Specify Error Count
+
+Check for a specific number of errors, and fail if the response does not have
+that number of errors.
+
+```ruby
+it "should have 3 errors" do
+  expect(response).to have_errors(3)
+end
+```
+
+Ensure the response does not have a specific number of errors.
+
+```ruby
+it "should not have 2 errors" do
+  expect(response).to_not have_errors(2)
+end
+```
+
+### CAUTION: False Positives
+
+Using `.to have_errors(count)` and especially using `.to_not have_errors(count)` is
+potentially dangerous! 
+
+Your test may be ensuring there are not 2 errors, but the underlying code may fail
+for an unknown reason and provide a false positive, saying the test passed because
+there was only one error.
+
+## Specify Error Messages
+
+When checking for errors, it's best to check for specific messages. This ensures
+the errors are what you expected and not something else, helping to prevent
+false positives in your tests.
+
+### Verify Specific Message
+
+```ruby
+it "raises User not found" do
+  expect(response).to have_errors.with_messages("User not found")
+end
+```
+
+This will ensure the `response["errors"]` contains a "User not found" error message.
+
+### Ensure Specifed Error Not Found
+
+```ruby
+it "does not raise User not found" do
+  expect(response).to_not have_errors.with_messages("User not found")
+end
+```
+
+### Fails if Specified Error Found in Array
+
+The `.to_not` form of `.with_messages` will ensure that none of the error messages
+specified are found withing the response.
+
+If, for example the response looks like this:
+
+```
+{
+  "errors" => [
+    {"message" => "User not found"},
+    {"message" => "Invalid ID format"}
+  ]
+}
+```
+
+a test like this would fail:
+
+```ruby
+it "looks for specific errors" do
+  expect(response).to_not have_errors.with_messages("User not found", "Some other errors")
+end
+```
+
+The resulting failure message would state that it was expecting not to find the
+"User not found" message, but it was found. The other non-matching error
+messages would be ignored.
+
+### CAUTION: False Positives
+
+Using `.to_not have_errors.with_messages("Some Message")` is a good way to
+ensure your code is not throwing a specific error message. However, it should
+not be the only expectation against the response. If your code raises any errors
+other than the ones specified, it will result in a passing test but a response
+that still contains errors.
+
+## Combining Count and Specified Messages
+
+The above count and specified messages can be combined in some interesting and
+potentially useful ways. 
+
+### Check for a Count with a Message
+
+```ruby
+it "does interesting things" do
+  expect(response).to have_errors(1).with_messages("User not found")
+end
+```
+
+This example will ensure there is only 1 error, and that it is "User not found".
+This is by far the most accurate way to check for errors, using this matcher.

data/docs/operation.md

@@ -0,0 +1,38 @@
+# Using the `operation` helper
+
+The `operation` helper will dig through a response to find a data
+structure that looks like, 
+
+```ruby
+{
+  "data" => {
+    operation_name
+  }
+}
+```
+
+## Basic Use
+
+```ruby
+it "has characters" do
+  characters = operation(:characters)
+
+  expect(character).to include(
+    { id: 1, name: "Jam" },
+    # ...
+  )
+end
+```
+
+## Handling Nil
+
+If there is no `"data"` or no named operation for the name supplied, the
+`operation` helper will return `nil`
+
+```ruby
+it "returns nil if operation doesn't exist" do
+  character = operation(:something_that_does_not_exist)
+
+  expect(operation).to be_nil
+end
+```

data/lib/rspec/graphql_response.rb

@@ -0,0 +1,29 @@
+require "RSpec"
+
+require_relative "graphql_response/version"
+require_relative "graphql_response/configuration"
+require_relative "graphql_response/validators"
+require_relative "graphql_response/matchers"
+require_relative "graphql_response/helpers"
+
+module RSpec
+  module GraphQLResponse
+    def self.configure(&block)
+      return if block.nil?
+
+      block.call(configuration)
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset_configuration
+      @configuration = nil
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include RSpec::GraphQLResponse, :type => :graphql
+  end
+end

data/lib/rspec/graphql_response/configuration.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module GraphQLResponse
+    class Configuration
+      attr_accessor :graphql_schema, :graphql_query_attribute
+    end
+  end
+end

data/lib/rspec/graphql_response/helpers.rb

@@ -0,0 +1,23 @@
+module RSpec
+  module GraphQLResponse
+    def self.add_helper(name, &helper)
+      helper_module = Module.new do |mod|
+        mod.define_method(name) do |*args|
+          @result ||= self.instance_exec(*args, &helper)
+        end
+      end
+
+      RSpec.configure do |config|
+        config.after(:each) do
+          helper_module.instance_variable_set(:@result, nil)
+        end
+      end
+
+      self.include(helper_module)
+    end
+  end
+end
+
+require_relative "helpers/operation"
+require_relative "helpers/response"
+require_relative "helpers/execute_graphql"

data/lib/rspec/graphql_response/helpers/execute_graphql.rb

@@ -0,0 +1,4 @@
+RSpec::GraphQLResponse.add_helper :execute_graphql do
+  config = RSpec::GraphQLResponse.configuration
+  config.graphql_schema.execute(query)
+end

data/lib/rspec/graphql_response/helpers/operation.rb

@@ -0,0 +1,5 @@
+RSpec::GraphQLResponse.add_helper :operation do |name|
+  return nil unless response.is_a? Hash
+
+  response.dig("data", name.to_s)
+end

data/lib/rspec/graphql_response/helpers/response.rb

@@ -0,0 +1,3 @@
+RSpec::GraphQLResponse.add_helper :response do
+  execute_graphql.to_h
+end

data/lib/rspec/graphql_response/matchers.rb

@@ -0,0 +1,14 @@
+module RSpec
+  module GraphQLResponse
+    def self.add_matcher(name, &matcher)
+      matcher_module = Module.new do |mod|
+        extend RSpec::Matchers::DSL
+        matcher(name, &matcher)
+      end
+
+      self.include(matcher_module)
+    end
+  end
+end
+
+require_relative "matchers/have_errors"

data/lib/rspec/graphql_response/matchers/have_errors.rb

@@ -0,0 +1,37 @@
+RSpec::GraphQLResponse.add_matcher :have_errors do |count = nil|
+  match do |response|
+    have_errors = RSpec::GraphQLResponse.validator(:have_errors)
+
+    @result = have_errors.validate(
+      response,
+      expected_count: count,
+      expected_messages: @messages
+    )
+
+    @result.valid?
+  end
+
+  failure_message do |response|
+    @result.reason
+  end
+
+  match_when_negated do |response|
+    have_errors = RSpec::GraphQLResponse.validator(:have_errors)
+
+    @result = have_errors.validate_negated(
+      response,
+      expected_count: count,
+      expected_messages: @messages
+    )
+
+    @result.valid?
+  end
+
+  failure_message_when_negated do |response|
+    @result.reason
+  end
+
+  chain :with_messages do |*messages|
+    @messages = messages
+  end
+end

data/lib/rspec/graphql_response/validators.rb

@@ -0,0 +1,20 @@
+require_relative "validators/validation_result"
+require_relative "validators/validation_base"
+require_relative "validators/validation_runner"
+
+module RSpec
+  module GraphQLResponse
+    def self.add_validator(name, &validator)
+      @validators ||= {}
+
+      validator_class = Class.new(Validators::ValidationBase, &validator)
+      @validators[name] = validator_class
+    end
+
+    def self.validator(name)
+      @validators[name].new
+    end
+  end
+end
+
+require_relative "validators/have_errors"

data/lib/rspec/graphql_response/validators/have_errors.rb

@@ -0,0 +1,70 @@
+RSpec::GraphQLResponse.add_validator :have_errors do
+  failure_message :nil, "Cannot evaluate nil for errors"
+  failure_message :none, "Expected response to have errors, but found none"
+  failure_message :unmatched, ->(expected, actual) { "Expected\n\t#{expected.inspect}\nbut found\n\t#{actual.inspect}" }
+  failure_message :length, ->(expected, actual) { "Expected response to have #{expected} errors, but found #{actual}" }
+
+  validate do |response, expected_messages: nil, expected_count: nil|
+    next fail_validation(:nil) if response.nil?
+
+    errors = response.fetch("errors", [])
+    actual_messages = errors.map {|e| e["message"] }
+
+    next fail_validation(:none, actual_messages) if errors.length == 0
+
+    with_messages = Array(expected_messages).length > 0
+    with_count = !expected_count.nil?
+
+    if with_count
+      actual_count = errors.length
+      next fail_validation(:length, expected_count, actual_count) if expected_count != actual_count
+    end
+
+    if with_messages
+      unmatched_messages = expected_messages.difference(actual_messages)
+
+      next fail_validation(:unmatched, expected_messages, actual_messages) if unmatched_messages.any?
+    end
+
+    pass_validation 
+  end
+
+  failure_message :negated_nil, "Cannot evaluate nil for errors"
+  failure_message :negated_none, ->(actual) { "Expected response not to have errors, but found\n\t#{actual.inspect}" }
+  failure_message :negated_unmatched, ->(expected, actual) { "Expected not to find any of\n\t#{expected.inspect}\nbut found\n\t#{actual.inspect}" }
+  failure_message :negated_length, ->(expected, actual, messages) { "Expected response not to have #{expected} errors, but found #{actual}\n\t#{messages.inspect}" }
+
+  validate_negated do |response, expected_messages: nil, expected_count: nil|
+    next fail_validation(:negated_nil) if response.nil?
+
+    errors = response.fetch("errors", [])
+    actual_messages = errors.map {|e| e["message"] }
+    actual_count = errors.length
+
+    with_messages = Array(expected_messages).length > 0
+    with_count = !expected_count.nil?
+
+    if !with_count && !with_messages && actual_count != 0
+      next fail_validation(:negated_none, actual_messages)
+    end
+
+    if with_count
+      if expected_count == actual_count
+        next fail_validation(:negated_length, expected_count, actual_count, actual_messages)
+      elsif !with_messages
+        next pass_validation
+      end
+    end
+
+    if with_messages
+      unmatched_messages = expected_messages & actual_messages
+      next fail_validation(:negated_unmatched, expected_messages, unmatched_messages) if unmatched_messages.any?
+    end
+
+    if with_messages || with_count
+      next pass_validation
+    end
+
+    pass_validation 
+  end
+end

data/lib/rspec/graphql_response/validators/validation_base.rb

@@ -0,0 +1,40 @@
+module RSpec
+  module GraphQLResponse
+    module Validators
+      class ValidationBase
+        class << self
+          def failure_message(type, msg)
+            @messages ||= {}
+            @messages[type] = msg
+          end
+
+          def validate(&validate_method)
+            @validate_method = validate_method
+          end
+
+          def validate_negated(&validate_negated_method)
+            @validate_negated_method = validate_negated_method
+          end
+        end
+
+        def validate(response, *args)
+          validate_method = self.class.instance_variable_get(:@validate_method)
+
+          runner = ValidationRunner.new(self)
+          runner.instance_exec(response, *args, &validate_method)
+        end
+
+        def validate_negated(response, *args)
+          validate_negated_method = self.class.instance_variable_get(:@validate_negated_method)
+
+          runner = ValidationRunner.new(self)
+          runner.instance_exec(response, *args, &validate_negated_method)
+        end
+
+        def failure_message(type)
+          self.class.instance_variable_get(:@messages)[type]
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_response/validators/validation_result.rb

@@ -0,0 +1,35 @@
+module RSpec
+  module GraphQLResponse
+    module Validators
+      class ValidationResult
+        def self.pass
+          self.new(true)
+        end
+
+        def self.fail(reason, args)
+          self.new(false, reason, args)
+        end
+
+        def valid?
+          @is_valid
+        end
+
+        def reason
+          if @reason.is_a? Proc
+            @reason = @reason.call(*@args)
+          end
+
+          @reason
+        end
+
+        private
+
+        def initialize(is_valid, reason = nil, args = [])
+          @is_valid = is_valid
+          @reason = reason
+          @args = args
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_response/validators/validation_runner.rb

@@ -0,0 +1,25 @@
+module RSpec
+  module GraphQLResponse
+    module Validators
+      class ValidationRunner
+        attr_reader :validator
+
+        def initialize(validator)
+          @validator = validator
+        end
+
+        protected
+
+        def fail_validation(type, *args)
+          message = validator.failure_message(type)
+          ValidationResult.fail(message, args)
+        end
+
+        def pass_validation
+          ValidationResult.pass
+        end
+
+      end
+    end
+  end
+end

data/lib/rspec/graphql_response/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module GraphQLResponse
+    VERSION = "0.1.0"
+  end
+end

data/rspec-graphql_response.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib/rspec/", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+root = File.expand_path("../lib/rspec/graphql_response/", __FILE__)
+$LOAD_PATH.unshift(root) unless $LOAD_PATH.include?(root)
+
+require_relative "lib/rspec/graphql_response/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-graphql_response"
+  spec.version       = RSpec::GraphQLResponse::VERSION
+  spec.authors       = ["River Lynn Bailey"]
+  spec.email         = ["riverl.bailey@testdouble.com"]
+
+  spec.summary       = %q{Verify ruby-graphql responses with a :graphql spec type}
+  spec.description   = %q{Adds a :graphql rspec type with built-in helpers and matchers for ruby-graphql gem responses}
+  spec.homepage      = "https://github.com/testdouble/rspec-graphql_response"
+  spec.license       = "MIT"
+
+  # 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.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "graphql", "~> 1.12"
+  spec.add_development_dependency "rake", ">= 12.0"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "pry-byebug", "~> 3.8"
+
+  spec.add_runtime_dependency "rspec", "~>3.10"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: rspec-graphql_response
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- River Lynn Bailey
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Adds a :graphql rspec type with built-in helpers and matchers for ruby-graphql
+  gem responses
+email:
+- riverl.bailey@testdouble.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- docs/add_matcher.md
+- docs/add_validator.md
+- docs/have_errors.md
+- docs/operation.md
+- lib/rspec/graphql_response.rb
+- lib/rspec/graphql_response/configuration.rb
+- lib/rspec/graphql_response/helpers.rb
+- lib/rspec/graphql_response/helpers/execute_graphql.rb
+- lib/rspec/graphql_response/helpers/operation.rb
+- lib/rspec/graphql_response/helpers/response.rb
+- lib/rspec/graphql_response/matchers.rb
+- lib/rspec/graphql_response/matchers/have_errors.rb
+- lib/rspec/graphql_response/validators.rb
+- lib/rspec/graphql_response/validators/have_errors.rb
+- lib/rspec/graphql_response/validators/validation_base.rb
+- lib/rspec/graphql_response/validators/validation_result.rb
+- lib/rspec/graphql_response/validators/validation_runner.rb
+- lib/rspec/graphql_response/version.rb
+- rspec-graphql_response.gemspec
+homepage: https://github.com/testdouble/rspec-graphql_response
+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.3
+signing_key:
+specification_version: 4
+summary: Verify ruby-graphql responses with a :graphql spec type
+test_files: []