rswag-ui 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72bb3ce1fa7c6268b6e9183f07a3e1ab89f792a5ed081d192df0726030da9de5
-  data.tar.gz: a96655aa7933a64100c2027c15ca0d12e31a7ab78c05545ebcb3cea0edac6daa
+  metadata.gz: 0ef5c28b235cad0e1e0209a710e43f1b061509a947792c26e69a56f9f366be3b
+  data.tar.gz: ce7ac5d67c50e5b11f6bf4aadc75d73aefdb3a95401c9e7e0e38b4919f534c7b
 SHA512:
-  metadata.gz: 00b4dc7dd1cfbc2eff39b74d47d7f4a11018a1d7fd44d62084c9dfd2097fbf71be42f450b2745bf9c76e2d624a2b9f09290fe916fca3719cb4bf4b401a262844
-  data.tar.gz: d792ce38e539fc11982cb3c0b3ab85b98c73eb0ba1b636a9f4906feb85a15122d4325ebde2ee4ceb8f18ff69689e3643774905985eed5cbd464573379202b813
+  metadata.gz: 29ae516901143f7032353171928c69c8164e6fbd36a4ebb7385cc69e1cc6d3a49b5ef160c3d9fcb21562983344f0253e2fff5d741aadece63a98472a522ced34
+  data.tar.gz: bb10473e1f3d883b9cd9d2a590b39d3ddf2141f2b4f285cda10abf6ad12c7ad3274e1984a18cb6baf17597ee0f89eea31d1b63308cd1bfb31da8a6d51f208d4f

data/lib/generators/rswag/ui/custom/custom_generator.rb

@@ -3,10 +3,10 @@ require 'rails/generators'
 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

data/lib/generators/rswag/ui/install/templates/rswag-ui.rb

@@ -5,5 +5,6 @@ Rswag::Ui.configure do |c|
   # 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

data/lib/rswag/ui/configuration.rb

@@ -3,14 +3,32 @@ require 'ostruct'
 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

data/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

data/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>

data/lib/rswag/ui/middleware.rb

@@ -0,0 +1,44 @@
+module Rswag
+  module Ui
+    class Middleware < Rack::Static
+
+      def initialize(app, config)
+        @config = config
+        super(app, urls: [ '' ], root: config.assets_root )
+      end
+
+      def call(env)
+        if base_path?(env) 
+          redirect_uri = env['SCRIPT_NAME'].chomp('/') + '/index.html'
+          return [ 301, { 'Location' => redirect_uri }, [ ] ]
+        end
+
+        if index_path?(env)
+          return [ 200, { 'Content-Type' => 'text/html' }, [ render_template ] ]
+        end
+
+        super
+      end
+
+      private
+
+      def base_path?(env)
+        env['REQUEST_METHOD'] == "GET" && env['PATH_INFO'] == "/"
+      end
+
+      def index_path?(env)
+        env['REQUEST_METHOD'] == "GET" && env['PATH_INFO'] == "/index.html"
+      end
+
+      def render_template
+        file = File.new(template_filename)
+        template = ERB.new(file.read)
+        template.result(@config.get_binding)
+      end
+
+      def template_filename
+        @config.template_locations.find { |filename| File.exists?(filename) }
+      end
+    end
+  end
+end

data/lib/tasks/rswag-ui_tasks.rake

@@ -0,0 +1,12 @@
+namespace :rswag do
+  namespace :ui do
+
+    desc 'TODO'
+    task :copy_assets, [ :dest ] do |t, args|
+      dest = args[:dest]
+      FileUtils.rm_r(dest, force: true)
+      FileUtils.mkdir_p(dest)
+      FileUtils.cp_r(Dir.glob("#{Rswag::Ui.config.assets_root}/{*.js,*.png,*.css}"), dest)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswag-ui
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Richie Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -60,9 +60,6 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - Rakefile
-- app/controllers/rswag/ui/home_controller.rb
-- app/views/rswag/ui/home/index.html.erb
-- config/routes.rb
 - lib/generators/rswag/ui/custom/USAGE
 - lib/generators/rswag/ui/custom/custom_generator.rb
 - lib/generators/rswag/ui/install/USAGE
@@ -71,56 +68,9 @@ files:
 - lib/rswag/ui.rb
 - lib/rswag/ui/configuration.rb
 - lib/rswag/ui/engine.rb
-- vendor/assets/components/swagger-ui/css/print.css.erb
-- vendor/assets/components/swagger-ui/css/reset.css
-- vendor/assets/components/swagger-ui/css/screen.css.erb
-- vendor/assets/components/swagger-ui/css/style.css.erb
-- vendor/assets/components/swagger-ui/css/typography.css.erb
-- vendor/assets/components/swagger-ui/fonts/DroidSans-Bold.ttf
-- vendor/assets/components/swagger-ui/fonts/DroidSans.ttf
-- vendor/assets/components/swagger-ui/images/collapse.gif
-- vendor/assets/components/swagger-ui/images/expand.gif
-- vendor/assets/components/swagger-ui/images/explorer_icons.png
-- vendor/assets/components/swagger-ui/images/favicon-16x16.png
-- vendor/assets/components/swagger-ui/images/favicon-32x32.png
-- vendor/assets/components/swagger-ui/images/favicon.ico
-- vendor/assets/components/swagger-ui/images/logo_small.png
-- vendor/assets/components/swagger-ui/images/pet_store_api.png
-- vendor/assets/components/swagger-ui/images/throbber.gif
-- vendor/assets/components/swagger-ui/images/wordnik_api.png
-- vendor/assets/components/swagger-ui/lang/ca.js
-- vendor/assets/components/swagger-ui/lang/en.js
-- vendor/assets/components/swagger-ui/lang/es.js
-- vendor/assets/components/swagger-ui/lang/fr.js
-- vendor/assets/components/swagger-ui/lang/geo.js
-- vendor/assets/components/swagger-ui/lang/it.js
-- vendor/assets/components/swagger-ui/lang/ja.js
-- vendor/assets/components/swagger-ui/lang/ko-kr.js
-- vendor/assets/components/swagger-ui/lang/pl.js
-- vendor/assets/components/swagger-ui/lang/pt.js
-- vendor/assets/components/swagger-ui/lang/ru.js
-- vendor/assets/components/swagger-ui/lang/tr.js
-- vendor/assets/components/swagger-ui/lang/translator.js
-- vendor/assets/components/swagger-ui/lang/zh-cn.js
-- vendor/assets/components/swagger-ui/lib/backbone-min.js
-- vendor/assets/components/swagger-ui/lib/es5-shim.js
-- vendor/assets/components/swagger-ui/lib/handlebars-4.0.5.js
-- vendor/assets/components/swagger-ui/lib/highlight.9.1.0.pack.js
-- vendor/assets/components/swagger-ui/lib/highlight.9.1.0.pack_extended.js
-- vendor/assets/components/swagger-ui/lib/jquery-1.8.0.min.js
-- vendor/assets/components/swagger-ui/lib/jquery.ba-bbq.min.js
-- vendor/assets/components/swagger-ui/lib/jquery.slideto.min.js
-- vendor/assets/components/swagger-ui/lib/jquery.wiggle.min.js
-- vendor/assets/components/swagger-ui/lib/js-yaml.min.js
-- vendor/assets/components/swagger-ui/lib/jsoneditor.min.js
-- vendor/assets/components/swagger-ui/lib/lodash.min.js
-- vendor/assets/components/swagger-ui/lib/marked.js
-- vendor/assets/components/swagger-ui/lib/object-assign-pollyfill.js
-- vendor/assets/components/swagger-ui/lib/sanitize-html.min.js
-- vendor/assets/components/swagger-ui/lib/swagger-oauth.js
-- vendor/assets/components/swagger-ui/o2c.html
-- vendor/assets/components/swagger-ui/swagger-ui.js
-- vendor/assets/components/swagger-ui/swagger-ui.min.js
+- lib/rswag/ui/index.erb
+- lib/rswag/ui/middleware.rb
+- lib/tasks/rswag-ui_tasks.rake
 homepage: https://github.com/domaindrivendev/rswag
 licenses:
 - MIT
@@ -141,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Rails Engine that includes swagger-ui and powers it from configured Swagger

data/app/controllers/rswag/ui/home_controller.rb

@@ -1,11 +0,0 @@
-module Rswag
-  module Ui
-    class HomeController < ActionController::Base
-
-      def index
-        @swagger_endpoints = Rswag::Ui.config.swagger_endpoints
-        render :index, layout: false
-      end
-    end
-  end
-end

data/app/views/rswag/ui/home/index.html.erb

@@ -1,126 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <title>Swagger UI</title>
-  <link rel="icon" type="image/png" href="<%= asset_path 'swagger-ui/images/favicon-32x32.png' %>" sizes="32x32" />
-  <link rel="icon" type="image/png" href="<%= asset_path 'swagger-ui/images/favicon-16x16.png' %>" sizes="16x16" />
-  <link href="<%= asset_path 'swagger-ui/css/typography.css' %>" media='screen' rel='stylesheet' type='text/css'/>
-  <link href="<%= asset_path 'swagger-ui/css/reset.css' %>" media='screen' rel='stylesheet' type='text/css'/>
-  <link href="<%= asset_path 'swagger-ui/css/screen.css' %>" media='screen' rel='stylesheet' type='text/css'/>
-  <link href="<%= asset_path 'swagger-ui/css/reset.css' %>" media='print' rel='stylesheet' type='text/css'/>
-  <link href="<%= asset_path 'swagger-ui/css/print.css' %>" media='print' rel='stylesheet' type='text/css'/>
-
-  <script src="<%= asset_path 'swagger-ui/lib/object-assign-pollyfill.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/jquery-1.8.0.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/jquery.slideto.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/jquery.wiggle.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/jquery.ba-bbq.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/handlebars-4.0.5.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/lodash.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/backbone-min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/swagger-ui.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/highlight.9.1.0.pack.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/highlight.9.1.0.pack_extended.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/jsoneditor.min.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/marked.js' %>" type='text/javascript'></script>
-  <script src="<%= asset_path 'swagger-ui/lib/swagger-oauth.js' %>" type='text/javascript'></script>
-
-  <!-- Some basic translations -->
-  <!-- <script src="<%= asset_path 'swagger-ui/lang/translator.js' %>" type='text/javascript'></script> -->
-  <!-- <script src="<%= asset_path 'swagger-ui/lang/ru.js' %>" type='text/javascript'></script> -->
-  <!-- <script src="<%= asset_path 'swagger-ui/lang/en.js' %>" type='text/javascript'></script> -->
-
-  <script type="text/javascript">
-    $(function () {
-      hljs.configure({
-        highlightSizeThreshold: 5000
-      });
-
-      // Pre load translate...
-      if(window.SwaggerTranslator) {
-        window.SwaggerTranslator.translate();
-      }
-      window.swaggerUi = new SwaggerUi({
-        url: '<%= @swagger_endpoints.first.path %>',
-        dom_id: "swagger-ui-container",
-        supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
-        onComplete: function(swaggerApi, swaggerUi){
-          if(typeof initOAuth == "function") {
-            initOAuth({
-              clientId: "your-client-id",
-              clientSecret: "your-client-secret-if-required",
-              realm: "your-realms",
-              appName: "your-app-name",
-              scopeSeparator: " ",
-              additionalQueryStringParams: {}
-            });
-          }
-
-          if(window.SwaggerTranslator) {
-            window.SwaggerTranslator.translate();
-          }
-        },
-        onFailure: function(data) {
-          log("Unable to Load SwaggerUI");
-        },
-        docExpansion: "list",
-        jsonEditor: false,
-        defaultModelRendering: 'schema',
-        showRequestHeaders: false
-      });
-
-      window.swaggerUi.load();
-
-      function log() {
-        if ('console' in window) {
-          console.log.apply(console, arguments);
-        }
-      }
-  });
-  </script>
-</head>
-
-<body class="swagger-section">
-<div id='header'>
-  <div class="swagger-ui-wrap">
-    <a id="logo" href="http://swagger.io"><img class="logo__img" alt="swagger" height="30" width="30" src="<%= asset_path 'swagger-ui/images/logo_small.png' %>" /><span class="logo__title">swagger</span></a>
-    <form id='api_selector'>
-      <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
-      <div id='auth_container'></div>
-      <select id="select_document">
-        <% @swagger_endpoints.each do |endpoint| %>
-          <option value='<%= endpoint.path %>'><%= endpoint.title %></option>
-        <% end %>
-      </select>
-      <script type="text/javascript">
-        // Refresh the swagger-ui when a new document is selected
-        $('#select_document').change(function () {
-          $('#input_baseUrl').val($(this).val());
-          window.swaggerUi.headerView.showCustom();
-        });
-      </script>
-      <style>
-        #select_document {
-          border: none;
-          height: 1.85em;
-          border-radius: 4px;
-          -moz-border-radius: 4px;
-          -webkit-border-radius: 4px;
-          -o-border-radius: 4px;
-          -ms-border-radius: 4px;
-          -khtml-border-radius: 4px;
-          font-size: 0.85em;
-          font-weight: bold;
-          color: white;
-          background-color: #547f00;
-        }
-      </style>
-    </form>
-  </div>
-</div>
-
-<div id="message-bar" class="swagger-ui-wrap" data-sw-translate>&nbsp;</div>
-<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
-</body>
-</html>