miniswag-ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21053b8d93bdb4c2d156e98cb6d57ca46fa20f7f68335d94d1bacdbd375aaf28
+  data.tar.gz: 79f2201b7412895ca8b9f5ca21acc74606a135b0db8212a3c19ccdbc108397d1
+SHA512:
+  metadata.gz: '066339385b6211cd36a5b701a7aa45a19be4072eeb17ae93b6af36ea5f29ebcb558fad884ffd2dd64c3fbc823c26baf4ebf60464dd0748da17849c6a484076c3'
+  data.tar.gz: 1044084f8f24fa858d4ca43e9e02691981010eb377721a3c7529ef895df946dddac17dd54b91b01f944af99a71f831ddbdc95b10dd18d5a5393fb63ca6435778

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sika
+
+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/lib/generators/miniswag/ui/custom/custom_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Miniswag
+  module Ui
+    class CustomGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../../lib/miniswag/ui', __dir__)
+
+      def add_custom_index
+        copy_file('index.erb', 'app/views/miniswag/ui/home/index.html.erb')
+      end
+    end
+  end
+end

data/lib/generators/miniswag/ui/install/install_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Miniswag
+  module Ui
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def add_initializer
+        template('miniswag_ui.rb', 'config/initializers/miniswag_ui.rb')
+      end
+
+      def add_routes
+        route("mount Miniswag::Ui::Engine => '/api-docs'")
+      end
+    end
+  end
+end

data/lib/generators/miniswag/ui/install/templates/miniswag_ui.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Miniswag::Ui.configure do |c|
+  # List the OpenAPI 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 endpoint and the second is a title that will be
+  # displayed in the document selector.
+
+  c.openapi_endpoint '/api-docs/v1/openapi.yaml', 'API V1 Docs'
+
+  # Add Basic Auth in case your API is private
+  # c.basic_auth_enabled = true
+  # c.basic_auth_credentials 'username', 'password'
+end

data/lib/miniswag/ui/basic_auth.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rack/auth/basic'
+
+module Miniswag
+  module Ui
+    # Extend Rack HTTP Basic Authentication, as per RFC 2617.
+    # @api private
+    class BasicAuth < ::Rack::Auth::Basic
+      def call(env)
+        return @app.call(env) unless env_matching_path(env)
+
+        super(env)
+      end
+
+      private
+
+      def env_matching_path(env)
+        path = base_path(env['PATH_INFO'])
+        Miniswag::Ui.config.config_object[:urls]&.find do |endpoint|
+          base_path(endpoint[:url]) == path
+        end
+      end
+
+      def base_path(url)
+        url.downcase.split('/')[1]
+      end
+    end
+  end
+end

data/lib/miniswag/ui/configuration.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Miniswag
+  module Ui
+    class Configuration
+      attr_reader :template_locations, :assets_root
+      attr_accessor :basic_auth_enabled, :config_object, :oauth_config_object
+
+      def initialize
+        @template_locations = [
+          # preferred override location
+          "#{Rack::Directory.new('').root}/swagger/index.erb",
+          # backwards compatible override location
+          "#{Rack::Directory.new('').root}/app/views/miniswag/ui/home/index.html.erb",
+          # default location
+          File.expand_path('index.erb', __dir__)
+        ]
+        @assets_root = File.expand_path('../../../node_modules/swagger-ui-dist', __dir__)
+        @config_object = {}
+        @oauth_config_object = {}
+        @basic_auth_enabled = false
+      end
+
+      def openapi_endpoint(url, name)
+        @config_object[:urls] ||= []
+        @config_object[:urls] << { url: url, name: name }
+      end
+
+      def basic_auth_credentials(username, password)
+        @config_object[:basic_auth] = { username: username, password: password }
+      end
+
+      # rubocop:disable Naming/AccessorMethodName
+      def get_binding
+        binding
+      end
+      # rubocop:enable Naming/AccessorMethodName
+    end
+  end
+end

data/lib/miniswag/ui/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'miniswag/ui/middleware'
+require 'miniswag/ui/basic_auth'
+
+module Miniswag
+  module Ui
+    class Engine < ::Rails::Engine
+      isolate_namespace Miniswag::Ui
+
+      initializer 'miniswag-ui.initialize' do |app|
+        middleware.use Miniswag::Ui::Middleware, Miniswag::Ui.config
+
+        if Miniswag::Ui.config.basic_auth_enabled
+          c = Miniswag::Ui.config
+          app.middleware.use Miniswag::Ui::BasicAuth do |username, password|
+            c.config_object[:basic_auth].values == [username, password]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/miniswag/ui/index.erb

@@ -0,0 +1,35 @@
+<!-- HTML for Swagger UI -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Miniswag API Documentation</title>
+  <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+  <style>
+    html { box-sizing: border-box; overflow: -moz-scrollbars-vertical; overflow-y: scroll; }
+    *, *:before, *:after { box-sizing: inherit; }
+    body { margin:0; background: #fafafa; }
+  </style>
+</head>
+<body>
+<div id="swagger-ui"></div>
+<script src="./swagger-ui-bundle.js"> </script>
+<script src="./swagger-ui-standalone-preset.js"> </script>
+<script>
+window.onload = function() {
+  var configObject = JSON.parse('<%= config_object.to_json %>');
+  var oauthConfigObject = JSON.parse('<%= oauth_config_object.to_json %>');
+
+  // Apply defaults
+  configObject.dom_id = "#swagger-ui";
+  configObject.presets = [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset];
+  configObject.layout = "StandaloneLayout";
+
+  const ui = SwaggerUIBundle(configObject);
+  if (Object.keys(oauthConfigObject).length) {
+    ui.initOAuth(oauthConfigObject);
+  }
+}
+</script>
+</body>
+</html>

data/lib/miniswag/ui/middleware.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Miniswag
+  module Ui
+    class Middleware < Rack::Static
+      def initialize(app, config)
+        @config = config
+        super(app, urls: [''], root: config.assets_root)
+      end
+
+      def call(env)
+        if base_path?(env)
+          redirect_uri = "#{env['SCRIPT_NAME'].chomp('/')}/index.html"
+          return [301, { 'Location' => redirect_uri }, []]
+        end
+
+        if index_path?(env)
+          return [200, { 'Content-Type' => 'text/html', 'Content-Security-Policy' => csp },
+                  [render_template]]
+        end
+
+        super
+      end
+
+      private
+
+      def base_path?(env)
+        env['REQUEST_METHOD'] == 'GET' && env['PATH_INFO'] == '/'
+      end
+
+      def index_path?(env)
+        env['REQUEST_METHOD'] == 'GET' && env['PATH_INFO'] == '/index.html'
+      end
+
+      def render_template
+        file = File.new(template_filename)
+        template = ERB.new(file.read)
+        template.result(@config.get_binding)
+      end
+
+      def template_filename
+        @config.template_locations.find { |filename| File.exist?(filename) }
+      end
+
+      def csp
+        <<~POLICY.tr("\n", ' ')
+          default-src 'self';
+          img-src 'self' data: https://validator.swagger.io;
+          font-src 'self' https://fonts.gstatic.com;
+          style-src 'self' 'unsafe-inline' https://fonts.googleapis.com;
+          script-src 'self' 'unsafe-inline';
+        POLICY
+      end
+    end
+  end
+end

data/lib/miniswag/ui.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'miniswag/ui/configuration'
+require 'miniswag/ui/engine'
+
+module Miniswag
+  module Ui
+    def self.configure
+      yield(config)
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: miniswag-ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edem Kumodzi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: |
+  Generate beautiful API documentation, including a UI to explore and test
+  operations, directly from your Minitest integration tests.
+email:
+- edem@sika.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/generators/miniswag/ui/custom/custom_generator.rb
+- lib/generators/miniswag/ui/install/install_generator.rb
+- lib/generators/miniswag/ui/install/templates/miniswag_ui.rb
+- lib/miniswag/ui.rb
+- lib/miniswag/ui/basic_auth.rb
+- lib/miniswag/ui/configuration.rb
+- lib/miniswag/ui/engine.rb
+- lib/miniswag/ui/index.erb
+- lib/miniswag/ui/middleware.rb
+homepage: https://github.com/edemkumodzi/miniswag
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/edemkumodzi/miniswag/tree/main/miniswag-ui
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.0
+specification_version: 4
+summary: A Rails Engine that includes swagger-ui and powers it from configured OpenAPI
+  endpoints
+test_files: []