gitlab 4.3.0 → 4.4.0

data/lib/gitlab/client/groups.rb

@@ -24,7 +24,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of a group.
     # @return [Gitlab::ObjectifiedHash]
     def group(id)
-      get("/groups/#{id}")
+      get("/groups/#{url_encode id}")
     end
 
     # Creates a new group.
@@ -48,7 +48,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of a group
     # @return [Gitlab::ObjectifiedHash] Information about the deleted group.
     def delete_group(id)
-      delete("/groups/#{id}")
+      delete("/groups/#{url_encode id}")
     end
 
     # Get a list of group members.
@@ -63,7 +63,7 @@ class Gitlab::Client
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def group_members(id, options={})
-      get("/groups/#{id}/members", query: options)
+      get("/groups/#{url_encode id}/members", query: options)
     end
 
     # Get details of a single group member.
@@ -75,7 +75,7 @@ class Gitlab::Client
     # @param  [Integer] user_id The user id of the member to find.
     # @return [Gitlab::ObjectifiedHash] (id, username, name, email, state, access_level ...)
     def group_member(team_id, user_id)
-      get("/groups/#{team_id}/members/#{user_id}")
+      get("/groups/#{url_encode team_id}/members/#{user_id}")
     end
 
     # Adds a user to group.
@@ -88,7 +88,7 @@ class Gitlab::Client
     # @param  [Integer] access_level Project access level.
     # @return [Gitlab::ObjectifiedHash] Information about added team member.
     def add_group_member(team_id, user_id, access_level)
-      post("/groups/#{team_id}/members", body: { user_id: user_id, access_level: access_level })
+      post("/groups/#{url_encode team_id}/members", body: { user_id: user_id, access_level: access_level })
     end
 
     # Edit a user of a group.
@@ -101,7 +101,7 @@ class Gitlab::Client
     # @param  [Integer] access_level Project access level.
     # @return [Gitlab::ObjectifiedHash] Information about edited team member.
     def edit_group_member(team_id, user_id, access_level)
-      put("/groups/#{team_id}/members/#{user_id}", body: { access_level: access_level })
+      put("/groups/#{url_encode team_id}/members/#{user_id}", body: { access_level: access_level })
     end
 
     # Removes user from user group.
@@ -113,7 +113,7 @@ class Gitlab::Client
     # @param  [Integer] user_id The ID of a user.
     # @return [Gitlab::ObjectifiedHash] Information about removed team member.
     def remove_group_member(team_id, user_id)
-      delete("/groups/#{team_id}/members/#{user_id}")
+      delete("/groups/#{url_encode team_id}/members/#{user_id}")
     end
 
     # Transfers a project to a group
@@ -125,7 +125,7 @@ class Gitlab::Client
     # @param  [Integer] project_id The ID of a project.
     def transfer_project_to_group(id, project_id)
       body = { id: id, project_id: project_id }
-      post("/groups/#{id}/projects/#{project_id}", body: body)
+      post("/groups/#{url_encode id}/projects/#{project_id}", body: body)
     end
 
     # Search for groups by name
@@ -150,7 +150,7 @@ class Gitlab::Client
     # @param [Integer] id The ID of a group
     # @return [Array<Gitlab::ObjectifiedHash>] List of projects under a group
     def group_projects(id, options={})
-      get("/groups/#{id}/projects", query: options)
+      get("/groups/#{url_encode id}/projects", query: options)
     end
 
     # Get a list of subgroups under a group
@@ -168,7 +168,7 @@ class Gitlab::Client
     # @option options [String] :owned Limit to groups owned by the current user.
     # @return [Array<Gitlab::ObjectifiedHash>] List of subgroups under a group
     def group_subgroups(id, options={})
-      get("/groups/#{id}/subgroups", query: options)
+      get("/groups/#{url_encode id}/subgroups", query: options)
     end
 
     # Updates an existing group.
@@ -187,7 +187,7 @@ class Gitlab::Client
     # @option options [String] :request_access_enabled Allow users to request member access.
     # @return [Gitlab::ObjectifiedHash] Information about the edited group.
     def edit_group(id, options={})
-      put("/groups/#{id}", body: options)
+      put("/groups/#{url_encode id}", body: options)
     end
   end
 end

data/lib/gitlab/client/labels.rb

@@ -9,8 +9,8 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def labels(project)
-      get("/projects/#{url_encode project}/labels")
+    def labels(project, options={})
+      get("/projects/#{url_encode project}/labels", query: options)
     end
 
     # Creates a new label.

data/lib/gitlab/client/merge_requests.rb

@@ -2,11 +2,23 @@ class Gitlab::Client
   # Defines methods related to merge requests.
   # @see https://docs.gitlab.com/ce/api/merge_requests.html
   module MergeRequests
+    # Gets a list of all of the merge requests the authenticated user has access to.
+    #
+    # @example
+    #   Gitlab.user_merge_requests
+    #   Gitlab.user_merge_requests(state: :opened, scope: :all)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_merge_requests(options = {})
+      get('/merge_requests', query: options)
+    end
+
     # Gets a list of project merge requests.
     #
     # @example
     #   Gitlab.merge_requests(5)
-    #   Gitlab.merge_requests({ per_page: 40 })
+    #   Gitlab.merge_requests(5, { per_page: 40 })
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Hash] options A customizable set of options.
@@ -143,5 +155,121 @@ class Gitlab::Client
     def unsubscribe_from_merge_request(project, id)
       post("/projects/#{url_encode project}/merge_requests/#{id}/unsubscribe")
     end
+
+    # List project merge request discussions
+    #
+    # @example
+    #   Gitlab.merge_request_discussions(5, 1)
+    #   Gitlab.merge_request_discussions('gitlab', 1)
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Gitlab::ObjectifiedHash] List of the merge request discussions.
+    def merge_request_discussions(project, merge_request_id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions")
+    end
+
+    # Get single merge request discussion
+    #
+    # @example
+    #   Gitlab.merge_request_discussion(5, 1, 1)
+    #   Gitlab.merge_request_discussion('gitlab', 1, 1)
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] discussion_id The ID of a discussion.
+    # @return [Gitlab::ObjectifiedHash] The merge request discussion.
+    def merge_request_discussion(project, merge_request_id, discussion_id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}")
+    end
+
+    # Create new merge request discussion
+    #
+    # @example
+    #   Gitlab.create_merge_request_discussion(5, 1, body: 'discuss')
+    #   Gitlab.create_merge_request_discussion('gitlab', 1, body: 'discuss')
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Hash] options A customizable set of options.
+    #   * :body (String) The content of a discussion
+    #   * :created_at (String) Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z
+    #   * :position (Hash) Position when creating a diff note
+    #     * :base_sha (String) Base commit SHA in the source branch
+    #     * :start_sha (String) SHA referencing commit in target branch
+    #     * :head_sha (String) SHA referencing HEAD of this merge request
+    #     * :position_type (String) Type of the position reference', allowed values: 'text' or 'image'
+    #     * :new_path (String) File path after change
+    #     * :new_line (Integer) Line number after change (for 'text' diff notes)
+    #     * :old_path (String) File path before change
+    #     * :old_line (Integer) Line number before change (for 'text' diff notes)
+    #     * :width (Integer) Width of the image (for 'image' diff notes)
+    #     * :height (Integer) Height of the image (for 'image' diff notes)
+    #     * :x (Integer) X coordinate (for 'image' diff notes)
+    #     * :y (Integer) Y coordinate (for 'image' diff notes)
+    # @return [Gitlab::ObjectifiedHash] The created merge request discussion.
+    def create_merge_request_discussion(project, merge_request_id, options={})
+      post("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions", body: options)
+    end
+
+    # Resolve a merge request discussion
+    #
+    # @example
+    #   Gitlab.resolve_merge_request_discussion(5, 1, 1, true)
+    #   Gitlab.resolve_merge_request_discussion('gitlab', 1, 1, false)
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] discussion_id The ID of a discussion.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :resolved Resolve/unresolve the discussion.
+    # @return [Gitlab::ObjectifiedHash] The merge request discussion.
+    def resolve_merge_request_discussion(project, merge_request_id, discussion_id, options)
+      put("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}", body: options)
+    end
+
+    # Add note to existing merge request discussion
+    #
+    # @example
+    #   Gitlab.create_merge_request_discussion_note(5, 1, 1, note_id: 1, body: 'note')
+    #   Gitlab.create_merge_request_discussion_note('gitlab', 1, 1, note_id: 1, body: 'note')
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] discussion_id The ID of a discussion.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :note_id The ID of a discussion note.
+    # @option options [String] :body The content of a discussion.
+    # @option options [String] :created_at Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z.
+    # @return [Gitlab::ObjectifiedHash] The merge request discussion note.
+    def create_merge_request_discussion_note(project, merge_request_id, discussion_id, options)
+      post("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes", body: options)
+    end
+
+    # Modify an existing merge request discussion note
+    #
+    # @example
+    #   Gitlab.update_merge_request_discussion_note(5, 1, 1, 1, body: 'note')
+    #   Gitlab.update_merge_request_discussion_note('gitlab', 1, 1, 1, body: 'note')
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] discussion_id The ID of a discussion.
+    # @param  [Integer] note_id The ID of a discussion note.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :body The content of a discussion.
+    # @option options [Boolean] :resolved Resolve/unresolve the note.
+    # @return [Gitlab::ObjectifiedHash] The merge request discussion note.
+    def update_merge_request_discussion_note(project, merge_request_id, discussion_id, note_id, options)
+      put("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes/#{note_id}", body: options)
+    end
+
+    # Delete a merge request discussion note
+    #
+    # @example
+    #   Gitlab.delete_merge_request_discussion_note(5, 1, 1, 1)
+    #   Gitlab.delete_merge_request_discussion_note('gitlab', 1, 1, 1)
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] discussion_id The ID of a discussion.
+    # @param  [Integer] note_id The ID of a discussion note.
+    # @return [Gitlab::ObjectifiedHash] An empty response.
+    def delete_merge_request_discussion_note(project, merge_request_id, discussion_id, note_id)
+      delete("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes/#{note_id}")
+    end
   end
 end

data/lib/gitlab/client/notes.rb

@@ -219,9 +219,10 @@ class Gitlab::Client
     #
     # @param [Integer] project The ID of a project.
     # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
     # @return [Gitlab::ObjectifiedHash]
     def edit_note(project, id, body)
-      put("/projects/#{url_encode project}/notes/#{id}", body: body)
+      put("/projects/#{url_encode project}/notes/#{id}", body: note_content(body))
     end
 
     # Modifies an issue note.
@@ -232,9 +233,10 @@ class Gitlab::Client
     # @param [Integer] project The ID of a project.
     # @param [Integer] issue The ID of an issue.
     # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
     # @return [Gitlab::ObjectifiedHash]
     def edit_issue_note(project, issue, id, body)
-      put("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}", body: body)
+      put("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}", body: note_content(body))
     end
 
     # Modifies a snippet note.
@@ -245,9 +247,10 @@ class Gitlab::Client
     # @param [Integer] project The ID of a project.
     # @param [Integer] snippet The ID of a snippet.
     # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
     # @return [Gitlab::ObjectifiedHash]
     def edit_snippet_note(project, snippet, id, body)
-      put("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}", body: body)
+      put("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}", body: note_content(body))
     end
 
     # Modifies a merge_request note.
@@ -258,10 +261,24 @@ class Gitlab::Client
     # @param [Integer] project The ID of a project.
     # @param [Integer] merge_request The ID of a merge_request.
     # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
     # @return [Gitlab::ObjectifiedHash]
     def edit_merge_request_note(project, merge_request, id, body)
-      put("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}", body: body)
+      put("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}", body: note_content(body))
     end
     alias_method :edit_merge_request_comment, :edit_merge_request_note
+
+    private
+
+    # TODO: Remove this method after a couple deprecation cycles.  Replace calls with the code
+    # in the 'else'.
+    def note_content(body)
+      if body.is_a?(Hash)
+        STDERR.puts "Passing the note body as a Hash is deprecated.  You should just pass the String."
+        body
+      else
+        { body: body }
+      end
+    end
   end
 end

data/lib/gitlab/client/projects.rb

@@ -50,21 +50,6 @@ class Gitlab::Client
       get("/projects/#{url_encode id}")
     end
 
-    # Gets a list of project events.
-    #
-    # @example
-    #   Gitlab.project_events(42)
-    #   Gitlab.project_events('gitlab')
-    #
-    # @param  [Integer, String] project The ID or path of a project.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [Integer] :page The page number.
-    # @option options [Integer] :per_page The number of results per page.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_events(project, options={})
-      get("/projects/#{url_encode project}/events", query: options)
-    end
-
     # Creates a new project.
     #
     # @example
@@ -415,6 +400,24 @@ class Gitlab::Client
       post("/projects/#{url_encode id}/fork", body: options)
     end
 
+    # Get a list of all visible projects across GitLab for the authenticated user.
+    # When accessed without authentication, only public projects are returned.
+    #
+    # Note: This feature was introduced in GitLab 10.1
+    #
+    # @example
+    #   Gitlab.project_forks(42)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @option options [String] :order_by Return requests ordered by id, name, created_at or last_activity_at fields
+    # @option options [String] :sort Return requests sorted in asc or desc order
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_forks(id, options={})
+      get("/projects/#{url_encode id}/forks", query: options)
+    end
+
     # Updates an existing project.
     #
     # @example
@@ -471,5 +474,24 @@ class Gitlab::Client
     def unstar_project(id)
       delete("/projects/#{url_encode id}/star")
     end
+
+    # Get a list of visible projects for the given user.
+    # @see https://docs.gitlab.com/ee/api/projects.html#list-user-projects
+    #
+    # @example
+    #   Gitlab.user_projects(1)
+    #   Gitlab.user_projects(1, { order_by: 'last_activity_at' })
+    #   Gitlab.user_projects('username', { order_by: 'name', sort: 'asc' })
+    #
+    # @param  [Integer, String] user_id The ID or username of the user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of projects to return per page
+    # @option options [String] :page The page to retrieve
+    # @option options [String] :order_by Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.
+    # @option options [String] :sort Return projects sorted in asc or desc order.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_projects(user_id, options={})
+      get("/users/#{url_encode user_id}/projects", query: options)
+    end
   end
 end

data/lib/gitlab/client/runners.rb

@@ -72,6 +72,17 @@ class Gitlab::Client
       delete("/runners/#{id}")
     end
 
+    # Gets a list of Jobs for a Runner
+    #
+    # @example
+    #   Gitlab.runner_jobs(1)
+    #
+    # @param  [Integer] id The ID of a runner.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def runner_jobs(runner_id)
+      get("/runners/#{url_encode runner_id}/jobs")
+    end
+
     # List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined and shared runners usage is enabled in the project's settings.
     # @see https://docs.gitlab.com/ce/api/runners.html#list-projects-runners
     #

data/lib/gitlab/client/sidekiq.rb

@@ -0,0 +1,37 @@
+class Gitlab::Client
+  # Defines methods related to sidekiq metrics.
+  # @see https://docs.gitlab.com/ce/api/sidekiq_metrics.html
+  module Sidekiq
+    # Get the current Queue Metrics
+    #
+    # @example
+    #   Gitlab.sidekiq_queue_metrics
+    def sidekiq_queue_metrics
+      get('/sidekiq/queue_metrics')
+    end
+
+    # Get the current Process Metrics
+    #
+    # @example
+    #   Gitlab.sidekiq_process_metrics
+    def sidekiq_process_metrics
+      get('/sidekiq/process_metrics')
+    end
+
+    # Get the current Job Statistics
+    #
+    # @example
+    #   Gitlab.sidekiq_job_stats
+    def sidekiq_job_stats
+      get('/sidekiq/job_stats')
+    end
+
+    # Get a compound response of all the previously mentioned metrics
+    #
+    # @example
+    #   Gitlab.sidekiq_compound_metrics
+    def sidekiq_compound_metrics
+      get('/sidekiq/compound_metrics')
+    end
+  end
+end

data/lib/gitlab/client/snippets.rb

@@ -31,7 +31,7 @@ class Gitlab::Client
     # Creates a new snippet.
     #
     # @example
-    #   Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code' })
+    #   Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code', visibility: 'public'})
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Hash] options A customizable set of options.
@@ -39,6 +39,7 @@ class Gitlab::Client
     # @option options [String] :file_name (required) The name of a snippet file.
     # @option options [String] :code (required) The content of a snippet.
     # @option options [String] :lifetime (optional) The expiration date of a snippet.
+    # @option options [String] :visibility (required) The visibility of a snippet
     # @return [Gitlab::ObjectifiedHash] Information about created snippet.
     def create_snippet(project, options={})
       post("/projects/#{url_encode project}/snippets", body: options)
@@ -56,6 +57,7 @@ class Gitlab::Client
     # @option options [String] :file_name The name of a snippet file.
     # @option options [String] :code The content of a snippet.
     # @option options [String] :lifetime The expiration date of a snippet.
+    # @option options [String] :visibility (optional) The visibility of a snippet
     # @return [Gitlab::ObjectifiedHash] Information about updated snippet.
     def edit_snippet(project, id, options={})
       put("/projects/#{url_encode project}/snippets/#{id}", body: options)