Adding Partial Response.

mariazevedo88 · Sep 17, 2020 · 5f3121b · 5f3121b
1 parent ab393d1
commit 5f3121b
Show file tree

Hide file tree

Showing 10 changed files with 232 additions and 77 deletions.
diff --git a/pom.xml b/pom.xml
@@ -25,6 +25,7 @@
 		<modelmapper.version>2.3.8</modelmapper.version>
 		<bucket4j.version>4.10.0</bucket4j.version>
 		<spring.admin.version>2.3.0</spring.admin.version>
+		<partialize.version>release~20.05</partialize.version>
 	</properties>
 
 	<parent>
@@ -33,6 +34,13 @@
 		<version>2.3.3.RELEASE</version>
 		<relativePath/>
 	</parent>
+
+	<repositories>
+		<repository>
+		    <id>jitpack.io</id>
+		    <url>https://jitpack.io</url>
+		</repository>
+	</repositories>
 
 	<dependencies>
 		<dependency>
@@ -115,6 +123,11 @@
 		    <artifactId>bucket4j-core</artifactId>
 		    <version>${bucket4j.version}</version>
 		</dependency>
+		<dependency>
+		    <groupId>com.github.thibaultmeyer</groupId>
+		    <artifactId>partialize</artifactId>
+		    <version>${partialize.version}</version>
+		</dependency>
 	</dependencies>
 
 	<build>

diff --git a/...io/github/mariazevedo88/financialjavaapi/controller/v1/statistic/StatisticController.java b/...io/github/mariazevedo88/financialjavaapi/controller/v1/statistic/StatisticController.java
@@ -77,10 +77,10 @@ public ResponseEntity<Response<StatisticDTO>> create(@RequestHeader(value=Financ
 		Response<StatisticDTO> response = new Response<>();
 
 		Statistic statistics = createStatistics(transactionService.findAll());
-		statistics = statisticService.save(statistics);
+		Statistic statisticsToCreate = statisticService.save(statistics);
 
-		StatisticDTO dto = convertEntityToDTO(statistics);
-		createSelfLink(statistics, dto);
+		StatisticDTO dto = convertEntityToDTO(statisticsToCreate);
+		createSelfLink(statisticsToCreate, dto);
 		response.setData(dto);
 
 		MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
@@ -119,32 +119,32 @@ private Statistic createStatistics(List<Transaction> transactions) {
 	}
 
 	/**
-	 * Method to convert an Statistic entity to an Statistic DTO.
+	 * Method that creates a self link to statistic object
 	 * 
 	 * @author Mariana Azevedo
 	 * @since 03/04/2020
 	 * 
-	 * @param statistic
-	 * @return a <code>StatisticDTO</code> object
+	 * @param statistics
+	 * @param statisticDTO
 	 */
-	private StatisticDTO convertEntityToDTO(Statistic statistic) {
-
-		ModelMapper modelMapper = new ModelMapper();
-		return modelMapper.map(statistic, StatisticDTO.class);
+	private void createSelfLink(Statistic statistics, StatisticDTO statisticDTO) {
+		Link selfLink = WebMvcLinkBuilder.linkTo(StatisticController.class).slash(statistics.getId()).withSelfRel();
+		statisticDTO.add(selfLink);
 	}
 
 	/**
-	 * Method that creates a self link to statistic object
+	 * Method to convert an Statistic entity to an Statistic DTO.
 	 * 
 	 * @author Mariana Azevedo
 	 * @since 03/04/2020
 	 * 
-	 * @param statistics
-	 * @param statisticDTO
+	 * @param statistic
+	 * @return a <code>StatisticDTO</code> object
 	 */
-	private void createSelfLink(Statistic statistics, StatisticDTO statisticDTO) {
-		Link selfLink = WebMvcLinkBuilder.linkTo(StatisticController.class).slash(statistics.getId()).withSelfRel();
-		statisticDTO.add(selfLink);
+	public StatisticDTO convertEntityToDTO(Statistic statistic) {
+
+		ModelMapper modelMapper = new ModelMapper();
+		return modelMapper.map(statistic, StatisticDTO.class);
 	}
 
 }
diff --git a/...ithub/mariazevedo88/financialjavaapi/controller/v1/transaction/TransactionController.java b/...ithub/mariazevedo88/financialjavaapi/controller/v1/transaction/TransactionController.java
@@ -109,10 +109,12 @@ public ResponseEntity<Response<TransactionDTO>> create(@RequestHeader(value=Fina
 			throw new NotParsableContentException("Date of the transaction is in the future.");
 		}
 
-		Transaction transaction = transactionService.save(convertDTOToEntity(dto));
-		TransactionDTO dtoSaved = convertEntityToDTO(transaction);
-		createSelfLink(transaction, dtoSaved);
-
+		Transaction transaction = convertDTOToEntity(dto); 
+		Transaction transactionToCreate = transactionService.save(transaction);
+
+		TransactionDTO dtoSaved = convertEntityToDTO(transactionToCreate);
+		createSelfLink(transactionToCreate, dtoSaved);
+
 		response.setData(dtoSaved);
 
 		MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
@@ -174,10 +176,11 @@ public ResponseEntity<Response<TransactionDTO>> update(@RequestHeader(value=Fina
 			throw new TransactionInvalidUpdateException("You don't have permission to change the transaction id=" + dto.getId());
 		}
 
-		Transaction transaction = transactionService.save(convertDTOToEntity(dto));
-		TransactionDTO itemDTO = convertEntityToDTO(transaction);
+		Transaction transaction = convertDTOToEntity(dto);
+		Transaction transactionToUpdate = transactionService.save(transaction);
 
-		createSelfLink(transaction, itemDTO);
+		TransactionDTO itemDTO = convertEntityToDTO(transactionToUpdate);
+		createSelfLink(transactionToUpdate, itemDTO);
 		response.setData(itemDTO);
 
 		MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
@@ -234,7 +237,7 @@ public ResponseEntity<Response<Page<TransactionDTO>>> findAllBetweenDates(@Reque
 		Page<TransactionDTO> itemsDTO = transactions.map(this::convertEntityToDTO);
 		itemsDTO.stream().forEach(dto -> {
 			try {
-				createSelfLinkInCollections(apiVersion, apiKey, dto);
+				createSelfLinkInCollections(apiVersion, apiKey, dto, null);
 			} catch (TransactionNotFoundException e) {
 				log.error("There are no transactions registered between startDate= {} and endDate= {}", startDate, endDate);
 			}
@@ -290,7 +293,7 @@ public ResponseEntity<Response<List<TransactionDTO>>> findByNsu(@RequestHeader(v
 
 		transactionsDTO.stream().forEach(dto -> {
 			try {
-				createSelfLinkInCollections(apiVersion, apiKey, dto);
+				createSelfLinkInCollections(apiVersion, apiKey, dto, null);
 			} catch (TransactionNotFoundException e) {
 				log.error("There are no transactions registered with the nsu= {}", transactionNSU);
 			}
@@ -311,6 +314,7 @@ public ResponseEntity<Response<List<TransactionDTO>>> findByNsu(@RequestHeader(v
 	 * @param apiVersion - API version at the moment
 	 * @param apiKey - API Key to access the routes
 	 * @param transactionId - the id of the transaction
+	 * @param fields - Transaction fields that should be returned in JSON as Partial Response
 	 * 
 	 * @return ResponseEntity with a <code>Response<TransactionDTO></code> object and the HTTP status
 	 * 
@@ -320,21 +324,26 @@ public ResponseEntity<Response<List<TransactionDTO>>> findByNsu(@RequestHeader(v
 	 * 400 - Bad Request: The request was unacceptable, often due to missing a required parameter.
 	 * 404 - Not Found: The requested resource doesn't exist.
 	 * 409 - Conflict: The request conflicts with another request (perhaps due to using the same idempotent key).
-	 * 429 - Too Many Requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
+	 * 429 - Too Many Requests: Too many requests hit the API too quickly. We recommend an exponential back-off of your requests.
 	 * 500, 502, 503, 504 - Server Errors: something went wrong on API end (These are rare).
 	 * 
 	 * @throws TransactionNotFoundException
 	 */
 	@GetMapping(value = "/{id}")
 	@ApiOperation(value = "Route to find a transaction by your id in the API")
 	public ResponseEntity<Response<TransactionDTO>> findById(@RequestHeader(value=FinancialApiUtil.HEADER_FINANCIAL_API_VERSION, defaultValue="${api.version}") 
-		String apiVersion, @RequestHeader(value=FinancialApiUtil.HEADER_API_KEY, defaultValue="${api.key}") String apiKey, 
-		@PathVariable("id") Long transactionId) throws TransactionNotFoundException {
+		String apiVersion, @RequestHeader(value=FinancialApiUtil.HEADER_API_KEY, defaultValue="${api.key}") String apiKey, @PathVariable("id") Long transactionId,
+		@RequestParam(required = false) String fields) throws TransactionNotFoundException {
 
 		Response<TransactionDTO> response = new Response<>();
 		Transaction transaction = transactionService.findById(transactionId);
 
 		TransactionDTO dto = convertEntityToDTO(transaction);
+
+		if(fields != null) {
+			dto = transactionService.getPartialJsonResponse(fields, dto);
+		}
+
 		createSelfLink(transaction, dto);
 		response.setData(dto);
 
@@ -387,36 +396,6 @@ public ResponseEntity<Response<String>> delete(@RequestHeader(value=FinancialApi
 		return new ResponseEntity<>(response, headers, HttpStatus.NO_CONTENT);
 	}
 
-	/**
-	 * Method to convert an Transaction DTO to a Transaction entity.
-	 * 
-	 * @author Mariana Azevedo
-	 * @since 03/04/2020
-	 * 
-	 * @param dto
-	 * @return a <code>Transaction</code> object
-	 */
-	private Transaction convertDTOToEntity(TransactionDTO dto) {
-
-		ModelMapper modelMapper = new ModelMapper();
-		return modelMapper.map(dto, Transaction.class);
-	}
-
-	/**
-	 * Method to convert an Transaction entity to a Transaction DTO.
-	 * 
-	 * @author Mariana Azevedo
-	 * @since 03/04/2020
-	 * 
-	 * @param transaction
-	 * @return a <code>TransactionDTO</code> object
-	 */
-	private TransactionDTO convertEntityToDTO(Transaction transaction) {
-
-		ModelMapper modelMapper = new ModelMapper();
-		return modelMapper.map(transaction, TransactionDTO.class);
-	}
-
 	/**
 	 * Method that creates a self link to transaction object
 	 * 
@@ -442,11 +421,41 @@ private void createSelfLink(Transaction transaction, TransactionDTO transactionD
 	 * @param transactionDTO
 	 * @throws TransactionNotFoundException
 	 */
-	private void createSelfLinkInCollections(String apiVersion, String apiKey, final TransactionDTO transactionDTO) 
+	private void createSelfLinkInCollections(String apiVersion, String apiKey, final TransactionDTO transactionDTO, String fields) 
 			throws TransactionNotFoundException {
 		Link selfLink = linkTo(methodOn(TransactionController.class).findById(apiVersion, apiKey, 
-				transactionDTO.getId())).withSelfRel();
+				transactionDTO.getId(), fields)).withSelfRel();
 		transactionDTO.add(selfLink);
 	}
 
+	/**
+	 * Method to convert an Transaction DTO to a Transaction entity.
+	 * 
+	 * @author Mariana Azevedo
+	 * @since 03/04/2020
+	 * 
+	 * @param dto
+	 * @return a <code>Transaction</code> object
+	 */
+	public Transaction convertDTOToEntity(TransactionDTO dto) {
+
+		ModelMapper modelMapper = new ModelMapper();
+		return modelMapper.map(dto, Transaction.class);
+	}
+
+	/**
+	 * Method to convert an Transaction entity to a Transaction DTO.
+	 * 
+	 * @author Mariana Azevedo
+	 * @since 03/04/2020
+	 * 
+	 * @param transaction
+	 * @return a <code>TransactionDTO</code> object
+	 */
+	public TransactionDTO convertEntityToDTO(Transaction transaction) {
+
+		ModelMapper modelMapper = new ModelMapper();
+		return modelMapper.map(transaction, TransactionDTO.class);
+	}
+
 }
diff --git a/...n/java/io/github/mariazevedo88/financialjavaapi/dto/model/transaction/TransactionDTO.java b/...n/java/io/github/mariazevedo88/financialjavaapi/dto/model/transaction/TransactionDTO.java
@@ -9,10 +9,12 @@
 import org.springframework.hateoas.RepresentationModel;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
 import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
+import com.zero_x_baadf00d.partialize.annotation.Partialize;
 
 import io.github.mariazevedo88.financialjavaapi.model.enumeration.TransactionTypeEnum;
 import lombok.EqualsAndHashCode;
@@ -28,6 +30,11 @@
 @Getter
 @Setter
 @EqualsAndHashCode(callSuper = false)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@Partialize(
+		allowedFields = {"id", "nsu", "authorizationNumber", "transactionDate", "amount", "type"},
+		defaultFields = {"nsu", "transactionDate", "amount"}
+)
 public class TransactionDTO extends RepresentationModel<TransactionDTO> {
 
 	private Long id;

diff --git a/...java/io/github/mariazevedo88/financialjavaapi/service/transaction/TransactionService.java b/...java/io/github/mariazevedo88/financialjavaapi/service/transaction/TransactionService.java
@@ -5,6 +5,7 @@
 
 import org.springframework.data.domain.Page;
 
+import io.github.mariazevedo88.financialjavaapi.dto.model.transaction.TransactionDTO;
 import io.github.mariazevedo88.financialjavaapi.exception.TransactionNotFoundException;
 import io.github.mariazevedo88.financialjavaapi.model.enumeration.PageOrderEnum;
 import io.github.mariazevedo88.financialjavaapi.model.transaction.Transaction;
@@ -86,5 +87,16 @@ public interface TransactionService {
 	 */
 	Page<Transaction> findBetweenDates(LocalDateTime startDate, LocalDateTime endDate, int page,
 			PageOrderEnum order);
-
+
+	/**
+	 * Method to build a partial response in requests regarding Transaction.
+	 * 
+	 * @author Mariana Azevedo
+	 * @since 17/09/2020
+	 * 
+	 * @param fields
+	 * @param dto
+	 * @return a <code>TransactionDTO</code> object
+	 */
+	TransactionDTO getPartialJsonResponse(String fields, TransactionDTO dto);
 }
diff --git a/...ithub/mariazevedo88/financialjavaapi/service/transaction/impl/TransactionServiceImpl.java b/...ithub/mariazevedo88/financialjavaapi/service/transaction/impl/TransactionServiceImpl.java
@@ -12,6 +12,11 @@
 import org.springframework.data.domain.Sort.Direction;
 import org.springframework.stereotype.Service;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ContainerNode;
+import com.zero_x_baadf00d.partialize.Partialize;
+
+import io.github.mariazevedo88.financialjavaapi.dto.model.transaction.TransactionDTO;
 import io.github.mariazevedo88.financialjavaapi.exception.TransactionNotFoundException;
 import io.github.mariazevedo88.financialjavaapi.model.enumeration.PageOrderEnum;
 import io.github.mariazevedo88.financialjavaapi.model.transaction.Transaction;
@@ -95,4 +100,15 @@ public List<Transaction> findAll() {
 		return transactionRepository.findAll();
 	}
 
+	/**
+	 * @see TransactionService#getPartialJsonResponse(String, TransactionDTO)
+	 */
+	@Override
+	public TransactionDTO getPartialJsonResponse(String fields, TransactionDTO dto) {
+
+		final Partialize partialize = new Partialize();
+		final ContainerNode<?> node = partialize.buildPartialObject(fields, TransactionDTO.class, dto);
+		return new ObjectMapper().convertValue(node, TransactionDTO.class);
+	}
+
 }
diff --git a/src/main/java/io/github/mariazevedo88/financialjavaapi/util/BigDecimalConverter.java b/src/main/java/io/github/mariazevedo88/financialjavaapi/util/BigDecimalConverter.java
@@ -0,0 +1,41 @@
+package io.github.mariazevedo88.financialjavaapi.util;
+
+import java.math.BigDecimal;
+
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.zero_x_baadf00d.partialize.converter.Converter;
+
+/**
+ * Class that converts a given data in BigDecimal format to a JSON compatible format
+ * 
+ * @author Mariana Azevedo
+ * @since 17/09/2020
+ */
+public class BigDecimalConverter implements Converter<BigDecimal> {
+
+	/**
+	 * @see com.zero_x_baadf00d.partialize.converter.Converter#convert(String, Object, ObjectNode)
+	 */
+	@Override
+	public void convert(String fieldName, BigDecimal data, ObjectNode node) {
+		node.put(fieldName, data.doubleValue());
+	}
+
+	/**
+	 * @see com.zero_x_baadf00d.partialize.converter.Converter#convert(String, Object, ArrayNode)
+	 */
+	@Override
+	public void convert(String fieldName, BigDecimal data, ArrayNode node) {
+		node.add(data.doubleValue());
+	}
+
+	/**
+	 * @see com.zero_x_baadf00d.partialize.converter.Converter#getManagedObjectClass()
+	 */
+	@Override
+	public Class<BigDecimal> getManagedObjectClass() {
+		return BigDecimal.class;
+	}
+
+}