rest_framework 0.11.0 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34653421f170160fbdd29c3119c728ba5fe7591fd969f9d50d2e20d18cecf8bb
-  data.tar.gz: ed35098916c941a897087d9b455f69e86f5f53b1e81442e22aa135c81877c45c
+  metadata.gz: acc3d4ff5a9d7669942f21eb7f3ecec06417c83322be936e1b862b1346e9bb14
+  data.tar.gz: 53ddfa6b5a46338b174ec67742d6019d5d005231eb492b0af30ed7232a2d22ce
 SHA512:
-  metadata.gz: b02af4cc8f15d804a8ece266a3678a5a0ae328cf505aa64478f4239392a2ccc1ddbcbdde333fc8d80c9ba8fbb59d2a057c8fed6150fe0758f068c7c3dca3670c
-  data.tar.gz: 33d87fa722fa5d0a23ccfd81ea6d5705cc37b49bb9b88ab62f504c76255429c77d0c75b2d83a8f86c3752c6fc7c9a60f3fa9078daebfca5461929d052f43d45f
+  metadata.gz: a93ccb739766ae11c9b0be6b52e60c698c72793cd109c1efbaf89eaac3f10b56a7bf11fd9e90b77ccc7c148aaa8436e51f73530f3ed3442f58ee93934fa37494
+  data.tar.gz: 616ebaac8b55a68a38fc8d29f6cedf764403990bc057bf9f6d8c92e672764a4f23189a3acca1e803b1d34df70731d28729744380cc90e9b7ec49f133c258d0de

data/VERSION

@@ -1 +1 @@
-0.11.0
+1.0.0.beta2

data/lib/rest_framework/mixins/base_controller_mixin.rb

@@ -12,6 +12,7 @@ module RESTFramework::Mixins::BaseControllerMixin
     description: nil,
     version: nil,
     inflect_acronyms: ["ID", "IDs", "REST", "API", "APIs"].freeze,
+    openapi_include_children: false,
 
     # Options related to serialization.
     rescue_unknown_format_with: :json,
@@ -69,6 +70,82 @@ module RESTFramework::Mixins::BaseControllerMixin
       end
     end
     # :nocov:
+
+    def openapi_paths(routes, tag)
+      response_content_types = [
+        "text/html",
+        self.serialize_to_json ? "application/json" : nil,
+        self.serialize_to_xml ? "application/xml" : nil,
+      ].compact
+      request_content_types = [
+        "application/json",
+        "application/xml",
+        "application/x-www-form-urlencoded",
+        "multipart/form-data",
+      ]
+
+      return routes.group_by { |r| r[:concat_path] }.map { |concat_path, routes|
+        [
+          concat_path.gsub(/:([0-9A-Za-z_-]+)/, "{\\1}"),
+          routes.map { |route|
+            metadata = route[:route].defaults[:metadata] || {}
+            summary = metadata[:label].presence || self.label_for(route[:action])
+            description = metadata[:description].presence
+            remaining_metadata = metadata.except(:label, :description).presence
+
+            [
+              route[:verb].downcase,
+              {
+                tags: [tag],
+                summary: summary,
+                description: description,
+                responses: {
+                  200 => {
+                    content: response_content_types.map { |ct|
+                      [ct, {}]
+                    }.to_h,
+                    description: "",
+                  },
+                },
+                requestBody: route[:verb].in?(["GET", "DELETE", "OPTIONS", "TRACE"]) ? nil : {
+                  content: request_content_types.map { |ct|
+                    [ct, {}]
+                  }.to_h,
+                },
+                "x-rrf-metadata": remaining_metadata,
+              }.compact,
+            ]
+          }.to_h.merge(
+            {
+              parameters: routes.first[:route].required_parts.map { |p|
+                {
+                  name: p,
+                  in: "path",
+                  required: true,
+                  schema: {type: "integer"},
+                }
+              },
+            },
+          ),
+        ]
+      }.to_h
+    end
+
+    def openapi_document(request, route_group_name, routes)
+      server = request.base_url + request.original_fullpath.gsub(/\?.*/, "")
+
+      return {
+        openapi: "3.1.1",
+        info: {
+          title: self.get_title,
+          description: self.description,
+          version: self.version.to_s,
+        }.compact,
+        servers: [{url: server}],
+        paths: self.openapi_paths(routes, route_group_name),
+        tags: [{name: route_group_name, description: self.description}.compact],
+      }.compact
+    end
   end
 
   def self.included(base)
@@ -239,81 +316,36 @@ module RESTFramework::Mixins::BaseControllerMixin
     end
   end
 
-  # TODO: Might make this the default render method in the future.
+  # Compatibility alias for deprecated `api_response`.
   alias_method :api_response, :render_api
 
-  def openapi_metadata
-    response_content_types = [
-      "text/html",
-      self.class.serialize_to_json ? "application/json" : nil,
-      self.class.serialize_to_xml ? "application/xml" : nil,
-    ].compact
-    request_content_types = [
-      "application/json",
-      "application/xml",
-      "application/x-www-form-urlencoded",
-      "multipart/form-data",
-    ].compact
-    routes = self.route_groups.values[0]
-    server = request.base_url + request.original_fullpath.gsub(/\?.*/, "")
-
-    return {
-      openapi: "3.1.1",
-      info: {
-        title: self.class.get_title,
-        description: self.class.description,
-        version: self.class.version.to_s,
-      }.compact,
-      servers: [{url: server}],
-      paths: routes.group_by { |r| r[:concat_path] }.map { |concat_path, routes|
-        [
-          concat_path.gsub(/:([0-9A-Za-z_-]+)/, "{\\1}"),
-          routes.map { |route|
-            metadata = route[:route].defaults[:metadata] || {}
-            summary = metadata[:label].presence || self.class.label_for(route[:action])
-            description = metadata[:description].presence
-            remaining_metadata = metadata.except(:label, :description).presence
+  def openapi_document
+    first, *rest = self.route_groups.to_a
+    document = self.class.openapi_document(request, *first)
 
-            [
-              route[:verb].downcase,
-              {
-                summary: summary,
-                description: description,
-                responses: {
-                  200 => {
-                    content: response_content_types.map { |ct|
-                      [ct, {}]
-                    }.to_h,
-                    description: "",
-                  },
-                },
-                requestBody: route[:verb].in?(["GET", "DELETE", "OPTIONS", "TRACE"]) ? nil : {
-                  content: request_content_types.map { |ct|
-                    [ct, {}]
-                  }.to_h,
-                },
-                "x-rrf-metadata": remaining_metadata,
-              }.compact,
-            ]
-          }.to_h.merge(
-            {
-              parameters: routes.first[:route].required_parts.map { |p|
-                {
-                  name: p,
-                  in: "path",
-                  required: true,
-                  schema: {type: "integer"},
-                }
-              },
-            },
-          ),
-        ]
-      }.to_h,
-    }.compact
+    if self.class.openapi_include_children
+      rest.each do |route_group_name, routes|
+        controller = "#{routes.first[:route].defaults[:controller]}_controller".camelize.constantize
+        child_document = controller.openapi_document(request, route_group_name, routes)
+
+        # Merge child paths and tags into the parent document.
+        document[:paths].merge!(child_document[:paths])
+        document[:tags] += child_document[:tags]
+
+        # If the child document has schemas, merge them into the parent document.
+        if schemas = child_document.dig(:components, :schemas)  # rubocop:disable Style/Next
+          document[:components] ||= {}
+          document[:components][:schemas] ||= {}
+          document[:components][:schemas].merge!(schemas)
+        end
+      end
+    end
+
+    return document
   end
 
   def options
-    render_api(self.openapi_metadata)
+    render_api(self.openapi_document)
   end
 end
 

data/lib/rest_framework/mixins/bulk_model_controller_mixin.rb

@@ -6,7 +6,7 @@ module RESTFramework::Mixins::BulkCreateModelMixin
   # While bulk update/destroy are obvious because they create new router endpoints, bulk create
   # overloads the existing collection `POST` endpoint, so we add a special key to the OpenAPI
   # metadata to indicate bulk create is supported.
-  def openapi_metadata
+  def openapi_document
     return super.merge({"x-rrf-bulk-create": true})
   end
 

data/lib/rest_framework/mixins/model_controller_mixin.rb

@@ -339,6 +339,39 @@ module RESTFramework::Mixins::BaseModelControllerMixin
       return @openapi_schema
     end
 
+    def openapi_document(request, route_group_name, routes)
+      document = super
+      schema_name = routes[0][:controller].camelize.gsub("::", ".")
+
+      # Insert schema into the document.
+      document[:components] ||= {}
+      document[:components][:schemas] ||= {}
+      document[:components][:schemas][schema_name] = self.openapi_schema
+
+      # Reference schema for specific actions with a `requestBody`.
+      document[:paths].each do |_path, actions|
+        actions.each do |_method, action|
+          next unless action.is_a?(Hash)
+
+          injectables = [action.dig(:requestBody, :content), *action[:responses].values.map { |r|
+            r[:content]
+          }].compact
+          injectables.each do |i|
+            i.each do |_, v|
+              v[:schema] = {"$ref" => "#/components/schemas/#{schema_name}"}
+            end
+          end
+        end
+      end
+
+      return document.merge(
+        {
+          "x-rrf-primary_key" => self.get_model.primary_key,
+          "x-rrf-callbacks" => self._process_action_callbacks.as_json,
+        },
+      )
+    end
+
     def setup_delegation
       # Delegate extra actions.
       self.extra_actions&.each do |action, config|
@@ -349,9 +382,9 @@ module RESTFramework::Mixins::BaseModelControllerMixin
           model = self.class.get_model
 
           if model.method(action).parameters.last&.first == :keyrest
-            return render_api(model.send(action, **params))
+            render_api(model.send(action, **params))
           else
-            return render_api(model.send(action))
+            render_api(model.send(action))
           end
         end
       end
@@ -365,9 +398,9 @@ module RESTFramework::Mixins::BaseModelControllerMixin
           record = self.get_record
 
           if record.method(action).parameters.last&.first == :keyrest
-            return render_api(record.send(action, **params))
+            render_api(record.send(action, **params))
           else
-            return render_api(record.send(action))
+            render_api(record.send(action))
           end
         end
       end
@@ -409,40 +442,6 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     return self.class.get_fields(input_fields: self.class.fields)
   end
 
-  def openapi_metadata
-    data = super
-    routes = self.route_groups.values[0]
-    schema_name = routes[0][:controller].camelize.gsub("::", ".")
-
-    # Insert schema into metadata.
-    data[:components] ||= {}
-    data[:components][:schemas] ||= {}
-    data[:components][:schemas][schema_name] = self.class.openapi_schema
-
-    # Reference schema for specific actions with a `requestBody`.
-    data[:paths].each do |_path, actions|
-      actions.each do |_method, action|
-        next unless action.is_a?(Hash)
-
-        injectables = [action.dig(:requestBody, :content), *action[:responses].values.map { |r|
-          r[:content]
-        }].compact
-        injectables.each do |i|
-          i.each do |_, v|
-            v[:schema] = {"$ref" => "#/components/schemas/#{schema_name}"}
-          end
-        end
-      end
-    end
-
-    return data.merge(
-      {
-        "x-rrf-primary_key" => self.class.get_model.primary_key,
-        "x-rrf-callbacks" => self._process_action_callbacks.as_json,
-      },
-    )
-  end
-
   # Get a hash of strong parameters for the current action.
   def get_allowed_parameters
     return @_get_allowed_parameters if defined?(@_get_allowed_parameters)
@@ -691,7 +690,7 @@ end
 # Mixin for listing records.
 module RESTFramework::Mixins::ListModelMixin
   def index
-    return render_api(self.get_index_records)
+    render_api(self.get_index_records)
   end
 
   # Get records with both filtering and pagination applied.
@@ -719,14 +718,14 @@ end
 # Mixin for showing records.
 module RESTFramework::Mixins::ShowModelMixin
   def show
-    return render_api(self.get_record)
+    render_api(self.get_record)
   end
 end
 
 # Mixin for creating records.
 module RESTFramework::Mixins::CreateModelMixin
   def create
-    return render_api(self.create!, status: :created)
+    render_api(self.create!, status: :created)
   end
 
   # Perform the `create!` call and return the created record.
@@ -738,7 +737,7 @@ end
 # Mixin for updating records.
 module RESTFramework::Mixins::UpdateModelMixin
   def update
-    return render_api(self.update!)
+    render_api(self.update!)
   end
 
   # Perform the `update!` call and return the updated record.
@@ -753,7 +752,7 @@ end
 module RESTFramework::Mixins::DestroyModelMixin
   def destroy
     self.destroy!
-    return render_api("")
+    render_api("")
   end
 
   # Perform the `destroy!` call and return the destroyed (and frozen) record.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -99,9 +99,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: