gitlab 3.0.0 → 4.0.0

data/lib/gitlab/client/groups.rb

@@ -1,18 +1,19 @@
 class Gitlab::Client
   # Defines methods related to groups.
+  # @see https://docs.gitlab.com/ce/api/groups.html
   module Groups
     # Gets a list of groups.
     #
     # @example
     #   Gitlab.groups
-    #   Gitlab.groups(:per_page => 40)
+    #   Gitlab.groups({ per_page: 40, page: 2 })
     #
     # @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 groups(options={})
-      get("/groups", :query => options)
+      get("/groups", query: options)
     end
 
     # Gets a single group.
@@ -28,19 +29,33 @@ class Gitlab::Client
 
     # Creates a new group.
     #
+    # @example
+    #   Gitlab.create_group('new-group', 'group-path')
+    #   Gitlab.create_group('gitlab', 'gitlab-path', { description: 'New Gitlab project' })
+    #
     # @param  [String] name The name of a group.
     # @param  [String] path The path of a group.
     # @return [Gitlab::ObjectifiedHash] Information about created group.
-    def create_group(name, path)
-      body = {:name => name, :path => path}
-      post("/groups", :body => body)
+    def create_group(name, path, options={})
+      body = { name: name, path: path }.merge(options)
+      post("/groups", body: body)
+    end
+
+    # Delete's a group.
+    #
+    # @example
+    #   Gitlab.delete_group(42)
+    # @param  [Integer] id The ID of a group
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted group.
+    def delete_group(id)
+      delete("/groups/#{id}")
     end
 
     # Get a list of group members.
     #
     # @example
     #   Gitlab.group_members(1)
-    #   Gitlab.group_members(1, :per_page => 40)
+    #   Gitlab.group_members(1, { per_page: 40 })
     #
     # @param  [Integer] id The ID of a group.
     # @param  [Hash] options A customizable set of options.
@@ -48,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/#{id}/members", query: options)
     end
 
     # Adds a user to group.
@@ -61,7 +76,20 @@ 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/#{team_id}/members", body: { user_id: user_id, access_level: access_level })
+    end
+
+    # Edit a user of a group.
+    #
+    # @example
+    #   Gitlab.edit_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id of member to edit.
+    # @param  [Integer] user_id The user id of the user to edit.
+    # @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 })
     end
 
     # Removes user from user group.
@@ -78,11 +106,39 @@ class Gitlab::Client
 
     # Transfers a project to a group
     #
+    # @example
+    #   Gitlab.transfer_project_to_group(3, 50)
+    #
     # @param  [Integer] id The ID of a group.
     # @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)
+      body = { id: id, project_id: project_id }
+      post("/groups/#{id}/projects/#{project_id}", body: body)
+    end
+
+    # Search for groups by name
+    #
+    # @example
+    #   Gitlab.group_search('gitlab')
+    #
+    # @param  [String] search A string to search for in group names and paths.
+    # @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
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_search(search, options={})
+      options[:search] = search
+      get("/groups", query: options)
+    end
+
+    # Get a list of projects under a group
+    # @example
+    #   Gitlab.group_projects(1)
+    #
+    # @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)
     end
   end
 end

data/lib/gitlab/client/issues.rb

@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to issues.
+  # @see https://docs.gitlab.com/ce/api/issues.html
   module Issues
     # Gets a list of user's issues.
     # Will return a list of project's issues if project ID passed.
@@ -7,18 +8,18 @@ class Gitlab::Client
     # @example
     #   Gitlab.issues
     #   Gitlab.issues(5)
-    #   Gitlab.issues(:per_page => 40)
+    #   Gitlab.issues({ per_page: 40 })
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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 issues(project=nil, options={})
-      if project.to_i.zero?
-        get("/issues", :query => options)
+      if project.to_s.empty? && project.to_i.zero?
+        get("/issues", query: options)
       else
-        get("/projects/#{project}/issues", :query => options)
+        get("/projects/#{url_encode project}/issues", query: options)
       end
     end
 
@@ -27,16 +28,20 @@ class Gitlab::Client
     # @example
     #   Gitlab.issue(5, 42)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash]
     def issue(project, id)
-      get("/projects/#{project}/issues/#{id}")
+      get("/projects/#{url_encode project}/issues/#{id}")
     end
 
     # Creates a new issue.
     #
-    # @param  [Integer] project The ID of a project.
+    # @example
+    #   Gitlab.create_issue(5, 'New issue')
+    #   Gitlab.create_issue(5, 'New issue', { description: 'This is a new issue', assignee_id: 42 })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] title The title of an issue.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description The description of an issue.
@@ -45,13 +50,16 @@ class Gitlab::Client
     # @option options [String] :labels Comma-separated label names for an issue.
     # @return [Gitlab::ObjectifiedHash] Information about created issue.
     def create_issue(project, title, options={})
-      body = {:title => title}.merge(options)
-      post("/projects/#{project}/issues", :body => body)
+      body = { title: title }.merge(options)
+      post("/projects/#{url_encode project}/issues", body: body)
     end
 
     # Updates an issue.
     #
-    # @param  [Integer] project The ID of a project.
+    # @example
+    #   Gitlab.edit_issue(6, 1, { title: 'Updated title' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of an issue.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :title The title of an issue.
@@ -62,7 +70,7 @@ class Gitlab::Client
     # @option options [String] :state_event The state event of an issue ('close' or 'reopen').
     # @return [Gitlab::ObjectifiedHash] Information about updated issue.
     def edit_issue(project, id, options={})
-      put("/projects/#{project}/issues/#{id}", :body => options)
+      put("/projects/#{url_encode project}/issues/#{id}", body: options)
     end
 
     # Closes an issue.
@@ -70,11 +78,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.close_issue(3, 42)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash] Information about closed issue.
     def close_issue(project, id)
-      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'close'})
+      put("/projects/#{url_encode project}/issues/#{id}", body: { state_event: 'close' })
     end
 
     # Reopens an issue.
@@ -82,11 +90,48 @@ class Gitlab::Client
     # @example
     #   Gitlab.reopen_issue(3, 42)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash] Information about reopened issue.
     def reopen_issue(project, id)
-      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'reopen'})
+      put("/projects/#{url_encode project}/issues/#{id}", body: { state_event: 'reopen' })
+    end
+
+    # Subscribe to an issue.
+    #
+    # @example
+    #   Gitlab.subscribe_to_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about subscribed issue.
+    def subscribe_to_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/subscribe")
+    end
+
+    # Unsubscribe from an issue.
+    #
+    # @example
+    #   Gitlab.unsubscribe_from_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about unsubscribed issue.
+    def unsubscribe_from_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/unsubscribe")
+    end
+
+    # Deletes  an issue.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.delete_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted issue.
+    def delete_issue(project, id)
+      delete("/projects/#{url_encode project}/issues/#{id}")
     end
   end
 end

data/lib/gitlab/client/labels.rb

@@ -0,0 +1,57 @@
+class Gitlab::Client
+  # Defines methods related to labels.
+  # @see https://docs.gitlab.com/ce/api/labels.html
+  module Labels
+    # Gets a list of project's labels.
+    #
+    # @example
+    #   Gitlab.labels(5)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def labels(project)
+      get("/projects/#{url_encode project}/labels")
+    end
+
+    # Creates a new label.
+    #
+    # @example
+    #   Gitlab.create_label(42, "Backlog", '#DD10AA')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @option [String] name The name of a label.
+    # @option [String] color The color of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about created label.
+    def create_label(project, name, color)
+      post("/projects/#{url_encode project}/labels", body: { name: name, color: color })
+    end
+
+    # Updates a label.
+    #
+    # @example
+    #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO' })
+    #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO', color: '#DD10AA' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] name The name of a label.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :new_name The new name of a label.
+    # @option options [String] :color The color of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about updated label.
+    def edit_label(project, name, options={})
+      put("/projects/#{url_encode project}/labels", body: options.merge(name: name))
+    end
+
+    # Deletes a label.
+    #
+    # @example
+    #   Gitlab.delete_label(2, 'Backlog')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] name The name of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted label.
+    def delete_label(project, name)
+      delete("/projects/#{url_encode project}/labels", body: { name: name })
+    end
+  end
+end

data/lib/gitlab/client/merge_requests.rb

@@ -1,19 +1,20 @@
 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 project merge requests.
     #
     # @example
     #   Gitlab.merge_requests(5)
-    #   Gitlab.merge_requests(:per_page => 40)
+    #   Gitlab.merge_requests({ per_page: 40 })
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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 merge_requests(project, options={})
-      get("/projects/#{project}/merge_requests", :query => options)
+      get("/projects/#{url_encode project}/merge_requests", query: options)
     end
 
     # Gets a single merge request.
@@ -21,74 +22,184 @@ class Gitlab::Client
     # @example
     #   Gitlab.merge_request(5, 36)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a merge request.
     # @return <Gitlab::ObjectifiedHash]
     def merge_request(project, id)
-      get("/projects/#{project}/merge_request/#{id}")
+      get("/projects/#{url_encode project}/merge_requests/#{id}")
     end
 
     # Creates a merge request.
     #
     # @example
     #   Gitlab.create_merge_request(5, 'New merge request',
-    #     :source_branch => 'source_branch', :target_branch => 'target_branch')
+    #     { source_branch: 'source_branch', target_branch: 'target_branch' })
     #   Gitlab.create_merge_request(5, 'New merge request',
-    #     :source_branch => 'source_branch', :target_branch => 'target_branch', :assignee_id => 42)
+    #     { source_branch: 'source_branch', target_branch: 'target_branch', assignee_id: 42 })
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] title The title of a merge request.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :source_branch (required) The source branch name.
     # @option options [String] :target_branch (required) The target branch name.
     # @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request.
+    # @option options [Integer] :target_project_id (optional) The target project ID.
     # @return [Gitlab::ObjectifiedHash] Information about created merge request.
     def create_merge_request(project, title, options={})
-      check_attributes!(options, [:source_branch, :target_branch])
-
-      body = {:title => title}.merge(options)
-      post("/projects/#{project}/merge_requests", :body => body)
+      body = { title: title }.merge(options)
+      post("/projects/#{url_encode project}/merge_requests", body: body)
     end
 
     # Updates a merge request.
     #
     # @example
-    #   Gitlab.update_merge_request(5, 42, :title => 'New title')
+    #   Gitlab.update_merge_request(5, 42, { title: 'New title' })
     #
-    # @param  [Integer] project The ID of a project.
+    # @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.
     # @option options [String] :title The title of a merge request.
     # @option options [String] :source_branch The source branch name.
     # @option options [String] :target_branch The target branch name.
     # @option options [Integer] :assignee_id The ID of a user to assign merge request.
+    # @option options [String] :state_event New state (close|reopen|merge).
     # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
     def update_merge_request(project, id, options={})
-      put("/projects/#{project}/merge_request/#{id}", :body => options)
+      put("/projects/#{url_encode project}/merge_requests/#{id}", body: options)
+    end
+
+    # Accepts a merge request.
+    #
+    # @example
+    #   Gitlab.accept_merge_request(5, 42, { merge_commit_message: 'Nice!' })
+    #
+    # @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.
+    # @option options [String] :merge_commit_message Custom merge commit message
+    # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
+    def accept_merge_request(project, id, options={})
+      put("/projects/#{url_encode project}/merge_requests/#{id}/merge", body: options)
     end
 
     # Adds a comment to a merge request.
     #
     # @example
-    #   Gitlab.comment_merge_request(5, 1, "Awesome merge!")
-    #   Gitlab.comment_merge_request('gitlab', 1, "Awesome merge!")
+    #   Gitlab.create_merge_request_comment(5, 1, "Awesome merge!")
+    #   Gitlab.create_merge_request_comment('gitlab', 1, "Awesome merge!")
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a merge request.
     # @param  [String] note The content of a comment.
     # @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
     def create_merge_request_comment(project, id, note)
-      post("/projects/#{project}/merge_request/#{id}/comments", :body => {:note => note})
+      post("/projects/#{url_encode project}/merge_requests/#{id}/notes", body: { body: note })
+    end
+
+    # Adds a comment to a merge request.
+    #
+    # @example
+    #   Gitlab.edit_merge_request_comment(5, 1,2, "Awesome merge!")
+    #   Gitlab.edit_merge_request_comment('gitlab', 1, 2, "Awesome merge!")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] id The ID of the merge-request comment
+    # @param  [String] note The content of a comment.
+    # @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
+    def edit_merge_request_comment(project, id, note_id , note)
+      put("/projects/#{url_encode project}/merge_requests/#{id}/notes/#{note_id}", body: { body: note })
+    end
+
+    # Deletes a comment from a merge request.
+    #
+    # @example
+    #   Gitlab.delete_merge_request_comment(5, 1,2)
+    #   Gitlab.delete_merge_request_comment('gitlab', 1, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Integer] id The ID of the merge-request comment
+    # @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
+    def delete_merge_request_comment(project, id, note_id)
+      delete("/projects/#{url_encode project}/merge_requests/#{id}/notes/#{note_id}")
+    end
+
+    # Gets the comments on a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_comments(5, 1)
+    #   Gitlab.merge_request_comments(5, 1, { per_page: 10, page: 2 })
+    #
+    # @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.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Gitlab::ObjectifiedHash] The merge request's comments.
+    def merge_request_comments(project, id, options={})
+      get("/projects/#{url_encode project}/merge_requests/#{id}/notes", query: options)
+    end
+
+    # Gets the changes of a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_changes(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Gitlab::ObjectifiedHash] The merge request's changes.
+    def merge_request_changes(project, id)
+      get("/projects/#{url_encode project}/merge_requests/#{id}/changes")
+    end
+
+    # Gets the commits of a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_commits(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>] The merge request's commits.
+    def merge_request_commits(project, id)
+      get("/projects/#{url_encode project}/merge_requests/#{id}/commits")
     end
 
-    private
+    # List issues that will close on merge
+    #
+    # @example
+    #   Gitlab.merge_request_closes_issues(5, 1)
+    #
+    # @param [Integer] project The ID of a project
+    # @param [Integer] iid The internal ID of a merge request
+    def merge_request_closes_issues(project_id, merge_request_iid)
+      get("/projects/#{project_id}/merge_requests/#{merge_request_iid}/closes_issues")
+    end
 
-    def check_attributes!(options, attrs)
-      attrs.each do |attr|
-        unless options.has_key?(attr) || options.has_key?(attr.to_s)
-          raise Gitlab::Error::MissingAttributes.new("Missing '#{attr}' parameter")
-        end
-      end
+    # Subscribes to a merge request.
+    #
+    # @example
+    #   Gitlab.subscribe_to_merge_request(5, 1)
+    #   Gitlab.subscribe_to_merge_request('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] Information about subscribed merge request.
+    def subscribe_to_merge_request(project, id)
+      post("/projects/#{url_encode project}/merge_requests/#{id}/subscribe")
+    end
+
+    # Unsubscribes from a merge request.
+    #
+    # @example
+    #   Gitlab.unsubscribe_from_merge_request(5, 1)
+    #   Gitlab.unsubscribe_from_merge_request('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] Information about unsubscribed merge request.
+    def unsubscribe_from_merge_request(project, id)
+      post("/projects/#{url_encode project}/merge_requests/#{id}/unsubscribe")
     end
   end
 end