rest_framework 0.3.0 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4c53fa557df9090c749745efce556214252b76e2115df09917970e9a9c8b5e
-  data.tar.gz: 5c33946ae697618f726532e9b45056f2e112d3f81f6efb5c9a37ab8d9b3b002e
+  metadata.gz: 86f1b6f94bf7074dd30cf16be9f07fdc83df2bd477e09584f12882456e1405cf
+  data.tar.gz: b0d8bacaac76492876f13e8f402bb090a3e490f3bbf6656c88efb3cf52d2d1c8
 SHA512:
-  metadata.gz: ddfd6544b96284e871684d2f448e622631bd88631ea78ebe4170d2ff2fe4f1654901ef86a96584e3c5d0a2538bcef5d29f85152795aa689df58fc98cb05f7b3b
-  data.tar.gz: 1ab60515fcf543c0df574a6cf3913648736d19d559b1d9fbe55f891ce3e6926026357369580430ada33b6e294a081d8058b297bb3f146b3d17f4671b10683d55
+  metadata.gz: '02179633392aa9f9e7c873e38bcacfb1cd7c93b5caeef57c2ec112707b16fc069cae17686d899d4d6bf5cb0582dff469bac38e71081f7b5f20b5915298e6eb44'
+  data.tar.gz: 432da0162809905fc29e93194d616561ee0b9d93c23b194e77792fb9a7814062ae10025986c466510d3d5adfe2e4300de4104213444a30835626ed17c076f7b4

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.6

data/lib/rest_framework/controller_mixins/base.rb

@@ -182,9 +182,9 @@ module RESTFramework::BaseControllerMixin
         hkwargs = kwargs.merge(html_kwargs)
         begin
           render(**hkwargs)
-        rescue ActionView::MissingTemplate  # fallback to rest_framework layout/view
+        rescue ActionView::MissingTemplate  # fallback to rest_framework layout
           hkwargs[:layout] = "rest_framework"
-          hkwargs[:template] = "rest_framework/default"
+          hkwargs[:html] = ''
           render(**hkwargs)
         end
       }

data/lib/rest_framework/controller_mixins/models.rb

@@ -37,6 +37,10 @@ module RESTFramework::BaseModelControllerMixin
         filterset_fields: nil,
         ordering_fields: nil,
         ordering_query_param: 'ordering',
+        ordering_no_reorder: false,
+        search_fields: nil,
+        search_query_param: 'search',
+        search_ilike: false,
 
         # Other misc attributes.
         create_from_recordset: true,  # Option for `recordset.create` vs `Model.create` behavior.
@@ -89,6 +93,11 @@ module RESTFramework::BaseModelControllerMixin
     return self.class.ordering_fields&.map(&:to_s) || self.get_fields
   end
 
+  # Get a list of search fields for the current action.
+  def get_search_fields
+    return self.class.search_fields&.map(&:to_s) || self.get_fields
+  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)

data/lib/rest_framework/errors.rb

@@ -14,15 +14,3 @@ class RESTFramework::NilPassedToAPIResponseError < RESTFramework::Error
     MSG
   end
 end
-
-
-class RESTFramework::UnserializableError < RESTFramework::Error
-  def initialize(object)
-    @object = object
-    return super
-  end
-
-  def message
-    return "Unable to serialize `#{@object.inspect}` (of type `#{@object.class}`)."
-  end
-end

data/lib/rest_framework/filters.rb

@@ -15,7 +15,7 @@ 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.send(:get_filterset_fields)
-    return @controller.request.query_parameters.select { |p|
+    return @controller.request.query_parameters.select { |p, _|
       fields.include?(p)
     }.to_h.symbolize_keys  # convert from HashWithIndifferentAccess to Hash w/keys
   end
@@ -38,8 +38,8 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
   def _get_ordering
     return nil if @controller.class.ordering_query_param.blank?
     ordering_fields = @controller.send(:get_ordering_fields)
-
     order_string = @controller.params[@controller.class.ordering_query_param]
+
     unless order_string.blank?
       ordering = {}
       order_string.split(',').each do |field|
@@ -63,14 +63,31 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
   # Order data according to the request query parameters.
   def get_filtered_data(data)
     ordering = self._get_ordering
+    reorder = !@controller.send(:ordering_no_reorder)
+
     if ordering && !ordering.empty?
-      return data.order(_get_ordering)
+      return data.send(reorder ? :reorder : :order, _get_ordering)
     end
+
     return data
   end
 end
 
 
-# TODO: implement searching within fields rather than exact match filtering (ModelFilter)
-# class RESTFramework::ModelSearchFilter < RESTFramework::BaseFilter
-# end
+# Multi-field text searching on models.
+class RESTFramework::ModelSearchFilter < RESTFramework::BaseFilter
+  # Filter data according to the request query parameters.
+  def get_filtered_data(data)
+    fields = @controller.send(:get_search_fields)
+    search = @controller.request.query_parameters[@controller.send(:search_query_param)]
+
+    # Ensure we use array conditions to prevent SQL injection.
+    unless search.blank?
+      return data.where(fields.map { |f|
+        "CAST(#{f} AS CHAR) #{@controller.send(:search_ilike) ? "ILIKE" : "LIKE"} ?"
+      }.join(' OR '), *(["%#{search}%"] * fields.length))
+    end
+
+    return data
+  end
+end

data/lib/rest_framework/paginators.rb

@@ -83,6 +83,7 @@ class RESTFramework::PageNumberPaginator < RESTFramework::BasePaginator
     return {
       count: @count,
       page: @page_number,
+      page_size: @page_size,
       total_pages: @total_pages,
       results: serialized_page,
     }

data/lib/rest_framework/serializers.rb

@@ -105,18 +105,12 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
 
   # Convert the object (record or recordset) to Ruby primitives.
   def serialize
-    if @object
-      begin
-        if @object.is_a?(Enumerable)
-          return @object.map { |r| r.serializable_hash(self.get_serializer_config) }
-        end
-        return @object.serializable_hash(self.get_serializer_config)
-      rescue NoMethodError
-      end
-    end
+    raise "No object available to serialize!" unless @object
 
-    # Raise an error if we cannot serialize the object.
-    raise RESTFramework::UnserializableError.new(@object)
+    if @object.is_a?(Enumerable)
+      return @object.map { |r| r.serializable_hash(self.get_serializer_config) }
+    end
+    return @object.serializable_hash(self.get_serializer_config)
   end
 
   # Allow a serializer instance to be used as a hash directly in a nested serializer config.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.6
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-11 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,7 +37,6 @@ files:
 - app/views/layouts/rest_framework.html.erb
 - app/views/rest_framework/_head.html.erb
 - app/views/rest_framework/_routes.html.erb
-- app/views/rest_framework/default.html.erb
 - lib/rest_framework.rb
 - lib/rest_framework/controller_mixins.rb
 - lib/rest_framework/controller_mixins/base.rb
@@ -73,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A framework for DRY RESTful APIs in Ruby on Rails.