fix: shop module structure

change the shop module structure and add a new module shop_database that contains all the entities and repositories of shop add a line in the README about swagger linked #15
MelvinCou · Jan 3, 2024 · 234cad9 · 234cad9
1 parent 5e48cf9
commit 234cad9
Show file tree

Hide file tree

Showing 30 changed files with 733 additions and 139 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,9 @@ To manage the microservices of the application, you need to first launch the mod
 Then launch the module api_gateway and the module mediator.
 You can have access to the Dashboard of the eureka_server at http://localhost:8761. You will see all the microservices.
 
+### For the endpoints documentation
+You can access the documentation of each endpoints after launching at this address : http://<localhost:service port>/swagger-ui/index.html#. This page also allow you to try the different endpoints of the concerned service.
+
 
 # terminal
 

diff --git a/Server/shop/pom.xml b/Server/shop/pom.xml
@@ -15,79 +15,20 @@
     <properties>
         <java.version>17</java.version>
     </properties>
+    <packaging>pom</packaging>
 
-    <dependencies>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-data-jpa</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-web</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.flywaydb</groupId>
-            <artifactId>flyway-core</artifactId>
-        </dependency>
+    <modules>
+        <module>shop_database</module>
+        <module>product</module>
+    </modules>
 
+    <dependencies>
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-devtools</artifactId>
-            <scope>runtime</scope>
-            <optional>true</optional>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-docker-compose</artifactId>
-            <scope>runtime</scope>
-            <optional>true</optional>
-        </dependency>
-        <dependency>
-            <groupId>org.postgresql</groupId>
-            <artifactId>postgresql</artifactId>
-            <scope>runtime</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <optional>true</optional>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
+            <groupId>com.cashmanager.server</groupId>
+            <artifactId>common</artifactId>
+            <version>0.0.1-SNAPSHOT</version>
+            <scope>compile</scope>
         </dependency>
     </dependencies>
 
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-maven-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>repackage</goal>
-                        </goals>
-                        <configuration>
-                            <attach>false</attach>
-                        </configuration>
-                    </execution>
-                </executions>
-                <configuration>
-                    <image>
-                        <builder>paketobuildpacks/builder-jammy-base:latest</builder>
-                    </image>
-                    <excludes>
-                        <exclude>
-                            <groupId>org.projectlombok</groupId>
-                            <artifactId>lombok</artifactId>
-                        </exclude>
-                    </excludes>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
 </project>
diff --git a/Server/shop/product/pom.xml b/Server/shop/product/pom.xml
@@ -3,12 +3,11 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
-        <groupId>org.springframework.boot</groupId>
-        <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.2.0</version>
-        <relativePath/> <!-- lookup parent from repository -->
+        <groupId>com.cashmanager.server</groupId>
+        <artifactId>shop</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
     </parent>
-    <groupId>com.cashmanager.server</groupId>
+
     <artifactId>product</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <name>product</name>
@@ -45,13 +44,7 @@
                 </dependency>
         <dependency>
             <groupId>com.cashmanager.server</groupId>
-            <artifactId>shop</artifactId>
-            <version>0.0.1-SNAPSHOT</version>
-            <scope>compile</scope>
-        </dependency>
-        <dependency>
-            <groupId>com.cashmanager.server</groupId>
-            <artifactId>common</artifactId>
+            <artifactId>shop_database</artifactId>
             <version>0.0.1-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>

diff --git a/Server/shop/product/src/main/java/com/cashmanager/server/product/ProductApplication.java b/Server/shop/product/src/main/java/com/cashmanager/server/product/ProductApplication.java
@@ -7,7 +7,7 @@
 
 @SpringBootApplication
 @EnableJpaRepositories(basePackages = "com.cashmanager.server")
-@EntityScan("com.cashmanager.server.shop.entities")
+@EntityScan("com.cashmanager.server.shop_database.entities")
 public class ProductApplication {
 
     public static void main(String[] args) {

diff --git a/...product/controller/ProductController.java → ...roduct/controllers/ProductController.java b/...product/controller/ProductController.java → ...roduct/controllers/ProductController.java
@@ -1,8 +1,8 @@
-package com.cashmanager.server.product.controller;
+package com.cashmanager.server.product.controllers;
 
 import com.cashmanager.server.common.dto.ProductDto;
 import com.cashmanager.server.product.exceptions.ProductException;
-import com.cashmanager.server.product.service.interfaces.IProductService;
+import com.cashmanager.server.product.services.interfaces.IProductService;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;

diff --git a/...hop/product/src/main/java/com/cashmanager/server/product/exceptions/ProductException.java b/...hop/product/src/main/java/com/cashmanager/server/product/exceptions/ProductException.java
@@ -1,5 +1,8 @@
 package com.cashmanager.server.product.exceptions;
 
+/**
+ * Class that will be thrown when an error occur while communicated with the database
+ */
 public class ProductException extends Exception{
     public ProductException() {
         super();

diff --git a/...p/product/src/main/java/com/cashmanager/server/product/service/mappers/ProductMapper.java b/...p/product/src/main/java/com/cashmanager/server/product/service/mappers/ProductMapper.java
diff --git a/...erver/product/service/ProductService.java → ...rver/product/services/ProductService.java b/...erver/product/service/ProductService.java → ...rver/product/services/ProductService.java
@@ -1,11 +1,12 @@
-package com.cashmanager.server.product.service;
+package com.cashmanager.server.product.services;
 
 import com.cashmanager.server.common.dto.ProductDto;
 import com.cashmanager.server.product.exceptions.ProductException;
-import com.cashmanager.server.product.service.interfaces.IProductService;
-import com.cashmanager.server.product.service.mappers.ProductMapper;
-import com.cashmanager.server.shop.entities.Product;
-import com.cashmanager.server.shop.repositories.ProductRepository;
+import com.cashmanager.server.product.services.interfaces.IProductService;
+import com.cashmanager.server.product.services.mappers.ProductMapper;
+
+import com.cashmanager.server.shop_database.entities.Product;
+import com.cashmanager.server.shop_database.repositories.ProductRepository;
 import org.springframework.stereotype.Service;
 
 import java.util.ArrayList;

diff --git a/...t/service/interfaces/IProductService.java → .../services/interfaces/IProductService.java b/...t/service/interfaces/IProductService.java → .../services/interfaces/IProductService.java
@@ -1,4 +1,4 @@
-package com.cashmanager.server.product.service.interfaces;
+package com.cashmanager.server.product.services.interfaces;
 
 import com.cashmanager.server.common.dto.ProductDto;
 import com.cashmanager.server.product.exceptions.ProductException;
@@ -9,6 +9,11 @@
 
 public interface IProductService {
 
+    /**
+     * Function that recuperate the products available in the database, via the ProductRepository
+     * @return List of ProductDto
+     * @throws ProductException if there is an error when communicating with the database
+     */
     List<ProductDto> getAllProducts() throws ProductException;
     Optional<ProductDto> getProductById(UUID productId);
     Optional<ProductDto> updateProduct(UUID productId, ProductDto product);

diff --git a/.../product/src/main/java/com/cashmanager/server/product/services/mappers/ProductMapper.java b/.../product/src/main/java/com/cashmanager/server/product/services/mappers/ProductMapper.java
@@ -0,0 +1,26 @@
+package com.cashmanager.server.product.services.mappers;
+
+import com.cashmanager.server.common.dto.ProductDto;
+import com.cashmanager.server.shop_database.entities.Product;
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+
+@Mapper
+public interface ProductMapper {
+
+    ProductMapper INSTANCE = Mappers.getMapper(ProductMapper.class);
+
+    /**
+     * Function that convert the entity Product to the ProductDto
+     * @param product : the product that will be converted
+     * @return productDto that result from the conversion
+     */
+    ProductDto productToProductDto(Product product);
+
+    /**
+     * Function that convert the dto ProductDto to the entity Product
+     * @param productDto : the dto that will be converted
+     * @return product that result from the conversion
+     */
+    Product productDtoToProduct(ProductDto productDto);
+}
diff --git a/Server/shop/shop_database/.gitignore b/Server/shop/shop_database/.gitignore
@@ -0,0 +1,33 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
diff --git a/Server/shop/shop_database/.mvn/wrapper/maven-wrapper.jar b/Server/shop/shop_database/.mvn/wrapper/maven-wrapper.jar
diff --git a/Server/shop/shop_database/.mvn/wrapper/maven-wrapper.properties b/Server/shop/shop_database/.mvn/wrapper/maven-wrapper.properties
@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
diff --git a/Server/shop/compose.yaml → Server/shop/shop_database/compose.yaml b/Server/shop/compose.yaml → Server/shop/shop_database/compose.yaml
@@ -3,9 +3,9 @@ services:
     image: 'postgres:16.1-alpine'
     volumes:
       - 'db:/var/lib/postgres/data'
-      - '../init-shop-db.sh:/docker-entrypoint-initdb.d/init-shop-db.sh'
+      - '../../init-shop-db.sh:/docker-entrypoint-initdb.d/init-shop-db.sh'
     env_file:
-      - ../.env.local
+      - ../../.env.local
     ports:
       - '5432:5432'
 volumes: