Add Pull mirror API (#1271)

Fixes #1227

---------

Co-authored-by: Jeremie Bresson <[email protected]>

Author: Jony-Jas

gitlab4j-api/src/main/java/org/gitlab4j/api/ProjectApi.java

@@ -64,6 +64,7 @@
 import org.gitlab4j.api.models.ProjectGroupsFilter;
 import org.gitlab4j.api.models.ProjectHook;
 import org.gitlab4j.api.models.ProjectUser;
+import org.gitlab4j.api.models.PullMirror;
 import org.gitlab4j.api.models.PushRules;
 import org.gitlab4j.api.models.RemoteMirror;
 import org.gitlab4j.api.models.Snippet;
@@ -4470,6 +4471,41 @@ public void deleteCustomAttribute(final Object projectIdOrPath, final String key
         delete(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "custom_attributes", key);
     }
 
+    /**
+     * Get all pull mirrors for the specified project.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/mirror/pull</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of a Long(ID), String(path), or Project instance
+     * @return a list of project's pull mirrors
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<PullMirror> getPullMirrors(final Object projectIdOrPath) throws GitLabApiException {
+        return (getPullMirrors(projectIdOrPath, getDefaultPerPage()).all());
+    }
+
+    /**
+     * Get a Pager of pull mirrors for the specified project.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/mirror/pull</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
+     * @param itemsPerPage the number of items per page
+     * @return a Pager of project's pull mirrors
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<PullMirror> getPullMirrors(final Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
+        return new Pager<PullMirror>(
+                this,
+                PullMirror.class,
+                itemsPerPage,
+                null,
+                "projects",
+                getProjectIdOrPath(projectIdOrPath),
+                "mirror",
+                "pull");
+    }
+
     /**
      * Get all remote mirrors and their statuses for the specified project.
      *

gitlab4j-models/src/main/java/org/gitlab4j/api/models/PullMirror.java

@@ -0,0 +1,124 @@
+package org.gitlab4j.api.models;
+
+import java.io.Serializable;
+import java.util.Date;
+
+import org.gitlab4j.models.utils.JacksonJson;
+
+public class PullMirror implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    private Long id;
+    private String lastError;
+    private Date lastSuccessfulUpdateAt;
+    private Date lastUpdateAt;
+    private Date lastUpdateStartedAt;
+    private String updateStatus;
+    private String url;
+    private Boolean enabled;
+    private Boolean mirrorTriggerBuilds;
+    private Boolean onlyMirrorProtectedBranches;
+    private Boolean mirrorOverwritesDivergedBranches;
+    private String mirrorBranchRegex;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public String getLastError() {
+        return lastError;
+    }
+
+    public void setLastError(String lastError) {
+        this.lastError = lastError;
+    }
+
+    public Date getLastSuccessfulUpdateAt() {
+        return lastSuccessfulUpdateAt;
+    }
+
+    public void setLastSuccessfulUpdateAt(Date lastSuccessfulUpdateAt) {
+        this.lastSuccessfulUpdateAt = lastSuccessfulUpdateAt;
+    }
+
+    public Date getLastUpdateAt() {
+        return lastUpdateAt;
+    }
+
+    public void setLastUpdateAt(Date lastUpdateAt) {
+        this.lastUpdateAt = lastUpdateAt;
+    }
+
+    public Date getLastUpdateStartedAt() {
+        return lastUpdateStartedAt;
+    }
+
+    public void setLastUpdateStartedAt(Date lastUpdateStartedAt) {
+        this.lastUpdateStartedAt = lastUpdateStartedAt;
+    }
+
+    public String getUpdateStatus() {
+        return updateStatus;
+    }
+
+    public void setUpdateStatus(String updateStatus) {
+        this.updateStatus = updateStatus;
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    public Boolean getEnabled() {
+        return enabled;
+    }
+
+    public void setEnabled(Boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    public Boolean getMirrorTriggerBuilds() {
+        return mirrorTriggerBuilds;
+    }
+
+    public void setMirrorTriggerBuilds(Boolean mirrorTriggerBuilds) {
+        this.mirrorTriggerBuilds = mirrorTriggerBuilds;
+    }
+
+    public Boolean getOnlyMirrorProtectedBranches() {
+        return onlyMirrorProtectedBranches;
+    }
+
+    public void setOnlyMirrorProtectedBranches(Boolean onlyMirrorProtectedBranches) {
+        this.onlyMirrorProtectedBranches = onlyMirrorProtectedBranches;
+    }
+
+    public Boolean getMirrorOverwritesDivergedBranches() {
+        return mirrorOverwritesDivergedBranches;
+    }
+
+    public void setMirrorOverwritesDivergedBranches(Boolean mirrorOverwritesDivergedBranches) {
+        this.mirrorOverwritesDivergedBranches = mirrorOverwritesDivergedBranches;
+    }
+
+    public String getMirrorBranchRegex() {
+        return mirrorBranchRegex;
+    }
+
+    public void setMirrorBranchRegex(String mirrorBranchRegex) {
+        this.mirrorBranchRegex = mirrorBranchRegex;
+    }
+
+    @Override
+    public String toString() {
+        return JacksonJson.toJsonString(this);
+    }
+}

gitlab4j-models/src/test/java/org/gitlab4j/models/TestGitLabApiBeans.java

@@ -507,6 +507,12 @@ public void testPushRule() throws Exception {
         assertTrue(compareJson(pushRule, "push-rule.json"));
     }
 
+    @Test
+    public void testPullMirror() throws Exception {
+        PullMirror value = unmarshalResource(PullMirror.class, "pull-mirror.json");
+        assertTrue(compareJson(value, "pull-mirror.json"));
+    }
+
     @Test
     public void testRegistryRepositories() throws Exception {
         List<RegistryRepository> repos = unmarshalResourceList(RegistryRepository.class, "registry-repositories.json");

gitlab4j-models/src/test/resources/org/gitlab4j/models/pull-mirror.json

@@ -0,0 +1,14 @@
+{
+  "id": 101486,
+  "last_error": "FOO",
+  "last_successful_update_at": "2020-01-06T17:32:02.823Z",
+  "last_update_at": "2020-01-06T17:32:02.823Z",
+  "last_update_started_at": "2020-01-06T17:31:55.864Z",
+  "update_status": "finished",
+  "url": "https://*****:*****@gitlab.com/gitlab-org/security/gitlab.git",
+  "enabled": true,
+  "mirror_trigger_builds": true,
+  "only_mirror_protected_branches": true,
+  "mirror_overwrites_diverged_branches": false,
+  "mirror_branch_regex": "[a-z]+"
+}