open_api-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f73e7bbf3bdd35a76c36adcad852ea9e96b005b2d49be0492c9df8e0c24183ee
+  data.tar.gz: 42451d1a200f757dfd77e961f4c54592a739646ba572ed6153bf940d7b68d81d
+SHA512:
+  metadata.gz: 39b8db5cde406f84d045e8b9b2ef1ab63003541033ea208e410bad3da09486b025be6a9047defb269a61101e2330784b751c0bbd8f62b8b7f9eb5817de176d19
+  data.tar.gz: d03479e35b8ad4e01f4a298b83067bcf060391ab1cae527b7ff39bc005f3863896d0b84d63741c35d61294de02d089f1e39ed481c089167b11728669a674bf06

data/.gitignore

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

data/.reek

@@ -0,0 +1,59 @@
+---
+DuplicateMethodCall:
+  exclude:
+  - OpenApi::RSpec::SchemaParser#deep_body_keys
+  - OpenApi::RSpec::SchemaParser#get_deep_keys
+  - OpenApi::RSpec::SchemaParser#initialize
+  - OpenApi::RSpec::SchemaParser#openapi_body_params
+  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_and_response_status
+FeatureEnvy:
+  exclude:
+  - OpenApi::RSpec::SchemaParser#deep_body_keys
+  - OpenApi::RSpec::SchemaParser#get_deep_keys
+  - OpenApi::RSpec::SchemaParser#openapi_required_form_data_params
+  - OpenApi::RSpec::SchemaParser#openapi_required_path_params
+  - OpenApi::RSpec::SchemaParser#openapi_required_query_string_params
+NestedIterators:
+  exclude:
+  - OpenApi::RSpec::SchemaParser#deep_body_keys
+  - OpenApi::RSpec::SchemaParser#get_deep_keys
+  - OpenApi::RSpec::SchemaParser#initialize
+  - OpenApi::RSpec::SchemaParser#openapi_body_params
+TooManyInstanceVariables:
+  exclude:
+  - OpenApi::RSpec::SchemaParser
+TooManyMethods:
+  exclude:
+  - OpenApi::RSpec::SchemaParser
+TooManyStatements:
+  exclude:
+  - initialize
+  - OpenApi::RSpec::SchemaParser#deep_body_keys
+  - OpenApi::RSpec::SchemaParser#get_deep_keys
+  - OpenApi::RSpec::SchemaParser#openapi_body_params
+UncommunicativeVariableName:
+  exclude:
+  - OpenApi::RSpec::SchemaParser#get_deep_keys
+  - OpenApi::RSpec::SchemaParser#initialize
+  - OpenApi::RSpec::SchemaParser#openapi_body_params
+  - OpenApi::RSpec::SchemaParser#openapi_form_data_params
+  - OpenApi::RSpec::SchemaParser#openapi_path_params
+  - OpenApi::RSpec::SchemaParser#openapi_query_string_params
+  - OpenApi::RSpec::SchemaParser#openapi_required_form_data_params
+  - OpenApi::RSpec::SchemaParser#openapi_required_path_params
+  - OpenApi::RSpec::SchemaParser#openapi_required_query_string_params
+  - OpenApi::RSpec::SchemaParser#request_path_params
+  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_body_parameters
+  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_form_data_parameters
+  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_path_parameters
+  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_query_string_parameters
+UtilityFunction:
+  exclude:
+  - OpenApi::RSpec::SchemaParser#has_documented_param_in_openapi_url_fragments
+  - OpenApi::RSpec::SchemaParser#openapi_url_fragment_name
+
+IrresponsibleModule:
+  enabled: false
+
+exclude_paths:
+  - vendor/bundle

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - '**/bin/*'
+    - '*.gemspec'
+    - 'vendor/bundle/**/*'
+  DisplayCopNames: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100

data/.rubocop_todo.yml

@@ -0,0 +1,59 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-02-25 12:32:27 -0700 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 55
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 60
+
+# Offense count: 2
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 190
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 67
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/open_api/rspec/schema_parser.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/open_api/rspec/schema_parser.rb'

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1
+before_script:
+  - bin/lois bundler-audit -c travis -g $GITHUB_CREDENTIALS
+  - bin/lois rubocop -c travis -g $GITHUB_CREDENTIALS
+  - bin/lois reek -c travis -g $GITHUB_CREDENTIALS

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    open_api-rspec (0.1.0)
+      open_api-schema_validator
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman (4.2.0)
+    bundler-audit (0.6.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    byebug (10.0.0)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    httparty (0.16.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json (2.1.0)
+    json-schema (2.8.0)
+      addressable (>= 2.4)
+    lois (0.1.6)
+      activesupport
+      brakeman
+      bundler-audit
+      httparty
+      reek
+      rubocop
+      simplecov
+      thor
+    method_source (0.9.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    open_api-schema_validator (0.1.0)
+      json-schema
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.2)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.0)
+    reek (4.7.3)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.4.0.0, < 2.5)
+      rainbow (~> 2.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.23.0)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  lois
+  open_api-rspec!
+  pry-byebug
+  rake
+  reek
+  rubocop
+  rubocop-rspec
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,97 @@
+# OpenApi::Rspec [![Build Status](https://travis-ci.org/ketiko/open_api-rspec.svg?branch=master)](https://travis-ci.org/ketiko/open_api-rspec)
+
+RSpec matchers and shared examples for OpenApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_api-rspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_api-rspec
+
+## Usage
+
+Test if your swagger.json endpoint is a valid schema.
+
+```ruby
+require 'rails_helper'
+
+RSpec.describe SwaggerController, type: :request do
+  describe '#swagger' do
+    before do
+      get '/swagger.json'
+    end
+
+    it { expect(response).to have_http_status(:ok) }
+    it { expect(response.body).to be_valid_openapi_schema }
+  end
+end
+```
+
+Test that a response body matches a specific OpenApi Schema.
+```ruby
+require 'rails_helper'
+
+RSpec.describe UsersController, type: :request do
+  describe '#show' do
+    before do
+      get '/users/1'
+    end
+
+    it { expect(response).to have_http_status(:ok) }
+    it { expect(response).to match_openapi_response_schema :User }
+  end
+end
+```
+Test that a request spec  matches an OpenApi Schema.
+This will check body, path, query, form data params.
+It will also fail if any unknown params are passed.
+It checks that there is a documented response code and verifies its response schema
+```ruby
+require 'rails_helper'
+
+RSpec.describe UsersController, type: :request do
+  describe '#show' do
+    before do
+      get '/users/1'
+    end
+
+    it { expect(response).to have_http_status(:ok) }
+    it { expect(response).to match_openapi_response_schema :User }
+    it_behaves_like :an_openapi_endpoint
+  end
+end
+```
+
+Note for the endpoint matcher to work you must declare something like the following:
+
+```ruby
+#file: spec/support/openapi_schema.rb
+
+RSpec.shared_context "Shared OpenAPI JSON" do
+  let(:open_api_json) { '{my open api json schema'} }
+end
+
+RSpec.configure do |rspec|
+  rspec.include_context "Shared OpenAPI JSON", type: :request
+end
+```
+
+## 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/[USERNAME]/open_api-rspec.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/code_climate_reek

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'code_climate_reek' 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, 150) =~ /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('reek', 'code_climate_reek')

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'open_api/rspec'
+
+# 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/lois

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'lois' 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, 150) =~ /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('lois', 'lois')

data/bin/reek

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'reek' 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, 150) =~ /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('reek', 'reek')

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, 150) =~ /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/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' 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, 150) =~ /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('rubocop', 'rubocop')

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/lib/open_api/rspec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'open_api/rspec/version'
+require 'open_api/rspec/schema_parser'
+require 'open_api/rspec/matchers/open_api'
+require 'open_api/rspec/shared_examples/open_api'
+
+module OpenApi
+  module Rspec
+  end
+end

data/lib/open_api/rspec/matchers/open_api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module RSpec
+    module Matchers
+      module OpenApi
+        ::RSpec::Matchers.define :match_openapi_response_schema do |schema|
+          match do |response|
+            ::OpenApi::SchemaValidator.validate_schema!(
+              SwaggerSchema.to_h,
+              response.is_a?(Hash) ? response : ::JSON.parse(response.body),
+              fragment: "#/definitions/#{schema}"
+            )
+          end
+        end
+
+        ::RSpec::Matchers.define :be_valid_openapi_schema do
+          match do |string|
+            json = ::JSON.parse(string)
+            ::OpenApi::SchemaValidator.validate!(json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_api/rspec/schema_parser.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module RSpec
+    class SchemaParser
+      attr_reader :openapi_schema, :request, :response, :schema_for_url
+      UUID_REGEX = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
+
+      def initialize(openapi_schema, request, response)
+        @openapi_schema = openapi_schema
+        @request = request
+        @response = response
+
+        url = request.path.gsub(@openapi_schema['basePath'], '')
+        url_fragments = url.split('/')
+
+        @openapi_schema['paths'].each do |path, meta|
+          path_fragments = path.to_s.split('/')
+          next if path_fragments.count != url_fragments.count
+
+          mismatch = false
+          @request_path_params = {}
+          path_fragments.each_with_index do |a, i|
+            if has_documented_param_in_openapi_url_fragments(a)
+              openapi_for_http_method = meta[request.method.to_s.downcase.to_s]
+              unless openapi_for_http_method
+                mismatch = true
+                break
+              end
+              openapi_params = openapi_for_http_method['parameters']
+              unless openapi_params
+                mismatch = true
+                break
+              end
+              openapi_path_params = openapi_params.select do |path_param|
+                path_param['in'].to_s == 'path'
+              end
+              unless openapi_path_params
+                mismatch = true
+                break
+              end
+              meta_param = openapi_path_params.find do |path_param|
+                path_param['name'].to_s == openapi_url_fragment_name(a).to_s
+              end
+              if meta_param
+                case meta_param['type'].to_s
+                when 'integer'
+                  if (url_fragments[i] =~ /\d/) != 0
+                    mismatch = true
+                    break
+                  else
+                    @request_path_params[a.delete('{').delete('}')] = url_fragments[i]
+                    next
+                  end
+                when 'string'
+                  if (url_fragments[i] =~ /#{UUID_REGEX}/) != 0 &&
+                     (url_fragments[i] =~ /[a-zA-Z]+/) != 0
+
+                    mismatch = true
+                    break
+                  else
+                    @request_path_params[a.delete('{').delete('}')] = url_fragments[i]
+                    next
+                  end
+                else
+                  mismatch = true
+                  break
+                end
+              else
+                mismatch = true
+                break
+              end
+            end
+
+            mismatch = a != url_fragments[i]
+            break if mismatch
+          end
+
+          next if mismatch
+
+          @schema_for_url = meta
+
+          break
+        end
+      end
+
+      def has_documented_param_in_openapi_url_fragments(fragment)
+        (fragment =~ /^{.+}$/) == 0
+      end
+
+      def openapi_url_fragment_name(fragment)
+        fragment.match(/^{(.+)}$/).captures.first
+      end
+
+      def request_path_params
+        @request_path_params.map { |k, _| k.to_s }
+      end
+
+      def schema_for_url_and_request_method
+        if schema_for_url
+          schema_for_url[request.method.to_s.downcase.to_s]
+        else
+          {}
+        end
+      end
+
+      def schema_for_url_and_request_method_parameters
+        schema_for_url_and_request_method['parameters'] || [{}]
+      end
+
+      def schema_for_url_and_request_method_query_string_parameters
+        schema_for_url_and_request_method_parameters
+          .select { |p| p['in'].to_s == 'query' }
+      end
+
+      def schema_for_url_and_request_method_path_parameters
+        schema_for_url_and_request_method_parameters
+          .select { |p| p['in'].to_s == 'path' }
+      end
+
+      def schema_for_url_and_request_method_form_data_parameters
+        schema_for_url_and_request_method_parameters
+          .select { |p| p['in'].to_s == 'formData' }
+      end
+
+      def schema_for_url_and_request_method_body_parameters
+        schema_for_url_and_request_method_parameters
+          .select { |p| p['in'].to_s == 'body' }
+      end
+
+      def schema_for_url_and_request_method_and_response_status
+        if schema_for_url_and_request_method['responses']
+          schema = schema_for_url_and_request_method['responses'][response.status.to_s]
+          schema
+        else
+          {}
+        end
+      end
+
+      def openapi_query_string_params
+        schema_for_url_and_request_method_query_string_parameters.map { |p| p['name'].to_s }
+      end
+
+      def openapi_path_params
+        schema_for_url_and_request_method_path_parameters.map { |p| p['name'].to_s }
+      end
+
+      def openapi_form_data_params
+        schema_for_url_and_request_method_form_data_parameters.map { |p| p['name'].to_s }
+      end
+
+      def openapi_body_params
+        schema_for_url_and_request_method_body_parameters.flat_map do |p|
+          if p['schema'].present?
+            scheme = p['schema']['$ref'].tr('/', ' ')[2..-1].strip.split.map(&:to_s)
+            body = @openapi_schema.dig(*scheme)
+            body['properties'].flat_map do |k, v|
+              deep_body_keys(k, v)
+            end
+          else
+            p['name'].to_s
+          end
+        end
+      end
+
+      def deep_body_keys(name, hash)
+        if hash['type'] == 'object'
+          hash['properties'].flat_map do |p_name, p_hash|
+            parent = name.to_s.camelize(:lower).to_s
+            sub_keys = deep_body_keys(p_name, p_hash)
+            sub_keys.flat_map do |sub|
+              "#{parent}##{sub}".to_s
+            end
+          end
+        else
+          [name.to_s.camelize(:lower).to_s]
+        end
+      end
+
+      def openapi_request_params
+        [
+          openapi_query_string_params,
+          openapi_path_params,
+          openapi_form_data_params,
+          openapi_body_params
+        ].flatten.compact
+      end
+
+      def openapi_required_form_data_params
+        schema_for_url_and_request_method_form_data_parameters
+          .select { |p| p['required'] == true }
+          .map { |p| p['name'].to_s }
+      end
+
+      def openapi_required_path_params
+        schema_for_url_and_request_method_path_parameters
+          .select { |p| p['required'] == true }
+          .map { |p| p['name'].to_s }
+      end
+
+      def openapi_required_query_string_params
+        schema_for_url_and_request_method_query_string_parameters
+          .select { |p| p['required'] == true }
+          .map { |p| p['name'].to_s }
+      end
+
+      def request_params
+        valid_params = get_deep_keys(request.params.except('format', 'action', 'controller'))
+
+        valid_params - request_path_params
+      end
+
+      def get_deep_keys(hash)
+        return [] if hash.empty?
+
+        hash.flat_map do |k, v|
+          if v.is_a? Hash
+            parent = k.to_s.camelize(:lower).to_s
+            sub_keys = get_deep_keys(v)
+            sub_keys.map do |sub|
+              "#{parent}##{sub}".to_s
+            end
+          else
+            k.to_s.camelize(:lower).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_api/rspec/shared_examples/open_api.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module RSpec
+    module SharedExamples
+      ::RSpec.shared_examples_for :an_openapi_endpoint do
+        let(:schema_hash) { ::JSON.parse(open_api_json) }
+        let(:schema_parser) { SchemaParser.new(schema_hash, request, response) }
+
+        it 'has openapi documentation for url' do
+          expect(schema_parser.schema_for_url).not_to be_nil
+        end
+
+        it 'matches an allowed http request method' do
+          expect(schema_parser.schema_for_url_and_request_method).not_to be_nil
+        end
+
+        it 'has all required request query parameters' do
+          schema_parser.openapi_required_query_string_params.each do |openapi_param|
+            expect(schema_parser.request_params).to include(openapi_param)
+          end
+        end
+
+        it 'has all required request path parameters' do
+          schema_parser.openapi_required_path_params.each do |openapi_param|
+            expect(schema_parser.request_path_params).to include(openapi_param)
+          end
+        end
+
+        it 'has all required request form data parameters' do
+          schema_parser.openapi_required_form_data_params.each do |openapi_param|
+            expect(schema_parser.request_params).to include(openapi_param)
+          end
+        end
+
+        it 'does not allow undocumented request path parameters' do
+          schema_parser.request_path_params.each do |request_param|
+            expect(schema_parser.openapi_path_params).to include(request_param)
+          end
+        end
+
+        it 'does not allow undocumented request parameters' do
+          schema_parser.request_params.each do |request_param|
+            expect(schema_parser.openapi_request_params).to include(request_param)
+          end
+        end
+
+        it 'matches an allowed http response status' do
+          expect(schema_parser.schema_for_url_and_request_method_and_response_status).not_to be_nil
+        end
+        it 'matches the response schema' do
+          response_schema = schema_parser.schema_for_url_and_request_method_and_response_status
+          results = if response_schema[:schema]
+                      ::OpenApi::SchemaValidator.validate_schema!(
+                        schema_hash,
+                        ::JSON.parse(response.body),
+                        fragment: response_schema[:schema][:$ref]
+                      )
+                    else
+                      response_schema
+                    end
+
+          expect(results).to be_truthy
+        end
+      end
+    end
+  end
+end

data/lib/open_api/rspec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module Rspec
+    VERSION = '0.1.0'
+  end
+end

data/open_api-rspec.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "open_api/rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_api-rspec"
+  spec.version       = OpenApi::Rspec::VERSION
+  spec.authors       = ["Ryan Hansen"]
+  spec.email         = ["ketiko@gmail.com"]
+
+  spec.summary       = %q{RSpec matchers and shared examples for OpenApi}
+  spec.description   = %q{RSpec matchers and shared examples for OpenApi}
+  spec.homepage      = "https://github.com/ketiko/open_api-rspec"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'lois'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry-byebug'
+
+  spec.add_dependency 'rspec'
+  spec.add_dependency 'open_api-schema_validator'
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: open_api-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Hansen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: lois
+  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: rake
+  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: reek
+  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: rubocop
+  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: rubocop-rspec
+  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: simplecov
+  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: pry-byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: open_api-schema_validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec matchers and shared examples for OpenApi
+email:
+- ketiko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/code_climate_reek
+- bin/console
+- bin/lois
+- bin/reek
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- lib/open_api/rspec.rb
+- lib/open_api/rspec/matchers/open_api.rb
+- lib/open_api/rspec/schema_parser.rb
+- lib/open_api/rspec/shared_examples/open_api.rb
+- lib/open_api/rspec/version.rb
+- open_api-rspec.gemspec
+homepage: https://github.com/ketiko/open_api-rspec
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: RSpec matchers and shared examples for OpenApi
+test_files: []