Add annotate rest resource

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

@@ -0,0 +1,95 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import sonia.scm.repository.NamespaceAndName;
+import sonia.scm.repository.api.RepositoryService;
+import sonia.scm.repository.api.RepositoryServiceFactory;
+import sonia.scm.web.VndMediaType;
+
+import javax.inject.Inject;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import java.io.IOException;
+
+public class AnnotateResource {
+
+  private final RepositoryServiceFactory serviceFactory;
+  private final BlameResultToBlameDtoMapper mapper;
+
+  @Inject
+  public AnnotateResource(RepositoryServiceFactory serviceFactory, BlameResultToBlameDtoMapper mapper) {
+    this.serviceFactory = serviceFactory;
+    this.mapper = mapper;
+  }
+
+  /**
+   * Returns the content of a file with additional information for each line regarding the last commit that
+   * changed this line: The revision, the author, the date, and the description of the commit.
+   *
+   * @param namespace the namespace of the repository
+   * @param name      the name of the repository
+   * @param revision  the revision
+   * @param path      The path of the file
+   */
+  @GET
+  @Path("{revision}/{path: .*}")
+  @Produces(VndMediaType.ANNOTATE)
+  @Operation(summary = "File content by revision", description = "Returns the annotated file for the given revision in the repository.", tags = "Repository")
+  @ApiResponse(responseCode = "200", description = "success")
+  @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
+  @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the repository")
+  @ApiResponse(
+    responseCode = "404",
+    description = "not found, no repository with the specified name available in the namespace",
+    content = @Content(
+      mediaType = VndMediaType.ERROR_TYPE,
+      schema = @Schema(implementation = ErrorDto.class)
+    ))
+  @ApiResponse(
+    responseCode = "500",
+    description = "internal server error",
+    content = @Content(
+      mediaType = VndMediaType.ERROR_TYPE,
+      schema = @Schema(implementation = ErrorDto.class)
+    ))
+  public BlameDto annotate(
+    @PathParam("namespace") String namespace,
+    @PathParam("name") String name,
+    @PathParam("revision") String revision,
+    @PathParam("path") String path
+  ) throws IOException {
+    NamespaceAndName namespaceAndName = new NamespaceAndName(namespace, name);
+    try (RepositoryService repositoryService = serviceFactory.create(namespaceAndName)) {
+      return mapper.map(repositoryService.getBlameCommand().setRevision(revision).getBlameResult(path), namespaceAndName, revision, path);
+    }
+  }
+}

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

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.api.v2.resources;
 
 import com.google.common.annotations.VisibleForTesting;
@@ -63,6 +63,7 @@ abstract class BaseFileObjectDtoMapper extends HalAppenderMapper implements Inst
     } else {
       links.self(resourceLinks.source().content(namespaceAndName.getNamespace(), namespaceAndName.getName(), browserResult.getRevision(), path));
       links.single(link("history", resourceLinks.fileHistory().self(namespaceAndName.getNamespace(), namespaceAndName.getName(), browserResult.getRevision(), path)));
+      links.single(link("annotate", resourceLinks.annotate().self(namespaceAndName.getNamespace(), namespaceAndName.getName(), browserResult.getRevision(), path)));
     }
     if (fileObject.isTruncated()) {
       links.single(link("proceed", resourceLinks.source().content(namespaceAndName.getNamespace(), namespaceAndName.getName(), browserResult.getRevision(), path) + "?offset=" + (offset + BrowseCommandRequest.DEFAULT_REQUEST_LIMIT)));

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

@@ -0,0 +1,42 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.HalRepresentation;
+import de.otto.edison.hal.Links;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class BlameDto extends HalRepresentation {
+
+  private List<BlameLineDto> blameLines;
+
+  public BlameDto(Links links) {
+    super(links);
+  }
+
+}

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

@@ -0,0 +1,41 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import lombok.Data;
+
+import java.time.Instant;
+
+@Data
+public class BlameLineDto {
+
+  private PersonDto author;
+  private String code;
+  private String description;
+  private int lineNumber;
+  private String revision;
+  private Instant when;
+
+}

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

@@ -0,0 +1,72 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import com.google.common.annotations.VisibleForTesting;
+import de.otto.edison.hal.Links;
+import org.mapstruct.Mapper;
+import org.mapstruct.ObjectFactory;
+import sonia.scm.repository.BlameLine;
+import sonia.scm.repository.BlameResult;
+import sonia.scm.repository.NamespaceAndName;
+import sonia.scm.repository.Person;
+
+import javax.inject.Inject;
+import java.util.stream.Collectors;
+
+@Mapper
+public abstract class BlameResultToBlameDtoMapper implements InstantAttributeMapper {
+
+  @Inject
+  private ResourceLinks resourceLinks;
+
+  BlameDto map(BlameResult result, NamespaceAndName namespaceAndName, String revision, String path) {
+    BlameDto dto = createDto(namespaceAndName, revision, path);
+    dto.setBlameLines(result.getBlameLines().stream().map(this::map).collect(Collectors.toList()));
+    return dto;
+  }
+
+  abstract BlameLineDto map(BlameLine line);
+
+  abstract PersonDto map(Person person);
+
+  @ObjectFactory
+  BlameDto createDto(NamespaceAndName namespaceAndName, String revision, String path) {
+    return new BlameDto(Links.linkingTo()
+      .self(
+        resourceLinks.annotate()
+          .self(
+            namespaceAndName.getNamespace(),
+            namespaceAndName.getName(),
+            revision,
+            path))
+      .build());
+  }
+
+  @VisibleForTesting
+  void setResourceLinks(ResourceLinks resourceLinks) {
+    this.resourceLinks = resourceLinks;
+  }
+}

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

@@ -73,6 +73,8 @@ public class MapperModule extends AbstractModule {
 
     bind(RepositoryToHalMapper.class).to(Mappers.getMapperClass(RepositoryToRepositoryDtoMapper.class));
 
+    bind(BlameResultToBlameDtoMapper.class).to(Mappers.getMapperClass(BlameResultToBlameDtoMapper.class));
+
     // no mapstruct required
     bind(MeDtoFactory.class);
     bind(UIPluginDtoMapper.class);

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

@@ -38,6 +38,7 @@ public class RepositoryBasedResourceProvider {
   private final Provider<ModificationsRootResource> modificationsRootResource;
   private final Provider<FileHistoryRootResource> fileHistoryRootResource;
   private final Provider<IncomingRootResource> incomingRootResource;
+  private final Provider<AnnotateResource> annotateResource;
 
   @Inject
   public RepositoryBasedResourceProvider(
@@ -50,7 +51,7 @@ public class RepositoryBasedResourceProvider {
     Provider<DiffRootResource> diffRootResource,
     Provider<ModificationsRootResource> modificationsRootResource,
     Provider<FileHistoryRootResource> fileHistoryRootResource,
-    Provider<IncomingRootResource> incomingRootResource) {
+    Provider<IncomingRootResource> incomingRootResource, Provider<AnnotateResource> annotateResource) {
     this.tagRootResource = tagRootResource;
     this.branchRootResource = branchRootResource;
     this.changesetRootResource = changesetRootResource;
@@ -61,6 +62,7 @@ public class RepositoryBasedResourceProvider {
     this.modificationsRootResource = modificationsRootResource;
     this.fileHistoryRootResource = fileHistoryRootResource;
     this.incomingRootResource = incomingRootResource;
+    this.annotateResource = annotateResource;
   }
 
   public TagRootResource getTagRootResource() {
@@ -102,4 +104,8 @@ public class RepositoryBasedResourceProvider {
   public IncomingRootResource getIncomingRootResource() {
     return incomingRootResource.get();
   }
+
+  public AnnotateResource getAnnotateResource() {
+    return annotateResource.get();
+  }
 }

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

@@ -232,6 +232,11 @@ public class RepositoryResource {
     return resourceProvider.getIncomingRootResource();
   }
 
+  @Path("annotate/")
+  public AnnotateResource annotate() {
+    return resourceProvider.getAnnotateResource();
+  }
+
   private Supplier<Repository> loadBy(String namespace, String name) {
     NamespaceAndName namespaceAndName = new NamespaceAndName(namespace, name);
     return () -> Optional.ofNullable(manager.get(namespaceAndName)).orElseThrow(() -> notFound(entity(namespaceAndName)));

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

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.api.v2.resources;
 
 import sonia.scm.repository.NamespaceAndName;
@@ -566,6 +566,22 @@ class ResourceLinks {
     }
   }
 
+  public AnnotateLinks annotate() {
+    return new AnnotateLinks(scmPathInfoStore.get());
+  }
+
+  static class AnnotateLinks {
+    private final LinkBuilder annotateLinkBuilder;
+
+    AnnotateLinks(ScmPathInfo pathInfo) {
+      this.annotateLinkBuilder = new LinkBuilder(pathInfo, RepositoryRootResource.class, RepositoryResource.class, AnnotateResource.class);
+    }
+
+    String self(String namespace, String name, String revision, String path) {
+      return annotateLinkBuilder.method("getRepositoryResource").parameters(namespace, name).method("annotate").parameters().method("annotate").parameters(revision, path).href();
+    }
+  }
+
   RepositoryVerbLinks repositoryVerbs() {
     return new RepositoryVerbLinks(scmPathInfoStore.get());
   }