services/api/lib/load_param.rb

   1 # Mixin module for reading out query parameters from request params.
   2 #
   3 # Expects:
   4 #   +params+ Hash
   5 # Sets:
   6 #   @where, @filters, @limit, @offset, @orders
   7 module LoadParam
   8
   9   # Default limit on number of rows to return in a single query.
  10   DEFAULT_LIMIT = 100
  11
  12   # Load params[:where] into @where
  13   def load_where_param
  14     if params[:where].nil? or params[:where] == ""
  15       @where = {}
  16     elsif params[:where].is_a? Hash
  17       @where = params[:where]
  18     elsif params[:where].is_a? String
  19       begin
  20         @where = Oj.load(params[:where])
  21         raise unless @where.is_a? Hash
  22       rescue
  23         raise ArgumentError.new("Could not parse \"where\" param as an object")
  24       end
  25     end
  26     @where = @where.with_indifferent_access
  27   end
  28
  29   # Load params[:filters] into @filters
  30   def load_filters_param
  31     @filters ||= []
  32     if params[:filters].is_a? Array
  33       @filters += params[:filters]
  34     elsif params[:filters].is_a? String and !params[:filters].empty?
  35       begin
  36         f = Oj.load params[:filters]
  37         raise unless f.is_a? Array
  38         @filters += f
  39       rescue
  40         raise ArgumentError.new("Could not parse \"filters\" param as an array")
  41       end
  42     end
  43   end
  44
  45   def default_orders
  46     ["#{table_name}.modified_at desc"]
  47   end
  48
  49   # Load params[:limit], params[:offset] and params[:order]
  50   # into @limit, @offset, @orders
  51   def load_limit_offset_order_params
  52     if params[:limit]
  53       unless params[:limit].to_s.match(/^\d+$/)
  54         raise ArgumentError.new("Invalid value for limit parameter")
  55       end
  56       @limit = params[:limit].to_i
  57     else
  58       @limit = DEFAULT_LIMIT
  59     end
  60
  61     if params[:offset]
  62       unless params[:offset].to_s.match(/^\d+$/)
  63         raise ArgumentError.new("Invalid value for offset parameter")
  64       end
  65       @offset = params[:offset].to_i
  66     else
  67       @offset = 0
  68     end
  69
  70     @orders = []
  71     if params[:order]
  72       od = []
  73       (case params[:order]
  74        when String
  75          if params[:order].starts_with? '['
  76            od = Oj.load(params[:order])
  77            raise unless od.is_a? Array
  78            od
  79          else
  80            params[:order].split(',')
  81          end
  82        when Array
  83          params[:order]
  84        else
  85          []
  86        end).each do |order|
  87         order = order.to_s
  88         attr, direction = order.strip.split " "
  89         direction ||= 'asc'
  90         if attr.match /^[a-z][_a-z0-9]+$/ and
  91             model_class.columns.collect(&:name).index(attr) and
  92             ['asc','desc'].index direction.downcase
  93           @orders << "#{table_name}.#{attr} #{direction.downcase}"
  94         end
  95       end
  96     end
  97
  98     if @orders.empty?
  99       @orders = default_orders
 100     end
 101
 102     case params[:select]
 103     when Array
 104       @select = params[:select]
 105     when String
 106       begin
 107         @select = Oj.load params[:select]
 108         raise unless @select.is_a? Array or @select.nil?
 109       rescue
 110         raise ArgumentError.new("Could not parse \"select\" param as an array")
 111       end
 112     end
 113
 114     if @select
 115       # Any ordering columns must be selected when doing select,
 116       # otherwise it is an SQL error, so filter out invaliding orderings.
 117       @orders.select! { |o|
 118         # match select column against order array entry
 119         @select.select { |s| /^#{table_name}.#{s}( (asc|desc))?$/.match o }.any?
 120       }
 121     end
 122
 123     @distinct = true if (params[:distinct] == true || params[:distinct] == "true")
 124     @distinct = false if (params[:distinct] == false || params[:distinct] == "false")
 125   end
 126
 127
 128 end