Merge branch 'main' of github.com:lucoenergia/conluz into main

Author: viktorKhan

build.gradle

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = 'org.lucoenergia'
-version = "1.0.16"
+version = "1.0.17"
 
 java {
     toolchain {

src/main/java/org/lucoenergia/conluz/domain/admin/supply/Supply.java

@@ -2,6 +2,7 @@
 
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.PositiveOrZero;
 import org.lucoenergia.conluz.domain.admin.user.User;
 import org.lucoenergia.conluz.infrastructure.shared.uuid.ValidUUID;
 
@@ -18,10 +19,12 @@ public class Supply {
     private String code;
     @NotNull
     private User user;
+    @NotBlank
     private String name;
     @NotBlank
     private String address;
     @NotNull
+    @PositiveOrZero
     private Float partitionCoefficient;
     @NotNull
     private Boolean enabled;
@@ -265,4 +268,4 @@ public boolean equals(Object o) {
     public int hashCode() {
         return Objects.hash(getId(), getCode(), getUser());
     }
-}
+}

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/SupplyExceptionHandler.java

@@ -1,6 +1,8 @@
 package org.lucoenergia.conluz.infrastructure.admin.supply;
 
+import org.lucoenergia.conluz.domain.admin.supply.SupplyAlreadyExistsException;
 import org.lucoenergia.conluz.domain.admin.supply.SupplyNotFoundException;
+import org.lucoenergia.conluz.domain.admin.user.UserAlreadyExistsException;
 import org.lucoenergia.conluz.infrastructure.shared.web.error.RestError;
 import org.springframework.context.MessageSource;
 import org.springframework.context.i18n.LocaleContextHolder;
@@ -10,6 +12,7 @@
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
 import java.util.Collections;
+import java.util.List;
 
 @RestControllerAdvice
 public class SupplyExceptionHandler {
@@ -32,4 +35,15 @@ public ResponseEntity<RestError> handleException(SupplyNotFoundException e) {
         );
         return new ResponseEntity<>(new RestError(HttpStatus.BAD_REQUEST.value(), message), HttpStatus.BAD_REQUEST);
     }
+
+    @ExceptionHandler(SupplyAlreadyExistsException.class)
+    public ResponseEntity<RestError> handleException(SupplyAlreadyExistsException e) {
+
+        String message = messageSource.getMessage(
+                "error.supply.already.exists",
+                List.of(e.getCode().getCode()).toArray(),
+                LocaleContextHolder.getLocale()
+        );
+        return new ResponseEntity<>(new RestError(HttpStatus.BAD_REQUEST.value(), message), HttpStatus.BAD_REQUEST);
+    }
 }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyAssembler.java

@@ -6,8 +6,6 @@
 import org.lucoenergia.conluz.domain.admin.supply.Supply;
 import org.lucoenergia.conluz.domain.admin.user.User;
 
-import java.util.UUID;
-
 @Schema(requiredProperties = {
         "code", "personalId", "address", "partitionCoefficient"
 })
@@ -21,6 +19,7 @@ public class CreateSupplyBody {
     private String address;
     @Positive
     private Float partitionCoefficient;
+    private String name;
 
     public String getCode() {
         return code;
@@ -54,12 +53,25 @@ public void setPersonalId(String personalId) {
         this.personalId = personalId;
     }
 
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
     public Supply mapToSupply() {
         Supply.Builder builder = new Supply.Builder();
-        builder.withCode(code)
-                .withAddress(address)
+        builder.withCode(code.trim())
+                .withAddress(address.trim())
                 .withPartitionCoefficient(partitionCoefficient)
-                .withUser(new User.Builder().personalId(personalId).build());
+                .withUser(new User.Builder().personalId(personalId.trim()).build());
+
+        if (name != null && !name.isBlank()) {
+            builder.withName(name.trim());
+        }
+
         return builder.build();
     }
 }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyBody.java

@@ -1,12 +1,12 @@
 package org.lucoenergia.conluz.infrastructure.admin.supply.create;
 
 import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.ExampleObject;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import org.lucoenergia.conluz.domain.admin.supply.create.CreateSupplyService;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import jakarta.validation.Valid;
 import org.lucoenergia.conluz.domain.admin.supply.Supply;
+import org.lucoenergia.conluz.domain.admin.supply.create.CreateSupplyService;
 import org.lucoenergia.conluz.domain.shared.UserPersonalId;
 import org.lucoenergia.conluz.infrastructure.admin.supply.SupplyResponse;
 import org.lucoenergia.conluz.infrastructure.shared.web.apidocs.ApiTag;
@@ -15,6 +15,7 @@
 import org.lucoenergia.conluz.infrastructure.shared.web.apidocs.response.InternalServerErrorResponse;
 import org.lucoenergia.conluz.infrastructure.shared.web.apidocs.response.UnauthorizedErrorResponse;
 import org.springframework.http.MediaType;
+import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -31,59 +32,45 @@
 )
 public class CreateSupplyController {
 
-    private final CreateSupplyAssembler assembler;
     private final CreateSupplyService service;
 
-    public CreateSupplyController(CreateSupplyAssembler assembler, CreateSupplyService service) {
-        this.assembler = assembler;
+    public CreateSupplyController(CreateSupplyService service) {
         this.service = service;
     }
 
     @PostMapping
     @Operation(
             summary = "Creates a new supply within the system.",
-            description = "This endpoint is designed to create a new supply within the system. To utilize this endpoint, a client sends a request containing essential details such as the supply's address, partition coefficient, and any relevant parameters. Proper authentication, through authentication tokens, is required to access this endpoint. Upon successful creation, the server responds with a status code of 200, providing comprehensive details about the newly created supply, including its unique identifier. In case of failure, the server returns an appropriate error status code along with a descriptive error message, aiding the client in diagnosing and addressing the issue. This endpoint plays a pivotal role in dynamically expanding the system's repertoire of energy supplies.",
+            description = """
+                    This endpoint is designed to create a new supply within the system.
+                    
+                    To utilize this endpoint, a client sends a request containing essential details such as the supply's address, partition coefficient, and any relevant parameters.
+                    
+                    Proper authentication, through authentication tokens, is required to access this endpoint.
+                    **Required Role: ADMIN**
+                    
+                    Upon successful creation, the server responds with a status code of 200, providing comprehensive details about the newly created supply, including its unique identifier.
+                    
+                    In case of failure, the server returns an appropriate error status code along with a descriptive error message, aiding the client in diagnosing and addressing the issue. This endpoint plays a pivotal role in dynamically expanding the system's repertoire of energy supplies.
+                    """,
             tags = ApiTag.SUPPLIES,
-            operationId = "createSupply"
+            operationId = "createSupply",
+            security = @SecurityRequirement(name = "bearerToken", scopes = {"ADMIN"})
     )
     @ApiResponses(value = {
             @ApiResponse(
                     responseCode = "200",
                     description = "The supply has been successfully created.",
-                    content = @Content(
-                            mediaType = MediaType.APPLICATION_JSON_VALUE,
-                            examples = @ExampleObject(
-                                    value = """
-                                            {
-                                               "id":"785de77b-8c22-4d2f-9d12-f172113f9aa4",
-                                               "code":"ES0033333333333333AA0A",
-                                               "user":{
-                                                  "id":"e7ab39cd-9250-40a9-b829-f11f65aae27d",
-                                                  "personalId":"rAtjrSXAU",
-                                                  "number":646650705,
-                                                  "fullName":"John Doe",
-                                                  "address":"Fake Street 123",
-                                                  "email":"[email protected]",
-                                                  "phoneNumber":"+34666333111",
-                                                  "enabled":true,
-                                                  "role":"PARTNER"
-                                               },
-                                               "name":null,
-                                               "address":"Fake Street 123",
-                                               "partitionCoefficient":3.0763,
-                                               "enabled":true
-                                            }
-                                            """
-                            )
-                    )
+                    useReturnTypeSchema = true
             )
     })
     @BadRequestErrorResponse
     @InternalServerErrorResponse
     @UnauthorizedErrorResponse
     @ForbiddenErrorResponse
-    public SupplyResponse createSupply(@RequestBody CreateSupplyBody body) {
-        Supply newSupply = service.create(assembler.assemble(body), UserPersonalId.of(body.getPersonalId()));
+    @PreAuthorize("hasRole('ADMIN')")
+    public SupplyResponse createSupply(@Valid @RequestBody CreateSupplyBody body) {
+        Supply newSupply = service.create(body.mapToSupply(), UserPersonalId.of(body.getPersonalId()));
         return new SupplyResponse(newSupply);
     }
 }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyController.java

@@ -26,9 +26,32 @@ public CreateSupplyServiceImpl(CreateSupplyRepository repository, GetUserReposit
         this.getUserRepository = getUserRepository;
     }
 
+    @Override
     public Supply create(Supply supply, UserId id) {
         supply.enable();
         supply.initializeUuid();
+
+        // If name is not provided, use the ID as the default name
+        if (supply.getName() == null) {
+            supply = new Supply.Builder()
+                    .withId(supply.getId())
+                    .withCode(supply.getCode())
+                    .withUser(supply.getUser())
+                    .withName(supply.getAddress())
+                    .withAddress(supply.getAddress())
+                    .withPartitionCoefficient(supply.getPartitionCoefficient())
+                    .withEnabled(supply.getEnabled())
+                    .withValidDateFrom(supply.getValidDateFrom())
+                    .withDistributor(supply.getDistributor())
+                    .withDistributorCode(supply.getDistributorCode())
+                    .withPointType(supply.getPointType())
+                    .withThirdParty(supply.isThirdParty())
+                    .withShellyMac(supply.getShellyMac())
+                    .withShellyId(supply.getShellyId())
+                    .withShellyMqttPrefix(supply.getShellyMqttPrefix())
+                    .build();
+        }
+
         return repository.create(supply, id);
     }
 

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyServiceImpl.java

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.24.xsd">
+
+    <!-- Update existing null names to use ID as name -->
+    <changeSet id="update_null_supply_names" author="Víctor Cañizares">
+        <sql>
+            UPDATE supplies
+            SET name = id::text
+            WHERE name IS NULL;
+        </sql>
+    </changeSet>
+
+    <!-- Make name column not nullable -->
+    <changeSet id="make_supply_name_not_null" author="Víctor Cañizares">
+        <addNotNullConstraint
+            tableName="supplies"
+            columnName="name"
+            columnDataType="VARCHAR(250)"/>
+    </changeSet>
+
+</databaseChangeLog>

src/main/resources/db/liquibase/changelogs/make_supply_name_not_null.xml

@@ -17,4 +17,5 @@ http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd">
     <include file="changelogs/rename_datadis_supplies_fields.xml" relativeToChangelogFile="true" />
     <include file="changelogs/create_table_sharing_agreements.xml" relativeToChangelogFile="true" />
     <include file="changelogs/create_table_supplies_partitions.xml" relativeToChangelogFile="true" />
+    <include file="changelogs/make_supply_name_not_null.xml" relativeToChangelogFile="true" />
 </databaseChangeLog>

src/main/resources/db/liquibase/db.changelog-main.xml

@@ -84,4 +84,38 @@ void testCreateSupplyWithUserPersonalIdWhenUserNotExistThrowUserNotFoundExceptio
         // act & assert
         assertThrows(UserNotFoundException.class, () -> createSupplyService.create(supply, UserPersonalId.of("123")));
     }
+
+    @Test
+    void testCreateSupplyWhenNameIsNotProvidedThenAddressIsUsedAsName() {
+        // arrange
+        String address = "Test Address 123";
+        Supply supply = new Supply.Builder()
+                .withId(UUID.randomUUID())
+                .withCode("code")
+                .withAddress(address)
+                .withPartitionCoefficient(1.0F)
+                .withEnabled(Boolean.TRUE)
+                .build();
+        UserId userId = UserId.of(UUID.randomUUID());
+
+        Supply expectedSupply = new Supply.Builder()
+                .withId(supply.getId())
+                .withCode(supply.getCode())
+                .withAddress(address)
+                .withName(address)
+                .withPartitionCoefficient(supply.getPartitionCoefficient())
+                .withEnabled(supply.getEnabled())
+                .build();
+
+        when(supplyRepository.create(any(Supply.class), any(UserId.class))).thenReturn(expectedSupply);
+
+        // act
+        Supply actualSupply = createSupplyService.create(supply, userId);
+
+        // assert
+        assertNotNull(actualSupply);
+        assertEquals(address, actualSupply.getName());
+    }
+
+
 }