From f42dcce74b304a9e5e94439def4ffe17b27cedef Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Mon, 10 Jun 2024 23:52:47 +0200 Subject: [PATCH 1/9] fix: Double to BigDecimal --- pom.xml | 1 + readme.md | 2 +- .../wymiana/data/entity/CurrencyEntity.java | 4 +- .../java/eu/ztsh/wymiana/model/Currency.java | 4 +- .../ztsh/wymiana/service/CurrencyService.java | 36 +++++++------ .../eu/ztsh/wymiana/service/NbpService.java | 9 ++-- .../java/eu/ztsh/wymiana/util/UserMapper.java | 2 +- .../ValidExchangeRequestValidator.java | 4 +- .../web/model/CurrencyExchangeRequest.java | 6 ++- .../wymiana/web/model/UserCreateRequest.java | 4 +- .../java/eu/ztsh/wymiana/EntityCreator.java | 50 +++++++++++++------ .../wymiana/service/CurrencyServiceTest.java | 14 +++--- .../ztsh/wymiana/service/UserServiceTest.java | 3 +- .../ValidExchangeRequestValidatorTest.java | 6 ++- .../web/ApplicationIntegrationTests.java | 5 +- 15 files changed, 93 insertions(+), 57 deletions(-) diff --git a/pom.xml b/pom.xml index 69862f2..d716a75 100644 --- a/pom.xml +++ b/pom.xml @@ -110,6 +110,7 @@ ${basedir}/src/main/resources/schema eu.ztsh.wymiana.model + true diff --git a/readme.md b/readme.md index 92a57f9..75a4586 100644 --- a/readme.md +++ b/readme.md @@ -37,7 +37,7 @@ Prosty mikroserwis stworzony na potrzeby rekrutacji "name", "surname", "pesel", - "pln" + "initial" ] } ``` diff --git a/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java b/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java index 441b224..f468a67 100644 --- a/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java +++ b/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java @@ -7,6 +7,8 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; +import java.math.BigDecimal; + @Data @NoArgsConstructor @AllArgsConstructor @@ -18,6 +20,6 @@ public class CurrencyEntity { String pesel; @Id String symbol; - Double amount; + BigDecimal amount; } diff --git a/src/main/java/eu/ztsh/wymiana/model/Currency.java b/src/main/java/eu/ztsh/wymiana/model/Currency.java index 0cc6b16..e644aff 100644 --- a/src/main/java/eu/ztsh/wymiana/model/Currency.java +++ b/src/main/java/eu/ztsh/wymiana/model/Currency.java @@ -1,5 +1,7 @@ package eu.ztsh.wymiana.model; -public record Currency(String symbol, double amount) { +import java.math.BigDecimal; + +public record Currency(String symbol, BigDecimal amount) { } diff --git a/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java b/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java index 401626a..9480825 100644 --- a/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java +++ b/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java @@ -45,8 +45,8 @@ public class CurrencyService { } var exchanged = performExchange(from, Optional.ofNullable(user.currencies().get(request.to().toUpperCase())).orElse(create(request.to())), - Optional.ofNullable(request.toSell()).orElse(0D), - Optional.ofNullable(request.toBuy()).orElse(0D)); + Optional.ofNullable(request.toSell()).orElse(BigDecimal.ZERO), + Optional.ofNullable(request.toBuy()).orElse(BigDecimal.ZERO)); user.currencies().putAll(exchanged); return userService.update(user); }) @@ -55,32 +55,36 @@ public class CurrencyService { private Currency create(String symbol) { // TODO: check if supported - now limited to PLN <-> USD - return new Currency(symbol.toUpperCase(), 0D); + return new Currency(symbol.toUpperCase(), BigDecimal.ZERO); } - private Map performExchange(Currency from, Currency to, double toSell, double toBuy) { - double exchangeRate; - double neededFromAmount; - double requestedToAmount; + private Map performExchange(Currency from, Currency to, BigDecimal toSell, BigDecimal toBuy) { + BigDecimal exchangeRate; + BigDecimal neededFromAmount; + BigDecimal requestedToAmount; if (from.symbol().equalsIgnoreCase("PLN")) { exchangeRate = nbpService.getSellRate(to.symbol()); - neededFromAmount = round(toBuy != 0 ? toBuy * exchangeRate : toSell); - requestedToAmount = round(toBuy != 0 ? toBuy : toSell / exchangeRate); + neededFromAmount = round(toBuy.signum() != 0 ? toBuy.multiply(exchangeRate) : toSell); + requestedToAmount = round(toBuy.signum() != 0 ? toBuy : divide(toSell, exchangeRate)); } else { exchangeRate = nbpService.getBuyRate(from.symbol()); - neededFromAmount = round(toBuy != 0 ? toBuy / exchangeRate : toSell); - requestedToAmount = round(toBuy != 0 ? toBuy : toSell * exchangeRate); + neededFromAmount = round(toBuy.signum() != 0 ? divide(toBuy, exchangeRate) : toSell); + requestedToAmount = round(toBuy.signum() != 0 ? toBuy : toSell.multiply(exchangeRate)); } - if (neededFromAmount > from.amount()) { + if (neededFromAmount.compareTo(from.amount()) > 0) { throw new InsufficientFundsException(); } - var newFrom = new Currency(from.symbol(), from.amount() - neededFromAmount); - var newTo = new Currency(to.symbol(), to.amount() + requestedToAmount); + var newFrom = new Currency(from.symbol(), from.amount().subtract(neededFromAmount)); + var newTo = new Currency(to.symbol(), to.amount().add(requestedToAmount)); return Stream.of(newFrom, newTo).collect(Collectors.toMap(Currency::symbol, currency -> currency)); } - private double round(double input) { - return BigDecimal.valueOf(input).setScale(2, RoundingMode.HALF_UP).doubleValue(); + private BigDecimal round(BigDecimal input) { + return input.setScale(2, RoundingMode.HALF_UP); + } + + private BigDecimal divide(BigDecimal input, BigDecimal division) { + return input.setScale(2, RoundingMode.HALF_UP).divide(division, RoundingMode.HALF_UP); } } diff --git a/src/main/java/eu/ztsh/wymiana/service/NbpService.java b/src/main/java/eu/ztsh/wymiana/service/NbpService.java index e612e0a..3fca0d1 100644 --- a/src/main/java/eu/ztsh/wymiana/service/NbpService.java +++ b/src/main/java/eu/ztsh/wymiana/service/NbpService.java @@ -8,6 +8,7 @@ import org.springframework.http.HttpStatusCode; import org.springframework.stereotype.Service; import org.springframework.web.client.RestClient; +import java.math.BigDecimal; import java.time.Clock; import java.time.DayOfWeek; import java.time.LocalDate; @@ -30,11 +31,11 @@ public class NbpService { private final ConcurrentMap cache = new ConcurrentHashMap<>(1); - public double getSellRate(String currency) { + public BigDecimal getSellRate(String currency) { return getCurrency(currency.toUpperCase()).sell(); } - public double getBuyRate(String currency) { + public BigDecimal getBuyRate(String currency) { return getCurrency(currency.toUpperCase()).buy(); } @@ -43,7 +44,7 @@ public class NbpService { var cacheObject = cache.get(currency); if (cacheObject == null || cacheObject.date().isBefore(today)) { var fresh = fetchData(currency, dtf.format(today)); - var rate = fresh.getRates().get(0); + var rate = fresh.getRates().getFirst(); cacheObject = new RatesCache( LocalDate.parse(rate.getEffectiveDate(), dtf), rate.getBid(), @@ -82,7 +83,7 @@ public class NbpService { || today.getDayOfWeek() == DayOfWeek.SUNDAY; } - private record RatesCache(LocalDate date, double buy, double sell) { + private record RatesCache(LocalDate date, BigDecimal buy, BigDecimal sell) { } diff --git a/src/main/java/eu/ztsh/wymiana/util/UserMapper.java b/src/main/java/eu/ztsh/wymiana/util/UserMapper.java index 39985fb..15a9e5a 100644 --- a/src/main/java/eu/ztsh/wymiana/util/UserMapper.java +++ b/src/main/java/eu/ztsh/wymiana/util/UserMapper.java @@ -21,7 +21,7 @@ public class UserMapper { public static UserEntity requestToEntity(UserCreateRequest request) { return new UserEntity(request.pesel(), request.name(), request.surname(), - List.of(new CurrencyEntity(request.pesel(), "PLN", request.pln()))); + List.of(new CurrencyEntity(request.pesel(), "PLN", request.initial()))); } private UserMapper() { diff --git a/src/main/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidator.java b/src/main/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidator.java index 143876b..9a01a0c 100644 --- a/src/main/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidator.java +++ b/src/main/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidator.java @@ -18,8 +18,8 @@ public class ValidExchangeRequestValidator implements return (request.from() != null && !request.from().equals(request.to())) && !((request.toBuy() == null && request.toSell() == null) || (request.toBuy() != null && request.toSell() != null)) - && ((request.toBuy() != null && request.toBuy() >= 0) - || (request.toSell() != null && request.toSell() >= 0)); + && ((request.toBuy() != null && request.toBuy().signum() >= 0) + || (request.toSell() != null && request.toSell().signum() >= 0)); } } diff --git a/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java b/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java index 54f192e..c804720 100644 --- a/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java +++ b/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java @@ -5,14 +5,16 @@ import jakarta.validation.constraints.NotNull; import lombok.Builder; import org.hibernate.validator.constraints.pl.PESEL; +import java.math.BigDecimal; + @Builder @ValidExchangeRequest public record CurrencyExchangeRequest( @PESEL String pesel, @NotNull String from, @NotNull String to, - Double toBuy, - Double toSell + BigDecimal toBuy, + BigDecimal toSell ) { } diff --git a/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java b/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java index bd7b1b4..cb5de05 100644 --- a/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java +++ b/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java @@ -6,11 +6,13 @@ import jakarta.validation.constraints.NotNull; import lombok.Builder; import org.hibernate.validator.constraints.pl.PESEL; +import java.math.BigDecimal; + @Builder public record UserCreateRequest( @NotNull String name, @NotNull String surname, @PESEL @Adult String pesel, - @Min(0) double pln) { + @Min(0) BigDecimal initial) { } diff --git a/src/test/java/eu/ztsh/wymiana/EntityCreator.java b/src/test/java/eu/ztsh/wymiana/EntityCreator.java index 617cbfa..6535f11 100644 --- a/src/test/java/eu/ztsh/wymiana/EntityCreator.java +++ b/src/test/java/eu/ztsh/wymiana/EntityCreator.java @@ -9,6 +9,8 @@ import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; import eu.ztsh.wymiana.web.model.UserCreateRequest; +import java.math.BigDecimal; +import java.math.RoundingMode; import java.util.ArrayList; import java.util.HashMap; import java.util.List; @@ -24,13 +26,13 @@ public class EntityCreator { public static String ANOTHER_PESEL = "08280959342"; public static String NAME = "Janina"; public static String SURNAME = "Kowalska"; - public static double PLN = 20.10; - public static double USD_SELL = 5.18; - public static double USD_BUY = 5.08; + public static BigDecimal PLN = createScaled(20.10, 2); + public static BigDecimal USD_SELL = createScaled(5.18, 2); + public static BigDecimal USD_BUY = createScaled(5.08, 2); public static String PLN_SYMBOL = "PLN"; public static String USD_SYMBOL = "USD"; - public static double BUY_RATE = 3.8804; - public static double SELL_RATE = 3.9572; + public static BigDecimal BUY_RATE = createScaled(3.8804, 4); + public static BigDecimal SELL_RATE = createScaled(3.9572, 4); } @@ -39,25 +41,29 @@ public class EntityCreator { } public static User user() { - return user(Constants.PLN, 0); + return user(Constants.PLN, BigDecimal.ZERO); } - public static User user(double pln, double usd) { + public static User user(BigDecimal pln, BigDecimal usd) { Map currencies = new HashMap<>(); - if (pln > 0) { + if (pln.signum() > 0) { currencies.put("PLN", new Currency("PLN", pln)); } - if (usd > 0) { + if (usd.signum() > 0) { currencies.put("USD", new Currency("USD", usd)); } return new User(Constants.NAME, Constants.SURNAME, Constants.PESEL, currencies); } public static UserCreateRequest.UserCreateRequestBuilder userRequest() { + return userRequest(null); + } + + public static UserCreateRequest.UserCreateRequestBuilder userRequest(Double initial) { return UserCreateRequest.builder().name(Constants.NAME) .surname(Constants.SURNAME) .pesel(Constants.PESEL) - .pln(Constants.PLN); + .initial(initial != null ? createScaled(initial, 2) : Constants.PLN); } public static CurrencyExchangeRequest.CurrencyExchangeRequestBuilder exchangeRequest() { @@ -83,8 +89,8 @@ public class EntityCreator { String name; String surname; String pesel; - double pln = -1; - double usd = -1; + BigDecimal pln = BigDecimal.valueOf(-1); + BigDecimal usd = BigDecimal.valueOf(-1); public UserEntityBuilder name(String name) { this.name = name; @@ -102,22 +108,30 @@ public class EntityCreator { } public UserEntityBuilder pln(double pln) { - this.pln = pln; + return this.pln(BigDecimal.valueOf(pln)); + } + + public UserEntityBuilder pln(BigDecimal pln) { + this.pln = pln.setScale(2, RoundingMode.HALF_UP); return this; } public UserEntityBuilder usd(double usd) { - this.usd = usd; + return this.usd(BigDecimal.valueOf(usd)); + } + + public UserEntityBuilder usd(BigDecimal usd) { + this.usd = usd.setScale(2, RoundingMode.HALF_UP); return this; } public UserEntity build() { var nonnulPesel = Optional.ofNullable(pesel).orElse(Constants.PESEL); List currencies = new ArrayList<>(); - if (pln > -1) { + if (pln.signum() > -1) { currencies.add(new CurrencyEntity(nonnulPesel, "PLN", pln)); } - if (usd > -1) { + if (usd.signum() > -1) { currencies.add(new CurrencyEntity(nonnulPesel, "USD", usd)); } if (currencies.isEmpty()) { @@ -133,4 +147,8 @@ public class EntityCreator { } + private static BigDecimal createScaled(double input, int scale) { + return BigDecimal.valueOf(input).setScale(scale, RoundingMode.HALF_UP); + } + } diff --git a/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java b/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java index c44625e..474f11f 100644 --- a/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java +++ b/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java @@ -16,6 +16,8 @@ import org.junit.jupiter.params.provider.MethodSource; import org.mockito.Mockito; import org.springframework.beans.factory.annotation.Autowired; +import java.math.BigDecimal; +import java.util.Objects; import java.util.stream.Stream; import static eu.ztsh.wymiana.EntityCreator.Constants.*; @@ -46,7 +48,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { .toSell(PLN) .build()); assertThat(result.currencies()) - .matches(map -> map.get(PLN_SYMBOL).amount() == 0 && map.get(USD_SYMBOL).amount() == USD_BUY); + .matches(map -> map.get(PLN_SYMBOL).amount().signum() == 0 && Objects.equals(map.get(USD_SYMBOL).amount(), USD_BUY), "USD 5.08"); var expected = EntityCreator.userEntity().pln(0).usd(USD_BUY).build(); expect(expected); } @@ -62,7 +64,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { .toBuy(USD_BUY) .build()); assertThat(result.currencies()) - .matches(map -> map.get(PLN_SYMBOL).amount() == 0 && map.get(USD_SYMBOL).amount() == USD_BUY); + .matches(map -> map.get(PLN_SYMBOL).amount().signum() == 0 && Objects.equals(map.get(USD_SYMBOL).amount(), USD_BUY)); var expected = EntityCreator.userEntity().pln(0).usd(USD_BUY).build(); expect(expected); } @@ -78,7 +80,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { .toSell(USD_SELL) .build()); assertThat(result.currencies()) - .matches(map -> map.get(PLN_SYMBOL).amount() == PLN && map.get(USD_SYMBOL).amount() == 0); + .matches(map -> Objects.equals(map.get(PLN_SYMBOL).amount(), PLN) && map.get(USD_SYMBOL).amount().signum() == 0, "PLN 20.10"); var expected = EntityCreator.userEntity().pln(PLN).usd(0).build(); expect(expected); } @@ -94,7 +96,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { .toBuy(PLN) .build()); assertThat(result.currencies()) - .matches(map -> map.get(PLN_SYMBOL).amount() == PLN && map.get(USD_SYMBOL).amount() == 0); + .matches(map -> Objects.equals(map.get(PLN_SYMBOL).amount(), PLN) && map.get(USD_SYMBOL).amount().signum() == 0, "PLN 20.10"); var expected = EntityCreator.userEntity().pln(PLN).usd(0).build(); expect(expected); } @@ -116,7 +118,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { @Transactional @Test void doubleExchangeTest() { - var initialValue = 100; + var initialValue = BigDecimal.valueOf(100); var entity = EntityCreator.userEntity().pln(initialValue).build(); userRepository.save(entity); var result1 = currencyService.exchange(EntityCreator.exchangeRequest() @@ -136,7 +138,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { assertThat(resultEntity.getCurrencies() .stream() .filter(c -> c.getSymbol().equalsIgnoreCase("PLN")) - .findFirst()).isNotEmpty().get().matches(currencyEntity -> currencyEntity.getAmount() < initialValue); + .findFirst()).isNotEmpty().get().matches(currencyEntity -> currencyEntity.getAmount().compareTo(initialValue) < 0); } @Transactional diff --git a/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java b/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java index 1ab7690..fef02b9 100644 --- a/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java +++ b/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java @@ -50,10 +50,9 @@ class UserServiceTest extends RepositoryBasedTest { @DisplayName("Try to create another user with same PESEL") void createDuplicatedPeselTest() { var first = EntityCreator.userRequest().build(); - var second = EntityCreator.userRequest() + var second = EntityCreator.userRequest(30.30) .name("Jan") .surname("Kowalski") - .pln(30.30) .build(); userService.create(first); assertThatThrownBy(() -> userService.create(second)) diff --git a/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java b/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java index 5226e14..e8ef550 100644 --- a/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java +++ b/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java @@ -5,6 +5,8 @@ import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; +import java.math.BigDecimal; + import static eu.ztsh.wymiana.EntityCreator.Constants.PLN_SYMBOL; import static eu.ztsh.wymiana.EntityCreator.Constants.USD_BUY; import static eu.ztsh.wymiana.EntityCreator.Constants.USD_SELL; @@ -72,7 +74,7 @@ class ValidExchangeRequestValidatorTest extends ValidatorTest Date: Sat, 15 Jun 2024 00:04:06 +0200 Subject: [PATCH 2/9] feat: swagger & requests annotations --- pom.xml | 6 ++++++ .../eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java | 7 ++++--- .../java/eu/ztsh/wymiana/web/model/UserCreateRequest.java | 4 ++-- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/pom.xml b/pom.xml index d716a75..7431833 100644 --- a/pom.xml +++ b/pom.xml @@ -28,6 +28,7 @@ 3.5.4 + 2.5.0 1.2.1 @@ -62,6 +63,11 @@ lombok provided + + org.springdoc + springdoc-openapi-starter-webmvc-ui + ${openapi.version} + diff --git a/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java b/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java index c804720..5264636 100644 --- a/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java +++ b/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java @@ -1,6 +1,7 @@ package eu.ztsh.wymiana.web.model; import eu.ztsh.wymiana.validation.ValidExchangeRequest; +import jakarta.validation.constraints.Min; import jakarta.validation.constraints.NotNull; import lombok.Builder; import org.hibernate.validator.constraints.pl.PESEL; @@ -10,11 +11,11 @@ import java.math.BigDecimal; @Builder @ValidExchangeRequest public record CurrencyExchangeRequest( - @PESEL String pesel, + @NotNull @PESEL String pesel, @NotNull String from, @NotNull String to, - BigDecimal toBuy, - BigDecimal toSell + @Min(0) BigDecimal toBuy, + @Min(0) BigDecimal toSell ) { } diff --git a/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java b/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java index cb5de05..0614f6b 100644 --- a/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java +++ b/src/main/java/eu/ztsh/wymiana/web/model/UserCreateRequest.java @@ -12,7 +12,7 @@ import java.math.BigDecimal; public record UserCreateRequest( @NotNull String name, @NotNull String surname, - @PESEL @Adult String pesel, - @Min(0) BigDecimal initial) { + @PESEL @Adult @NotNull String pesel, + @NotNull @Min(0) BigDecimal initial) { } From 11d6e41c983f2991a0001d366059150b4f19667b Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Tue, 25 Jun 2024 00:24:18 +0200 Subject: [PATCH 3/9] feat: Currency symbols enum --- .../wymiana/config/CurrencyProperties.java | 9 +++ .../wymiana/data/entity/CurrencyEntity.java | 6 +- .../wymiana/exception/NoDataException.java | 4 +- .../java/eu/ztsh/wymiana/model/Currency.java | 2 +- .../java/eu/ztsh/wymiana/model/Symbol.java | 6 ++ src/main/java/eu/ztsh/wymiana/model/User.java | 2 +- .../UserCreateRequestConfiguredWrapper.java | 65 +++++++++++++++++ .../ztsh/wymiana/service/CurrencyService.java | 22 +++--- .../eu/ztsh/wymiana/service/NbpService.java | 19 ++--- .../eu/ztsh/wymiana/service/UserService.java | 7 +- .../eu/ztsh/wymiana/util/CurrencyMapper.java | 5 +- .../java/eu/ztsh/wymiana/util/UserMapper.java | 6 +- .../web/model/CurrencyExchangeRequest.java | 5 +- src/main/resources/application.yaml | 5 ++ .../java/eu/ztsh/wymiana/EntityCreator.java | 17 +++-- .../eu/ztsh/wymiana/RepositoryBasedTest.java | 1 + .../wymiana/service/CurrencyServiceTest.java | 71 ++++++++++--------- .../ztsh/wymiana/service/NbpServiceTest.java | 11 +-- .../ztsh/wymiana/service/UserServiceTest.java | 32 +++++---- .../eu/ztsh/wymiana/util/UserMapperTest.java | 10 +-- .../ValidExchangeRequestValidatorTest.java | 31 ++++---- .../web/ApplicationIntegrationTests.java | 41 ++++++++--- 22 files changed, 248 insertions(+), 129 deletions(-) create mode 100644 src/main/java/eu/ztsh/wymiana/config/CurrencyProperties.java create mode 100644 src/main/java/eu/ztsh/wymiana/model/Symbol.java create mode 100644 src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java diff --git a/src/main/java/eu/ztsh/wymiana/config/CurrencyProperties.java b/src/main/java/eu/ztsh/wymiana/config/CurrencyProperties.java new file mode 100644 index 0000000..9cfbce1 --- /dev/null +++ b/src/main/java/eu/ztsh/wymiana/config/CurrencyProperties.java @@ -0,0 +1,9 @@ +package eu.ztsh.wymiana.config; + +import eu.ztsh.wymiana.model.Symbol; +import org.springframework.boot.context.properties.ConfigurationProperties; + +@ConfigurationProperties("currency") +public record CurrencyProperties(Symbol initial) { + +} diff --git a/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java b/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java index f468a67..95615f0 100644 --- a/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java +++ b/src/main/java/eu/ztsh/wymiana/data/entity/CurrencyEntity.java @@ -1,6 +1,9 @@ package eu.ztsh.wymiana.data.entity; +import eu.ztsh.wymiana.model.Symbol; import jakarta.persistence.Entity; +import jakarta.persistence.EnumType; +import jakarta.persistence.Enumerated; import jakarta.persistence.Id; import jakarta.persistence.Table; import lombok.AllArgsConstructor; @@ -19,7 +22,8 @@ public class CurrencyEntity { @Id String pesel; @Id - String symbol; + @Enumerated(EnumType.STRING) + Symbol symbol; BigDecimal amount; } diff --git a/src/main/java/eu/ztsh/wymiana/exception/NoDataException.java b/src/main/java/eu/ztsh/wymiana/exception/NoDataException.java index 8da9ad6..1472b0b 100644 --- a/src/main/java/eu/ztsh/wymiana/exception/NoDataException.java +++ b/src/main/java/eu/ztsh/wymiana/exception/NoDataException.java @@ -1,8 +1,10 @@ package eu.ztsh.wymiana.exception; +import eu.ztsh.wymiana.model.Symbol; + public class NoDataException extends RuntimeException { - public NoDataException(String code, String date) { + public NoDataException(Symbol code, String date) { super("No data for code %s and date %s".formatted(code, date)); } diff --git a/src/main/java/eu/ztsh/wymiana/model/Currency.java b/src/main/java/eu/ztsh/wymiana/model/Currency.java index e644aff..05e7ab1 100644 --- a/src/main/java/eu/ztsh/wymiana/model/Currency.java +++ b/src/main/java/eu/ztsh/wymiana/model/Currency.java @@ -2,6 +2,6 @@ package eu.ztsh.wymiana.model; import java.math.BigDecimal; -public record Currency(String symbol, BigDecimal amount) { +public record Currency(Symbol symbol, BigDecimal amount) { } diff --git a/src/main/java/eu/ztsh/wymiana/model/Symbol.java b/src/main/java/eu/ztsh/wymiana/model/Symbol.java new file mode 100644 index 0000000..4d38bbd --- /dev/null +++ b/src/main/java/eu/ztsh/wymiana/model/Symbol.java @@ -0,0 +1,6 @@ +package eu.ztsh.wymiana.model; + +public enum Symbol { + PLN, + USD +} diff --git a/src/main/java/eu/ztsh/wymiana/model/User.java b/src/main/java/eu/ztsh/wymiana/model/User.java index a1f28f1..7ae46a1 100644 --- a/src/main/java/eu/ztsh/wymiana/model/User.java +++ b/src/main/java/eu/ztsh/wymiana/model/User.java @@ -2,6 +2,6 @@ package eu.ztsh.wymiana.model; import java.util.Map; -public record User(String name, String surname, String pesel, Map currencies) { +public record User(String name, String surname, String pesel, Map currencies) { } diff --git a/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java b/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java new file mode 100644 index 0000000..f61e4c3 --- /dev/null +++ b/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java @@ -0,0 +1,65 @@ +package eu.ztsh.wymiana.model; + +import eu.ztsh.wymiana.web.model.UserCreateRequest; + +import java.math.BigDecimal; + +public class UserCreateRequestConfiguredWrapper { + + private final UserCreateRequest request; + private final Symbol initialSymbol; + + public String name() { + return request.name(); + } + + public String surname() { + return request.surname(); + } + + public String pesel() { + return request.pesel(); + } + + public BigDecimal initial() { + return request.initial(); + } + + public Symbol initialSymbol() { + return initialSymbol; + } + + private UserCreateRequestConfiguredWrapper(Builder builder) { + this.request = builder.request; + this.initialSymbol = builder.initial; + } + + public static Builder of(UserCreateRequest request) { + return new Builder().withRequest(request); + } + + public static final class Builder { + + private UserCreateRequest request; + private Symbol initial; + + private Builder() { + } + + private Builder withRequest(UserCreateRequest request) { + this.request = request; + return this; + } + + public Builder withInitial(Symbol initial) { + this.initial = initial; + return this; + } + + public UserCreateRequestConfiguredWrapper build() { + return new UserCreateRequestConfiguredWrapper(this); + } + + } + +} diff --git a/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java b/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java index 9480825..e9736d7 100644 --- a/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java +++ b/src/main/java/eu/ztsh/wymiana/service/CurrencyService.java @@ -4,6 +4,7 @@ import eu.ztsh.wymiana.exception.ExchangeFailedException; import eu.ztsh.wymiana.exception.InsufficientFundsException; import eu.ztsh.wymiana.exception.UserNotFoundException; import eu.ztsh.wymiana.model.Currency; +import eu.ztsh.wymiana.model.Symbol; import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.validation.InstanceValidator; import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; @@ -28,23 +29,17 @@ public class CurrencyService { public User exchange(CurrencyExchangeRequest request) { validator.validate(request); return userService.get(request.pesel()).map(user -> { - if (!request.from().equalsIgnoreCase("PLN") && !request.to().equalsIgnoreCase("PLN")) { + if (!request.from().equals(Symbol.PLN) && !request.to().equals(Symbol.PLN)) { throw new ExchangeFailedException("Either 'from' or 'to' has to be PLN"); } - // As we support only USD now, we need to limit second parameter too - // Begin: unlock other currencies - if (!request.from().equalsIgnoreCase("USD") && !request.to().equalsIgnoreCase("USD")) { - throw new ExchangeFailedException("Either 'from' or 'to' has to be USD"); - } - // End: unlock other currencies - var from = user.currencies().get(request.from().toUpperCase()); + var from = user.currencies().get(request.from()); if (from == null) { // There is no currency 'from' opened so no need to check if user has funds to exchange throw new InsufficientFundsException(); } var exchanged = performExchange(from, - Optional.ofNullable(user.currencies().get(request.to().toUpperCase())).orElse(create(request.to())), + Optional.ofNullable(user.currencies().get(request.to())).orElse(create(request.to())), Optional.ofNullable(request.toSell()).orElse(BigDecimal.ZERO), Optional.ofNullable(request.toBuy()).orElse(BigDecimal.ZERO)); user.currencies().putAll(exchanged); @@ -53,16 +48,15 @@ public class CurrencyService { .orElseThrow(() -> new UserNotFoundException(request)); } - private Currency create(String symbol) { - // TODO: check if supported - now limited to PLN <-> USD - return new Currency(symbol.toUpperCase(), BigDecimal.ZERO); + private Currency create(Symbol symbol) { + return new Currency(symbol, BigDecimal.ZERO); } - private Map performExchange(Currency from, Currency to, BigDecimal toSell, BigDecimal toBuy) { + private Map performExchange(Currency from, Currency to, BigDecimal toSell, BigDecimal toBuy) { BigDecimal exchangeRate; BigDecimal neededFromAmount; BigDecimal requestedToAmount; - if (from.symbol().equalsIgnoreCase("PLN")) { + if (from.symbol().equals(Symbol.PLN)) { exchangeRate = nbpService.getSellRate(to.symbol()); neededFromAmount = round(toBuy.signum() != 0 ? toBuy.multiply(exchangeRate) : toSell); requestedToAmount = round(toBuy.signum() != 0 ? toBuy : divide(toSell, exchangeRate)); diff --git a/src/main/java/eu/ztsh/wymiana/service/NbpService.java b/src/main/java/eu/ztsh/wymiana/service/NbpService.java index 3fca0d1..3d5edd3 100644 --- a/src/main/java/eu/ztsh/wymiana/service/NbpService.java +++ b/src/main/java/eu/ztsh/wymiana/service/NbpService.java @@ -2,6 +2,7 @@ package eu.ztsh.wymiana.service; import eu.ztsh.wymiana.exception.NoDataException; import eu.ztsh.wymiana.model.Rates; +import eu.ztsh.wymiana.model.Symbol; import lombok.RequiredArgsConstructor; import org.assertj.core.util.VisibleForTesting; import org.springframework.http.HttpStatusCode; @@ -29,17 +30,17 @@ public class NbpService { private static final String URI_PATTERN = "/api/exchangerates/rates/c/{code}/{date}/"; private final DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd"); - private final ConcurrentMap cache = new ConcurrentHashMap<>(1); + private final ConcurrentMap cache = new ConcurrentHashMap<>(1); - public BigDecimal getSellRate(String currency) { - return getCurrency(currency.toUpperCase()).sell(); + public BigDecimal getSellRate(Symbol currency) { + return getCurrency(currency).sell(); } - public BigDecimal getBuyRate(String currency) { - return getCurrency(currency.toUpperCase()).buy(); + public BigDecimal getBuyRate(Symbol currency) { + return getCurrency(currency).buy(); } - private synchronized RatesCache getCurrency(String currency) { + private synchronized RatesCache getCurrency(Symbol currency) { var today = getFetchDate(); var cacheObject = cache.get(currency); if (cacheObject == null || cacheObject.date().isBefore(today)) { @@ -50,7 +51,7 @@ public class NbpService { rate.getBid(), rate.getAsk() ); - cache.put(fresh.getCode(), cacheObject); + cache.put(Symbol.valueOf(fresh.getCode().toUpperCase()), cacheObject); } return cacheObject; } @@ -69,8 +70,8 @@ public class NbpService { } @VisibleForTesting - Rates fetchData(String code, String date) { - return restClient.get().uri(URI_PATTERN, code.toLowerCase(), date) + Rates fetchData(Symbol code, String date) { + return restClient.get().uri(URI_PATTERN, code.name().toLowerCase(), date) .retrieve() .onStatus(HttpStatusCode::is4xxClientError, ((request, response) -> { throw new NoDataException(code, date); diff --git a/src/main/java/eu/ztsh/wymiana/service/UserService.java b/src/main/java/eu/ztsh/wymiana/service/UserService.java index 857bc0f..75a1781 100644 --- a/src/main/java/eu/ztsh/wymiana/service/UserService.java +++ b/src/main/java/eu/ztsh/wymiana/service/UserService.java @@ -1,8 +1,10 @@ package eu.ztsh.wymiana.service; +import eu.ztsh.wymiana.config.CurrencyProperties; import eu.ztsh.wymiana.data.repository.UserRepository; import eu.ztsh.wymiana.exception.UserAlreadyExistsException; import eu.ztsh.wymiana.model.User; +import eu.ztsh.wymiana.model.UserCreateRequestConfiguredWrapper; import eu.ztsh.wymiana.util.UserMapper; import eu.ztsh.wymiana.validation.InstanceValidator; import eu.ztsh.wymiana.web.model.UserCreateRequest; @@ -20,13 +22,16 @@ public class UserService { private final UserRepository userRepository; private final InstanceValidator validator; + private final CurrencyProperties currencyProperties; public User create(UserCreateRequest request) { validator.validate(request); if (userRepository.findById(request.pesel()).isPresent()) { throw new UserAlreadyExistsException(request); } - return UserMapper.entityToPojo(userRepository.save(UserMapper.requestToEntity(request))); + return UserMapper.entityToPojo(userRepository.save(UserMapper.requestToEntity( + UserCreateRequestConfiguredWrapper.of(request).withInitial(currencyProperties.initial()).build() + ))); } public Optional get(@PESEL String pesel) { diff --git a/src/main/java/eu/ztsh/wymiana/util/CurrencyMapper.java b/src/main/java/eu/ztsh/wymiana/util/CurrencyMapper.java index b962ddc..697e956 100644 --- a/src/main/java/eu/ztsh/wymiana/util/CurrencyMapper.java +++ b/src/main/java/eu/ztsh/wymiana/util/CurrencyMapper.java @@ -2,6 +2,7 @@ package eu.ztsh.wymiana.util; import eu.ztsh.wymiana.data.entity.CurrencyEntity; import eu.ztsh.wymiana.model.Currency; +import eu.ztsh.wymiana.model.Symbol; import java.util.List; import java.util.Map; @@ -17,12 +18,12 @@ public class CurrencyMapper { return new CurrencyEntity(pesel, pojo.symbol(), pojo.amount()); } - public static Map entitiesToPojoMap(List values) { + public static Map entitiesToPojoMap(List values) { return values.stream().map(CurrencyMapper::entityToPojo) .collect(Collectors.toMap(Currency::symbol, pojo -> pojo)); } - public static List pojoMapToEntities(Map currencies, String pesel) { + public static List pojoMapToEntities(Map currencies, String pesel) { return currencies.values().stream().map(entry -> pojoToEntity(entry, pesel)).toList(); } diff --git a/src/main/java/eu/ztsh/wymiana/util/UserMapper.java b/src/main/java/eu/ztsh/wymiana/util/UserMapper.java index 15a9e5a..09ad887 100644 --- a/src/main/java/eu/ztsh/wymiana/util/UserMapper.java +++ b/src/main/java/eu/ztsh/wymiana/util/UserMapper.java @@ -3,7 +3,7 @@ package eu.ztsh.wymiana.util; import eu.ztsh.wymiana.data.entity.CurrencyEntity; import eu.ztsh.wymiana.data.entity.UserEntity; import eu.ztsh.wymiana.model.User; -import eu.ztsh.wymiana.web.model.UserCreateRequest; +import eu.ztsh.wymiana.model.UserCreateRequestConfiguredWrapper; import java.util.List; @@ -19,9 +19,9 @@ public class UserMapper { CurrencyMapper.pojoMapToEntities(pojo.currencies(), pojo.pesel())); } - public static UserEntity requestToEntity(UserCreateRequest request) { + public static UserEntity requestToEntity(UserCreateRequestConfiguredWrapper request) { return new UserEntity(request.pesel(), request.name(), request.surname(), - List.of(new CurrencyEntity(request.pesel(), "PLN", request.initial()))); + List.of(new CurrencyEntity(request.pesel(), request.initialSymbol(), request.initial()))); } private UserMapper() { diff --git a/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java b/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java index c804720..f420134 100644 --- a/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java +++ b/src/main/java/eu/ztsh/wymiana/web/model/CurrencyExchangeRequest.java @@ -1,5 +1,6 @@ package eu.ztsh.wymiana.web.model; +import eu.ztsh.wymiana.model.Symbol; import eu.ztsh.wymiana.validation.ValidExchangeRequest; import jakarta.validation.constraints.NotNull; import lombok.Builder; @@ -11,8 +12,8 @@ import java.math.BigDecimal; @ValidExchangeRequest public record CurrencyExchangeRequest( @PESEL String pesel, - @NotNull String from, - @NotNull String to, + @NotNull Symbol from, + @NotNull Symbol to, BigDecimal toBuy, BigDecimal toSell ) { diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml index 47b720c..84ae7b8 100644 --- a/src/main/resources/application.yaml +++ b/src/main/resources/application.yaml @@ -4,6 +4,8 @@ hsqldb: nbp: baseurl: "http://api.nbp.pl" +currency: + initial: PLN spring: datasource: @@ -14,6 +16,9 @@ spring: jpa: hibernate: ddl-auto: create + jackson: + mapper: + ACCEPT_CASE_INSENSITIVE_ENUMS: true management: endpoints: diff --git a/src/test/java/eu/ztsh/wymiana/EntityCreator.java b/src/test/java/eu/ztsh/wymiana/EntityCreator.java index 6535f11..0f3b662 100644 --- a/src/test/java/eu/ztsh/wymiana/EntityCreator.java +++ b/src/test/java/eu/ztsh/wymiana/EntityCreator.java @@ -5,6 +5,7 @@ import eu.ztsh.wymiana.data.entity.UserEntity; import eu.ztsh.wymiana.model.Currency; import eu.ztsh.wymiana.model.Rate; import eu.ztsh.wymiana.model.Rates; +import eu.ztsh.wymiana.model.Symbol; import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; import eu.ztsh.wymiana.web.model.UserCreateRequest; @@ -29,8 +30,6 @@ public class EntityCreator { public static BigDecimal PLN = createScaled(20.10, 2); public static BigDecimal USD_SELL = createScaled(5.18, 2); public static BigDecimal USD_BUY = createScaled(5.08, 2); - public static String PLN_SYMBOL = "PLN"; - public static String USD_SYMBOL = "USD"; public static BigDecimal BUY_RATE = createScaled(3.8804, 4); public static BigDecimal SELL_RATE = createScaled(3.9572, 4); @@ -45,12 +44,12 @@ public class EntityCreator { } public static User user(BigDecimal pln, BigDecimal usd) { - Map currencies = new HashMap<>(); + Map currencies = new HashMap<>(); if (pln.signum() > 0) { - currencies.put("PLN", new Currency("PLN", pln)); + currencies.put(Symbol.PLN, new Currency(Symbol.PLN, pln)); } if (usd.signum() > 0) { - currencies.put("USD", new Currency("USD", usd)); + currencies.put(Symbol.USD, new Currency(Symbol.USD, usd)); } return new User(Constants.NAME, Constants.SURNAME, Constants.PESEL, currencies); } @@ -74,7 +73,7 @@ public class EntityCreator { var rates = new Rates(); rates.setTable("C"); rates.setCurrency("dolar amerykański"); - rates.setCode("USD"); + rates.setCode(Symbol.USD.toString()); var rate = new Rate(); rate.setNo("096/C/NBP/2024"); rate.setEffectiveDate(date); @@ -129,13 +128,13 @@ public class EntityCreator { var nonnulPesel = Optional.ofNullable(pesel).orElse(Constants.PESEL); List currencies = new ArrayList<>(); if (pln.signum() > -1) { - currencies.add(new CurrencyEntity(nonnulPesel, "PLN", pln)); + currencies.add(new CurrencyEntity(nonnulPesel, Symbol.PLN, pln)); } if (usd.signum() > -1) { - currencies.add(new CurrencyEntity(nonnulPesel, "USD", usd)); + currencies.add(new CurrencyEntity(nonnulPesel, Symbol.USD, usd)); } if (currencies.isEmpty()) { - currencies.add(new CurrencyEntity(nonnulPesel, "PLN", Constants.PLN)); + currencies.add(new CurrencyEntity(nonnulPesel, Symbol.PLN, Constants.PLN)); } return new UserEntity( nonnulPesel, diff --git a/src/test/java/eu/ztsh/wymiana/RepositoryBasedTest.java b/src/test/java/eu/ztsh/wymiana/RepositoryBasedTest.java index cd0ffcf..5e0bc54 100644 --- a/src/test/java/eu/ztsh/wymiana/RepositoryBasedTest.java +++ b/src/test/java/eu/ztsh/wymiana/RepositoryBasedTest.java @@ -29,6 +29,7 @@ public abstract class RepositoryBasedTest { .isNotEmpty() .get() .usingRecursiveComparison() + .ignoringCollectionOrder() .isEqualTo(entity); } diff --git a/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java b/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java index 474f11f..14f7ea3 100644 --- a/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java +++ b/src/test/java/eu/ztsh/wymiana/service/CurrencyServiceTest.java @@ -2,10 +2,11 @@ package eu.ztsh.wymiana.service; import eu.ztsh.wymiana.EntityCreator; import eu.ztsh.wymiana.RepositoryBasedTest; +import eu.ztsh.wymiana.config.CurrencyProperties; import eu.ztsh.wymiana.data.repository.UserRepository; -import eu.ztsh.wymiana.exception.ExchangeFailedException; import eu.ztsh.wymiana.exception.InsufficientFundsException; import eu.ztsh.wymiana.exception.UserNotFoundException; +import eu.ztsh.wymiana.model.Symbol; import eu.ztsh.wymiana.validation.InstanceValidator; import eu.ztsh.wymiana.validation.ValidationFailedException; import jakarta.transaction.Transactional; @@ -29,12 +30,14 @@ class CurrencyServiceTest extends RepositoryBasedTest { private final CurrencyService currencyService; @Autowired - public CurrencyServiceTest(UserRepository userRepository, InstanceValidator instanceValidator) { + public CurrencyServiceTest(UserRepository userRepository, InstanceValidator instanceValidator, + CurrencyProperties currencyProperties) { super(userRepository); var nbp = Mockito.mock(NbpService.class); - Mockito.when(nbp.getSellRate("USD")).thenReturn(SELL_RATE); - Mockito.when(nbp.getBuyRate("USD")).thenReturn(BUY_RATE); - currencyService = new CurrencyService(new UserService(userRepository, instanceValidator), nbp, instanceValidator); + Mockito.when(nbp.getSellRate(Symbol.USD)).thenReturn(SELL_RATE); + Mockito.when(nbp.getBuyRate(Symbol.USD)).thenReturn(BUY_RATE); + currencyService = new CurrencyService(new UserService(userRepository, instanceValidator, currencyProperties), + nbp, instanceValidator); } @Transactional @@ -43,12 +46,12 @@ class CurrencyServiceTest extends RepositoryBasedTest { var entity = EntityCreator.userEntity().build(); userRepository.save(entity); var result = currencyService.exchange(EntityCreator.exchangeRequest() - .from(PLN_SYMBOL) - .to(USD_SYMBOL) + .from(Symbol.PLN) + .to(Symbol.USD) .toSell(PLN) .build()); assertThat(result.currencies()) - .matches(map -> map.get(PLN_SYMBOL).amount().signum() == 0 && Objects.equals(map.get(USD_SYMBOL).amount(), USD_BUY), "USD 5.08"); + .matches(map -> map.get(Symbol.PLN).amount().signum() == 0 && Objects.equals(map.get(Symbol.USD).amount(), USD_BUY), "USD 5.08"); var expected = EntityCreator.userEntity().pln(0).usd(USD_BUY).build(); expect(expected); } @@ -59,12 +62,12 @@ class CurrencyServiceTest extends RepositoryBasedTest { var entity = EntityCreator.userEntity().build(); userRepository.save(entity); var result = currencyService.exchange(EntityCreator.exchangeRequest() - .from(PLN_SYMBOL) - .to(USD_SYMBOL) + .from(Symbol.PLN) + .to(Symbol.USD) .toBuy(USD_BUY) .build()); assertThat(result.currencies()) - .matches(map -> map.get(PLN_SYMBOL).amount().signum() == 0 && Objects.equals(map.get(USD_SYMBOL).amount(), USD_BUY)); + .matches(map -> map.get(Symbol.PLN).amount().signum() == 0 && Objects.equals(map.get(Symbol.USD).amount(), USD_BUY)); var expected = EntityCreator.userEntity().pln(0).usd(USD_BUY).build(); expect(expected); } @@ -75,12 +78,12 @@ class CurrencyServiceTest extends RepositoryBasedTest { var entity = EntityCreator.userEntity().pln(-1).usd(USD_SELL).build(); userRepository.save(entity); var result = currencyService.exchange(EntityCreator.exchangeRequest() - .from(USD_SYMBOL) - .to(PLN_SYMBOL) + .from(Symbol.USD) + .to(Symbol.PLN) .toSell(USD_SELL) .build()); assertThat(result.currencies()) - .matches(map -> Objects.equals(map.get(PLN_SYMBOL).amount(), PLN) && map.get(USD_SYMBOL).amount().signum() == 0, "PLN 20.10"); + .matches(map -> Objects.equals(map.get(Symbol.PLN).amount(), PLN) && map.get(Symbol.USD).amount().signum() == 0, "PLN 20.10"); var expected = EntityCreator.userEntity().pln(PLN).usd(0).build(); expect(expected); } @@ -91,12 +94,12 @@ class CurrencyServiceTest extends RepositoryBasedTest { var entity = EntityCreator.userEntity().pln(-1).usd(USD_SELL).build(); userRepository.save(entity); var result = currencyService.exchange(EntityCreator.exchangeRequest() - .from(USD_SYMBOL) - .to(PLN_SYMBOL) + .from(Symbol.USD) + .to(Symbol.PLN) .toBuy(PLN) .build()); assertThat(result.currencies()) - .matches(map -> Objects.equals(map.get(PLN_SYMBOL).amount(), PLN) && map.get(USD_SYMBOL).amount().signum() == 0, "PLN 20.10"); + .matches(map -> Objects.equals(map.get(Symbol.PLN).amount(), PLN) && map.get(Symbol.USD).amount().signum() == 0, "PLN 20.10"); var expected = EntityCreator.userEntity().pln(PLN).usd(0).build(); expect(expected); } @@ -107,8 +110,8 @@ class CurrencyServiceTest extends RepositoryBasedTest { var entity = EntityCreator.userEntity().build(); userRepository.save(entity); var request = EntityCreator.exchangeRequest() - .from(USD_SYMBOL) - .to(PLN_SYMBOL) + .from(Symbol.USD) + .to(Symbol.PLN) .toBuy(PLN) .build(); assertThatThrownBy(() -> currencyService.exchange(request)) @@ -121,14 +124,14 @@ class CurrencyServiceTest extends RepositoryBasedTest { var initialValue = BigDecimal.valueOf(100); var entity = EntityCreator.userEntity().pln(initialValue).build(); userRepository.save(entity); - var result1 = currencyService.exchange(EntityCreator.exchangeRequest() - .from(PLN_SYMBOL) - .to(USD_SYMBOL) + currencyService.exchange(EntityCreator.exchangeRequest() + .from(Symbol.PLN) + .to(Symbol.USD) .toBuy(USD_BUY) .build()); - var result2 = currencyService.exchange(EntityCreator.exchangeRequest() - .from(USD_SYMBOL) - .to(PLN_SYMBOL) + currencyService.exchange(EntityCreator.exchangeRequest() + .from(Symbol.USD) + .to(Symbol.PLN) .toSell(USD_BUY) .build()); var resultOptional = userRepository.findById(entity.getPesel()); @@ -137,7 +140,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { var resultEntity = resultOptional.get(); assertThat(resultEntity.getCurrencies() .stream() - .filter(c -> c.getSymbol().equalsIgnoreCase("PLN")) + .filter(c -> c.getSymbol().equals(Symbol.PLN)) .findFirst()).isNotEmpty().get().matches(currencyEntity -> currencyEntity.getAmount().compareTo(initialValue) < 0); } @@ -147,8 +150,8 @@ class CurrencyServiceTest extends RepositoryBasedTest { var entity = EntityCreator.userEntity().build(); userRepository.save(entity); var request = EntityCreator.exchangeRequest() - .from(PLN_SYMBOL) - .to(USD_SYMBOL) + .from(Symbol.PLN) + .to(Symbol.USD) .toBuy(PLN) .build(); assertThatThrownBy(() -> currencyService.exchange(request)) @@ -161,8 +164,8 @@ class CurrencyServiceTest extends RepositoryBasedTest { void invalidPeselTest(String pesel) { var entity = EntityCreator.exchangeRequest() .pesel(pesel) - .from(PLN_SYMBOL) - .to(USD_SYMBOL) + .from(Symbol.PLN) + .to(Symbol.USD) .toSell(USD_SELL) .build(); assertThatThrownBy(() -> currencyService.exchange(entity)) @@ -173,8 +176,8 @@ class CurrencyServiceTest extends RepositoryBasedTest { @Test void notExistingUserTest() { var entity = EntityCreator.exchangeRequest() - .from(PLN_SYMBOL) - .to(USD_SYMBOL) + .from(Symbol.PLN) + .to(Symbol.USD) .toSell(USD_SELL) .build(); assertThatThrownBy(() -> currencyService.exchange(entity)) @@ -185,7 +188,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { @DisplayName("Empty 'from' value") void emptyFromTest() { var entity = EntityCreator.exchangeRequest() - .to(USD_SYMBOL) + .to(Symbol.USD) .toSell(USD_SELL) .build(); assertThatThrownBy(() -> currencyService.exchange(entity)) @@ -197,7 +200,7 @@ class CurrencyServiceTest extends RepositoryBasedTest { @DisplayName("Empty 'to' value") void emptyToTest() { var entity = EntityCreator.exchangeRequest() - .from(PLN_SYMBOL) + .from(Symbol.PLN) .toSell(USD_SELL) .build(); assertThatThrownBy(() -> currencyService.exchange(entity)) diff --git a/src/test/java/eu/ztsh/wymiana/service/NbpServiceTest.java b/src/test/java/eu/ztsh/wymiana/service/NbpServiceTest.java index 7424fbe..0ec2838 100644 --- a/src/test/java/eu/ztsh/wymiana/service/NbpServiceTest.java +++ b/src/test/java/eu/ztsh/wymiana/service/NbpServiceTest.java @@ -5,6 +5,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import eu.ztsh.wymiana.EntityCreator; import eu.ztsh.wymiana.WireMockExtension; import eu.ztsh.wymiana.exception.NoDataException; +import eu.ztsh.wymiana.model.Symbol; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.DisplayName; @@ -79,7 +80,7 @@ class NbpServiceTest { var url = "/api/exchangerates/rates/c/usd/%s/".formatted(date); WireMockExtension.response(url, 200, new ObjectMapper().writeValueAsString(EntityCreator.rates(date))); try { - assertThat(nbpService.getSellRate(EntityCreator.Constants.USD_SYMBOL)).isEqualTo(EntityCreator.Constants.SELL_RATE); + assertThat(nbpService.getSellRate(Symbol.USD)).isEqualTo(EntityCreator.Constants.SELL_RATE); } finally { WireMockExtension.verifyGet(1, url); } @@ -92,9 +93,9 @@ class NbpServiceTest { var url = "/api/exchangerates/rates/c/usd/%s/".formatted(date); WireMockExtension.response(url, 200, new ObjectMapper().writeValueAsString(EntityCreator.rates(date))); // save to cache - assertThat(nbpService.getSellRate(EntityCreator.Constants.USD_SYMBOL)).isEqualTo(EntityCreator.Constants.SELL_RATE); + assertThat(nbpService.getSellRate(Symbol.USD)).isEqualTo(EntityCreator.Constants.SELL_RATE); // get from cache - assertThat(nbpService.getBuyRate(EntityCreator.Constants.USD_SYMBOL)).isEqualTo(EntityCreator.Constants.BUY_RATE); + assertThat(nbpService.getBuyRate(Symbol.USD)).isEqualTo(EntityCreator.Constants.BUY_RATE); WireMockExtension.verifyGet(1, url); } @@ -102,9 +103,9 @@ class NbpServiceTest { @Test void getInvalidCurrencyTest() { var date = dtf.format(updateClock(DayOfWeek.FRIDAY)); - var url = "/api/exchangerates/rates/c/usb/%s/".formatted(date); + var url = "/api/exchangerates/rates/c/usd/%s/".formatted(date); WireMockExtension.response(url, 404, "404 NotFound - Not Found - Brak danych"); - assertThatThrownBy(() -> nbpService.getSellRate("usb")).isInstanceOf(NoDataException.class); + assertThatThrownBy(() -> nbpService.getSellRate(Symbol.USD)).isInstanceOf(NoDataException.class); WireMockExtension.verifyGet(1, url); } diff --git a/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java b/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java index fef02b9..33ea330 100644 --- a/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java +++ b/src/test/java/eu/ztsh/wymiana/service/UserServiceTest.java @@ -2,6 +2,7 @@ package eu.ztsh.wymiana.service; import eu.ztsh.wymiana.EntityCreator; import eu.ztsh.wymiana.RepositoryBasedTest; +import eu.ztsh.wymiana.config.CurrencyProperties; import eu.ztsh.wymiana.data.repository.UserRepository; import eu.ztsh.wymiana.exception.UserAlreadyExistsException; import eu.ztsh.wymiana.util.UserMapper; @@ -21,9 +22,10 @@ class UserServiceTest extends RepositoryBasedTest { private final UserService userService; @Autowired - public UserServiceTest(UserRepository userRepository, InstanceValidator instanceValidator) { + public UserServiceTest(UserRepository userRepository, InstanceValidator instanceValidator, + CurrencyProperties currencyProperties) { super(userRepository); - userService = new UserService(userRepository, instanceValidator); + userService = new UserService(userRepository, instanceValidator, currencyProperties); } @Test @@ -42,8 +44,8 @@ class UserServiceTest extends RepositoryBasedTest { var second = EntityCreator.userRequest().build(); userService.create(first); assertThatThrownBy(() -> userService.create(second)) - .isInstanceOf(UserAlreadyExistsException.class) - .hasMessage("User with PESEL %s already exists".formatted(EntityCreator.Constants.PESEL)); + .isInstanceOf(UserAlreadyExistsException.class) + .hasMessage("User with PESEL %s already exists".formatted(EntityCreator.Constants.PESEL)); } @Test @@ -51,13 +53,13 @@ class UserServiceTest extends RepositoryBasedTest { void createDuplicatedPeselTest() { var first = EntityCreator.userRequest().build(); var second = EntityCreator.userRequest(30.30) - .name("Jan") - .surname("Kowalski") - .build(); + .name("Jan") + .surname("Kowalski") + .build(); userService.create(first); assertThatThrownBy(() -> userService.create(second)) - .isInstanceOf(UserAlreadyExistsException.class) - .hasMessage("User with PESEL %s already exists".formatted(EntityCreator.Constants.PESEL)); + .isInstanceOf(UserAlreadyExistsException.class) + .hasMessage("User with PESEL %s already exists".formatted(EntityCreator.Constants.PESEL)); } @Test @@ -65,8 +67,8 @@ class UserServiceTest extends RepositoryBasedTest { void youngUserTest() { var request = EntityCreator.userRequest().pesel("").build(); assertThatThrownBy(() -> userService.create(request)) - .isInstanceOf(ValidationFailedException.class) - .hasMessageContaining(Adult.MESSAGE); + .isInstanceOf(ValidationFailedException.class) + .hasMessageContaining(Adult.MESSAGE); } @Test @@ -78,10 +80,10 @@ class UserServiceTest extends RepositoryBasedTest { var userOptional = userService.get(EntityCreator.Constants.PESEL); var expected = UserMapper.entityToPojo(entity); assertThat(userOptional) - .isNotEmpty() - .get() - .usingRecursiveComparison() - .isEqualTo(expected); + .isNotEmpty() + .get() + .usingRecursiveComparison() + .isEqualTo(expected); } @Test diff --git a/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java b/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java index 11503aa..01338eb 100644 --- a/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java +++ b/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java @@ -1,12 +1,10 @@ package eu.ztsh.wymiana.util; import eu.ztsh.wymiana.EntityCreator; -import eu.ztsh.wymiana.model.Currency; -import eu.ztsh.wymiana.model.User; +import eu.ztsh.wymiana.model.Symbol; +import eu.ztsh.wymiana.model.UserCreateRequestConfiguredWrapper; import org.junit.jupiter.api.Test; -import java.util.Map; - import static org.assertj.core.api.Assertions.assertThat; class UserMapperTest { @@ -31,7 +29,9 @@ class UserMapperTest { @Test void requestToEntityTest() { - var request = EntityCreator.userRequest().build(); + var request = UserCreateRequestConfiguredWrapper.of(EntityCreator.userRequest().build()) + .withInitial(Symbol.PLN) + .build() ; var expected = EntityCreator.userEntity().build(); assertThat(UserMapper.requestToEntity(request)) .usingRecursiveComparison() diff --git a/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java b/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java index e8ef550..4edd903 100644 --- a/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java +++ b/src/test/java/eu/ztsh/wymiana/validation/ValidExchangeRequestValidatorTest.java @@ -1,16 +1,15 @@ package eu.ztsh.wymiana.validation; import eu.ztsh.wymiana.EntityCreator; +import eu.ztsh.wymiana.model.Symbol; import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; import java.math.BigDecimal; -import static eu.ztsh.wymiana.EntityCreator.Constants.PLN_SYMBOL; import static eu.ztsh.wymiana.EntityCreator.Constants.USD_BUY; import static eu.ztsh.wymiana.EntityCreator.Constants.USD_SELL; -import static eu.ztsh.wymiana.EntityCreator.Constants.USD_SYMBOL; class ValidExchangeRequestValidatorTest extends ValidatorTest { @@ -22,8 +21,8 @@ class ValidExchangeRequestValidatorTest extends ValidatorTest Date: Tue, 25 Jun 2024 00:52:06 +0200 Subject: [PATCH 4/9] fix: Request wrapper builder function name --- .../ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java | 2 +- src/main/java/eu/ztsh/wymiana/service/UserService.java | 2 +- src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java b/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java index f61e4c3..b4a3619 100644 --- a/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java +++ b/src/main/java/eu/ztsh/wymiana/model/UserCreateRequestConfiguredWrapper.java @@ -34,7 +34,7 @@ public class UserCreateRequestConfiguredWrapper { this.initialSymbol = builder.initial; } - public static Builder of(UserCreateRequest request) { + public static Builder wrap(UserCreateRequest request) { return new Builder().withRequest(request); } diff --git a/src/main/java/eu/ztsh/wymiana/service/UserService.java b/src/main/java/eu/ztsh/wymiana/service/UserService.java index 75a1781..2205d19 100644 --- a/src/main/java/eu/ztsh/wymiana/service/UserService.java +++ b/src/main/java/eu/ztsh/wymiana/service/UserService.java @@ -30,7 +30,7 @@ public class UserService { throw new UserAlreadyExistsException(request); } return UserMapper.entityToPojo(userRepository.save(UserMapper.requestToEntity( - UserCreateRequestConfiguredWrapper.of(request).withInitial(currencyProperties.initial()).build() + UserCreateRequestConfiguredWrapper.wrap(request).withInitial(currencyProperties.initial()).build() ))); } diff --git a/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java b/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java index 01338eb..121c03d 100644 --- a/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java +++ b/src/test/java/eu/ztsh/wymiana/util/UserMapperTest.java @@ -29,7 +29,7 @@ class UserMapperTest { @Test void requestToEntityTest() { - var request = UserCreateRequestConfiguredWrapper.of(EntityCreator.userRequest().build()) + var request = UserCreateRequestConfiguredWrapper.wrap(EntityCreator.userRequest().build()) .withInitial(Symbol.PLN) .build() ; var expected = EntityCreator.userEntity().build(); From 5549c8618547098dd76866b19f0414e81e182e9a Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Tue, 25 Jun 2024 23:21:33 +0200 Subject: [PATCH 5/9] docs: Readme update --- readme.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 75a4586..e4c4278 100644 --- a/readme.md +++ b/readme.md @@ -28,9 +28,9 @@ Prosty mikroserwis stworzony na potrzeby rekrutacji "pesel": { "type": "string" }, - "pln": { + "initial": { "type": "number", - "description": "początkowy stan konta w złotówkach" + "description": "początkowy stan konta w domyślnej walucie" } }, "required": [ @@ -169,6 +169,35 @@ Prosty mikroserwis stworzony na potrzeby rekrutacji actor <--> exchange endpoint <--> core core <--> tabC - core <-- hsql.port --> hsqldb + core <-- hsql . port --> hsqldb ``` + +## Konfiguracja + +Aplikacja posiada dostosowaną konfigurację, która obejmuje własności: + +### `hsqldb` + +Konfiguracja bazy danych + +| Nazwa | Opis | Typ | Wartość domyślna | +|-------|------------------|--------|------------------| +| name | host bazy danych | string | db | +| port | port bazy danych | int | 9090 | + +### `nbp` + +Konfiguracja połączenia z Narodowym Bankiem Polskim + +| Nazwa | Opis | Typ | Wartość domyślna | +|---------|--------------|--------|-------------------| +| baseurl | host API nbp | string | http://api.nbp.pl | + +### `currency` + +Konfiguracja walut + +| Nazwa | Opis | Typ | Wartość domyślna | +|---------|-----------------------------------------|--------|------------------| +| initial | waluta początkowa przy zakładaniu konta | string | PLN | From a37f1c28341823f6029b8a49498fe19ec0b674a4 Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Thu, 27 Jun 2024 01:06:33 +0200 Subject: [PATCH 6/9] feat: OpenAPI --- .../web/controller/ExchangeController.java | 22 +++++++++++++++++++ .../web/controller/UserController.java | 21 ++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java b/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java index fb0ee13..6025a9d 100644 --- a/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java +++ b/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java @@ -2,11 +2,18 @@ package eu.ztsh.wymiana.web.controller; import eu.ztsh.wymiana.exception.InsufficientFundsException; import eu.ztsh.wymiana.exception.UserNotFoundException; +import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.service.CurrencyService; import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.responses.ApiResponses; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.PostMapping; @@ -22,6 +29,21 @@ public class ExchangeController { private final CurrencyService currencyService; + @Operation(summary = "Perform exchange") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", + description = "Exchange performed successfully", + content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = User.class))), + @ApiResponse(responseCode = "400", + description = "Insufficient funds", + content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)), + @ApiResponse(responseCode = "404", + description = "User not found", + content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)), + @ApiResponse(responseCode = "500", + description = "Another error has occurred", + content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)) + }) @PostMapping public ResponseEntity exchange(@Valid @RequestBody CurrencyExchangeRequest request) { try { diff --git a/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java b/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java index bca74ce..1004803 100644 --- a/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java +++ b/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java @@ -6,10 +6,16 @@ import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.service.UserService; import eu.ztsh.wymiana.validation.ValidationFailedException; import eu.ztsh.wymiana.web.model.UserCreateRequest; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.responses.ApiResponses; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import jakarta.validation.ValidationException; import lombok.RequiredArgsConstructor; import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; @@ -23,10 +29,18 @@ import org.springframework.web.bind.annotation.RestController; @Validated @RestController @RequestMapping(path = "/api/user", produces = "application/json") +@Tag(name="User management", description = "Create or get user") public class UserController { private final UserService userService; + @Operation(summary = "Get user by PESEL") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "User found"), + @ApiResponse(responseCode = "400", description = "Request not valid", content = @Content), + @ApiResponse(responseCode = "404", description = "User not found", content = @Content), + @ApiResponse(responseCode = "500", description = "Another error has occurred", content = @Content) + }) @GetMapping("{pesel}") public ResponseEntity get(@PathVariable("pesel") String pesel) { try { @@ -42,6 +56,13 @@ public class UserController { } } + @Operation(summary = "Create user") + @ApiResponses(value = { + @ApiResponse(responseCode = "204", description = "User created", content = @Content), + @ApiResponse(responseCode = "400", description = "Request not valid", content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)), + @ApiResponse(responseCode = "409", description = "User already exists", content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)), + @ApiResponse(responseCode = "500", description = "Another error has occurred", content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)) + }) @PostMapping public ResponseEntity create(@Valid @RequestBody UserCreateRequest request) { try { From 177f67369613d9dcafc5ed18ac612838e28048e4 Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Thu, 27 Jun 2024 01:19:30 +0200 Subject: [PATCH 7/9] fix: List in User response instead of Map --- src/main/java/eu/ztsh/wymiana/util/UserMapper.java | 5 +++++ .../ztsh/wymiana/web/controller/ExchangeController.java | 5 +++-- .../eu/ztsh/wymiana/web/controller/UserController.java | 6 ++++-- .../java/eu/ztsh/wymiana/web/model/UserResponse.java | 9 +++++++++ 4 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 src/main/java/eu/ztsh/wymiana/web/model/UserResponse.java diff --git a/src/main/java/eu/ztsh/wymiana/util/UserMapper.java b/src/main/java/eu/ztsh/wymiana/util/UserMapper.java index 15a9e5a..44f2524 100644 --- a/src/main/java/eu/ztsh/wymiana/util/UserMapper.java +++ b/src/main/java/eu/ztsh/wymiana/util/UserMapper.java @@ -4,6 +4,7 @@ import eu.ztsh.wymiana.data.entity.CurrencyEntity; import eu.ztsh.wymiana.data.entity.UserEntity; import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.web.model.UserCreateRequest; +import eu.ztsh.wymiana.web.model.UserResponse; import java.util.List; @@ -19,6 +20,10 @@ public class UserMapper { CurrencyMapper.pojoMapToEntities(pojo.currencies(), pojo.pesel())); } + public static UserResponse pojoToResponse(User pojo) { + return new UserResponse(pojo.name(), pojo.surname(), pojo.pesel(), pojo.currencies().values().stream().toList()); + } + public static UserEntity requestToEntity(UserCreateRequest request) { return new UserEntity(request.pesel(), request.name(), request.surname(), List.of(new CurrencyEntity(request.pesel(), "PLN", request.initial()))); diff --git a/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java b/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java index 6025a9d..39c635d 100644 --- a/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java +++ b/src/main/java/eu/ztsh/wymiana/web/controller/ExchangeController.java @@ -2,9 +2,9 @@ package eu.ztsh.wymiana.web.controller; import eu.ztsh.wymiana.exception.InsufficientFundsException; import eu.ztsh.wymiana.exception.UserNotFoundException; -import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.service.CurrencyService; import eu.ztsh.wymiana.web.model.CurrencyExchangeRequest; +import eu.ztsh.wymiana.web.model.UserResponse; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Schema; @@ -33,7 +33,8 @@ public class ExchangeController { @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Exchange performed successfully", - content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = User.class))), + content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, + schema = @Schema(implementation = UserResponse.class))), @ApiResponse(responseCode = "400", description = "Insufficient funds", content = @Content(mediaType = MediaType.TEXT_PLAIN_VALUE)), diff --git a/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java b/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java index 1004803..dfa40b6 100644 --- a/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java +++ b/src/main/java/eu/ztsh/wymiana/web/controller/UserController.java @@ -2,10 +2,11 @@ package eu.ztsh.wymiana.web.controller; import eu.ztsh.wymiana.exception.UserAlreadyExistsException; import eu.ztsh.wymiana.exception.UserNotFoundException; -import eu.ztsh.wymiana.model.User; import eu.ztsh.wymiana.service.UserService; +import eu.ztsh.wymiana.util.UserMapper; import eu.ztsh.wymiana.validation.ValidationFailedException; import eu.ztsh.wymiana.web.model.UserCreateRequest; +import eu.ztsh.wymiana.web.model.UserResponse; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.responses.ApiResponse; @@ -42,9 +43,10 @@ public class UserController { @ApiResponse(responseCode = "500", description = "Another error has occurred", content = @Content) }) @GetMapping("{pesel}") - public ResponseEntity get(@PathVariable("pesel") String pesel) { + public ResponseEntity get(@PathVariable("pesel") String pesel) { try { return userService.get(pesel) + .map(UserMapper::pojoToResponse) .map(ResponseEntity::ok) .orElseThrow(() -> new UserNotFoundException(pesel)); } catch (Exception e) { diff --git a/src/main/java/eu/ztsh/wymiana/web/model/UserResponse.java b/src/main/java/eu/ztsh/wymiana/web/model/UserResponse.java new file mode 100644 index 0000000..2e73267 --- /dev/null +++ b/src/main/java/eu/ztsh/wymiana/web/model/UserResponse.java @@ -0,0 +1,9 @@ +package eu.ztsh.wymiana.web.model; + +import eu.ztsh.wymiana.model.Currency; + +import java.util.List; + +public record UserResponse(String name, String surname, String pesel, List currencies) { + +} From 5950dec099137143197a4a2e128117923c783489 Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Thu, 27 Jun 2024 01:19:45 +0200 Subject: [PATCH 8/9] docs: Readme update --- readme.md | 1 - 1 file changed, 1 deletion(-) diff --git a/readme.md b/readme.md index 75a4586..3e0fd54 100644 --- a/readme.md +++ b/readme.md @@ -79,7 +79,6 @@ Prosty mikroserwis stworzony na potrzeby rekrutacji "type": "string" }, "currencies": { - "$comment": "TODO: Map -> List", "type": "array", "items": { "$ref": "#/def/currency" From e501c59f869b12af0438f727ed2f0763abf7b3b5 Mon Sep 17 00:00:00 2001 From: Piotr Dec Date: Thu, 27 Jun 2024 01:29:36 +0200 Subject: [PATCH 9/9] test: Application tests response fix --- .../java/eu/ztsh/wymiana/web/ApplicationIntegrationTests.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/java/eu/ztsh/wymiana/web/ApplicationIntegrationTests.java b/src/test/java/eu/ztsh/wymiana/web/ApplicationIntegrationTests.java index 01bb2df..9a14ef5 100644 --- a/src/test/java/eu/ztsh/wymiana/web/ApplicationIntegrationTests.java +++ b/src/test/java/eu/ztsh/wymiana/web/ApplicationIntegrationTests.java @@ -116,7 +116,7 @@ class ApplicationIntegrationTests { .uri(endpoint.concat("/").concat(PESEL)) .exchange() .expectStatus().isOk() - .expectBody().json(asJson(UserMapper.entityToPojo(EntityCreator.userEntity().pln(100).build()))); + .expectBody().json(asJson(UserMapper.pojoToResponse(UserMapper.entityToPojo(EntityCreator.userEntity().pln(100).build())))); } @Test