rest_framework 0.5.6 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a0533297190fd34ec007578f495d67ef19e3e02b7b495b8be004dd2180f6b2
-  data.tar.gz: 07f5478177e47bae6476c42587b10b698a862bbcfa762497a7bd11ebb5cf324e
+  metadata.gz: 33c45fc367d9899fa2e47ea4c042a46ed381986e9210bf4574b61d1301c60fcc
+  data.tar.gz: 225adc8d9b5380e7e403765d7ec21331a61c9a8c562013781571dc84037560d0
 SHA512:
-  metadata.gz: d971192a3c797b69e9e7982f2f7e381b7fa2784db39e592c56f3640683985424e40a52e28a0ff503f0c22ad2b0cedbd828ba5b4461e354abe36d5d9e8c01c370
-  data.tar.gz: 22f0d3779328a0c5dccb382674d44dfea4a5cffea92b96614366d9cbfa570ce436ea5774c13a16f524b995c54074d5ad5d979e82d081d2f012f89923f55339f6
+  metadata.gz: 7178418a52918caf797f2a96bd1d39a5e8291d154ba335122b590e5534cc02124f5203feb24dade1f5dcb84ac45b281a7e4fb30274be943025e2f7850bd1cfca
+  data.tar.gz: e4195747856948df06aa0c396812d6ea3bbd3d374318b3c9f7a60c55747ae62db25ef76fc59e0705fd1531822304c62a416151772d29877aa4b723852015f2db

data/VERSION

@@ -1 +1 @@
-0.5.6
+0.6.1

data/lib/rest_framework/controller_mixins/base.rb

@@ -45,6 +45,7 @@ module RESTFramework::BaseControllerMixin
         page_query_param: "page",
         page_size_query_param: "page_size",
         max_page_size: nil,
+        rescue_unknown_format_with: :json,
         serializer_class: nil,
         serialize_to_json: true,
         serialize_to_xml: true,
@@ -145,42 +146,55 @@ module RESTFramework::BaseControllerMixin
       raise RESTFramework::NilPassedToAPIResponseError
     end
 
-    respond_to do |format|
-      if payload == ""
-        format.json { head(:no_content) } if self.class.serialize_to_json
-        format.xml { head(:no_content) } if self.class.serialize_to_xml
-      else
-        format.json {
-          jkwargs = kwargs.merge(json_kwargs)
-          render(json: payload, layout: false, **jkwargs)
-        } if self.class.serialize_to_json
-        format.xml {
-          xkwargs = kwargs.merge(xml_kwargs)
-          render(xml: payload, layout: false, **xkwargs)
-        } if self.class.serialize_to_xml
-        # TODO: possibly support more formats here if supported?
-      end
-      format.html {
-        @payload = payload
+    # Flag to track if we had to rescue unknown format.
+    already_rescued_unknown_format = false
+
+    begin
+      respond_to do |format|
         if payload == ""
-          @json_payload = "" if self.class.serialize_to_json
-          @xml_payload = "" if self.class.serialize_to_xml
+          format.json { head(:no_content) } if self.class.serialize_to_json
+          format.xml { head(:no_content) } if self.class.serialize_to_xml
         else
-          @json_payload = payload.to_json if self.class.serialize_to_json
-          @xml_payload = payload.to_xml if self.class.serialize_to_xml
-        end
-        @template_logo_text ||= "Rails REST Framework"
-        @title ||= self.controller_name.camelize
-        @route_groups ||= RESTFramework::Utils.get_routes(Rails.application.routes, request)
-        hkwargs = kwargs.merge(html_kwargs)
-        begin
-          render(**hkwargs)
-        rescue ActionView::MissingTemplate  # fallback to rest_framework layout
-          hkwargs[:layout] = "rest_framework"
-          hkwargs[:html] = ""
-          render(**hkwargs)
+          format.json {
+            jkwargs = kwargs.merge(json_kwargs)
+            render(json: payload, layout: false, **jkwargs)
+          } if self.class.serialize_to_json
+          format.xml {
+            xkwargs = kwargs.merge(xml_kwargs)
+            render(xml: payload, layout: false, **xkwargs)
+          } if self.class.serialize_to_xml
+          # TODO: possibly support more formats here if supported?
         end
-      }
+        format.html {
+          @payload = payload
+          if payload == ""
+            @json_payload = "" if self.class.serialize_to_json
+            @xml_payload = "" if self.class.serialize_to_xml
+          else
+            @json_payload = payload.to_json if self.class.serialize_to_json
+            @xml_payload = payload.to_xml if self.class.serialize_to_xml
+          end
+          @template_logo_text ||= "Rails REST Framework"
+          @title ||= self.controller_name.camelize
+          @route_groups ||= RESTFramework::Utils.get_routes(Rails.application.routes, request)
+          hkwargs = kwargs.merge(html_kwargs)
+          begin
+            render(**hkwargs)
+          rescue ActionView::MissingTemplate  # fallback to rest_framework layout
+            hkwargs[:layout] = "rest_framework"
+            hkwargs[:html] = ""
+            render(**hkwargs)
+          end
+        }
+      end
+    rescue ActionController::UnknownFormat
+      if !already_rescued_unknown_format && rescue_format = self.class.rescue_unknown_format_with
+        request.format = rescue_format
+        already_rescued_unknown_format = true
+        retry
+      else
+        raise
+      end
     end
   end
 end

data/lib/rest_framework/controller_mixins/models.rb

@@ -59,7 +59,7 @@ module RESTFramework::BaseModelControllerMixin
   end
 
   def _get_specific_action_config(action_config_key, generic_config_key)
-    action_config = self.class.send(action_config_key) || {}
+    action_config = self.class.send(action_config_key)&.with_indifferent_access || {}
     action = self.action_name&.to_sym
 
     # Index action should use :list serializer if :index is not provided.
@@ -68,38 +68,45 @@ module RESTFramework::BaseModelControllerMixin
     return (action_config[action] if action) || self.class.send(generic_config_key)
   end
 
-  # Get a list of fields for the current action.
-  def get_fields
-    return (
-      _get_specific_action_config(:action_fields, :fields)&.map(&:to_s) ||
-      self.get_model&.column_names ||
-      []
-    )
+  # Get a list of fields for the current action. Returning `nil` indicates that anything should be
+  # accepted unless `fallback` is true, in which case we should fallback to this controller's model
+  # columns, or en empty array.
+  def get_fields(fallback: false)
+    fields = _get_specific_action_config(:action_fields, :fields)
+
+    if fallback
+      fields ||= self.get_model&.column_names || []
+    end
+
+    return fields
   end
 
   # Get a list of find_by fields for the current action.
   def get_find_by_fields
-    return self.class.find_by_fields&.map(&:to_s) || self.get_fields
+    return self.class.find_by_fields || self.get_fields
   end
 
-  # Get a list of find_by fields for the current action.
+  # Get a list of find_by fields for the current action. Default to the model column names.
   def get_filterset_fields
-    return self.class.filterset_fields&.map(&:to_s) || self.get_fields
+    return self.class.filterset_fields || self.get_fields(fallback: true)
   end
 
   # Get a list of ordering fields for the current action.
   def get_ordering_fields
-    return self.class.ordering_fields&.map(&:to_s) || self.get_fields
+    return self.class.ordering_fields || self.get_fields
   end
 
-  # Get a list of search fields for the current action.
+  # Get a list of search fields for the current action. Default to the model column names.
   def get_search_fields
-    return self.class.search_fields&.map(&:to_s) || self.get_fields
+    return self.class.search_fields || self.get_fields(fallback: true)
   end
 
   # Get a list of parameters allowed for the current action.
   def get_allowed_parameters
-    return _get_specific_action_config(:allowed_action_parameters, :allowed_parameters)&.map(&:to_s)
+    return _get_specific_action_config(
+      :allowed_action_parameters,
+      :allowed_parameters,
+    ) || self.fields
   end
 
   # Helper to get the configured serializer class, or `NativeSerializer` as a default.
@@ -117,14 +124,18 @@ module RESTFramework::BaseModelControllerMixin
   # Filter the request body for keys in current action's allowed_parameters/fields config.
   def get_body_params
     return @_get_body_params ||= begin
-      fields = self.get_allowed_parameters || self.get_fields
-
-      # Filter the request body.
-      body_params = request.request_parameters.select { |p| fields.include?(p) }
+      # Filter the request body and map to strings. Return all params if we cannot resolve a list of
+      # allowed parameters or fields.
+      body_params = if allowed_params = self.get_allowed_parameters&.map(&:to_s)
+        request.request_parameters.select { |p| allowed_params.include?(p) }
+      else
+        request.request_parameters
+      end
 
-      # Add query params in place of missing body params, if configured.
+      # Add query params in place of missing body params, if configured. If fields are not defined,
+      # fallback to using columns for this particular feature.
       if self.class.accept_generic_params_as_body_params
-        (fields - body_params.keys).each do |k|
+        (self.get_fields(fallback: true) - body_params.keys).each do |k|
           if (value = params[k])
             body_params[k] = value
           end
@@ -137,7 +148,7 @@ module RESTFramework::BaseModelControllerMixin
       end
 
       # Filter fields in exclude_body_fields.
-      (self.class.exclude_body_fields || []).each { |f| body_params.delete(f.to_s) }
+      (self.class.exclude_body_fields || []).each { |f| body_params.delete(f) }
 
       body_params
     end
@@ -181,13 +192,21 @@ module RESTFramework::BaseModelControllerMixin
 
   # Get a single record by primary key or another column, if allowed.
   def get_record
+    # Cache the result.
+    return @_get_record if @_get_record
+
     recordset = self.get_recordset
-    find_by_fields = self.get_find_by_fields
     find_by_key = self.get_model.primary_key
 
     # Find by another column if it's permitted.
-    if find_by_query_param && params[find_by_query_param].in?(find_by_fields)
-      find_by_key = params[find_by_query_param]
+    if find_by_param = self.class.find_by_query_param.presence
+      if find_by = params[find_by_param].presence
+        find_by_fields = self.get_find_by_fields&.map(&:to_s)
+
+        if !find_by_fields || find_by.in?(find_by_fields)
+          find_by_key = find_by
+        end
+      end
     end
 
     # Filter recordset, if configured.
@@ -196,18 +215,18 @@ module RESTFramework::BaseModelControllerMixin
     end
 
     # Return the record. Route key is always :id by Rails convention.
-    return recordset.find_by!(find_by_key => params[:id])
+    return @_get_record = recordset.find_by!(find_by_key => params[:id])
   end
 end
 
 # Mixin for listing records.
 module RESTFramework::ListModelMixin
   def index
-    api_response(self._index)
+    api_response(self.index!)
   end
 
-  def _index
-    @records = self.get_filtered_data(self.get_recordset)
+  def index!
+    @records ||= self.get_filtered_data(self.get_recordset)
 
     # Handle pagination, if enabled.
     if self.class.paginator_class
@@ -224,11 +243,11 @@ end
 # Mixin for showing records.
 module RESTFramework::ShowModelMixin
   def show
-    api_response(self._show)
+    api_response(self.show!)
   end
 
-  def _show
-    @record = self.get_record
+  def show!
+    @record ||= self.get_record
     return self.get_serializer_class.new(@record, controller: self).serialize
   end
 end
@@ -236,16 +255,16 @@ end
 # Mixin for creating records.
 module RESTFramework::CreateModelMixin
   def create
-    api_response(self._create)
+    api_response(self.create!)
   end
 
-  def _create
+  def create!
     if self.get_recordset.respond_to?(:create!) && self.create_from_recordset
       # Create with any properties inherited from the recordset.
-      @record = self.get_recordset.create!(self.get_create_params)
+      @record ||= self.get_recordset.create!(self.get_create_params)
     else
       # Otherwise, perform a "bare" create.
-      @record = self.get_model.create!(self.get_create_params)
+      @record ||= self.get_model.create!(self.get_create_params)
     end
 
     return self.get_serializer_class.new(@record, controller: self).serialize
@@ -255,11 +274,11 @@ end
 # Mixin for updating records.
 module RESTFramework::UpdateModelMixin
   def update
-    api_response(self._update)
+    api_response(self.update!)
   end
 
-  def _update
-    @record = self.get_record
+  def update!
+    @record ||= self.get_record
     @record.update!(self.get_update_params)
     return self.get_serializer_class.new(@record, controller: self).serialize
   end
@@ -268,12 +287,12 @@ end
 # Mixin for destroying records.
 module RESTFramework::DestroyModelMixin
   def destroy
-    self._destroy
+    self.destroy!
     api_response("")
   end
 
-  def _destroy
-    @record = self.get_record
+  def destroy!
+    @record ||= self.get_record
     @record.destroy!
   end
 end

data/lib/rest_framework/filters.rb

@@ -13,15 +13,17 @@ end
 class RESTFramework::ModelFilter < RESTFramework::BaseFilter
   # Filter params for keys allowed by the current action's filterset_fields/fields config.
   def _get_filter_params
-    fields = @controller.get_filterset_fields
-    return @controller.request.query_parameters.select { |p, _|
-      fields.include?(p)
-    }.to_h.symbolize_keys  # convert from HashWithIndifferentAccess to Hash w/keys
+    # Map filterset fields to strings because query parameter keys are strings.
+    if fields = @controller.get_filterset_fields&.map(&:to_s)
+      return @controller.request.query_parameters.select { |p, _| fields.include?(p) }
+    end
+
+    return @controller.request.query_parameters.to_h
   end
 
   # Filter data according to the request query parameters.
   def get_filtered_data(data)
-    filter_params = self._get_filter_params
+    filter_params = self._get_filter_params.symbolize_keys
     unless filter_params.blank?
       return data.where(**filter_params)
     end
@@ -36,11 +38,12 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
   def _get_ordering
     return nil if @controller.class.ordering_query_param.blank?
 
-    ordering_fields = @controller.get_ordering_fields
+    # Ensure ordering_fields are strings since the split param will be strings.
+    ordering_fields = @controller.get_ordering_fields&.map(&:to_s)
     order_string = @controller.params[@controller.class.ordering_query_param]
 
     unless order_string.blank?
-      ordering = {}
+      ordering = {}.with_indifferent_access
       order_string.split(",").each do |field|
         if field[0] == "-"
           column = field[1..-1]
@@ -49,8 +52,8 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
           column = field
           direction = :asc
         end
-        if column.in?(ordering_fields)
-          ordering[column.to_sym] = direction
+        if !ordering_fields || column.in?(ordering_fields)
+          ordering[column] = direction
         end
       end
       return ordering

data/lib/rest_framework/routers.rb

@@ -6,7 +6,7 @@ module ActionDispatch::Routing
     # Internal interface to get the controller class from the name and current scope.
     def _get_controller_class(name, pluralize: true, fallback_reverse_pluralization: true)
       # Get class name.
-      name = name.to_s.camelize  # camelize to leave plural names plural
+      name = name.to_s.camelize  # Camelize to leave plural names plural.
       name = name.pluralize if pluralize
       if name == name.pluralize
         name_reverse = name.singularize

data/lib/rest_framework/serializers.rb

@@ -212,9 +212,8 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
       return serializer_config.deep_dup
     end
 
-    # If the config wasn't determined, build a serializer config from model fields.
-    fields = @controller.get_fields if @controller
-    if fields
+    # If the config wasn't determined, build a serializer config from controller fields.
+    if fields = @controller&.get_fields
       fields = fields.deep_dup
 
       if @model

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.1
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-20 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails