swagger_ui_engine 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cf6d187a04a511f68f0ca2aaf44e67a191a8abb
-  data.tar.gz: 551be9c6c59e67202c69c8dc8bf17341a75c9079
+  metadata.gz: feeab22e987c76c54281622b493aa6a56c8adab3
+  data.tar.gz: a318d182ec2bb18add9decae5e6df03f7ce5a52d
 SHA512:
-  metadata.gz: 99d13298d35bab586e706419f30787b107add39656328cf9644376784317ba611d9fff076338a360edff3e9558ffe2ba525c95dee08020160a2419d4b5fb82f9
-  data.tar.gz: 1be044e1b3c8f8152801ad9f70a6e711bb3dd48d498695028671b3ed153f4582f21581f6ae61ef5a6097d9b72fcc3a0ed8b534b0f1f6f24f8fdc8971757c085a
+  metadata.gz: ae10fc9280d2112315e4623d2ed189a1f1090834ee27f108da5a049add052e01c8fb758265f1fc73e0313f9412b2b6b82e4d4c5f2babe69a8273e4c74b4e55aa
+  data.tar.gz: 818ce3e5688f985c5fbbb291a2263fe0b375fb8cb72521ebb504b613efe62e48ae76d0a7df05281e544da87b1e928197ab863c3eea73eff16c715c5acb8aed20

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## master
 
+## 1.1.0
+
+* Correct Oauth template name
+* Add sass/rails dependency for API-only applications
+* Rename routes to be Swagger-specific
+* Separate route for single API docs version
+* Ignore Gemfile.lock file
+* Overall refactor
+
 ## 1.0.2
 
 * Fix translation loading error

data/app/controllers/swagger_ui_engine/swagger_docs_controller.rb

@@ -0,0 +1,51 @@
+module SwaggerUiEngine
+  class SwaggerDocsController < ApplicationController
+    include SwaggerUiEngine::ConfigParser
+    include SwaggerUiEngine::OauthConfigParser
+
+    add_template_helper SwaggerUiEngine::TranslationHelper
+    layout 'swagger_ui_engine/layouts/swagger', except: %w(oauth2)
+
+    before_action :set_configs, :set_oauth_configs
+
+    def oauth2
+    end
+
+    def index
+      # backward compatibility for defining single doc url in strings
+      redirect_to single_swagger_doc_path if single_doc_url?
+      redirect_to swagger_doc_path(@swagger_url.keys.first) if single_doc_url_hash?
+    end
+
+    def show
+      @single_doc_url = single_doc_url? || single_doc_url_hash?
+      @swagger_url = @swagger_url[params[:id].to_sym] unless single_doc_url?
+    end
+
+    def single_doc
+      render 'show'
+    end
+
+    private
+
+    def set_configs
+      SwaggerUiEngine::DEFAULTS.keys.each do |key|
+        instance_variable_set("@#{key}", self.send("set_#{key}"))
+      end
+    end
+
+    def set_oauth_configs
+      SwaggerUiEngine::OAUTH2_DEFAULTS.keys.each do |key|
+        instance_variable_set("@#{key}", self.send("set_#{key}"))
+      end
+    end
+
+    def single_doc_url?
+      @swagger_url.is_a?(String)
+    end
+
+    def single_doc_url_hash?
+      @swagger_url.is_a?(Hash) && @swagger_url.size.eql?(1)
+    end
+  end
+end

data/app/helpers/swagger_ui_engine/config_parser.rb

@@ -1,34 +1,21 @@
 module SwaggerUiEngine
   module ConfigParser
-    def set_doc_expansion
-      configuration.doc_expansion || default_doc_expansion
-    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
-
-    def set_show_operation_ids
-      configuration.show_operation_ids || default_show_operation_ids
-    end
+    SwaggerUiEngine::DEFAULTS.each do |default|
+      next if default.first.to_s.eql?('validator_url')
 
-    def set_swagger_url
-      configuration.swagger_url || default_swagger_url
+      define_method("set_#{default.first}") do
+        # set_swagger_url set_doc_expansion
+        # set_json_editor set_model_rendering
+        # set_request_headers
+        configuration.send("#{default.first}") || default.last
+      end
     end
 
     def set_validator_url
-      validator_enabled ? default_validator_url : 'null'
+      validator_enabled? ? SwaggerUiEngine::DEFAULTS[:validator_url] : 'null'
     end
 
-    def validator_enabled
+    def validator_enabled?
       configuration.validator_enabled || false
     end
 

data/app/helpers/swagger_ui_engine/oauth_config_parser.rb

@@ -1,31 +1,12 @@
 module SwaggerUiEngine
   module OauthConfigParser
-    def set_oauth_app_name
-      configuration.oauth_app_name || 'your-app-name'
-    end
-
-    def set_oauth_client_id
-      configuration.oauth_client_id || 'your-client-id'
-    end
-
-    def set_oauth_client_secret
-      configuration.oauth_client_secret || 'your-client-secret-if-required'
-    end
-
-    def set_oauth_realm
-      configuration.oauth_realm || 'your-realms'
-    end
-
-    def set_oauth_scope_separator
-      configuration.oauth_scope_separator || ' '
-    end
-
-    def set_oauth_query_string_params
-      configuration.oauth_query_string_params || {}
-    end
-
-    def configuration
-      SwaggerUiEngine.configuration
+    SwaggerUiEngine::OAUTH2_DEFAULTS.each do |default|
+      define_method("set_#{default.first}") do
+        # set_oauth_app_name set_oauth_client_id
+        # set_oauth_client_secret set_oauth_realm
+        # set_oauth_scope_separator set_oauth_query_string_params
+        configuration.send("#{default.first}") || default.last
+      end
     end
   end
 end

data/app/views/swagger_ui_engine/{docs/index.html.erb → layouts/swagger.html.erb}

@@ -12,7 +12,7 @@
 
     <%= javascript_include_tag "swagger_ui_engine/application" %>
     <%= csrf_meta_tags %>
-
+    <%= yield :head %>
   </head>
 
   <body class="swagger-section">
@@ -24,14 +24,7 @@
 
     <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>
+      <%= yield %>
     </div>
   </body>
 </html>

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

@@ -0,0 +1,8 @@
+<ul>
+  <h2> API documentations: </h2>
+  <% @swagger_url.each_key do |k| %>
+    <li>
+      <h1> <%= link_to k, swagger_doc_path(k) %> </h1>
+    </li>
+  <% end %>
+</ul>

data/app/views/swagger_ui_engine/{docs → swagger_docs}/show.html.erb

@@ -1,19 +1,4 @@
-<!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" %>
-    <%= load_translation_file %>
-    <%= csrf_meta_tags %>
-
+<% content_for(:head) do %>
     <script type="text/javascript">
       $(function () {
         var url = window.location.search.match(/url=([^&]+)/);
@@ -34,7 +19,7 @@
         window.swaggerUi = new SwaggerUi({
           url: url,
           validatorUrl: "<%= @validator_url %>",
-          oauth2RedirectUrl: "<%= oauth2_docs_path %>",
+          oauth2RedirectUrl: "<%= oauth2_swagger_docs_path %>",
           dom_id: "swagger-ui-container",
           supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
           onComplete: function(swaggerApi, swaggerUi){
@@ -72,26 +57,10 @@
         }
     });
     </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>
+<% end %>
 
-    <div id="message-bar" class="swagger-ui-wrap" data-sw-translate>&nbsp;</div>
-    <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
-    <% unless @single_doc_url %>
-      <div class="swagger-ui-wrap">
-        <a href="<%= docs_path %>" class="swagger-return-link" data-sw-translate>Back to the list</a>
-      </div>
-    <% end %>
-  </body>
-</html>
+<% unless @single_doc_url %>
+  <div class="swagger-ui-wrap">
+    <a href="<%= swagger_docs_path %>" class="swagger-return-link" data-sw-translate> Back to the list </a>
+  </div>
+<% end %>

data/config/routes.rb

@@ -1,11 +1,12 @@
 SwaggerUiEngine::Engine.routes.draw do
   scope format: false do
-    resources :docs, only: [:index, :show] do
+    resources :swagger_docs, only: [:index, :show] do
       collection do
-        get 'oauth2', to: 'docs#oauth2', format: false
+        get 'oauth2', to: 'swagger_docs#oauth2', format: false
       end
     end
 
-    root to: 'docs#index'
+    get 'single_swagger_doc', to: 'swagger_docs#single_doc', format: false
+    root to: 'swagger_docs#index'
   end
 end

data/lib/swagger_ui_engine.rb

@@ -1,6 +1,7 @@
 require 'swagger_ui_engine/engine'
 require 'swagger_ui_engine/version'
 require 'swagger_ui_engine/configuration'
+require 'swagger_ui_engine/defaults'
 
 module SwaggerUiEngine
   class << self

data/lib/swagger_ui_engine/configuration.rb

@@ -1,23 +1,23 @@
 module SwaggerUiEngine
   class Configuration
     # Configurable options
-    OPTIONS = [
-      :admin_username,
-      :admin_password,
-      :doc_expansion,
-      :json_editor,
-      :model_rendering,
-      :oauth_client_id,
-      :oauth_client_secret,
-      :oauth_realm,
-      :oauth_app_name,
-      :oauth_scope_separator,
-      :oauth_query_string_params,
-      :request_headers,
-      :swagger_url,
-      :translator_enabled,
-      :validator_enabled,
-    ].freeze
+    OPTIONS = %i(
+      admin_username
+      admin_password
+      doc_expansion
+      json_editor
+      model_rendering
+      oauth_client_id
+      oauth_client_secret
+      oauth_realm
+      oauth_app_name
+      oauth_scope_separator
+      oauth_query_string_params
+      request_headers
+      swagger_url
+      translator_enabled
+      validator_enabled
+    ).freeze
 
     attr_accessor(*OPTIONS)
   end

data/lib/swagger_ui_engine/defaults.rb

@@ -0,0 +1,19 @@
+module SwaggerUiEngine
+  DEFAULTS = {
+    swagger_url:      'http://petstore.swagger.io/v2/swagger.json',
+    doc_expansion:    'none',
+    json_editor:      false,
+    model_rendering:  'schema',
+    request_headers:  false,
+    validator_url:    '//online.swagger.io/validator'
+  }.freeze
+
+  OAUTH2_DEFAULTS = {
+    oauth_app_name: 'your-app-name',
+    oauth_client_id: 'your-client-id',
+    oauth_client_secret: 'your-client-secret-if-required',
+    oauth_realm: 'your-realms',
+    oauth_scope_separator: ' ',
+    oauth_query_string_params: {}
+  }.freeze
+end

data/lib/swagger_ui_engine/engine.rb

@@ -1,3 +1,5 @@
+require 'sass/rails'
+
 module SwaggerUiEngine
   class Engine < ::Rails::Engine
     isolate_namespace SwaggerUiEngine

data/lib/swagger_ui_engine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_ui_engine
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - ZuzannaSt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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:
@@ -98,18 +112,19 @@ files:
 - 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/controllers/swagger_ui_engine/swagger_docs_controller.rb
 - app/helpers/swagger_ui_engine/auth_config_parser.rb
 - app/helpers/swagger_ui_engine/config_parser.rb
 - app/helpers/swagger_ui_engine/oauth_config_parser.rb
-- app/helpers/swagger_ui_engine/swagger_ui_defaults.rb
 - app/helpers/swagger_ui_engine/translation_helper.rb
-- app/views/swagger_ui_engine/docs/index.html.erb
-- app/views/swagger_ui_engine/docs/ouath2.html.erb
-- app/views/swagger_ui_engine/docs/show.html.erb
+- app/views/swagger_ui_engine/layouts/swagger.html.erb
+- app/views/swagger_ui_engine/swagger_docs/index.html.erb
+- app/views/swagger_ui_engine/swagger_docs/oauth2.html.erb
+- app/views/swagger_ui_engine/swagger_docs/show.html.erb
 - config/routes.rb
 - lib/swagger_ui_engine.rb
 - lib/swagger_ui_engine/configuration.rb
+- lib/swagger_ui_engine/defaults.rb
 - lib/swagger_ui_engine/engine.rb
 - lib/swagger_ui_engine/version.rb
 homepage: https://github.com/ZuzannaSt/swagger_ui_engine
@@ -132,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Mountable Rails engine that serves Swagger UI for your API documentation

data/app/controllers/swagger_ui_engine/docs_controller.rb

@@ -1,52 +0,0 @@
-module SwaggerUiEngine
-  class DocsController < ApplicationController
-    include SwaggerUiEngine::ConfigParser
-    include SwaggerUiEngine::OauthConfigParser
-    include SwaggerUiEngine::SwaggerUiDefaults
-
-    add_template_helper SwaggerUiEngine::TranslationHelper
-    before_action :set_configs, :set_oauth_configs
-
-    def oauth2
-    end
-
-    def index
-      # 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
-      @single_doc_url = single_doc_url? || single_doc_url_hash?
-      @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 set_oauth_configs
-      @oauth_app_name = set_oauth_app_name
-      @oauth_client_id = set_oauth_client_id
-      @oauth_client_secret = set_oauth_client_secret
-      @oauth_realm = set_oauth_realm
-      @oauth_query_string_params = set_oauth_query_string_params
-      @oauth_scope_separator = set_oauth_scope_separator
-    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/swagger_ui_engine/swagger_ui_defaults.rb

@@ -1,27 +0,0 @@
-module SwaggerUiEngine
-  module SwaggerUiDefaults
-    def default_swagger_url
-      'http://petstore.swagger.io/v2/swagger.json'
-    end
-
-    def default_doc_expansion
-      'none'
-    end
-
-    def default_json_editor
-      false
-    end
-
-    def default_model_rendering
-      'schema'
-    end
-
-    def default_request_headers
-      false
-    end
-
-    def default_validator_url
-      '//online.swagger.io/validator'
-    end
-  end
-end