RubyGems - swagger_ui_engine - Versions diffs - 0.0.1 - Mend

swagger_ui_engine 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/Rakefile +15 -0
data/app/controllers/swagger_ui_engine/docs_controller.rb +7 -0
data/app/views/swagger_ui_engine/docs/index.html.erb +108 -0
data/config/routes.rb +3 -0
data/lib/swagger_ui_engine.rb +4 -0
data/lib/swagger_ui_engine/engine.rb +26 -0
data/lib/swagger_ui_engine/version.rb +3 -0
metadata +52 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a29be68ba946ae7ded7569d2efccc05e7d9740c5
+  data.tar.gz: fc6f9444c192d29477a5e18d33481307899ba7fc
+SHA512:
+  metadata.gz: f42e9af67f694da26156a934420a9a8b755b7f062ffe187032c10004eaf419e964ea59c83e0a93d6c074864a2635d8feecfc7e64fdfe492f4e6a4af98d7a4f53
+  data.tar.gz: 8bc31d62302e1a1a9d6f09cafe6ce1f068a409ebb94329dec2181168d2143033185c53a45cc3da204e7c8f4aad383894c074df5e73cd1afdf30184e2d57214e5

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2015 Zuzanna Stolińska
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile ADDED Viewed

@@ -0,0 +1,15 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SwaggerUiEngine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/swagger_ui_engine/docs_controller.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module SwaggerUiEngine
+  class DocsController < ActionController::Base
+    def index
+      @swagger_url = SwaggerUiEngine.configuration.swagger_url
+    end
+  end
+end

data/app/views/swagger_ui_engine/docs/index.html.erb ADDED Viewed

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="x-ua-compatible" content="IE=edge">
+  <title>Swagger UI</title>
+  <link rel="icon" type="image/png" href="/swagger_ui_engine/images/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="/swagger_ui_engine/images/favicon-16x16.png" sizes="16x16" />
+  <link href='/swagger_ui_engine/css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='/swagger_ui_engine/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='/swagger_ui_engine/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='/swagger_ui_engine/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
+  <link href='/swagger_ui_engine/css/print.css' media='print' rel='stylesheet' type='text/css'/>
+  <script src='/swagger_ui_engine/lib/object-assign-pollyfill.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/jquery.slideto.min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/jquery.wiggle.min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/handlebars-4.0.5.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/lodash.min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/backbone-min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/swagger-ui.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/highlight.9.1.0.pack.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/jsoneditor.min.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/lib/marked.js' type='text/javascript'></script>
+  <script src='/swagger_ui_engine/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,
+        showOperationIds: 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="/swagger_ui_engine/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>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+SwaggerUiEngine::Engine.routes.draw do
+  root to: 'docs#index'
+end

data/lib/swagger_ui_engine.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require "swagger_ui_engine/engine"
+module SwaggerUiEngine
+end

data/lib/swagger_ui_engine/engine.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module SwaggerUiEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace SwaggerUiEngine
+    # Initializer to combine this engines 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
+  class Configuration
+    attr_accessor :swagger_url
+  end
+  class << self
+    attr_writer :configuration
+  end
+  module_function
+  def configuration
+    @configuration ||= Configuration.new
+  end
+  def configure
+    yield(configuration)
+  end
+ end

data/lib/swagger_ui_engine/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module SwaggerUiEngine
+  VERSION = "0.0.1"
+end

metadata ADDED Viewed

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: swagger_ui_engine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ZuzannaSt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-03-16 00:00:00.000000000 Z
+dependencies: []
+description: Api docs inside your rails project.
+email:
+- zuzannast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/controllers/swagger_ui_engine/docs_controller.rb
+- app/views/swagger_ui_engine/docs/index.html.erb
+- config/routes.rb
+- lib/swagger_ui_engine.rb
+- lib/swagger_ui_engine/engine.rb
+- lib/swagger_ui_engine/version.rb
+homepage: https://github.com/ZuzannaSt/swagger_ui_engine
+licenses:
+- MIT
+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.4.5
+signing_key:
+specification_version: 4
+summary: Mount swagger-ui as rails engine.
+test_files: []