#146 | Implement the process of Assignment for Save Operation

src/main/java/com/ays/assignment/controller/AssignmentController.java

@@ -0,0 +1,42 @@
+package com.ays.assignment.controller;
+
+import com.ays.assignment.model.dto.request.AssignmentSaveRequest;
+import com.ays.assignment.service.AssignmentSaveService;
+import com.ays.common.model.dto.response.AysResponse;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * REST controller class for managing assignment-related operations via HTTP requests.
+ * This controller handles the CRUD operations for assignments in the system.
+ * The mapping path for this controller is "/api/v1/assignment".
+ */
+@RestController
+@RequestMapping("/api/v1")
+@RequiredArgsConstructor
+@Validated
+class AssignmentController {
+
+    private final AssignmentSaveService assignmentSaveService;
+
+
+    /**
+     * Saves a new assignment to the system.
+     * Requires ADMIN authority.
+     *
+     * @param saveRequest The request object containing the assignment data to be saved.
+     * @return A response object containing the saved assignment data.
+     */
+    @PostMapping("/assignment")
+    @PreAuthorize("hasAnyAuthority('ADMIN')")
+    public AysResponse<Void> saveAssignment(@RequestBody @Valid AssignmentSaveRequest saveRequest) {
+        assignmentSaveService.saveAssignment(saveRequest);
+        return AysResponse.SUCCESS;
+    }
+}

src/main/java/com/ays/assignment/model/dto/request/AssignmentSaveRequest.java

@@ -0,0 +1,43 @@
+package com.ays.assignment.model.dto.request;
+
+import com.ays.common.model.AysPhoneNumber;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * A DTO class representing the request data for saving an assignment.
+ * <p>
+ * This class provides getters and setters for the description, first name, last name, latitude, longitude  and phone number fields.
+ * It also includes a builder pattern implementation for constructing instances of this class with optional parameters.
+ * <p>
+ * The purpose of this class is to encapsulate the request data related to saving an assignment, allowing for easy
+ * transfer of the data between different layers of the application.
+ */
+@Getter
+@Setter
+@Builder
+public class AssignmentSaveRequest {
+
+    @NotBlank
+    private String description;
+
+    @NotBlank
+    private String firstName;
+
+    @NotBlank
+    private String lastName;
+
+    @Valid
+    @NotNull
+    private AysPhoneNumber phoneNumber;
+
+    @NotNull
+    private Double latitude;
+
+    @NotNull
+    private Double longitude;
+}

src/main/java/com/ays/assignment/model/entity/AssignmentEntity.java

@@ -11,8 +11,10 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 import org.locationtech.jts.geom.Coordinate;
+import org.locationtech.jts.geom.CoordinateSequence;
 import org.locationtech.jts.geom.GeometryFactory;
 import org.locationtech.jts.geom.Point;
+import org.locationtech.jts.geom.impl.CoordinateArraySequence;
 
 /**
  * Assignment entity, which holds the information regarding assignment.
@@ -55,7 +57,7 @@ public class AssignmentEntity extends BaseEntity {
     private Point point;
 
     @Enumerated(EnumType.STRING)
-    @Column(name = "ASSIGNMENT_STATUS")
+    @Column(name = "STATUS")
     private AssignmentStatus status;
 
     @OneToOne
@@ -67,9 +69,11 @@ public class AssignmentEntity extends BaseEntity {
     private UserEntity user;
 
     public void setPoint(double latitude, double longitude) {
-        Coordinate coordinate = new Coordinate(latitude, longitude);
+        Coordinate[] coordinates = new Coordinate[]{new Coordinate(latitude, longitude)};
+        CoordinateSequence coordinateSequence = new CoordinateArraySequence(coordinates);
         GeometryFactory geometryFactory = new GeometryFactory();
-        this.point = geometryFactory.createPoint(coordinate);
+        this.point = geometryFactory.createPoint(coordinateSequence);
+        this.point.setSRID(4326); // Set the SRID of the created Point
     }
 
     public boolean isAvailable() {
@@ -92,6 +96,7 @@ public boolean isDone() {
         return AssignmentStatus.DONE.equals(this.status);
     }
 
+
     public void updateAssignmentStatus(AssignmentStatus assignmentStatus) {
         this.status = assignmentStatus;
     }

src/main/java/com/ays/assignment/model/mapper/AssignmentSaveRequestToAssignmentMapper.java

@@ -0,0 +1,57 @@
+package com.ays.assignment.model.mapper;
+
+import com.ays.assignment.model.Assignment;
+import com.ays.assignment.model.dto.request.AssignmentSaveRequest;
+import com.ays.assignment.model.entity.AssignmentEntity;
+import com.ays.assignment.model.enums.AssignmentStatus;
+import com.ays.common.model.mapper.BaseMapper;
+import com.ays.common.util.AysRandomUtil;
+import com.ays.user.model.entity.UserEntity;
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+
+/**
+ * UserToUserResponseMapper is an interface that defines the mapping between an {@link AssignmentSaveRequest} and an {@link Assignment}.
+ * This interface uses the MapStruct annotation @Mapper to generate an implementation of this interface at compile-time.
+ * <p>The class provides a static method {@code initialize()} that returns an instance of the generated mapper implementation.
+ * <p>The interface extends the MapStruct interface {@link BaseMapper}, which defines basic mapping methods.
+ * The interface adds no additional mapping methods, but simply defines the types to be used in the mapping process.
+ */
+@Mapper
+public interface AssignmentSaveRequestToAssignmentMapper extends BaseMapper<AssignmentSaveRequest, Assignment> {
+
+    /**
+     * Maps an {@link AssignmentSaveRequest} object to an {@link AssignmentEntity} object for saving in the database.
+     *
+     * @param saveRequest   the {@link AssignmentSaveRequest} object to be mapped.
+     * @param institutionId the {@link String} object.
+     * @return the mapped {@link UserEntity} object.
+     */
+    default AssignmentEntity mapForSaving(AssignmentSaveRequest saveRequest, String institutionId) {
+
+        AssignmentEntity assignmentEntity = AssignmentEntity.builder()
+                .id(AysRandomUtil.generateUUID())
+                .institutionId(institutionId)
+                .firstName(saveRequest.getFirstName())
+                .lastName(saveRequest.getLastName())
+                .lineNumber(saveRequest.getPhoneNumber().getLineNumber())
+                .countryCode(saveRequest.getPhoneNumber().getCountryCode())
+                .description(saveRequest.getDescription())
+                .status(AssignmentStatus.AVAILABLE)
+                .build();
+
+        assignmentEntity.setPoint(saveRequest.getLatitude(), saveRequest.getLongitude());
+
+        return assignmentEntity;
+    }
+
+    /**
+     * Initializes the mapper.
+     *
+     * @return the initialized mapper object.
+     */
+    static AssignmentSaveRequestToAssignmentMapper initialize() {
+        return Mappers.getMapper(AssignmentSaveRequestToAssignmentMapper.class);
+    }
+
+}

src/main/java/com/ays/assignment/repository/AssignmentEntityRepository.java → src/main/java/com/ays/assignment/repository/AssignmentRepository.java

@@ -2,10 +2,12 @@
 
 import com.ays.assignment.model.entity.AssignmentEntity;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
 
 /**
  * Repository interface for performing CRUD operations on UserAssignmentEntity objects.
  */
-public interface AssignmentEntityRepository extends JpaRepository<AssignmentEntity, String> {
+public interface AssignmentRepository extends JpaRepository<AssignmentEntity, String>, JpaSpecificationExecutor<AssignmentEntity> {
+
 
 }

src/main/java/com/ays/assignment/service/AssignmentSaveService.java

@@ -0,0 +1,17 @@
+package com.ays.assignment.service;
+
+import com.ays.assignment.model.dto.request.AssignmentSaveRequest;
+
+/**
+ * Assignment Save Service to perform assignment related save business operations.
+ */
+public interface AssignmentSaveService {
+
+    /**
+     * Saves a saveRequest to the database.
+     *
+     * @param saveRequest the AssignmentSaveRequest entity
+     * @return Assignment
+     */
+    void saveAssignment(AssignmentSaveRequest saveRequest);
+}

src/main/java/com/ays/assignment/service/impl/AssignmentSaveServiceImpl.java

@@ -0,0 +1,41 @@
+package com.ays.assignment.service.impl;
+
+import com.ays.assignment.model.dto.request.AssignmentSaveRequest;
+import com.ays.assignment.model.entity.AssignmentEntity;
+import com.ays.assignment.model.mapper.AssignmentSaveRequestToAssignmentMapper;
+import com.ays.assignment.repository.AssignmentRepository;
+import com.ays.assignment.service.AssignmentSaveService;
+import com.ays.auth.model.AysIdentity;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+/**
+ * UserSaveServiceImpl is an implementation of the {@link AssignmentSaveService} interface.
+ * It provides methods for saving assignment data and performing related operations by admin.
+ */
+@Service
+@RequiredArgsConstructor
+class AssignmentSaveServiceImpl implements AssignmentSaveService {
+
+    private final AssignmentRepository assignmentRepository;
+
+    private final AysIdentity identity;
+
+    private static final AssignmentSaveRequestToAssignmentMapper assignmentSaveRequestToAssignmentMapper = AssignmentSaveRequestToAssignmentMapper.initialize();
+
+    /**
+     * Saves a new assignment based on the provided save request.
+     *
+     * @param saveRequest the request object containing assignment data to be saved
+     * @return the saved assignment
+     */
+    @Override
+    public void saveAssignment(AssignmentSaveRequest saveRequest) {
+
+        final AssignmentEntity assignmentEntity = assignmentSaveRequestToAssignmentMapper.mapForSaving(saveRequest, identity.getInstitutionId());
+
+        assignmentRepository.save(assignmentEntity);
+
+    }
+
+}

src/main/java/com/ays/assignment/util/exception/AysAssignmentAlreadyAvailableException.java

@@ -5,7 +5,7 @@
 import java.io.Serial;
 
 /**
- * Exception thrown when a user assignment is available and attempting to perform an action that requires an assignment which is already available.
+ * Exception thrown when an assignment is available and attempting to perform an action that requires an assignment which is already available.
  */
 public class AysAssignmentAlreadyAvailableException extends AysAlreadyException {
 

src/main/java/com/ays/assignment/util/exception/AysAssignmentAlreadyDeletedException.java

@@ -0,0 +1,26 @@
+package com.ays.assignment.util.exception;
+
+import com.ays.common.util.exception.AysAlreadyException;
+
+import java.io.Serial;
+
+/**
+ * Exception thrown when an assignment is deleted and attempting to perform an action that requires an assignment which is already deleted.
+ */
+public class AysAssignmentAlreadyDeletedException extends AysAlreadyException {
+
+    /**
+     * Unique identifier for serialization.
+     */
+    @Serial
+    private static final long serialVersionUID = 7742901037914306311L;
+
+    /**
+     * Constructs a new {@code AysAssignmentAlreadyAvailableException} with the specified id.
+     *
+     * @param id the id of the assignment which is already available
+     */
+    public AysAssignmentAlreadyDeletedException(String id) {
+        super("ASSIGNMENT IS ALREADY DELETED! id:" + id);
+    }
+}

src/main/resources/db/changelog/changes/4-ays-ddl.xml

@@ -47,17 +47,17 @@
                 <constraints primaryKey="true" nullable="false"/>
             </column>
             <column name="USER_ID" type="VARCHAR(36)">
-                <constraints unique="true"
-                             foreignKeyName="FK__AYS_ASSIGNMENT__USER_ID"
-                             referencedTableName="AYS_USER"
-                             referencedColumnNames="ID"
+                <constraints
+                        foreignKeyName="FK__AYS_ASSIGNMENT__USER_ID"
+                        referencedTableName="AYS_USER"
+                        referencedColumnNames="ID"
                 />
             </column>
             <column name="INSTITUTION_ID" type="VARCHAR(36)">
-                <constraints unique="true"
-                             foreignKeyName="FK__AYS_ASSIGNMENT__INSTITUTION_ID"
-                             referencedTableName="AYS_USER"
-                             referencedColumnNames="ID"
+                <constraints
+                        foreignKeyName="FK__AYS_ASSIGNMENT__INSTITUTION_ID"
+                        referencedTableName="AYS_INSTITUTION"
+                        referencedColumnNames="ID"
                 />
             </column>
             <column name="DESCRIPTION" type="VARCHAR(2048)">
@@ -69,10 +69,10 @@
             <column name="LAST_NAME" type="VARCHAR(255)">
                 <constraints nullable="false"/>
             </column>
-            <column name="COUNTRY_CODE" type="INTEGER(5)">
+            <column name="COUNTRY_CODE" type="VARCHAR(5)">
                 <constraints nullable="false"/>
             </column>
-            <column name="LINE_NUMBER" type="INTEGER(10)">
+            <column name="LINE_NUMBER" type="VARCHAR(10)">
                 <constraints nullable="false"/>
             </column>
             <column name="STATUS" type="VARCHAR(50)">

src/main/resources/db/changelog/changes/5-ays-dml.xml

@@ -24,23 +24,23 @@
         <!-- ========================== -->
         <sql>
             <!-- Kadiköy, Moda (40.981210, 29.026083) -->
-            INSERT INTO AYS_ASSIGNMENT (ID, DESCRIPTION, FIRST_NAME, LAST_NAME, COUNTRY_CODE, LINE_NUMBER, STATUS,
+            INSERT INTO AYS_ASSIGNMENT (ID, INSTITUTION_ID, DESCRIPTION, FIRST_NAME, LAST_NAME, COUNTRY_CODE,
+                                        LINE_NUMBER, STATUS,
                                         POINT, CREATED_USER, CREATED_AT)
-            VALUES ('3b30cac9-0645-48cb-bc98-2e928df521ab', '100L İçme Suyu İhtiyacı', 'Ahmet', 'Mehmet',
-                    90, 1234567890, 'AVAILABLE', ST_GeomFromText('POINT(40.981210 29.026083)', 4326),
+            VALUES ('3b30cac9-0645-48cb-bc98-2e928df521ab', '77ece256-bf0e-4bbe-801d-173083f8bdcf',
+                    '100L İçme Suyu İhtiyacı',
+                    'Ahmet', 'Mehmet', '90', '1234567890', 'AVAILABLE',
+                    ST_GeomFromText('POINT(40.981210 29.026083)', 4326),
                     'AYS', CURRENT_TIMESTAMP);
 
-            INSERT INTO AYS_ASSIGNMENT (ID, DESCRIPTION, FIRST_NAME, LAST_NAME, COUNTRY_CODE, LINE_NUMBER, STATUS,
+            INSERT INTO AYS_ASSIGNMENT (ID, INSTITUTION_ID, DESCRIPTION, FIRST_NAME, LAST_NAME, COUNTRY_CODE,
+                                        LINE_NUMBER, STATUS,
                                         POINT, CREATED_USER, CREATED_AT)
-            VALUES ('a9ec051e-3c4f-4cb5-ab08-e9dcee5e1f03', 'Kıyafet İhtiyacı', 'Cem', 'Orkun',
-                    90, 1234567890, 'AVAILABLE', ST_GeomFromText('POINT(40.981210 29.000000)', 4326),
+            VALUES ('a9ec051e-3c4f-4cb5-ab08-e9dcee5e1f03', '91df7ae9-d5b9-44ae-b54f-d5d55359c4a4', 'Kıyafet İhtiyacı',
+                    'Cem', 'Orkun', '90', '1234567890', 'AVAILABLE',
+                    ST_GeomFromText('POINT(40.981210 29.000000)', 4326),
                     'AYS', CURRENT_TIMESTAMP);
 
-            INSERT INTO AYS_ASSIGNMENT (ID, DESCRIPTION, FIRST_NAME, LAST_NAME, COUNTRY_CODE, LINE_NUMBER, STATUS,
-                                        POINT, CREATED_USER, CREATED_AT)
-            VALUES ('7e1ebd41-a644-4596-a0f3-b4a71237b3c5', 'Yemek İhtiyacı', 'Ceren', 'Deniz',
-                    90, 1234567890, 'AVAILABLE', ST_GeomFromText('POINT(40.941210 29.123123)', 4326),
-                    'AYS', CURRENT_TIMESTAMP);
         </sql>
         <!-- ========================== -->
         <!-- DML of AYS_ASSIGNMENT -->