Merge pull request #3 from trendyol-data-eng-summer-intern-2019/dev

yasinuygun · web-flow · commit 44502fc41882 · 2019-07-19T09:23:20.000+03:00
Dev
diff --git a/pom.xml b/pom.xml
@@ -9,7 +9,7 @@
         <relativePath/>
     </parent>
     <groupId>com.trendyol</groupId>
-    <artifactId>recom-engine</artifactId>
+    <artifactId>recom-engine-web-service</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <name>recom-engine</name>
     <description>Demo project for Spring Boot</description>
@@ -28,7 +28,6 @@
             <groupId>org.springframework.kafka</groupId>
             <artifactId>spring-kafka</artifactId>
         </dependency>
-
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
diff --git a/src/main/java/com/trendyol/recomengine/webservice/controller/RecommendationController.java b/src/main/java/com/trendyol/recomengine/webservice/controller/RecommendationController.java
@@ -0,0 +1,31 @@
+package com.trendyol.recomengine.webservice.controller;
+
+import com.trendyol.recomengine.webservice.model.Recommendation;
+import com.trendyol.recomengine.webservice.service.RecommendationService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Handles GET requests that contains that contain user id's. Fetches recommendations from database and returns them.
+ */
+@RestController
+class RecommendationController {
+
+    @Autowired
+    RecommendationService recommendationService;
+
+    /**
+     * This method is called when a GET request happens. Fetches recommendations from database for the user that is
+     * specified in the argument.
+     *
+     * @param userId The user's id who sends the GET request.
+     * @return If there is a recommendation list for the user in the database, returns it. Otherwise, returns a default
+     * recommendation list using generateDefaultRecommendations.
+     */
+    @GetMapping("/users/{userId}/recommendations")
+    Recommendation getRecommendation(@PathVariable String userId) {
+        return recommendationService.getRecommendations(userId);
+    }
+}
diff --git a/src/main/java/com/trendyol/recomengine/webservice/controller/ReviewController.java b/src/main/java/com/trendyol/recomengine/webservice/controller/ReviewController.java
@@ -1,8 +1,8 @@
-package com.trendyol.recomengine.webservice.controllers;
+package com.trendyol.recomengine.webservice.controller;
 
 import com.trendyol.recomengine.webservice.engine.Producer;
-import com.trendyol.recomengine.webservice.resource.Review;
-import com.trendyol.recomengine.webservice.resource.ReviewWithoutUserId;
+import com.trendyol.recomengine.webservice.model.Review;
+import com.trendyol.recomengine.webservice.model.ReviewWithoutUserId;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -25,14 +25,15 @@ public class ReviewController {
     /**
      * This method is called when a POST request happens. Validates the data in the request body using validateReview
      * and sends them to Kafka.
+     *
      * @param requestBody POST request's body which is converted to a ReviewWithoutUserId object.
      * @param userId      The user's id who sends the POST request.
      * @return If the request body is a valid review, the method returns the same review that is posted. Otherwise,
      * the method returns an error message which tells why the request body is invalid.
      * @see ReviewWithoutUserId
      */
     @PostMapping(value = "/users/{userId}/reviews")
-    public Object sendMessageToKafkaTopic(@Valid @RequestBody ReviewWithoutUserId requestBody, @PathVariable String userId) {
+    public Object createReview(@Valid @RequestBody ReviewWithoutUserId requestBody, @PathVariable String userId) {
         Review review = new Review(userId, requestBody);
 
         String dataToSendToKafka = String.format("%s,%s,%.1f,%d", userId, requestBody.getProductId(),
diff --git a/src/main/java/com/trendyol/recomengine/webservice/controllers/RecommendationController.java b/src/main/java/com/trendyol/recomengine/webservice/controllers/RecommendationController.java
diff --git a/src/main/java/com/trendyol/recomengine/webservice/engine/Producer.java b/src/main/java/com/trendyol/recomengine/webservice/engine/Producer.java
@@ -21,6 +21,7 @@ public class Producer {
     /**
      * Sends message to the default topic configured in the application.yml file. If the message is successfully sent
      * to the Kafka cluster, logs the produced message at INFO level.
+     *
      * @param message Message string to be sent to Kafka cluster's default topic.
      */
     public void sendMessage(String message) {
diff --git a/src/main/java/com/trendyol/recomengine/webservice/model/Recommendation.java b/src/main/java/com/trendyol/recomengine/webservice/model/Recommendation.java
@@ -1,4 +1,4 @@
-package com.trendyol.recomengine.webservice.resource;
+package com.trendyol.recomengine.webservice.model;
 
 import org.springframework.data.annotation.Id;
 import org.springframework.data.mongodb.core.mapping.Document;
@@ -21,7 +21,7 @@ public class Recommendation {
     private final String[] recommendations;
 
     /**
-     * @param _id The user's id who sends the POST request.
+     * @param _id             The user's id who sends the POST request.
      * @param recommendations Specific recommendations for the user
      */
     public Recommendation(String _id, String[] recommendations) {
diff --git a/src/main/java/com/trendyol/recomengine/webservice/model/Review.java b/src/main/java/com/trendyol/recomengine/webservice/model/Review.java
@@ -1,7 +1,7 @@
-package com.trendyol.recomengine.webservice.resource;
+package com.trendyol.recomengine.webservice.model;
 
 import javax.validation.constraints.NotBlank;
-import java.util.Date;
+import java.sql.Timestamp;
 
 /**
  * To keep reviews
@@ -12,18 +12,18 @@ public class Review extends ReviewWithoutUserId {
     private final String userId;
 
     /**
-     * @param userId User's id who reviewed
+     * @param userId    User's id who reviewed
      * @param productId Reviewed product's id
-     * @param score Reviewed score
-     * @param time Review timestamp
+     * @param score     Reviewed score
+     * @param time      Review timestamp
      */
-    public Review(String userId, String productId, float score, Date time) {
+    public Review(String userId, String productId, float score, Timestamp time) {
         super(productId, score, time);
         this.userId = userId;
     }
 
     /**
-     * @param userId User's id who reviewed
+     * @param userId              User's id who reviewed
      * @param reviewWithoutUserId ProductId, score and timestamp without user id
      */
     public Review(String userId, ReviewWithoutUserId reviewWithoutUserId) {
diff --git a/src/main/java/com/trendyol/recomengine/webservice/model/ReviewWithoutUserId.java b/src/main/java/com/trendyol/recomengine/webservice/model/ReviewWithoutUserId.java
@@ -1,7 +1,10 @@
-package com.trendyol.recomengine.webservice.resource;
+package com.trendyol.recomengine.webservice.model;
 
-import javax.validation.constraints.*;
-import java.util.Date;
+import javax.validation.constraints.DecimalMin;
+import javax.validation.constraints.Max;
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotNull;
+import java.sql.Timestamp;
 
 /**
  * To keep productId, score and timestamp without user id
@@ -11,17 +14,19 @@ public class ReviewWithoutUserId {
     @NotBlank
     private final String productId;
 
-    @DecimalMin(value = "0.5", inclusive = true) @Max(5)
+    @DecimalMin(value = "0.5")
+    @Max(5)
     private final float score;
 
-    private final Date timestamp;
+    @NotNull
+    private final Timestamp timestamp;
 
     /**
      * @param productId Reviewed product's id
-     * @param score Reviewed score
+     * @param score     Reviewed score
      * @param timestamp Review timestamp
      */
-    ReviewWithoutUserId(String productId, float score, Date timestamp) {
+    ReviewWithoutUserId(String productId, float score, Timestamp timestamp) {
         this.productId = productId;
         this.score = score;
         this.timestamp = timestamp;
@@ -44,7 +49,7 @@ public float getScore() {
     /**
      * @return Review timestamp in seconds
      */
-    public Date getTimestamp() {
+    public Timestamp getTimestamp() {
         return timestamp;
     }
 
diff --git a/src/main/java/com/trendyol/recomengine/webservice/repository/RecommendationRepository.java b/src/main/java/com/trendyol/recomengine/webservice/repository/RecommendationRepository.java
@@ -1,6 +1,6 @@
-package com.trendyol.recomengine.webservice.repositories;
+package com.trendyol.recomengine.webservice.repository;
 
-import com.trendyol.recomengine.webservice.resource.Recommendation;
+import com.trendyol.recomengine.webservice.model.Recommendation;
 import org.springframework.data.mongodb.repository.MongoRepository;
 
 /**
@@ -13,10 +13,11 @@ public interface RecommendationRepository extends MongoRepository<Recommendation
     /**
      * Searches for a document having the same _id with the method parameter in the specified collection of a specified
      * MongoDB database which are configured in the application.yml file.
+     *
      * @param _id Document id to be searched.
      * @return If the document is found, converts document to a Recommendation object and returns it; returns null
      * otherwise.
      */
     Recommendation findBy_id(String _id);
 
-}
+}
diff --git a/src/main/java/com/trendyol/recomengine/webservice/service/RecommendationService.java b/src/main/java/com/trendyol/recomengine/webservice/service/RecommendationService.java
@@ -0,0 +1,9 @@
+package com.trendyol.recomengine.webservice.service;
+
+import com.trendyol.recomengine.webservice.model.Recommendation;
+import org.springframework.stereotype.Service;
+
+@Service
+public interface RecommendationService {
+    Recommendation getRecommendations(String userId);
+}
diff --git a/src/main/java/com/trendyol/recomengine/webservice/service/impl/RecommendationServiceImpl.java b/src/main/java/com/trendyol/recomengine/webservice/service/impl/RecommendationServiceImpl.java
@@ -0,0 +1,33 @@
+package com.trendyol.recomengine.webservice.service.impl;
+
+import com.trendyol.recomengine.webservice.model.Recommendation;
+import com.trendyol.recomengine.webservice.repository.RecommendationRepository;
+import com.trendyol.recomengine.webservice.service.RecommendationService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+@Service
+public class RecommendationServiceImpl implements RecommendationService {
+    @Autowired
+    private RecommendationRepository repository;
+
+    public Recommendation getRecommendations(String userId) {
+        Recommendation fetched = repository.findBy_id(userId);
+        return fetched == null ? generateDefaultRecommendations(userId) : fetched;
+    }
+
+    /**
+     * Generates a default recommendation list for the user. For now, it returns 10 products' ids but default
+     * recommendations could be generated based on a criterion.
+     *
+     * @param userId The user id of the user that is to be recommended.
+     * @return A list of recommendations that is generated for the user.
+     * @see Recommendation
+     */
+    private Recommendation generateDefaultRecommendations(String userId) {
+        return new Recommendation(userId, new String[]{
+                "100", "101", "102", "103", "104",
+                "105", "106", "107", "108", "109"
+        });
+    }
+}
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -3,13 +3,13 @@ server:
 spring:
   data:
     mongodb:
-      host: mongo1
+      host: localhost
       port: 27017
       database: recom-engine
   kafka:
     template:
       default-topic: reviews
     producer:
-      bootstrap-servers: kafka1:19092
+      bootstrap-servers: localhost:9092
       key-serializer: org.apache.kafka.common.serialization.StringSerializer
       value-serializer: org.apache.kafka.common.serialization.StringSerializer
diff --git a/src/test/java/com/trendyol/recomengine/webservice/controller/RecommendationControllerTests.java b/src/test/java/com/trendyol/recomengine/webservice/controller/RecommendationControllerTests.java
@@ -0,0 +1,48 @@
+package com.trendyol.recomengine.webservice.controller;
+
+import com.trendyol.recomengine.webservice.model.Recommendation;
+import com.trendyol.recomengine.webservice.repository.RecommendationRepository;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.http.MediaType;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+import static org.hamcrest.Matchers.hasItems;
+import static org.mockito.BDDMockito.given;
+import static org.springframework.test.web.servlet.ResultMatcher.matchAll;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest
+@AutoConfigureMockMvc
+public class RecommendationControllerTests {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @MockBean
+    private RecommendationRepository repository;
+
+    @Test
+    public void getRecommendationShouldReturnUserIdAndRecommendations() throws Exception {
+        String userId = "3";
+        Recommendation mockResponse = new Recommendation(userId, new String[]{"1", "2", "3", "4", "5", "6", "7", "8", "9", "10"});
+        given(repository.findBy_id(userId)).willReturn(mockResponse);
+        this.mockMvc
+                .perform(get("/users/" + userId + "/recommendations"))
+                .andDo(print())
+                .andExpect(matchAll(
+                        status().isOk(),
+                        content().contentType(MediaType.APPLICATION_JSON_UTF8),
+                        jsonPath("$._id").value(userId),
+                        jsonPath("$.recommendations", hasItems(mockResponse.getRecommendations()))
+                ));
+    }
+}
diff --git a/src/test/java/com/trendyol/recomengine/webservice/controller/ReviewControllerTests.java b/src/test/java/com/trendyol/recomengine/webservice/controller/ReviewControllerTests.java
