rest_framework 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e37d7baf0b2e805e4df451a8ef646e57ed078a7edd3f9d03b524198eef9fc83f
-  data.tar.gz: c6f5bf3f8f7bfa79566a1292f7634f94b29a09a934a0179adea6e3320291cb9e
+  metadata.gz: af670b7b95c56b3afafeb8947b732be7e5ff3adc9f26b7bdd8f3dc6705c48094
+  data.tar.gz: ba4de3b422fcae2451bbb5ea5e979acaaaedfba53773ddf3a77f16c97fd4db85
 SHA512:
-  metadata.gz: 13b7905e307bbc0f204d2570c05298cf9c4bcc025719210c3f496bac64a387f611ec4ab3772f8c268cc41b608973b7d3502cf5542d9fee0cce5587ef80a773cc
-  data.tar.gz: 49ef1e4a637fa2f3dee50f40042cdf50a28f68f632a0e5587a339e492954ef90c1f7cd8d80f4b0fb39668838ee020556b29dfd806377e82541b3c4a8940d6b55
+  metadata.gz: 1f98df76846047b3435c6caaf071ebd4ac60a9ddd9da517b621d21d9e84498a28d5387e2338128c4b7815d36f0750e6c06d84147409a9ce3982a329d626a9c60
+  data.tar.gz: 3aa62deb130160763d08b1487496973bdc587968c278cf26be0390d9e3464d4c408ea9f30d01d8fb38702a93e311df26a81b54f3b5adf9a49b344667af5d7508

data/VERSION

@@ -1 +1 @@
-0.7.4
+0.7.5

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

@@ -3,8 +3,20 @@
 <%= csrf_meta_tags %>
 <%= csp_meta_tag rescue nil %>
 
+<!-- Bootstrap -->
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/css/bootstrap.min.css" integrity="sha384-F3w7mX95PdgyTmZZMECAngseQB83DfGTowi0iMjiWaeVhAn4FJkqJByhZMI3AhiU" crossorigin="anonymous">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/styles/vs.min.css" integrity="sha512-aWjgJTbdG4imzxTxistV5TVNffcYGtIQQm2NBNahV6LmX14Xq9WwZTL1wPjaSglUuVzYgwrq+0EuI4+vKvQHHw==" crossorigin="anonymous">
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/js/bootstrap.bundle.min.js" integrity="sha384-/bQdsTh/da6pkI1MST/rWKFNjaCP5gBSY4sEBT38Q/9RBh9AH40zEOg7Hlq2THRZ" crossorigin="anonymous"></script>
+
+<!-- Highlight.js -->
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/vs.min.css" integrity="sha512-AVoZ71dJLtHRlsgWwujPT1hk2zxtFWsPlpTPCc/1g0WgpbmlzkqlDFduAvnOV4JJWKUquPc1ZyMc5eq4fRnKOQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js" integrity="sha512-bgHRAiTjGrzHzLyKOnpFvaEpGzJet3z4tZnXGjpsCcqOnAH6VGUx9frc5bcIhKTVLEiCO6vEhNAgx5jtLUYrfA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/json.min.js" integrity="sha512-0xYvyncS9OLE7GOpNBZFnwyh9+bq4HVgk4yVVYI678xRvE22ASicF1v6fZ1UiST+M6pn17MzFZdvVCI3jTHSyw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/xml.min.js" integrity="sha512-5zBcw+OKRkaNyvUEPlTSfYylVzgpi7KpncY36b0gRudfxIYIH0q0kl2j26uCUB3YBRM6ytQQEZSgRg+ZlBTmdA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+
+<!-- NeatJSON -->
+<script src="https://cdn.jsdelivr.net/npm/neatjson@0.10.5/javascript/neatjson.min.js"></script>
+
+<!-- Custom Style -->
 <style>
 /* Adjust headers to always take up their entire row, and tweak the sizing. */
 h1,h2,h3,h4,h5,h6 { display: inline-block; font-weight: normal; margin-bottom: 0; }
@@ -17,7 +29,7 @@ h6 { font-size: 1rem; }
 
 /* Make code and code blocks a little nicer looking. */
 code {
-  padding: 0 .35em;
+  padding: .5em !important;
   background-color: #f3f3f3 !important;
   border: 1px solid #aaa;
   border-radius: 3px;
@@ -56,25 +68,22 @@ code {
 }
 </style>
 
-<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/js/bootstrap.bundle.min.js" integrity="sha384-/bQdsTh/da6pkI1MST/rWKFNjaCP5gBSY4sEBT38Q/9RBh9AH40zEOg7Hlq2THRZ" crossorigin="anonymous"></script>
-<script src="https://cdn.jsdelivr.net/npm/neatjson@0.10.5/javascript/neatjson.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/highlight.min.js" integrity="sha512-TDKKr+IvoqZnPzc3l35hdjpHD0m+b2EC2SrLEgKDRWpxf2rFCxemkgvJ5kfU48ip+Y+m2XVKyOCD85ybtlZDmw==" crossorigin="anonymous"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/languages/json.min.js" integrity="sha512-FoN8JE+WWCdIGXAIT8KQXwpiavz0Mvjtfk7Rku3MDUNO0BDCiRMXAsSX+e+COFyZTcDb9HDgP+pM2RX12d4j+A==" crossorigin="anonymous"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/languages/xml.min.js" integrity="sha512-dICltIgnUP+QSJrnYGCV8943p3qSDgvcg2NU4W8IcOZP4tdrvxlXjbhIznhtVQEcXow0mOjLM0Q6/NvZsmUH4g==" crossorigin="anonymous"></script>
+<!-- Custom JavaScript -->
 <script>
-hljs.initHighlightingOnLoad()
-
 // What to do when document loads.
 document.addEventListener("DOMContentLoaded", (event) => {
   // Pretty-print JSON.
   [...document.getElementsByClassName("language-json")].forEach((element, index) => {
-    element.innerHTML = neatJSON(JSON.parse(element.innerHTML), {
+    element.innerHTML = neatJSON(JSON.parse(element.innerText), {
       wrap: 80,
       afterComma: 1,
       afterColon: 1,
     })
   });
 
+  // Then highlight it.
+  hljs.highlightAll();
+
   // Insert copy link and callback to copy contents of `<code>` element.
   [...document.getElementsByClassName("rrf-copy")].forEach((element, index) => {
     element.insertAdjacentHTML(

data/lib/rest_framework/controller_mixins/base.rb

@@ -18,7 +18,7 @@ module RESTFramework::BaseControllerMixin
     filter_backends: nil,
     singleton_controller: nil,
 
-    # Metadata and display options.
+    # Options related to metadata and display.
     title: nil,
     description: nil,
     inflect_acronyms: ["ID", "REST", "API"].freeze,
@@ -36,6 +36,10 @@ module RESTFramework::BaseControllerMixin
     page_size_query_param: "page_size",
     max_page_size: nil,
 
+    # Options related to bulk actions and batch processing.
+    bulk_guard_query_param: nil,
+    enable_batch_processing: nil,
+
     # Option to disable serializer adapters by default, mainly introduced because Active Model
     # Serializers will do things like serialize `[]` into `{"":[]}`.
     disable_adapters_by_default: true,
@@ -74,6 +78,13 @@ module RESTFramework::BaseControllerMixin
         end
       end
 
+      # Add builtin bulk actions.
+      RESTFramework::RRF_BUILTIN_BULK_ACTIONS.each do |action, methods|
+        if self.method_defined?(action)
+          actions[action] = {path: "", methods: methods, type: :builtin}
+        end
+      end
+
       # Add extra actions.
       if extra_actions = self.try(:extra_actions)
         actions.merge!(RESTFramework::Utils.parse_extra_actions(extra_actions, controller: self))
@@ -268,8 +279,8 @@ module RESTFramework::BaseControllerMixin
     )
   end
 
-  # Helper to render a browsable API for `html` format, along with basic `json`/`xml` formats, and
-  # with support or passing custom `kwargs` to the underlying `render` calls.
+  # Render a browsable API for `html` format, along with basic `json`/`xml` formats, and with
+  # support or passing custom `kwargs` to the underlying `render` calls.
   def api_response(payload, html_kwargs: nil, **kwargs)
     html_kwargs ||= {}
     json_kwargs = kwargs.delete(:json_kwargs) || {}

data/lib/rest_framework/controller_mixins/bulk.rb

@@ -0,0 +1,51 @@
+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.
+module RESTFramework::BulkCreateModelMixin
+  def create
+    raise NotImplementedError, "TODO"
+  end
+
+  # Perform the `create!` call and return the created record.
+  def create_all!
+    raise NotImplementedError, "TODO"
+  end
+end
+
+# Mixin for updating records in bulk.
+module RESTFramework::BulkUpdateModelMixin
+  def update_all
+    raise NotImplementedError, "TODO"
+  end
+
+  # Perform the `update!` call and return the updated record.
+  def update_all!
+    raise NotImplementedError, "TODO"
+  end
+end
+
+# Mixin for destroying records in bulk.
+module RESTFramework::BulkDestroyModelMixin
+  def destroy_all
+    raise NotImplementedError, "TODO"
+  end
+
+  # Perform the `destroy!` call and return the destroyed (and frozen) record.
+  def destroy_all!
+    raise NotImplementedError, "TODO"
+  end
+end
+
+# Mixin that includes all the CRUD bulk mixins.
+module RESTFramework::BulkModelControllerMixin
+  include RESTFramework::ModelControllerMixin
+
+  include RESTFramework::BulkCreateModelMixin
+  include RESTFramework::BulkUpdateModelMixin
+  include RESTFramework::BulkDestroyModelMixin
+
+  def self.included(base)
+    RESTFramework::ModelControllerMixin.included(base)
+  end
+end

data/lib/rest_framework/controller_mixins/models.rb

@@ -163,15 +163,20 @@ module RESTFramework::BaseModelControllerMixin
     # Get metadata about the resource's associations (reflections).
     def get_associations_metadata
       return self.get_model.reflections.map { |k, v|
+        begin
+          pk = v.active_record_primary_key
+        rescue ActiveRecord::UnknownPrimaryKey
+        end
+
         next [k, {
           macro: v.macro,
           label: self.get_label(k),
           class_name: v.class_name,
           foreign_key: v.foreign_key,
-          primary_key: v.active_record_primary_key,
+          primary_key: pk,
           polymorphic: v.polymorphic?,
           table_name: v.table_name,
-          options: v.options,
+          options: v.options.presence,
         }.compact]
       }.to_h
     end
@@ -238,9 +243,10 @@ module RESTFramework::BaseModelControllerMixin
   end
 
   def self.included(base)
+    RESTFramework::BaseControllerMixin.included(base)
+
     return unless base.is_a?(Class)
 
-    RESTFramework::BaseControllerMixin.included(base)
     base.extend(ClassMethods)
 
     # Add class attributes (with defaults) unless they already exist.
@@ -311,12 +317,12 @@ module RESTFramework::BaseModelControllerMixin
     ) || self.get_fields
   end
 
-  # Helper to get the configured serializer class, or `NativeSerializer` as a default.
+  # Get the configured serializer class, or `NativeSerializer` as a default.
   def get_serializer_class
     return super || RESTFramework::NativeSerializer
   end
 
-  # Helper to get filtering backends, defaulting to using `ModelFilter` and `ModelOrderingFilter`.
+  # Get filtering backends, defaulting to using `ModelFilter` and `ModelOrderingFilter`.
   def get_filter_backends
     return self.class.filter_backends || [
       RESTFramework::ModelFilter, RESTFramework::ModelOrderingFilter
@@ -324,14 +330,16 @@ module RESTFramework::BaseModelControllerMixin
   end
 
   # Filter the request body for keys in current action's allowed_parameters/fields config.
-  def get_body_params
+  def get_body_params(request_parameters: nil)
+    request_parameters ||= request.request_parameters
+
     # Filter the request body and map to strings. Return all params if we cannot resolve a list of
     # allowed parameters or fields.
     allowed_params = self.get_allowed_parameters&.map(&:to_s)
     body_params = if allowed_params
-      request.request_parameters.select { |p| allowed_params.include?(p) }
+      request_parameters.select { |p| allowed_params.include?(p) }
     else
-      request.request_parameters
+      request_parameters
     end
 
     # Add query params in place of missing body params, if configured.
@@ -370,7 +378,7 @@ module RESTFramework::BaseModelControllerMixin
     return @recordset = nil
   end
 
-  # Helper to get the records this controller has access to *after* any filtering is applied.
+  # Get the records this controller has access to *after* any filtering is applied.
   def get_records
     return @records if instance_variable_defined?(:@records)
 
@@ -413,7 +421,7 @@ module RESTFramework::ListModelMixin
     return api_response(self.get_index_records)
   end
 
-  # Helper to get records with both filtering and pagination applied.
+  # Get records with both filtering and pagination applied.
   def get_index_records
     records = self.get_records
 
@@ -448,7 +456,7 @@ module RESTFramework::CreateModelMixin
     return api_response(self.create!, status: :created)
   end
 
-  # Helper to perform the `create!` call and return the created record.
+  # Perform the `create!` call and return the created record.
   def create!
     if self.get_recordset.respond_to?(:create!) && self.create_from_recordset
       # Create with any properties inherited from the recordset. We exclude any `select` clauses in
@@ -468,7 +476,7 @@ module RESTFramework::UpdateModelMixin
     return api_response(self.update!)
   end
 
-  # Helper to perform the `update!` call and return the updated record.
+  # Perform the `update!` call and return the updated record.
   def update!
     record = self.get_record
     record.update!(self.get_update_params)
@@ -483,7 +491,7 @@ module RESTFramework::DestroyModelMixin
     return api_response("")
   end
 
-  # Helper to perform the `destroy!` call and return the destroyed (and frozen) record.
+  # Perform the `destroy!` call and return the destroyed (and frozen) record.
   def destroy!
     return self.get_record.destroy!
   end
@@ -493,29 +501,25 @@ end
 module RESTFramework::ReadOnlyModelControllerMixin
   include RESTFramework::BaseModelControllerMixin
 
-  def self.included(base)
-    return unless base.is_a?(Class)
+  include RESTFramework::ListModelMixin
+  include RESTFramework::ShowModelMixin
 
+  def self.included(base)
     RESTFramework::BaseModelControllerMixin.included(base)
   end
-
-  include RESTFramework::ListModelMixin
-  include RESTFramework::ShowModelMixin
 end
 
 # Mixin that includes all the CRUD mixins.
 module RESTFramework::ModelControllerMixin
   include RESTFramework::BaseModelControllerMixin
 
-  def self.included(base)
-    return unless base.is_a?(Class)
-
-    RESTFramework::BaseModelControllerMixin.included(base)
-  end
-
   include RESTFramework::ListModelMixin
   include RESTFramework::ShowModelMixin
   include RESTFramework::CreateModelMixin
   include RESTFramework::UpdateModelMixin
   include RESTFramework::DestroyModelMixin
+
+  def self.included(base)
+    RESTFramework::BaseModelControllerMixin.included(base)
+  end
 end

data/lib/rest_framework/controller_mixins.rb

@@ -2,4 +2,5 @@ module RESTFramework::ControllerMixins
 end
 
 require_relative "controller_mixins/base"
+require_relative "controller_mixins/bulk"
 require_relative "controller_mixins/models"

data/lib/rest_framework/routers.rb

@@ -102,6 +102,15 @@ module ActionDispatch::Routing
               public_send(m, "", action: action) if self.respond_to?(m)
             end
           end
+
+          # Route bulk actions, if configured.
+          RESTFramework::RRF_BUILTIN_BULK_ACTIONS.each do |action, methods|
+            next unless controller_class.method_defined?(action)
+
+            [methods].flatten.each do |m|
+              public_send(m, "", action: action) if self.respond_to?(m)
+            end
+          end
         end
 
         if unscoped

data/lib/rest_framework/serializers.rb

@@ -88,7 +88,7 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
     return self.config || self.singular_config || self.plural_config
   end
 
-  # Helper to get a native serializer configuration from the controller.
+  # Get a native serializer configuration from the controller.
   def get_controller_native_serializer_config
     return nil unless @controller
 
@@ -101,9 +101,8 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
     return controller_serializer || @controller.class.try(:native_serializer_config)
   end
 
-  # Helper to filter a single subconfig for specific keys. By default, keys from `fields` are
-  # removed from the provided `subcfg`. There are two (mutually exclusive) options to adjust the
-  # behavior:
+  # Filter a single subconfig for specific keys. By default, keys from `fields` are removed from the
+  # provided `subcfg`. There are two (mutually exclusive) options to adjust the behavior:
   #
   #  `add`: Add any `fields` to the `subcfg` which aren't already in the `subcfg`.
   #  `only`: Remove any values found in the `subcfg` not in `fields`.
@@ -149,7 +148,7 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
     return subcfg
   end
 
-  # Helper to filter out configuration properties based on the :except query parameter.
+  # Filter out configuration properties based on the :except query parameter.
   def filter_except(cfg)
     return cfg unless @controller
 
@@ -245,7 +244,7 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
     return filter_except(self._get_raw_serializer_config)
   end
 
-  # Internal helper to serialize a single record and merge results of `serializer_methods`.
+  # Serialize a single record and merge results of `serializer_methods`.
   def _serialize(record, config, serializer_methods)
     # Ensure serializer_methods is either falsy, or an array.
     if serializer_methods && !serializer_methods.respond_to?(:to_ary)

data/lib/rest_framework.rb

@@ -13,6 +13,10 @@ module RESTFramework
   RRF_BUILTIN_ACTIONS = {
     options: :options,
   }.freeze
+  RRF_BUILTIN_BULK_ACTIONS = {
+    update_all: [:put, :patch].freeze,
+    destroy_all: :delete,
+  }.freeze
 
   # Global configuration should be kept minimal, as controller-level configurations allows multiple
   # APIs to be defined to behave differently.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,6 +42,7 @@ files:
 - lib/rest_framework.rb
 - lib/rest_framework/controller_mixins.rb
 - lib/rest_framework/controller_mixins/base.rb
+- lib/rest_framework/controller_mixins/bulk.rb
 - lib/rest_framework/controller_mixins/models.rb
 - lib/rest_framework/engine.rb
 - lib/rest_framework/errors.rb