swagger_ui_static_engine 2.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e23c96bff6a4a0342ddeff91bac1f29bbdedf389
+  data.tar.gz: 0068d2d6d8c46396d0ecd8d71e6d77e25dc4a0ee
+SHA512:
+  metadata.gz: cb2d47c6441ddb13f72c9246dd8869a8ac486e4f960ca43ba8ad5ba19ae94e47aa92161f3e800398bf7984587187f71dac9106506de3f51b60c7ecd9c4319f0c
+  data.tar.gz: 365cd9d99ce2a1c87e046c6cafeba88b304504b6f14d7fe6078c570743e0139a62b4bf4d7d081b6959ca61f2a6b785c96baa4f57a5da36abfbe011d7fc53bb7b

data/README.md

@@ -0,0 +1,87 @@
+# Swagger UI Static Engine
+
+I was documenting my API.  I wanted to include [Swagger UI](http://swagger.io/swagger-ui/) as simply as possible.
+
+Swagger UI is schweet, because, as they say:
+
+> [_Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets ... just clone this repo and use the
+pre-built files in the dist folder_](https://github.com/swagger-api/swagger-ui#download)
+
+At first, I just copied the `dist` folder into my `/public` directory.  Awesome!  It's self-contained and just works.
+
+But then, I had 25k lines of code in my git repo that, didn't belong there.  So, I looked for more elegant ways
+to include it in my project ...
+
+I found some nice projects like:
+
+* https://github.com/batdevis/swagger_engine
+* https://github.com/d4be4st/swagger-ui_rails
+
+The problem is, these projects had fallen out of date.  I cloned them and tried to update them, but it was
+complicated to just, copy the new swagger-ui/dist folder over, because these folks had really wired them up in the asset
+pipeline and, in order to update them I had to mangle / merge / adapt the Swagger UI quite a bit.  I thought, what I
+really wanted was just, the static files, in a separate git repo, in an engine, that I could keep up to date, edit simply
+(if later I want to tweak the look of things, etc).
+
+So, that's what I have done here.  It's mostly just the [Swagger UI
+dist](https://github.com/swagger-api/swagger-ui/tree/master/dist) folder, in the public directory of the engine.
+
+
+## Swagger UI Version
+
+**Contains Swagger UI version: 2.1.4**
+
+The version number of this RubyGem will mirror Swagger UI's ...
+
+
+## Philosophy
+
+This isn't really a gem that you configure, it's a gem that you fork and modify.  I'm purposefully trying to alter the
+static Swagger UI files, as little as possible.  The more mods I make, the harder this will be to keep up with the
+Swagger UI project.  Additionally, there's no way for me to anticipate exactly how I will want to modify the Swagger UI
+files to customize them for my project.  I plan to make any customizations that I want, by editing the files directly in
+this repo.
+
+
+## Install
+
+_config/initializers/swagger_ui_static_engine.rb_
+
+    SwaggerUiStaticEngine::Engine.mount_path = "/api/docs" # the path to your swagger-ui page, when you have mounted it
+    SwaggerUiStaticEngine::Engine.swagger_url = "/api/swagger.json" # the path to your swagger.json file
+
+_config/routes.rb_
+
+    Rails.application.routes.draw do
+      mount SwaggerUiStaticEngine::Engine, at: '/docs'
+    end
+
+
+If you are including this inside another engine (as I am, my 'Api' engine), you will need these extra files:
+
+_lib/yourengine.rb_
+
+    require 'swagger_ui_static_engine'
+
+_lib/yourengine/yourengine.rb_
+
+    module YourEngine
+      class Engine < ::Rails::Engine
+        # combine this engine's static assets with the static assets of the hosting site
+        initializer "static assets" do |app|
+          app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public")
+        end
+      end
+    end
+
+
+## Updating
+
+    wget https://github.com/swagger-api/swagger-ui/archive/master.zip && mv master.zip swagger-ui-master.zip
+    unzip swagger-ui-master.zip
+    cp -R swagger-ui-master/dist/ swagger_ui_static_engine/public
+    mv swagger_ui_static_engine/public/index.html swagger_ui_static_engine/app/views/swagger_ui_static_engine/index.html.erb
+    git diff
+    <edit index.html.erb to view & merge anything that was overwritten>
+
+

data/app/controllers/swagger_ui_static_engine/application_controller.rb

@@ -0,0 +1,8 @@
+module SwaggerUiStaticEngine
+  class ApplicationController < ActionController::Base
+    def index
+      @mount_path = SwaggerUiStaticEngine::Engine.mount_path
+      @swagger_url = SwaggerUiStaticEngine::Engine.swagger_url
+    end
+  end
+end

data/app/views/swagger_ui_static_engine/index.html.erb

@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="icon" type="image/png" href="<%= @mount_path %>/images/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="<%= @mount_path %>/images/favicon-16x16.png" sizes="16x16" />
+  <link href='<%= @mount_path %>/css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='<%= @mount_path %>/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='<%= @mount_path %>/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='<%= @mount_path %>/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
+  <link href='<%= @mount_path %>/css/print.css' media='print' rel='stylesheet' type='text/css'/>
+  <script src='<%= @mount_path %>/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/jquery.slideto.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/jquery.wiggle.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/handlebars-2.0.0.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/js-yaml.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/lodash.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/backbone-min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/swagger-ui.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/highlight.9.1.0.pack.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/jsoneditor.min.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/marked.js' type='text/javascript'></script>
+  <script src='<%= @mount_path %>/lib/swagger-oauth.js' type='text/javascript'></script>
+
+  <!-- Some basic translations -->
+  <!-- <script src='lang/translator.js' type='text/javascript'></script> -->
+  <!-- <script src='lang/ru.js' type='text/javascript'></script> -->
+  <!-- <script src='lang/en.js' type='text/javascript'></script> -->
+
+  <script type="text/javascript">
+    $(function () {
+      var url = window.location.search.match(/url=([^&]+)/);
+      if (url && url.length > 1) {
+        url = decodeURIComponent(url[1]);
+      } else {
+        url = "<%= @swagger_url %>";
+      }
+
+      hljs.configure({
+        highlightSizeThreshold: 5000
+      });
+
+      // Pre load translate...
+      if(window.SwaggerTranslator) {
+        window.SwaggerTranslator.translate();
+      }
+      window.swaggerUi = new SwaggerUi({
+        url: url,
+        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: "none",
+        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="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>
+      <div class='input'><a id="explore" class="header__btn" href="#" data-sw-translate>Explore</a></div>
+    </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>

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: swagger_ui_static_engine
+version: !ruby/object:Gem::Version
+  version: 2.1.4
+platform: ruby
+authors:
+- Kevin Trowbridge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- kevinmtrowbridge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/swagger_ui_static_engine/application_controller.rb
+- app/views/swagger_ui_static_engine/index.html.erb
+- README.md
+homepage: https://github.com/kevinmtrowbridge/swagger_ui_static_engine
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Mount Swagger UI in a Rails app, via an engine, in as simple, editable, maintainable,
+  STATIC way, as possible.
+test_files: []