add allowed_scopes to jsonapi_filter and keep it backwards compatible

Author: fluxsaas

lib/jsonapi/filtering.rb

@@ -32,9 +32,11 @@ def self.extract_attributes_and_predicates(requested_field)
     # @param allowed_fields [Array] a list of allowed fields to be filtered
     # @param options [Hash] extra flags to enable/disable features
     # @return [ActiveRecord::Base] a collection of resources
-    def jsonapi_filter(resources, allowed_fields, options = {})
+    def jsonapi_filter(resources, allowed_fields, *allowed_scopes, options)
+      options = options || {}
+      allowed_scopes = (allowed_scopes || []).flatten.map(&:to_s)
       allowed_fields = allowed_fields.map(&:to_s)
-      extracted_params = jsonapi_filter_params(allowed_fields)
+      extracted_params = jsonapi_filter_params(allowed_fields, allowed_scopes)
       extracted_params[:sorts] = jsonapi_sort_params(allowed_fields, options)
       resources = resources.ransack(extracted_params)
       block_given? ? yield(resources) : resources
@@ -47,7 +49,7 @@ def jsonapi_filter(resources, allowed_fields, options = {})
     #
     # @param allowed_fields [Array] a list of allowed fields to be filtered
     # @return [Hash] to be passed to [ActiveRecord::Base#order]
-    def jsonapi_filter_params(allowed_fields)
+    def jsonapi_filter_params(allowed_fields, allowed_scopes)
       filtered = {}
       requested = params[:filter] || {}
       allowed_fields = allowed_fields.map(&:to_s)
@@ -62,9 +64,17 @@ def jsonapi_filter_params(allowed_fields)
           to_filter = to_filter.split(',')
         end
 
+        # filter by attributes
+        # {"first_name_eq"=>"Beau"}
         if predicates.any? && (field_names - allowed_fields).empty?
           filtered[requested_field] = to_filter
         end
+
+        # filter by scopes
+        # {"created_before"=>"2013-02-01"}
+        if (field_names - allowed_scopes).empty?
+          filtered[requested_field] = to_filter
+        end
       end
 
       filtered

spec/dummy.rb

@@ -88,12 +88,17 @@ class UsersController < ActionController::Base
   def index
     allowed_fields = [
       :first_name, :last_name, :created_at,
-      :notes_created_at, :notes_quantity,
+      :notes_created_at, :notes_quantity
+    ]
+    allowed_scopes = [
       :created_before
     ]
     options = { sort_with_expressions: true }
 
-    jsonapi_filter(User.all, allowed_fields, options) do |filtered|
+    jsonapi_filter(User.all,
+                   allowed_fields,
+                   allowed_scopes,
+                   options) do |filtered|
       result = filtered.result
 
       if params[:sort].to_s.include?('notes_quantity')

spec/filtering_spec.rb

@@ -106,14 +106,14 @@
           }
         end
 
-        fit 'ensures ransack scopes are working properly' do
+        it 'ensures ransack scopes are working properly' do
           ransack = User.ransack({ created_before: '2013-02-01' })
           expected_sql = 'SELECT "users".* FROM "users" WHERE '\
                          '(created_at < \'2013-02-01\')'
           expect(ransack.result.to_sql).to eq(expected_sql)
         end
 
-        fit 'should return only' do
+        it 'should return only' do
           expect(response).to have_http_status(:ok)
           expect(response_json['data'].size).to eq(1)
           expect(response_json['data'][0]).to have_id(third_user.id.to_s)