gitlab 4.5.0 → 5.1.0

data/lib/gitlab/client/projects.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to projects.
   # @see https://docs.gitlab.com/ce/api/projects.html
-  module Projects
+  module Projects # rubocop:disable Metrics/ModuleLength
     # Gets a list of projects owned by the authenticated user.
     #
     # @example
@@ -13,8 +15,8 @@ class Gitlab::Client
     # (Any provided options will be passed to Gitlab. See {https://docs.gitlab.com/ce/api/projects.html#list-all-projects Gitlab docs} for all valid options)
     #
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def projects(options={})
-      get("/projects", query: options)
+    def projects(options = {})
+      get('/projects', query: options)
     end
 
     # Search for projects by name.
@@ -30,10 +32,10 @@ class Gitlab::Client
     # @option options [String] :order_by Return requests ordered by id, name, created_at or last_activity_at fields
     # @option options [String] :sort Return requests sorted in asc or desc order
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_search(query, options={})
-      get("/projects", query: options.merge(search:query))
+    def project_search(query, options = {})
+      get('/projects', query: options.merge(search: query))
     end
-    alias_method :search_projects, :project_search
+    alias search_projects project_search
 
     # Gets information about a project.
     #
@@ -42,9 +44,12 @@ class Gitlab::Client
     #   Gitlab.project('gitlab')
     #
     # @param  [Integer, String] id The ID or path of a project.
+    # @param  options [string] :license Include project license data
+    # @param  options [string] :statistics Include project statistics.
+    # @param  options [string] :with_custom_attributes Include custom attributes in response. (admins only)
     # @return [Gitlab::ObjectifiedHash]
-    def project(id)
-      get("/projects/#{url_encode id}")
+    def project(id, options = {})
+      get("/projects/#{url_encode id}", query: options)
     end
 
     # Creates a new project.
@@ -65,11 +70,11 @@ class Gitlab::Client
     # @option options [Boolean] :issues_enabled The issues integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :snippets_enabled The snippets integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :merge_requests_enabled The merge requests functionality for a project (0 = false, 1 = true).
-    # @option options [Boolean] :public The setting for making a project public (0 = false, 1 = true).
+    # @option options [String] :visibility The setting for making a project public ('private', 'internal', 'public').
     # @option options [Integer] :user_id The user/owner id of a project.
     # @return [Gitlab::ObjectifiedHash] Information about created project.
-    def create_project(name, options={})
-      url = options[:user_id] ? "/projects/user/#{options[:user_id]}" : "/projects"
+    def create_project(name, options = {})
+      url = options[:user_id] ? "/projects/user/#{options[:user_id]}" : '/projects'
       post(url, body: { name: name }.merge(options))
     end
 
@@ -96,10 +101,26 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def team_members(project, options={})
+    def team_members(project, options = {})
       get("/projects/#{url_encode project}/members", query: options)
     end
 
+    # Gets a list of all project team members including inherited members.
+    #
+    # @example
+    #   Gitlab.all_members(42)
+    #   Gitlab.all_members('gitlab')
+    #
+    # @param  [Integer, String] project The ID or path of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :query The search query.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def all_members(project, options = {})
+      get("/projects/#{url_encode project}/members/all", query: options)
+    end
+
     # Gets a project team member.
     #
     # @example
@@ -116,28 +137,34 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.add_team_member('gitlab', 2, 40)
+    #   Gitlab.add_team_member('gitlab', 2, 40, { expires_at: "2018-12-31"})
     #
     # @param  [Integer, String] project The ID or path of a project.
     # @param  [Integer] id The ID of a user.
     # @param  [Integer] access_level The access level to project.
     # @param  [Hash] options A customizable set of options.
+    # @option options [String] :expires_at A date string in the format YEAR-MONTH-DAY.
     # @return [Gitlab::ObjectifiedHash] Information about added team member.
-    def add_team_member(project, id, access_level)
-      post("/projects/#{url_encode project}/members", body: { user_id: id, access_level: access_level })
+    def add_team_member(project, id, access_level, options = {})
+      body = { user_id: id, access_level: access_level }.merge(options)
+      post("/projects/#{url_encode project}/members", body: body)
     end
 
     # Updates a team member's project access level.
     #
     # @example
     #   Gitlab.edit_team_member('gitlab', 3, 20)
+    #   Gitlab.edit_team_member('gitlab', 3, 20, { expires_at: "2018-12-31"})
     #
     # @param  [Integer, String] project The ID or path of a project.
     # @param  [Integer] id The ID of a user.
     # @param  [Integer] access_level The access level to project.
     # @param  [Hash] options A customizable set of options.
+    # @option options [String] :expires_at A date string in the format YEAR-MONTH-DAY.
     # @return [Array<Gitlab::ObjectifiedHash>] Information about updated team member.
-    def edit_team_member(project, id, access_level)
-      put("/projects/#{url_encode project}/members/#{id}", body: { access_level: access_level })
+    def edit_team_member(project, id, access_level, options = {})
+      body = { access_level: access_level }.merge(options)
+      put("/projects/#{url_encode project}/members/#{id}", body: body)
     end
 
     # Removes a user from project team.
@@ -164,7 +191,7 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_hooks(project, options={})
+    def project_hooks(project, options = {})
       get("/projects/#{url_encode project}/hooks", query: options)
     end
 
@@ -194,7 +221,7 @@ class Gitlab::Client
     # @param  option [Boolean] :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)
     # @param  option [Boolean] :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)
     # @return [Gitlab::ObjectifiedHash] Information about added hook.
-    def add_project_hook(project, url, options={})
+    def add_project_hook(project, url, options = {})
       body = { url: url }.merge(options)
       post("/projects/#{url_encode project}/hooks", body: body)
     end
@@ -213,7 +240,7 @@ class Gitlab::Client
     # @param  option [Boolean] :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)
     # @param  option [Boolean] :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)
     # @return [Gitlab::ObjectifiedHash] Information about updated hook.
-    def edit_project_hook(project, id, url, options={})
+    def edit_project_hook(project, id, url, options = {})
       body = { url: url }.merge(options)
       put("/projects/#{url_encode project}/hooks/#{id}", body: body)
     end
@@ -253,7 +280,7 @@ class Gitlab::Client
     # @param  option [Boolean] :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true)
     # @param  option [String] :commit_message_regex Commit message regex
     # @return [Gitlab::ObjectifiedHash] Information about added push rule.
-    def add_push_rule(id, options={})
+    def add_push_rule(id, options = {})
       post("/projects/#{url_encode id}/push_rule", body: options)
     end
 
@@ -268,7 +295,7 @@ class Gitlab::Client
     # @param  option [Boolean] :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true)
     # @param  option [String] :commit_message_regex Commit message regex
     # @return [Gitlab::ObjectifiedHash] Information about updated push rule.
-    def edit_push_rule(id, options={})
+    def edit_push_rule(id, options = {})
       put("/projects/#{url_encode id}/push_rule", body: options)
     end
 
@@ -318,7 +345,7 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def deploy_keys(project, options={})
+    def deploy_keys(project, options = {})
       get("/projects/#{url_encode project}/deploy_keys", query: options)
     end
 
@@ -372,6 +399,20 @@ class Gitlab::Client
       post("/projects/#{url_encode project}/deploy_keys/#{key}/disable", body: { id: project, key_id: key })
     end
 
+    # Updates an existing deploy key.
+    #
+    # @example
+    #   Gitlab.edit_deploy_key(42, 66, 'New key name', can_push: false)
+    #
+    # @param  [Integer, String] project The ID or path of a project.
+    # @param  [Integer] id The ID of a deploy key.
+    # @param  [String] title The title of a deploy key.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Gitlab::ObjectifiedHash] Information about created deploy key.
+    def edit_deploy_key(project, id, title, options = {})
+      put("/projects/#{url_encode project}/deploy_keys/#{id}", body: { title: title }.merge(options))
+    end
+
     # Deletes a deploy key from project.
     #
     # @example
@@ -394,7 +435,7 @@ class Gitlab::Client
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :sudo The username the project will be forked for
     # @return [Gitlab::ObjectifiedHash] Information about the forked project.
-    def create_fork(id, options={})
+    def create_fork(id, options = {})
       post("/projects/#{url_encode id}/fork", body: options)
     end
 
@@ -412,7 +453,7 @@ class Gitlab::Client
     # @option options [String] :order_by Return requests ordered by id, name, created_at or last_activity_at fields
     # @option options [String] :sort Return requests sorted in asc or desc order
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_forks(id, options={})
+    def project_forks(id, options = {})
       get("/projects/#{url_encode id}/forks", query: options)
     end
 
@@ -431,7 +472,7 @@ class Gitlab::Client
     # (Any provided options will be passed to Gitlab. See {https://docs.gitlab.com/ce/api/projects.html#edit-project Gitlab docs} for all valid options)
     #
     # @return [Gitlab::ObjectifiedHash] Information about the edited project.
-    def edit_project(id, options={})
+    def edit_project(id, options = {})
       put("/projects/#{url_encode id}", body: options)
     end
 
@@ -459,6 +500,18 @@ class Gitlab::Client
       delete("/projects/#{url_encode project}/share/#{id}")
     end
 
+    # Transfer a project to a new namespace.
+    #
+    # @example
+    #   Gitlab.transfer_project(42, 'yolo')
+    #
+    # @param  [Integer, String] project The ID or path of a project
+    # @param  [Integer, String] namespace The ID or path of the namespace to transfer to project to
+    # @return [Gitlab::ObjectifiedHash] Information about transfered project.
+    def transfer_project(project, namespace)
+      put("/projects/#{url_encode project}/transfer", body: { namespace: namespace })
+    end
+
     # Stars a project.
     # @see https://docs.gitlab.com/ce/api/projects.html#star-a-project
     #
@@ -485,6 +538,25 @@ class Gitlab::Client
       delete("/projects/#{url_encode id}/star")
     end
 
+    # Get a list of visible projects that the given user has starred.
+    # @see https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user
+    #
+    # @example
+    #   Gitlab.user_starred_projects(1)
+    #   Gitlab.user_starred_projects(1, { order_by: 'last_activity_at' })
+    #   Gitlab.user_starred_projects('username', { order_by: 'name', sort: 'asc' })
+    #
+    # @param  [Integer, String] user_id The ID or username of the user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of projects to return per page
+    # @option options [String] :page The page to retrieve
+    # @option options [String] :order_by Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.
+    # @option options [String] :sort Return projects sorted in asc or desc order.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_starred_projects(user_id, options = {})
+      get("/users/#{url_encode user_id}/starred_projects", query: options)
+    end
+
     # Get a list of visible projects for the given user.
     # @see https://docs.gitlab.com/ee/api/projects.html#list-user-projects
     #
@@ -500,8 +572,217 @@ class Gitlab::Client
     # @option options [String] :order_by Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.
     # @option options [String] :sort Return projects sorted in asc or desc order.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def user_projects(user_id, options={})
+    def user_projects(user_id, options = {})
       get("/users/#{url_encode user_id}/projects", query: options)
     end
+
+    # Uploads a file to the specified project to be used in an issue or
+    # merge request description, or a comment.
+    # @see https://docs.gitlab.com/ee/api/projects.html#upload-a-file
+    #
+    # @example
+    #   Gitlab.upload_file(1, '/full/path/to/avatar.jpg')
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @param  [String] file_fullpath The fullpath of the file you are interested to upload.
+    # @return [Gitlab::ObjectifiedHash]
+    def upload_file(id, file_fullpath)
+      post("/projects/#{url_encode id}/uploads", body: { file: File.open(file_fullpath, 'r') })
+    end
+
+    # Get all project templates of a particular type
+    # @see https://docs.gitlab.com/ce/api/project_templates.html
+    #
+    # @example
+    #   Gitlab.project_templates(1, 'dockerfiles')
+    #   Gitlab.project_templates(1, 'licenses')
+    #
+    # @param  [Integer, String] id The ID or URL-encoded path of the project.
+    # @param  [String] type The type (dockerfiles|gitignores|gitlab_ci_ymls|licenses) of the template
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_templates(project, type)
+      get("/projects/#{url_encode project}/templates/#{type}")
+    end
+
+    # Get one project template of a particular type
+    # @see https://docs.gitlab.com/ce/api/project_templates.html
+    #
+    # @example
+    #   Gitlab.project_template(1, 'dockerfiles', 'dockey')
+    #   Gitlab.project_template(1, 'licenses', 'gpl', { project: 'some project', fullname: 'Holder Holding' })
+    #
+    # @param  [Integer, String] project The ID or URL-encoded path of the project.
+    # @param  [String] type The type (dockerfiles|gitignores|gitlab_ci_ymls|licenses) of the template
+    # @param  [String] key The key of the template, as obtained from the collection endpoint
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] project(optional) The project name to use when expanding placeholders in the template. Only affects licenses
+    # @option options [String] fullname(optional) The full name of the copyright holder to use when expanding placeholders in the template. Only affects licenses
+    # @return [Gitlab::ObjectifiedHash]
+    def project_template(project, type, key, options = {})
+      get("/projects/#{url_encode project}/templates/#{type}/#{key}", query: options)
+    end
+
+    # Archives a project.
+    #
+    # @example
+    #   Gitlab.archive_project(4)
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about archived project.
+    def archive_project(id)
+      post("/projects/#{url_encode id}/archive")
+    end
+
+    # Unarchives a project.
+    #
+    # @example
+    #   Gitlab.unarchive_project(4)
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about unarchived project.
+    def unarchive_project(id)
+      post("/projects/#{url_encode id}/unarchive")
+    end
+
+    # Gets project custom_attributes.
+    #
+    # @example
+    #   Gitlab.project_custom_attributes(2)
+    #
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_custom_attributes(project_id)
+      get("/projects/#{project_id}/custom_attributes")
+    end
+
+    # Gets single project custom_attribute.
+    #
+    # @example
+    #   Gitlab.project_custom_attribute(key, 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_custom_attribute(key, project_id)
+      get("/projects/#{project_id}/custom_attributes/#{key}")
+    end
+
+    # Creates a new custom_attribute
+    #
+    # @example
+    #   Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [String] value The custom_attributes value
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_project_custom_attribute(key, value, project_id)
+      url = "/projects/#{project_id}/custom_attributes/#{key}"
+      put(url, body: { value: value })
+    end
+
+    # Delete custom_attribute
+    # Will delete a custom_attribute
+    #
+    # @example
+    #   Gitlab.delete_project_custom_attribute('somekey', 2)
+    #
+    # @param  [String] key The custom_attribute key to delete
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Boolean]
+    def delete_project_custom_attribute(key, project_id = nil)
+      delete("/projects/#{project_id}/custom_attributes/#{key}")
+    end
+
+    # List project deploy tokens
+    #
+    # @example
+    #   Gitlab.project_deploy_tokens(42)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @option options [Boolean] :active Limit by active status. Optional.
+    def project_deploy_tokens(project, options = {})
+      get("/projects/#{url_encode project}/deploy_tokens", query: options)
+    end
+
+    # Get languages used with percentage value
+    #
+    # @example
+    #   Gitlab.project_languages(42)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_languages(project)
+      get("/projects/#{url_encode project}/languages")
+    end
+
+    # List all project access tokens.
+    #
+    # @example
+    #   Gitlab.project_access_tokens(42)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @option options [String] :state Limit by active/inactive state. Optional.
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_access_tokens(project, options = {})
+      get("/projects/#{url_encode project}/access_tokens", query: options)
+    end
+
+    # Get a specific project access token.
+    #
+    # @example
+    #   Gitlab.project_access_token(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] token_id The ID of the project access token.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the specified project access token.
+    def project_access_token(project, token_id)
+      get("/projects/#{url_encode project}/access_tokens/#{token_id}")
+    end
+
+    # Creates a new project access token.
+    #
+    # @example
+    #   Gitlab.create_project_access_token(42, 'My Token', ['api'], '2024-12-12', access_level: 40)
+    #
+    # @param  [Integer, String] project The ID or path of a project.
+    # @param  [String] name The name of the project access token.
+    # @param  [Array] scopes List of scopes of the project access token.
+    # @param  [String] expires_at A date string in the format YYYY-MM-DD.
+    # @option options [Integer] :access_level Access level. Optional. Defaults to 40.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the created project access token.
+    def create_project_access_token(project, name, scopes, expires_at, options = {})
+      post("/projects/#{url_encode project}/access_tokens", body: { name: name, scopes: scopes, expires_at: expires_at }.merge(options))
+    end
+
+    # Rotate a project access token.
+    #
+    # @example
+    #   Gitlab.rotate_project_access_token(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] token_id The ID of the project access token.
+    # @option options [String] :expires_at A date string in the format YEAR-MONTH-DAY.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the specified project access token.
+    def rotate_project_access_token(project, token_id, options = {})
+      post("/projects/#{url_encode project}/access_tokens/#{token_id}/rotate", query: options)
+    end
+
+    # Revoke a project access token.
+    #
+    # @example
+    #   Gitlab.revoke_project_access_token(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] token_id The ID of the project access token.
+    #
+    # @return [Gitlab::ObjectifiedHash]
+    def revoke_project_access_token(project, token_id)
+      delete("/projects/#{url_encode project}/access_tokens/#{token_id}")
+    end
   end
 end

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