fs-gitlab 4.18.1

data/lib/gitlab/client/builds.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://docs.gitlab.com/ce/api/builds.html
+  module Builds
+    # Gets a list of project builds.
+    #
+    # @example
+    #   Gitlab.builds(5)
+    #   Gitlab.builds(5, { per_page: 10, page:  2 })
+    #
+    # @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.
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def builds(project, options = {})
+      get("/projects/#{url_encode project}/builds", query: options)
+    end
+
+    # Gets a single build.
+    #
+    # @example
+    #   Gitlab.build(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash]
+    def build(project, id)
+      get("/projects/#{url_encode project}/builds/#{id}")
+    end
+
+    # Gets build artifacts.
+    #
+    # @example
+    #   Gitlab.build_artifacts(1, 8)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::FileResponse]
+    def build_artifacts(project, id)
+      get("/projects/#{url_encode project}/builds/#{id}/artifacts",
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          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
+
+    # Gets a list of builds for specific commit in a project.
+    #
+    # @example
+    #   Gitlab.commit_builds(5, 'asdf')
+    #   Gitlab.commit_builds(5, 'asdf', { per_page: 10, page: 2 })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The SHA checksum of a commit.
+    # @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>] The list of builds.
+    def commit_builds(project, sha, options = {})
+      get("/projects/#{url_encode project}/repository/commits/#{sha}/builds", query: options)
+    end
+
+    # Cancels a build.
+    #
+    # @example
+    #   Gitlab.build_cancel(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash] The builds changes.
+    def build_cancel(project, id)
+      post("/projects/#{url_encode project}/builds/#{id}/cancel")
+    end
+
+    # Retry a build.
+    #
+    # @example
+    #   Gitlab.build_retry(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Array<Gitlab::ObjectifiedHash>] The builds changes.
+    def build_retry(project, id)
+      post("/projects/#{url_encode project}/builds/#{id}/retry")
+    end
+
+    # Erase a single build of a project (remove build artifacts and a build trace)
+    #
+    # @example
+    #   Gitlab.build_erase(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash] The build's changes.
+    def build_erase(project, id)
+      post("/projects/#{url_encode project}/builds/#{id}/erase")
+    end
+  end
+end

data/lib/gitlab/client/commits.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to repository commits.
+  # @see https://docs.gitlab.com/ce/api/commits.html
+  module Commits
+    # Gets a list of project commits.
+    #
+    # @example
+    #   Gitlab.commits('viking')
+    #   Gitlab.repo_commits('gitlab', { ref: 'api' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref The branch or tag name of a project repository.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commits(project, options = {})
+      get("/projects/#{url_encode project}/repository/commits", query: options)
+    end
+    alias repo_commits commits
+
+    # Gets a specific commit identified by the commit hash or name of a branch or tag.
+    #
+    # @example
+    #   Gitlab.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @return [Gitlab::ObjectifiedHash]
+    def commit(project, sha)
+      get("/projects/#{url_encode project}/repository/commits/#{sha}")
+    end
+    alias repo_commit commit
+
+    # Get all references (from branches or tags) a commit is pushed to.
+    #
+    # @example
+    #   Gitlab.commit_refs(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :type The scope of commits. Possible values `branch`, `tag`, `all`. Default is `all`.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Gitlab::ObjectifiedHash]
+    def commit_refs(project, sha, options = {})
+      get("/projects/#{url_encode project}/repository/commits/#{sha}/refs", query: options)
+    end
+
+    # Cherry picks a commit to a given branch.
+    #
+    # @example
+    #   Gitlab.cherry_pick_commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @param  [String] branch The name of the branch
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :dry_run Don't commit any changes
+    # @return [Gitlab::ObjectifiedHash]
+    def cherry_pick_commit(project, sha, branch, options = {})
+      options[:branch] = branch
+
+      post("/projects/#{url_encode project}/repository/commits/#{sha}/cherry_pick", body: options)
+    end
+
+    # Reverts a commit in a given branch.
+    #
+    # @example
+    #   Gitlab.revert_commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @param  [String] branch The name of the branch
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :dry_run Don't commit any changes
+    # @return [Gitlab::ObjectifiedHash]
+    def revert_commit(project, sha, branch, options = {})
+      options[:branch] = branch
+
+      post("/projects/#{url_encode project}/repository/commits/#{sha}/revert", body: options)
+    end
+
+    # Get the diff of a commit in a project.
+    #
+    # @example
+    #   Gitlab.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The name of a repository branch or tag or if not given the default branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def commit_diff(project, sha)
+      get("/projects/#{url_encode project}/repository/commits/#{sha}/diff")
+    end
+    alias repo_commit_diff commit_diff
+
+    # Gets a list of comments for a commit.
+    #
+    # @example
+    #   Gitlab.commit_comments(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] sha The commit hash or name of a repository branch or tag.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commit_comments(project, commit, options = {})
+      get("/projects/#{url_encode project}/repository/commits/#{commit}/comments", query: options)
+    end
+    alias repo_commit_comments commit_comments
+
+    # Creates a new comment for a commit.
+    #
+    # @example
+    #   Gitlab.create_commit_comment(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b', 'Nice work on this commit!')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag.
+    # @param  [String] note The text of a comment.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :path The file path.
+    # @option options [Integer] :line The line number.
+    # @option options [String] :line_type The line type (new or old).
+    # @return [Gitlab::ObjectifiedHash] Information about created comment.
+    def create_commit_comment(project, commit, note, options = {})
+      post("/projects/#{url_encode project}/repository/commits/#{commit}/comments", body: options.merge(note: note))
+    end
+    alias repo_create_commit_comment create_commit_comment
+
+    # Get the status of a commit
+    #
+    # @example
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', { name: 'jenkins' })
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', { name: 'jenkins', all: true })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref Filter by ref name, it can be branch or tag
+    # @option options [String] :stage Filter by stage
+    # @option options [String] :name Filter by status name, eg. jenkins
+    # @option options [Boolean] :all The flag to return all statuses, not only latest ones
+    def commit_status(project, sha, options = {})
+      get("/projects/#{url_encode project}/repository/commits/#{sha}/statuses", query: options)
+    end
+    alias repo_commit_status commit_status
+
+    # Adds or updates a status of a commit.
+    #
+    # @example
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'success')
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'failed', { name: 'jenkins' })
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'canceled', { name: 'jenkins', target_url: 'http://example.com/builds/1' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash
+    # @param  [String] state of the status. Can be: pending, running, success, failed, canceled
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref The ref (branch or tag) to which the status refers
+    # @option options [String] :name Filter by status name, eg. jenkins
+    # @option options [String] :target_url The target URL to associate with this status
+    def update_commit_status(project, sha, state, options = {})
+      post("/projects/#{url_encode project}/statuses/#{sha}", body: options.merge(state: state))
+    end
+    alias repo_update_commit_status update_commit_status
+
+    # Creates a single commit with one or more changes
+    #
+    # @see https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions
+    # Introduced in Gitlab 8.13
+    #
+    # @example
+    # Gitlab.create_commit(2726132, 'master', 'refactors everything', [{action: 'create', file_path: '/foo.txt', content: 'bar'}])
+    # Gitlab.create_commit(2726132, 'master', 'refactors everything', [{action: 'delete', file_path: '/foo.txt'}])
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param [String] branch the branch name you wish to commit to
+    # @param [String] message the commit message
+    # @param [Array[Hash]] An array of action hashes to commit as a batch. See the next table for what attributes it can take.
+    # @option options [String] :author_email the email address of the author
+    # @option options [String] :author_name the name of the author
+    # @return [Gitlab::ObjectifiedHash] hash of commit related data
+    def create_commit(project, branch, message, actions, options = {})
+      payload = {
+        branch: branch,
+        commit_message: message,
+        actions: actions
+      }.merge(options)
+      post("/projects/#{url_encode project}/repository/commits", body: payload)
+    end
+
+    # Gets a list of merge requests for a commit.
+    #
+    # @see https://docs.gitlab.com/ce/api/commits.html#list-merge-requests-associated-with-a-commit
+    # Introduced in Gitlab 10.7
+    #
+    # @example
+    #   Gitlab.commit_merge_requests(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] sha The commit hash.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commit_merge_requests(project, commit, options = {})
+      get("/projects/#{url_encode project}/repository/commits/#{commit}/merge_requests", query: options)
+    end
+    alias repo_commit_merge_requests commit_merge_requests
+  end
+end

data/lib/gitlab/client/container_registry.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to GitLab Container Registry.
+  # @see https://docs.gitlab.com/ce/api/container_registry.html
+  module ContainerRegistry
+    # Get a list of registry repositories in a project.
+    #
+    # @example
+    #   Gitlab.registry_repositories(5)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] Returns list of registry repositories in a project.
+    def registry_repositories(project)
+      get("/projects/#{url_encode project}/registry/repositories")
+    end
+
+    # Delete a repository in registry.
+    #
+    # @example
+    #   Gitlab.delete_registry_repository(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of registry repository.
+    # @return [void] This API call returns an empty response body.
+    def delete_registry_repository(project, id)
+      delete("/projects/#{url_encode project}/registry/repositories/#{id}")
+    end
+
+    # Get a list of tags for given registry repository.
+    #
+    # @example
+    #   Gitlab.registry_repository_tags(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] repository_id The ID of registry repository.
+    # @return [Array<Gitlab::ObjectifiedHash>] Returns list of tags of a registry repository.
+    def registry_repository_tags(project, repository_id)
+      get("/projects/#{url_encode project}/registry/repositories/#{repository_id}/tags")
+    end
+
+    # Get details of a registry repository tag.
+    #
+    # @example
+    #   Gitlab.registry_repository_tag(5, 2, 'v10.0.0')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] repository_id The ID of registry repository.
+    # @param  [String] tag_name The name of tag.
+    # @return <Gitlab::ObjectifiedHash> Returns details about the registry repository tag
+    def registry_repository_tag(project, repository_id, tag_name)
+      get("/projects/#{url_encode project}/registry/repositories/#{repository_id}/tags/#{tag_name}")
+    end
+
+    # Delete a registry repository tag.
+    #
+    # @example
+    #   Gitlab.delete_registry_repository_tag(5, 2, 'v10.0.0')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] repository_id The ID of registry repository.
+    # @param  [String] tag_name The name of tag.
+    # @return [void] This API call returns an empty response body.
+    def delete_registry_repository_tag(project, repository_id, tag_name)
+      delete("/projects/#{url_encode project}/registry/repositories/#{repository_id}/tags/#{tag_name}")
+    end
+
+    # Delete repository tags in bulk based on given criteria.
+    #
+    # @example
+    #   Gitlab.bulk_delete_registry_repository_tags(5, 2, name_regex: '.*')
+    #   Gitlab.bulk_delete_registry_repository_tags(5, 2, name_regex: '[0-9a-z]{40}', keep_n: 5, older_than: '1d')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] repository_id The ID of registry repository.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name_regex(required) The regex of the name to delete. To delete all tags specify .*.
+    # @option options [Integer] :keep_n(optional) The amount of latest tags of given name to keep.
+    # @option options [String] :older_than(required) Tags to delete that are older than the given time, written in human readable form 1h, 1d, 1month.
+    # @return [void] This API call returns an empty response body.
+    def bulk_delete_registry_repository_tags(project, repository_id, options = {})
+      delete("/projects/#{url_encode project}/registry/repositories/#{repository_id}/tags", body: options)
+    end
+  end
+end

data/lib/gitlab/client/deployments.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to deployments.
+  # @see https://docs.gitlab.com/ce/api/deployments.html
+  module Deployments
+    # Gets a list of project deployments.
+    #
+    # @example
+    #   Gitlab.deployments(5)
+    #   Gitlab.deployments(5, { per_page: 10, page:  2 })
+    #
+    # @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 deployments(project, options = {})
+      get("/projects/#{url_encode project}/deployments", query: options)
+    end
+
+    # Gets a single deployment.
+    #
+    # @example
+    #   Gitlab.deployment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an deployment.
+    # @return [Gitlab::ObjectifiedHash]
+    def deployment(project, id)
+      get("/projects/#{url_encode project}/deployments/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/environments.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to environments.
+  # @see https://docs.gitlab.com/ce/api/environments.html
+  module Environments
+    # Gets a list of project environments.
+    #
+    # @example
+    #   Gitlab.environments(5)
+    #   Gitlab.environments(5, { per_page: 10, page:  2 })
+    #
+    # @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 environments(project, options = {})
+      get("/projects/#{url_encode project}/environments", query: options)
+    end
+
+    # Gets a single environment.
+    #
+    # @example
+    #   Gitlab.environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Gitlab::ObjectifiedHash]
+    def environment(project, id)
+      get("/projects/#{url_encode project}/environments/#{id}")
+    end
+
+    # Create an environment.
+    #
+    # @examples
+    #   Gitlab.create_environment(5, 'test-branch')
+    #   Gitlab.create_environment(5, 'test-branch', external_url: 'https://test-branch.example.host.com')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] env_name Name for the environment
+    # @option options [String] :external_url Optional URL for viewing the deployed project in this environment
+    # @return [Gitlab::ObjectifiedHash] The updated environment.
+    def create_environment(project, env_name, options = {})
+      body = { name: env_name }.merge(options)
+      post("/projects/#{url_encode project}/environments", body: body)
+    end
+
+    # Update an environment.
+    #
+    # @examples
+    #   Gitlab.edit_environment(5, 36, name: 'test-branch')
+    #   Gitlab.edit_environment(5, 36, external_url: 'https://test-branch.example.host.com')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @param  [Hash] options A hash of the attribute keys & values to update.
+    # @option options [String] env_name Name for the environment
+    # @option options [String] external_url Optional URL for viewing the deployed project in this environment
+    # @return [Gitlab::ObjectifiedHash] The updated environment.
+    def edit_environment(project, id, options = {})
+      put("/projects/#{url_encode project}/environments/#{id}", body: options)
+    end
+
+    # Deletes an environment.
+    #
+    # @example
+    #   Gitlab.delete_environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted environment.
+    def delete_environment(project, id)
+      delete("/projects/#{url_encode project}/environments/#{id}")
+    end
+
+    # Stop an environment.
+    #
+    # @example
+    #   Gitlab.stop_environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Array<Gitlab::ObjectifiedHash>] The stopped environment.
+    def stop_environment(project, id)
+      post("/projects/#{url_encode project}/environments/#{id}/stop")
+    end
+  end
+end

data/lib/gitlab/client/epic_issues.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to issues.
+  # @see https://docs.gitlab.com/ee/api/epic_issues.html
+  module EpicIssues
+    # List issues for an epic.
+    # Gets all issues that are assigned to an epic and the authenticated user has access to..
+    # @example
+    #   Gitlab.epic_issues(5, 7)
+    #   Gitlab.epic_issues(5, 7, { per_page: 40 })
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic The iid of an epic.
+    # @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 epic_issues(group, epic, options = {})
+      get("/groups/#{url_encode group}/epics/#{epic}/issues", query: options)
+    end
+  end
+end

data/lib/gitlab/client/epics.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to Epics.
+  # @see https://docs.gitlab.com/ee/api/epics.html
+  module Epics
+    # Gets a list of epics.
+    #
+    # @example
+    #   Gitlab.epics(123)
+    #   Gitlab.epics(123, { per_page: 40, page: 2 })
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @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 epics(group_id, options = {})
+      get("/groups/#{group_id}/epics", query: options)
+    end
+
+    # Gets a single epic.
+    #
+    # @example
+    #   Gitlab.epic(123, 1)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] epic_iid The ID of a epic.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Gitlab::ObjectifiedHash]
+    def epic(group_id, epic_iid, options = {})
+      get("/groups/#{group_id}/epics/#{epic_iid}", query: options)
+    end
+
+    # Creates a new epic.
+    #
+    # @example
+    #   Gitlab.create_epic(123, "My new epic title")
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [String] title
+    # @param  [Hash] options A customizable set of options.
+    # @return [Gitlab::ObjectifiedHash] Information about created epic.
+    def create_epic(group_id, title, options = {})
+      body = options.merge(title: title)
+      post("/groups/#{group_id}/epics", body: body)
+    end
+
+    # Deletes an epic.
+    #
+    # @example
+    #   Gitlab.delete_epic(42, 123)
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] epic_iid The IID of an epic.
+    def delete_epic(group_id, epic_iid)
+      delete("/groups/#{group_id}/epics/#{epic_iid}")
+    end
+
+    # Updates an existing epic.
+    #
+    # @example
+    #   Gitlab.edit_epic(42)
+    #   Gitlab.edit_epic(42, 123, { title: 'New epic title' })
+    #
+    # @param  [Integer] group_id The ID.
+    # @param  [Integer] epic_iid The IID of an epic.
+    # @param  [Hash] options A customizable set of options
+    # @return [Gitlab::ObjectifiedHash] Information about the edited epic.
+    def edit_epic(group_id, epic_iid, options = {})
+      put("/groups/#{group_id}/epics/#{epic_iid}", body: options)
+    end
+  end
+end