rswag/rswag-api/spec/rswag/api/middleware_spec.rb

require 'rswag/api/middleware'
require 'rswag/api/configuration'

module Rswag
  module Api

    describe Middleware do
      let(:app) { double('app') }
      let(:swagger_root) { File.expand_path('../fixtures/swagger', __FILE__) }
      let(:config) do
        Configuration.new.tap { |c| c.swagger_root = swagger_root }
      end

      subject { described_class.new(app, config) }

      describe '#call(env)' do
        let(:response) { subject.call(env) }
        let(:env_defaults) do
          {
            'HTTP_HOST' => 'tempuri.org',
            'REQUEST_METHOD' => 'GET',
          }
        end

        context 'given a path that maps to an existing swagger file' do
          let(:env) { env_defaults.merge('PATH_INFO' => 'v1/swagger.json') }

          it 'returns a 200 status' do
            expect(response.length).to eql(3)
            expect(response.first).to eql('200')
          end

          it 'returns contents of the swagger file' do
            expect(response.length).to eql(3)
            expect(response[1]).to include( 'Content-Type' => 'application/json')
            expect(response[2].join).to include('"title":"API V1"')
          end
        end

        context "given a path that doesn't map to any swagger file" do
          let(:env) { env_defaults.merge('PATH_INFO' => 'foobar.json') }
          before do
            allow(app).to receive(:call).and_return([ '500', {}, [] ])
          end

          it 'delegates to the next middleware' do
            expect(response).to include('500')
          end
        end

        context 'when the env contains a specific swagger_root' do
          let(:env) do
            env_defaults.merge(
              'PATH_INFO' => 'v1/swagger.json',
              'action_dispatch.request.path_parameters' => {
                swagger_root: swagger_root
              }
            )
          end

          it 'locates files at the provided swagger_root' do
            expect(response.length).to eql(3)
            expect(response[1]).to include( 'Content-Type' => 'application/json')
            expect(response[2].join).to include('"openapi":"3.0.1"')
          end
        end

        context 'when a swagger_filter is configured' do
          before do
            config.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
          end
          let(:env) { env_defaults.merge('PATH_INFO' => 'v1/swagger.json') }

          it 'applies the filter prior to serialization' do
            expect(response.length).to eql(3)
            expect(response[2].join).to include('"host":"tempuri.org"')
          end
        end

        context 'when a path maps to a yaml swagger file' do
          let(:env) { env_defaults.merge('PATH_INFO' => 'v1/swagger.yml') }

          it 'returns a 200 status' do
            expect(response.length).to eql(3)
            expect(response.first).to eql('200')
          end

          it 'returns contents of the swagger file' do
            expect(response.length).to eql(3)
            expect(response[1]).to include( 'Content-Type' => 'text/yaml')
            expect(response[2].join).to include('title: API V1')
          end
        end
      end
    end
  end
end