gitlab-akerl 4.0.0

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] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def labels(project)
+      get("/projects/#{project}/labels")
+    end
+
+    # Creates a new label.
+    #
+    # @example
+    #   Gitlab.create_label(42, "Backlog", '#DD10AA')
+    #
+    # @param  [Integer] project The ID 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/#{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] project The ID 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/#{project}/labels", body: options.merge(name: name))
+    end
+
+    # Deletes a label.
+    #
+    # @example
+    #   Gitlab.delete_label(2, 'Backlog')
+    #
+    # @param  [Integer] project The ID 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/#{project}/labels", body: { name: name })
+    end
+  end
+end

data/lib/gitlab/client/merge_requests.rb

@@ -0,0 +1,168 @@
+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 })
+    #
+    # @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 merge_requests(project, options={})
+      get("/projects/#{project}/merge_requests", query: options)
+    end
+
+    # Gets a single merge request.
+    #
+    # @example
+    #   Gitlab.merge_request(5, 36)
+    #
+    # @param  [Integer] project The ID 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}")
+    end
+
+    # Creates a merge request.
+    #
+    # @example
+    #   Gitlab.create_merge_request(5, 'New merge request',
+    #     { 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 })
+    #
+    # @param  [Integer] project The ID 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={})
+      body = { title: title }.merge(options)
+      post("/projects/#{project}/merge_requests", body: body)
+    end
+
+    # Updates a merge request.
+    #
+    # @example
+    #   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.
+    # @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)
+    end
+
+    # Accepts a merge request.
+    #
+    # @example
+    #   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.
+    # @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/#{project}/merge_request/#{id}/merge", body: options)
+    end
+
+    # Adds a comment to a merge request.
+    #
+    # @example
+    #   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] 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_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 })
+    #
+    # @param  [Integer] project The ID 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/#{project}/merge_requests/#{id}/notes", query: options)
+    end
+
+    # Gets the changes of a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_changes(5, 1)
+    #
+    # @param  [Integer] project The ID 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/#{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

@@ -0,0 +1,78 @@
+class Gitlab::Client
+  # Defines methods related to milestones.
+  # @see https://docs.gitlab.com/ce/api/milestones.html
+  module Milestones
+    # Gets a list of project's milestones.
+    #
+    # @example
+    #   Gitlab.milestones(5)
+    #
+    # @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 milestones(project, options={})
+      get("/projects/#{project}/milestones", query: options)
+    end
+
+    # Gets a single milestone.
+    #
+    # @example
+    #   Gitlab.milestone(5, 36)
+    #
+    # @param  [Integer, String] project The ID of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [Gitlab::ObjectifiedHash]
+    def milestone(project, id)
+      get("/projects/#{project}/milestones/#{id}")
+    end
+
+    # Gets the issues of a given milestone.
+    #
+    # @example
+    #   Gitlab.milestone_issues(5, 2)
+    #
+    # @param  [Integer, String] project The ID of a project.
+    # @param  [Integer, String] milestone The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def milestone_issues(project, milestone, options={})
+      get("/projects/#{project}/milestones/#{milestone}/issues", query: options)
+    end
+
+    # Creates a new milestone.
+    #
+    # @example
+    #   Gitlab.create_milestone(5, 'v1.0')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] title The title of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @return [Gitlab::ObjectifiedHash] Information about created milestone.
+    def create_milestone(project, title, options={})
+      body = { title: title }.merge(options)
+      post("/projects/#{project}/milestones", body: body)
+    end
+
+    # Updates a milestone.
+    #
+    # @example
+    #   Gitlab.edit_milestone(5, 2, { state_event: 'activate' })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a milestone.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @option options [String] :state_event The state of a milestone ('close' or 'activate').
+    # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
+    def edit_milestone(project, id, options={})
+      put("/projects/#{project}/milestones/#{id}", body: options)
+    end
+  end
+end

data/lib/gitlab/client/namespaces.rb

@@ -0,0 +1,20 @@
+class Gitlab::Client
+  # Defines methods related to namespaces
+  # @see https://docs.gitlab.com/ce/api/namespaces.html
+  module Namespaces
+    # Gets a list of namespaces.
+    # @see https://docs.gitlab.com/ce/api/namespaces.html#list-namespaces
+    #
+    # @example
+    #   Gitlab.namespaces
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @options options [Integer] :page The page number.
+    # @options options [Integer] :per_page The number of results per page.
+    # @options opttion [String]  :search The string to search for.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def namespaces(options={})
+      get("/namespaces", query: options)
+    end
+  end
+end

data/lib/gitlab/client/notes.rb

@@ -0,0 +1,161 @@
+class Gitlab::Client
+  # Defines methods related to notes.
+  # @see https://docs.gitlab.com/ce/api/notes.html
+  module Notes
+    # Gets a list of projects notes.
+    #
+    # @example
+    #   Gitlab.notes(5)
+    #
+    # @param [Integer] project The ID of a project.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def notes(project, options={})
+      get("/projects/#{project}/notes", query: options)
+    end
+
+    # Gets a list of notes for a issue.
+    #
+    # @example
+    #   Gitlab.issue_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_notes(project, issue, options={})
+      get("/projects/#{project}/issues/#{issue}/notes", query: options)
+    end
+
+    # Gets a list of notes for a snippet.
+    #
+    # @example
+    #   Gitlab.snippet_notes(5, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def snippet_notes(project, snippet, options={})
+      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
+    #   Gitlab.note(5, 15)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def note(project, id)
+      get("/projects/#{project}/notes/#{id}")
+    end
+
+    # Gets a single issue note.
+    #
+    # @example
+    #   Gitlab.issue_note(5, 10, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def issue_note(project, issue, id)
+      get("/projects/#{project}/issues/#{issue}/notes/#{id}")
+    end
+
+    # Gets a single snippet note.
+    #
+    # @example
+    #   Gitlab.snippet_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @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
+    #   Gitlab.create_note(5, 'This is a wall note!')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_note(project, body)
+      post("/projects/#{project}/notes", body: { body: body })
+    end
+
+    # Creates a new issue note.
+    #
+    # @example
+    #   Gitlab.create_issue_note(6, 1, 'Adding a note to my issue.')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] issue The ID of an issue.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_issue_note(project, issue, body)
+      post("/projects/#{project}/issues/#{issue}/notes", body: { body: body })
+    end
+
+    # Creates a new snippet note.
+    #
+    # @example
+    #   Gitlab.create_snippet_note(3, 2, 'Look at this awesome snippet!')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] snippet The ID of a snippet.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_snippet_note(project, snippet, body)
+      post("/projects/#{project}/snippets/#{snippet}/notes", body: { body: body })
+    end
+
+    # Creates a new note for a single merge request.
+    #
+    # @example
+    #   Gitlab.create_merge_request_note(5, 3, 'This MR is ready for review.')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge request.
+    # @param [String] body The content of a note.
+    def create_merge_request_note(project, merge_request, body)
+      post("/projects/#{project}/merge_requests/#{merge_request}/notes", body: { body: body })
+    end
+  end
+end