implemented fetch qr code scanned details

This commit is contained in:
ltiongku
2024-07-19 20:32:55 +08:00
parent 0af328977b
commit a236eb13f8
36 changed files with 148 additions and 82 deletions

View File

@@ -2,7 +2,7 @@ package com.safeqr.app.qrcode.controller;
import static com.safeqr.app.constants.APIConstants.*;
import static com.safeqr.app.constants.CommonConstants.*;
import com.safeqr.app.qrcode.dto.QRCodePayload;
import com.safeqr.app.qrcode.dto.request.QRCodePayload;
import com.safeqr.app.qrcode.dto.RedirectCountResponse;
import com.safeqr.app.qrcode.dto.URLVerificationResponse;
import com.safeqr.app.qrcode.dto.response.BaseScanResponse;
@@ -20,6 +20,7 @@ import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.UUID;
@RestController
@RequestMapping(API_VERSION)
@@ -42,6 +43,11 @@ public class QRCodeTypeController {
public ResponseEntity<List<QRCodeTypeEntity>> getAllTypes() {
return ResponseEntity.ok(qrCodeTypeService.getAllTypes());
}
@GetMapping(value = API_URL_QRCODE_GET_SCANNED_DETAILS)
public ResponseEntity<BaseScanResponse> getScannedQRCodeDetails(@RequestHeader(name="QR-ID") UUID qrCodeId) {
logger.info("Invoking GET QRCode details endpoint, qrCodeId: {}", qrCodeId);
return ResponseEntity.ok(qrCodeTypeService.getScannedQRCodeDetails(qrCodeId));
}
@PostMapping(value = API_URL_QRCODE_SCAN, produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<BaseScanResponse> scanQRCode(@RequestBody QRCodePayload payload,

View File

@@ -1,4 +1,4 @@
package com.safeqr.app.qrcode.dto;
package com.safeqr.app.qrcode.dto.request;
import lombok.Data;

View File

@@ -7,6 +7,7 @@ import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.Builder;
import org.hibernate.annotations.Type;
import org.hibernate.annotations.UuidGenerator;
import java.util.List;
@@ -45,12 +46,12 @@ public class URLEntity {
private int redirect = 0;
@Column(name = "hsts_header")
@Column(name = "hsts_header", columnDefinition = "text[]")
private List<String> hstsHeader;
@Column(name = "ssl_stripping")
@Column(name = "ssl_stripping", columnDefinition = "boolean[]")
private List<Boolean> sslStripping;
@Column(name = "redirect_chain")
@Column(name = "redirect_chain", columnDefinition = "text[]")
private List<String> redirectChain;
}

View File

@@ -3,7 +3,7 @@ package com.safeqr.app.qrcode.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.EmailEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.service.EmailVerificationService;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -12,14 +12,12 @@ import org.slf4j.LoggerFactory;
@EqualsAndHashCode(callSuper = true)
@Data
public class EmailModel extends QRCodeModel {
public final class EmailModel extends QRCodeModel<EmailEntity> {
private static final Logger logger = LoggerFactory.getLogger(EmailModel.class);
@JsonIgnore
private final EmailVerificationService emailVerificationService;
EmailEntity details;
public EmailModel(QRCodeEntity scannedQRCodeEntity, EmailVerificationService emailVerificationService) {
this.scannedQRCode = scannedQRCodeEntity;
this.emailVerificationService = emailVerificationService;
@@ -32,4 +30,9 @@ public class EmailModel extends QRCodeModel {
// Insert into email table
emailVerificationService.insertDB(details);
}
@Override
public EmailEntity getDetails () {
return new EmailEntity();
}
}

View File

@@ -1,9 +1,9 @@
package com.safeqr.app.qrcode.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.safeqr.app.qrcode.entity.EmailEntity;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.PhoneEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.service.PhoneVerificationService;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -12,14 +12,12 @@ import org.slf4j.LoggerFactory;
@EqualsAndHashCode(callSuper = true)
@Data
public class PhoneModel extends QRCodeModel {
public final class PhoneModel extends QRCodeModel<PhoneEntity> {
private static final Logger logger = LoggerFactory.getLogger(PhoneModel.class);
@JsonIgnore
private final PhoneVerificationService phoneVerificationService;
PhoneEntity details;
public PhoneModel(QRCodeEntity scannedQRCodeEntity, PhoneVerificationService phoneVerificationService) {
this.scannedQRCode = scannedQRCodeEntity;
this.phoneVerificationService = phoneVerificationService;
@@ -32,4 +30,8 @@ public class PhoneModel extends QRCodeModel {
// Insert into phone table
phoneVerificationService.insertDB(details);
}
@Override
public PhoneEntity getDetails () {
return new PhoneEntity();
}
}

View File

@@ -1,11 +1,13 @@
package com.safeqr.app.qrcode.model;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import lombok.Data;
@Data
public abstract class QRCodeModel {
public abstract class QRCodeModel<T>{
QRCodeEntity scannedQRCode;
T details;
public abstract void setDetails();
public abstract T getDetails();
}

View File

@@ -1,9 +1,9 @@
package com.safeqr.app.qrcode.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.safeqr.app.qrcode.entity.EmailEntity;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.SMSEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.service.SMSVerificationService;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -12,14 +12,12 @@ import org.slf4j.LoggerFactory;
@EqualsAndHashCode(callSuper = true)
@Data
public class SMSModel extends QRCodeModel {
public final class SMSModel extends QRCodeModel<SMSEntity> {
private static final Logger logger = LoggerFactory.getLogger(SMSModel.class);
@JsonIgnore
private final SMSVerificationService smsVerificationService;
SMSEntity details;
public SMSModel(QRCodeEntity scannedQRCodeEntity, SMSVerificationService smsVerificationService) {
this.scannedQRCode = scannedQRCodeEntity;
this.smsVerificationService = smsVerificationService;
@@ -32,4 +30,8 @@ public class SMSModel extends QRCodeModel {
// Insert into sms table
smsVerificationService.insertDB(details);
}
@Override
public SMSEntity getDetails () {
return new SMSEntity();
}
}

View File

@@ -1,9 +1,9 @@
package com.safeqr.app.qrcode.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.safeqr.app.qrcode.entity.EmailEntity;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.TextEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.service.TextVerificationService;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -12,14 +12,12 @@ import org.slf4j.LoggerFactory;
@EqualsAndHashCode(callSuper = true)
@Data
public class TextModel extends QRCodeModel {
public final class TextModel extends QRCodeModel<TextEntity> {
private static final Logger logger = LoggerFactory.getLogger(TextModel.class);
@JsonIgnore
private final TextVerificationService textVerificationService;
TextEntity details;
public TextModel(QRCodeEntity scannedQRCodeEntity, TextVerificationService textVerificationService) {
this.scannedQRCode = scannedQRCodeEntity;
this.textVerificationService = textVerificationService;
@@ -32,4 +30,8 @@ public class TextModel extends QRCodeModel {
// Insert into text table
textVerificationService.insertDB(details);
}
@Override
public TextEntity getDetails () {
return new TextEntity();
}
}

View File

@@ -1,8 +1,8 @@
package com.safeqr.app.qrcode.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.safeqr.app.qrcode.entity.EmailEntity;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.entity.URLEntity;
import com.safeqr.app.qrcode.service.URLVerificationService;
import lombok.*;
@@ -15,17 +15,16 @@ import java.net.URISyntaxException;
@EqualsAndHashCode(callSuper = true)
@Data
public class URLModel extends QRCodeModel {
public final class URLModel extends QRCodeModel<URLEntity> {
private static final Logger logger = LoggerFactory.getLogger(URLModel.class);
@JsonIgnore
private final URLVerificationService urlVerificationService;
URLEntity details;
@Autowired
public URLModel(QRCodeEntity scannedQRCodeEntity, URLVerificationService urlVerificationService) {
this.scannedQRCode = scannedQRCodeEntity;
this.urlVerificationService = urlVerificationService;
this.details = null;
details = null;
}
@Override
@@ -44,4 +43,8 @@ public class URLModel extends QRCodeModel {
logger.error("Error: ", e);
}
}
@Override
public URLEntity getDetails () {
return urlVerificationService.getURLEntityByQRCodeId(scannedQRCode.getId());
}
}

View File

@@ -1,9 +1,9 @@
package com.safeqr.app.qrcode.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.safeqr.app.qrcode.entity.EmailEntity;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.WifiEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.service.WifiVerificationService;
import lombok.Data;
import lombok.EqualsAndHashCode;
@@ -12,14 +12,12 @@ import org.slf4j.LoggerFactory;
@EqualsAndHashCode(callSuper = true)
@Data
public class WifiModel extends QRCodeModel {
public final class WifiModel extends QRCodeModel<WifiEntity> {
private static final Logger logger = LoggerFactory.getLogger(WifiModel.class);
@JsonIgnore
private final WifiVerificationService wifiVerificationService;
WifiEntity details;
public WifiModel(QRCodeEntity scannedQRCodeEntity, WifiVerificationService wifiVerificationService) {
this.scannedQRCode = scannedQRCodeEntity;
this.wifiVerificationService = wifiVerificationService;
@@ -32,4 +30,8 @@ public class WifiModel extends QRCodeModel {
// Insert into wifi table
wifiVerificationService.insertDB(details);
}
@Override
public WifiEntity getDetails () {
return new WifiEntity();
}
}

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.EmailModel;
import com.safeqr.app.qrcode.service.EmailVerificationService;
import org.springframework.beans.factory.annotation.Autowired;

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.PhoneModel;
import com.safeqr.app.qrcode.service.PhoneVerificationService;
import org.springframework.beans.factory.annotation.Autowired;

View File

@@ -1,10 +1,9 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.QRCodeModel;
@FunctionalInterface
public interface QRCodeFactory<T extends QRCodeModel> {
public interface QRCodeFactory<T extends QRCodeModel<?>> {
T create(QRCodeEntity scannedQRCodeEntity);
}

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.QRCodeModel;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.SMSModel;
import com.safeqr.app.qrcode.service.SMSVerificationService;
import org.springframework.beans.factory.annotation.Autowired;

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.TextModel;
import com.safeqr.app.qrcode.service.TextVerificationService;
import org.springframework.beans.factory.annotation.Autowired;

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.URLModel;
import com.safeqr.app.qrcode.service.URLVerificationService;
import org.springframework.beans.factory.annotation.Autowired;

View File

@@ -1,7 +1,6 @@
package com.safeqr.app.qrcode.model.factory;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
import com.safeqr.app.qrcode.model.WifiModel;
import com.safeqr.app.qrcode.service.WifiVerificationService;
import org.springframework.beans.factory.annotation.Autowired;

View File

@@ -1,8 +1,6 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.EmailEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.UUID;
public interface EmailRepository extends JpaRepository<EmailEntity, UUID> {
public interface EmailRepository extends GenericRepository<EmailEntity> {
}

View File

@@ -0,0 +1,10 @@
package com.safeqr.app.qrcode.repository;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.repository.NoRepositoryBean;
import java.util.UUID;
@NoRepositoryBean
public interface GenericRepository<T> extends JpaRepository<T, UUID> {
}

View File

@@ -1,8 +1,6 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.PhoneEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.UUID;
public interface PhoneRepository extends JpaRepository<PhoneEntity, UUID> {
public interface PhoneRepository extends GenericRepository<PhoneEntity> {
}

View File

@@ -1,8 +1,6 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.UUID;
public interface QRCodeRepository extends JpaRepository<QRCodeEntity, UUID> {
public interface QRCodeRepository extends GenericRepository<QRCodeEntity> {
}

View File

@@ -1,8 +1,6 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.SMSEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.UUID;
public interface SMSRepository extends JpaRepository<SMSEntity, UUID> {
public interface SMSRepository extends GenericRepository<SMSEntity> {
}

View File

@@ -1,8 +1,6 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.TextEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.UUID;
public interface TextRepository extends JpaRepository<TextEntity, UUID> {
public interface TextRepository extends GenericRepository<TextEntity> {
}

View File

@@ -1,8 +1,10 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.URLEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.Optional;
import java.util.UUID;
public interface URLRepository extends JpaRepository<URLEntity, UUID> {
public interface URLRepository extends GenericRepository<URLEntity> {
Optional<URLEntity> findByQrCodeId(UUID qrCodeId);
}

View File

@@ -1,8 +1,6 @@
package com.safeqr.app.qrcode.repository;
import com.safeqr.app.qrcode.entity.WifiEntity;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.UUID;
public interface WifiRepository extends JpaRepository<WifiEntity, UUID> {
public interface WifiRepository extends GenericRepository<WifiEntity> {
}

View File

@@ -2,7 +2,9 @@
package com.safeqr.app.qrcode.service;
import static com.safeqr.app.constants.CommonConstants.*;
import com.safeqr.app.qrcode.dto.QRCodePayload;
import com.safeqr.app.exceptions.QRCodeExceptions;
import com.safeqr.app.qrcode.dto.request.QRCodePayload;
import com.safeqr.app.qrcode.dto.response.BaseScanResponse;
import com.safeqr.app.qrcode.entity.QRCodeEntity;
import com.safeqr.app.qrcode.entity.QRCodeTypeEntity;
@@ -23,6 +25,8 @@ import java.security.NoSuchAlgorithmException;
import java.time.LocalDateTime;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import java.util.function.Function;
import java.util.stream.Collectors;
@@ -48,11 +52,8 @@ public class QRCodeTypeService {
this.qrCodeRepository = qrCodeRepository;
this.safeBrowsingService = safeBrowsingService;
}
private List<QRCodeTypeEntity> configs;
private QRCodeTypeEntity defaultQRCodeTypeEntity;
private Map<Long, QRCodeTypeEntity> qrCodeTypeMap;
@PostConstruct
public void loadQRCodeTypes() {
@@ -63,15 +64,23 @@ public class QRCodeTypeService {
.filter(config -> config.getType().equals(DEFAULT_QR_CODE_TYPE))
.findFirst()
.orElse(null);
// Construct the tableMap with key = qrCodeTypeId, value = tableName
qrCodeTypeMap = configs.stream().collect(Collectors.toMap(QRCodeTypeEntity::getId, Function.identity()));
logger.info("QRCodeType map: {}", qrCodeTypeMap);
}
public List<QRCodeTypeEntity> getAllTypes() {
return configs;
}
// Get scanned qrcode details
public BaseScanResponse getScannedQRCodeDetails(UUID qrCodeId){
// Find scanned qr code in qr code table
QRCodeEntity qrCodeEntity = qrCodeRepository.findById(qrCodeId)
.orElseThrow(() -> new QRCodeExceptions("QR Code not found with id: " + qrCodeId));
logger.info("qrCodeEntity: {}", qrCodeEntity);
QRCodeModel<?> qrCodeModel = qrCodeFactoryProvider.createQRCodeInstance(qrCodeEntity);
logger.info("Retrieved details: {}", qrCodeModel.getDetails());
return BaseScanResponse.builder().qrcode(qrCodeModel).build();
}
// Process Scanned QR Code
public BaseScanResponse scanQRCode(String userId, QRCodePayload payload) {
String data = payload.getData();
logger.info("scanQRCode: userId={}, data={}", userId, data);
@@ -97,7 +106,7 @@ public class QRCodeTypeService {
.build());
}
// Create the QR Code Instance based on the QR Code Type & insert into the respective table
QRCodeModel qrCodeModel = qrCodeFactoryProvider.createQRCodeInstance(scannedQR);
QRCodeModel<?> qrCodeModel = qrCodeFactoryProvider.createQRCodeInstance(scannedQR);
qrCodeModel.setDetails();
return BaseScanResponse.builder().qrcode(qrCodeModel).build();
@@ -109,10 +118,6 @@ public class QRCodeTypeService {
.findFirst()
.orElse(defaultQRCodeTypeEntity);
}
// Returns name of table given type
public QRCodeTypeEntity getQRCodeMap(Long qrTypeId) {
return qrCodeTypeMap.get(qrTypeId);
}
public Mono<String> detectType(QRCodePayload payload) {
String data = payload.getData();

View File

@@ -1,7 +1,7 @@
package com.safeqr.app.qrcode.service;
import com.safeqr.app.qrcode.dto.QRCodePayload;
import com.safeqr.app.qrcode.dto.request.QRCodePayload;
import com.safeqr.app.qrcode.dto.RedirectCountResponse;
import org.springframework.stereotype.Service;
import org.springframework.web.reactive.function.client.WebClient;

View File

@@ -1,7 +1,9 @@
package com.safeqr.app.qrcode.service;
import static com.safeqr.app.constants.CommonConstants.*;
import com.safeqr.app.qrcode.dto.QRCodePayload;
import com.safeqr.app.exceptions.QRCodeExceptions;
import com.safeqr.app.qrcode.dto.request.QRCodePayload;
import com.safeqr.app.qrcode.dto.URLVerificationResponse;
import com.safeqr.app.qrcode.entity.URLEntity;
import com.safeqr.app.qrcode.repository.URLRepository;
@@ -25,6 +27,12 @@ public class URLVerificationService {
this.urlRepository = urlRepository;
}
public URLEntity getURLEntityByQRCodeId(UUID qrCodeId) {
logger.info("qrCodeId retrieving: {}", qrCodeId);
return urlRepository.findByQrCodeId(qrCodeId)
.orElseThrow(() -> new QRCodeExceptions("URL not found for QR Code id: " + qrCodeId));
}
public void insertDB(URLEntity urlEntity) {
urlRepository.save(urlEntity);
}

View File

@@ -2,7 +2,7 @@
package com.safeqr.app.qrcode.service;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.safeqr.app.qrcode.dto.QRCodePayload;
import com.safeqr.app.qrcode.dto.request.QRCodePayload;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;