feat(api): added scan api & implementation

Author: stephane-segning

.github/workflows/build.yml

@@ -87,6 +87,6 @@ jobs:
       - uses: ncipollo/release-action@v1
         with:
           artifacts: "dist/*"
-          tag: 0.0.1-SNAPSHOT
+          tag: 0.1.0
           body: |
             Release ${{ github.ref }}

build.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 
 group = 'com.ssegning.lynx'
-version = '0.0.1-SNAPSHOT'
+version = '0.1.0'
 
 java {
     sourceCompatibility = '21'
@@ -31,6 +31,7 @@ ext {
 }
 
 dependencies {
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
     implementation 'org.springframework.boot:spring-boot-starter-oauth2-resource-server'
@@ -40,9 +41,12 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-websocket'
     implementation 'io.sentry:sentry-spring-boot-starter-jakarta'
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0'
+    implementation 'org.mapstruct:mapstruct:1.5.5.Final'
+    runtimeOnly 'com.h2database:h2'
     compileOnly 'org.projectlombok:lombok'
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
     annotationProcessor 'org.projectlombok:lombok'
+    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.5.Final'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'org.springframework.boot:spring-boot-testcontainers'
     testImplementation 'org.springframework.security:spring-security-test'

frontend

@@ -0,0 +1,11 @@
+package com.ssegning.lynx.local;
+
+import org.springframework.boot.autoconfigure.domain.EntityScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+
+@EntityScan
+@Configuration
+@EnableJpaRepositories
+public class JpaConfig {
+}

src/main/java/com/ssegning/lynx/local/JpaConfig.java

@@ -0,0 +1,34 @@
+package com.ssegning.lynx.local.domain;
+
+import jakarta.persistence.*;
+import lombok.Data;
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.annotation.LastModifiedDate;
+
+import java.util.Map;
+import java.util.UUID;
+
+@Data
+@Entity
+@Table(name = "scans")
+public class ScanEntity {
+
+    @Id
+    @Column
+    private UUID id;
+
+    @Column(name = "created_at")
+    @CreatedDate
+    private String createdAt;
+
+    @Column(name = "updated_at")
+    @LastModifiedDate
+    private String updatedAt;
+
+    @Column(name = "title")
+    private String title;
+
+    @ElementCollection
+    @CollectionTable(name = "scan_meta_data", joinColumns = @JoinColumn(name = "scan_id"))
+    private Map<String, String> metaData;
+}

src/main/java/com/ssegning/lynx/local/domain/ScanEntity.java

@@ -0,0 +1,16 @@
+package com.ssegning.lynx.local.mapper;
+
+import com.ssegning.lynx.local.domain.ScanEntity;
+import com.ssegning.lynx.local.service.ScanFactory;
+import com.ssegning.lynx.lynxbackend.model.Scan;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.MappingConstants;
+
+@Mapper(componentModel = MappingConstants.ComponentModel.SPRING, uses = {UuidMapper.class, ScanFactory.class})
+public interface ScanMapper {
+    @Mapping(target = "id", ignore = true)
+    ScanEntity map(Scan scan);
+
+    Scan map(ScanEntity scan);
+}

src/main/java/com/ssegning/lynx/local/mapper/ScanMapper.java

@@ -0,0 +1,24 @@
+package com.ssegning.lynx.local.mapper;
+
+import org.springframework.stereotype.Component;
+
+import java.util.UUID;
+
+@Component
+public class UuidMapper {
+    public String map(UUID value) {
+        if (value == null) {
+            return null;
+        }
+
+        return value.toString();
+    }
+
+    public UUID map(String value) {
+        if (value == null) {
+            return null;
+        }
+
+        return UUID.fromString(value);
+    }
+}

src/main/java/com/ssegning/lynx/local/mapper/UuidMapper.java

@@ -0,0 +1,11 @@
+package com.ssegning.lynx.local.repo;
+
+import com.ssegning.lynx.local.domain.ScanEntity;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+import java.util.UUID;
+
+@Repository
+public interface ScanRepo extends JpaRepository<ScanEntity, UUID> {
+}

src/main/java/com/ssegning/lynx/local/repo/ScanRepo.java

@@ -1,4 +1,4 @@
-package com.ssegning.lynx.local;
+package com.ssegning.lynx.local.service;
 
 import com.ssegning.lynx.lynxbackend.exceptions.StorageException;
 import com.ssegning.lynx.lynxbackend.exceptions.StorageFileNotFoundException;
@@ -21,7 +21,7 @@
 
 @Service
 @RequiredArgsConstructor
-public class LocalFSUpload implements FileUpload {
+public class LocalFSUploadService implements FileUpload {
 
     @Value("${file.upload-dir}")
     private Path rootLocation;

src/main/java/com/ssegning/lynx/local/LocalFSUpload.java src/main/java/com/ssegning/lynx/local/service/LocalFSUploadService.java

@@ -0,0 +1,26 @@
+package com.ssegning.lynx.local.service;
+
+import com.ssegning.lynx.local.repo.ScanRepo;
+import com.ssegning.lynx.local.mapper.UuidMapper;
+import com.ssegning.lynx.local.domain.ScanEntity;
+import com.ssegning.lynx.lynxbackend.model.Scan;
+import lombok.RequiredArgsConstructor;
+import org.mapstruct.ObjectFactory;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class ScanFactory {
+    private final ScanRepo repo;
+    private final UuidMapper uuidMapper;
+
+    @ObjectFactory
+    public ScanEntity factory(Scan scan) {
+        var id = uuidMapper.map(scan.getId());
+        if (id == null) {
+            return new ScanEntity();
+        }
+
+        return repo.getReferenceById(id);
+    }
+}

src/main/java/com/ssegning/lynx/local/service/ScanFactory.java

@@ -0,0 +1,56 @@
+package com.ssegning.lynx.local.service;
+
+import com.ssegning.lynx.local.mapper.ScanMapper;
+import com.ssegning.lynx.local.repo.ScanRepo;
+import com.ssegning.lynx.local.mapper.UuidMapper;
+import com.ssegning.lynx.lynxbackend.model.Scan;
+import com.ssegning.lynx.lynxbackend.service.ScanService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.stereotype.Service;
+
+import java.math.BigDecimal;
+import java.util.List;
+
+@Service
+@RequiredArgsConstructor
+public class ScanServiceImpl implements ScanService {
+    private final ScanRepo repo;
+    private final ScanMapper mapper;
+    private final UuidMapper uuidMapper;
+
+    @Override
+    public Scan createScan(Scan scan) {
+        var entity = mapper.map(scan);
+        var saved = repo.save(entity);
+        return mapper.map(saved);
+    }
+
+    @Override
+    public Scan updateScan(String scanId, Scan scan) {
+        scan.setId(scanId);
+        var entity = mapper.map(scan);
+        var saved = repo.save(entity);
+        return mapper.map(saved);
+    }
+
+    @Override
+    public Scan getScan(String scanId) {
+        var id = uuidMapper.map(scanId);
+        var saved = repo.getReferenceById(id);
+        return mapper.map(saved);
+    }
+
+    @Override
+    public void deleteScan(String scanId) {
+        var id = uuidMapper.map(scanId);
+        repo.deleteById(id);
+    }
+
+    @Override
+    public List<Scan> getScans(BigDecimal page, BigDecimal size) {
+        var pageRequest = PageRequest.of(page.intValue(), size.intValue());
+        var entities = repo.findAll(pageRequest).getContent();
+        return entities.stream().map(mapper::map).toList();
+    }
+}

src/main/java/com/ssegning/lynx/local/service/ScanServiceImpl.java

@@ -0,0 +1,44 @@
+package com.ssegning.lynx.lynxbackend.controller;
+
+import com.ssegning.lynx.lynxbackend.api.ScanApi;
+import com.ssegning.lynx.lynxbackend.model.Scan;
+import com.ssegning.lynx.lynxbackend.service.ScanService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.math.BigDecimal;
+import java.util.List;
+import java.util.Optional;
+
+@RestController
+@RequestMapping
+@RequiredArgsConstructor
+public class ScanApiImpl implements ScanApi {
+    private final ScanService scanService;
+
+    @Override
+    public Scan createScan(Scan scan) {
+        return scanService.createScan(scan);
+    }
+
+    @Override
+    public void deleteScan(String scanId) {
+        scanService.deleteScan(scanId);
+    }
+
+    @Override
+    public Scan getScan(String scanId) {
+        return scanService.getScan(scanId);
+    }
+
+    @Override
+    public List<Scan> getScans(Optional<BigDecimal> page, Optional<BigDecimal> size) {
+        return scanService.getScans(page.orElse(BigDecimal.ZERO), size.orElse(BigDecimal.TEN));
+    }
+
+    @Override
+    public Scan updateScan(String scanId, Scan scan) {
+        return scanService.updateScan(scanId, scan);
+    }
+}

src/main/java/com/ssegning/lynx/lynxbackend/controller/ScanApiImpl.java

@@ -0,0 +1,18 @@
+package com.ssegning.lynx.lynxbackend.service;
+
+import com.ssegning.lynx.lynxbackend.model.Scan;
+
+import java.math.BigDecimal;
+import java.util.List;
+
+public interface ScanService {
+    Scan createScan(Scan scan);
+
+    Scan updateScan(String scanId, Scan scan);
+
+    Scan getScan(String scanId);
+
+    void deleteScan(String scanId);
+
+    List<Scan> getScans(BigDecimal page, BigDecimal size);
+}

src/main/java/com/ssegning/lynx/lynxbackend/service/ScanService.java

@@ -127,6 +127,12 @@ spring:
       - org.springframework.boot.actuate.autoconfigure.web.reactive.ReactiveManagementContextAutoConfiguration
       - org.springframework.boot.actuate.autoconfigure.web.server.ManagementContextAutoConfiguration
       - org.springframework.boot.actuate.autoconfigure.web.servlet.ServletManagementContextAutoConfiguration
+  jpa:
+    database: h2
+    generate-ddl: true
+    open-in-view: false
+  datasource:
+    url: jdbc:h2:file:./tmp/h2db
 
 file:
-  upload-dir: ./tmp
+  upload-dir: ./tmp