Feature-351: Add support for get all members to ProjectApi and GroupApi

* Added getAllMembers() methods (#348).
* Added tests for getAllMembers() methods (#348).

Author: gmessner

src/main/java/org/gitlab4j/api/GroupApi.java

@@ -21,6 +21,8 @@
 
 /**
  * This class implements the client side API for the GitLab groups calls.
+ * @see <a href="https://docs.gitlab.com/ce/api/groups.html">Groups API at GitLab</a>
+ * @see <a href="https://docs.gitlab.com/ee/api/members.html">Group and project members API at GitLab</a>
  */
 public class GroupApi extends AbstractApi {
 
@@ -729,7 +731,8 @@ public Stream<Member> getMembersStream(Object groupIdOrPath) throws GitLabApiExc
      * @throws GitLabApiException if any exception occurs
      */
     public Member getMember(Object groupIdOrPath, int userId) throws GitLabApiException {
-        Response response = get(Response.Status.OK, getDefaultPerPageParam(), "groups", getGroupIdOrPath(groupIdOrPath), "members", userId);
+        Response response = get(Response.Status.OK, getDefaultPerPageParam(),
+                "groups", getGroupIdOrPath(groupIdOrPath), "members", userId);
         return (response.readEntity(new GenericType<Member>() {}));
     }
 
@@ -750,6 +753,75 @@ public Optional<Member> getOptionalMember(Object groupIdOrPath, int userId) {
         }
     }
 
+    /**
+     * Gets a list of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups. Returns multiple times the same user (with different member attributes)
+     * when the user is a member of the group and of one or more ancestor group.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/members/all</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @return a list of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Member> getAllMembers(Object groupIdOrPath) throws GitLabApiException {
+        return (getAllMembers(groupIdOrPath, getDefaultPerPage()).all());
+    }
+
+    /**
+     * Gets a list of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups. Returns multiple times the same user (with different member attributes)
+     * when the user is a member of the group and of one or more ancestor group.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/members/all</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @param page the page to get
+     * @param perPage the number of Member instances per page
+     * @return a list of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups in the specified page range
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Member> getAllMembers(Object groupIdOrPath, int page, int perPage) throws GitLabApiException {
+        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage),
+                "groups", getGroupIdOrPath(groupIdOrPath), "members", "all");
+        return (response.readEntity(new GenericType<List<Member>>() {}));
+    }
+
+    /**
+     * Gets a Pager of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups. Returns multiple times the same user (with different member attributes)
+     * when the user is a member of the group and of one or more ancestor group.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/members/all</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @param itemsPerPage the number of Member instances that will be fetched per page
+     * @return a Pager of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<Member> getAllMembers(Object groupIdOrPath, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<Member>(this, Member.class, itemsPerPage, null, "groups", getGroupIdOrPath(groupIdOrPath), "members", "all"));
+    }
+
+    /**
+     * Gets a Stream of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups. Returns multiple times the same user (with different member attributes)
+     * when the user is a member of the group and of one or more ancestor group.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/members/all</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @return a Stream of group members viewable by the authenticated user, including inherited members
+     * through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Member> getAllMembersStream(Object groupIdOrPath) throws GitLabApiException {
+        return (getAllMembers(groupIdOrPath, getDefaultPerPage()).stream());
+    }
+
     /**
      * Adds a user to the list of group members.
      *

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

@@ -54,6 +54,8 @@
 
 /**
  * This class provides an entry point to all the GitLab API project calls.
+ * @see <a href="https://docs.gitlab.com/ce/api/projects.html">Projects API at GitLab</a>
+ * @see <a href="https://docs.gitlab.com/ee/api/members.html">Group and project members API at GitLab</a>
  */
 public class ProjectApi extends AbstractApi implements Constants {
 
@@ -1213,6 +1215,78 @@ public Stream<Member> getMembersStream(Object projectIdOrPath) throws GitLabApiE
         return (getMembers(projectIdOrPath, getDefaultPerPage()).stream());
     }
 
+    /**
+     * Gets a list of project members viewable by the authenticated user,
+     * including inherited members through ancestor groups. Returns multiple
+     * times the same user (with different member attributes) when the user is
+     * a member of the project/group and of one or more ancestor group.
+     *
+     * <pre><code>GET /projects/:id/members/all</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return the project members viewable by the authenticated user, including inherited members through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Member> getAllMembers(Object projectIdOrPath) throws GitLabApiException {
+        return (getAllMembers(projectIdOrPath, getDefaultPerPage()).all());
+    }
+
+    /**
+     * Gets a list of project members viewable by the authenticated user,
+     * including inherited members through ancestor groups. Returns multiple
+     * times the same user (with different member attributes) when the user is
+     * a member of the project/group and of one or more ancestor group.
+     *
+     * <pre><code>GET /projects/:id/members</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param page the page to get
+     * @param perPage the number of Member instances per page
+     * @return the project members viewable by the authenticated user, including inherited members through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Member> getAllMembers(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
+        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage),
+                "projects", getProjectIdOrPath(projectIdOrPath), "members", "all");
+        return (response.readEntity(new GenericType<List<Member>>() {}));
+    }
+
+    /**
+     * Gets a Pager of project members viewable by the authenticated user,
+     * including inherited members through ancestor groups. Returns multiple
+     * times the same user (with different member attributes) when the user is
+     * a member of the project/group and of one or more ancestor group.
+     *
+     * <pre><code>GET /projects/:id/members/all</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param itemsPerPage the number of Project instances that will be fetched per page
+     * @return a Pager of the project members viewable by the authenticated user,
+     * including inherited members through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<Member> getAllMembers(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<Member>(this, Member.class, itemsPerPage, null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "members", "all"));
+    }
+
+    /**
+     * Gets a Stream of project members viewable by the authenticated user,
+     * including inherited members through ancestor groups. Returns multiple
+     * times the same user (with different member attributes) when the user is
+     * a member of the project/group and of one or more ancestor group.
+     *
+     * <pre><code>GET /projects/:id/members/all</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a Stream of the project members viewable by the authenticated user,
+     * including inherited members through ancestor groups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Member> getAllMembersStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getAllMembers(projectIdOrPath, getDefaultPerPage()).stream());
+    }
+
     /**
      * Gets a project team member.
      *

src/test/java/org/gitlab4j/api/TestGroupApi.java

@@ -112,11 +112,57 @@ public void beforeMethod() {
     @Test
     public void testMemberOperations() throws GitLabApiException {
 
+        // Arrange and Act
         Member member = gitLabApi.getGroupApi().addMember(testGroup.getId(), testUser.getId(), AccessLevel.DEVELOPER);
+
+        // Assert
+        assertNotNull(member);
+        assertEquals(testUser.getId(), member.getId());
+        assertEquals(AccessLevel.DEVELOPER, member.getAccessLevel());
+
+        // Act
+        Optional<Member> optionalMember = gitLabApi.getGroupApi().getOptionalMember(testGroup, testUser.getId());
+
+        // Assert
+        assertTrue(optionalMember.isPresent());
+
+        // Act
+        List<Member> members = gitLabApi.getGroupApi().getMembers(testGroup);
+
+        // Assert
+        assertNotNull(members);
+        Boolean found = (members.stream().filter(m -> m.getId().equals(member.getId())).findAny().orElse(null) != null);
+        assertTrue(found);
+
+        // Act
+        gitLabApi.getGroupApi().removeMember(testGroup.getId(), testUser.getId());
+
+        // Act
+        optionalMember = gitLabApi.getGroupApi().getOptionalMember(testGroup, testUser.getId());
+
+        // Assert
+        assertFalse(optionalMember.isPresent());
+    }
+
+    @Test
+    public void testAllMemberOperations() throws GitLabApiException {
+
+        // Arrange and Act
+        Member member = gitLabApi.getGroupApi().addMember(testGroup.getId(), testUser.getId(), AccessLevel.DEVELOPER);
+
+        // Assert
         assertNotNull(member);
         assertEquals(testUser.getId(), member.getId());
         assertEquals(AccessLevel.DEVELOPER, member.getAccessLevel());
 
+        // Act
+        List<Member> members = gitLabApi.getGroupApi().getAllMembers(testGroup);
+
+        // Assert
+        assertNotNull(members);
+        Boolean found = (members.stream().filter(m -> m.getId().equals(member.getId())).findAny().orElse(null) != null);
+        assertTrue(found);
+
         gitLabApi.getGroupApi().removeMember(testGroup.getId(), testUser.getId());
     }