RubyGems - swagger_ui_engine_2 - Versions diffs - 0.2.0 - Mend

swagger_ui_engine_2 0.2.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 (36) hide show

data/app/controllers/swagger_ui_engine2/application_controller.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module SwaggerUiEngine2
+  class ApplicationController < ActionController::Base
+    include SwaggerUiEngine2::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_engine2/swagger_docs_controller.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module SwaggerUiEngine2
+  class SwaggerDocsController < ApplicationController
+    include SwaggerUiEngine2::ConfigParser
+    layout 'layouts/swagger_ui_engine2/swagger'
+    before_action :set_configs
+    def index
+      @swagger_url = @swagger_url[params[:id].to_sym] unless single_doc_url?
+    end
+    private
+    def set_configs
+      SwaggerUiEngine2::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
+  end
+end

data/app/helpers/swagger_ui_engine_2/application_helper.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module SwaggerUiEngine2
+  module ApplicationHelper
+  end
+end

data/app/helpers/swagger_ui_engine_2/auth_config_parser.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module SwaggerUiEngine2
+  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
+      SwaggerUiEngine2.configuration
+    end
+  end
+end

data/app/helpers/swagger_ui_engine_2/config_parser.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module SwaggerUiEngine2
+  module ConfigParser
+    SwaggerUiEngine2::DEFAULTS.each do |default|
+      next if default.first.to_s.eql?('validator_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? ? SwaggerUiEngine2::DEFAULTS[:validator_url] : 'null'
+    end
+    def validator_enabled?
+      configuration.validator_enabled || false
+    end
+    def configuration
+      SwaggerUiEngine2.configuration
+    end
+  end
+end

data/app/views/layouts/swagger_ui_engine2/swagger.html.erb ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Swagger</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag    "swagger_ui_engine_2/application", media: "all" %>
+  <%= javascript_include_tag "swagger_ui_engine_2/swagger-ui-bundle.js" %>
+  <%= javascript_include_tag "swagger_ui_engine_2/swagger-ui-standalone-preset.js" %>
+  <%= yield :head %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

data/app/views/swagger_ui_engine2/swagger_docs/index.html.erb ADDED Viewed

@@ -0,0 +1,36 @@
+<% content_for(:head) do %>
+  <script type="text/javascript">
+    window.onload = function() {
+      var url = window.location.search.match(/url=([^&]+)/);
+      if (url && url.length > 1) {
+        url = decodeURIComponent(url[1]);
+      } else {
+        url = "<%= @swagger_url %>";
+      }
+      // Begin Swagger UI call region
+      const ui = SwaggerUIBundle({
+        url: url,
+        dom_id: '#swagger-ui',
+        deepLinking: true,
+        docExpansion: "<%= @doc_expansion %>",
+        jsonEditor: "<%= @json_editor %>",
+        defaultModelRendering: "<%= @model_rendering %>",
+        showRequestHeaders: "<%= @request_headers %>",
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+        plugins: [
+          SwaggerUIBundle.plugins.DownloadUrl
+        ],
+        layout: "StandaloneLayout"
+      });
+      // End Swagger UI call region
+      window.ui = ui;
+    };
+  </script>
+<% end %>
+<div id="swagger-ui"></div>

data/config/routes.rb ADDED Viewed

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

data/lib/swagger_ui_engine_2/configuration.rb ADDED Viewed

@@ -0,0 +1,24 @@
+module SwaggerUiEngine2
+  class Configuration
+    # Configurable options
+    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
+end

data/lib/swagger_ui_engine_2/defaults.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module SwaggerUiEngine2
+  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
+end

data/lib/swagger_ui_engine_2/engine.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module SwaggerUiEngine2
+  class Engine < ::Rails::Engine
+    isolate_namespace SwaggerUiEngine2
+  end
+end

data/lib/swagger_ui_engine_2/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module SwaggerUiEngine2
+  VERSION = "0.2.0"
+end

data/lib/swagger_ui_engine_2.rb ADDED Viewed

@@ -0,0 +1,19 @@
+require "sprockets/railtie"
+require "swagger_ui_engine_2/version"
+require "swagger_ui_engine_2/engine"
+require "swagger_ui_engine_2/configuration"
+require "swagger_ui_engine_2/defaults"
+module SwaggerUiEngine2
+  class << self
+    delegate(*Configuration::OPTIONS, to: :configuration)
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/tasks/swaggerui_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :swaggerui do
+#   # Task goes here
+# end

metadata ADDED Viewed

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: swagger_ui_engine_2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Israel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-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: Description of SwaggerUiEngine2.
+email:
+- israelb.aceves@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/swagger_ui_engine_2/manifest.js
+- app/assets/images/swagger_ui_engine_2/favicon-16x16.png
+- app/assets/images/swagger_ui_engine_2/favicon-32x32.png
+- app/assets/javascripts/swagger_ui_engine_2/application.js
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-bundle.js
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-bundle.js.map
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle-core.js
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle-core.js.map
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle.js
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle.js.map
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-standalone-preset.js
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-standalone-preset.js.map
+- app/assets/javascripts/swagger_ui_engine_2/swagger-ui.js
+- app/assets/stylesheets/swagger_ui_engine_2/application.css
+- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.css
+- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.css.map
+- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.js
+- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.js.map
+- app/controllers/swagger_ui_engine2/application_controller.rb
+- app/controllers/swagger_ui_engine2/swagger_docs_controller.rb
+- app/helpers/swagger_ui_engine_2/application_helper.rb
+- app/helpers/swagger_ui_engine_2/auth_config_parser.rb
+- app/helpers/swagger_ui_engine_2/config_parser.rb
+- app/views/layouts/swagger_ui_engine2/swagger.html.erb
+- app/views/swagger_ui_engine2/swagger_docs/index.html.erb
+- config/routes.rb
+- lib/swagger_ui_engine_2.rb
+- lib/swagger_ui_engine_2/configuration.rb
+- lib/swagger_ui_engine_2/defaults.rb
+- lib/swagger_ui_engine_2/engine.rb
+- lib/swagger_ui_engine_2/version.rb
+- lib/tasks/swaggerui_tasks.rake
+homepage:
+licenses: []
+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: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: Summary of SwaggerUiEngine2.
+test_files: []