Merge pull request #30 from companieshouse/feature/lp-207-create-persistence-service

LP-207 create service to persist submission

Author: dlloyd1-ch

pom.xml

@@ -18,11 +18,13 @@
         <java.version>21</java.version>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
+        <maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <spring-boot-dependencies.version>3.3.4</spring-boot-dependencies.version>
         <spring-boot-maven-plugin.version>3.3.4</spring-boot-maven-plugin.version>
         <api-sdk-java.version>6.0.21</api-sdk-java.version>
         <structured-logging.version>3.0.20</structured-logging.version>
+        <org.mapstruct.version>1.5.5.Final</org.mapstruct.version>
         <log4j.version>2.24.1</log4j.version>
         <jib-maven-plugin.version>3.4.2</jib-maven-plugin.version>
     </properties>
@@ -63,6 +65,10 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-mongodb</artifactId>
+        </dependency>
         <dependency>
             <groupId>uk.gov.companieshouse</groupId>
             <artifactId>structured-logging</artifactId>
@@ -73,6 +79,11 @@
             <artifactId>api-sdk-java</artifactId>
             <version>${api-sdk-java.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.mapstruct</groupId>
+            <artifactId>mapstruct</artifactId>
+            <version>${org.mapstruct.version}</version>
+        </dependency>
 
         <!-- Test dependencies -->
         <dependency>
@@ -86,6 +97,11 @@
             <version>${sonar-maven-plugin.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -106,6 +122,22 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>${maven-compiler-plugin.version}</version>
+                <configuration>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>org.mapstruct</groupId>
+                            <artifactId>mapstruct-processor</artifactId>
+                            <version>${org.mapstruct.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>com.google.cloud.tools</groupId>
                 <artifactId>jib-maven-plugin</artifactId>

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/mapper/LimitedPartnershipMapper.java

@@ -0,0 +1,28 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.mapper;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+import org.springframework.stereotype.Component;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.PartnershipNameEnding;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dao.DataDao;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dao.LimitedPartnershipSubmissionDao;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.DataDto;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionDto;
+
+@Component
+@Mapper(componentModel = "spring")
+public interface LimitedPartnershipMapper {
+
+  LimitedPartnershipMapper INSTANCE = Mappers.getMapper(LimitedPartnershipMapper.class);
+
+  LimitedPartnershipSubmissionDao dtoToDao(LimitedPartnershipSubmissionDto dto);
+
+  default String mapPartnershipNameEndingToString(PartnershipNameEnding nameEnding){
+    return nameEnding.getDescription();
+  }
+
+  default PartnershipNameEnding mapPartnershipNameEndingToEnum(String nameEnding){
+    return nameEnding != null ? PartnershipNameEnding.fromDescription(nameEnding) : null;
+  }
+
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/PartnershipNameEnding.java

@@ -0,0 +1,30 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.model;
+
+public enum PartnershipNameEnding {
+
+    LIMITED_PARTNERSHIP("Limited Partnership"),
+    LP("LP"),
+    L_DOT_P_DOT("L.P."),
+    PARTNERIAETH_CYFYNGEDIG("Partneriaeth Cyfyngedig"),
+    PC("PC"),
+    P_DOT_C_DOT("P.C.");
+
+    private final String description;
+
+    PartnershipNameEnding(String description) {
+        this.description = description;
+    };
+
+    public String getDescription() {
+        return description;
+    }
+
+    public static PartnershipNameEnding fromDescription(String description) {
+        for (PartnershipNameEnding nameEnding : PartnershipNameEnding.values()) {
+            if (nameEnding.getDescription().equalsIgnoreCase(description)) {
+                return nameEnding;
+            }
+        }
+        throw new IllegalArgumentException("No PartnershipNameEnding constant with description " + description);
+    }
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dao/DataDao.java

@@ -0,0 +1,28 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.model.dao;
+
+import org.springframework.data.mongodb.core.mapping.Field;
+
+public class DataDao {
+
+    @Field("partnership_name")
+    private String partnershipName;
+
+    @Field("name_ending")
+    private String nameEnding;
+
+    public String getPartnershipName() {
+        return partnershipName;
+    }
+
+    public void setPartnershipName(String partnershipName) {
+        this.partnershipName = partnershipName;
+    }
+
+    public String getNameEnding() {
+        return nameEnding;
+    }
+
+    public void setNameEnding(String nameEnding) {
+        this.nameEnding = nameEnding;
+    }
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dao/LimitedPartnershipSubmissionDao.java

@@ -0,0 +1,55 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.model.dao;
+
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.Document;
+import org.springframework.data.mongodb.core.mapping.Field;
+
+import java.time.LocalDateTime;
+
+@Document(collection = "limited_partnership_submissions")
+public class LimitedPartnershipSubmissionDao {
+
+    @Id
+    private String id;
+
+    @Field("created_at")
+    private LocalDateTime createdAt;
+
+    @Field("created_by_user_id")
+    private String userId;
+
+    @Field("data")
+    private DataDao data;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public LocalDateTime getCreatedAt() {
+        return createdAt;
+    }
+
+    public void setCreatedAt(LocalDateTime createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    public DataDao getData() {
+        return data;
+    }
+
+    public void setData(DataDao data) {
+        this.data = data;
+    }
+
+    public String getUserId() {
+        return userId;
+    }
+
+    public void setUserId(String userId) {
+        this.userId = userId;
+    }
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dto/DataDto.java

@@ -0,0 +1,33 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.model.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.PartnershipNameEnding;
+
+import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
+
+public class DataDto {
+    @JsonInclude(NON_NULL)
+    @JsonProperty("partnership_name")
+    private String partnershipName;
+
+    @JsonInclude(NON_NULL)
+    @JsonProperty("name_ending")
+    private PartnershipNameEnding nameEnding;
+
+    public String getPartnershipName() {
+        return partnershipName;
+    }
+
+    public void setPartnershipName(String partnershipName) {
+        this.partnershipName = partnershipName;
+    }
+
+    public PartnershipNameEnding getNameEnding() {
+        return nameEnding;
+    }
+
+    public void setNameEnding(PartnershipNameEnding nameEnding) {
+        this.nameEnding = nameEnding;
+    }
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dto/LimitedPartnershipSubmissionDto.java

@@ -0,0 +1,21 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.model.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
+
+public class LimitedPartnershipSubmissionDto {
+
+    @JsonInclude(NON_NULL)
+    @JsonProperty("data")
+    private DataDto data;
+
+    public DataDto getData() {
+        return data;
+    }
+
+    public void setData(DataDto data) {
+        this.data = data;
+    }
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/repository/LimitedPartnershipSubmissionsRepository.java

@@ -0,0 +1,9 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.repository;
+
+import org.springframework.data.mongodb.repository.MongoRepository;
+import org.springframework.stereotype.Repository;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dao.LimitedPartnershipSubmissionDao;
+
+@Repository
+public interface LimitedPartnershipSubmissionsRepository extends MongoRepository<LimitedPartnershipSubmissionDao, String> {
+}

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/service/LimitedPartnershipService.java

@@ -0,0 +1,36 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.service;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+import uk.gov.companieshouse.limitedpartnershipsapi.mapper.LimitedPartnershipMapper;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dao.LimitedPartnershipSubmissionDao;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionDto;
+import uk.gov.companieshouse.limitedpartnershipsapi.repository.LimitedPartnershipSubmissionsRepository;
+import uk.gov.companieshouse.limitedpartnershipsapi.utils.ApiLogger;
+
+import java.time.LocalDateTime;
+
+@Service
+public class LimitedPartnershipService {
+
+    private final LimitedPartnershipMapper mapper;
+    private final LimitedPartnershipSubmissionsRepository repository;
+
+    @Autowired
+    public LimitedPartnershipService(LimitedPartnershipMapper mapper, LimitedPartnershipSubmissionsRepository repository) {
+        this.mapper = mapper;
+        this.repository = repository;
+    }
+
+    public String createLimitedPartnership(LimitedPartnershipSubmissionDto limitedPartnershipSubmissionDto, String requestId, String userId) {
+        ApiLogger.debug("Called createLimitedPartnership(...)");
+
+        LimitedPartnershipSubmissionDao dao = mapper.dtoToDao(limitedPartnershipSubmissionDto);
+        dao.setCreatedAt(LocalDateTime.now());
+        dao.setUserId(userId);
+        LimitedPartnershipSubmissionDao insertedSubmission = repository.insert(dao);
+        ApiLogger.infoContext(requestId, String.format("Limited Partnership Submission created with limited-partnership submission id: %s", insertedSubmission.getId()));
+
+        return insertedSubmission.getId();
+    }
+}

src/main/resources/application.properties

@@ -1,3 +1,6 @@
+limited_partnerships.mongodb.dbname=transactions_limited_partnerships
+spring.data.mongodb.uri=${MONGODB_URL}/${limited_partnerships.mongodb.dbname}
+
 # Spring actuator end-points config
 management.endpoints.enabled-by-default=false
 management.endpoint.health.enabled=true