miniswag-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04a59ae0610a53747cbfcc2bf71716c17bca7997c9a29c65768087a5a71d38cc
+  data.tar.gz: 392f14d55f8509742a96def1a9424a2f5bf65f44a877214f68e0708aa3a8b98d
+SHA512:
+  metadata.gz: 8decebb8d4db1d5b2e340de9fabf530bd715cfb96418e448187278c78a3230fa78441edc47c201df9d41c61d0bcee0aa9c1da32b46e19650003531673ac62ebb
+  data.tar.gz: a8fe8ea54d822ec0a3a05eacc6e471896666cf269aae9efd029cfc7b0b45e5fc3e24e2eac1b97e3bdac5c6cb8d22d974ace08f872c13aaf3f4f0116e33cae1d7

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/api/install/install_generator.rb

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

data/lib/generators/miniswag/api/install/templates/miniswag_api.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Miniswag::Api.configure do |c|
+  # Specify a root folder where OpenAPI JSON/YAML files are located.
+  # This is used by the middleware to serve requests for API descriptions.
+  c.openapi_root = Rails.root.join('openapi').to_s
+
+  # Inject a lambda to alter the returned OpenAPI prior to serialization.
+  # The function will have access to the rack env for the current request.
+  # For example, you could leverage this to dynamically assign the "host" property:
+  #
+  # c.openapi_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+end

data/lib/miniswag/api/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Miniswag
+  module Api
+    class Configuration
+      attr_accessor :openapi_root, :openapi_filter, :openapi_headers
+
+      def resolve_openapi_root(env)
+        path_params = env['action_dispatch.request.path_parameters'] || {}
+        path_params[:openapi_root] || openapi_root
+      end
+    end
+  end
+end

data/lib/miniswag/api/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'miniswag/api/middleware'
+
+module Miniswag
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace Miniswag::Api
+
+      initializer 'miniswag-api.initialize' do |_app|
+        middleware.use Miniswag::Api::Middleware, Miniswag::Api.config
+      end
+    end
+  end
+end

data/lib/miniswag/api/middleware.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'yaml'
+require 'rack/mime'
+
+module Miniswag
+  module Api
+    class Middleware
+      def initialize(app, config)
+        @app = app
+        @config = config
+      end
+
+      def call(env)
+        path = env['PATH_INFO']
+        # Sanitize the filename for directory traversal by expanding, and ensuring
+        # it starts with the root directory.
+        openapi_root = @config.resolve_openapi_root(env)
+        filename = File.expand_path(File.join(openapi_root, path))
+        return @app.call(env) unless filename.start_with?(openapi_root.to_s)
+
+        if env['REQUEST_METHOD'] == 'GET' && File.file?(filename)
+          openapi = parse_file(filename)
+          @config.openapi_filter&.call(openapi, env)
+          mime = Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+          headers = { 'Content-Type' => mime }.merge(@config.openapi_headers || {})
+          body = unload_openapi(filename, openapi)
+
+          return [200, headers, [body]]
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def parse_file(filename)
+        if /\.ya?ml$/.match?(filename)
+          YAML.safe_load(File.read(filename))
+        else
+          JSON.parse(File.read(filename))
+        end
+      end
+
+      def unload_openapi(filename, openapi)
+        if /\.ya?ml$/.match?(filename)
+          YAML.dump(openapi)
+        else
+          JSON.dump(openapi)
+        end
+      end
+    end
+  end
+end

data/lib/miniswag/api.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'miniswag/api/configuration'
+require 'miniswag/api/engine' if defined?(Rails::Engine)
+
+module Miniswag
+  module Api
+    def self.configure
+      yield(config)
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: miniswag-api
+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: activesupport
+  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: |
+  Open up your API to the OpenAPI ecosystem by exposing OpenAPI files,
+  that describe your service, as JSON or YAML endpoints.
+email:
+- edem@sika.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/generators/miniswag/api/install/install_generator.rb
+- lib/generators/miniswag/api/install/templates/miniswag_api.rb
+- lib/miniswag/api.rb
+- lib/miniswag/api/configuration.rb
+- lib/miniswag/api/engine.rb
+- lib/miniswag/api/middleware.rb
+homepage: https://github.com/edemkumodzi/miniswag
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/edemkumodzi/miniswag/tree/main/miniswag-api
+  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 exposes OpenAPI files as JSON/YAML endpoints
+test_files: []