class JsonApiable::FilterParser
Attributes
filter_class[R]
filter_param[R]
Public Class Methods
new(filter_param, filter_class)
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 11 def initialize(filter_param, filter_class) @filter_param = filter_param @filter_class = filter_class end
parse_filters!(jsonapi_build_params, filter_class)
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 5 def self.parse_filters!(jsonapi_build_params, filter_class) FilterParser.new(jsonapi_build_params[:filter], filter_class).parse! end
Public Instance Methods
parse!()
click to toggle source
Support filtering in the form of example.com/v1/posts?filter=draft,published
# File lib/json_apiable/filter_parser.rb, line 17 def parse! raise_invalid_filter_class unless valid_filter_class? filter_hash = ActiveSupport::HashWithIndifferentAccess.new if valid_filter_query? filter_param.keys.each do |k| if valid_filter_key?(k) # support notation ?filter[param]=value1,value2,value3&... requested = filter_param[k].split(',') allowed_values = allowed_filter_keys[k] raise_invalid_filter_value(k) unless FilterMatchers.matches?(allowed_values, requested) filter_hash[k] = requested else raise_invalid_filter_value(k) end end elsif filter_param.present? raise ArgumentError, 'filter' end filter_hash end
Private Instance Methods
allowed_filter_keys()
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 68 def allowed_filter_keys filter_class.jsonapi_allowed_filters.with_indifferent_access end
raise_argument_error(message)
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 42 def raise_argument_error(message) raise ArgumentError, message end
raise_invalid_filter_class()
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 52 def raise_invalid_filter_class raise_argument_error("#{filter_class} does not specify jsonapi_allowed_filters") end
raise_invalid_filter_value(k)
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 46 def raise_invalid_filter_value(k) prefix = "filter[#{k}]" msg = filter_param[k].present? ? "#{prefix}=#{filter_param[k]}" : prefix raise_argument_error(msg) end
valid_filter_class?()
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 56 def valid_filter_class? filter_class.respond_to?(:jsonapi_allowed_filters) end
valid_filter_key?(k)
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 64 def valid_filter_key?(k) allowed_filter_keys.key?(k) && filter_param[k].present? end
valid_filter_query?()
click to toggle source
# File lib/json_apiable/filter_parser.rb, line 60 def valid_filter_query? filter_param.present? && (filter_param.is_a?(Hash) || filter_param.is_a?(ActionController::Parameters)) end