Codebase list ruby-gitlab / 2a84b9a lib / gitlab / client / events.rb
2a84b9a

Tree @2a84b9a (Download .tar.gz)

events.rb @2a84b9a — 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
# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to events.
  # @see https://docs.gitlab.com/ce/api/events.html
  module Events
    # Gets a list of authenticated user's events
    #
    # @example
    #   Gitlab.events()
    #   Gitlab.events({ action: 'created', target_type: 'issue' })
    #
    # @param  [Hash] options A customizable set of options.
    # @option options [String] :action Only events of specific action type
    # @option options [String] :target_type Only events of specific target type
    # @option options [String] :before Only events created before YYYY-MM-DD
    # @option options [String] :after Only events created after YYYY-MM-DD
    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
    # @return [Array<Gitlab::ObjectifiedHash>]
    def events(options = {})
      get('/events', query: options)
    end

    # Gets a list of user contribution events
    #
    # @example
    #   Gitlab.user_events(1)
    #   Gitlab.user_events(1, { action: created})
    #
    # @param  [Integer, String] user The ID or username of user
    # @param  [Hash] options A customizable set of options.
    # @option options [String] :action Only events of specific action type
    # @option options [String] :target_type Only events of specific target type
    # @option options [String] :before Only events created before YYYY-MM-DD
    # @option options [String] :after Only events created after YYYY-MM-DD
    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
    # @return [Array<Gitlab::ObjectifiedHash>]
    def user_events(user, options = {})
      get("/users/#{url_encode user}/events", query: options)
    end

    # Gets a list of visible project events
    #
    # @example
    #   Gitlab.project_events(1)
    #   Gitlab.project_events(1, { action: created })
    #
    # @param  [Integer] project The ID of project
    # @param  [Hash] options A customizable set of options.
    # @option options [String] :action Only events of specific action type
    # @option options [String] :target_type Only events of specific target type
    # @option options [String] :before Only events created before YYYY-MM-DD
    # @option options [String] :after Only events created after YYYY-MM-DD
    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
    # @return [Array<Gitlab::ObjectifiedHash>]
    def project_events(project, options = {})
      get("/projects/#{url_encode project}/events", query: options)
    end
  end
end