Feature/rest endpoints

.github/linters/sun_checks.xml

@@ -153,7 +153,7 @@
         <!-- See https://checkstyle.org/checks/coding/index.html -->
         <module name="EmptyStatement"/>
         <module name="EqualsHashCode"/>
-        <module name="HiddenField"/>
+        <!--module name="HiddenField"/-->
         <module name="IllegalInstantiation"/>
         <module name="InnerAssignment"/>
         <module name="MagicNumber"/>
@@ -175,8 +175,8 @@
         <!-- Miscellaneous other checks.                   -->
         <!-- See https://checkstyle.org/checks/misc/index.html -->
         <module name="ArrayTypeStyle"/>
-        <module name="FinalParameters"/>
-        <module name="TodoComment"/>
+        <!--module name="FinalParameters"/-->
+        <!--module name="TodoComment"/-->
         <module name="UpperEll"/>
 
         <!-- https://checkstyle.org/filters/suppressionxpathfilter.html -->

.github/workflows/build.yml

@@ -66,7 +66,7 @@ jobs:
           DATABASE_PASSWORD: ${{ secrets.TEST_DATABASE_PASSWORD }}
         run: |
           chmod +x mvnw
-          ./mvnw test
+          ./mvnw test -Dquarkus.profile=test
 
   build_and_push_docker_image:
     runs-on: self-hosted

README.md

@@ -6,9 +6,9 @@ Quarkus documentation: <https://quarkus.io/>
 
 ## Branch naming guidelines
 
-> **Feature Branch:** ```feature/<ticket-id>``` Example: ```feature/#123```
+> **Feature Branch:** ```feature/<short ticket description>``` Example: ```feature/rainbow-rest-endpoints```
 > 
-> **Bugfix Branch:** ```bugfix/<ticket-id>``` Example: ```bugfix/#123```
+> **Bugfix Branch:** ```bugfix/<short ticket description>``` Example: ```bugfix/rainbow-rest-endpoints```
 
 ## Commit guidelines
 

pom.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>eu.quotly</groupId>
     <artifactId>backend</artifactId>
@@ -31,6 +30,7 @@
     </dependencyManagement>
 
     <dependencies>
+        <!-- Rest Api -->
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-resteasy</artifactId>
@@ -39,17 +39,41 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-resteasy-jsonb</artifactId>
         </dependency>
+
+        <!-- Database -->
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-smallrye-health</artifactId>
+            <artifactId>quarkus-hibernate-orm-panache</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-hibernate-orm-panache</artifactId>
+            <artifactId>quarkus-jdbc-mariadb</artifactId>
         </dependency>
+
+        <!-- Flyway (Database migration) -->
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-jdbc-mariadb</artifactId>
+            <artifactId>quarkus-flyway</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.flywaydb</groupId>
+            <artifactId>flyway-mysql</artifactId>
+        </dependency>
+
+        <!-- Swagger (API documentation) -->
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-openapi</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-swagger-ui</artifactId>
+        </dependency>
+
+        <!-- Miscellaneous -->
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-health</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
@@ -70,16 +94,6 @@
             <artifactId>lombok</artifactId>
             <version>1.18.30</version>
         </dependency>
-
-        <!-- Swagger -->
-        <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-smallrye-openapi</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-swagger-ui</artifactId>
-        </dependency>
     </dependencies>
 
     <build>

src/main/java/eu/quotly/config/ErrorCode.java

@@ -0,0 +1,20 @@
+package eu.quotly.config;
+
+public enum ErrorCode {
+  DATE_PARSING_ERROR(40100L),
+  USER_NOT_FOUND(40010L),
+  QUOTE_NOT_FOUND(40020L),
+  COMMENT_NOT_FOUND(40030L),
+  REACTION_NOT_FOUND(40040L),
+  INVALID_PAGE_INDEX_OR_SIZE(40101L);
+
+  private final Long code;
+
+  ErrorCode(Long code) {
+    this.code = code;
+  }
+
+  public Long getValue() {
+    return code;
+  }
+}

src/main/java/eu/quotly/config/QuotlyConfig.java

@@ -0,0 +1,20 @@
+package eu.quotly.config;
+
+import io.quarkus.runtime.annotations.StaticInitSafe;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+
+@StaticInitSafe
+@ApplicationScoped
+public class QuotlyConfig {
+  @Inject
+  QuotlyProperties quotlyProperties;
+
+  public String getVersion() {
+    return quotlyProperties.version();
+  }
+
+  public Boolean isEmailEncryptionEnabled() {
+    return quotlyProperties.emailEncryption();
+  }
+}

src/main/java/eu/quotly/config/QuotlyProperties.java

@@ -0,0 +1,11 @@
+package eu.quotly.config;
+
+import io.quarkus.runtime.annotations.StaticInitSafe;
+import io.smallrye.config.ConfigMapping;
+
+@StaticInitSafe
+@ConfigMapping(prefix = "quotly")
+public interface QuotlyProperties {
+  String version();
+  Boolean emailEncryption();
+}

src/main/java/eu/quotly/config/ResponseStatus.java

@@ -0,0 +1,12 @@
+package eu.quotly.config;
+
+@SuppressWarnings("unused")
+public enum ResponseStatus {
+  SUCCESS,
+  ERROR,
+  UNKNOWN;
+
+  public String getName() {
+    return this.name().toLowerCase();
+  }
+}

src/main/java/eu/quotly/dto/ErrorResponseDto.java

@@ -0,0 +1,33 @@
+package eu.quotly.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import eu.quotly.config.ErrorCode;
+import eu.quotly.config.ResponseStatus;
+import jakarta.json.bind.annotation.JsonbPropertyOrder;
+
+@JsonbPropertyOrder({"status", "errorCode"})
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public record ErrorResponseDto(String status, Long errorCode) {
+  public static class Builder {
+    private String status;
+    private Long errorCode;
+
+    public Builder withResponseStatus(ResponseStatus status) {
+      if (status != null) {
+        this.status = status.getName();
+      }
+      return this;
+    }
+
+    public Builder withErrorCode(ErrorCode errorCode) {
+      if (errorCode != null) {
+        this.errorCode = errorCode.getValue();
+      }
+      return this;
+    }
+
+    public ErrorResponseDto build() {
+      return new ErrorResponseDto(status, errorCode);
+    }
+  }
+}

src/main/java/eu/quotly/dto/ResponseDto.java

@@ -0,0 +1,30 @@
+package eu.quotly.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import eu.quotly.config.ResponseStatus;
+import jakarta.json.bind.annotation.JsonbPropertyOrder;
+
+@JsonbPropertyOrder({"status", "data"})
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public record ResponseDto(String status, Object data) {
+  public static class Builder {
+    private String status;
+    private Object data;
+
+    public Builder withResponseStatus(ResponseStatus status) {
+      if (status != null) {
+        this.status = status.getName();
+      }
+      return this;
+    }
+
+    public Builder withData(Object data) {
+      this.data = data;
+      return this;
+    }
+
+    public ResponseDto build() {
+      return new ResponseDto(status, data);
+    }
+  }
+}

src/main/java/eu/quotly/dto/UserDto.java

@@ -0,0 +1,16 @@
+package eu.quotly.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import jakarta.json.bind.annotation.JsonbPropertyOrder;
+
+import java.time.LocalDateTime;
+
+@JsonbPropertyOrder({"discordId", "displayName", "emailAddress", "creationTime"})
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public record UserDto(
+  String discordId,
+  String displayName,
+  String emailAddress,
+  LocalDateTime creationTime
+) {
+}

src/main/java/eu/quotly/entity/CommentEntity.java

@@ -0,0 +1,77 @@
+package eu.quotly.entity;
+
+import eu.quotly.Constants;
+import io.quarkus.hibernate.orm.panache.PanacheEntityBase;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.OneToMany;
+import jakarta.persistence.SequenceGenerator;
+import jakarta.persistence.Table;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+import java.time.LocalDateTime;
+import java.util.List;
+
+@Entity
+@Data
+@NoArgsConstructor
+@Table(name = "quote_comments", schema = "quotly")
+@EqualsAndHashCode(callSuper = true)
+public class CommentEntity extends PanacheEntityBase {
+  @Id
+  @Column(name = "comment_id", nullable = false, updatable = false)
+  @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "quote_comments_seq")
+  @SequenceGenerator(name = "quote_comments_seq", sequenceName = "quote_comments_sequence", allocationSize = 1)
+  private Long commentId;
+
+  @ManyToOne(fetch = FetchType.LAZY)
+  @JoinColumn(name = "user_id", nullable = false)
+  private UserEntity user;
+
+  @ManyToOne(fetch = FetchType.LAZY)
+  @JoinColumn(name = "quote_id", nullable = false)
+  private QuoteEntity quote;
+
+  @ManyToOne(fetch = FetchType.LAZY)
+  @JoinColumn(name = "parent", referencedColumnName = "comment_id")
+  private CommentEntity parentComment;
+
+  @OneToMany(mappedBy = "parentComment", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY)
+  private List<CommentEntity> childComments;
+
+  @Column(name = "comment", length = Constants.DB_EXTRA_LARGE_STRING_LENGTH)
+  private String comment;
+
+  @Column(name = "created_at", updatable = false)
+  private LocalDateTime creationTime = LocalDateTime.now();
+
+  @Column(name = "updated_at")
+  private LocalDateTime modificationTime;
+
+  @Column(name = "deleted_at")
+  private LocalDateTime deletionTime;
+
+  @Override
+  public String toString() {
+    return "CommentEntity {"
+      + "commentId=" + commentId
+      + ", userId=" + user.getUserId()
+      + ", quoteId=" + quote.getQuoteId()
+      + ", parentCommentId=" + parentComment.getCommentId()
+      + ", childCount=" + (childComments != null ? childComments.size() : 0)
+      + ", comment=" + comment
+      + ", creationTime=" + creationTime
+      + ", modificationTime=" + modificationTime
+      + ", deletionTime=" + deletionTime
+      + "}";
+  }
+}