gitlab-faraday 5.1.0

data/lib/gitlab/client/merge_trains.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to merge trains.
+  # @see https://docs.gitlab.com/ee/api/merge_trains.html
+  module MergeTrains
+    # Get list of merge trains for a project.
+    #
+    # @example
+    #  Gitlab.merge_trains(1, scope: :active, sort: :asc)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :scope The scope of merge trains to return, one of: :active, :complete
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_trains(project, options = {})
+      get("/projects/#{url_encode project}/merge_trains", query: options)
+    end
+
+    # Get all merge requests added to a merge train for the requested target branch.
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] target_branch The target branch of the merge train.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :scope The scope of merge trains to return, one of: :active, :complete
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_train_merge_requests(project, target_branch, options = {})
+      get("/projects/#{url_encode project}/merge_trains/#{target_branch}", query: options)
+    end
+
+    # Get merge train information for the requested merge request.
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] merge_request_iid The IID of the merge request.
+    # @return [Gitlab::ObjectifiedHash]
+    def merge_train_status(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_trains/merge_requests/#{merge_request_iid}")
+    end
+
+    # Add a merge request to the merge train targeting the merge request’s target branch.
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] merge_request_iid The IID of the merge request.
+    # @param [Hash] options A customizable set of options.
+    # @option options [Boolean] :when_pipeline_succeeds Add merge request to merge train when pipeline succeeds.
+    # @option options [String] :sha If present, the SHA must match the HEAD of the source branch, otherwise the merge fails.
+    # @option options [Boolean] :squash If true, the commits are squashed into a single commit on merge.
+    # @return [Array<Gitlab::ObjectifiedHash>] <description>
+    def add_merge_request_to_merge_train(project, merge_request_iid, options = {})
+      post("/projects/#{url_encode project}/merge_trains/merge_requests/#{merge_request_iid}", query: options)
+    end
+  end
+end

data/lib/gitlab/client/milestones.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+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, 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 milestones(project, options = {})
+      get("/projects/#{url_encode project}/milestones", query: options)
+    end
+
+    # Gets a single milestone.
+    #
+    # @example
+    #   Gitlab.milestone(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [Gitlab::ObjectifiedHash]
+    def milestone(project, id)
+      get("/projects/#{url_encode project}/milestones/#{id}")
+    end
+
+    # Gets the issues of a given milestone.
+    #
+    # @example
+    #   Gitlab.milestone_issues(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name 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/#{url_encode project}/milestones/#{milestone}/issues", query: options)
+    end
+
+    # Gets the merge_requests of a given milestone.
+    #
+    # @example
+    #   Gitlab.milestone_merge_requests(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name 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_merge_requests(project, milestone, options = {})
+      get("/projects/#{url_encode project}/milestones/#{milestone}/merge_requests", query: options)
+    end
+
+    # Creates a new milestone.
+    #
+    # @example
+    #   Gitlab.create_milestone(5, 'v1.0')
+    #
+    # @param  [Integer, String] project The ID or name 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/#{url_encode project}/milestones", body: body)
+    end
+
+    # Updates a milestone.
+    #
+    # @example
+    #   Gitlab.edit_milestone(5, 2, { state_event: 'activate' })
+    #
+    # @param  [Integer, String] project The ID or name 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/#{url_encode project}/milestones/#{id}", body: options)
+    end
+
+    # Delete a project milestone.
+    #
+    # @example
+    #   Gitlab.delete_milestone(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [nil] This API call returns an empty response body.
+    def delete_milestone(project, id)
+      delete("/projects/#{url_encode project}/milestones/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/namespaces.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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,313 @@
+# frozen_string_literal: true
+
+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/#{url_encode 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/#{url_encode 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/#{url_encode 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/#{url_encode project}/merge_requests/#{merge_request}/notes", query: options)
+    end
+    alias merge_request_comments merge_request_notes
+
+    # Gets a list of notes for an epic.
+    #
+    # @example
+    #   Gitlab.epic_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a group.
+    # @param [Integer] epic The ID of an epic.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def epic_notes(group, epic, options = {})
+      get("/groups/#{url_encode group}/epics/#{epic}/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/#{url_encode 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/#{url_encode 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/#{url_encode 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/#{url_encode 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, String] project The ID or name 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/#{url_encode 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, String] project The ID or name 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/#{url_encode 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, String] project The ID or name 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/#{url_encode 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/#{url_encode project}/merge_requests/#{merge_request}/notes", body: { body: body })
+    end
+    alias create_merge_request_comment create_merge_request_note
+
+    # Creates a new epic note.
+    #
+    # @example
+    #   Gitlab.create_epic_note(6, 1, 'Adding a note to my epic.')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic The ID of an epic.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_epic_note(group, epic, body)
+      post("/groups/#{url_encode group}/epics/#{epic}/notes", body: { body: body })
+    end
+
+    # Deletes a wall note.
+    #
+    # @example
+    #   Gitlab.delete_note(5, 15)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_note(project, id)
+      delete("/projects/#{url_encode project}/notes/#{id}")
+    end
+
+    # Deletes an issue note.
+    #
+    # @example
+    #   Gitlab.delete_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 delete_issue_note(project, issue, id)
+      delete("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
+    end
+
+    # Deletes a snippet note.
+    #
+    # @example
+    #   Gitlab.delete_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 delete_snippet_note(project, snippet, id)
+      delete("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
+    end
+
+    # Deletes a merge_request note.
+    #
+    # @example
+    #   Gitlab.delete_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 delete_merge_request_note(project, merge_request, id)
+      delete("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
+    end
+    alias delete_merge_request_comment delete_merge_request_note
+
+    # Modifies a wall note.
+    #
+    # @example
+    #   Gitlab.edit_note(5, 15, 'This is an edited note')
+    #
+    # @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: note_content(body))
+    end
+
+    # Modifies an issue note.
+    #
+    # @example
+    #   Gitlab.edit_issue_note(5, 10, 1, 'This is an edited issue note')
+    #
+    # @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: note_content(body))
+    end
+
+    # Modifies a snippet note.
+    #
+    # @example
+    #   Gitlab.edit_snippet_note(5, 11, 3, 'This is an edited snippet note')
+    #
+    # @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: note_content(body))
+    end
+
+    # Modifies a merge_request note.
+    #
+    # @example
+    #   Gitlab.edit_merge_request_note(5, 11, 3, 'This is an edited merge request note')
+    #
+    # @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: note_content(body))
+    end
+    alias 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)
+        warn '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/packages.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to GitLab Packages.
+  # @see https://docs.gitlab.com/ee/api/packages.html
+  module Packages
+    # Gets a list of project packages.
+    #
+    # @example
+    #   Gitlab.project_packages(5)
+    #   Gitlab.project_packages(5, { package_type: 'npm', sort: 'desc' })
+    #
+    # @param   [Integer, String] :project the ID or name of a project.
+    # @param   [Hash] options A customizable set of options.
+    # @options options [String] :order_by The field to use as order. One of created_at (default), name, version, or type.
+    # @options options [String] :sort The direction of the order, either asc (default) for ascending order or desc for descending order.
+    # @options options [String] :package_type Filter the returned packages by type. One of conan, maven, npm, pypi, composer, nuget, helm, terraform_module, or golang.
+    # @options options [String] :package_name Filter the project packages with a fuzzy search by name.
+    # @options options [String] :include_versionless When set to true, versionless packages are included in the response.
+    # @options options [String] :status Filter the returned packages by status. One of default (default), hidden, processing, error, or pending_destruction.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def project_packages(project, options = {})
+      get("/projects/#{url_encode project}/packages", query: options)
+    end
+
+    # Gets a list of project packages.
+    #
+    # @example
+    #   Gitlab.group_packages(5)
+    #   Gitlab.group_packages(5, { package_type: 'npm', sort: 'desc' })
+    #
+    # @param   [Integer, String] project the ID or name of a project.
+    # @param   [Hash] options A customizable set of options.
+    # @options options [String] :exclude_subgroups If the parameter is included as true, packages from projects from subgroups are not listed. Default is false.
+    # @options options [String] :order_by The field to use as order. One of created_at (default), name, version, or type.
+    # @options options [String] :sort The direction of the order, either asc (default) for ascending order or desc for descending order.
+    # @options options [String] :package_type Filter the returned packages by type. One of conan, maven, npm, pypi, composer, nuget, helm, terraform_module, or golang.
+    # @options options [String] :package_name Filter the project packages with a fuzzy search by name.
+    # @options options [String] :include_versionless When set to true, versionless packages are included in the response.
+    # @options options [String] :status Filter the returned packages by status. One of default (default), hidden, processing, error, or pending_destruction.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def group_packages(group, options = {})
+      get("/groups/#{url_encode group}/packages", query: options)
+    end
+
+    # Get a single project package.
+    #
+    # @example
+    #   Gitlab.project_package(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id ID of a package.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_package(project, id)
+      get("/projects/#{url_encode project}/packages/#{id}")
+    end
+
+    # Get a list of package files of a single package.
+    #
+    # @example
+    #   Gitlab.project_package_files(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id ID of a package.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_package_files(project, id)
+      get("/projects/#{url_encode project}/packages/#{id}/package_files")
+    end
+
+    # Deletes a project package.
+    #
+    # @example
+    #   Gitlab.delete_project_package(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id ID of a package.
+    # @return [void] This API call returns an empty response body.
+    def delete_project_package(project, id)
+      delete("/projects/#{url_encode project}/packages/#{id}")
+    end
+
+    # Delete a package file.
+    #
+    # @example
+    #   Gitlab.delete_project_file(5, 3, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] package_id ID of a package.
+    # @param  [Integer] file_id ID of a package file.
+    # @return [void] This API call returns an empty response body.
+    def delete_project_package_file(project, package_id, file_id)
+      delete("/projects/#{url_encode project}/packages/#{package_id}/package_files/#{file_id}")
+    end
+  end
+end