rest_framework 0.6.7 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aef3d359b16de4e6980d055031a4eb1d1ebd3f9aafa39af6b9effec8e1319d2
-  data.tar.gz: 5df89b3b8f9e6879cb6422d629743471e7641cb3b06736fdd7ddc583e6a5d182
+  metadata.gz: b74a4553ac1297795e4bb614e395e6b21a8c3ba18ef11ca36594e76bc51c3aac
+  data.tar.gz: 948044b9b604fe754aad64db509351478d869b298a87d382e19dd3a95eba7087
 SHA512:
-  metadata.gz: 01efb5108e191ad044fd64c61781cba2c2ea3e2a516f4cde1c7b3fec1fa7568ed29dda159a37440b1e59f59b6fbeb0754be4b4a37c86c0c4f94e10d81aa57ec4
-  data.tar.gz: c5302e76238dbd5fc610a9b2bea424c62646d8766f23a2a7cfe9d22ac5f4f40db99901c448696f315347e9f358756fd0d373b2003a32288d327e6ec08fa1cf75
+  metadata.gz: 42780202ca53a1e52a6c866e01c0ae428c2f54bafe3c4f2e0f7be599139f3159cade939346f8018ddc4e3b2a4ad37dbbedef5377c97e1df1e84c2f09dbd6a31d
+  data.tar.gz: 6e50a220a25ed28f1f1b0d71fdaf73a1f8fe6caf5c3130779621cb4528a5774008e6c379ad0a98c12132740d962f3dac786f0a17e9691c6b5a7e09586f96bf6e

data/VERSION

@@ -1 +1 @@
-0.6.7
+0.6.9

data/lib/rest_framework/controller_mixins/base.rb

@@ -36,23 +36,28 @@ module RESTFramework::BaseControllerMixin
       {
         filter_pk_from_request_body: true,
         exclude_body_fields: [:created_at, :created_by, :updated_at, :updated_by],
-        accept_generic_params_as_body_params: true,
+        accept_generic_params_as_body_params: false,
+        show_backtrace: false,
         extra_actions: nil,
         extra_member_actions: nil,
         filter_backends: nil,
+        singleton_controller: nil,
+        skip_actions: nil,
+
+        # Options related to serialization.
+        rescue_unknown_format_with: :json,
+        serializer_class: nil,
+        serialize_to_json: true,
+        serialize_to_xml: true,
+
+        # Options related to pagination.
         paginator_class: nil,
         page_size: 20,
         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,
-        singleton_controller: nil,
-        skip_actions: nil,
 
-        # Helper to disable serializer adapters by default, mainly introduced because Active Model
+        # Option to disable serializer adapters by default, mainly introduced because Active Model
         # Serializers will do things like serialize `[]` into `{"":[]}`.
         disable_adapters_by_default: true,
       }.each do |a, default|
@@ -83,6 +88,7 @@ module RESTFramework::BaseControllerMixin
       base.rescue_from(ActiveRecord::RecordInvalid, with: :record_invalid)
       base.rescue_from(ActiveRecord::RecordNotSaved, with: :record_not_saved)
       base.rescue_from(ActiveRecord::RecordNotDestroyed, with: :record_not_destroyed)
+      base.rescue_from(ActiveModel::UnknownAttributeError, with: :unknown_attribute_error)
     end
   end
 
@@ -126,23 +132,46 @@ module RESTFramework::BaseControllerMixin
 
   def record_invalid(e)
     return api_response(
-      {message: "Record invalid.", exception: e, errors: e.record&.errors}, status: 400
+      {
+        message: "Record invalid.", errors: e.record&.errors
+      }.merge(self.class.show_backtrace ? {exception: e.full_message} : {}),
+      status: 400,
     )
   end
 
   def record_not_found(e)
-    return api_response({message: "Record not found.", exception: e}, status: 404)
+    return api_response(
+      {
+        message: "Record not found.",
+      }.merge(self.class.show_backtrace ? {exception: e.full_message} : {}),
+      status: 404,
+    )
   end
 
   def record_not_saved(e)
     return api_response(
-      {message: "Record not saved.", exception: e, errors: e.record&.errors}, status: 406
+      {
+        message: "Record not saved.", errors: e.record&.errors
+      }.merge(self.class.show_backtrace ? {exception: e.full_message} : {}),
+      status: 400,
     )
   end
 
   def record_not_destroyed(e)
     return api_response(
-      {message: "Record not destroyed.", exception: e, errors: e.record&.errors}, status: 406
+      {
+        message: "Record not destroyed.", errors: e.record&.errors
+      }.merge(self.class.show_backtrace ? {exception: e.full_message} : {}),
+      status: 400,
+    )
+  end
+
+  def unknown_attribute_error(e)
+    return api_response(
+      {
+        message: e.message.capitalize,
+      }.merge(self.class.show_backtrace ? {exception: e.full_message} : {}),
+      status: 400,
     )
   end
 

data/lib/rest_framework/controller_mixins/models.rb

@@ -125,17 +125,17 @@ module RESTFramework::BaseModelControllerMixin
   def get_body_params
     # 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)
+    allowed_params = self.get_allowed_parameters&.map(&:to_s)
+    body_params = if allowed_params
       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. If fields are not defined,
-    # fallback to using columns for this particular feature.
-    if self.class.accept_generic_params_as_body_params
-      (self.get_fields(fallback: true) - body_params.keys).each do |k|
-        if (value = params[k])
+    # Add query params in place of missing body params, if configured.
+    if self.class.accept_generic_params_as_body_params && allowed_params
+      (allowed_params - body_params.keys).each do |k|
+        if value = params[k].presence
           body_params[k] = value
         end
       end
@@ -238,10 +238,16 @@ module RESTFramework::ListModelMixin
 
     # Handle pagination, if enabled.
     if self.class.paginator_class
-      paginator = self.class.paginator_class.new(data: records, controller: self)
-      page = paginator.get_page
-      serialized_page = self.serialize(page)
-      return paginator.get_paginated_response(serialized_page)
+      # If there is no `max_page_size`, `page_size_query_param` is not `nil`, and the page size is
+      # set to "0", then skip pagination.
+      unless !self.class.max_page_size &&
+          self.class.page_size_query_param &&
+          params[self.class.page_size_query_param] == "0"
+        paginator = self.class.paginator_class.new(data: records, controller: self)
+        page = paginator.get_page
+        serialized_page = self.serialize(page)
+        return paginator.get_paginated_response(serialized_page)
+      end
     end
 
     return records

metadata

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