minitest-openapi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 842cf7448f6ccde919d1c6d51eccf576923fa47d7da657139b3956c09955fea3
-  data.tar.gz: b623ad83736c487b3f0aa51f83ecedc9dc153670c15ce855b9202dcefc87f19a
+  metadata.gz: c9ce72856fa448b87d2a15278ceb0d9aeb93a7de02cbfe08341c872004abcffd
+  data.tar.gz: 7c3a71aea09013041b302aac453ddc50f1af8c41554e2c5dda0c6fe7e5c44361
 SHA512:
-  metadata.gz: 6c65f04a0d795172d7f1100a045ff6139b3bfa391bdf4dac4c64240b0d7cf72b61136555fb80a1cb76c47645866dce982021c557c6940a0457dd812e4b61f48c
-  data.tar.gz: d960a442315236435eb6121978468bd5670fb31d1a6f80ad72fa245294c45c1c78416a5e87003def8c2431d344415fc4368c3d6ba940ef84b3f192dd14f62190
+  metadata.gz: 1c4b050a134c378ea354408056e6dcc5e3060a929b3ce0b7f2979bf3eded390dd20b2392619a77dc007956d1a42a010a2634e3819b57d220bcfde7c47d84d860
+  data.tar.gz: 1326a492f68652eceb81017c9676f0401a8d0361dadca7b6b82ad7c92136938661a120f0fb6ca0cfba962b7a25fd2b9e4dbc770a53c7eefff4316d48a571bc24

data/lib/minitest/openapi/endpoint_metadata.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "action_dispatch"
+require "active_support/inflector"
+
+module Minitest
+  module OpenAPI
+    module EndpointMetadata
+      class << self
+        def call(context, _test)
+          @request, @response = Minitest::OpenAPI::ParseRequest.call(context)
+          return if @request.nil?
+
+          @endpoint = @request.filtered_path || "unknown"
+          metadata
+        end
+
+        private
+
+        def metadata
+          {
+            endpoint: format_endpoint,
+            method: @request.method.downcase,
+            summary: "",
+            parameters: [],
+            status: @response.status
+          }
+        end
+
+        # Convert "owners/1234/pets/5678" to "owners/{ownerId}/pets/{petId}"
+        def format_endpoint
+          ep = @endpoint.split("/")[1..-1] || []
+          resource = ""
+
+          ep.each_with_index do |e, i|
+            i.odd? ?
+              ep[i] = "{#{resource}Id}" :
+              resource = ActiveSupport::Inflector.singularize(e)
+          end
+          "/#{ep.join("/")}"
+        end
+      end
+    end
+  end
+end

data/lib/minitest/openapi/minitest_hook.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "minitest"
+
+module Minitest
+  module OpenAPI
+    TestCase = Struct.new(:path)
+
+    module RunPatch
+      def run(*args)
+        return super unless ENV["DOC"]
+        result = super
+
+        if self.class.document?
+          test_file_path = result.source_location.first
+          test_case = TestCase.new(test_file_path)
+          metadata = Minitest::OpenAPI::EndpointMetadata.call(self, test_case) || {}
+
+          self.webhook? ?
+            Minitest::OpenAPI::Webhook.build(metadata, test_case) :
+            Minitest::OpenAPI::Path.build(metadata, test_case)
+        end
+
+        result
+      end
+    end
+  end
+end
+
+module MinitestOpenAPIMethods
+  def self.prepended(base)
+    base.extend(Document)
+
+    base.class_eval do
+      def webhook?
+        @webhook
+      end
+
+      def webhook!
+        @webhook = true
+      end
+    end
+  end
+
+  module Document
+    def document?
+      @document
+    end
+
+    def document!
+      @document = true
+    end
+  end
+end
+
+Minitest::Test.prepend MinitestOpenAPIMethods
+
+if ENV["DOC"]
+  Minitest::Test.prepend Minitest::OpenAPI::RunPatch
+
+  Minitest.after_run do
+    Minitest::OpenAPI::Schema.build
+  end
+end

data/lib/minitest/openapi/parse_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Minitest
+  module OpenAPI
+    module ParseRequest
+      # TODO: Add support for Rack::Test for middleware/etc.
+      def self.call(context)
+        @context = context
+        [ @context.request, @context.response ]
+      end
+    end
+  end
+end

data/lib/minitest/openapi/path.rb

@@ -0,0 +1,38 @@
+module Minitest
+  module OpenAPI
+    module Path
+      TestCase = Struct.new(:path)
+
+      def self.build(metadata, test_case)
+        export_file_path = Minitest::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(test_case) : p }
+        file_path_data = Minitest::OpenAPI.paths[export_file_path]
+
+        if file_path_data[metadata[:endpoint]]
+          if file_path_data[metadata[:endpoint]][metadata[:method]]
+            file_path_data[metadata[:endpoint]][metadata[:method]][:responses].merge!({ metadata[:status] => {} })
+          else
+            file_path_data[metadata[:endpoint]].merge! self.format_endpoint(metadata)
+          end
+        else
+          file_path_data.merge!(metadata[:endpoint] => self.format_endpoint(metadata))
+        end
+      end
+
+      def self.format_endpoint(metadata)
+        {
+          metadata[:method] => {
+            parameters: [],
+            responses: {
+              metadata[:status] => {
+                description: "",
+                headers: {},
+                content: {}
+              },
+              default: {}
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/minitest/openapi/schema.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Minitest
+  module OpenAPI
+    class InvalidFileFormat < StandardError; end
+
+    module Schema
+      ALLOWED_EXTENSIONS = %w[.json .yaml .yml].freeze
+
+      def self.build
+        file_paths = self.parse_files
+
+        Dir.mkdir("docs") unless File.exist?("docs")
+        file_paths.each do |file|
+          raise InvalidFileFormat unless valid_file_ext?(file)
+
+          File.open(file, "w") do |f|
+            f.write(JSON.pretty_generate(json_schema(file), indent: "  "))
+            puts "File generated!"
+          end
+        end
+      end
+
+      # IDK
+      def self.json_schema(file)
+        JSON.parse({
+          openapi: "3.1.0",
+          info: {
+            title: Minitest::OpenAPI.title,
+            version: Minitest::OpenAPI.version
+          },
+          servers: Minitest::OpenAPI.servers,
+          paths: Minitest::OpenAPI.paths[file],
+          webhooks: Minitest::OpenAPI.webhooks[file]
+        }.to_json)
+      end
+
+      def self.parse_files
+        file_paths = []
+        file_paths.concat(
+          Minitest::OpenAPI.paths.keys,
+          Minitest::OpenAPI.webhooks.keys
+        )
+        file_paths.uniq
+      end
+
+      def self.valid_file_ext?(file)
+        ALLOWED_EXTENSIONS.include?(File.extname(file))
+      end
+    end
+  end
+end

data/lib/minitest/openapi/webhook.rb

@@ -0,0 +1,34 @@
+module Minitest
+  module OpenAPI
+    module Webhook
+      TestCase = Struct.new(:path)
+
+      def self.build(metadata, test_case)
+        export_file_path = Minitest::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(test_case) : p }
+        file_path_data = Minitest::OpenAPI.webhooks[export_file_path]
+
+        if file_path_data[metadata[:endpoint]]
+          if file_path_data[metadata[:endpoint]][metadata[:method]]
+            file_path_data[metadata[:endpoint]][metadata[:method]][:responses].merge!({ metadata[:status] => {} })
+          else
+            file_path_data[metadata[:endpoint]].merge! self.format_endpoint(metadata)
+          end
+        else
+          file_path_data.merge!(metadata[:endpoint] => self.format_endpoint(metadata))
+        end
+      end
+
+      def self.format_endpoint(metadata)
+        {
+          metadata[:method] => {
+            parameters: [],
+            responses: {
+              metadata[:status] => {},
+              default: {}
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/minitest/openapi.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "minitest/openapi/minitest_hook"
+require "minitest/openapi/parse_request"
+require "minitest/openapi/endpoint_metadata"
+require "minitest/openapi/path"
+require "minitest/openapi/schema"
+require "minitest/openapi/webhook"
+
+module Minitest
+  module OpenAPI
+    @path = "docs/openapi.json"
+    @paths = Hash.new { |h, k| h[k] = {} }
+    @servers = []
+    @title = ""
+    @version = ""
+    @webhooks = Hash.new { |h, k| h[k] = {} }
+
+    class << self
+      attr_accessor :path,
+                    :paths,
+                    :servers,
+                    :title,
+                    :version,
+                    :webhooks
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: minitest-openapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Austin Wasson
+- Bijan Rahnema
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-01 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies: []
 description: API documentation generator based on the OpenAPI spec.
 email: austinpwasson@gmail.com
@@ -16,8 +17,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/minitest/doc.rb
-- lib/minitest/openapi/hooks.rb
+- lib/minitest/openapi.rb
+- lib/minitest/openapi/endpoint_metadata.rb
+- lib/minitest/openapi/minitest_hook.rb
+- lib/minitest/openapi/parse_request.rb
+- lib/minitest/openapi/path.rb
+- lib/minitest/openapi/schema.rb
+- lib/minitest/openapi/webhook.rb
 homepage:
 licenses:
 - MIT
@@ -37,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: API documentation generator based on the OpenAPI spec.

data/lib/minitest/doc.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest/openapi/hooks'
-
-module Minitest
-  class Config
-    @path = 'docs/openapi.yaml'
-
-    class << self
-      attr_accessor :path
-    end
-  end
-end

data/lib/minitest/openapi/hooks.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest'
-
-module Minitest
-  module OpenAPI
-    module RunPatch
-      def run(*args)
-        result = super
-        if ENV['OPENAPI'] && self.class.openapi?
-          # This will run before specs
-        end
-        result
-      end
-    end
-
-    module ActivateOpenApiClassMethods
-      def self.prepended(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def openapi?
-          @openapi
-        end
-
-        def openapi!
-          @openapi = true
-        end
-      end
-    end
-  end
-end
-
-Minitest::Test.prepend Minitest::OpenAPI::ActivateOpenApiClassMethods
-
-if ENV['OPENAPI']
-  Minitest::Test.prepend Minitest::OpenAPI::RunPatch
-  Minitest.after_run do
-    puts "============================="
-    puts "Building Docs 🎉"
-    puts "============================="
-  end
-end
-