rc-minitest-openapi-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03e7af9c0cb24c4b9d40abc84cec7ccad1c07f0e2aff6f129c9861ae2e58106d
+  data.tar.gz: 1d4b26f07bc3c9d9d068653ce038259c74232808e8044b2b5c51398ec354f1df
+SHA512:
+  metadata.gz: 31ae0efe0d957785608757303e3a6707542f2b9be42ff4e81a0792822012e7e83c44adf25c4f048d4c8e85fb682efc953dce1e60e556bde81bebf46d18d17b2b
+  data.tar.gz: 0a1f05ebdb044edb21bde871c7c606f08b587d685d607c25bc25d6c35eb0896ccd8425bb4a368ea19391167fa205af7d89e3cc4e0ac383492cba062c9a3afa5d

data/README.md

@@ -0,0 +1,19 @@
+# rc-minitest-openapi-api
+
+A mountable Rails engine that serves the OpenAPI document generated by
+[`rc-minitest-openapi`](https://github.com/RailsComposer/minitest-openapi).
+
+```ruby
+# config/routes.rb
+mount Minitest::OpenAPI::Api::Engine => "/api-docs"
+
+# config/initializers/minitest_openapi.rb
+Minitest::OpenAPI::Api.configure { |c| c.document_path = "openapi/v1/openapi.json" }
+```
+
+See the [repository README](https://github.com/RailsComposer/minitest-openapi)
+for full documentation.
+
+## License
+
+MIT

data/config/routes.rb

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

data/lib/minitest/openapi/api/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Minitest
+  module OpenAPI
+    module Api
+      class Configuration
+        # Path to the generated document, relative to Rails.root (or absolute).
+        attr_accessor :document_path
+
+        def initialize
+          @document_path = "openapi/openapi.json"
+        end
+      end
+    end
+  end
+end

data/lib/minitest/openapi/api/document_endpoint.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Minitest
+  module OpenAPI
+    module Api
+      # Rack endpoint that serves the generated OpenAPI document.
+      class DocumentEndpoint
+        JSON_HEADERS = {"content-type" => "application/json; charset=utf-8"}.freeze
+
+        def call(_env)
+          path = resolved_path
+
+          if File.file?(path)
+            [200, JSON_HEADERS.dup, [File.read(path)]]
+          else
+            [404, JSON_HEADERS.dup, [not_found_body]]
+          end
+        end
+
+        private
+
+        def resolved_path
+          configured = Minitest::OpenAPI::Api.configuration.document_path
+          return configured if Pathname.new(configured).absolute?
+
+          File.join(Rails.root.to_s, configured)
+        end
+
+        def not_found_body
+          %({"error":"OpenAPI document not found. Run `bin/rails openapi:generate`."})
+        end
+      end
+    end
+  end
+end

data/lib/minitest/openapi/api/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module Minitest
+  module OpenAPI
+    module Api
+      # Mountable engine. In the host app's routes:
+      #
+      #   mount Minitest::OpenAPI::Api::Engine => "/api-docs"
+      #
+      # The document is then served at GET /api-docs.
+      class Engine < ::Rails::Engine
+        isolate_namespace Minitest::OpenAPI::Api
+      end
+    end
+  end
+end

data/lib/minitest/openapi/api/version.rb

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

data/lib/minitest/openapi/api.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "api/version"
+require_relative "api/configuration"
+require_relative "api/document_endpoint"
+require_relative "api/engine" if defined?(::Rails::Engine)
+
+module Minitest
+  module OpenAPI
+    # Serves the OpenAPI document produced by minitest-openapi.
+    module Api
+      class << self
+        def configuration
+          @configuration ||= Configuration.new
+        end
+
+        def configure
+          yield configuration
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: rc-minitest-openapi-api
+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 serves the OpenAPI document produced by
+  rc-minitest-openapi at a configurable route.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/routes.rb
+- lib/minitest/openapi/api.rb
+- lib/minitest/openapi/api/configuration.rb
+- lib/minitest/openapi/api/document_endpoint.rb
+- lib/minitest/openapi/api/engine.rb
+- lib/minitest/openapi/api/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: Serve the OpenAPI document generated by rc-minitest-openapi.
+test_files: []