gitlab 3.6.1 → 3.7.0

data/lib/gitlab/client/issues.rb

@@ -8,7 +8,7 @@ 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  [Hash] options A customizable set of options.
@@ -39,7 +39,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.create_issue(5, 'New issue')
-    #   Gitlab.create_issue(5, 'New issue', :description => "This is a new issue", :assignee_id => 42)
+    #   Gitlab.create_issue(5, 'New issue', { description: 'This is a new issue', assignee_id: 42 })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [String] title The title of an issue.
@@ -57,7 +57,7 @@ class Gitlab::Client
     # Updates an issue.
     #
     # @example
-    #   Gitlab.edit_issue(6, 1, :title => 'Updated title')
+    #   Gitlab.edit_issue(6, 1, { title: 'Updated title' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of an issue.
@@ -96,5 +96,18 @@ class Gitlab::Client
     def reopen_issue(project, id)
       put("/projects/#{project}/issues/#{id}", body: { state_event: 'reopen' })
     end
+
+    # Deletes  an issue.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.delete_issue(3, 42)
+    #
+    # @param  [Integer] project The ID 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/#{project}/issues/#{id}")
+    end
   end
 end

data/lib/gitlab/client/labels.rb

@@ -29,8 +29,8 @@ class Gitlab::Client
     # Updates a label.
     #
     # @example
-    #   Gitlab.edit_label(42, "Backlog", :new_name => 'TODO')
-    #   Gitlab.edit_label(42, "Backlog", :new_name => 'TODO', :color => '#DD10AA')
+    #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO' })
+    #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO', color: '#DD10AA' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [String] name The name of a label.

data/lib/gitlab/client/merge_requests.rb

@@ -6,7 +6,7 @@ class Gitlab::Client
     #
     # @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  [Hash] options A customizable set of options.
@@ -33,9 +33,9 @@ class Gitlab::Client
     #
     # @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  [String] title The title of a merge request.
@@ -53,7 +53,7 @@ class Gitlab::Client
     # 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] id The ID of a merge request.
@@ -71,7 +71,7 @@ class Gitlab::Client
     # Accepts a merge request.
     #
     # @example
-    #   Gitlab.accept_merge_request(5, 42, :merge_commit_message => 'Nice!')
+    #   Gitlab.accept_merge_request(5, 42, { merge_commit_message: 'Nice!' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a merge request.
@@ -93,14 +93,43 @@ class Gitlab::Client
     # @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/#{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] project The ID 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/#{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] project The ID 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/#{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)
+    #   Gitlab.merge_request_comments(5, 1, { per_page: 10, page: 2 })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a merge request.
@@ -109,7 +138,7 @@ class Gitlab::Client
     # @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/#{project}/merge_request/#{id}/comments", query: options)
+      get("/projects/#{project}/merge_requests/#{id}/notes", query: options)
     end
 
     # Gets the changes of a merge request.
@@ -123,5 +152,17 @@ class Gitlab::Client
     def merge_request_changes(project, id)
       get("/projects/#{project}/merge_request/#{id}/changes")
     end
+
+    # Gets the commits of a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_commits(5, 1)
+    #
+    # @param  [Integer] project The ID 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/#{project}/merge_request/#{id}/commits")
+    end
   end
 end

data/lib/gitlab/client/milestones.rb

@@ -61,7 +61,7 @@ class Gitlab::Client
     # Updates a milestone.
     #
     # @example
-    #   Gitlab.edit_milestone(5, 2, :state_event => 'activate')
+    #   Gitlab.edit_milestone(5, 2, { state_event: 'activate' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a milestone.

data/lib/gitlab/client/notes.rb

@@ -43,6 +43,20 @@ class Gitlab::Client
       get("/projects/#{project}/snippets/#{snippet}/notes", query: options)
     end
 
+    # Gets a list of notes for a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_notes(5, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge request.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_notes(project, merge_request, options={})
+      get("/projects/#{project}/merge_requests/#{merge_request}/notes", query: options)
+    end
+
     # Gets a single wall note.
     #
     # @example
@@ -75,12 +89,25 @@ 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 an note.
+    # @param [Integer] id The ID of a note.
     # @return [Gitlab::ObjectifiedHash]
     def snippet_note(project, snippet, id)
       get("/projects/#{project}/snippets/#{snippet}/notes/#{id}")
     end
 
+    # Gets a single merge_request note.
+    #
+    # @example
+    #   Gitlab.merge_request_note(5, 11, 3)
+    #
+    # @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.
+    # @return [Gitlab::ObjectifiedHash]
+    def merge_request_note(project, merge_request, id)
+      get("/projects/#{project}/merge_requests/#{merge_request}/notes/#{id}")
+    end
+
     # Creates a new wall note.
     #
     # @example

data/lib/gitlab/client/projects.rb

@@ -24,8 +24,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.project_search('gitlab')
-    #   Gitlab.project_search('gitlab', order_by: 'last_activity_at')
-    #   Gitlab.search_projects('gitlab', order_by: 'name', sort: 'asc')
+    #   Gitlab.project_search('gitlab', { order_by: 'last_activity_at' })
+    #   Gitlab.search_projects('gitlab', { order_by: 'name', sort: 'asc' })
     #
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :per_page Number of projects to return per page
@@ -69,14 +69,13 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.create_project('gitlab')
-    #   Gitlab.create_project('viking', :description => 'Awesome project')
-    #   Gitlab.create_project('Red', :wall_enabled => false)
+    #   Gitlab.create_project('viking', { description: 'Awesome project' })
+    #   Gitlab.create_project('Red', { wall_enabled: false })
     #
     # @param  [String] name The name of a project.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description The description of a project.
     # @option options [String] :default_branch The default branch of a project.
-    # @option options [String] :group_id The group in which to create a project.
     # @option options [String] :namespace_id The namespace in which to create a project.
     # @option options [Boolean] :wiki_enabled The wiki integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :wall_enabled The wall functionality for a project (0 = false, 1 = true).
@@ -248,6 +247,60 @@ class Gitlab::Client
       delete("/projects/#{project}/hooks/#{id}")
     end
 
+    # Gets a project git hook.
+    # See: http://docs.gitlab.com/ee/api/projects.html#show-project-git-hooks
+    #
+    # @example
+    #   Gitlab.git_hook(42)
+    #
+    # @param  [Integer] id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def git_hook(id)
+      get("/projects/#{id}/git_hook")
+    end
+
+    # Adds a project git hook.
+    # See: http://docs.gitlab.com/ee/api/projects.html#add-project-git-hook
+    #
+    # @example
+    #   Gitlab.add_git_hook(42, { deny_delete_tag: false, commit_message_regex: '\\b[A-Z]{3}-[0-9]+\\b' })
+    #
+    # @param  [Integer] id The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @param  option [Boolean] :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true)
+    # @param  option [String] :commit_message_regex Commit message regex
+    # @return [Gitlab::ObjectifiedHash] Information about added git hook.
+    def add_git_hook(id, options={})
+      post("/projects/#{id}/git_hook", body: options)
+    end
+
+    # Updates a project git hook.
+    # See: http://docs.gitlab.com/ee/api/projects.html#edit-project-git-hook
+    #
+    # @example
+    #   Gitlab.edit_git_hook(42, { deny_delete_tag: false, commit_message_regex: '\\b[A-Z]{3}-[0-9]+\\b' })
+    #
+    # @param  [Integer] id The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @param  option [Boolean] :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true)
+    # @param  option [String] :commit_message_regex Commit message regex
+    # @return [Gitlab::ObjectifiedHash] Information about updated git hook.
+    def edit_git_hook(id, options={})
+      put("/projects/#{id}/git_hook", body: options)
+    end
+
+    # Deletes a git hook from a project.
+    # See: http://docs.gitlab.com/ee/api/projects.html#delete-project-git-hook
+    #
+    # @example
+    #   Gitlab.delete_git_hook(42)
+    #
+    # @param  [Integer] id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted git hook.
+    def delete_git_hook(id, options={})
+      delete("/projects/#{id}/git_hook")
+    end
+
     # Mark this project as forked from the other
     #
     # @example
@@ -327,7 +380,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.create_fork(42)
-    #   Gitlab.create_fork(42, :sudo => 'another_username')
+    #   Gitlab.create_fork(42, { sudo: 'another_username' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Hash] options A customizable set of options.
@@ -341,7 +394,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.edit_project(42)
-    #   Gitlab.edit_project(42, :name => 'project_name')
+    #   Gitlab.edit_project(42, { name: 'project_name' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Hash] options A customizable set of options.

data/lib/gitlab/client/repositories.rb

@@ -2,37 +2,6 @@ class Gitlab::Client
   # Defines methods related to repositories.
   # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repositories.md
   module Repositories
-    # Gets a list of project repository tags.
-    #
-    # @example
-    #   Gitlab.tags(42)
-    #
-    # @param  [Integer] project The ID 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 tags(project, options={})
-      get("/projects/#{project}/repository/tags", query: options)
-    end
-    alias_method :repo_tags, :tags
-
-    # Creates a new project repository tag.
-    #
-    # @example
-    #   Gitlab.create_tag(42, 'new_tag', 'master')
-    #   Gitlab.create_tag(42, 'v1.0', 'master', 'Release 1.0')
-    #
-    # @param  [Integer] project The ID of a project.
-    # @param  [String]  tag_name The name of the new tag.
-    # @param  [String]  ref The ref (commit sha, branch name, or another tag) the tag will point to.
-    # @param  [String]  message Optional message for tag, creates annotated tag if specified.
-    # @return [Gitlab::ObjectifiedHash]
-    def create_tag(project, tag_name, ref, message='')
-      post("/projects/#{project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message })
-    end
-    alias_method :repo_create_tag, :create_tag
-
     # Get the contents of a file
     #
     # @example
@@ -56,7 +25,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.tree(42)
-    #   Gitlab.tree(42, path: "Gemfile")
+    #   Gitlab.tree(42, { path: 'Gemfile' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Hash] options A customizable set of options.

data/lib/gitlab/client/runners.rb

@@ -0,0 +1,115 @@
+class Gitlab::Client
+  # Defines methods related to runners.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+  module Runners
+
+    # Get a list of specific runners available to the user.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.runners
+    #   Gitlab.runners(:active)
+    #   Gitlab.runners(:paused)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :scope The scope of specific runners to show, one of: active, paused, online; showing all runners if none provided
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def runners(options = {})
+      get("/runners", query: options)
+    end
+
+    # Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.all_runners
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :scope The scope of runners to show, one of: specific, shared, active, paused, online; showing all runners if none provided
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def all_runners(options = {})
+      get("/runners/all", query: options)
+    end
+
+    # Get details of a runner..
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.runner(42)
+    #
+    # @param  [Integer, String] id The ID of a runner
+    # @return <Gitlab::ObjectifiedHash>
+    def runner(id)
+      get("/runners/#{id}")
+    end
+
+    # Update details of a runner.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.update_runner(42, { description: 'Awesome runner' })
+    #   Gitlab.update_runner(42, { active: false })
+    #   Gitlab.update_runner(42, { tag_list: [ 'awesome', 'runner' ] })
+    #
+    # @param  [Integer, String] id The ID of a runner
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :active The state of a runner; can be set to true or false.
+    # @option options [String] :tag_list The list of tags for a runner; put array of tags, that should be finally assigned to a runner
+    # @return <Gitlab::ObjectifiedHash>
+    def update_runner(id, options={})
+      put("/runners/#{id}", query: options)
+    end
+
+    # Remove a runner.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.delete_runner(42)
+    #
+    # @param  [Integer, String] id The ID of a runner
+    # @return <Gitlab::ObjectifiedHash>
+    def delete_runner(id)
+      delete("/runners/#{id}")
+    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.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.project_runners(42)
+    #
+    # @param  [Integer, String] id The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_runners(project_id)
+      get("/projects/#{project_id}/runners")
+    end
+
+    # Enable an available specific runner in the project.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.project_enable_runner(2, 42)
+    #
+    # @param  [Integer, String] id The ID of a project.
+    # @param  [Integer, String] id The ID of a runner.
+    # @return <Gitlab::ObjectifiedHash>
+    def project_enable_runner(project_id, id)
+      body = { runner_id: id }
+      post("/projects/#{project_id}/runners", body: body)
+    end
+
+    # Disable a specific runner from the project. It works only if the project isn't the only project associated with the specified runner.
+    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    #
+    # @example
+    #   Gitlab.project_disable_runner(2, 42)
+    #
+    # @param  [Integer, String] id The ID of a project.
+    # @param  [Integer, String] runner_id The ID of a runner.
+    # @return <Gitlab::ObjectifiedHash>
+    def project_disable_runner(id, runner_id)
+      delete("/projects/#{id}/runners/#{runner_id}")
+    end
+
+  end
+end