[breaking] params - url-decoding restx path by default.

if you want to keep old behaviour (no decoded path), simply @provide 'restx.http.decode.url.path.params' key with false value

Author: fcamblor

restx-core/src/main/java/restx/AbstractRequest.java

@@ -18,7 +18,7 @@
  * Time: 18:38
  */
 public abstract class AbstractRequest implements RestxRequest {
-    private final HttpSettings httpSettings;
+    protected final HttpSettings httpSettings;
 
     protected AbstractRequest(HttpSettings httpSettings) {
         this.httpSettings = httpSettings;

restx-core/src/main/java/restx/HttpSettings.java

@@ -21,4 +21,8 @@ public interface HttpSettings {
 
     @SettingsKey(key = "restx.http.gzip.paths", defaultValue = "/{s:.+}")
     Collection<String> gzipPaths();
+
+    @SettingsKey(key = "restx.http.decode.url.path.params", defaultValue = "true",
+            doc="Will issue a URLDecoder.decode() on every PATH parameters if true")
+    boolean decodeURLPathParams();
 }

restx-core/src/main/java/restx/HttpSettingsConfig.java

@@ -39,4 +39,9 @@ public Collection<String> gzipPaths() {
         return Splitter.on(",").trimResults().splitToList(
                 config.getString("restx.http.gzip.paths").or("/{s:.+}"));
     }
+
+    @Override
+    public boolean decodeURLPathParams() {
+        return config.getBoolean("restx.http.decode.url.path.params").or(Boolean.TRUE).booleanValue();
+    }
 }

restx-core/src/main/resources/restx/httpConfig.properties

@@ -15,4 +15,7 @@ restx.http.scheme=
 
 # the collection of RESTX paths on which gzip filter should be applied
 # to enable it on all resources, use `/{s:.+}`
-restx.http.gzip.paths=/{s:.+}
+restx.http.gzip.paths=/{s:.+}
+
+# Will issue a URLDecoder.decode() on restx path resolution
+restx.http.decode.url.path.params=true

restx-samplest/src/test/java/samplest/core/UrlParametersResourceTest.java

@@ -27,7 +27,7 @@ public class UrlParametersResourceTest {
     @Parameterized.Parameters(name="{0}")
     public static Iterable<Object[]> data(){
         return Arrays.asList(new Object[][]{
-                {"/v1/v2/35v4/v5", "a=v1 b=v2 c=35 d=v4 e=v5"}
+                {"/v1/hello%20world/35v4/v5", "a=v1 b=hello world c=35 d=v4 e=v5"},
         });
     }
 

restx-servlet/src/main/java/restx/servlet/HttpServletRestxRequest.java

@@ -1,6 +1,7 @@
 package restx.servlet;
 
 import com.google.common.base.Optional;
+import com.google.common.base.Throwables;
 import com.google.common.collect.*;
 import restx.AbstractRequest;
 import restx.HttpSettings;
@@ -11,6 +12,8 @@
 import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
 import java.util.Collections;
 import java.util.List;
 import java.util.Locale;
@@ -48,7 +51,15 @@ protected String getLocalScheme() {
 
     @Override
     public String getRestxPath() {
-        return request.getRequestURI().substring((getBaseApiPath()).length());
+        String restxPath = request.getRequestURI().substring((getBaseApiPath()).length());
+        if(this.httpSettings.decodeURLPathParams()) {
+            try {
+                restxPath = URLDecoder.decode(restxPath, "UTF-8");
+            } catch (UnsupportedEncodingException e) {
+                throw Throwables.propagate(e);
+            }
+        }
+        return restxPath;
     }
 
     @Override