Codebase list ruby-gitlab / 56aea8b lib / gitlab / client / search.rb
56aea8b

Tree @56aea8b (Download .tar.gz)

search.rb @56aea8b — raw · history · blame 

 1
 2
 3
 4
 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
58
59
60
61
62
63
64
65
66
# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to global searches, searching in projects and searching in groups.
  # @see https://docs.gitlab.com/ce/api/search.html
  module Search
    # Search globally across the GitLab instance.
    #
    # @example
    #   Gitlab.search_globally('projects', 'gitlab')
    #   Gitlab.search_globally('issues', 'gitlab')
    #   Gitlab.search_globally('merge_requests', 'gitlab')
    #   Gitlab.search_globally('milestones', 'gitlab')
    #   Gitlab.search_globally('snippet_titles', 'gitlab')
    #   Gitlab.search_globally('snippet_blobs', 'gitlab')
    #
    # @param  [String] scope The scope to search in. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs.
    # @param  [String] search The search query.
    # @return [Array<Gitlab::ObjectifiedHash>] Returns a list of responses depending on the requested scope.
    def search_globally(scope, search)
      options = { scope: scope, search: search }
      get('/search', query: options)
    end

    # Search within the specified group.
    #
    # @example
    #   Gitlab.search_in_group(1, 'projects', 'gitlab')
    #   Gitlab.search_in_group(1, 'issues', 'gitlab')
    #   Gitlab.search_in_group(1, 'merge_requests', 'gitlab')
    #   Gitlab.search_in_group(1, 'milestones', 'gitlab')
    #
    # @param  [Integer, String] group The ID or name of a group.
    # @param  [String] scope The scope to search in. Currently these scopes are supported: projects, issues, merge_requests, milestones.
    # @param  [String] search The search query.
    # @return [Array<Gitlab::ObjectifiedHash>] Returns a list of responses depending on the requested scope.
    def search_in_group(group, scope, search)
      options = { scope: scope, search: search }
      get("/groups/#{url_encode group}/search", query: options)
    end

    # Search within the specified project.
    #
    # @example
    #   Gitlab.search_in_project(1, 'issues', 'gitlab')
    #   Gitlab.search_in_project(1, 'merge_requests', 'gitlab')
    #   Gitlab.search_in_project(1, 'milestones', 'gitlab')
    #   Gitlab.search_in_project(1, 'notes', 'gitlab')
    #   Gitlab.search_in_project(1, 'wiki_blobs', 'gitlab')
    #   Gitlab.search_in_project(1, 'commits', 'gitlab')
    #   Gitlab.search_in_project(1, 'blobs', 'gitlab')
    #
    # @param  [Integer, String] project The ID or name of a project.
    # @param  [String] scope The scope to search in. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs.
    # @param  [String] search The search query.
    # @return [Array<Gitlab::ObjectifiedHash>] Returns a list of responses depending on the requested scope.
    def search_in_project(project, scope, search, ref = nil)
      options = { scope: scope, search: search }

      # Add ref filter if provided - backward compatible with main project
      options[:ref] = ref unless ref.nil?

      get("/projects/#{url_encode project}/search", query: options)
    end
  end
end