rest_framework 0.8.17 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b8d9a14de396b6832c13e0f3e1f2627decb432af03c6a2cbb59ce27328cdd7c
-  data.tar.gz: 6d1e675245643d96e2b35aaaadd9118eb441025a1bb7acc303db63d6761dc79c
+  metadata.gz: '036384f3209aba594f8af47997294c73c4ca95294601d1abf46ee31086610296'
+  data.tar.gz: 52424a145b6c959eed3818c23a3e21cd952cb8cb9dc0520506803c08ba5b63b3
 SHA512:
-  metadata.gz: a0ef4d98bec92656d0541f34aebd652d30b90af0bdde8ea91e0b1809b82ee381bdbfef0ea04235b2c24005ec43646ad59b7fce01d3eda1312e48e1a976bd8092
-  data.tar.gz: d64fdd4c884a6173c9df9f87074748290b1093917a053acfa70b5b6579bbe07f7479adf15b226178fb784181edfe28ac3cbce461c13b64372e988d5abbab5966
+  metadata.gz: 28d9e2ec67ae6ac76f9709a78f7818f96336b87956e447095e48af59386c4cf5375d2fbc9ff243bc5bb915d982a868849a32bda8f3b5406c6fd853e6d2245a58
+  data.tar.gz: f8618a040b3ea3cdf44017a2b7dbedd465546f6b073750925635124b97a11e15486883d0902a8259ac8f4d94f4c0a582f6687f1f8148f7332c76342a67c9ff11

data/VERSION

@@ -1 +1 @@
-0.8.17
+0.9.1

data/app/views/layouts/rest_framework.html.erb

@@ -64,7 +64,7 @@
         <div>
           <h1 class="m-0"><%= (@header_text if defined? @header_text) || @title %></h1>
           <div style="float: right">
-            <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "DELETE" } %>
+            <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "DELETE" && r[:action] == "destroy" } %>
               <button type="button" class="btn btn-danger" onclick="rrfDelete(this)">DELETE</button>
             <% end %>
             <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "OPTIONS" } %>
@@ -150,22 +150,28 @@
                   Routes
                 </a>
               </li>
-              <% @_rrf_form_routes = @route_groups.values[0].select { |r|
+              <% @_rrf_form_routes_raw = @route_groups.values[0].select { |r|
+                r[:matches_params] && (
+                  r[:verb].in?(["POST", "PUT", "PATCH"]) ||
+                  (r[:verb] == "DELETE" && r[:action] == "destroy_all")
+                )
+              } %>
+              <% @_rrf_form_routes_html = @route_groups.values[0].select { |r|
                 r[:matches_params] && r[:verb].in?(["POST", "PUT", "PATCH"])
               } %>
-              <% unless @_rrf_form_routes.empty? %>
+              <% if @_rrf_form_routes_raw.present? %>
                 <li class="nav-item">
-                  <a class="nav-link" href="#tab-raw-form" data-bs-toggle="tab" role="tab">
+                  <a class="nav-link" href="#tabRawForm" data-bs-toggle="tab" role="tab">
                     Raw Form
                   </a>
                 </li>
-                <% if @is_model_controller %>
-                  <li class="nav-item">
-                    <a class="nav-link" href="#tab-html-form" data-bs-toggle="tab" role="tab">
-                      HTML Form
-                    </a>
-                  </li>
-                <% end %>
+              <% end %>
+              <% if @_rrf_form_routes_html.present? && @is_model_controller %>
+                <li class="nav-item">
+                  <a class="nav-link" href="#tabHtmlForm" data-bs-toggle="tab" role="tab">
+                    HTML Form
+                  </a>
+                </li>
               <% end %>
             </ul>
           </div>
@@ -173,15 +179,15 @@
             <div class="tab-pane fade show active" id="tab-routes" role="tabpanel">
               <%= render partial: "rest_framework/routes" %>
             </div>
-            <% unless @_rrf_form_routes.empty? %>
-              <div class="tab-pane fade" id="tab-raw-form" role="tabpanel">
+            <% if @_rrf_form_routes_raw.present? %>
+              <div class="tab-pane fade" id="tabRawForm" role="tabpanel">
                 <%= render partial: "rest_framework/raw_form" %>
               </div>
-              <% if @is_model_controller %>
-                <div class="tab-pane fade" id="tab-html-form" role="tabpanel">
-                  <%= render partial: "rest_framework/html_form" %>
-                </div>
-              <% end %>
+            <% end %>
+            <% if @_rrf_form_routes_html.present? && @is_model_controller %>
+              <div class="tab-pane fade" id="tabHtmlForm" role="tabpanel">
+                <%= render partial: "rest_framework/html_form" %>
+              </div>
             <% end %>
           </div>
         </div>

data/app/views/rest_framework/_head.html.erb

@@ -135,11 +135,15 @@ html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
 }
 .rrf-copy .rrf-copy-link {
   position: absolute;
-  top: .5em;
-  right: .5em;
+  top: .25em;
+  right: .4em;
   transition: 0.3s ease;
+  font-size: 1.5em;
 }
-.rrf-copy .rrf-copy-link.rrf-clicked{
+.rrf-copy .rrf-copy-link.rrf-clicked {
+  color: green;
+}
+.rrf-copy .rrf-copy-link.rrf-clicked:hover {
   color: green;
 }
 </style>
@@ -167,8 +171,6 @@ html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
 
   // Set the mode, given a "selected" mode.
   const rrfSetSelectedMode = (selectedMode) => {
-    const modeComponent = document.getElementById("rrfModeComponent")
-
     // Anything except "light" or "dark" is casted to "system".
     if (selectedMode !== "light" && selectedMode !== "dark") {
       selectedMode = "system"
@@ -178,16 +180,19 @@ html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
     localStorage.setItem("rrfMode", selectedMode)
 
     // Set the mode selector to the selected mode.
-    let labelHTML
-    modeComponent.querySelectorAll("button[data-rrf-mode-value]").forEach((el) => {
-      if (el.getAttribute("data-rrf-mode-value") === selectedMode) {
-        el.classList.add("active")
-        labelHTML = el.querySelector("i").outerHTML.replace("ms-2", "me-1")
-      } else {
-        el.classList.remove("active")
-      }
-    })
-    modeComponent.querySelector("button[data-bs-toggle]").innerHTML = labelHTML
+    const modeComponent = document.getElementById("rrfModeComponent")
+    if (modeComponent) {
+      let labelHTML
+      modeComponent.querySelectorAll("button[data-rrf-mode-value]").forEach((el) => {
+        if (el.getAttribute("data-rrf-mode-value") === selectedMode) {
+          el.classList.add("active")
+          labelHTML = el.querySelector("i").outerHTML.replace("ms-2", "me-1")
+        } else {
+          el.classList.remove("active")
+        }
+      })
+      modeComponent.querySelector("button[data-bs-toggle]").innerHTML = labelHTML
+    }
 
     // Get the real mode to use.
     realMode = rrfGetRealMode(selectedMode)
@@ -218,10 +223,14 @@ html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
     }
   }
 
-  // Initialize dark/light mode.
+  // Initialize dark/light mode before page fully loads to prevent flash.
+  rrfSetSelectedMode(localStorage.getItem("rrfMode"))
+
+  // Initialize dark/light mode after page load (mostly so mode component is updated).
   document.addEventListener("DOMContentLoaded", (event) => {
-    const selectedMode = localStorage.getItem("rrfMode")
-    rrfSetSelectedMode(selectedMode)
+    rrfSetSelectedMode(localStorage.getItem("rrfMode"))
+
+    // Also set up mode selector.
     document.querySelectorAll("#rrfModeComponent button[data-rrf-mode-value]").forEach((el) => {
       el.addEventListener("click", (event) => {
         rrfSetSelectedMode(event.target.getAttribute("data-rrf-mode-value"))
@@ -246,7 +255,7 @@ html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
 
 document.addEventListener("DOMContentLoaded", (event) => {
   // Pretty-print JSON.
-  document.querySelectorAll(".language-json").forEach((el, index) => {
+  document.querySelectorAll(".language-json").forEach((el) => {
     el.innerHTML = neatJSON(JSON.parse(el.innerText), {
       wrap: 80,
       afterComma: 1,
@@ -263,17 +272,55 @@ document.addEventListener("DOMContentLoaded", (event) => {
   hljs.highlightAll()
 
   // Replace text node links with anchor tag links.
-  document.querySelectorAll(".rrf-copy code").forEach((el, index) => {
+  document.querySelectorAll(".rrf-copy code").forEach((el) => {
     el.innerHTML = rrfLinkify(el.innerHTML)
   })
 
-  // Insert copy link and callback to copy contents of `<code>` element.
-  document.querySelectorAll("rrf-copy").forEach((el, index) => {
+  // Insert copy links.
+  document.querySelectorAll(".rrf-copy").forEach((el) => {
     el.insertAdjacentHTML(
       "afterbegin",
-      "<a class=\"rrf-copy-link\" onclick=\"return rrfCopyToClipboard(this)\" href=\"#\">Copy to Clipboard</a>",
+      '<a class="rrf-copy-link" title="Copy to Clipboard" href="#"><i class="bi bi-clipboard-fill"></i></a>',
     )
   })
+
+  // Copy link implementation.
+  document.querySelectorAll(".rrf-copy-link").forEach((el) => {
+    el.addEventListener("click", (event) => {
+      const range = document.createRange()
+      range.selectNode(el.nextSibling)
+      window.getSelection().removeAllRanges()
+      window.getSelection().addRange(range)
+      if (document.execCommand("copy")) {
+        // Trigger clicked animation.
+        el.classList.add("rrf-clicked")
+        el.innerHTML = '<i class="bi bi-clipboard-check-fill">'
+        setTimeout(() => {
+          el.classList.remove("rrf-clicked")
+          el.innerHTML = '<i class="bi bi-clipboard-fill">'
+        }, 1000)
+      }
+      event.preventDefault()
+    })
+  })
+
+  // Check if `rawFilesFormWrapper` should be displayed when media type is changed.
+  const rawFormRouteSelect = document.getElementById("rawFormRoute")
+  const rawFormMediaTypeSelect = document.getElementById("rawFormMediaType")
+  const rawFilesFormWrapper = document.getElementById("rawFilesFormWrapper")
+  if (rawFilesFormWrapper) {
+    const rawFormFilesHandler = () => {
+      const selectedRouteOption = rawFormRouteSelect.options[rawFormRouteSelect.selectedIndex]
+      if (rawFormMediaTypeSelect.value === "multipart/form-data" && selectedRouteOption.dataset.supportsFiles) {
+        rawFilesFormWrapper.style.display = "block"
+      } else {
+        rawFilesFormWrapper.style.display = "none"
+      }
+    }
+
+    rawFormRouteSelect.addEventListener("change", rawFormFilesHandler)
+    rawFormMediaTypeSelect.addEventListener("change", rawFormFilesHandler)
+  }
 })
 
 // Convert plain-text links to anchor tag links.
@@ -292,26 +339,6 @@ function rrfReplaceDocument(content) {
   document.dispatchEvent(new Event("DOMContentLoaded", {bubbles: true, cancelable: true}))
 }
 
-// Copy the element's next `<code>` sibling's content to the clipboard.
-function rrfCopyToClipboard(element) {
-  let range = document.createRange()
-  range.selectNode(element.nextSibling)
-  window.getSelection().removeAllRanges()
-  window.getSelection().addRange(range)
-  if (document.execCommand("copy")) {
-    // Trigger clicked animation.
-    element.classList.add("rrf-clicked")
-    element.innerText = "Copied!"
-    setTimeout(() => {
-      element.classList.remove("rrf-clicked")
-      element.innerText = "Copy to Clipboard"
-    }, 700)
-  }
-
-  // Return false to prevent normal link behavior.
-  return false
-}
-
 // Refresh the window as a `GET` request.
 function rrfGet(button) {
   button.disabled = true
@@ -352,7 +379,7 @@ function rrfSubmitRawForm(button) {
     // Add file(s) to `formData`.
     const rawFilesForm = document.getElementById("rawFilesForm")
     if (rawFilesForm) {
-      rawFilesForm.querySelectorAll("input[type=file]").forEach((el, index) => {
+      rawFilesForm.querySelectorAll("input[type=file]").forEach((el) => {
         const files = el.files
         for (let i = 0; i < files.length; i++) {
           formData.append(el.name, files[i])
@@ -382,17 +409,4 @@ function rrfAPICall(path, method, kwargs={}) {
     .then((response) => response.text())
     .then((body) => { rrfReplaceDocument(body) })
 }
-
-// Check if `rawFilesFormWrapper` should be displayed when media type is changed.
-function rrfCheckRawFilesFormDisplay(el) {
-  const rawFilesFormWrapper = document.getElementById("rawFilesFormWrapper")
-
-  if (rawFilesFormWrapper) {
-    if (el.value === "multipart/form-data") {
-      rawFilesFormWrapper.style.display = "block"
-    } else {
-      rawFilesFormWrapper.style.display = "none"
-    }
-  }
-}
 </script>

data/app/views/rest_framework/_html_form.html.erb

@@ -2,7 +2,7 @@
   <div class="mb-2">
     <label class="form-label w-100">Route
       <select class="form-control form-control-sm" id="htmlFormRoute">
-        <% @_rrf_form_routes.each do |route| %>
+        <% @_rrf_form_routes_html.each do |route| %>
           <% path = @route_props[:with_path_args].call(route[:route]) %>
           <option value="<%= route[:verb] %>:<%= path %>"><%= route[:verb] %> <%= route[:relative_path] %></option>
         <% end %>

data/app/views/rest_framework/_raw_form.html.erb

@@ -2,9 +2,12 @@
   <div class="mb-2">
     <label class="form-label w-100">Route
       <select class="form-control form-control-sm" id="rawFormRoute">
-        <% @_rrf_form_routes.each do |route| %>
+        <% @_rrf_form_routes_raw.each do |route| %>
           <% path = @route_props[:with_path_args].call(route[:route]) %>
-          <option value="<%= route[:verb] %>:<%= path %>"><%= route[:verb] %> <%= route[:relative_path] %></option>
+          <option
+            value="<%= route[:verb] %>:<%= path %>"
+            data-supports-files="<%= !route[:action].in?(["update_all", "destroy", "destroy_all"]) ? "true" : "" %>"
+          ><%= route[:verb] %> <%= route[:relative_path] %></option>
         <% end %>
       </select>
     </label>
@@ -12,7 +15,7 @@
 
   <div class="mb-2">
     <label class="form-label w-100">Media Type
-      <select class="form-control form-control-sm" id="rawFormMediaType" onchange="rrfCheckRawFilesFormDisplay(this)">
+      <select class="form-control form-control-sm" id="rawFormMediaType">
         <% ["application/json", "application/x-www-form-urlencoded", "multipart/form-data"].each do |t| %>
           <option value="<%= t %>"><%= t %></option>
         <% end %>

data/docs/assets/js/rest_framework.js

@@ -19,8 +19,6 @@
 
   // Set the mode, given a "selected" mode.
   const rrfSetSelectedMode = (selectedMode) => {
-    const modeComponent = document.getElementById("rrfModeComponent")
-
     // Anything except "light" or "dark" is casted to "system".
     if (selectedMode !== "light" && selectedMode !== "dark") {
       selectedMode = "system"
@@ -30,16 +28,19 @@
     localStorage.setItem("rrfMode", selectedMode)
 
     // Set the mode selector to the selected mode.
-    let labelHTML
-    modeComponent.querySelectorAll("button[data-rrf-mode-value]").forEach((el) => {
-      if (el.getAttribute("data-rrf-mode-value") === selectedMode) {
-        el.classList.add("active")
-        labelHTML = el.querySelector("i").outerHTML.replace("ms-2", "me-1")
-      } else {
-        el.classList.remove("active")
-      }
-    })
-    modeComponent.querySelector("button[data-bs-toggle]").innerHTML = labelHTML
+    const modeComponent = document.getElementById("rrfModeComponent")
+    if (modeComponent) {
+      let labelHTML
+      modeComponent.querySelectorAll("button[data-rrf-mode-value]").forEach((el) => {
+        if (el.getAttribute("data-rrf-mode-value") === selectedMode) {
+          el.classList.add("active")
+          labelHTML = el.querySelector("i").outerHTML.replace("ms-2", "me-1")
+        } else {
+          el.classList.remove("active")
+        }
+      })
+      modeComponent.querySelector("button[data-bs-toggle]").innerHTML = labelHTML
+    }
 
     // Get the real mode to use.
     realMode = rrfGetRealMode(selectedMode)
@@ -70,10 +71,14 @@
     }
   }
 
-  // Initialize dark/light mode.
+  // Initialize dark/light mode before page fully loads to prevent flash.
+  rrfSetSelectedMode(localStorage.getItem("rrfMode"))
+
+  // Initialize dark/light mode after page load (mostly so mode component is updated).
   document.addEventListener("DOMContentLoaded", (event) => {
-    const selectedMode = localStorage.getItem("rrfMode")
-    rrfSetSelectedMode(selectedMode)
+    rrfSetSelectedMode(localStorage.getItem("rrfMode"))
+
+    // Also set up mode selector.
     document.querySelectorAll("#rrfModeComponent button[data-rrf-mode-value]").forEach((el) => {
       el.addEventListener("click", (event) => {
         rrfSetSelectedMode(event.target.getAttribute("data-rrf-mode-value"))

data/lib/rest_framework/controller_mixins/bulk.rb

@@ -2,43 +2,31 @@ require_relative "models"
 
 # Mixin for creating records in bulk. This is unique compared to update/destroy because we overload
 # the existing `create` action to support bulk creation.
-# :nocov:
 module RESTFramework::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 options
+  # metadata to indicate bulk create is supported.
+  def get_options_metadata
+    return super.merge({bulk_create: true})
+  end
+
   def create
-    status, payload = self.create_all!
-    return api_response(payload, status: status)
+    if params[:_json].is_a?(Array)
+      records = self.create_all!
+      serialized_records = self.bulk_serialize(records)
+      return api_response(serialized_records)
+    end
+
+    return super
   end
 
-  # Perform the `create` or `insert_all` call and return the created records with any errors. The
-  # result should be of the form: `(status, payload)`, and `payload` should be of the form:
-  # `[{success:, record: | errors:}]`, unless batch mode is enabled, in which case `payload` is
-  # blank with a status of `202`.
+  # Perform the `create` call, and return the collection of (possibly) created records.
   def create_all!
-    if self.class.bulk_batch_mode
-      insert_from = if self.get_recordset.respond_to?(:insert_all) && self.create_from_recordset
-        # Create with any properties inherited from the recordset. We exclude any `select` clauses
-        # in case model callbacks need to call `count` on this collection, which typically raises a
-        # SQL `SyntaxError`.
-        self.get_recordset.except(:select)
-      else
-        # Otherwise, perform a "bare" insert_all.
-        self.class.get_model
-      end
+    create_data = self.get_create_params(bulk_mode: true)[:_json]
 
-      insert_from
-    end
-
-    # Perform bulk creation, possibly in a transaction.
-    self.class._rrf_bulk_transaction do
-      if self.get_recordset.respond_to?(:insert_all) && self.create_from_recordset
-        # Create with any properties inherited from the recordset. We exclude any `select` clauses
-        # in case model callbacks need to call `count` on this collection, which typically raises a
-        # SQL `SyntaxError`.
-        return self.get_recordset.except(:select).create!(self.get_create_params)
-      else
-        # Otherwise, perform a "bare" insert_all.
-        return self.class.get_model.insert_all(self.get_create_params)
-      end
+    # Perform bulk create in a transaction.
+    return ActiveRecord::Base.transaction do
+      next self.get_create_from.create(create_data)
     end
   end
 end
@@ -46,24 +34,52 @@ end
 # Mixin for updating records in bulk.
 module RESTFramework::BulkUpdateModelMixin
   def update_all
-    raise NotImplementedError, "TODO"
+    records = self.update_all!
+    serialized_records = self.bulk_serialize(records)
+    return api_response(serialized_records)
   end
 
-  # Perform the `update!` call and return the updated record.
+  # Perform the `update` call and return the collection of (possibly) updated records.
   def update_all!
-    raise NotImplementedError, "TODO"
+    pk = self.class.get_model.primary_key
+    update_data = if params[:_json].is_a?(Array)
+      self.get_create_params(bulk_mode: :update)[:_json].index_by { |r| r[pk] }
+    else
+      create_params = self.get_create_params
+      {create_params[pk] => create_params}
+    end
+
+    # Perform bulk update in a transaction.
+    return ActiveRecord::Base.transaction do
+      next self.get_recordset.update(update_data.keys, update_data.values)
+    end
   end
 end
 
 # Mixin for destroying records in bulk.
 module RESTFramework::BulkDestroyModelMixin
   def destroy_all
-    raise NotImplementedError, "TODO"
+    if params[:_json].is_a?(Array)
+      records = self.destroy_all!
+      serialized_records = self.bulk_serialize(records)
+      return api_response(serialized_records)
+    end
+
+    return api_response(
+      {message: "Bulk destroy requires an array of primary keys as input."},
+      status: 400,
+    )
   end
 
   # Perform the `destroy!` call and return the destroyed (and frozen) record.
   def destroy_all!
-    raise NotImplementedError, "TODO"
+    pk = self.class.get_model.primary_key
+    destroy_data = self.request.request_parameters[:_json]
+
+    # Perform bulk destroy in a transaction.
+    return ActiveRecord::Base.transaction do
+      next self.get_recordset.where(pk => destroy_data).destroy_all
+    end
   end
 end
 
@@ -79,4 +95,3 @@ module RESTFramework::BulkModelControllerMixin
     RESTFramework::ModelControllerMixin.included(base)
   end
 end
-# :nocov:

data/lib/rest_framework/controller_mixins/models.rb

@@ -66,14 +66,6 @@ module RESTFramework::BaseModelControllerMixin
 
     # Control if filtering is done before find.
     filter_recordset_before_find: true,
-
-    # Control if bulk operations are done in a transaction and rolled back on error, or if all bulk
-    # operations are attempted and errors simply returned in the response.
-    bulk_transactional: false,
-
-    # Control if bulk operations should be done in "batch" mode, using efficient queries, but also
-    # skipping model validations/callbacks.
-    bulk_batch_mode: false,
   }
 
   module ClassMethods
@@ -502,15 +494,22 @@ module RESTFramework::BaseModelControllerMixin
   end
 
   # Use strong parameters to filter the request body using the configured allowed parameters.
-  def get_body_params(data: nil)
-    data ||= request.request_parameters
-
-    # Filter the request body with strong params.
-    body_params = ActionController::Parameters.new(data).permit(*self.get_allowed_parameters)
+  def get_body_params(data: nil, bulk_mode: nil)
+    data ||= self.request.request_parameters
+    pk = self.class.get_model&.primary_key
+
+    # Filter the request body with strong params. If `bulk` is true, then we apply allowed
+    # parameters to the `_json` key of the request body.
+    body_params = if bulk_mode
+      pk = bulk_mode == :update ? [pk] : []
+      ActionController::Parameters.new(data).permit({_json: self.get_allowed_parameters + pk})
+    else
+      ActionController::Parameters.new(data).permit(*self.get_allowed_parameters)
+    end
 
     # Filter primary key if configured.
-    if self.class.filter_pk_from_request_body
-      body_params.delete(self.class.get_model&.primary_key)
+    if self.class.filter_pk_from_request_body && bulk_mode != :update
+      body_params.delete(pk)
     end
 
     # Filter fields in `exclude_body_fields`.
@@ -593,6 +592,7 @@ module RESTFramework::BaseModelControllerMixin
 
     recordset = self.get_recordset
     find_by_key = self.class.get_model.primary_key
+    is_pk = true
 
     # Find by another column if it's permitted.
     if find_by_param = self.class.find_by_query_param.presence
@@ -600,6 +600,7 @@ module RESTFramework::BaseModelControllerMixin
         find_by_fields = self.get_find_by_fields&.map(&:to_s)
 
         if !find_by_fields || find_by.in?(find_by_fields)
+          is_pk = false unless find_by_key == find_by
           find_by_key = find_by
         end
       end
@@ -611,18 +612,41 @@ module RESTFramework::BaseModelControllerMixin
     end
 
     # Return the record. Route key is always `:id` by Rails convention.
-    return @record = recordset.find_by!(find_by_key => request.path_parameters[:id])
+    if is_pk
+      return @record = recordset.find(request.path_parameters[:id])
+    else
+      return @record = recordset.find_by!(find_by_key => request.path_parameters[:id])
+    end
   end
 
-  # Create a transaction around the passed block, if configured. This is used primarily for bulk
-  # actions, but we include it here so it's always available.
-  def self._rrf_bulk_transaction(&block)
-    if self.bulk_transactional
-      ActiveRecord::Base.transaction(&block)
+  # Determine what collection to call `create` on.
+  def get_create_from
+    if self.class.create_from_recordset
+      # Create with any properties inherited from the recordset. We exclude any `select` clauses
+      # in case model callbacks need to call `count` on this collection, which typically raises a
+      # SQL `SyntaxError`.
+      self.get_recordset.except(:select)
     else
-      yield
+      # Otherwise, perform a "bare" insert_all.
+      self.class.get_model
     end
   end
+
+  # Serialize the records, but also include any errors that might exist. This is used for bulk
+  # actions, however we include it here so the helper is available everywhere.
+  def bulk_serialize(records)
+    # This is kinda slow, so perhaps we should eventually integrate `errors` serialization into
+    # the serializer directly. This would fail for active model serializers, but maybe we don't
+    # care?
+    serializer_class = self.get_serializer_class
+    serialized_records = records.map do |record|
+      serializer_class.new(record, controller: self).serialize.merge!(
+        {errors: record.errors.presence}.compact,
+      )
+    end
+
+    return serialized_records
+  end
 end
 
 # Mixin for listing records.
@@ -668,17 +692,7 @@ module RESTFramework::CreateModelMixin
 
   # Perform the `create!` call and return the created record.
   def create!
-    create_from = if self.create_from_recordset && self.get_recordset.respond_to?(:create!)
-      # Create with any properties inherited from the recordset. We exclude any `select` clauses in
-      # case model callbacks need to call `count` on this collection, which typically raises a SQL
-      # `SyntaxError`.
-      self.get_recordset.except(:select)
-    else
-      # Otherwise, perform a "bare" create.
-      self.class.get_model
-    end
-
-    return create_from.create!(self.get_create_params)
+    return self.get_create_from.create!(self.get_create_params)
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.8.17
+  version: 0.9.1
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails