RubyGems - openapi-ruby - Versions diffs - 2.0.0 → 2.2.0 - Mend

openapi-ruby 2.0.0 → 2.2.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 (13) hide show

checksums.yaml +4 -4
data/README.md +8 -2
data/app/controllers/openapi_ruby/ui_controller.rb +31 -6
data/app/views/openapi_ruby/oauth2_redirect.html +83 -0
data/config/routes.rb +2 -1
data/lib/openapi-ruby.rb +3 -0
data/lib/openapi_ruby/components/base.rb +38 -8
data/lib/openapi_ruby/components/key_transformer.rb +14 -5
data/lib/openapi_ruby/components/loader.rb +48 -43
data/lib/openapi_ruby/components/registry.rb +43 -7
data/lib/openapi_ruby/engine.rb +2 -15
data/lib/openapi_ruby/version.rb +1 -1
metadata +7 -5

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4d1e0c7be33a19d1264716a6864c964451717c477a2d8be113c636d7ac12744
-  data.tar.gz: ef006bb3472303c4aeee1faf6291822a22e0c02c9f2bf81fc7f7296462bb5324
+  metadata.gz: d7c1b8cfa3a8ecc15d1e378b9354d359333b5ac8d43f9cdd1de609d60830a839
+  data.tar.gz: c987648c9d766474bb5665d115647513c1ae7d6c3d4c5ea4478ec83d3b7fed22
 SHA512:
-  metadata.gz: 80cf5378dfb48cdec73b9a19a57449b4891eddf7282f1ff3e251d77f4f04c7e876fa87ec89feef8dcf5bb10cea22ecd12f1c5dc30fd68a175ecc04ba44a26e1d
-  data.tar.gz: 0f3bf8c4096823a12426ec2c289be4200ec45b27262e4f4a991b67d08fa17a65d4673dc0fabda1c67cb9e634ceedb4ace95bc5187034b84ea09920efa0711dd7
+  metadata.gz: 01dc4b64bd6d67a48659d1d1ffb8f77dc93609d3ff790664d60ad312c8b38f2ff986ec013ae52cf14dda243f396637c39366c21985086098bb7c3effa0f4a813
+  data.tar.gz: d5df229413a0836644665b8ff29976764c547383ea6443eea20d156d6db8671405f8e84ddec26a25d11b1b3456d84157e44571ebb32ecc58265209e04b20e5b1

data/README.md CHANGED Viewed

@@ -1,6 +1,12 @@
-# openapi_ruby
+<p align="center">
+  <img src="logo.svg" alt="openapi_ruby" width="200">
+</p>
-A unified OpenAPI 3.1 toolkit for Rails that combines test-driven spec generation, reusable schema components as Ruby classes, and runtime request/response validation middleware. Works with both RSpec and Minitest.
+<h1 align="center">openapi_ruby</h1>
+<p align="center">
+  A unified OpenAPI 3.1 toolkit for Rails that combines test-driven spec generation, reusable schema components as Ruby classes, and runtime request/response validation middleware. Works with both RSpec and Minitest.
+</p>
 Replaces [rswag](https://github.com/rswag/rswag), [rswag-schema-components](https://github.com/101skills-gmbh/rswag-schema-components), and [committee](https://github.com/interagent/committee) with a single gem.

data/app/controllers/openapi_ruby/ui_controller.rb CHANGED Viewed

@@ -8,14 +8,19 @@ module OpenapiRuby
       return head :not_found unless OpenapiRuby.configuration.ui_enabled
       config = OpenapiRuby.configuration
-      @schemas = config.schemas.keys.map(&:to_s)
-      @default_schema = @schemas.first
+      @schemas = config.schemas
       @ui_config = config.ui_config
-      @schema_url = openapi_ruby.schema_path(@default_schema, format: schema_format)
       render html: swagger_ui_html.html_safe
     end
+    def oauth2_redirect
+      return head :not_found unless OpenapiRuby.configuration.ui_enabled
+      file = File.join(OpenapiRuby::Engine.root, "app", "views", "openapi_ruby", "oauth2_redirect.html")
+      render file: file, layout: false, content_type: "text/html"
+    end
     private
     def schema_format
@@ -39,16 +44,20 @@ module OpenapiRuby
         <body>
           <div id="swagger-ui"></div>
           <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
+          <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-standalone-preset.js"></script>
           <script>
             SwaggerUIBundle({
-              url: "#{@schema_url}",
+              #{schema_urls_js},
               dom_id: '#swagger-ui',
               deepLinking: true,
               presets: [
                 SwaggerUIBundle.presets.apis,
-                SwaggerUIBundle.SwaggerUIStandalonePreset
+                SwaggerUIStandalonePreset
               ],
-              layout: "BaseLayout",
+              plugins: [
+                SwaggerUIBundle.plugins.DownloadUrl
+              ],
+              layout: "#{(@schemas.size > 1) ? "StandaloneLayout" : "BaseLayout"}",
               #{ui_config_js}
             });
           </script>
@@ -57,6 +66,22 @@ module OpenapiRuby
       HTML
     end
+    def schema_urls_js
+      fmt = schema_format
+      if @schemas.size > 1
+        urls = @schemas.map { |name, schema_config|
+          title = schema_config.dig(:info, :title) || name.to_s
+          url = openapi_ruby.schema_path(name.to_s, format: fmt)
+          {url: url, name: title}
+        }
+        "urls: #{urls.to_json}"
+      else
+        name = @schemas.keys.first.to_s
+        url = openapi_ruby.schema_path(name, format: fmt)
+        "url: \"#{url}\""
+      end
+    end
     def ui_config_js
       @ui_config.except(:title).map { |k, v|
         "#{k}: #{v.to_json}"

data/app/views/openapi_ruby/oauth2_redirect.html ADDED Viewed

@@ -0,0 +1,83 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+        if (/code|token|error/.test(window.location.href)) {
+            if (window.location.search) {
+                qp = parseSearch(window.location.search);
+            } else {
+                qp = parseHash(window.location.hash);
+            }
+            isValid = qp.state === sentState;
+            if ((
+              oauth2.auth.schema.get("flow") === "accessCode"||
+              oauth2.auth.schema.get("flow") === "authorizationCode"||
+              oauth2.auth.schema.get("flow") === "authorization_code"
+            ) && !oauth2.auth.code) {
+                if (!isValid) {
+                    oauth2.errCb({
+                        authId: oauth2.auth.name,
+                        source: "auth",
+                        level: "warning",
+                        message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                    });
+                }
+                if (qp.code) {
+                    delete qp.state;
+                    oauth2.auth.code = qp.code;
+                    oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+                } else {
+                    var oauthErrorMsg;
+                    if (qp.error) {
+                        oauthErrorMsg = "["+qp.error+"]: " + (qp.error_description ? qp.error_description + ". " : "no accessCode received from the server. ") + (qp.error_uri ? "More info: "+qp.error_uri : "");
+                    }
+                    oauth2.errCb({
+                        authId: oauth2.auth.name,
+                        source: "auth",
+                        level: "error",
+                        message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                    });
+                }
+            } else {
+                oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+            }
+        }
+        window.close();
+    }
+    function parseSearch(str) {
+        return parseParams(str.substr(1));
+    }
+    function parseHash(str) {
+        return parseParams(str.substr(1));
+    }
+    function parseParams(str) {
+        return str.split("&").reduce(function (params, param) {
+            var keyValue = param.split("=");
+            params[keyValue[0]] = decodeURIComponent(keyValue[1]);
+            return params;
+        }, {});
+    }
+    window.addEventListener('DOMContentLoaded', function () {
+        run();
+    });
+</script>
+</body>
+</html>

data/config/routes.rb CHANGED Viewed

@@ -2,7 +2,8 @@
 OpenapiRuby::Engine.routes.draw do
   get "schemas", to: "schemas#index", as: :schemas
-  get "schemas/:id", to: "schemas#show", as: :schema
+  get "schemas/*id", to: "schemas#show", as: :schema
   get "ui", to: "ui#index", as: :ui
+  get "oauth2-redirect.html", to: "ui#oauth2_redirect", as: :oauth2_redirect
 end

data/lib/openapi-ruby.rb ADDED Viewed

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require_relative "openapi_ruby"

data/lib/openapi_ruby/components/base.rb CHANGED Viewed

@@ -4,13 +4,20 @@ module OpenapiRuby
   module Components
     module Base
       def self.included(base)
-        base.extend ClassMethods
-        base.class_attribute :_schema_definition, default: {}
-        base.class_attribute :_schema_hidden, default: false
-        base.class_attribute :_skip_key_transformation, default: false
-        base.class_attribute :_component_type, default: :schemas
-        base.class_attribute :_component_scopes, default: []
-        base.class_attribute :_component_scopes_explicitly_set, default: false
+        # Guard against re-including in subclasses that already inherited Base.
+        # Re-running class_attribute with default: would overwrite inherited values.
+        already_included = base.respond_to?(:_schema_definition)
+        base.extend ClassMethods unless already_included
+        unless already_included
+          base.class_attribute :_schema_definition, default: {}
+          base.class_attribute :_schema_hidden, default: false
+          base.class_attribute :_skip_key_transformation, default: false
+          base.class_attribute :_component_type, default: :schemas
+          base.class_attribute :_component_scopes, default: []
+          base.class_attribute :_component_scopes_explicitly_set, default: false
+        end
         Registry.instance.register(base) if base.name
       end
@@ -28,7 +35,10 @@ module OpenapiRuby
         end
         def schema(definition = nil)
-          self._schema_definition = _schema_definition.deep_merge(deep_stringify(definition)) if definition
+          if definition
+            stringified = deep_stringify(definition)
+            self._schema_definition = deep_merge_with_array_concat(_schema_definition, stringified)
+          end
           _schema_definition
         end
@@ -58,6 +68,11 @@ module OpenapiRuby
           self._component_scopes_explicitly_set = true
         end
+        def transform_enum_key(key)
+          key = ActiveSupport::Inflector.underscore(key.to_s)
+          key.parameterize(separator: "_").upcase
+        end
         def component_name
           (name || "Anonymous").demodulize
         end
@@ -115,6 +130,21 @@ module OpenapiRuby
           !_skip_key_transformation && OpenapiRuby.configuration.camelize_keys
         end
+        # Deep merge that concatenates arrays instead of replacing them,
+        # matching the behavior of rswag-schema_components' deeper_merge.
+        # This ensures inherited schema properties (like `required`) are merged correctly.
+        def deep_merge_with_array_concat(base, override)
+          base.merge(override) do |_key, old_val, new_val|
+            if old_val.is_a?(Hash) && new_val.is_a?(Hash)
+              deep_merge_with_array_concat(old_val, new_val)
+            elsif old_val.is_a?(Array) && new_val.is_a?(Array)
+              (old_val + new_val).uniq
+            else
+              new_val
+            end
+          end
+        end
         def deep_stringify(value)
           case value
           when Hash

data/lib/openapi_ruby/components/key_transformer.rb CHANGED Viewed

@@ -9,15 +9,20 @@ module OpenapiRuby
         transform_keys(hash) { |key| camelize(key) }
       end
-      def transform_keys(value, &block)
+      def transform_keys(value, parent_key: nil, &block)
         case value
         when Hash
           value.each_with_object({}) do |(k, v), result|
             new_key = block.call(k.to_s)
-            result[new_key] = transform_keys(v, &block)
+            result[new_key] = transform_keys(v, parent_key: k.to_s, &block)
           end
         when Array
-          value.map { |v| transform_keys(v, &block) }
+          if parent_key == "required"
+            # Values in "required" arrays are property names that must also be transformed
+            value.map { |v| v.is_a?(String) ? block.call(v) : transform_keys(v, &block) }
+          else
+            value.map { |v| transform_keys(v, &block) }
+          end
         else
           value
         end
@@ -27,8 +32,12 @@ module OpenapiRuby
         key = key.to_s
         return key if key.start_with?("$")
-        parts = key.split("_")
-        parts[0] + parts[1..].map(&:capitalize).join
+        # Preserve leading underscore prefix (e.g., _destroy stays _destroy)
+        prefix = key.start_with?("_") ? "_" : ""
+        stripped = key.delete_prefix("_")
+        parts = stripped.split("_")
+        "#{prefix}#{parts[0]}#{parts[1..].map(&:capitalize).join}"
       end
     end
   end

data/lib/openapi_ruby/components/loader.rb CHANGED Viewed

@@ -63,77 +63,82 @@ module OpenapiRuby
           expanded = File.expand_path(path)
           next unless Dir.exist?(expanded)
-          define_nested_modules(expanded, expanded)
-        end
-      end
-      def define_nested_modules(base_path, current_path)
-        Dir.children(current_path).select { |f| File.directory?(File.join(current_path, f)) }.each do |dir|
-          mod_name = dir.camelize.to_sym
-          Object.const_set(mod_name, Module.new) unless Object.const_defined?(mod_name)
-          child_path = File.join(current_path, dir)
-          define_nested_modules(base_path, child_path)
+          Dir.glob(File.join(expanded, "**/")).each do |dir_path|
+            relative = dir_path.sub("#{expanded}/", "").chomp("/")
+            next if relative.empty?
+            const_name = relative.camelize
+            const_name.split("::").inject(Object) do |parent, name|
+              if parent.const_defined?(name, false)
+                parent.const_get(name, false)
+              else
+                parent.const_set(name, Module.new)
+              end
+            end
+          end
         end
       end
       def load_component_files!
         scope_paths = OpenapiRuby.configuration.component_scope_paths
+        # Collect all files with their base paths, then sort globally by relative
+        # path to ensure consistent load order across multiple base paths.
+        # This prevents cross-directory inheritance issues (e.g., a subclass in
+        # packs/ai_feedback loading before its superclass in packs/api).
+        all_files = collect_all_files
         if scope_paths.any?
-          load_with_scope_inference(scope_paths)
+          load_with_scope_inference(all_files, scope_paths)
         else
-          component_files.each { |f| require f }
+          all_files.each { |entry| require entry[:file] }
         end
       end
-      def load_with_scope_inference(scope_paths)
+      def collect_all_files
+        files = []
         @paths.each do |base_path|
           expanded = File.expand_path(base_path)
           next unless Dir.exist?(expanded)
-          files = Dir[File.join(expanded, "**", "*.rb")].sort
-          files.each do |file|
+          Dir[File.join(expanded, "**", "*.rb")].each do |file|
             relative = file.sub("#{expanded}/", "")
-            inferred_scope = infer_scope(relative, scope_paths)
-            registered_before = Registry.instance.all_registered_classes.dup
-            require file
-            registered_after = Registry.instance.all_registered_classes
-            new_classes = registered_after - registered_before
-            new_classes.each do |klass|
-              next if klass._component_scopes_explicitly_set
-              if inferred_scope == :shared
-                # Shared components have empty scopes (included in all specs)
-                klass._component_scopes = []
-              elsif inferred_scope
-                Registry.instance.unregister(klass)
-                klass._component_scopes = [inferred_scope]
-                Registry.instance.register(klass)
-              end
+            files << {file: file, base_path: expanded, relative: relative}
+          end
+        end
+        files.sort_by { |entry| entry[:relative] }
+      end
+      def load_with_scope_inference(all_files, scope_paths)
+        all_files.each do |entry|
+          inferred_scope = infer_scope(entry[:relative], scope_paths)
+          registered_before = Registry.instance.all_registered_classes.dup
+          require entry[:file]
+          registered_after = Registry.instance.all_registered_classes
+          new_classes = registered_after - registered_before
+          new_classes.each do |klass|
+            next if klass._component_scopes_explicitly_set
+            if inferred_scope == :shared
+              klass._component_scopes = []
+            elsif inferred_scope
+              Registry.instance.unregister(klass)
+              klass._component_scopes = [inferred_scope]
+              Registry.instance.register(klass)
             end
           end
         end
       end
       def infer_scope(relative_path, scope_paths)
-        # Match longest prefix first for specificity
         scope_paths.sort_by { |prefix, _| -prefix.length }.each do |prefix, scope|
           return scope&.to_sym if relative_path.start_with?("#{prefix}/")
         end
         nil
       end
-      def component_files
-        @paths.flat_map do |path|
-          expanded = File.expand_path(path)
-          Dir[File.join(expanded, "**", "*.rb")]
-        end
-      end
       def filter_type(type)
         to_openapi_hash[type.to_s] || {}
       end

data/lib/openapi_ruby/components/registry.rb CHANGED Viewed

@@ -13,21 +13,22 @@ module OpenapiRuby
       def register(component_class)
         type = component_class._component_type
-        key = component_class.registry_key
+        name = component_class.name || "Anonymous"
         @components[type] ||= {}
-        if @components[type].key?(key) && @components[type][key] != component_class
-          raise DuplicateComponentError, "Component '#{component_class.component_name}' already registered under #{type}"
-        end
+        check_for_duplicate!(component_class, type)
-        @components[type][key] = component_class
+        # Use the full class name as key to avoid collisions between
+        # same-named components in different scopes (e.g., Internal::V1::Schemas::PaginatedCollection
+        # vs Mobile::V1::Schemas::PaginatedCollection). Scope filtering happens in to_openapi_hash.
+        @components[type][name] = component_class
       end
       def unregister(component_class)
         type = component_class._component_type
-        key = component_class.registry_key
-        @components[type]&.delete(key)
+        name = component_class.name || "Anonymous"
+        @components[type]&.delete(name)
       end
       def components_for(type)
@@ -50,6 +51,41 @@ module OpenapiRuby
         @components = {}
       end
+      private
+      def check_for_duplicate!(component_class, type)
+        short_name = component_class.component_name
+        new_scopes = component_class._component_scopes
+        new_scopes_set = component_class._component_scopes_explicitly_set
+        @components[type]&.each_value do |existing|
+          next if existing.name == component_class.name
+          next unless existing.component_name == short_name
+          existing_scopes = existing._component_scopes
+          existing_scopes_set = existing._component_scopes_explicitly_set
+          # Skip when exactly one side has explicitly configured scopes — the other
+          # is still at its default (freshly included) and may get scopes set later via
+          # component_scopes, which unregisters/re-registers and retriggers this check.
+          next if new_scopes_set != existing_scopes_set
+          if scopes_overlap?(new_scopes, existing_scopes)
+            raise DuplicateComponentError,
+              "Component '#{short_name}' is already registered as #{type} " \
+              "(existing: #{existing.name}, new: #{component_class.name})"
+          end
+        end
+      end
+      def scopes_overlap?(a, b)
+        return true if a.empty? && b.empty?
+        return true if a.empty? || b.empty?
+        (a & b).any?
+      end
+      public
       def to_openapi_hash(scope: nil)
         result = {}
         @components.each do |type, components|

data/lib/openapi_ruby/engine.rb CHANGED Viewed

@@ -36,21 +36,8 @@ module OpenapiRuby
       end
     end
-    initializer "openapi_ruby.components" do
-      config = OpenapiRuby.configuration
-      config.component_paths.each do |path|
-        expanded = Rails.root.join(path)
-        next unless expanded.exist?
-        # Auto-define modules for subdirectories (Schemas, Parameters, etc.)
-        expanded.children.select(&:directory?).each do |dir|
-          mod_name = dir.basename.to_s.camelize.to_sym
-          Object.const_set(mod_name, Module.new) unless Object.const_defined?(mod_name)
-        end
-        Dir[expanded.join("**", "*.rb")].sort.each { |f| require f }
-      end
-    end
+    # Components are loaded on demand via Components::Loader (e.g. in test helpers),
+    # not at boot time — avoids cross-file dependency ordering issues.
     private

data/lib/openapi_ruby/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module OpenapiRuby
-  VERSION = "2.0.0"
+  VERSION = "2.2.0"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Morten Hartvig
@@ -79,12 +79,14 @@ files:
 - Rakefile
 - app/controllers/openapi_ruby/schemas_controller.rb
 - app/controllers/openapi_ruby/ui_controller.rb
+- app/views/openapi_ruby/oauth2_redirect.html
 - config/routes.rb
 - lib/generators/openapi_ruby/component/component_generator.rb
 - lib/generators/openapi_ruby/component/templates/component.rb.tt
 - lib/generators/openapi_ruby/install/install_generator.rb
 - lib/generators/openapi_ruby/install/templates/initializer.rb.tt
 - lib/generators/openapi_ruby/install/templates/openapi_helper.rb.tt
+- lib/openapi-ruby.rb
 - lib/openapi_ruby.rb
 - lib/openapi_ruby/adapters/minitest.rb
 - lib/openapi_ruby/adapters/rspec.rb
@@ -118,13 +120,13 @@ files:
 - lib/openapi_ruby/testing/response_validator.rb
 - lib/openapi_ruby/version.rb
 - lib/tasks/openapi_ruby.rake
-homepage: https://github.com/mortik/openapi-ruby
+homepage: https://github.com/openapi-ruby/openapi-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/mortik/openapi-ruby
-  source_code_uri: https://github.com/mortik/openapi-ruby
-  changelog_uri: https://github.com/mortik/openapi-ruby/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/openapi-ruby/openapi-ruby
+  source_code_uri: https://github.com/openapi-ruby/openapi-ruby
+  changelog_uri: https://github.com/openapi-ruby/openapi-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: