Add APIs project & Utils Project

mohamed-taman · mohamed-taman · commit 3d58057031f1 · 2020-03-29T23:27:47.000+02:00
- store-api project the shared Springy store contracts DTOs and API Interfaces.
- store-util project is the shared functionality across microservices.
diff --git a/product-composite-service/pom.xml b/product-composite-service/pom.xml
@@ -6,7 +6,6 @@
 		<groupId>com.siriusxi.ms.store</groupId>
 		<artifactId>store-chassis</artifactId>
 		<version>0.0.1-SNAPSHOT</version>
-		<relativePath>/</relativePath> <!-- lookup parent from repository -->
 	</parent>
 	
 	<artifactId>product-composite-service</artifactId>
diff --git a/product-service/pom.xml b/product-service/pom.xml
@@ -6,7 +6,6 @@
 		<groupId>com.siriusxi.ms.store</groupId>
 		<artifactId>store-chassis</artifactId>
 		<version>0.0.1-SNAPSHOT</version>
-		<relativePath>/</relativePath> <!-- lookup parent from repository -->
 	</parent>
 	
 	<artifactId>product-service</artifactId>
diff --git a/recommendation-service/pom.xml b/recommendation-service/pom.xml
@@ -6,7 +6,6 @@
 		<groupId>com.siriusxi.ms.store</groupId>
 		<artifactId>store-chassis</artifactId>
 		<version>0.0.1-SNAPSHOT</version>
-		<relativePath>/</relativePath> <!-- lookup parent from repository -->
 	</parent>
 	
 	<artifactId>recommendation-service</artifactId>
diff --git a/review-service/pom.xml b/review-service/pom.xml
@@ -6,7 +6,6 @@
 		<groupId>com.siriusxi.ms.store</groupId>
 		<artifactId>store-chassis</artifactId>
 		<version>0.0.1-SNAPSHOT</version>
-		<relativePath>/</relativePath> <!-- lookup parent from repository -->
 	</parent>
 	
 	<artifactId>review-service</artifactId>
diff --git a/store-api/pom.xml b/store-api/pom.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.siriusxi.ms.store</groupId>
+    <artifactId>store-api</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <name>Springy Store APIs</name>
+    <description>Project that define all Springy Store DTOs and REST APIs contracts</description>
+
+    <properties>
+        <java.version>14</java.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <!-- Libraries versions -->
+        <spring.boot.dependencies.version>2.2.3.BUILD-SNAPSHOT</spring.boot.dependencies.version>
+        <maven.compiler.plugin.version>3.8.1</maven.compiler.plugin.version>
+        <maven.surefire.plugin.version>3.0.0-M4</maven.surefire.plugin.version>
+        <maven.failsafe.plugin.version>3.0.0-M4</maven.failsafe.plugin.version>
+
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-dependencies</artifactId>
+                <version>${spring.boot.dependencies.version}</version>
+                <scope>import</scope>
+                <type>pom</type>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>${maven.compiler.plugin.version}</version>
+                <configuration>
+                    <release>${java.version}</release>
+                    <compilerArgs>
+                        --enable-preview
+                    </compilerArgs>
+                </configuration>
+            </plugin>
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${maven.surefire.plugin.version}</version>
+                <configuration>
+                    <argLine>
+                        --enable-preview
+                    </argLine>
+                </configuration>
+            </plugin>
+            <plugin>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>${maven.failsafe.plugin.version}</version>
+                <configuration>
+                    <argLine>
+                        --enable-preview
+                    </argLine>
+                </configuration>
+            </plugin>
+        </plugins>
+
+    </build>
+</project>
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/ProductCompositeService.java b/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/ProductCompositeService.java
@@ -0,0 +1,19 @@
+package com.siriusxi.ms.store.api.composite.product;
+
+import com.siriusxi.ms.store.api.composite.product.dto.ProductAggregate;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+
+public interface ProductCompositeService {
+
+    /**
+     * Sample usage: curl $HOST:$PORT/product-composite/1
+     *
+     * @param productId is the product that you are looking for.
+     * @return the composite product info, if found, else null.
+     */
+    @GetMapping(
+            value    = "/product-composite/{productId}",
+            produces = "application/json")
+    ProductAggregate getProduct(@PathVariable int productId);
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/ProductAggregate.java b/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/ProductAggregate.java
@@ -0,0 +1,12 @@
+package com.siriusxi.ms.store.api.composite.product.dto;
+
+import java.util.List;
+
+public record ProductAggregate(
+        int productId,
+        String name,
+        int weight,
+        List<RecommendationSummary> recommendations,
+        List<ReviewSummary>reviews,
+        ServiceAddresses serviceAddresses) {
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/RecommendationSummary.java b/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/RecommendationSummary.java
@@ -0,0 +1,7 @@
+package com.siriusxi.ms.store.api.composite.product.dto;
+
+public record RecommendationSummary(
+        int recommendationId,
+        String author,
+        int rate) {
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/ReviewSummary.java b/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/ReviewSummary.java
@@ -0,0 +1,7 @@
+package com.siriusxi.ms.store.api.composite.product.dto;
+
+public record ReviewSummary(
+        int reviewId,
+        String author,
+        String subject) {
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/ServiceAddresses.java b/store-api/src/main/java/com/siriusxi/ms/store/api/composite/product/dto/ServiceAddresses.java
@@ -0,0 +1,8 @@
+package com.siriusxi.ms.store.api.composite.product.dto;
+
+public record ServiceAddresses(
+        String cmp,
+        String pro,
+        String rev,
+        String rec) {
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/core/product/Product.java b/store-api/src/main/java/com/siriusxi/ms/store/api/core/product/Product.java
@@ -0,0 +1,14 @@
+package com.siriusxi.ms.store.api.core.product;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Data
+@NoArgsConstructor(force = true)
+public class Product {
+    private final int productId;
+    private final String name;
+    private final int weight;
+    private final String serviceAddress;
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/core/product/ProductService.java b/store-api/src/main/java/com/siriusxi/ms/store/api/core/product/ProductService.java
@@ -0,0 +1,17 @@
+package com.siriusxi.ms.store.api.core.product;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+
+public interface ProductService {
+    /**
+     * Sample usage: curl $HOST:$PORT/product/1
+     *
+     * @param productId is the product that you are looking for.
+     * @return the product, if found, else null.
+     */
+    @GetMapping(
+            value    = "/product/{productId}",
+            produces =  "application/json")
+    Product getProduct(@PathVariable int productId);
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/core/recommendation/Recommendation.java b/store-api/src/main/java/com/siriusxi/ms/store/api/core/recommendation/Recommendation.java
@@ -0,0 +1,15 @@
+package com.siriusxi.ms.store.api.core.recommendation;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor(force = true)
+public class Recommendation {
+    private final int productId;
+    private final int recommendationId;
+    private final String author;
+    private final int rate;
+    private final String content;
+    private final String serviceAddress;
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/core/recommendation/RecommendationService.java b/store-api/src/main/java/com/siriusxi/ms/store/api/core/recommendation/RecommendationService.java
@@ -0,0 +1,23 @@
+package com.siriusxi.ms.store.api.core.recommendation;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import java.util.List;
+
+public interface RecommendationService {
+
+    /**
+     * Sample usage: curl $HOST:$PORT/recommendation?productId=1
+     *
+     * @param productId that you are looking for its recommendations.
+     * @return list of recommendations for this product,
+     * or empty list if there are no recommendations.
+     */
+    @GetMapping(
+            value = "/recommendation",
+            produces = "application/json")
+    List<Recommendation> getRecommendations(
+            @RequestParam(value = "productId")
+                    int productId);
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/core/review/Review.java b/store-api/src/main/java/com/siriusxi/ms/store/api/core/review/Review.java
@@ -0,0 +1,10 @@
+package com.siriusxi.ms.store.api.core.review;
+
+public record Review(
+        int productId,
+        int reviewId,
+        String author,
+        String subject,
+        String content,
+        String serviceAddress) {
+}
diff --git a/store-api/src/main/java/com/siriusxi/ms/store/api/core/review/ReviewService.java b/store-api/src/main/java/com/siriusxi/ms/store/api/core/review/ReviewService.java
@@ -0,0 +1,20 @@
+package com.siriusxi.ms.store.api.core.review;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import java.util.List;
+
+public interface ReviewService {
+
+    /**
+     * Sample usage: curl $HOST:$PORT/review?productId=1
+     *
+     * @param productId that you are looking for its reviews.
+     * @return list of reviews for this product,
+     *         or empty list if there are no reviews.
+     */
+    @GetMapping(
+            value    = "/review",
+            produces = "application/json")
+    List<Review> getReviews(@RequestParam(value = "productId") int productId);
+}
diff --git a/store-chassis/pom.xml b/store-chassis/pom.xml
diff --git a/store-utils/pom.xml b/store-utils/pom.xml
diff --git a/store-utils/src/main/java/com/siriusxi/ms/store/util/exceptions/InvalidInputException.java b/store-utils/src/main/java/com/siriusxi/ms/store/util/exceptions/InvalidInputException.java
diff --git a/store-utils/src/main/java/com/siriusxi/ms/store/util/exceptions/NotFoundException.java b/store-utils/src/main/java/com/siriusxi/ms/store/util/exceptions/NotFoundException.java
diff --git a/store-utils/src/main/java/com/siriusxi/ms/store/util/http/GlobalControllerExceptionHandler.java b/store-utils/src/main/java/com/siriusxi/ms/store/util/http/GlobalControllerExceptionHandler.java
diff --git a/store-utils/src/main/java/com/siriusxi/ms/store/util/http/HttpErrorInfo.java b/store-utils/src/main/java/com/siriusxi/ms/store/util/http/HttpErrorInfo.java
diff --git a/store-utils/src/main/java/com/siriusxi/ms/store/util/http/ServiceUtil.java b/store-utils/src/main/java/com/siriusxi/ms/store/util/http/ServiceUtil.java
