Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
swagger-ui as middleware & upgrade to 3.12.2
  • Loading branch information
domaindrivendev committed May 17, 2018
1 parent 4c70829 commit fee8491
Show file tree
Hide file tree
Showing 74 changed files with 258 additions and 37,700 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -3,5 +3,6 @@
**/*/*.gem
**/*/*.sqlite3
**/*/public/assets
**/*/node_modules
*.swp
Gemfile.lock
2 changes: 1 addition & 1 deletion .travis.yml
Expand Up @@ -12,7 +12,7 @@ cache:
directories:
- /home/travis/.rvm/gems/ruby-2.2.5

install: bundle install
install: ./ci/build.sh

before_script:
- export DISPLAY=:99.0
Expand Down
9 changes: 4 additions & 5 deletions Gemfile
Expand Up @@ -15,23 +15,22 @@ end

gem 'sqlite3'

gem 'rswag-specs', path: './rswag-specs'
gem 'rswag-api', path: './rswag-api'
gem 'rswag-ui', path: './rswag-ui'

# To use debugger
# gem 'debugger'

group :test do
gem 'test-unit'
gem 'rspec-rails'
gem 'generator_spec'
gem 'capybara'
gem 'capybara-webkit'
gem 'puma'
gem 'rswag-specs', path: './rswag-specs'
end

group :assets do
gem 'uglifier'
gem 'therubyracer'
end

gem 'byebug'
gem 'puma'
24 changes: 24 additions & 0 deletions ci/build.sh
@@ -0,0 +1,24 @@
#!/usr/bin/env bash

ROOT_PATH=$PWD
set -e # abort if anything fails

echo '####################'
echo 'bundle'
echo '####################'
echo ''

echo '##### all #####'
bundle install

echo '####################'
echo 'npm'
echo '####################'
echo ''

echo '##### rswag-ui #####'
cd $ROOT_PATH/rswag-ui
npm install

# Cleanup
cd $ROOT_PATH
11 changes: 0 additions & 11 deletions rswag-ui/app/controllers/rswag/ui/home_controller.rb

This file was deleted.

126 changes: 0 additions & 126 deletions rswag-ui/app/views/rswag/ui/home/index.html.erb

This file was deleted.

3 changes: 0 additions & 3 deletions rswag-ui/config/routes.rb

This file was deleted.

4 changes: 2 additions & 2 deletions rswag-ui/lib/generators/rswag/ui/custom/custom_generator.rb
Expand Up @@ -3,10 +3,10 @@
module Rswag
module Ui
class CustomGenerator < Rails::Generators::Base
source_root File.expand_path('../../../../../../app/views/rswag/ui/home', __FILE__)
source_root File.expand_path('../../../../../../lib/rswag/ui', __FILE__)

def add_custom_index
copy_file('index.html.erb', 'app/views/rswag/ui/home/index.html.erb')
copy_file('index.erb', 'app/views/rswag/ui/home/index.html.erb')
end
end
end
Expand Down
Expand Up @@ -5,5 +5,6 @@
# JSON endpoint and the second is a title that will be displayed in the document selector
# NOTE: If you're using rspec-api to expose Swagger files (under swagger_root) as JSON endpoints,
# then the list below should correspond to the relative paths for those endpoints

c.swagger_endpoint '/api-docs/v1/swagger.json', 'API V1 Docs'
end
26 changes: 22 additions & 4 deletions rswag-ui/lib/rswag/ui/configuration.rb
Expand Up @@ -3,14 +3,32 @@
module Rswag
module Ui
class Configuration
attr_reader :swagger_endpoints
attr_reader :template_locations
attr_accessor :config_object
attr_accessor :oauth_config_object
attr_reader :assets_root

def initialize
@swagger_endpoints = []
@template_locations = [
# preffered override location
"#{Rack::Directory.new('').root}/swagger/index.erb",
# backwards compatible override location
"#{Rack::Directory.new('').root}/app/views/rswag/ui/home/index.html.erb",
# default location
File.expand_path('../index.erb', __FILE__)
]
@assets_root = File.expand_path('../../../../node_modules/swagger-ui-dist', __FILE__)
@config_object = {}
@oauth_config_object = {}
end

def swagger_endpoint(path, title)
@swagger_endpoints << OpenStruct.new(path: path, title: title)
def swagger_endpoint(url, name)
@config_object[:urls] ||= []
@config_object[:urls] << { url: url, name: name }
end

def get_binding
binding
end
end
end
Expand Down
17 changes: 7 additions & 10 deletions rswag-ui/lib/rswag/ui/engine.rb
@@ -1,19 +1,16 @@
require 'rswag/ui/middleware'

module Rswag
module Ui
class Engine < ::Rails::Engine
isolate_namespace Rswag::Ui

initializer 'rswag-ui.initialize' do |app|
if app.config.respond_to?(:assets)
app.config.assets.precompile += [
'swagger-ui/css/*',
'swagger-ui/fonts/*',
'swagger-ui/images/*',
'swagger-ui/lang/*',
'swagger-ui/lib/*',
'swagger-ui/swagger-ui.min.js'
]
end
middleware.use Rswag::Ui::Middleware, Rswag::Ui.config
end

rake_tasks do
load File.expand_path('../../../tasks/rswag-ui_tasks.rake', __FILE__)
end
end
end
Expand Down
103 changes: 103 additions & 0 deletions rswag-ui/lib/rswag/ui/index.erb
@@ -0,0 +1,103 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}

body {
margin:0;
background: #fafafa;
}
</style>
</head>

<body>

<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
<defs>
<symbol viewBox="0 0 20 20" id="unlocked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
</symbol>

<symbol viewBox="0 0 20 20" id="locked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
</symbol>

<symbol viewBox="0 0 20 20" id="close">
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
</symbol>

<symbol viewBox="0 0 20 20" id="large-arrow">
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
</symbol>

<symbol viewBox="0 0 20 20" id="large-arrow-down">
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
</symbol>


<symbol viewBox="0 0 24 24" id="jump-to">
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
</symbol>

<symbol viewBox="0 0 24 24" id="expand">
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
</symbol>

</defs>
</svg>

<div id="swagger-ui"></div>

<!-- Workaround for https://github.com/swagger-api/swagger-editor/issues/1371 -->
<script>
if (window.navigator.userAgent.indexOf("Edge") > -1) {
console.log("Removing native Edge fetch in favor of swagger-ui's polyfill")
window.fetch = undefined;
}
</script>

<script src="./swagger-ui-bundle.js"> </script>
<script src="./swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function () {
var configObject = JSON.parse('<%= config_object.to_json %>');
var oauthConfigObject = JSON.parse('<%= oauth_config_object.to_json %>');

// Apply mandatory parameters
configObject.dom_id = "#swagger-ui";
configObject.presets = [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset];
configObject.layout = "StandaloneLayout";

// If oauth2RedirectUrl isn't specified, use the built-in default
if (!configObject.hasOwnProperty("oauth2RedirectUrl"))
configObject.oauth2RedirectUrl = window.location.href.replace("index.html", "oauth2-redirect.html");

// Build a system
const ui = SwaggerUIBundle(configObject);

// Apply OAuth config
ui.initOAuth(oauthConfigObject);
}
</script>
</body>

</html>

0 comments on commit fee8491

Please sign in to comment.