rest_framework 0.2.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d9ce4741f59e6f68bfa18bc2e6c11202c91fbe251eeaa5562f8f718e6e8afaa
-  data.tar.gz: 652ad42a8d0bad99e552af9117112df707e67d4c1e6dd2dd983e7925933fcab6
+  metadata.gz: dc5065eb969e4616e6a0e22717a4398940b3696a43182d6e8b526e225f6c81f3
+  data.tar.gz: 3efcfdfa6abfe7343770c8241e83d34bc1e02bcbd145826bc8a9709514b8b5f7
 SHA512:
-  metadata.gz: 26036468d40ccc77a203981ba442265ef82c7a991fee800ee3d7925d96d09a696f3db06930e8252c49cf63e86d2aee2fd121a735e5e06609585299ff984d6992
-  data.tar.gz: 3c53d8eed996e380ab3390acfde7a3cef262d38a1355d0016aa6d8129b8e329c99003c0181ec1602f5bb1ba8869355e6b1eb0ff366d8b814ff83f6bb3c9cbf4d
+  metadata.gz: 170b7b9ebb18b9527d1e9216a0456af154284ab8935d1ddcc367815bf73c86379ae83340f6a259f6b4324d5c4cf32eae740a28210a1ce963427ef96a870ae016
+  data.tar.gz: a6148d463fa2eda9dc6f19dc89646a78b922a93bdcf6f147707343d218a9501e8bebe67d8182d75a946968d59b27a0f030d08349268297799bc4886b780f6aa4

data/VERSION

@@ -0,0 +1 @@
+0.3.5

data/lib/rest_framework/controller_mixins/base.rb

@@ -79,8 +79,12 @@ module RESTFramework::BaseControllerMixin
 
   protected
 
-  # Helper to get filtering backends with a sane default.
-  # @return [RESTFramework::BaseFilter]
+  # Helper to get the configured serializer class.
+  def get_serializer_class
+    return self.class.serializer_class
+  end
+
+  # Helper to get filtering backends, defaulting to no backends.
   def get_filter_backends
     return self.class.filter_backends || []
   end
@@ -95,16 +99,10 @@ module RESTFramework::BaseControllerMixin
     return data
   end
 
-  # Helper to get the configured serializer class.
-  # @return [RESTFramework::BaseSerializer]
-  def get_serializer_class
-    return self.class.serializer_class
-  end
-
   def record_invalid(e)
-    return api_response(
-      {message: "Record invalid.", exception: e, errors: e.record.errors}, status: 400
-    )
+    return api_response({
+      message: "Record invalid.", exception: e, errors: e.record&.errors
+    }, status: 400)
   end
 
   def record_not_found(e)
@@ -112,11 +110,15 @@ module RESTFramework::BaseControllerMixin
   end
 
   def record_not_saved(e)
-    return api_response({message: "Record not saved.", exception: e}, status: 406)
+    return api_response({
+      message: "Record not saved.", exception: e, errors: e.record&.errors
+    }, status: 406)
   end
 
   def record_not_destroyed(e)
-    return api_response({message: "Record not destroyed.", exception: e}, status: 406)
+    return api_response({
+      message: "Record not destroyed.", exception: e, errors: e.record&.errors
+    }, status: 406)
   end
 
   # Helper for showing routes under a controller action, used for the browsable API.
@@ -180,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

@@ -20,6 +20,10 @@ module RESTFramework::BaseModelControllerMixin
         fields: nil,
         action_fields: nil,
 
+        # Attributes for finding records.
+        find_by_fields: nil,
+        find_by_query_param: 'find_by',
+
         # Attributes for create/update parameters.
         allowed_parameters: nil,
         allowed_action_parameters: nil,
@@ -33,9 +37,14 @@ 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.
-        disable_creation_from_recordset: false,  # Option to disable `recordset.create` behavior.
+        create_from_recordset: true,  # Option for `recordset.create` vs `Model.create` behavior.
+        filter_recordset_before_find: true,  # Option to control if filtering is done before find.
       }.each do |a, default|
         unless base.respond_to?(a)
           base.class_attribute(a)
@@ -60,11 +69,6 @@ module RESTFramework::BaseModelControllerMixin
     return (action_config[action] if action) || self.class.send(generic_config_key)
   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)
-  end
-
   # Get a list of fields for the current action.
   def get_fields
     return (
@@ -74,14 +78,37 @@ module RESTFramework::BaseModelControllerMixin
     )
   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
+  end
+
+  # Get a list of find_by fields for the current action.
+  def get_filterset_fields
+    return self.class.filterset_fields&.map(&:to_s) || self.get_fields
+  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
+  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)
+  end
+
   # Helper to get the configured serializer class, or `NativeSerializer` as a default.
-  # @return [RESTFramework::BaseSerializer]
   def get_serializer_class
     return self.class.serializer_class || RESTFramework::NativeSerializer
   end
 
-  # Get the list of filtering backends to use.
-  # @return [RESTFramework::BaseFilter]
+  # Helper to get filtering backends, defaulting to using `ModelFilter` and `ModelOrderingFilter`.
   def get_filter_backends
     return self.class.filter_backends || [
       RESTFramework::ModelFilter, RESTFramework::ModelOrderingFilter
@@ -94,9 +121,7 @@ module RESTFramework::BaseModelControllerMixin
       fields = self.get_allowed_parameters || self.get_fields
 
       # Filter the request body.
-      body_params = request.request_parameters.select { |p|
-        fields.include?(p)
-      }
+      body_params = request.request_parameters.select { |p| fields.include?(p) }
 
       # Add query params in place of missing body params, if configured.
       if self.class.accept_generic_params_as_body_params
@@ -113,9 +138,7 @@ module RESTFramework::BaseModelControllerMixin
       end
 
       # Filter fields in exclude_body_fields.
-      (self.class.exclude_body_fields || []).each do |f|
-        body_params.delete(f.to_s)
-      end
+      (self.class.exclude_body_fields || []).each { |f| body_params.delete(f.to_s) }
 
       body_params
     end
@@ -123,14 +146,6 @@ module RESTFramework::BaseModelControllerMixin
   alias :get_create_params :get_body_params
   alias :get_update_params :get_body_params
 
-  # Get a record by the primary key from the (non-filtered) recordset.
-  def get_record
-    if pk = params[self.get_model.primary_key]
-      return self.get_recordset.find(pk)
-    end
-    return nil
-  end
-
   # Get the model for this controller.
   def get_model(from_get_recordset: false)
     return @model if instance_variable_defined?(:@model) && @model
@@ -164,6 +179,29 @@ module RESTFramework::BaseModelControllerMixin
 
     return nil
   end
+
+  # Get a single record by primary key or another column, if allowed.
+  def 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]
+    end
+
+    # Filter recordset, if configured.
+    if self.filter_recordset_before_find
+      recordset = self.get_filtered_data(recordset)
+    end
+
+    # Return the record.
+    if find_by_value = params[:id]  # Route key is always :id by Rails convention.
+      return self.get_recordset.find_by!(find_by_key => find_by_value)
+    end
+    return nil
+  end
 end
 
 
@@ -200,8 +238,8 @@ end
 # Mixin for creating records.
 module RESTFramework::CreateModelMixin
   def create
-    if self.get_recordset.respond_to?(:create!) && !self.disable_creation_from_recordset
-      # Create with any properties inherited from the recordset (like associations).
+    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)
     else
       # Otherwise, perform a "bare" create.

data/lib/rest_framework/errors.rb

@@ -2,6 +2,7 @@
 class RESTFramework::Error < StandardError
 end
 
+
 class RESTFramework::NilPassedToAPIResponseError < RESTFramework::Error
   def message
     return <<~MSG.split("\n").join(' ')
@@ -14,6 +15,7 @@ class RESTFramework::NilPassedToAPIResponseError < RESTFramework::Error
   end
 end
 
+
 class RESTFramework::UnserializableError < RESTFramework::Error
   def initialize(object)
     @object = object

data/lib/rest_framework/filters.rb

@@ -14,8 +14,8 @@ 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.class.filterset_fields&.map(&:to_s) || @controller.send(:get_fields)
-    return @controller.request.query_parameters.select { |p|
+    fields = @controller.send(:get_filterset_fields)
+    return @controller.request.query_parameters.select { |p, _|
       fields.include?(p)
     }.to_h.symbolize_keys  # convert from HashWithIndifferentAccess to Hash w/keys
   end
@@ -36,17 +36,25 @@ end
 class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
   # Convert ordering string to an ordering configuration.
   def _get_ordering
-    return nil unless @controller.class.ordering_query_param
-
+    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?
-      return order_string.split(',').map { |field|
+      ordering = {}
+      order_string.split(',').each do |field|
         if field[0] == '-'
-          [field[1..-1].to_sym, :desc]
+          column = field[1..-1]
+          direction = :desc
         else
-          [field.to_sym, :asc]
+          column = field
+          direction = :asc
         end
-      }.to_h
+        if column.in?(ordering_fields)
+          ordering[column.to_sym] = direction
+        end
+      end
+      return ordering
     end
 
     return nil
@@ -55,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/routers.rb

@@ -99,9 +99,11 @@ module ActionDispatch::Routing
       kwargs[:controller] = name unless kwargs[:controller]
 
       # determine plural/singular resource
-      if kwargs.delete(:force_singular)
+      force_singular = kwargs.delete(:force_singular)
+      force_plural = kwargs.delete(:force_plural)
+      if force_singular
         singular = true
-      elsif kwargs.delete(:force_plural)
+      elsif force_plural
         singular = false
       elsif !controller_class.singleton_controller.nil?
         singular = controller_class.singleton_controller

data/lib/rest_framework/serializers.rb

@@ -121,29 +121,21 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
 
   # Allow a serializer instance to be used as a hash directly in a nested serializer config.
   def [](key)
-    unless instance_variable_defined?(:@_nested_config)
-      @_nested_config = self.get_serializer_config
-    end
+    @_nested_config ||= self.get_serializer_config
     return @_nested_config[key]
   end
   def []=(key, value)
-    unless instance_variable_defined?(:@_nested_config)
-      @_nested_config = self.get_serializer_config
-    end
+    @_nested_config ||= self.get_serializer_config
     return @_nested_config[key] = value
   end
 
   # Allow a serializer class to be used as a hash directly in a nested serializer config.
   def self.[](key)
-    unless instance_variable_defined?(:@_nested_config)
-      @_nested_config = self.new.get_serializer_config
-    end
+    @_nested_config ||= self.new.get_serializer_config
     return @_nested_config[key]
   end
   def self.[]=(key, value)
-    unless instance_variable_defined?(:@_nested_config)
-      @_nested_config = self.new.get_serializer_config
-    end
+    @_nested_config ||= self.new.get_serializer_config
     return @_nested_config[key] = value
   end
 end

data/lib/rest_framework/version.rb

@@ -1,35 +1,32 @@
+# Do not use Rails-specific helper methods here (e.g., `blank?`) so the module can run standalone.
 module RESTFramework
   module Version
-    @_version = nil
+    VERSION_FILEPATH = File.expand_path("../../VERSION", __dir__)
 
     def self.get_version(skip_git: false)
-      # Return cached @_version, if available.
-      return @_version if @_version
-
       # First, attempt to get the version from git.
       unless skip_git
-        begin
-          version = `git describe 2>/dev/null`.strip
-          raise "blank version" if version.nil? || version.match(/^\w*$/)
-          # Check for local changes.
-          changes = `git status --porcelain 2>/dev/null`
-          version << '.localchanges' if changes.strip.length > 0
-          return version
-        rescue
-        end
+        version = `git describe --dirty --broken 2>/dev/null`&.strip
+        return version unless !version || version.empty?
       end
 
-      # Git failed, so try to find a VERSION_STAMP.
+      # Git failed or was skipped, so try to find a VERSION file.
       begin
-        version = File.read(File.expand_path("VERSION_STAMP", __dir__))
-        unless version.nil? || version.match(/^\w*$/)
-          return (@_version = version)  # cache VERSION_STAMP content
-        end
-      rescue
+        version = File.read(VERSION_FILEPATH)&.strip
+        return version unless !version || version.blank?
+      rescue SystemCallError
       end
 
-      # No VERSION_STAMP, so version is unknown.
-      return '0.unknown'
+      # No VERSION file, so version is unknown.
+      return 'unknown'
+    end
+
+    def self.stamp_version
+      File.write(VERSION_FILEPATH, RESTFramework::VERSION)
+    end
+
+    def self.unstamp_version
+      File.delete(VERSION_FILEPATH) if File.exist?(VERSION_FILEPATH)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,12 +33,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- VERSION
 - 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/VERSION_STAMP
 - lib/rest_framework/controller_mixins.rb
 - lib/rest_framework/controller_mixins/base.rb
 - lib/rest_framework/controller_mixins/models.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.

data/lib/rest_framework/VERSION_STAMP

@@ -1 +0,0 @@
-0.2.4