swagger_ui_engine 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 683541ecbfa1ee245ba3b609efe020c394899a30
-  data.tar.gz: 5b2a999913297cac602d276b305ac4a0910fa32c
+  metadata.gz: 6d6fff974d9f7d8667215be02d2b198551fe8b80
+  data.tar.gz: 0ff2b58a74369dabfb951a7e9c385eca9fc0e13a
 SHA512:
-  metadata.gz: aa32685d104bdf33da1916e699f4ebfc2f0449f28b908cbbc9daa3c408c2998039a1619cd54acf28643211654f895b86488c6aad815f5e9d7fcd0d6474b52e04
-  data.tar.gz: ee23ee2299dd069f46dab66040e78c8121c7fc42492efa0943b7df2579f857ebe9d92ee43cd59544a6ad34f0fe6400127ab8904a48eea073fbd4492c67bb3026
+  metadata.gz: 777136dcf3369e1a715f32e91281eeb0f6ac2101811df40208da9595233fe17007dd313ab0bb1e77c8612a8b6df9583e9d9309eedcfac6a11438ae0773be9659
+  data.tar.gz: 96779d30916340800fb2f3766009f49aa7b2a28c0ca8a8b2c5fdc8599f1adb8ba0b258dd35ec55ef5f9b8f2e60a357ecb39273a9fa3b7889b5a4eb6aa8d71ada

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# SwaggerUiEngine Changelog
+
+## master
+
+## 0.0.5
+
+* Support Swagger UI version 2.2.10
+* Add tests
+* Fix fonts not being loaded
+* Describe problem solved by this gem in README
+
+## 0.0.4
+
+* Improve configurable options
+* Fix assets errors
+
+## 0.0.1-0.0.3
+
+Initial releases supporting Swagger UI version 2.2.8

data/app/controllers/swagger_ui_engine/application_controller.rb

@@ -0,0 +1,20 @@
+module SwaggerUiEngine
+  class ApplicationController < ActionController::Base
+    include AuthConfigParser
+
+    protect_from_forgery with: :exception
+    layout false
+
+    before_action :authenticate_admin
+
+    protected
+
+    def authenticate_admin
+      return unless basic_authentication_enabled?
+
+      authenticate_or_request_with_http_basic do |username, password|
+        username == admin_username && password == admin_password
+      end
+    end
+  end
+end

data/app/controllers/swagger_ui_engine/docs_controller.rb

@@ -1,14 +1,37 @@
 module SwaggerUiEngine
-  class DocsController < ActionController::Base
+  class DocsController < ApplicationController
     include ConfigParser
     include SwaggerUiDefaults
 
+    before_action :set_configs
+
     def index
-      @swagger_url = set_swagger_url
+      # backward compatibility for defining single doc url in strings
+      redirect_to doc_path('v1') if single_doc_url?
+      redirect_to doc_path(@swagger_url.keys.first) if single_doc_url_hash?
+    end
+
+    def show
+      @swagger_url = @swagger_url[params[:id].to_sym] unless single_doc_url?
+    end
+
+    private
+
+    def set_configs
       @doc_expansion = set_doc_expansion
       @json_editor = set_json_editor
       @model_rendering = set_model_rendering
       @request_headers = set_request_headers
+      @swagger_url = set_swagger_url
+      @validator_url = set_validator_url
+    end
+
+    def single_doc_url?
+      @swagger_url.is_a?(String)
+    end
+
+    def single_doc_url_hash?
+      @swagger_url.is_a?(Hash) && @swagger_url.size == 1
     end
   end
 end

data/app/helpers/auth_config_parser.rb

@@ -0,0 +1,17 @@
+module AuthConfigParser
+  def admin_username
+    configuration.admin_username
+  end
+
+  def admin_password
+    configuration.admin_password
+  end
+
+  def basic_authentication_enabled?
+    admin_username && admin_password
+  end
+
+  def configuration
+    SwaggerUiEngine.configuration
+  end
+end

data/app/helpers/config_parser.rb

@@ -1,20 +1,16 @@
 module ConfigParser
-  def set_swagger_url
-    configuration.swagger_url || default_swagger_url
-  end
-
   def set_doc_expansion
     configuration.doc_expansion || default_doc_expansion
   end
 
-  def set_model_rendering
-    configuration.model_rendering || default_model_rendering
-  end
-
   def set_json_editor
     configuration.json_editor || default_json_editor
   end
 
+  def set_model_rendering
+    configuration.model_rendering || default_model_rendering
+  end
+
   def set_request_headers
     configuration.request_headers || default_request_headers
   end
@@ -23,6 +19,18 @@ module ConfigParser
     configuration.show_operation_ids || default_show_operation_ids
   end
 
+  def set_swagger_url
+    configuration.swagger_url || default_swagger_url
+  end
+
+  def set_validator_url
+    validator_enabled ? default_validator_url : 'null'
+  end
+
+  def validator_enabled
+    configuration.validator_enabled || false
+  end
+
   def configuration
     SwaggerUiEngine.configuration
   end

data/app/helpers/swagger_ui_defaults.rb

@@ -18,4 +18,8 @@ module SwaggerUiDefaults
   def default_request_headers
     false
   end
+
+  def default_validator_url
+    '//online.swagger.io/validator'
+  end
 end

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

@@ -1,89 +1,37 @@
 <!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="<%= image_path('swagger_ui_engine/favicon-32x32.png') %>" sizes="32x32" />
-  <link rel="icon" type="image/png" href="<%= image_path('swagger_ui_engine/favicon-16x16.png') %>" sizes="16x16" />
-
-  <%= stylesheet_link_tag "swagger_ui_engine/application", media: "screen" %>
-  <%= stylesheet_link_tag "swagger_ui_engine/print", media: "print" %>
-
-  <%= javascript_include_tag "swagger_ui_engine/application" %>
-  <%= csrf_meta_tags %>
-
-  <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: "<%= @doc_expansion %>",
-        jsonEditor: "<%= @json_editor %>",
-        defaultModelRendering: "<%= @model_rendering %>",
-        showRequestHeaders: "<%= @request_headers %>",
-        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="<%= image_path('swagger_ui_engine/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>
+  <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="<%= image_path('swagger_ui_engine/favicon-32x32.png') %>" sizes="32x32" />
+    <link rel="icon" type="image/png" href="<%= image_path('swagger_ui_engine/favicon-16x16.png') %>" sizes="16x16" />
+
+    <%= stylesheet_link_tag "swagger_ui_engine/application", media: "screen" %>
+    <%= stylesheet_link_tag "swagger_ui_engine/print", media: "print" %>
+
+    <%= javascript_include_tag "swagger_ui_engine/application" %>
+    <%= csrf_meta_tags %>
+
+  </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="<%= image_path('swagger_ui_engine/logo_small.png') %>" /><span class="logo__title">swagger</span></a>
+      </div>
+    </div>
+
+    <div id="message-bar" class="swagger-ui-wrap" data-sw-translate>&nbsp;</div>
+    <div id="swagger-ui-container" class="swagger-ui-wrap">
+      <ul>
+        <h2> API documentations: </h2>
+        <% @swagger_url.each_key do |k| %>
+          <li>
+            <h1> <%= link_to k, doc_path(k) %> </h1>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </body>
 </html>

data/app/views/swagger_ui_engine/docs/show.html.erb

@@ -0,0 +1,90 @@
+<!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="<%= image_path('swagger_ui_engine/favicon-32x32.png') %>" sizes="32x32" />
+    <link rel="icon" type="image/png" href="<%= image_path('swagger_ui_engine/favicon-16x16.png') %>" sizes="16x16" />
+
+    <%= stylesheet_link_tag "swagger_ui_engine/application", media: "screen" %>
+    <%= stylesheet_link_tag "swagger_ui_engine/print", media: "print" %>
+
+    <%= javascript_include_tag "swagger_ui_engine/application" %>
+    <%= csrf_meta_tags %>
+
+    <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,
+          validatorUrl: "<%= @validator_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: "<%= @doc_expansion %>",
+          jsonEditor: "<%= @json_editor %>",
+          defaultModelRendering: "<%= @model_rendering %>",
+          showRequestHeaders: "<%= @request_headers %>",
+          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="<%= image_path('swagger_ui_engine/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

@@ -1,3 +1,6 @@
 SwaggerUiEngine::Engine.routes.draw do
-  root to: 'docs#index'
+  scope format: false do
+    resources :docs, only: [:index, :show]
+    root to: 'docs#index'
+  end
 end

data/lib/swagger_ui_engine/configuration.rb

@@ -0,0 +1,17 @@
+module SwaggerUiEngine
+  class Configuration
+    # Configurable options
+    OPTIONS = [
+      :admin_username,
+      :admin_password,
+      :doc_expansion,
+      :json_editor,
+      :model_rendering,
+      :request_headers,
+      :swagger_url,
+      :validator_enabled,
+    ].freeze
+
+    attr_accessor(*OPTIONS)
+  end
+end

data/lib/swagger_ui_engine/engine.rb

@@ -18,21 +18,4 @@ module SwaggerUiEngine
       Rails.application.config.assets.precompile << /\.(?:svg|eot|woff|ttf)$/
     end
   end
-
-  class Configuration
-    attr_accessor :swagger_url, :doc_expansion, :model_rendering,
-                  :json_editor, :request_headers
-  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

@@ -1,4 +1,4 @@
 module SwaggerUiEngine
-  VERSION = '0.0.5'.freeze
+  VERSION = '1.0.0'.freeze
   SWAGGER_UI_VERSION = '2.2.10'.freeze
 end

data/lib/swagger_ui_engine.rb

@@ -1,4 +1,17 @@
-require "swagger_ui_engine/engine"
+require 'swagger_ui_engine/engine'
+require 'swagger_ui_engine/version'
+require 'swagger_ui_engine/configuration'
 
 module SwaggerUiEngine
+  class << self
+    delegate(*Configuration::OPTIONS, to: :configuration)
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
 end

metadata

@@ -1,36 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: swagger_ui_engine
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - ZuzannaSt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Swagger API docs and web console for your rails project.
+        version: 5.0.0
+description: Mount Swagger UI web console as Rails engine, configure it as you want
+  and write your API documentation in simple YAML files.
 email:
 - zuzannast@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - Rakefile
 - app/assets/fonts/swagger_ui_engine/DroidSans-Bold.ttf
@@ -88,12 +96,16 @@ files:
 - app/assets/stylesheets/swagger_ui_engine/lib/style.css
 - app/assets/stylesheets/swagger_ui_engine/lib/typography.css.erb
 - app/assets/stylesheets/swagger_ui_engine/print.css
+- app/controllers/swagger_ui_engine/application_controller.rb
 - app/controllers/swagger_ui_engine/docs_controller.rb
+- app/helpers/auth_config_parser.rb
 - app/helpers/config_parser.rb
 - app/helpers/swagger_ui_defaults.rb
 - app/views/swagger_ui_engine/docs/index.html.erb
+- app/views/swagger_ui_engine/docs/show.html.erb
 - config/routes.rb
 - lib/swagger_ui_engine.rb
+- lib/swagger_ui_engine/configuration.rb
 - lib/swagger_ui_engine/engine.rb
 - lib/swagger_ui_engine/version.rb
 homepage: https://github.com/ZuzannaSt/swagger_ui_engine
@@ -119,5 +131,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Mount Swagger-Ui as Rails engine.
+summary: Mountable Rails engine that serves Swagger UI for your API documentation
+  written in YAML files.
 test_files: []