fix query parameter encoding

Author: lbalmaceda

build.gradle

@@ -59,13 +59,13 @@ test {
 }
 
 dependencies {
-    compile 'com.squareup.okhttp3:okhttp:3.5.0'
-    compile 'com.squareup.okhttp3:logging-interceptor:3.5.0'
+    compile 'com.squareup.okhttp3:okhttp:3.7.0'
+    compile 'com.squareup.okhttp3:logging-interceptor:3.7.0'
     compile 'com.fasterxml.jackson.core:jackson-databind:2.8.5'
     compile 'commons-codec:commons-codec:1.10'
 
     testCompile 'org.mockito:mockito-core:2.5.4'
-    testCompile 'com.squareup.okhttp3:mockwebserver:3.5.0'
+    testCompile 'com.squareup.okhttp3:mockwebserver:3.7.0'
     testCompile 'org.hamcrest:hamcrest-core:1.3'
     testCompile 'org.hamcrest:hamcrest-library:1.3'
     testCompile 'junit:junit:4.11'

src/main/java/com/auth0/client/mgmt/LogEventsEntity.java

@@ -12,6 +12,8 @@
 
 import java.util.Map;
 
+import static com.auth0.client.mgmt.filter.QueryFilter.KEY_QUERY;
+
 /**
  * Class that provides an implementation of the Events methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Logs
  */
@@ -35,7 +37,11 @@ public Request<LogEventsPage> list(LogEventFilter filter) {
                 .addPathSegments("api/v2/logs");
         if (filter != null) {
             for (Map.Entry<String, Object> e : filter.getAsMap().entrySet()) {
-                builder.addQueryParameter(e.getKey(), String.valueOf(e.getValue()));
+                if (KEY_QUERY.equals(e.getKey())) {
+                    builder.addEncodedQueryParameter(e.getKey(), String.valueOf(e.getValue()));
+                } else {
+                    builder.addQueryParameter(e.getKey(), String.valueOf(e.getValue()));
+                }
             }
         }
         String url = builder.build().toString();

src/main/java/com/auth0/client/mgmt/UsersEntity.java

@@ -20,6 +20,8 @@
 import java.util.List;
 import java.util.Map;
 
+import static com.auth0.client.mgmt.filter.QueryFilter.KEY_QUERY;
+
 /**
  * Class that provides an implementation of the Users methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Users
  */
@@ -44,7 +46,11 @@ public Request<UsersPage> list(UserFilter filter) {
                 .addPathSegments("api/v2/users");
         if (filter != null) {
             for (Map.Entry<String, Object> e : filter.getAsMap().entrySet()) {
-                builder.addQueryParameter(e.getKey(), String.valueOf(e.getValue()));
+                if (KEY_QUERY.equals(e.getKey())) {
+                    builder.addEncodedQueryParameter(e.getKey(), String.valueOf(e.getValue()));
+                } else {
+                    builder.addQueryParameter(e.getKey(), String.valueOf(e.getValue()));
+                }
             }
         }
         String url = builder.build().toString();

src/main/java/com/auth0/client/mgmt/filter/LogEventFilter.java

@@ -1,5 +1,7 @@
 package com.auth0.client.mgmt.filter;
 
+import java.io.UnsupportedEncodingException;
+
 /**
  * Class used to filter the results received when calling the Logs endpoint. Related to the {@link com.auth0.client.mgmt.LogEventsEntity} entity.
  */
@@ -25,7 +27,7 @@ public LogEventFilter withTotals(boolean includeTotals) {
     }
 
     @Override
-    public LogEventFilter withQuery(String query) {
+    public LogEventFilter withQuery(String query) throws UnsupportedEncodingException {
         super.withQuery(query);
         return this;
     }

src/main/java/com/auth0/client/mgmt/filter/QueryFilter.java

@@ -1,15 +1,21 @@
 package com.auth0.client.mgmt.filter;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+
 public class QueryFilter extends FieldsFilter {
 
+    public static final String KEY_QUERY = "q";
+
     /**
      * Filter by a query
      *
      * @param query the query expression using the following syntax https://auth0.com/docs/api/management/v2/query-string-syntax.
      * @return this filter instance
      */
-    public QueryFilter withQuery(String query) {
-        parameters.put("q", query);
+    public QueryFilter withQuery(String query) throws UnsupportedEncodingException {
+        String encodedQuery = URLEncoder.encode(query, "UTF-8");
+        parameters.put(KEY_QUERY, encodedQuery);
         return this;
     }
 

src/main/java/com/auth0/client/mgmt/filter/UserFilter.java

@@ -1,5 +1,7 @@
 package com.auth0.client.mgmt.filter;
 
+import java.io.UnsupportedEncodingException;
+
 /**
  * Class used to filter the results received when calling the Users endpoint. Related to the {@link com.auth0.client.mgmt.UsersEntity} entity.
  */
@@ -19,7 +21,7 @@ public UserFilter withTotals(boolean includeTotals) {
     }
 
     @Override
-    public UserFilter withQuery(String query) {
+    public UserFilter withQuery(String query) throws UnsupportedEncodingException {
         super.withQuery(query);
         return this;
     }

src/test/java/com/auth0/client/mgmt/LogEventsEntityTest.java

@@ -95,7 +95,7 @@ public void shouldListLogEventsWithSort() throws Exception {
 
     @Test
     public void shouldListLogEventsWithQuery() throws Exception {
-        LogEventFilter filter = new LogEventFilter().withQuery("sample");
+        LogEventFilter filter = new LogEventFilter().withQuery("email:\\*@gmail.com");
         Request<LogEventsPage> request = api.logEvents().list(filter);
         assertThat(request, is(notNullValue()));
 
@@ -106,13 +106,12 @@ public void shouldListLogEventsWithQuery() throws Exception {
         assertThat(recordedRequest, hasMethodAndPath("GET", "/api/v2/logs"));
         assertThat(recordedRequest, hasHeader("Content-Type", "application/json"));
         assertThat(recordedRequest, hasHeader("Authorization", "Bearer apiToken"));
-        assertThat(recordedRequest, hasQueryParameter("q", "sample"));
+        assertThat(recordedRequest, hasQueryParameter("q", "email%3A%5C*%40gmail.com"));
 
         assertThat(response, is(notNullValue()));
         assertThat(response.getItems(), hasSize(2));
     }
 
-
     @Test
     public void shouldListLogEventsWithCheckpoint() throws Exception {
         LogEventFilter filter = new LogEventFilter().withCheckpoint("id3", 5);

src/test/java/com/auth0/client/mgmt/UsersEntityTest.java

@@ -104,7 +104,7 @@ public void shouldListUsersWithSort() throws Exception {
 
     @Test
     public void shouldListUsersWithQuery() throws Exception {
-        UserFilter filter = new UserFilter().withQuery("sample");
+        UserFilter filter = new UserFilter().withQuery("email:\\*@gmail.com");
         Request<UsersPage> request = api.users().list(filter);
         assertThat(request, is(notNullValue()));
 
@@ -116,7 +116,7 @@ public void shouldListUsersWithQuery() throws Exception {
         assertThat(recordedRequest, hasHeader("Content-Type", "application/json"));
         assertThat(recordedRequest, hasHeader("Authorization", "Bearer apiToken"));
         assertThat(recordedRequest, hasQueryParameter("search_engine", "v2"));
-        assertThat(recordedRequest, hasQueryParameter("q", "sample"));
+        assertThat(recordedRequest, hasQueryParameter("q", "email%3A%5C*%40gmail.com"));
 
         assertThat(response, is(notNullValue()));
         assertThat(response.getItems(), hasSize(2));

src/test/java/com/auth0/client/mgmt/filter/LogEventFilterTest.java

@@ -42,7 +42,7 @@ public void shouldFilterByQuery() throws Exception {
 
         assertThat(filter, is(instance));
         assertThat(filter.getAsMap(), is(notNullValue()));
-        assertThat(filter.getAsMap(), Matchers.hasEntry("q", (Object) "id=log123"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("q", (Object) "id%3Dlog123"));
     }
 
     @Test

src/test/java/com/auth0/client/mgmt/filter/QueryFilterTest.java

@@ -32,7 +32,7 @@ public void shouldFilterByQuery() throws Exception {
 
         assertThat(filter, is(instance));
         assertThat(filter.getAsMap(), is(notNullValue()));
-        assertThat(filter.getAsMap(), Matchers.hasEntry("q", (Object) "id=log123"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("q", (Object) "id%3Dlog123"));
     }
 
     @Test