Feature - Added support for HTTP DELETE method (#12)

.gitignore

@@ -51,3 +51,6 @@ nbdist/
 .DS_Store
 **.swap
 ~          
+
+# Eclipse #
+/bin/

pom.xml

@@ -28,7 +28,7 @@
 		<junit.version>4.12</junit.version>
 		<start-class>parrot.rest.ParrotRestApplication</start-class>
 		<docker.image.name>parrot-rest</docker.image.name>
-		<asciidoctor-plugin.version>1.5.3</asciidoctor-plugin.version>
+		<asciidoctor-plugin.version>1.5.6</asciidoctor-plugin.version>
 		<snippetsDirectory>${project.build.directory}/snippets</snippetsDirectory>
 		<asciidoc.source.dir>src/main/asciidocs</asciidoc.source.dir>
 		<asciidoc.output.dir>docs/release</asciidoc.output.dir>

src/main/asciidocs/api-guide.adoc

@@ -22,6 +22,9 @@ Parrot-REST application is a simple application that exposes to RESTs endpoints.
 
 | `POST`
 | Used to create a new resource
+
+|`DELETE`
+| Used to delete a resource
 |===
 
 Parrot-REST tries to adhere as closely as possible to standard HTTP and REST conventions in its
@@ -116,4 +119,47 @@ include::{snippets}/talk-example/http-request.adoc[]
 
 === CURL request
 
-include::{snippets}/talk-example/curl-request.adoc[]
+include::{snippets}/talk-example/curl-request.adoc[]
+
+[[resources-forget]]
+== Forget
+
+The forget provides the ability to remove existing responses which were posted by the listen resource.
+
+[[resources-forget-access]]
+== Accessing the forget
+
+A `DLETE` request is used to access the forget
+
+[[forget-existing-resource]]
+=== Forget an existing resource
+
+==== Example response
+
+include::{snippets}/forget-example/http-response.adoc[]
+
+==== Example request
+
+include::{snippets}/forget-example/http-request.adoc[]
+
+==== CURL request
+
+include::{snippets}/forget-example/curl-request.adoc[]
+
+[[forget-non-existing-resource]]
+=== Forget a non-existing resource
+
+==== Example response
+
+include::{snippets}/forget-non-existing-resource-example/http-response.adoc[]
+
+==== Example request
+
+include::{snippets}/forget-non-existing-resource-example/http-request.adoc[]
+
+==== CURL request
+
+include::{snippets}/forget-non-existing-resource-example/curl-request.adoc[]
+
+
+

src/main/java/parrot/rest/common/PhraseUtility.java

@@ -0,0 +1,44 @@
+package parrot.rest.common;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.servlet.http.HttpServletRequest;
+
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.web.servlet.HandlerMapping;
+
+/**
+ * 
+ * @author Isuru Weerasooriya
+ *
+ */
+public class PhraseUtility {
+
+	private PhraseUtility() {
+	}
+
+	public static String getFullUrl(HttpServletRequest request, Pattern urlPattern) {
+		StringBuilder builder = new StringBuilder();
+		String fullUrl = (String) request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
+		String url = getAppContextUrl(fullUrl, urlPattern);
+		if (url == null) {
+			return null;
+		}
+		builder.append(url);
+		if (StringUtils.isNotEmpty(request.getQueryString())) {
+			builder.append("?");
+			builder.append(request.getQueryString());
+		}
+		return builder.toString();
+	}
+
+	public static String getAppContextUrl(String fullUrl, Pattern urlPattern) {
+		Matcher matcher = urlPattern.matcher(fullUrl);
+		if (matcher.matches() && matcher.groupCount() > 0) {
+			return matcher.group(1);
+		}
+		return null;
+	}
+
+}

src/main/java/parrot/rest/controller/ForgetController.java

@@ -0,0 +1,50 @@
+package parrot.rest.controller;
+
+import java.util.regex.Pattern;
+
+import javax.servlet.http.HttpServletRequest;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.DeleteMapping;
+
+import parrot.rest.common.PhraseUtility;
+import parrot.rest.exception.UrlNotFoundException;
+import parrot.rest.service.PhraseService;
+
+/**
+ * 
+ * @author Isuru Weerasooriya
+ *
+ */
+@Controller(ForgetController.PATH)
+public class ForgetController {
+
+	public static final String PATH = "forget";
+
+	private static final Logger logger = LoggerFactory.getLogger(ForgetController.class);
+	private static final Pattern URL_PATTERN = Pattern.compile("\\/{0,1}forget\\/(.*)");
+
+	@Autowired
+	private PhraseService phraseService;
+
+	@DeleteMapping("forget/**")
+	public ResponseEntity<String> forget(HttpServletRequest request) {
+		ResponseEntity<String> result = null;
+		String url = PhraseUtility.getFullUrl(request, URL_PATTERN);
+
+		logger.debug("Forgetting URL: {}", url);
+		try {
+			phraseService.remove(url);
+			result = new ResponseEntity<>("OK", HttpStatus.OK);
+		} catch (UrlNotFoundException e) {
+			result = new ResponseEntity<>("NO_CONTENT", HttpStatus.NO_CONTENT);
+		}
+		return result;
+	}
+
+}

src/main/java/parrot/rest/controller/HealthController.java

@@ -1,6 +1,3 @@
-/**
- * 
- */
 package parrot.rest.controller;
 
 import org.springframework.http.HttpStatus;
@@ -16,7 +13,6 @@
 @Controller("health")
 public class HealthController {
 
-
 	@GetMapping
 	public ResponseEntity<String> listen() {
 		return new ResponseEntity<>("I'm a healthy parrot, do you have sunflower seeds for me?", HttpStatus.OK);

src/main/java/parrot/rest/controller/ListenController.java

@@ -1,6 +1,3 @@
-/**
- * 
- */
 package parrot.rest.controller;
 
 import org.slf4j.Logger;

src/main/java/parrot/rest/controller/TalkController.java

@@ -1,6 +1,5 @@
 package parrot.rest.controller;
 
-import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import javax.servlet.http.HttpServletRequest;
@@ -14,8 +13,8 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
-import org.springframework.web.servlet.HandlerMapping;
 
+import parrot.rest.common.PhraseUtility;
 import parrot.rest.exception.UrlNotFoundException;
 import parrot.rest.service.PhraseService;
 
@@ -28,45 +27,22 @@
 public class TalkController {
 
 	public static final String PATH = "talk";
-	
+
 	private static final Logger logger = LoggerFactory.getLogger(TalkController.class);
 	private static final Pattern URL_PATTERN = Pattern.compile("\\/{0,1}talk\\/(.*)");
-	
+
 	@Autowired
 	private PhraseService phraseService;
-	
+
 	@GetMapping("talk/**")
 	@ResponseBody
 	public ResponseEntity<String> talk(HttpServletRequest request) throws UrlNotFoundException {
-		String url = getFullUrl(request);
-		
+		String url = PhraseUtility.getFullUrl(request, URL_PATTERN);
+
 		logger.debug("Talking URL: {}", url);
 		if (StringUtils.isEmpty(url)) {
 			throw new UrlNotFoundException(url);
 		}
 		return new ResponseEntity<>(phraseService.getResponse(url), HttpStatus.OK);
 	}
-
-  private String getFullUrl(HttpServletRequest request) {
-    StringBuilder builder = new StringBuilder();
-    String fullUrl = (String)request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
-    String url = getAppContextUrl(fullUrl);
-    if (url == null) {
-      return null;
-    }
-    builder.append(url);    
-    if (StringUtils.isNotEmpty(request.getQueryString())) {
-      builder.append("?");
-      builder.append(request.getQueryString());
-    }
-    return builder.toString();
-  }
-
-	private String getAppContextUrl(String fullUrl) {
-		Matcher matcher = URL_PATTERN.matcher(fullUrl);
-		if (matcher.matches() && matcher.groupCount() > 0) {
-			return matcher.group(1);
-		}
-		return null;
-	}
 }

src/main/java/parrot/rest/repository/PhraseRepository.java

@@ -6,7 +6,7 @@
 import parrot.rest.common.Phrase;
 
 /**
- * @author gamezd
+ * @author David Gamez, Isuru Weerasooriya
  *
  */
 public interface PhraseRepository {
@@ -15,4 +15,6 @@ public interface PhraseRepository {
 
 	Phrase load(String fullUrl);
 
+	Phrase delete(String fullUrl);
+
 }

src/main/java/parrot/rest/repository/PhraseRepositoryBase.java

@@ -8,6 +8,7 @@
 import parrot.rest.common.Phrase;
 
 /**
+ * @author David Gamez
  *
  */
 public abstract class PhraseRepositoryBase  implements PhraseRepository {

src/main/java/parrot/rest/repository/PhraseRepositoryMapImpl.java

@@ -12,6 +12,7 @@
 import parrot.rest.common.Phrase;
 
 /**
+ * @author David Gamez, Isuru Weerasooriya
  *
  */
 @Component
@@ -30,4 +31,9 @@ public Phrase load(String fullUrl) {
     return map.get(getIdFromUrl(fullUrl));
   }
 
+  @Override
+  public Phrase delete(String fullUrl) {
+	  return map.remove(getIdFromUrl(fullUrl));
+  }
+
 }

src/main/java/parrot/rest/repository/PhraseRepositoryRedisImpl.java

@@ -12,7 +12,7 @@
 import parrot.rest.common.Phrase;
 
 /**
- * @author David Gamez
+ * @author David Gamez, Isuru Weerasooriya
  *
  */
 @Component
@@ -37,5 +37,13 @@ public Phrase load(String url) {
 		return (Phrase) getHashOps().get(Phrase.class.getName(), getIdFromUrl(url));
 	}
 
-
+	@Override
+	public Phrase delete(String url) {
+		Phrase result = load(url);
+		if (result != null) {
+			getHashOps().delete(Phrase.class.getName(), getIdFromUrl(url));
+		}
+		return result;
+	}
+
 }

src/main/java/parrot/rest/service/PhraseService.java

@@ -15,4 +15,6 @@ public interface PhraseService {
 	Phrase save(Phrase phrase);
 
 	String getResponse(String url) throws UrlNotFoundException;
+
+	Phrase remove(String url) throws UrlNotFoundException;
 }

src/main/java/parrot/rest/service/PhraseServiceImpl.java

@@ -1,6 +1,3 @@
-/**
- * 
- */
 package parrot.rest.service;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -28,6 +25,7 @@ public Phrase save(Phrase phrase) {
 		return phraseRepository.save(phrase);
 	}
 
+
 	/* (non-Javadoc)
 	 * @see parrot.rest.repository.PhraseService#get(java.lang.String, java.lang.String)
 	 */
@@ -40,4 +38,14 @@ public String getResponse(String url) throws UrlNotFoundException {
 
 		return result.getResponse();
 	}
+
+
+	@Override
+	public Phrase remove(String url) throws UrlNotFoundException {
+		Phrase result = phraseRepository.delete(url);
+		if (result == null) {
+			throw new UrlNotFoundException(url);
+		}
+		return result;
+	}
 }

src/main/resources/application.properties

@@ -8,4 +8,9 @@ server.contextPath=/api
 persistent.type=MAP
 
 #REDIS
-spring.redis.url=http://localhost:6379
+spring.redis.url=http://localhost:6379
+
+---
+# local profile
+spring.profiles=local
+server.port=10010