swagalicious 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 941a558739b2079027c117ccea67ffc90c7a21f682811ab817a739ef0ea93d82
+  data.tar.gz: 275cce80dedbfcaa5b5e76d01499fe18babcc7e30a948806ad95df1cea46d475
+SHA512:
+  metadata.gz: 2e8f90a288217b8e27e85411194a73a7f5d1bbe7bd8881a1f086c11319b8ee9a832143bc9c610a8398fb11051484be70f828f3a1625d5c2180d5e1d1194e5121
+  data.tar.gz: 181ff6d1a9dcab5b13499f648b75299f4ab6321c2ea4d65956a94d4bd8b62f90d8e049c771629ed457ca828635f7f90ab35f9bba630b437d0ebb11136d0cdb19

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,74 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  DisabledByDefault: true
+  Exclude:
+    - "cypress/**/*"
+    - "db/migrations/**/*.rb"
+    - "docs/**/*"
+    - "node_modules/**/*"
+    - "private/**/*"
+    - "public/**/*"
+    - "static/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/ExtraSpacing:
+  Enabled: true
+  ForceEqualSignAlignment: true
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+RSpec/AlignLeftLetBrace:
+  Enabled: true
+
+RSpec/DescribedClass:
+  EnforcedStyle: described_class
+
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: true
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: ruby19
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/SignalException:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in swagalicious.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    swagalicious (0.1.0)
+      faraday (~> 1.0.1)
+      json-schema (~> 2.8.1)
+      oj (~> 3.10.14)
+      rack-test (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    multipart-post (2.1.1)
+    oj (3.10.14)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  swagalicious!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Eugene Howe
+
+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,65 @@
+# Swagalicious
+
+This gem is an implementation of https://github.com/rswag/rswag/blob/master/rswag-specs that does not rely on Rails. Most of the code is a blatant copy/paste from that repo, most of the credit goes to them.
+
+Currenty it does not implement any API or UI. In the application that is using this gem, we are using https://github.com/Redocly/redoc that is accessed through a rack middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagalicious'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install swagalicious
+
+## Usage
+
+Add the following to your `spec_helper.rb` or add a new `swagger_helper.rb`
+
+```ruby
+require 'swagalicious`
+
+DEFINITIONS = Oj.load(File.read(File.expand_path("docs/definitions.json", __dir__))).freeze
+
+RSpec.configure do |c|
+  c.swagger_root = "public/swagger_docs" # This is the relative path where the swagger docs will be output
+  c.swagger_docs = {
+    "path/to/swagger_doc.json" => {
+      swagger:  "3.0",
+      basePath: "/api/",
+      version:  "v1",
+      info:     {
+        title: "Namespace for my API"
+      },
+      components: {
+        securitySchemes: {
+          apiKey: {
+            type: :apiKey,
+            name: "authorization",
+            in:   :header,
+          }
+        }
+      },
+    }
+  }
+end
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eugene@xtreme-computers.net/swagalicious.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "swagalicious"
+
+# 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/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/core/ext/hash.rb

@@ -0,0 +1,19 @@
+class Hash
+  def deep_merge!(other_hash)
+    self.merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+      newval = newval.to_hash if newval.respond_to?(:to_hash)
+      oldval.class.to_s == "Hash" && newval.class.to_s == "Hash" ? oldval.deep_merge(newval) : newval
+    end
+  end
+
+  def slice(*keep_keys)
+    h                                              = {}
+    keep_keys.each { |key| has_key?(key) && h[key] = fetch(key, nil) }
+    h
+  end
+
+  def except(*less_keys)
+    slice(*keys - less_keys)
+  end
+end

data/lib/swagalicious.rb

@@ -0,0 +1,30 @@
+require "rspec/core"
+
+require_relative "swagalicious/version"
+
+module Swagalicious
+  class Error < StandardError; end
+
+  require_relative "swagalicious/configuration"
+  require_relative "swagalicious/example_group_helpers"
+  require_relative "swagalicious/example_helpers"
+  require_relative "swagalicious/extended_schema"
+  require_relative "swagalicious/request_factory"
+  require_relative "swagalicious/response_validator"
+  require_relative "swagalicious/swagger_formatter"
+
+  ::RSpec::Core::ExampleGroup.define_example_group_method :path
+
+  ::RSpec.configure do |c|
+    c.add_setting :swagger_format
+    c.add_setting :swagger_root
+    c.add_setting :swagger_docs
+    c.add_setting :swagger_dry_run
+    c.extend Swagalicious::ExampleGroupHelpers, type: :doc
+    c.include Swagalicious::ExampleHelpers, type: :doc
+  end
+
+  def self.config
+    @config ||= Swagalicious::Configuration.new(RSpec.configuration)
+  end
+end

data/lib/swagalicious/configuration.rb

@@ -0,0 +1,53 @@
+module Swagalicious
+  class ConfigurationError < StandardError; end
+
+  class Configuration
+    def initialize(rspec_config)
+      @rspec_config = rspec_config
+    end
+
+    def swagger_root
+      @swagger_root ||= begin
+                          if @rspec_config.swagger_root.nil?
+                            raise ConfigurationError, "No swagger_root provided. See swagger_helper.rb"
+                          end
+                          @rspec_config.swagger_root
+                        end
+    end
+
+    def swagger_docs
+      @swagger_docs ||= begin
+                          if @rspec_config.swagger_docs.nil? || @rspec_config.swagger_docs.empty?
+                            raise ConfigurationError, "No swagger_docs defined. See swagger_helper.rb"
+                          end
+                          @rspec_config.swagger_docs
+                        end
+    end
+
+    def swagger_dry_run
+      @swagger_dry_run ||= begin
+                             @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
+                           end
+    end
+
+    def swagger_format
+      @swagger_format ||= begin
+                            @rspec_config.swagger_format = :json if @rspec_config.swagger_format.nil? || @rspec_config.swagger_format.empty?
+                            raise ConfigurationError, "Unknown swagger_format '#{@rspec_config.swagger_format}'" unless [:json, :yaml].include?(@rspec_config.swagger_format)
+                            @rspec_config.swagger_format
+                          end
+    end
+
+    def get_swagger_doc(name)
+      return swagger_docs.values.first if name.nil?
+      raise ConfigurationError, "Unknown swagger_doc '#{name}'" unless swagger_docs[name]
+
+      swagger_docs[name]
+    end
+
+    def get_swagger_doc_version(name)
+      doc = get_swagger_doc(name)
+      doc[:openapi] || doc[:swagger]
+    end
+  end
+end

data/lib/swagalicious/example_group_helpers.rb

@@ -0,0 +1,79 @@
+module Swagalicious
+  module ExampleGroupHelpers
+    def path(template, metadata={}, &block)
+      metadata[:path_item] = { template: template }
+      describe(template, metadata, &block)
+    end
+
+    [ :get, :post, :patch, :put, :delete, :head ].each do |verb|
+      define_method(verb) do |summary, &block|
+        api_metadata = { operation: { verb: verb, summary: summary } }
+        describe(verb, api_metadata, &block)
+      end
+    end
+
+    [ :operationId, :deprecated, :security ].each do |attr_name|
+      define_method(attr_name) do |value|
+        metadata[:operation][attr_name] = value
+      end
+    end
+
+    # NOTE: 'description' requires special treatment because ExampleGroup already
+    # defines a method with that name. Provide an override that supports the existing
+    # functionality while also setting the appropriate metadata if applicable
+    def description(value=nil)
+      return super() if value.nil?
+      metadata[:operation][:description] = value
+    end
+
+    # These are array properties - note the splat operator
+    [ :tags, :consumes, :produces, :schemes ].each do |attr_name|
+      define_method(attr_name) do |*value|
+        metadata[:operation][attr_name] = value
+      end
+    end
+
+    def parameter(attributes)
+      if attributes[:in] && attributes[:in].to_sym == :path
+        attributes[:required] = true
+      end
+
+      if metadata.has_key?(:operation)
+        metadata[:operation][:parameters] ||= []
+        metadata[:operation][:parameters] << attributes
+      else
+        metadata[:path_item][:parameters] ||= []
+        metadata[:path_item][:parameters] << attributes
+      end
+    end
+
+    def response(code, description, metadata={}, &block)
+      metadata[:response] = { code: code, description: description }
+      context(description, metadata, &block)
+    end
+
+    def schema(value)
+      metadata[:response][:schema] = value
+    end
+
+    def header(name, attributes)
+      metadata[:response][:headers]     ||= {}
+      metadata[:response][:headers][name] = attributes
+    end
+
+    # NOTE: Similar to 'description', 'examples' need to handle the case when
+    # being invoked with no params to avoid overriding 'examples' method of
+    # rspec-core ExampleGroup
+    def examples(example = nil)
+      return super() if example.nil?
+      metadata[:response][:examples] = example
+    end
+
+    def validate_schema!(mocked: false, mock_name: nil)
+      it "returns a #{metadata[:response][:code]} response" do |example|
+        yield if block_given?
+        submit_request(example.metadata, mocked: mocked, mock_name: mock_name)
+      end
+    end
+  end
+end

data/lib/swagalicious/example_helpers.rb

@@ -0,0 +1,65 @@
+require "faraday"
+require "faraday/adapter/rack"
+require "rack"
+require "oj"
+
+require_relative "response_validator"
+
+module Swagalicious
+  module ExampleHelpers
+    include Rack::Test::Methods
+
+    class MockResponse
+      attr_reader :body, :status, :headers
+
+      def initialize(file_name)
+        @body    = File.read(File.expand_path("#{File.join(ENV["MOCK_PATH"], file_name)}.json", __FILE__))
+        @status  = 200
+        @headers = {}
+      end
+    end
+
+    def app
+      @app ||= Rack::Builder.parse_file("config.ru").first
+    end
+
+    def client
+      @client ||= Faraday.new do |b|
+        b.adapter Faraday::Adapter::Rack, app
+      end
+    end
+
+    def submit_request(metadata, mocked: false, mock_name: nil)
+      request = RequestFactory.new.build_request(metadata, self)
+
+      response = if mocked
+                   file_name = File.basename(mock_name || URI.parse(request[:path]).path)
+
+                   MockResponse.new(file_name)
+                 else
+                   client.public_send(request[:verb]) do |req|
+                     req.url request[:path].gsub("//", "/")
+                     req.headers = request[:headers]
+                     req.body    = request[:payload]
+                   end
+                 end
+
+      body = response.body
+      body = "{}" if body.empty?
+
+      @body = Oj.load(body, symbol_keys: true)
+
+      if request[:payload]
+        metadata[:response][:request] = Oj.load(request[:payload])
+      end
+
+      metadata[:response][:examples]                   ||= {}
+      metadata[:response][:examples]["application/json"] = @body
+
+      # Validates response matches the proper schema
+      Swagalicious::ResponseValidator.new.validate!(metadata, response)
+
+      response
+    end
+  end
+end

data/lib/swagalicious/extended_schema.rb

@@ -0,0 +1,21 @@
+require "json-schema"
+
+module Swagalicious
+  class ExtendedSchema < JSON::Schema::Draft4
+    def initialize
+      super
+      @attributes["type"] = ExtendedTypeAttribute
+      @uri                = URI.parse("http://tempuri.org/swagalicious/extended_schema")
+      @names              = ["http://tempuri.org/swagalicious/extended_schema"]
+    end
+  end
+
+  class ExtendedTypeAttribute < JSON::Schema::TypeV4Attribute
+    def self.validate(current_schema, data, fragments, processor, validator, options={})
+      return if data.nil? && current_schema.schema["null"] == true
+      super
+    end
+  end
+
+  JSON::Validator.register_validator(ExtendedSchema.new)
+end

data/lib/swagalicious/request_factory.rb

@@ -0,0 +1,187 @@
+require "faraday"
+require "faraday/adapter/rack"
+
+module Swagalicious
+  class RequestFactory
+    def initialize(config = ::Swagalicious.config)
+      @config = config
+    end
+
+    def build_request(metadata, example)
+      swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
+      parameters  = expand_parameters(metadata, swagger_doc, example)
+
+      {}.tap do |request|
+        add_verb(request, metadata)
+        add_path(request, metadata, swagger_doc, parameters, example)
+        add_headers(request, metadata, swagger_doc, parameters, example)
+        add_payload(request, parameters, example)
+      end
+    end
+
+    private
+
+    def expand_parameters(metadata, swagger_doc, example)
+      operation_params = metadata[:operation][:parameters] || []
+      path_item_params = metadata[:path_item][:parameters] || []
+      security_params  = derive_security_params(metadata, swagger_doc)
+
+      # NOTE: Use of + instead of concat to avoid mutation of the metadata object
+      (operation_params + path_item_params + security_params)
+        .map { |p| p["$ref"] ? resolve_parameter(p["$ref"], swagger_doc) : p }
+        .uniq { |p| p[:name] }
+        .reject { |p| p[:required] == false && !example.respond_to?(p[:name]) }
+    end
+
+    def derive_security_params(metadata, swagger_doc)
+      requirements = metadata[:operation][:security] || swagger_doc[:security] || []
+      scheme_names = requirements.flat_map(&:keys)
+      schemes      = security_version(scheme_names, swagger_doc)
+
+      schemes.map do |scheme|
+        param = (scheme[:type] == :apiKey) ? scheme.slice(:name, :in) : { name: "Authorization", in: :header }
+        param.merge(type: :string, required: requirements.one?)
+      end
+    end
+
+    def security_version(scheme_names, swagger_doc)
+      if swagger_doc.key?(:securityDefinitions)
+        puts "Swagalicious: WARNING: securityDefinitions is replaced in OpenAPI3! Rename to components/securitySchemes (in swagger_helper.rb)"
+        swagger_doc[:components] ||= { securitySchemes: swagger_doc[:securityDefinitions] }
+        swagger_doc.delete(:securityDefinitions)
+      end
+      components = swagger_doc[:components] || {}
+      (components[:securitySchemes] || {}).slice(*scheme_names).values
+    end
+
+    def resolve_parameter(ref, swagger_doc)
+      key         = key_version(ref, swagger_doc)
+      definitions = definition_version(swagger_doc)
+      raise "Referenced parameter '#{ref}' must be defined" unless definitions && definitions[key]
+
+      definitions[key]
+    end
+
+    def key_version(ref, swagger_doc)
+      if ref.start_with?("#/parameters/")
+        puts "Swagalicious: WARNING: #/parameters/ refs are replaced in OpenAPI3! Rename to #/components/parameters/"
+        ref.sub("#/parameters/", "").to_sym
+      else
+        ref.sub("#/components/parameters/", "").to_sym
+      end
+    end
+
+    def definition_version(swagger_doc)
+      if swagger_doc.key?(:parameters)
+        puts "Swagalicious: WARNING: parameters is replaced in OpenAPI3! Rename to components/parameters (in swagger_helper.rb)"
+        swagger_doc[:parameters]
+      else
+        components = swagger_doc[:components] || {}
+        components[:parameters]
+      end
+    end
+
+    def add_verb(request, metadata)
+      request[:verb] = metadata[:operation][:verb]
+    end
+
+    def add_path(request, metadata, swagger_doc, parameters, example)
+      template = (swagger_doc[:basePath] || "") + metadata[:path_item][:template]
+
+      request[:path] = template.tap do |path_template|
+        parameters.select { |p| p[:in] == :path }.each do |p|
+          path_template.gsub!("{#{p[:name]}}", example.send(p[:name]).to_s)
+        end
+
+        parameters.select { |p| p[:in] == :query }.each_with_index do |p, i|
+          path_template.concat(i.zero? ? "?" : "&")
+          path_template.concat(build_query_string_part(p, example.send(p[:name])))
+        end
+      end
+    end
+
+    def build_query_string_part(param, value)
+      name = param[:name]
+      return "#{name}=#{value}" unless param[:type].to_sym == :array
+
+      case param[:collectionFormat]
+      when :ssv
+        "#{name}=#{value.join(" ")}"
+      when :tsv
+        "#{name}=#{value.join("\t")}"
+      when :pipes
+        "#{name}=#{value.join("|")}"
+      when :multi
+        value.map { |v| "#{name}=#{v}" }.join("&")
+      else
+        "#{name}=#{value.join(",")}" # csv is default
+      end
+    end
+
+    def add_headers(request, metadata, swagger_doc, parameters, example)
+      tuples = parameters
+        .select { |p| p[:in] == :header }
+        .map { |p| [p[:name], example.send(p[:name]).to_s] }
+
+      # Accept header
+      produces = metadata[:operation][:produces] || swagger_doc[:produces]
+      if produces
+        accept = example.respond_to?(:Accept) ? example.send(:Accept) : produces.first
+        tuples << ["Accept", accept]
+      end
+
+      # Content-Type header
+      consumes = metadata[:operation][:consumes] || swagger_doc[:consumes]
+      if consumes
+        content_type = example.respond_to?(:"Content-Type") ? example.send(:"Content-Type") : consumes.first
+        tuples << ["Content-Type", content_type]
+      end
+
+      # Rails test infrastructure requires rackified headers
+      rackified_tuples = tuples.map do |pair|
+        [
+          case pair[0]
+          when "Accept" then "HTTP_ACCEPT"
+          when "Content-Type" then "CONTENT_TYPE"
+          when "Authorization" then "HTTP_AUTHORIZATION"
+          else pair[0]
+          end,
+          pair[1]
+        ]
+      end
+
+      request[:headers] = Hash[rackified_tuples]
+    end
+
+    def add_payload(request, parameters, example)
+      content_type = request[:headers]["CONTENT_TYPE"]
+      return if content_type.nil?
+
+      if ["application/x-www-form-urlencoded", "multipart/form-data"].include?(content_type)
+        request[:payload] = build_form_payload(parameters, example)
+      else
+        request[:payload] = build_json_payload(parameters, example)
+      end
+    end
+
+    def build_form_payload(parameters, example)
+      # See http://seejohncode.com/2012/04/29/quick-tip-testing-multipart-uploads-with-rspec/
+      # Rather that serializing with the appropriate encoding (e.g. multipart/form-data),
+      # Rails test infrastructure allows us to send the values directly as a hash
+      # PROS: simple to implement, CONS: serialization/deserialization is bypassed in test
+      tuples = parameters
+        .select { |p| p[:in] == :formData }
+        .map { |p| [p[:name], example.send(p[:name])] }
+      Hash[tuples]
+    end
+
+    def build_json_payload(parameters, example)
+      body_param = parameters.select { |p| p[:in] == :body }.first
+      body_param ? example.send(body_param[:name]).to_json : nil
+    end
+
+    def doc_version(doc)
+      doc[:openapi] || doc[:swagger] || "3"
+    end
+  end
+end

data/lib/swagalicious/response_validator.rb

@@ -0,0 +1,64 @@
+require "json"
+
+module Swagalicious
+  class UnexpectedResponse < StandardError; end
+
+  class ResponseValidator
+    def initialize(config = ::Swagalicious::config)
+      @config = config
+    end
+
+    def validate!(metadata, response)
+      swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
+
+      validate_code!(metadata, response.status)
+      validate_headers!(metadata, response.headers)
+      validate_body!(metadata, swagger_doc, response.body)
+    end
+
+    private
+
+    def validate_code!(metadata, response)
+      expected = metadata[:response][:code].to_s
+      if response.to_s != expected.to_s
+        raise UnexpectedResponse, "Expected response code '#{response}' to match '#{expected}'"
+      end
+    end
+
+    def validate_headers!(metadata, headers)
+      expected = (metadata[:response][:headers] || {}).keys
+      expected.each do |name|
+        raise UnexpectedResponse, "Expected response header #{name} to be present" if headers[name.to_s].nil?
+      end
+    end
+
+    def validate_body!(metadata, swagger_doc, body)
+      response_schema = metadata[:response][:schema]
+      return if response_schema.nil?
+
+      version = @config.get_swagger_doc_version(metadata[:swagger_doc])
+      schemas = definitions_or_component_schemas(swagger_doc, version)
+
+      validation_schema = response_schema
+        .merge("$schema" => "http://tempuri.org/swagalicious/extended_schema")
+        .merge(schemas)
+
+      errors = JSON::Validator.fully_validate(validation_schema, body)
+      raise UnexpectedResponse, "Expected response body to match schema: #{errors[0]}" if errors.any?
+    end
+
+    def definitions_or_component_schemas(swagger_doc, version)
+      if version.start_with?("2")
+        swagger_doc.slice(:definitions)
+      else # Openapi3
+        if swagger_doc.key?(:definitions)
+          puts "Swagger::Specs: WARNING: definitions is replaced in OpenAPI3! Rename to components/schemas (in swagger_helper.rb)"
+          swagger_doc.slice(:definitions)
+        else
+          components = swagger_doc[:components] || {}
+          { components: { schemas: components[:schemas] } }
+        end
+      end
+    end
+  end
+end

data/lib/swagalicious/swagger_formatter.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require_relative "../core/ext/hash"
+
+module Swagalicious
+  class SwaggerFormatter
+    RSpec::Core::Formatters.register self, :example_group_finished, :stop
+
+    def initialize(output, config = Swagalicious.config)
+      @output = output
+      @config = config
+
+      @output.puts "Generating Swagger docs ..."
+    end
+
+    def example_group_finished(notification)
+      metadata = notification.group.metadata
+
+      # !metadata[:document] won"t work, since nil means we should generate
+      # docs.
+      return if metadata[:document] == false
+      return unless metadata.key?(:response)
+
+      swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
+
+      # This is called multiple times per file!
+      # metadata[:operation] is also re-used between examples within file
+      # therefore be careful NOT to modify its content here.
+      upgrade_request_type!(metadata)
+      upgrade_servers!(swagger_doc)
+      upgrade_oauth!(swagger_doc)
+      upgrade_response_produces!(swagger_doc, metadata)
+
+      swagger_doc.deep_merge!(metadata_to_swagger(metadata))
+    end
+
+    def stop(_notification = nil)
+      @config.swagger_docs.each do |url_path, doc|
+        unless doc_version(doc).start_with?("2")
+          doc[:paths]&.each_pair do |_k, v|
+            v.each_pair do |_verb, value|
+              is_hash = value.is_a?(Hash)
+              if is_hash && value.dig(:parameters)
+                schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
+                mime_list    = value.dig(:consumes)
+                if value && schema_param && mime_list
+                  value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
+                  mime_list.each do |mime|
+                    value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
+                  end
+                end
+
+                value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
+              end
+              remove_invalid_operation_keys!(value)
+            end
+          end
+        end
+
+        file_path = File.join(@config.swagger_root, url_path)
+        dirname   = File.dirname(file_path)
+        FileUtils.mkdir_p dirname unless File.exist?(dirname)
+
+        File.open(file_path, "w") do |file|
+          file.write(pretty_generate(doc))
+        end
+
+        @output.puts "Swagger doc generated at #{file_path}"
+      end
+    end
+
+    private
+
+    def pretty_generate(doc)
+      if @config.swagger_format == :yaml
+        clean_doc = yaml_prepare(doc)
+        YAML.dump(clean_doc)
+      else # config errors are thrown in "def swagger_format", no throw needed here
+        JSON.pretty_generate(doc)
+      end
+    end
+
+    def yaml_prepare(doc)
+      json_doc = JSON.pretty_generate(doc)
+      JSON.parse(json_doc)
+    end
+
+    def metadata_to_swagger(metadata)
+      response_code = metadata[:response][:code]
+      response      = metadata[:response].reject { |k, _v| k == :code }
+
+      verb      = metadata[:operation][:verb]
+      operation = metadata[:operation]
+        .reject { |k, _v| k == :verb }
+        .merge(responses: { response_code => response })
+
+      path_template = metadata[:path_item][:template]
+      path_item     = metadata[:path_item]
+        .reject { |k, _v| k == :template }
+        .merge(verb => operation)
+
+      { paths: { path_template => path_item } }
+    end
+
+    def doc_version(doc)
+      doc[:openapi] || doc[:swagger] || "3"
+    end
+
+    def upgrade_response_produces!(swagger_doc, metadata)
+      # Accept header
+      mime_list   = Array(metadata[:operation][:produces] || swagger_doc[:produces])
+      target_node = metadata[:response]
+      upgrade_content!(mime_list, target_node)
+      metadata[:response].delete(:schema)
+    end
+
+    def upgrade_content!(mime_list, target_node)
+      target_node.merge!(content: {})
+      schema = target_node[:schema]
+      return if mime_list.empty? || schema.nil?
+
+      mime_list.each do |mime_type|
+        # TODO upgrade to have content-type specific schema
+        target_node[:content][mime_type] = { schema: schema }
+      end
+    end
+
+    def upgrade_request_type!(metadata)
+      # No deprecation here as it seems valid to allow type as a shorthand
+      operation_nodes = metadata[:operation][:parameters] || []
+      path_nodes      = metadata[:path_item][:parameters] || []
+      header_node     = metadata[:response][:headers] || {}
+
+      (operation_nodes + path_nodes + [header_node]).each do |node|
+        if node && node[:type] && node[:schema].nil?
+          node[:schema] = { type: node[:type] }
+          node.delete(:type)
+        end
+      end
+    end
+
+    def upgrade_servers!(swagger_doc)
+      return unless swagger_doc[:servers].nil? && swagger_doc.key?(:schemes)
+
+      puts "Swagalicious: WARNING: schemes, host, and basePath are replaced in OpenAPI3! Rename to array of servers[{url}] (in swagger_helper.rb)"
+
+      swagger_doc[:servers] = { urls: [] }
+      swagger_doc[:schemes].each do |scheme|
+        swagger_doc[:servers][:urls] << scheme + "://" + swagger_doc[:host] + swagger_doc[:basePath]
+      end
+
+      swagger_doc.delete(:schemes)
+      swagger_doc.delete(:host)
+      swagger_doc.delete(:basePath)
+    end
+
+    def upgrade_oauth!(swagger_doc)
+      # find flow in securitySchemes (securityDefinitions will have been re-written)
+      schemes = swagger_doc.dig(:components, :securitySchemes)
+      return unless schemes&.any? { |_k, v| v.key?(:flow) }
+
+      schemes.each do |name, v|
+        next unless v.key?(:flow)
+
+        puts "Swagalicious: WARNING: securityDefinitions flow is replaced in OpenAPI3! Rename to components/securitySchemes/#{name}/flows[] (in swagger_helper.rb)"
+
+        flow = swagger_doc[:components][:securitySchemes][name].delete(:flow).to_s
+
+        if flow == "accessCode"
+          puts "Swagalicious: WARNING: securityDefinitions accessCode is replaced in OpenAPI3! Rename to clientCredentials (in swagger_helper.rb)"
+          flow = "authorizationCode"
+        end
+
+        if flow == "application"
+          puts "Swagalicious: WARNING: securityDefinitions application is replaced in OpenAPI3! Rename to authorizationCode (in swagger_helper.rb)"
+          flow = "clientCredentials"
+        end
+
+        flow_elements = swagger_doc[:components][:securitySchemes][name].except(:type).each_with_object({}) do |(k, _v), a|
+          a[k] = swagger_doc[:components][:securitySchemes][name].delete(k)
+        end
+
+        swagger_doc[:components][:securitySchemes][name].merge!(flows: { flow => flow_elements })
+      end
+    end
+
+    def remove_invalid_operation_keys!(value)
+      is_hash = value.is_a?(Hash)
+      value.delete(:consumes) if is_hash && value.dig(:consumes)
+      value.delete(:produces) if is_hash && value.dig(:produces)
+    end
+  end
+end

data/lib/swagalicious/version.rb

@@ -0,0 +1,3 @@
+module Swagalicious
+  VERSION = "0.1.0"
+end

data/swagalicious.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/swagalicious/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagalicious"
+  spec.version       = Swagalicious::VERSION
+  spec.authors       = ["Eugene Howe"]
+  spec.email         = ["eugene@xtreme-computers.net"]
+
+  spec.summary               = %q{RSwag without Rails}
+  spec.description           = %q{This gem is almost a straight copy and paste of https://github.com/rswag/rswag/tree/master/rswag-specs with the Rails specific code stripped out so it can be used in Rack applications that don't use Rails.}
+  spec.homepage              = "https://github.com/ehowe/swagalicious"
+  spec.license               = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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_dependency "faraday",     "~> 1.0.1"
+  spec.add_dependency "json-schema", "~> 2.8.1"
+  spec.add_dependency "oj",          "~> 3.10.14"
+  spec.add_dependency "rack-test",   "~> 1.1.0"
+  spec.add_dependency "rspec",       "~> 3.9.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: swagalicious
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugene Howe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.14
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: This gem is almost a straight copy and paste of https://github.com/rswag/rswag/tree/master/rswag-specs
+  with the Rails specific code stripped out so it can be used in Rack applications
+  that don't use Rails.
+email:
+- eugene@xtreme-computers.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/core/ext/hash.rb
+- lib/swagalicious.rb
+- lib/swagalicious/configuration.rb
+- lib/swagalicious/example_group_helpers.rb
+- lib/swagalicious/example_helpers.rb
+- lib/swagalicious/extended_schema.rb
+- lib/swagalicious/request_factory.rb
+- lib/swagalicious/response_validator.rb
+- lib/swagalicious/swagger_formatter.rb
+- lib/swagalicious/version.rb
+- swagalicious.gemspec
+homepage: https://github.com/ehowe/swagalicious
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ehowe/swagalicious
+  source_code_uri: https://github.com/ehowe/swagalicious
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: RSwag without Rails
+test_files: []