rest_framework 0.9.8 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b06a61592498f8debce6f504b4eee90ceeef6fdff63dbb769bd70c623cd9631
-  data.tar.gz: ab5b1284a3504104b77cc38278bad01a1dfa30ce7ebcd65323b73e0dd31e58a2
+  metadata.gz: 2db255f618d449ef621f1337d182993c21b5d8d87e5e8c960c8b42093248c91d
+  data.tar.gz: 4612f2e11733ae69e418cd2877b8150e2a1dbd4fb0cd34ed29727dcec007f305
 SHA512:
-  metadata.gz: ed04505314f252ac1058732a875711090fb07499edac42814bf72e5b15f90f833040e40399df279654727041af30789c8a931e06d83b9fc1c67f46d4f0da850f
-  data.tar.gz: abd68ae8ab71f2fff8f7a933270a467811143096f7cdde16d21c99ac3faeadc8f958cb0bcdde94c1b57f1d620fc278f8d9b5e3b4e2cec5851fb4616f9c325d41
+  metadata.gz: 04457aa989c261900e8e1e55829dbb3cc3aed3afda800433944497996a330a92fdff403351be8e4b83b7b44fea658ecd57a3ab20b4b9e41587398a52b8203680
+  data.tar.gz: e67d99fd29629b7bf31e37f3f27edc8e7d5d222172e6b91e5d2340eec0d891b340029097dc798411410d9c5ecbdffe316521c0dd47e8810c6fe897b0ff59624b

data/README.md

@@ -7,12 +7,10 @@
 
 A framework for DRY RESTful APIs in Ruby on Rails.
 
-**The Problem**: Building controllers for APIs usually involves writing a lot of redundant CRUD
-logic, and routing them can be obnoxious. Building and maintaining features like ordering,
-filtering, and pagination can be tedious.
+**The Problem**: Building controllers for APIs usually involves writing a lot of redundant CRUD logic, and routing them can be obnoxious.
+Building and maintaining features like ordering, filtering, and pagination can be tedious.
 
-**The Solution**: This framework implements browsable API responses, CRUD actions for your models,
-and features like ordering/filtering/pagination, so you can focus on building awesome APIs.
+**The Solution**: This framework implements browsable API responses, CRUD actions for your models, and features like ordering/filtering/pagination, so you can focus on building awesome APIs.
 
 Website/Guide: [rails-rest-framework.com](https://rails-rest-framework.com)
 
@@ -27,87 +25,119 @@ YARD Docs: [rubydoc.info/gems/rest_framework](https://rubydoc.info/gems/rest_fra
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rest_framework'
+gem "rest_framework"
 ```
 
-And then execute:
+And then run:
 
 ```shell
-$ bundle install
+bundle install
 ```
 
-Or install it yourself with:
+## Quick Usage Tutorial
 
-```shell
-$ gem install rest_framework
-```
+This section provides some simple examples to quickly get you started using the framework.
 
-## Quick Usage Tutorial
+For the purpose of this example, you'll want to add an `api_controller.rb` to your controllers, as well as a directory for the resources:
+
+```text
+controllers/
+├─ api_controller.rb
+└─ api/
+   ├─ root_controller.rb
+   ├─ movies_controller.rb
+   └─ users_controller.rb
+```
 
 ### Controller Mixins
 
-To transform a controller into a RESTful controller, you can either include `BaseControllerMixin`,
-`ReadOnlyModelControllerMixin`, or `ModelControllerMixin`. `BaseControllerMixin` provides a `root`
-action and a simple interface for routing arbitrary additional actions:
+The root `ApiController` can include any common behavior you want to share across all your API controllers:
 
 ```ruby
 class ApiController < ApplicationController
   include RESTFramework::BaseControllerMixin
+
+  # Setting up a paginator class here makes more sense than defining it on every child controller.
+  self.paginator_class = RESTFramework::PageNumberPaginator
+
+  # The page_size attribute doesn't exist on the `BaseControllerMixin`, but for child controllers
+  # that include the `ModelControllerMixin`, they will inherit this attribute and will not overwrite
+  # it.
+  class_attribute(:page_size, default: 30)
+end
+```
+
+A root controller can provide actions that exist on the root of your API.
+It's best to define a dedicated root controller, rather than using the `ApiController` for this purpose, so that actions don't propagate to child controllers:
+
+```ruby
+class Api::RootController < ApiController
   self.extra_actions = {test: :get}
 
+  def root
+    return api_response(
+      {
+        message: "Welcome to the API.",
+        how_to_authenticate: <<~END.lines.map(&:strip).join(" "),
+          You can use this API with your normal login session. Otherwise, you can insert your API
+          key into a Bearer Authorization header, or into the URL parameters with the name
+          `api_key`.
+        END
+      },
+    )
+  end
+
   def test
-    render api_response({message: "Test successful!"})
+    return api_response({message: "Hello, world!"})
   end
 end
 ```
 
-`ModelControllerMixin` assists with providing the standard model CRUD for your controller.
+And here is an example of a resource controller:
 
 ```ruby
 class Api::MoviesController < ApiController
   include RESTFramework::ModelControllerMixin
 
-  self.recordset = Movie.where(enabled: true)
+  self.fields = [:id, :name, :release_date, :enabled]
+  self.extra_member_actions = {first: :get}
+
+  def first
+    # Always use the bang method, since the framework will rescue `RecordNotFound` and return a
+    # sensible error response.
+    return api_response(self.get_records.first!)
+  end
+
+  def get_recordset
+    return Movie.where(enabled: true)
+  end
 end
 ```
 
-`ReadOnlyModelControllerMixin` only enables list/show actions, but since we're naming this
-controller in a way that doesn't make the model obvious, we can set that explicitly:
+When `fields` is nil, then it will default to all columns.
+The `fields` attribute can also be a hash to include or exclude fields rather than defining them manually:
 
 ```ruby
-class Api::ReadOnlyMoviesController < ApiController
-  include RESTFramework::ReadOnlyModelControllerMixin
+class Api::UsersController < ApiController
+  include RESTFramework::ModelControllerMixin
 
-  self.model = Movie
+  self.fields = {include: [:calculated_popularity], exclude: [:impersonation_token]}
 end
 ```
 
-Note that you can also override the `get_recordset` instance method to override the API behavior
-dynamically per-request.
-
 ### Routing
 
-You can use Rails' `resource`/`resources` routers to route your API, however if you want
-`extra_actions` / `extra_member_actions` to be routed automatically, then you can use `rest_route`
-for non-resourceful controllers, or `rest_resource` / `rest_resources` resourceful routers. You can
-also use `rest_root` to route the root of your API:
+Use `rest_route` for non-resourceful controllers, or `rest_resource` / `rest_resources` resourceful routers.
+These routers add some features to the Rails builtin `resource`/`resources` routers, such as automatically routing extra actions defined on the controller.
+To route the root, use `rest_root`.
 
 ```ruby
 Rails.application.routes.draw do
-  rest_root :api  # will find `api_controller` and route the `root` action to '/api'
-  namespace :api do
-    rest_resources :movies
-    rest_resources :users
-  end
-end
-```
-
-Or if you want the API root to be routed to `Api::RootController#root`:
+  # If you wanted to route actions from the `ApiController`, then you would use this:
+  # rest_root :api  # Will find `api_controller` and route the `root` action to '/api'.
 
-```ruby
-Rails.application.routes.draw do
   namespace :api do
-    rest_root  # will route `Api::RootController#root` to '/' in this namespace ('/api')
+    rest_root  # Will route `Api::RootController#root` to '/' in this namespace ('/api').
     rest_resources :movies
     rest_resources :users
   end
@@ -116,15 +146,7 @@ end
 
 ## Development/Testing
 
-After you clone the repository, cd'ing into the directory should create a new gemset if you are
-using RVM. Then run `bundle install` to install the appropriate gems.
-
-To run the test suite:
-
-```shell
-$ rails test
-```
+After you clone the repository, cd'ing into the directory should create a new gemset if you are using RVM.
+Then run `bin/setup` to install the appropriate gems and set things up.
 
-The top-level `bin/rails` proxies all Rails commands to the test project, so you can operate it via
-the usual commands. Ensure you run `rails db:setup` before running `rails server` or
-`rails console`.
+The top-level `bin/rails` proxies all Rails commands to the test project, so you can operate it via the usual commands (e.g., `rails test`, `rails server` and `rails console`).

data/VERSION

@@ -1 +1 @@
-0.9.8
+0.9.10

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

@@ -29,7 +29,6 @@
   h1, h2, h3, h4, h5, h6 {
     color: var(--rrf-red);
     font-weight: normal;
-    margin-bottom: 0;
   }
   html[data-bs-theme="dark"] h1,
   html[data-bs-theme="dark"] h2,
@@ -290,7 +289,7 @@
 
   // Convert plain-text links to anchor tag links.
   function rrfLinkify(text) {
-    return text.replace(/(https?:\/\/[^\s<>"]+)/g, "<a href=\"$1\" target=\"_blank\">$1</a>")
+    return text.replace(/(https?:\/\/[^\s<>"]+)/g, "<a href=\"$1\">$1</a>")
   }
 
   // Replace the document when doing form submission (mainly to support PUT/PATCH/DELETE).

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

@@ -1,7 +1,7 @@
 <div class="row">
   <div>
     <%= render partial: "rest_framework/heading/actions" if @route_groups.present? %>
-    <h1 class="m-0"><%= @heading_title || @title %></h1>
+    <h1 style="margin: 0"><%= @heading_title || @title %></h1>
     <% if @description.present? %>
       <br><br><p style="display: inline-block; margin-bottom: 0"><%= @description %></p>
     <% end %>

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

@@ -17,7 +17,7 @@
       <% end %>
     </ul>
   </div>
-  <div class="tab-content pt-2">
+  <div class="tab-content">
     <div class="tab-pane fade show active" id="tab-json" role="tabpanel">
       <% if @json_payload.present? %>
         <div><pre class="rrf-copy"><code class="language-json"><%=

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

@@ -1,16 +1,14 @@
 <div class="row">
   <div>
-    <pre><code><%
+    <pre class="mb-2"><code class="language-plaintext"><%
       concat request.request_method
       if request.method != request.request_method
         concat " (via #{request.method})"
       end
       concat " #{request.path}"
     %></code></pre>
-    <pre><code><%
+    <pre><code class="language-plaintext"><%
       concat "HTTP #{response.status} #{response.message}"
-      concat "\n"
-      concat "Content-Type: #{response.content_type}"
     %></code></pre>
   </div>
 </div>

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

@@ -34,7 +34,7 @@
       <% end %>
     </ul>
   </div>
-  <div class="tab-content pt-2">
+  <div class="tab-content">
     <div class="tab-pane fade show active" id="tab-routes" role="tabpanel">
       <%= render partial: "rest_framework/routes_and_forms/routes" %>
     </div>
@@ -49,4 +49,4 @@
       </div>
     <% end %>
   </div>
-</div>
+</div>

data/lib/rest_framework/errors/base_error.rb

@@ -0,0 +1,5 @@
+class RESTFramework::Errors::BaseError < StandardError
+end
+
+# Alias for convenience.
+RESTFramework::BaseError = RESTFramework::Errors::BaseError

data/lib/rest_framework/errors/nil_passed_to_api_response_error.rb

@@ -0,0 +1,14 @@
+class RESTFramework::Errors::NilPassedToAPIResponseError < RESTFramework::Errors::BaseError
+  def message
+    return <<~MSG.split("\n").join(" ")
+      Payload of `nil` was passed to `api_response`; this is unsupported. If you want a blank
+      response, pass `''` (an empty string) as the payload. If this was the result of a `find_by`
+      (or similar Active Record method) not finding a record, you should use the bang version (e.g.,
+      `find_by!`) to raise `ActiveRecord::RecordNotFound`, which the REST controller will catch and
+      return an appropriate error response.
+    MSG
+  end
+end
+
+# Alias for convenience.
+RESTFramework::NilPassedToAPIResponseError = RESTFramework::Errors::NilPassedToAPIResponseError

data/lib/rest_framework/errors/unknown_model_error.rb

@@ -0,0 +1,18 @@
+class RESTFramework::Errors::UnknownModelError < RESTFramework::Errors::BaseError
+  def initialize(controller_class)
+    super()
+    @controller_class = controller_class
+  end
+
+  def message
+    return <<~MSG.split("\n").join(" ")
+      The model class for `#{@controller_class}` could not be determined. Any controller that
+      includes `RESTFramework::BaseModelControllerMixin` (directly or indirectly) must either set
+      the `model` attribute on the controller, or the model must be deducible from the controller
+      name (e.g., `UsersController` could resolve to the `User` model).
+    MSG
+  end
+end
+
+# Alias for convenience.
+RESTFramework::UnknownModelError = RESTFramework::Errors::UnknownModelError

data/lib/rest_framework/errors.rb

@@ -1,31 +1,7 @@
-# Top-level class for all REST Framework errors.
-class RESTFramework::Error < StandardError
+module RESTFramework::Errors
 end
 
-class RESTFramework::NilPassedToAPIResponseError < RESTFramework::Error
-  def message
-    return <<~MSG.split("\n").join(" ")
-      Payload of `nil` was passed to `api_response`; this is unsupported. If you want a blank
-      response, pass `''` (an empty string) as the payload. If this was the result of a `find_by`
-      (or similar Active Record method) not finding a record, you should use the bang version (e.g.,
-      `find_by!`) to raise `ActiveRecord::RecordNotFound`, which the REST controller will catch and
-      return an appropriate error response.
-    MSG
-  end
-end
-
-class RESTFramework::UnknownModelError < RESTFramework::Error
-  def initialize(controller_class)
-    super()
-    @controller_class = controller_class
-  end
+require_relative "errors/base_error"
 
-  def message
-    return <<~MSG.split("\n").join(" ")
-      The model class for `#{@controller_class}` could not be determined. Any controller that
-      includes `RESTFramework::BaseModelControllerMixin` (directly or indirectly) must either set
-      the `model` attribute on the controller, or the model must be deducible from the controller
-      name (e.g., `UsersController` could resolve to the `User` model).
-    MSG
-  end
-end
+require_relative "errors/nil_passed_to_api_response_error"
+require_relative "errors/unknown_model_error"

data/lib/rest_framework/filters/model_ordering_filter.rb

@@ -15,6 +15,7 @@ class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::Base
 
     if order_string.present?
       ordering = {}.with_indifferent_access
+
       order_string.split(",").each do |field|
         if field[0] == "-"
           column = field[1..-1]
@@ -24,10 +25,11 @@ class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::Base
           direction = :asc
         end
 
-        next if !column.in?(fields) && column.split(".").first.in?(fields)
+        next if !column.in?(fields) && !column.split(".").first.in?(fields)
 
         ordering[column] = direction
       end
+
       return ordering
     end
 

data/lib/rest_framework/filters/model_query_filter.rb

@@ -1,5 +1,7 @@
 # A simple filtering backend that supports filtering a recordset based on query parameters.
 class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFilter
+  NIL_VALUES = ["nil", "null"].freeze
+
   # Get a list of filterset fields for the current action.
   def _get_fields
     # Always return a list of strings; `@controller.get_fields` already does this.
@@ -9,8 +11,9 @@ class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFil
   # Filter params for keys allowed by the current action's filterset_fields/fields config.
   def _get_filter_params
     fields = self._get_fields
+    includes = []
 
-    return @controller.request.query_parameters.select { |p, _|
+    filter_params = @controller.request.query_parameters.select { |p, _|
       # Remove any trailing `__in` from the field name.
       field = p.chomp("__in")
 
@@ -20,7 +23,12 @@ class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFil
         next false unless field.in?(fields)
 
         sub_fields = @controller.class.get_field_config(field)[:sub_fields] || []
-        next sub_field.in?(sub_fields)
+        if sub_field.in?(sub_fields)
+          includes << field.to_sym
+          next true
+        end
+
+        next false
       end
 
       next field.in?(fields)
@@ -28,21 +36,27 @@ class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFil
       # Convert fields ending in `__in` to array values.
       if p.end_with?("__in")
         p = p.chomp("__in")
-        v = v.split(",")
+        v = v.split(",").map { |v| v.in?(NIL_VALUES) ? nil : v }
       end
 
       # Convert "nil" and "null" to nil.
-      if v == "nil" || v == "null"
-        v = nil
-      end
+      v = nil if v.in?(NIL_VALUES)
 
       [p, v]
     }.to_h.symbolize_keys
+
+    return filter_params, includes
   end
 
   # Filter data according to the request query parameters.
   def get_filtered_data(data)
-    if filter_params = self._get_filter_params.presence
+    filter_params, includes = self._get_filter_params
+
+    if filter_params.any?
+      if includes.any?
+        data = data.includes(*includes)
+      end
+
       return data.where(**filter_params)
     end
 

data/lib/rest_framework/mixins/bulk_model_controller_mixin.rb

@@ -31,9 +31,6 @@ module RESTFramework::Mixins::BulkCreateModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::BulkCreateModelMixin = RESTFramework::Mixins::BulkCreateModelMixin
-
 # Mixin for updating records in bulk.
 module RESTFramework::Mixins::BulkUpdateModelMixin
   def update_all
@@ -59,9 +56,6 @@ module RESTFramework::Mixins::BulkUpdateModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::BulkUpdateModelMixin = RESTFramework::Mixins::BulkUpdateModelMixin
-
 # Mixin for destroying records in bulk.
 module RESTFramework::Mixins::BulkDestroyModelMixin
   def destroy_all
@@ -89,21 +83,21 @@ module RESTFramework::Mixins::BulkDestroyModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::BulkDestroyModelMixin = RESTFramework::Mixins::BulkDestroyModelMixin
-
 # Mixin that includes all the CRUD bulk mixins.
 module RESTFramework::Mixins::BulkModelControllerMixin
-  include RESTFramework::ModelControllerMixin
+  include RESTFramework::Mixins::ModelControllerMixin
 
-  include RESTFramework::BulkCreateModelMixin
-  include RESTFramework::BulkUpdateModelMixin
-  include RESTFramework::BulkDestroyModelMixin
+  include RESTFramework::Mixins::BulkCreateModelMixin
+  include RESTFramework::Mixins::BulkUpdateModelMixin
+  include RESTFramework::Mixins::BulkDestroyModelMixin
 
   def self.included(base)
-    RESTFramework::ModelControllerMixin.included(base)
+    RESTFramework::Mixins::ModelControllerMixin.included(base)
   end
 end
 
-# Alias for convenience.
+# Aliases for convenience.
+RESTFramework::BulkCreateModelMixin = RESTFramework::Mixins::BulkCreateModelMixin
+RESTFramework::BulkUpdateModelMixin = RESTFramework::Mixins::BulkUpdateModelMixin
+RESTFramework::BulkDestroyModelMixin = RESTFramework::Mixins::BulkDestroyModelMixin
 RESTFramework::BulkModelControllerMixin = RESTFramework::Mixins::BulkModelControllerMixin

data/lib/rest_framework/mixins/model_controller_mixin.rb

@@ -33,17 +33,7 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     # Options for handling request body parameters.
     allowed_parameters: nil,
     filter_pk_from_request_body: true,
-    exclude_body_fields: %w[
-      created_at
-      created_by
-      created_by_id
-      updated_at
-      updated_by
-      updated_by_id
-      _method
-      utf8
-      authenticity_token
-    ].freeze,
+    exclude_body_fields: RESTFramework.config.exclude_body_fields,
 
     # Attributes for the default native serializer.
     native_serializer_config: nil,
@@ -515,7 +505,7 @@ module RESTFramework::Mixins::BaseModelControllerMixin
       ActionController::Parameters.new(data).permit(*allowed_params)
     end
 
-    # Filter primary key if configured.
+    # Filter primary key, if configured.
     if self.filter_pk_from_request_body && bulk_mode != :update
       body_params.delete(pk)
     end
@@ -527,7 +517,7 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     #
     # rubocop:disable Layout/LineLength
     #
-    # Good example base64 image:
+    # Example base64 image:
     #   data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3/OAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAANCSURBVEiJtZZPbBtFFMZ/M7ubXdtdb1xSFyeilBapySVU8h8OoFaooFSqiihIVIpQBKci6KEg9Q6H9kovIHoCIVQJJCKE1ENFjnAgcaSGC6rEnxBwA04Tx43t2FnvDAfjkNibxgHxnWb2e/u992bee7tCa00YFsffekFY+nUzFtjW0LrvjRXrCDIAaPLlW0nHL0SsZtVoaF98mLrx3pdhOqLtYPHChahZcYYO7KvPFxvRl5XPp1sN3adWiD1ZAqD6XYK1b/dvE5IWryTt2udLFedwc1+9kLp+vbbpoDh+6TklxBeAi9TL0taeWpdmZzQDry0AcO+jQ12RyohqqoYoo8RDwJrU+qXkjWtfi8Xxt58BdQuwQs9qC/afLwCw8tnQbqYAPsgxE1S6F3EAIXux2oQFKm0ihMsOF71dHYx+f3NND68ghCu1YIoePPQN1pGRABkJ6Bus96CutRZMydTl+TvuiRW1m3n0eDl0vRPcEysqdXn+jsQPsrHMquGeXEaY4Yk4wxWcY5V/9scqOMOVUFthatyTy8QyqwZ+kDURKoMWxNKr2EeqVKcTNOajqKoBgOE28U4tdQl5p5bwCw7BWquaZSzAPlwjlithJtp3pTImSqQRrb2Z8PHGigD4RZuNX6JYj6wj7O4TFLbCO/Mn/m8R+h6rYSUb3ekokRY6f/YukArN979jcW+V/S8g0eT/N3VN3kTqWbQ428m9/8k0P/1aIhF36PccEl6EhOcAUCrXKZXXWS3XKd2vc/TRBG9O5ELC17MmWubD2nKhUKZa26Ba2+D3P+4/MNCFwg59oWVeYhkzgN/JDR8deKBoD7Y+ljEjGZ0sosXVTvbc6RHirr2reNy1OXd6pJsQ+gqjk8VWFYmHrwBzW/n+uMPFiRwHB2I7ih8ciHFxIkd/3Omk5tCDV1t+2nNu5sxxpDFNx+huNhVT3/zMDz8usXC3ddaHBj1GHj/As08fwTS7Kt1HBTmyN29vdwAw+/wbwLVOJ3uAD1wi/dUH7Qei66PfyuRj4Ik9is+hglfbkbfR3cnZm7chlUWLdwmprtCohX4HUtlOcQjLYCu+fzGJH2QRKvP3UNz8bWk1qMxjGTOMThZ3kvgLI5AzFfo379UAAAAASUVORK5CYII=
     #
     # rubocop:enable Layout/LineLength
@@ -572,7 +562,6 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     # Cache the result.
     return @record if @record
 
-    recordset = self.get_recordset
     find_by_key = self.class.get_model.primary_key
     is_pk = true
 
@@ -588,16 +577,18 @@ module RESTFramework::Mixins::BaseModelControllerMixin
       end
     end
 
-    # Filter recordset, if configured.
-    if self.filter_recordset_before_find
-      recordset = self.get_records
+    # Get the recordset, filtering if configured.
+    collection = if self.filter_recordset_before_find
+      self.get_records
+    else
+      self.get_recordset
     end
 
     # Return the record. Route key is always `:id` by Rails convention.
     if is_pk
-      return @record = recordset.find(request.path_parameters[:id])
+      return @record = collection.find(request.path_parameters[:id])
     else
-      return @record = recordset.find_by!(find_by_key => request.path_parameters[:id])
+      return @record = collection.find_by!(find_by_key => request.path_parameters[:id])
     end
   end
 
@@ -631,9 +622,6 @@ module RESTFramework::Mixins::BaseModelControllerMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::BaseModelControllerMixin = RESTFramework::Mixins::BaseModelControllerMixin
-
 # Mixin for listing records.
 module RESTFramework::Mixins::ListModelMixin
   def index
@@ -662,9 +650,6 @@ module RESTFramework::Mixins::ListModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::ListModelMixin = RESTFramework::Mixins::ListModelMixin
-
 # Mixin for showing records.
 module RESTFramework::Mixins::ShowModelMixin
   def show
@@ -672,9 +657,6 @@ module RESTFramework::Mixins::ShowModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::ShowModelMixin = RESTFramework::Mixins::ShowModelMixin
-
 # Mixin for creating records.
 module RESTFramework::Mixins::CreateModelMixin
   def create
@@ -687,9 +669,6 @@ module RESTFramework::Mixins::CreateModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::CreateModelMixin = RESTFramework::Mixins::CreateModelMixin
-
 # Mixin for updating records.
 module RESTFramework::Mixins::UpdateModelMixin
   def update
@@ -704,9 +683,6 @@ module RESTFramework::Mixins::UpdateModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::UpdateModelMixin = RESTFramework::Mixins::UpdateModelMixin
-
 # Mixin for destroying records.
 module RESTFramework::Mixins::DestroyModelMixin
   def destroy
@@ -720,38 +696,39 @@ module RESTFramework::Mixins::DestroyModelMixin
   end
 end
 
-# Alias for convenience.
-RESTFramework::DestroyModelMixin = RESTFramework::Mixins::DestroyModelMixin
-
 # Mixin that includes show/list mixins.
 module RESTFramework::Mixins::ReadOnlyModelControllerMixin
-  include RESTFramework::BaseModelControllerMixin
+  include RESTFramework::Mixins::BaseModelControllerMixin
 
-  include RESTFramework::ListModelMixin
-  include RESTFramework::ShowModelMixin
+  include RESTFramework::Mixins::ListModelMixin
+  include RESTFramework::Mixins::ShowModelMixin
 
   def self.included(base)
     RESTFramework::BaseModelControllerMixin.included(base)
   end
 end
 
-# Alias for convenience.
-RESTFramework::ReadOnlyModelControllerMixin = RESTFramework::Mixins::ReadOnlyModelControllerMixin
-
 # Mixin that includes all the CRUD mixins.
 module RESTFramework::Mixins::ModelControllerMixin
-  include RESTFramework::BaseModelControllerMixin
+  include RESTFramework::Mixins::BaseModelControllerMixin
 
-  include RESTFramework::ListModelMixin
-  include RESTFramework::ShowModelMixin
-  include RESTFramework::CreateModelMixin
-  include RESTFramework::UpdateModelMixin
-  include RESTFramework::DestroyModelMixin
+  include RESTFramework::Mixins::ListModelMixin
+  include RESTFramework::Mixins::ShowModelMixin
+  include RESTFramework::Mixins::CreateModelMixin
+  include RESTFramework::Mixins::UpdateModelMixin
+  include RESTFramework::Mixins::DestroyModelMixin
 
   def self.included(base)
     RESTFramework::BaseModelControllerMixin.included(base)
   end
 end
 
-# Alias for convenience.
+# Aliases for convenience.
+RESTFramework::BaseModelControllerMixin = RESTFramework::Mixins::BaseModelControllerMixin
+RESTFramework::ListModelMixin = RESTFramework::Mixins::ListModelMixin
+RESTFramework::ShowModelMixin = RESTFramework::Mixins::ShowModelMixin
+RESTFramework::CreateModelMixin = RESTFramework::Mixins::CreateModelMixin
+RESTFramework::UpdateModelMixin = RESTFramework::Mixins::UpdateModelMixin
+RESTFramework::DestroyModelMixin = RESTFramework::Mixins::DestroyModelMixin
+RESTFramework::ReadOnlyModelControllerMixin = RESTFramework::Mixins::ReadOnlyModelControllerMixin
 RESTFramework::ModelControllerMixin = RESTFramework::Mixins::ModelControllerMixin

data/lib/rest_framework/paginators/page_number_paginator.rb

@@ -59,13 +59,24 @@ class RESTFramework::Paginators::PageNumberPaginator < RESTFramework::Paginators
 
   # Wrap the serialized page with appropriate metadata. TODO: include links.
   def get_paginated_response(serialized_page)
+    page_query_param = @controller.page_query_param
+    base_params = @controller.params.to_unsafe_h
+    next_url = if @page_number < @total_pages
+      @controller.url_for({**base_params, page_query_param => @page_number + 1})
+    end
+    previous_url = if @page_number > 1
+      @controller.url_for({**base_params, page_query_param => @page_number - 1})
+    end
+
     return {
       count: @count,
       page: @page_number,
       page_size: @page_size,
       total_pages: @total_pages,
+      next: next_url,
+      previous: previous_url,
       results: serialized_page,
-    }
+    }.compact
   end
 end
 

data/lib/rest_framework/version.rb

@@ -1,5 +1,5 @@
-# Do not use Rails-specific helper methods here (e.g., `blank?`) so the module can run standalone.
 module RESTFramework
+  # Do not use Rails-specific helper methods here (e.g., `blank?`) so the module can run standalone.
   module Version
     VERSION_FILEPATH = File.expand_path("../../VERSION", __dir__)
     UNKNOWN = "0-unknown"

data/lib/rest_framework.rb

@@ -122,9 +122,19 @@ module RESTFramework
   # Global configuration should be kept minimal, as controller-level configurations allows multiple
   # APIs to be defined to behave differently.
   class Config
-    DEFAULT_EXCLUDE_ASSOCIATION_CLASSES = [].freeze
     DEFAULT_LABEL_FIELDS = %w(name label login title email username url).freeze
     DEFAULT_SEARCH_COLUMNS = DEFAULT_LABEL_FIELDS + %w(description note).freeze
+    DEFAULT_EXCLUDE_BODY_FIELDS = %w[
+      created_at
+      created_by
+      created_by_id
+      updated_at
+      updated_by
+      updated_by_id
+      _method
+      utf8
+      authenticity_token
+    ].freeze
 
     # Do not run `rrf_finalize` on controllers automatically using a `TracePoint` hook. This is a
     # performance option and must be global because we have to determine this before any
@@ -155,6 +165,9 @@ module RESTFramework
     # The default search columns to use when generating search filters.
     attr_accessor :search_columns
 
+    # The default list of fields to exclude from the body of the request.
+    attr_accessor :exclude_body_fields
+
     # Option to use vendored assets (requires sprockets or propshaft) rather than linking to
     # external assets (the default).
     attr_accessor :use_vendored_assets
@@ -163,6 +176,7 @@ module RESTFramework
       self.show_backtrace = Rails.env.development?
       self.label_fields = DEFAULT_LABEL_FIELDS
       self.search_columns = DEFAULT_SEARCH_COLUMNS
+      self.exclude_body_fields = DEFAULT_EXCLUDE_BODY_FIELDS
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.10
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,6 +53,9 @@ files:
 - lib/rest_framework.rb
 - lib/rest_framework/engine.rb
 - lib/rest_framework/errors.rb
+- lib/rest_framework/errors/base_error.rb
+- lib/rest_framework/errors/nil_passed_to_api_response_error.rb
+- lib/rest_framework/errors/unknown_model_error.rb
 - lib/rest_framework/filters.rb
 - lib/rest_framework/filters/base_filter.rb
 - lib/rest_framework/filters/model_ordering_filter.rb