fs-gitlab 4.18.1

data/lib/gitlab/client/protected_tags.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to Protected Tags.
+  # @see https://docs.gitlab.com/ce/api/protected_tags.html
+  module ProtectedTags
+    # Gets a list of protected tags from a project
+    #
+    # @example
+    #   Gitlab.protected_tags(1)
+    #
+    # @param [Integer, String] project(required) The ID or name 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>] List of all protected tags requested
+    def protected_tags(project, options = {})
+      get("/projects/#{url_encode project}/protected_tags", query: options)
+    end
+
+    # Gets a single protected tag or wildcard protected tag.
+    #
+    # @example
+    #   Gitlab.protected_tag(1, 'release-1-0')
+    #
+    # @param [Integer, String] project(required) The ID or name of a project.
+    # @param [String] name(required) The name of the tag or wildcard
+    # @return <Gitlab::ObjectifiedHash] Information about the requested protected tag
+    def protected_tag(project, name)
+      get("/projects/#{url_encode project}/protected_tags/#{name}")
+    end
+
+    # Protects a single repository tag or several project repository tags using a wildcard protected tag.
+    #
+    # @example
+    #    Gitlab.protect_repository_tag(1, 'release-1-0')
+    #    Gitlab.protect_repository_tag(1, 'release-1-0', create_access_level: 30)
+    #
+    # @param [Integer, String] project(required) The ID or name of a project.
+    # @param [String] name(required) The name of the tag or wildcard
+    # @option options [Integer] :create_access_level Access levels allowed to create (defaults: 40, maintainer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the protected repository tag
+    def protect_repository_tag(project, name, options = {})
+      body = { name: name }.merge(options)
+      post("/projects/#{url_encode project}/protected_tags", body: body)
+    end
+
+    # Unprotects the given protected tag or wildcard protected tag.
+    #
+    # @example
+    #    Gitlab.unprotect_repository_tag(1, 'release-1-0')
+    #
+    # @param [Integer, String] project(required) The ID or name of a project.
+    # @param [String] name(required) The name of the tag or wildcard
+    # @return [nil] This API call returns an empty response body.
+    def unprotect_repository_tag(project, name)
+      delete("/projects/#{url_encode project}/protected_tags/#{name}")
+    end
+  end
+end

data/lib/gitlab/client/remote_mirrors.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to remote mirrors.
+  # @see https://docs.gitlab.com/ee/api/remote_mirrors.html
+  module RemoteMirrors
+    # List a project's remote mirrors
+    #
+    # @example
+    #   Gitlab.remote_mirrors(42)
+    #   Gitlab.remote_mirrors('gitlab-org/gitlab')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def remote_mirrors(project)
+      get("/projects/#{url_encode project}/remote_mirrors")
+    end
+
+    # Create a remote mirror
+    #
+    # @example
+    #   Gitlab.create_remote_mirror(42, 'https://mirror-bot@gitlab.com/gitlab-org/gitlab.git', enabled: true)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] url The full URL of the remote repository.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :enabled Determines if the mirror is enabled.
+    # @option options [Boolean] :only_protected_branches Determines if only protected branches are mirrored.
+    # @option options [Boolean] :keep_divergent_refs Determines if divergent refs are skipped.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_remote_mirror(project, url, options = {})
+      post("/projects/#{url_encode project}/remote_mirrors", body: options.merge(url: url))
+    end
+
+    # Update a remote mirror's attributes
+    #
+    # @example
+    #   Gitlab.edit_remote_mirror(42, 66, only_protected_branches: true)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the remote mirror.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :enabled Determines if the mirror is enabled.
+    # @option options [Boolean] :only_protected_branches Determines if only protected branches are mirrored.
+    # @option options [Boolean] :keep_divergent_refs Determines if divergent refs are skipped.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_remote_mirror(project, id, options = {})
+      put("/projects/#{url_encode project}/remote_mirrors/#{id}", body: options)
+    end
+  end
+end

data/lib/gitlab/client/repositories.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to repositories.
+  # @see https://docs.gitlab.com/ce/api/repositories.html
+  module Repositories
+    # Get file tree project (root level).
+    #
+    # @example
+    #   Gitlab.tree(42)
+    #   Gitlab.tree(42, { path: 'Gemfile' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :path The path inside repository.
+    # @option options [String] :ref The name of a repository branch or tag.
+    # @option options [Integer] :per_page Number of results to show per page (default = 20)
+    # @return [Gitlab::ObjectifiedHash]
+    def tree(project, options = {})
+      get("/projects/#{url_encode project}/repository/tree", query: options)
+    end
+    alias repo_tree tree
+
+    # Get project repository archive
+    #
+    # @example
+    #   Gitlab.repo_archive(42)
+    #   Gitlab.repo_archive(42, 'deadbeef')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] ref The commit sha, branch, or tag to download.
+    # @param  [String] format The archive format. Options are: tar.gz (default), tar.bz2, tbz, tbz2, tb2, bz2, tar, and zip
+    # @return [Gitlab::FileResponse]
+    def repo_archive(project, ref = 'master', format = 'tar.gz')
+      get("/projects/#{url_encode project}/repository/archive.#{format}",
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          query: { sha: ref },
+          parser: proc { |body, _|
+            if body.encoding == Encoding::ASCII_8BIT # binary response
+              ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+            else # error with json response
+              ::Gitlab::Request.parse(body)
+            end
+          })
+    end
+
+    # Compares branches, tags or commits.
+    #
+    # @example
+    #   Gitlab.compare(42, 'master', 'feature/branch')
+    #   Gitlab.repo_compare(42, 'master', 'feature/branch')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] from The commit SHA or branch name of from branch.
+    # @param [String] to The commit SHA or branch name of to branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def compare(project, from, to)
+      get("/projects/#{url_encode project}/repository/compare", query: { from: from, to: to })
+    end
+    alias repo_compare compare
+
+    # Get the common ancestor for 2 refs (commit SHAs, branch names or tags).
+    #
+    # @example
+    #   Gitlab.merge_base(42, ['master', 'feature/branch'])
+    #   Gitlab.merge_base(42, ['master', 'feature/branch'])
+    #
+    # @param [Integer, String] project The ID or URL-encoded path of the project.
+    # @param [Array] refs Array containing 2 commit SHAs, branch names, or tags.
+    # @return [Gitlab::ObjectifiedHash]
+    def merge_base(project, refs)
+      get("/projects/#{url_encode project}/repository/merge_base", query: { refs: refs })
+    end
+
+    # Get project repository contributors.
+    #
+    # @example
+    #   Gitlab.contributors(42)
+    #   Gitlab.contributors(42, { order: 'name' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :order_by Order by name, email or commits (default = commits).
+    # @option options [String] :sort Sort order asc or desc (default = asc).
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def contributors(project, options = {})
+      get("/projects/#{url_encode project}/repository/contributors", query: options)
+    end
+    alias repo_contributors contributors
+
+    # Generate changelog data
+    #
+    # @example
+    #   Gitlab.generate_changelog(42, 'v1.0.0')
+    #   Gitlab.generate_changelog(42, 'v1.0.0', branch: 'main')
+    #
+    # @param [Integer, String] project The ID or name of a project
+    # @param [String] version The version to generate the changelog for
+    # @param [Hash] options A customizable set of options
+    # @option options [String] :from The start of the range of commits (SHA)
+    # @option options [String] :to The end of the range of commits (as a SHA) to use for the changelog
+    # @option options [String] :date The date and time of the release, defaults to the current time
+    # @option options [String] :branch The branch to commit the changelog changes to
+    # @option options [String] :trailer The Git trailer to use for including commits
+    # @option options [String] :file The file to commit the changes to
+    # @option options [String] :message The commit message to produce when committing the changes
+    # @return [bool]
+    def generate_changelog(project, version, options = {})
+      post("/projects/#{url_encode project}/repository/changelog", body: options.merge(version: version))
+    end
+  end
+end

data/lib/gitlab/client/repository_files.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+class Gitlab::Client
+  # Defines methods related to repository files.
+  # @see https://docs.gitlab.com/ce/api/repository_files.html
+  module RepositoryFiles
+    # Get the contents of a file
+    #
+    # @example
+    #   Gitlab.file_contents(42, 'Gemfile')
+    #   Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] filepath The relative path of the file in the repository
+    # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
+    # @return [String]
+    def file_contents(project, filepath, ref = 'master')
+      get "/projects/#{url_encode project}/repository/files/#{url_encode filepath}/raw",
+          query: { ref: ref },
+          format: nil,
+          headers: { Accept: 'text/plain' },
+          parser: ::Gitlab::Request::Parser
+    end
+    alias repo_file_contents file_contents
+
+    # Get file blame from repository
+    #
+    # @example
+    #   Gitlab.get_file_blame(42, "README.md", "master")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] file_path The full path of the file.
+    # @param  [String] ref The name of branch, tag or commit.
+    # @return [Gitlab::ObjectifiedHash]
+    #
+    def get_file_blame(project, file_path, ref)
+      get("/projects/#{url_encode project}/repository/files/#{url_encode file_path}/blame", query: {
+            ref: ref
+          })
+    end
+
+    # Gets a repository file.
+    #
+    # @example
+    #   Gitlab.get_file(42, "README.md", "master")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] file_path The full path of the file.
+    # @param  [String] ref The name of branch, tag or commit.
+    # @return [Gitlab::ObjectifiedHash]
+    def get_file(project, file_path, ref)
+      get("/projects/#{url_encode project}/repository/files/#{url_encode file_path}", query: {
+            ref: ref
+          })
+    end
+
+    # Creates a new repository file.
+    #
+    # @example
+    #   Gitlab.create_file(42, "path", "branch", "content", "commit message")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] path full path to new file.
+    # @param  [String] branch the name of the branch.
+    # @param  [String] content file content.
+    # @param  [String] commit_message ...commit message.
+    # @param  [Hash] options Optional additional details for commit
+    # @option options [String] :author_name Commit author's name
+    # @option options [String] :author_email Commit author's email address
+    # @return [Gitlab::ObjectifiedHash]
+    def create_file(project, path, branch, content, commit_message, options = {})
+      post("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+        branch: branch,
+        commit_message: commit_message
+      }.merge(options).merge(encoded_content_attributes(content)))
+    end
+
+    # Edits an existing repository file.
+    #
+    # @example
+    #   Gitlab.edit_file(42, "path", "branch", "content", "commit message")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] path full path of file to update.
+    # @param  [String] branch the name of the branch to commit changes to.
+    # @param  [String] content new file content.
+    # @param  [String] commit_message ...commit message.
+    # @param  [Hash] options Optional additional details for commit
+    # @option options [String] :author_name Commit author's name
+    # @option options [String] :author_email Commit author's email address
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_file(project, path, branch, content, commit_message, options = {})
+      put("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+        branch: branch,
+        commit_message: commit_message
+      }.merge(options).merge(encoded_content_attributes(content)))
+    end
+
+    # Removes an existing repository file.
+    #
+    # @example
+    #   Gitlab.remove_file(42, "path", "branch", "commit message")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] path full path of file to delete.
+    # @param  [String] branch the name of the branch to commit the deletion to.
+    # @param  [String] commit_message ...a commit message ;)
+    # @param  [Hash] options Optional additional details for commit
+    # @option options [String] :author_name Commit author's name
+    # @option options [String] :author_email Commit author's email address
+    # @return [Gitlab::ObjectifiedHash]
+    def remove_file(project, path, branch, commit_message, options = {})
+      delete("/projects/#{url_encode project}/repository/files/#{url_encode path}",
+             body: {
+               branch: branch,
+               commit_message: commit_message
+             }.merge(options))
+    end
+
+    private
+
+    def encoded_content_attributes(content)
+      {
+        encoding: 'base64',
+        content: Base64.encode64(content)
+      }
+    end
+  end
+end

data/lib/gitlab/client/repository_submodules.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to repository submodules.
+  # @see https://docs.gitlab.com/ce/api/repository_submodules.html
+  module RepositorySubmodules
+    # Edits an existing repository submodule.
+    #
+    # @example
+    #   Gitlab.edit_file(42, "submodule", {
+    #     branch: "branch",
+    #     commit_sha: "3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88",
+    #     commit_message: "commit message"
+    #   })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] submodule full path of submodule to update.
+    # @param  [Hash] options A customizable set of options.
+    # @param  options [String] :branch the name of the branch to commit changes to.
+    # @param  options [String] :commit_sha commit SHA to update the submodule to.
+    # @param  options [String] :commit_message commit message text.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_submodule(project, submodule, options = {})
+      put("/projects/#{url_encode project}/repository/submodules/#{url_encode submodule}", body: options)
+    end
+  end
+end

data/lib/gitlab/client/resource_label_events.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to resource label events.
+  # @see https://docs.gitlab.com/ee/api/resource_label_events.html
+  module ResourceLabelEvents
+    # Gets a list of all label events for a single issue.
+    #
+    # @example
+    #   Gitlab.issue_label_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_label_events(project, issue_iid)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_label_events")
+    end
+
+    # Returns a single label event for a specific project issue
+    #
+    # @example
+    #   Gitlab.issue_label_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @param  [Integer] id The ID of a label event.
+    # @return Gitlab::ObjectifiedHash
+    def issue_label_event(project, issue_iid, id)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_label_events/#{id}")
+    end
+
+    # Gets a list of all label events for a single epic.
+    #
+    # @example
+    #   Gitlab.epic_label_events(5, 42)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic_id The ID of an epic.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def epic_label_events(group, epic_id)
+      get("/groups/#{url_encode group}/epics/#{epic_id}/resource_label_events")
+    end
+
+    # Returns a single label event for a specific group epic
+    #
+    # @example
+    #   Gitlab.epic_label_event(5, 42, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic_id The ID of an epic.
+    # @param  [Integer] id The ID of a label event.
+    # @return Gitlab::ObjectifiedHash
+    def epic_label_event(group, epic_id, id)
+      get("/groups/#{url_encode group}/epics/#{epic_id}/resource_label_events/#{id}")
+    end
+
+    # Gets a list of all label events for a single merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_label_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_label_events(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_label_events")
+    end
+
+    # Returns a single label event for a specific project merge request
+    #
+    # @example
+    #   Gitlab.merge_request_label_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of an merge request.
+    # @param  [Integer] id The ID of a label event.
+    # @return Gitlab::ObjectifiedHash
+    def merge_request_label_event(project, merge_request_iid, id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_label_events/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/resource_state_events.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to resource state events.
+  # @see https://docs.gitlab.com/ee/api/resource_state_events.html
+  module ResourceStateEvents
+    # Gets a list of all state events for a single issue.
+    #
+    # @example
+    #   Gitlab.issue_state_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_state_events(project, issue_iid)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events")
+    end
+
+    # Returns a single state event for a specific project issue
+    #
+    # @example
+    #   Gitlab.issue_state_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @param  [Integer] id The ID of a resource event.
+    # @return Gitlab::ObjectifiedHash
+    def issue_state_event(project, issue_iid, id)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events/#{id}")
+    end
+
+    # Gets a list of all state events for a single merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_state_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_state_events(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events")
+    end
+
+    # Returns a single state event for a specific project merge request
+    #
+    # @example
+    #   Gitlab.merge_request_state_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of an merge request.
+    # @param  [Integer] id The ID of a state event.
+    # @return Gitlab::ObjectifiedHash
+    def merge_request_state_event(project, merge_request_iid, id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events/#{id}")
+    end
+  end
+end