rest_framework 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4c53fa557df9090c749745efce556214252b76e2115df09917970e9a9c8b5e
-  data.tar.gz: 5c33946ae697618f726532e9b45056f2e112d3f81f6efb5c9a37ab8d9b3b002e
+  metadata.gz: cb9085823972b6991c739761eb1ec47ce012e9b0c40e0215199b1cc1f2e681c0
+  data.tar.gz: 7c211b54982077d586d35cd0c04401f1e7ec54cd5363234f5832651f605aee5d
 SHA512:
-  metadata.gz: ddfd6544b96284e871684d2f448e622631bd88631ea78ebe4170d2ff2fe4f1654901ef86a96584e3c5d0a2538bcef5d29f85152795aa689df58fc98cb05f7b3b
-  data.tar.gz: 1ab60515fcf543c0df574a6cf3913648736d19d559b1d9fbe55f891ce3e6926026357369580430ada33b6e294a081d8058b297bb3f146b3d17f4671b10683d55
+  metadata.gz: a92b41406fa3d2723fe29e53ff38c129453b3357e6d21f51fb79de797812a2d20ea0dd5936ace48834084d00887658daf7be63bbb65e98d7cb7eee21fbe2fd89
+  data.tar.gz: 652d9e6c68f1688202d7ee52617bb73491f358afffcd99960bda6edc3acf2a6dd2942e278bcfeb7e86876754f16d9b8911af716b61eb179f021188ecd61e9dc8

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

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,9 @@ module RESTFramework::BaseModelControllerMixin
         filterset_fields: nil,
         ordering_fields: nil,
         ordering_query_param: 'ordering',
+        search_fields: nil,
+        search_query_param: 'search',
+        search_case_sensitive: false,
 
         # Other misc attributes.
         create_from_recordset: true,  # Option for `recordset.create` vs `Model.create` behavior.
@@ -89,6 +92,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/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
@@ -71,6 +71,20 @@ class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
 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 text) #{@controller.send(:search_case_sensitive) ? "LIKE" : "ILIKE"} ?"
+      }.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,
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-11 00:00:00.000000000 Z
+date: 2021-05-07 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.