rest_framework 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 365696e92f267b3c3547bc6fed9ad2cfcbc1a3cc769ee7128332cc469a534eec
-  data.tar.gz: bde678de3e2c11847f3777b057b5d267f75185c23a997fe704acaab6a36ad23d
+  metadata.gz: 207b074408e0f95dd2d289abdd7d048f66f44d38f795b45b51245af28376a1c4
+  data.tar.gz: 67729758c21dd7627419248801d85f929188c64f2b20dba9095938a9650259da
 SHA512:
-  metadata.gz: 527ffee7ac29d26d0405c6ff6dba94c2d5d7e8ba505b2c6f42860fb67d782fc2b180ddaeb462947b918b84818fd30633a8290bde5d2558ced238b5a28bd9eab8
-  data.tar.gz: 6d56d27874e79beea8ce627fc85b0841e3a2d1cc864a7664a07ef54279216e8da80f13061ed07f3761c1da9ae570906387331c21f946c9bef102adab2bb56b6c
+  metadata.gz: 8dd2c8c6209b04ffa77fe1506906332c9beb3e87ee60bad2f348ab5331258b46fe66fc3ced5048b66472c424b84132746fbca650b82faa87415c1a36b41c16c2
+  data.tar.gz: d04ceada0800c54161cfaeccb3d43251c3ae3bd5c629a937da058c0be640c0287453ac3338744d36e0290aea536b4987f56e76b0ace999580bd90adbd14d85c1

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.2

data/lib/rest_framework/controller_mixins/models.rb

@@ -68,16 +68,17 @@ 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(fallback: true)
-    action_fields = _get_specific_action_config(:action_fields, :fields)
+  # 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)
 
-    # Typically we want to fallback to either the DB dolumns or an empty array.
     if fallback
-      action_fields ||= self.get_model&.column_names || []
+      fields ||= self.get_model&.column_names || []
     end
 
-    return action_fields
+    return fields
   end
 
   # Get a list of find_by fields for the current action.
@@ -85,9 +86,9 @@ module RESTFramework::BaseModelControllerMixin
     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 || self.get_fields
+    return self.class.filterset_fields || self.get_fields(fallback: true)
   end
 
   # Get a list of ordering fields for the current action.
@@ -95,14 +96,17 @@ module RESTFramework::BaseModelControllerMixin
     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 || 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)
+    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.
@@ -120,15 +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
-      # Map fields to strings because body keys will be string.
-      fields = (self.get_allowed_parameters || self.get_fields).map(&:to_s)
-
-      # 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
@@ -189,14 +196,17 @@ module RESTFramework::BaseModelControllerMixin
     return @_get_record if @_get_record
 
     recordset = self.get_recordset
-
-    # Map find_by fields to strings because query param value is a string.
-    find_by_fields = self.get_find_by_fields.map(&:to_s)
     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.
@@ -250,8 +260,10 @@ module RESTFramework::CreateModelMixin
 
   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)
+      # 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`.
+      @record ||= self.get_recordset.except(:select).create!(self.get_create_params)
     else
       # Otherwise, perform a "bare" create.
       @record ||= self.get_model.create!(self.get_create_params)

data/lib/rest_framework/filters.rb

@@ -14,9 +14,11 @@ class RESTFramework::ModelFilter < RESTFramework::BaseFilter
   # Filter params for keys allowed by the current action's filterset_fields/fields config.
   def _get_filter_params
     # Map filterset fields to strings because query parameter keys are strings.
-    fields = @controller.get_filterset_fields.map(&:to_s)
+    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.select { |p, _| fields.include?(p) }
+    return @controller.request.query_parameters.to_h
   end
 
   # Filter data according to the request query parameters.
@@ -37,7 +39,7 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
     return nil if @controller.class.ordering_query_param.blank?
 
     # Ensure ordering_fields are strings since the split param will be strings.
-    ordering_fields = @controller.get_ordering_fields.map(&:to_s)
+    ordering_fields = @controller.get_ordering_fields&.map(&:to_s)
     order_string = @controller.params[@controller.class.ordering_query_param]
 
     unless order_string.blank?
@@ -50,7 +52,7 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
           column = field
           direction = :asc
         end
-        if column.in?(ordering_fields)
+        if !ordering_fields || column.in?(ordering_fields)
           ordering[column] = direction
         end
       end

data/lib/rest_framework/paginators.rb

@@ -21,7 +21,8 @@ end
 class RESTFramework::PageNumberPaginator < RESTFramework::BasePaginator
   def initialize(**kwargs)
     super
-    @count = @data.count
+    # Exclude any `select` clauses since that would cause `count` to fail with a SQL `SyntaxError`.
+    @count = @data.except(:select).count
     @page_size = self._page_size
 
     @total_pages = @count / @page_size

data/lib/rest_framework/serializers.rb

@@ -213,8 +213,7 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
     end
 
     # If the config wasn't determined, build a serializer config from controller fields.
-    fields = @controller.get_fields(fallback: false) if @controller
-    if 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.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails