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       params[:order].split(',').each do |order|
  73         attr, direction = order.strip.split " "
  74         direction ||= 'asc'
  75         if attr.match /^[a-z][_a-z0-9]+$/ and
  76             model_class.columns.collect(&:name).index(attr) and
  77             ['asc','desc'].index direction.downcase
  78           @orders << "#{table_name}.#{attr} #{direction.downcase}"
  79         end
  80       end
  81     end
  82     if @orders.empty?
  83       @orders << default_orders
  84     end
  85   end
  86
  87
  88 end