rename to rswag plus major refactor - almost a rewrite

rswag-api/spec/generators/rswag/api/fixtures/config/routes.rb

@@ -0,0 +1,2 @@
+TestApp::Application.routes.draw do
+end

rswag-api/spec/generators/rswag/api/install_generator_spec.rb

@@ -0,0 +1,27 @@
+require 'generator_spec'
+require 'generators/rswag/api/install/install_generator'
+
+module Rswag
+  module Api
+
+    describe InstallGenerator do
+      include GeneratorSpec::TestCase
+      destination File.expand_path('../tmp', __FILE__)
+
+      before(:all) do
+        prepare_destination
+        fixtures_dir = File.expand_path('../fixtures', __FILE__)
+        FileUtils.cp_r("#{fixtures_dir}/config", destination_root)
+
+        run_generator
+      end
+
+      it 'installs the Rails initializer' do
+        assert_file('config/initializers/rswag-api.rb')
+      end
+
+      # Don't know how to test this
+      #it 'wires up routes'
+    end
+  end
+end

rswag-api/spec/generators/rswag/api/tmp/config/initializers/rswag-api.rb

@@ -0,0 +1,14 @@
+Rswag::Api.configure do |c|
+
+  # Specify a root folder where Swagger JSON files are located
+  # This is used by the Swagger middleware to serve requests for API descriptions
+  # NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
+  # that it's configured to generate files in the same folder
+  c.swagger_root = Rails.root.to_s + '/swagger'
+
+  # Inject a lamda function to alter the returned Swagger prior to serialization
+  # The function will have access to the rack env for the current request
+  # For example, you could leverage this to dynamically assign the "host" property
+  #
+  #c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+end

rswag-api/spec/generators/rswag/api/tmp/config/routes.rb

@@ -0,0 +1,4 @@
+TestApp::Application.routes.draw do
+  mount Rswag::Api::Engine => '/api-docs'
+
+end

rswag-api/spec/rswag/api/fixtures/config/routes.rb

@@ -0,0 +1,6 @@
+TestApp::Application.routes.draw do
+  resources :blogs, defaults: { :format => :json }
+
+  mount Rswag::Api::Engine => 'api-docs'
+  mount Rswag::Ui::Engine => 'api-docs'
+end

rswag-api/spec/rswag/api/fixtures/swagger/v1/swagger.json

@@ -0,0 +1,8 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "API V1",
+    "version": "v1"
+  },
+  "paths": {}
+}

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

@@ -0,0 +1,82 @@
+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('"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[2].join).to include('"host":"tempuri.org"')
+          end
+        end
+      end
+    end
+  end
+end