Fixed transaction service, updated integration test suite

Author: harshbhardwaj

request-proxy-service/build.gradle

@@ -45,11 +45,15 @@ dependencies {
     testCompile(group: 'org.mockito', name: 'mockito-core', version: '2.18.0')
 
     compile group: 'com.google.code.gson', name: 'gson', version: '2.8.5'
-    implementation 'com.squareup.okhttp3:okhttp:3.14.6'
+    compile group: 'org.json', name: 'json', version: '20200518'
+
 
 
 }
 
 test {
     useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
 }

request-proxy-service/src/main/java/com/freshworks/requestproxy/constant/MessageConstants.java

@@ -6,6 +6,9 @@ public interface MessageConstants {
     public static final String MALFORMED_URL_STRUCTURE = "The Requested URL is not allowed as per the RFC protocol";
     public static final String MISSING_REQUEST_PARAMS = "Required Parameters are missing in a request";
     public static final String MAX_LIMIT_REACHED = "Maximum limit is reached to request the resource, please re-try after 1 minute";
-    public static final String SUCCESS = "Success";
-    public static final String FAILURE = "Failure";
+    public static final String REQUEST_TIMEOUT = "The Request has Timed Out";
+    public static final String CONNECTION_FAILED = "Connection failed, requesting url might not exist or refused to set up connection";
+    public static final String EXCEPTION = "Exception Occur while executing the request on the URL";
+    public static final String SUCCESS = "The request is successful";
+    public static final String FAILURE = "The request has failed";
 }

request-proxy-service/src/main/java/com/freshworks/requestproxy/entity/requestEntity/CommonRequest.java

@@ -1,23 +1,35 @@
 package com.freshworks.requestproxy.entity.requestEntity;
 
-import com.google.gson.JsonObject;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
+import org.json.JSONObject;
 
 import java.io.Serializable;
 
 @Data
+@ApiModel(description = "A common request entity for incoming request to replay by the system")
 public class CommonRequest implements Serializable {
 
+    @ApiModelProperty(value = "A client Id could be unique identifier for a requesting client")
     private Long clientId;
+
+    @ApiModelProperty(value = "A Url where the HTTPS request has to be made")
     private String url;
-    private JsonObject headers;
+
+    @ApiModelProperty(value = "Header that need to be sent along with URL")
+    private JSONObject headers;
+
+    @ApiModelProperty(value = "A request type, eg. GET, POST, PUT, DELETE, PATCH")
     private String request;
+
+    @ApiModelProperty(value = "A Body that has to be sent along with the URL")
     private String body;
 
     public CommonRequest() {
     }
 
-    public CommonRequest(Long clientId, String url, JsonObject headers, String request, String body) {
+    public CommonRequest(Long clientId, String url, JSONObject headers, String request, String body) {
         this.clientId = clientId;
         this.url = url;
         this.headers = headers;

request-proxy-service/src/main/java/com/freshworks/requestproxy/exception/InvalidUrlException.java

@@ -1,8 +1,12 @@
 package com.freshworks.requestproxy.model;
 
 public enum SupportedRequestTypes {
+
     POST("POST"),
-    GET("GET");
+    GET("GET"),
+    PUT("PUT"),
+    DELETE("DELETE"),
+    PATCH("PATCH");
 
     private String requestType;
 

request-proxy-service/src/main/java/com/freshworks/requestproxy/exception/MaxLimitExceededException.java

@@ -1,14 +1,19 @@
 package com.freshworks.requestproxy.model;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.Date;
 
 @Data
+@ApiModel("An Entity to capture or trace client activing on the proxy system")
 public class Transaction {
 
+    @ApiModelProperty(value = "Represents time when client access the system last")
     private Date accessTime;
 
+    @ApiModelProperty(value = "Represents the count, client requested the system already")
     private Integer accessCount;
 
     public Transaction() {

request-proxy-service/src/main/java/com/freshworks/requestproxy/exception/ValidationFailureException.java

@@ -3,6 +3,7 @@
 import com.freshworks.requestproxy.constant.CommonConstants;
 import com.freshworks.requestproxy.entity.requestEntity.CommonRequest;
 import com.freshworks.requestproxy.entity.responseEntity.CommonResponse;
+import com.freshworks.requestproxy.exception.RequestParseException;
 import com.freshworks.requestproxy.exception.RequestTimeoutException;
 import com.freshworks.requestproxy.service.ExecutionService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -26,7 +27,7 @@ public RequestProxyResource(ExecutionService executionService) {
     }
 
     @PostMapping
-    public CommonResponse<?> processRequest(@RequestBody CommonRequest commonRequest) throws RequestTimeoutException, IOException, URISyntaxException {
+    public CommonResponse<?> processRequest(@RequestBody CommonRequest commonRequest) throws RequestTimeoutException, URISyntaxException, IOException, RequestParseException {
         return executionService.executeRequest(commonRequest);
     }
 

request-proxy-service/src/main/java/com/freshworks/requestproxy/model/SupportedRequestTypes.java

@@ -2,13 +2,16 @@
 
 import com.freshworks.requestproxy.entity.requestEntity.CommonRequest;
 import com.freshworks.requestproxy.entity.responseEntity.CommonResponse;
+import com.freshworks.requestproxy.exception.RequestParseException;
 import com.freshworks.requestproxy.exception.RequestTimeoutException;
 
 import java.io.IOException;
-import java.net.MalformedURLException;
 import java.net.URISyntaxException;
 
+/**
+ * executeRequest method is used to execute the incoming request to replay with the Common request format
+ */
 public interface ExecutionService {
 
-    public CommonResponse<?> executeRequest(CommonRequest commonRequest) throws RequestTimeoutException, IOException, URISyntaxException;
+    public CommonResponse<?> executeRequest(CommonRequest commonRequest) throws RequestTimeoutException, IOException, URISyntaxException, RequestParseException;
 }