Get group collections

scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionDto.java

@@ -0,0 +1,17 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.Embedded;
+import de.otto.edison.hal.HalRepresentation;
+import de.otto.edison.hal.Links;
+import lombok.Data;
+
+@Data
+public class GroupCollectionDto extends HalRepresentation {
+
+  private int page;
+  private int pageTotal;
+
+  public GroupCollectionDto(Links links, Embedded embedded) {
+    super(links, embedded);
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionResource.java

@@ -5,6 +5,7 @@ import com.webcohesion.enunciate.metadata.rs.ResponseCode;
 import com.webcohesion.enunciate.metadata.rs.ResponseHeader;
 import com.webcohesion.enunciate.metadata.rs.StatusCodes;
 import com.webcohesion.enunciate.metadata.rs.TypeHint;
+import sonia.scm.PageResult;
 import sonia.scm.api.rest.resources.AbstractManagerResource;
 import sonia.scm.group.Group;
 import sonia.scm.group.GroupException;
@@ -12,11 +13,15 @@ import sonia.scm.group.GroupManager;
 import sonia.scm.web.VndMediaType;
 
 import javax.ws.rs.Consumes;
+import javax.ws.rs.DefaultValue;
+import javax.ws.rs.GET;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.Produces;
+import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.GenericEntity;
+import javax.ws.rs.core.Request;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.UriInfo;
 import java.io.IOException;
@@ -38,7 +43,6 @@ public class GroupCollectionResource extends AbstractManagerResource<Group, Grou
     this.groupToDtoMapper = groupToDtoMapper;
   }
 
-
   /**
    * Creates a new group.
    * @param groupDto The group to be created.
@@ -61,6 +65,36 @@ public class GroupCollectionResource extends AbstractManagerResource<Group, Grou
     return Response.created(URI.create(group(uriInfo).self(group.getName()))).build();
   }
 
+  /**
+   * Returns all groups for a given page number with a given page size (default page size is {@value DEFAULT_PAGE_SIZE}).
+   * <strong>Note:</strong> This method requires admin privileges.
+   *
+   * @param request  the current request
+   * @param page     the number of the requested page
+   * @param pageSize the page size (default page size is {@value DEFAULT_PAGE_SIZE})
+   * @param sortby   sort parameter
+   * @param desc     sort direction desc or aesc
+   * @return
+   */
+  @GET
+  @Path("")
+  @TypeHint(GroupDto[].class)
+  @StatusCodes({
+    @ResponseCode(code = 200, condition = "success"),
+    @ResponseCode(code = 403, condition = "forbidden, the current user has no admin privileges"),
+    @ResponseCode(code = 500, condition = "internal server error")
+  })
+  public Response getAll(@Context Request request, @Context UriInfo uriInfo,
+    @DefaultValue("0") @QueryParam("page") int page,
+    @DefaultValue("" + DEFAULT_PAGE_SIZE) @QueryParam("pageSize") int pageSize,
+    @QueryParam("sortby") String sortby,
+    @DefaultValue("false")
+    @QueryParam("desc") boolean desc) {
+    PageResult<Group> pageResult = fetchPage(sortby, desc, page, pageSize);
+
+    return Response.ok(new GroupCollectionToDtoMapper(groupToDtoMapper).map(uriInfo, page, pageSize, pageResult)).build();
+  }
+
   @Override
   protected GenericEntity<Collection<Group>> createGenericEntity(Collection<Group> items) {
     throw new UnsupportedOperationException();

scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionToDtoMapper.java

@@ -0,0 +1,63 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.Embedded;
+import de.otto.edison.hal.Links;
+import de.otto.edison.hal.paging.NumberedPaging;
+import de.otto.edison.hal.paging.PagingRel;
+import sonia.scm.PageResult;
+import sonia.scm.group.Group;
+import sonia.scm.group.GroupPermissions;
+
+import javax.inject.Inject;
+import javax.ws.rs.core.UriInfo;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static com.damnhandy.uri.template.UriTemplate.fromTemplate;
+import static de.otto.edison.hal.Embedded.embeddedBuilder;
+import static de.otto.edison.hal.Link.link;
+import static de.otto.edison.hal.Links.linkingTo;
+import static de.otto.edison.hal.paging.NumberedPaging.zeroBasedNumberedPaging;
+import static sonia.scm.api.v2.resources.ResourceLinks.groupCollection;
+
+public class GroupCollectionToDtoMapper {
+
+  private final GroupToGroupDtoMapper groupToDtoMapper;
+
+  @Inject
+  public GroupCollectionToDtoMapper(GroupToGroupDtoMapper groupToDtoMapper) {
+    this.groupToDtoMapper = groupToDtoMapper;
+  }
+
+  public GroupCollectionDto map(UriInfo uriInfo, int pageNumber, int pageSize, PageResult<Group> pageResult) {
+    NumberedPaging paging = zeroBasedNumberedPaging(pageNumber, pageSize, pageResult.hasMore());
+    List<GroupDto> dtos = pageResult.getEntities().stream().map(user -> groupToDtoMapper.map(user, uriInfo)).collect(Collectors.toList());
+
+    GroupCollectionDto groupCollectionDto = new GroupCollectionDto(
+      createLinks(uriInfo, paging),
+      embedDtos(dtos)
+    );
+    groupCollectionDto.setPage(pageNumber);
+    return groupCollectionDto;
+  }
+
+  private static Links createLinks(UriInfo uriInfo, NumberedPaging page) {
+    String baseUrl = groupCollection(uriInfo).self();
+
+    Links.Builder linksBuilder = linkingTo()
+      .with(page.links(
+        fromTemplate(baseUrl + "{?page,pageSize}"),
+        EnumSet.allOf(PagingRel.class)));
+    if (GroupPermissions.create().isPermitted()) {
+      linksBuilder.single(link("create", groupCollection(uriInfo).create()));
+    }
+    return linksBuilder.build();
+  }
+
+  private Embedded embedDtos(List<GroupDto> dtos) {
+    return embeddedBuilder()
+      .with("groups", dtos)
+      .build();
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ResourceLinks.java

@@ -31,6 +31,26 @@ class ResourceLinks {
     }
   }
 
+  static GroupCollectionLinks groupCollection(UriInfo uriInfo) {
+    return new GroupCollectionLinks(uriInfo);
+  }
+
+  static class GroupCollectionLinks {
+    private final LinkBuilder collectionLinkBuilder;
+
+    private GroupCollectionLinks(UriInfo uriInfo) {
+      collectionLinkBuilder = new LinkBuilder(uriInfo, GroupV2Resource.class, GroupCollectionResource.class);
+    }
+
+    String self() {
+      return collectionLinkBuilder.method("getGroupCollectionResource").parameters().method("getAll").parameters().href();
+    }
+
+    String create() {
+      return collectionLinkBuilder.method("getGroupCollectionResource").parameters().method("create").parameters().href();
+    }
+  }
+
   static UserLinks user(UriInfo uriInfo) {
     return new UserLinks(uriInfo);
   }

scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserCollectionResource.java

@@ -55,7 +55,7 @@ public class UserCollectionResource extends AbstractManagerResource<User, UserEx
    */
   @GET
   @Path("")
-  @TypeHint(User[].class)
+  @TypeHint(UserDto[].class)
   @StatusCodes({
     @ResponseCode(code = 200, condition = "success"),
     @ResponseCode(code = 403, condition = "forbidden, the current user has no admin privileges"),

scm-webapp/src/test/java/sonia/scm/api/v2/resources/GroupCollectionToDtoMapperTest.java

@@ -0,0 +1,129 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.HalRepresentation;
+import org.apache.shiro.subject.Subject;
+import org.apache.shiro.subject.support.SubjectThreadState;
+import org.apache.shiro.util.ThreadContext;
+import org.apache.shiro.util.ThreadState;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import sonia.scm.PageResult;
+import sonia.scm.group.Group;
+
+import javax.ws.rs.core.UriInfo;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
+import static java.util.stream.Collectors.toList;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class GroupCollectionToDtoMapperTest {
+
+  private final UriInfo uriInfo = mock(UriInfo.class);
+  private final GroupToGroupDtoMapper groupToDtoMapper = mock(GroupToGroupDtoMapper.class);
+  private final Subject subject = mock(Subject.class);
+  private final ThreadState subjectThreadState = new SubjectThreadState(subject);
+
+  private final GroupCollectionToDtoMapper mapper = new GroupCollectionToDtoMapper(groupToDtoMapper);
+
+  private URI expectedBaseUri;
+
+  @Before
+  public void init() throws URISyntaxException {
+    URI baseUri = new URI("http://example.com/base/");
+    expectedBaseUri = baseUri.resolve(GroupV2Resource.GROUPS_PATH_V2 + "/");
+    when(uriInfo.getBaseUri()).thenReturn(baseUri);
+    subjectThreadState.bind();
+    ThreadContext.bind(subject);
+  }
+
+  @After
+  public void unbindSubject() {
+    ThreadContext.unbindSubject();
+  }
+
+  @Test
+  public void shouldSetPageNumber() {
+    PageResult<Group> pageResult = mockPageResult(true, "nobodies");
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 1, pageResult);
+    assertEquals(1, groupCollectionDto.getPage());
+  }
+
+  @Test
+  public void shouldHaveSelfLink() {
+    PageResult<Group> pageResult = mockPageResult(true, "nobodies");
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 1, pageResult);
+    assertTrue(groupCollectionDto.getLinks().getLinkBy("self").get().getHref().startsWith(expectedBaseUri.toString()));
+  }
+
+  @Test
+  public void shouldCreateNextPageLink_whenHasMore() {
+    PageResult<Group> pageResult = mockPageResult(true, "nobodies");
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 1, pageResult);
+    assertTrue(groupCollectionDto.getLinks().getLinkBy("next").get().getHref().contains("page=2"));
+  }
+
+  @Test
+  public void shouldNotCreateNextPageLink_whenNoMore() {
+    PageResult<Group> pageResult = mockPageResult(false, "nobodies");
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 1, pageResult);
+    assertFalse(groupCollectionDto.getLinks().stream().anyMatch(link -> link.getHref().contains("page=2")));
+  }
+
+  @Test
+  public void shouldHaveCreateLink_whenHasPermission() {
+    PageResult<Group> pageResult = mockPageResult(false, "nobodies");
+    when(subject.isPermitted("group:create")).thenReturn(true);
+
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 1, pageResult);
+
+    assertTrue(groupCollectionDto.getLinks().getLinkBy("create").isPresent());
+  }
+
+  @Test
+  public void shouldNotHaveCreateLink_whenHasNoPermission() {
+    PageResult<Group> pageResult = mockPageResult(false, "nobodies");
+    when(subject.isPermitted("group:create")).thenReturn(false);
+
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 1, pageResult);
+
+    assertFalse(groupCollectionDto.getLinks().getLinkBy("create").isPresent());
+  }
+
+  @Test
+  public void shouldMapGroups() {
+    PageResult<Group> pageResult = mockPageResult(false, "nobodies", "bosses");
+    GroupCollectionDto groupCollectionDto = mapper.map(uriInfo, 1, 2, pageResult);
+    List<HalRepresentation> groups = groupCollectionDto.getEmbedded().getItemsBy("groups");
+    assertEquals(2, groups.size());
+    assertEquals("nobodies", ((GroupDto) groups.get(0)).getName());
+    assertEquals("bosses", ((GroupDto) groups.get(1)).getName());
+  }
+
+  private PageResult<Group> mockPageResult(boolean hasMore, String... groupNames) {
+    Collection<Group> groups = Arrays.stream(groupNames).map(this::mockGroupWithDto).collect(toList());
+    return new PageResult<>(groups, hasMore);
+  }
+
+  private Group mockGroupWithDto(String groupName) {
+    Group group = new Group();
+    group.setName(groupName);
+    when(groupToDtoMapper.map(group, uriInfo)).thenReturn(createGroupDto(group));
+    return group;
+  }
+
+  private GroupDto createGroupDto(Group group) {
+    GroupDto dto = new GroupDto();
+    dto.setName(group.getName());
+    return dto;
+  }
+
+}