RubyGems - rc-minitest-openapi-ui - Versions diffs - 0.1.0 - Mend

rc-minitest-openapi-ui 0.1.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 (9) hide show

checksums.yaml +7 -0
data/README.md +22 -0
data/config/routes.rb +5 -0
data/lib/minitest/openapi/ui/configuration.rb +25 -0
data/lib/minitest/openapi/ui/engine.rb +16 -0
data/lib/minitest/openapi/ui/page_endpoint.rb +49 -0
data/lib/minitest/openapi/ui/version.rb +9 -0
data/lib/minitest/openapi/ui.rb +23 -0
metadata +63 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24028baf7b6d71e8c5e682a771b8cd6c7e94b18c60e7560410cef1b1256b40d8
+  data.tar.gz: 8f169a37ef45b9716b766ef793deb7845403b2a1ee727196a8e9394d0d8c6429
+SHA512:
+  metadata.gz: dc98e1fc8384fcd33e59fe6af30e901b10a4068a5f0cae5b16ee19fb1c890358b34bdd986c475136399367e980c6fe1d7aed5c8c8db03195baadeb13b3be697a
+  data.tar.gz: c51d689ac3bb9e8927ac16233782ff7846e4cc37781575570e8baa4b0f90915e003e7a7ebd3ac485dbe9b9d8577372b7fbc8bf17e26dba4ccc7240d3f4cab5eb

data/README.md ADDED Viewed

@@ -0,0 +1,22 @@
+# rc-minitest-openapi-ui
+A mountable Rails engine that renders Swagger UI for an OpenAPI document,
+pairing with [`rc-minitest-openapi`](https://github.com/RailsComposer/minitest-openapi)
+and `rc-minitest-openapi-api`.
+```ruby
+# config/routes.rb
+mount Minitest::OpenAPI::UI::Engine => "/api-docs/ui"
+# config/initializers/minitest_openapi.rb
+Minitest::OpenAPI::UI.configure { |c| c.openapi_url = "/api-docs" }
+```
+Swagger UI assets are loaded from the jsDelivr CDN; no assets are vendored.
+See the [repository README](https://github.com/RailsComposer/minitest-openapi)
+for full documentation.
+## License
+MIT

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+Minitest::OpenAPI::UI::Engine.routes.draw do
+  get "/" => Minitest::OpenAPI::UI::PageEndpoint.new, :as => :ui
+end

data/lib/minitest/openapi/ui/configuration.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Minitest
+  module OpenAPI
+    module UI
+      class Configuration
+        # URL the Swagger UI page loads the OpenAPI document from. Point this
+        # at wherever minitest-openapi-api is mounted.
+        attr_accessor :openapi_url
+        # Page <title>.
+        attr_accessor :page_title
+        # swagger-ui-dist version loaded from the jsDelivr CDN.
+        attr_accessor :swagger_ui_version
+        def initialize
+          @openapi_url = "/api-docs"
+          @page_title = "API documentation"
+          @swagger_ui_version = "5.17.14"
+        end
+      end
+    end
+  end
+end

data/lib/minitest/openapi/ui/engine.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require "rails/engine"
+module Minitest
+  module OpenAPI
+    module UI
+      # Mountable engine. In the host app's routes:
+      #
+      #   mount Minitest::OpenAPI::UI::Engine => "/api-docs/ui"
+      class Engine < ::Rails::Engine
+        isolate_namespace Minitest::OpenAPI::UI
+      end
+    end
+  end
+end

data/lib/minitest/openapi/ui/page_endpoint.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require "erb"
+module Minitest
+  module OpenAPI
+    module UI
+      # Rack endpoint rendering a Swagger UI page. swagger-ui-dist is loaded
+      # from the jsDelivr CDN so the gem ships no vendored assets.
+      class PageEndpoint
+        HTML_HEADERS = {"content-type" => "text/html; charset=utf-8"}.freeze
+        def call(_env)
+          [200, HTML_HEADERS.dup, [render]]
+        end
+        private
+        def render
+          config = Minitest::OpenAPI::UI.configuration
+          base = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@#{config.swagger_ui_version}"
+          <<~HTML
+            <!DOCTYPE html>
+            <html lang="en">
+            <head>
+              <meta charset="UTF-8">
+              <meta name="viewport" content="width=device-width, initial-scale=1">
+              <title>#{ERB::Util.html_escape(config.page_title)}</title>
+              <link rel="stylesheet" href="#{base}/swagger-ui.css">
+            </head>
+            <body>
+              <div id="swagger-ui"></div>
+              <script src="#{base}/swagger-ui-bundle.js"></script>
+              <script>
+                window.ui = SwaggerUIBundle({
+                  url: #{config.openapi_url.to_json},
+                  dom_id: "#swagger-ui",
+                  deepLinking: true
+                });
+              </script>
+            </body>
+            </html>
+          HTML
+        end
+      end
+    end
+  end
+end

data/lib/minitest/openapi/ui/version.rb ADDED Viewed

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Minitest
+  module OpenAPI
+    module UI
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/minitest/openapi/ui.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require_relative "ui/version"
+require_relative "ui/configuration"
+require_relative "ui/page_endpoint"
+require_relative "ui/engine" if defined?(::Rails::Engine)
+module Minitest
+  module OpenAPI
+    # Renders Swagger UI for an OpenAPI document.
+    module UI
+      class << self
+        def configuration
+          @configuration ||= Configuration.new
+        end
+        def configure
+          yield configuration
+        end
+      end
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: rc-minitest-openapi-ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RailsComposer
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: A mountable Rails engine that renders Swagger UI for an OpenAPI document,
+  intended to pair with rc-minitest-openapi and rc-minitest-openapi-api.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/routes.rb
+- lib/minitest/openapi/ui.rb
+- lib/minitest/openapi/ui/configuration.rb
+- lib/minitest/openapi/ui/engine.rb
+- lib/minitest/openapi/ui/page_endpoint.rb
+- lib/minitest/openapi/ui/version.rb
+homepage: https://github.com/RailsComposer/minitest-openapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RailsComposer/minitest-openapi
+  source_code_uri: https://github.com/RailsComposer/minitest-openapi
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Swagger UI for the OpenAPI document generated by rc-minitest-openapi.
+test_files: []