Merge pull request #45 from companieshouse/lp219-links-uri-submission

Store as self link in the links data block in the mongo record

Author: HatiDev

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

@@ -5,6 +5,7 @@
 import org.springframework.data.mongodb.core.mapping.Field;
 
 import java.time.LocalDateTime;
+import java.util.Map;
 
 @Document(collection = "limited_partnership_submissions")
 public class LimitedPartnershipSubmissionDao {
@@ -21,6 +22,9 @@ public class LimitedPartnershipSubmissionDao {
     @Field("data")
     private DataDao data;
 
+    @Field("links")
+    private Map<String, String> links;
+
     public String getId() {
         return id;
     }
@@ -52,4 +56,12 @@ public String getUserId() {
     public void setUserId(String userId) {
         this.userId = userId;
     }
+
+    public Map<String, String> getLinks() {
+        return links;
+    }
+
+    public void setLinks(Map<String, String> links) {
+        this.links = links;
+    }
 }

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

@@ -18,6 +18,7 @@
 
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.FILING_KIND_LIMITED_PARTNERSHIP;
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.SUBMISSION_URI_PATTERN;
+import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.LINK_SELF;
 
 @Service
 public class LimitedPartnershipService {
@@ -49,9 +50,11 @@ public String createLimitedPartnership(Transaction transaction,
         LimitedPartnershipSubmissionDao dao = mapper.dtoToDao(limitedPartnershipSubmissionDto);
         dao.setCreatedAt(LocalDateTime.now());
         dao.setUserId(userId);
+
         LimitedPartnershipSubmissionDao insertedSubmission = repository.insert(dao);
 
         final String submissionUri = getSubmissionUri(transaction.getId(), insertedSubmission.getId());
+        updateLimitedPartnershipSubmissionWithSelfLink(insertedSubmission, submissionUri); 
 
         // Create the Resource to be added to the Transaction (includes various links to the resource)
         var limitedPartnershipResource = createLimitedPartnershipTransactionResource(submissionUri);
@@ -102,4 +105,10 @@ private boolean hasExistingLimitedPartnershipSubmission(Transaction transaction)
         }
         return false;
     }
+
+    private void updateLimitedPartnershipSubmissionWithSelfLink(LimitedPartnershipSubmissionDao submission,
+                                                              String submissionUri) {
+        submission.setLinks(Collections.singletonMap(LINK_SELF, submissionUri));
+        repository.save(submission);
+    }
 }

src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/utils/Constants.java

@@ -19,4 +19,6 @@ private Constants() {
 
     // Filings
     public static final String FILING_KIND_LIMITED_PARTNERSHIP = "limited-partnership";
+
+    public static final String LINK_SELF = "self";
 }

src/test/java/uk/gov/companieshouse/limitedpartnershipsapi/service/LimitedPartnershipServiceTest.java

@@ -35,7 +35,8 @@ class LimitedPartnershipServiceTest {
     private static final String USER_ID = "xbJf0l";
     private static final String SUBMISSION_ID = "abc-123";
     private static final String REQUEST_ID = "fd4gld5h3jhh";
-    private static final String TRANSACTION_ID = "12321123";
+    private static final String TRANSACTION_ID = "txn-456";
+    private static final String LINK_SELF = "self";
 
     @InjectMocks
     private LimitedPartnershipService service;
@@ -52,6 +53,9 @@ class LimitedPartnershipServiceTest {
     @Captor
     private ArgumentCaptor<Transaction> transactionApiCaptor;
 
+    @Captor
+    private ArgumentCaptor<LimitedPartnershipSubmissionDao> submissionCaptor;
+
     @Test
     void givenDto_whenCreateLP_thenLPCreatedWithSubmissionIdAndTransactionUpdated() throws ServiceException {
         // given
@@ -62,13 +66,14 @@ void givenDto_whenCreateLP_thenLPCreatedWithSubmissionIdAndTransactionUpdated()
         when(repository.insert(limitedPartnershipSubmissionDao)).thenReturn(limitedPartnershipSubmissionDao);
 
         Transaction transaction = buildTransaction();
-
+        
         // when
         String submissionId = service.createLimitedPartnership(transaction, limitedPartnershipSubmissionDto, REQUEST_ID, USER_ID);
 
         // then
         verify(mapper, times(1)).dtoToDao(limitedPartnershipSubmissionDto);
         verify(repository, times(1)).insert(limitedPartnershipSubmissionDao);
+        verify(repository, times(1)).save(submissionCaptor.capture());
         verify(transactionService, times(1)).updateTransaction(transactionApiCaptor.capture(), any());
         assertEquals(SUBMISSION_ID, submissionId);
 
@@ -78,6 +83,10 @@ void givenDto_whenCreateLP_thenLPCreatedWithSubmissionIdAndTransactionUpdated()
         assertNull(sentTransaction.getCompanyNumber());
         String submissionUri = String.format("/transactions/%s/limited-partnership/%s", transaction.getId(), limitedPartnershipSubmissionDao.getId());
         assertEquals(submissionUri, sentTransaction.getResources().get(submissionUri).getLinks().get("resource"));
+        // assert dao submission self link is correct
+        LimitedPartnershipSubmissionDao sentSubmission = submissionCaptor.getValue();
+        String sentSubmissionUri = sentSubmission.getLinks().get(LINK_SELF);
+        assertEquals(submissionUri, sentSubmissionUri);
     }
 
     @Test