rswag/spec/swagger_rails/middleware/swagger_json_spec.rb

require 'rails_helper'

module SwaggerRails

  describe SwaggerJson do
    let(:app) { double('app') }
    let(:config) do
      Configuration.new.tap { |c| c.swagger_root = (Rails.root + 'swagger').to_s }
    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.second).to include( 'Content-Type' => 'application/json')
          expect(response.third.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' => 'swagger.json',
            'action_dispatch.request.path_parameters' => {
              swagger_root: (Rails.root + 'swagger/v1').to_s
            }
          )
        end

        it 'locates files at the provided swagger_root' do
          expect(response.length).to eql(3)
          expect(response.second).to include( 'Content-Type' => 'application/json')
          expect(response.third.join).to include('"swagger":"2.0"')
        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.third.join).to include('"host":"tempuri.org"')
        end
      end
    end
  end
end