RubyGems - rswag-ui - Versions diffs - 1.0.0 - Mend

rswag-ui 1.0.0

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 (16) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/Rakefile +27 -0
data/app/controllers/rswag/ui/home_controller.rb +11 -0
data/app/views/rswag/ui/home/index.html.erb +126 -0
data/config/routes.rb +3 -0
data/lib/generators/rswag/ui/custom/USAGE +8 -0
data/lib/generators/rswag/ui/custom/custom_generator.rb +13 -0
data/lib/generators/rswag/ui/install/USAGE +8 -0
data/lib/generators/rswag/ui/install/install_generator.rb +18 -0
data/lib/generators/rswag/ui/install/templates/rswag-ui.rb +9 -0
data/lib/rswag/ui/configuration.rb +17 -0
data/lib/rswag/ui/engine.rb +13 -0
data/lib/rswag/ui/version.rb +5 -0
data/lib/rswag/ui.rb +15 -0
metadata +80 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e3b19f5dfd370a427e561892e4c4af39c9642cf
+  data.tar.gz: 9c1820c91172f06387572f20a857c59ffca79693
+SHA512:
+  metadata.gz: 701b71ac61693d763592ff9d61589bbae38a56403602f54cfddd3a98bd3e6af1d7257358d0d28b66f334b94658d35d5a8d877e64e33372b94faca6f4daafa214
+  data.tar.gz: eb47858f29f1a165ab7dd3e0b8082e48dfb5f47670764a47375855ebedc998b57e98261613ec96b640d3048a01e3c38b5bbea4baa96d79b9df78a009b84d082a

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2015 domaindrivendev
+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,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rswag-specs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,11 @@
+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 ADDED Viewed

@@ -0,0 +1,126 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="icon" type="image/png" href="/assets/swagger-ui/images/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="/assets/swagger-ui/images/favicon-16x16.png" sizes="16x16" />
+  <link href='/assets/swagger-ui/css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='/assets/swagger-ui/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='/assets/swagger-ui/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='/assets/swagger-ui/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
+  <link href='/assets/swagger-ui/css/print.css' media='print' rel='stylesheet' type='text/css'/>
+  <script src='/assets/swagger-ui/lib/object-assign-pollyfill.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/jquery.slideto.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/jquery.wiggle.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/handlebars-4.0.5.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/lodash.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/backbone-min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/swagger-ui.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/highlight.9.1.0.pack.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/jsoneditor.min.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/marked.js' type='text/javascript'></script>
+  <script src='/assets/swagger-ui/lib/swagger-oauth.js' type='text/javascript'></script>
+  <!-- Some basic translations -->
+  <!-- <script src='/assets/swagger-ui/lang/translator.js' type='text/javascript'></script> -->
+  <!-- <script src='/assets/swagger-ui/lang/ru.js' type='text/javascript'></script> -->
+  <!-- <script src='/assets/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="/assets/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>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Rswag::Ui::Engine.routes.draw do
+  root to: 'home#index'
+end

data/lib/generators/rswag/ui/custom/USAGE ADDED Viewed

@@ -0,0 +1,8 @@
+Description:
+    Adds a local version of index.html.erb for customizing the swagger-ui
+Example:
+    rails generate rswag:ui:custom
+    This will create:
+        app/views/rswag/ui/home/index.html.erb

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

@@ -0,0 +1,13 @@
+require 'rails/generators'
+module Rswag
+  module Ui
+    class CustomGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../../../app/views/rswag/ui/home', __FILE__)
+      def add_custom_index
+        copy_file('index.html.erb', 'app/views/rswag/ui/home/index.html.erb')
+      end
+    end
+  end
+end

data/lib/generators/rswag/ui/install/USAGE ADDED Viewed

@@ -0,0 +1,8 @@
+Description:
+  Adds rswag-api initializer for configuration
+Example:
+    rails generate rswag:api:install
+    This will create:
+        config/initializers/rswag-api.rb

data/lib/generators/rswag/ui/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require 'rails/generators'
+module Rswag
+  module Ui
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      def add_initializer
+        template('rswag-ui.rb', 'config/initializers/rswag-ui.rb')
+      end
+      def add_routes
+        route("mount Rswag::Ui::Engine => '/api-docs'")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+Rswag::Ui.configure do |c|
+  # List the Swagger endpoints that you want to be documented through the swagger-ui
+  # The first parameter is the path (absolute or relative to the UI host) to the corresponding
+  # 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 ADDED Viewed

@@ -0,0 +1,17 @@
+require 'ostruct'
+module Rswag
+  module Ui
+    class Configuration
+      attr_reader :swagger_endpoints
+      def initialize
+        @swagger_endpoints = []
+      end
+      def swagger_endpoint(path, title)
+        @swagger_endpoints << OpenStruct.new(path: path, title: title)
+      end
+    end
+  end
+end

data/lib/rswag/ui/engine.rb ADDED Viewed

@@ -0,0 +1,13 @@
+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/*' ]
+        end
+      end
+    end
+  end
+end

data/lib/rswag/ui/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Rswag
+  module Ui
+    VERSION = '1.0.0'
+  end
+end

data/lib/rswag/ui.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'rswag/ui/version'
+require 'rswag/ui/configuration'
+require 'rswag/ui/engine'
+module Rswag
+  module Ui
+    def self.configure
+      yield(config)
+    end
+    def self.config
+      @config ||= Configuration.new
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rswag-ui
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Richie Morris
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Expose beautiful API documentation, that's powered by Swagger JSON endpoints,
+  including a UI to explore and test operations
+email:
+- domaindrivendev@gmail.com
+executables: []
+extensions: []
+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
+- lib/generators/rswag/ui/install/install_generator.rb
+- lib/generators/rswag/ui/install/templates/rswag-ui.rb
+- lib/rswag/ui.rb
+- lib/rswag/ui/configuration.rb
+- lib/rswag/ui/engine.rb
+- lib/rswag/ui/version.rb
+homepage: https://github.com/domaindrivendev/rswag
+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: A Rails Engine that includes swagger-ui and powers it from configured Swagger
+  endpoints
+test_files: []