11 tk 018 create rest endpoint to receive otp at obs

obs/obs-rest-api/pom.xml

@@ -30,21 +30,23 @@
         </dependency>
 
         <!-- Swagger Annotations -->
-
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations-jakarta</artifactId>
+        </dependency>
 
         <!-- Spring Boot Starter for Web -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
-            <scope>compile</scope>
         </dependency>
 
         <!-- Spring Boot Starter for Testing -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
         </dependency>
+
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>

obs/obs-rest-api/src/main/java/com/adorsys/webank/obs/resource/OtpRestApi.java

@@ -0,0 +1,23 @@
+package com.adorsys.webank.obs.resource;
+
+import com.adorsys.webank.obs.dto.OtpRequest;
+import io.swagger.v3.oas.annotations.Operation;
+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 org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+@Tag(name = "OTP", description = "Operations related to OTP processing")
+@RequestMapping("/api/otp")
+public interface OtpRestApi {
+
+    @Operation(summary = "Receive OTP", description = "Receives OTP and processes it")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "OTP successfully captured"),
+            @ApiResponse(responseCode = "400", description = "OTP capture failed")
+    })
+    @PostMapping(value = "/receive", consumes = "application/json", produces = "application/json")
+    ResponseEntity<?> receiveOtp(@RequestBody OtpRequest otpRequest);
+}
+

obs/obs-rest-server/pom.xml

@@ -35,7 +35,6 @@
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>com.adorsys.webank</groupId>
@@ -52,7 +51,14 @@
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
         </dependency>
 
         <!-- Other existing dependencies -->

obs/obs-rest-server/src/main/java/com/adorsys/webank/obs/resource/OtpRestServer.java

@@ -0,0 +1,35 @@
+package com.adorsys.webank.obs.resource;
+
+import com.adorsys.webank.obs.dto.OtpRequest;
+import com.adorsys.webank.obs.service.OtpServiceApi;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.Map;
+
+@RestController
+@RequestMapping("/api/otp")
+public class OtpRestServer implements OtpRestApi {
+
+    private final OtpServiceApi otpServiceApi;
+
+    @Autowired
+    public OtpRestServer(OtpServiceApi otpServiceApi) {
+        this.otpServiceApi = otpServiceApi;
+    }
+
+    @Override
+    public ResponseEntity<?> receiveOtp(@RequestBody OtpRequest otpRequest) {
+        try {
+            // Delegate OTP validation and processing to the service
+            String responseMessage = otpServiceApi.receiveOtp(otpRequest.getOtp());
+
+            return ResponseEntity.ok(Map.of("message", responseMessage));
+        } catch (IllegalArgumentException e) {
+            return ResponseEntity.badRequest().body(Map.of("message", e.getMessage()));
+        }
+    }
+}

obs/obs-rest-server/src/test/java/com/adorsys/webank/obs/resource/OtpRestServerTest.java

@@ -0,0 +1,66 @@
+package com.adorsys.webank.obs.resource;
+
+import com.adorsys.webank.obs.dto.OtpRequest;
+import com.adorsys.webank.obs.service.OtpServiceApi;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.when;
+
+public class OtpRestServerTest {
+
+    @InjectMocks
+    private OtpRestServer otpRestServer; // Class under test
+
+    @Mock
+    private OtpServiceApi otpServiceApi; // Mocked dependency
+
+    @BeforeEach
+    void setUp() {
+        MockitoAnnotations.openMocks(this);
+    }
+
+    @Test
+    void receiveOtp_ShouldReturnSuccessfulResponse() {
+        // Arrange
+        OtpRequest otpRequest = new OtpRequest();
+        otpRequest.setOtp("123456");
+
+        String expectedResponse = "OTP is valid";
+        when(otpServiceApi.receiveOtp(otpRequest.getOtp())).thenReturn(expectedResponse);
+
+        // Act
+        ResponseEntity<?> responseEntity = otpRestServer.receiveOtp(otpRequest);
+
+        // Assert
+        assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
+
+        assertEquals(Map.of("message", "OTP is valid"), responseEntity.getBody());
+    }
+
+    @Test
+    void receiveOtp_ShouldReturnBadRequestForInvalidOtp() {
+        // Arrange
+        OtpRequest otpRequest = new OtpRequest();
+        otpRequest.setOtp("invalid");
+
+        String expectedErrorMessage = "Invalid OTP";
+        when(otpServiceApi.receiveOtp(otpRequest.getOtp())).thenThrow(new IllegalArgumentException(expectedErrorMessage));
+
+        // Act
+        ResponseEntity<?> responseEntity = otpRestServer.receiveOtp(otpRequest);
+
+        // Assert
+        assertEquals(HttpStatus.BAD_REQUEST, responseEntity.getStatusCode());
+        assertEquals(Map.of("message", expectedErrorMessage), responseEntity.getBody());
+    }
+}
+

obs/obs-service-api/pom.xml

@@ -25,7 +25,6 @@
     </properties>
 
     <dependencies>
-
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>
@@ -35,8 +34,15 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-openfeign</artifactId>
         </dependency>
+        <dependency>
+            <groupId>jakarta.ws.rs</groupId>
+            <artifactId>jakarta.ws.rs-api</artifactId>
+        </dependency>
 
-
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+        </dependency>
     </dependencies>
 
 

obs/obs-service-api/src/main/java/com/adorsys/webank/obs/dto/OtpRequest.java

@@ -0,0 +1,16 @@
+package com.adorsys.webank.obs.dto;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class OtpRequest {
+    @JsonProperty("otp")
+    private String otp;
+
+    public String getOtp() {
+        return otp;
+    }
+
+    public void setOtp(String otp) {
+        this.otp = otp;
+    }
+}

obs/obs-service-api/src/main/java/com/adorsys/webank/obs/service/OtpServiceApi.java

@@ -0,0 +1,14 @@
+package com.adorsys.webank.obs.service;
+
+import jakarta.ws.rs.Consumes;
+
+@Consumes("application/json")
+public interface OtpServiceApi {
+    /**
+     * Method to receive and process the OTP.
+     *
+     * @param otp The OTP string received.
+     */
+    String receiveOtp(String otp);
+}
+

obs/obs-service-impl/pom.xml

@@ -38,7 +38,6 @@
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-test</artifactId>
-            <scope>test</scope>
         </dependency>
 
         <dependency>

obs/obs-service-impl/src/main/java/com/adorsys/webank/obs/serviceimpl/OtpServiceImpl.java

@@ -0,0 +1,25 @@
+package com.adorsys.webank.obs.serviceimpl;
+
+import com.adorsys.webank.obs.service.OtpServiceApi;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+@Service
+public class OtpServiceImpl implements OtpServiceApi {
+    private static final Logger logger = LoggerFactory.getLogger(OtpServiceImpl.class);
+
+    @Override
+    public String receiveOtp(String otp) {
+        if (otp == null || otp.length() != 6) {
+            logger.error("Invalid OTP format received.");
+            throw new IllegalArgumentException("Invalid OTP format");
+        }
+
+        // Add actual OTP processing logic here
+        logger.info("OTP successfully processed: {}", otp);
+        return "OTP successfully received";
+    }
+}
+
+

obs/obs-service-impl/src/test/java/com/adorsys/webank/obs/serviceimpl/OtpServiceImplTest.java

@@ -0,0 +1,45 @@
+package com.adorsys.webank.obs.serviceimpl;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.InjectMocks;
+import org.mockito.MockitoAnnotations;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class OtpServiceImplTest {
+
+    @InjectMocks
+    private OtpServiceImpl otpService;
+
+    @BeforeEach
+    void setUp() {
+        MockitoAnnotations.openMocks(this);
+    }
+
+    @Test
+    void testReceiveOTP_valid() {
+        String otp = "123456";
+
+        // Call the method
+        String result = otpService.receiveOtp(otp);
+
+        // Assertions
+        assertNotNull(result);
+        assertEquals("OTP successfully received", result);
+    }
+
+    @Test
+    void testReceiveOTP_invalid() {
+        String otp = null;
+
+        // Call the method
+        Exception exception = assertThrows(IllegalArgumentException.class, () -> {
+            otpService.receiveOtp(otp);
+        });
+
+        // Verify exception message
+        assertEquals("Invalid OTP format", exception.getMessage());
+    }
+}
+

online-banking-app/pom.xml

@@ -68,11 +68,7 @@
 		<dependency>
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>
-			<scope>runtime</scope>
 		</dependency>
-
-
-
 		<dependency>
 			<groupId>org.projectlombok</groupId>
 			<artifactId>lombok</artifactId>
@@ -81,7 +77,6 @@
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
-			<scope>test</scope>
 		</dependency>
 	</dependencies>
 	<dependencyManagement>

pom.xml

@@ -212,11 +212,17 @@
 
 
             <!-- swagger -->
-
             <dependency>
                 <groupId>org.springdoc</groupId>
                 <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
-                <version>${springdoc-openapi-ui.version}</version>
+                <version>2.1.0</version>
+            </dependency>
+
+            <dependency>
+                <groupId>io.swagger.core.v3</groupId>
+                <artifactId>swagger-annotations-jakarta</artifactId>
+                <version>2.2.22</version>
+                <scope>compile</scope>
             </dependency>
 
             <!-- logging dependencies -->