Method: Boxr::Client#search

Defined in:
lib/boxr/search.rb

#search(query = nil, scope: nil, file_extensions: [], fields: [], created_at_range_from_date: nil, created_at_range_to_date: nil, updated_at_range_from_date: nil, updated_at_range_to_date: nil, size_range_lower_bound_bytes: nil, size_range_upper_bound_bytes: nil, owner_user_ids: [], ancestor_folder_ids: [], content_types: [], trash_content: nil, mdfilters: nil, type: nil, limit: 30, offset: 0) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/boxr/search.rb', line 5

def search(query = nil, scope: nil, file_extensions: [], fields: [],
           created_at_range_from_date: nil, created_at_range_to_date: nil,
           updated_at_range_from_date: nil, updated_at_range_to_date: nil,
           size_range_lower_bound_bytes: nil, size_range_upper_bound_bytes: nil,
           owner_user_ids: [], ancestor_folder_ids: [], content_types: [], trash_content: nil,
           mdfilters: nil, type: nil, limit: 30, offset: 0)
  # if a string is passed in assume it is already formatted correctly
  if !mdfilters.nil? && !mdfilters.is_a?(String)
    unless mdfilters.is_a? Array
      # if just one mdfilter is specified ensure that it is packaged inside an array
      mdfilters = [mdfilters]
    end
    mdfilters = JSON.dump(mdfilters)
  end

  # build range strings
  created_at_range_string = build_date_range_field(created_at_range_from_date,
                                                   created_at_range_to_date)
  updated_at_range_string = build_date_range_field(updated_at_range_from_date,
                                                   updated_at_range_to_date)
  size_range_string = build_size_range_field(size_range_lower_bound_bytes,
                                             size_range_upper_bound_bytes)

  # build comma separated strings
  file_extensions_string = to_comma_separated_string(file_extensions)
  owner_user_ids_string = to_comma_separated_string(owner_user_ids)
  ancestor_folder_ids_string = to_comma_separated_string(ancestor_folder_ids)
  content_types_string = to_comma_separated_string(content_types)
  fields_string = to_comma_separated_string(fields)

  search_query = {}
  search_query[:query] = query unless query.nil?
  search_query[:scope] = scope unless scope.nil?
  search_query[:file_extensions] = file_extensions_string unless file_extensions_string.nil?
  search_query[:fields] = fields_string unless fields_string.nil?
  search_query[:created_at_range] = created_at_range_string unless created_at_range_string.nil?
  search_query[:updated_at_range] = updated_at_range_string unless updated_at_range_string.nil?
  search_query[:size_range] = size_range_string unless size_range_string.nil?
  search_query[:owner_user_ids] = owner_user_ids_string unless owner_user_ids_string.nil?
  unless ancestor_folder_ids_string.nil?
    search_query[:ancestor_folder_ids] =
      ancestor_folder_ids_string
  end
  search_query[:content_types] = content_types_string unless content_types_string.nil?
  search_query[:trash_content] = trash_content unless trash_content.nil?
  search_query[:mdfilters] = mdfilters unless mdfilters.nil?
  search_query[:type] = type unless type.nil?
  search_query[:limit] = limit unless limit.nil?
  search_query[:offset] = offset unless offset.nil?

  results, = get(SEARCH_URI, query: search_query)
  results.entries
end