remove BaseFilter generic type. Refactor other filters

lbalmaceda · lbalmaceda · commit b5a5dbfd4cf7 · 2017-01-27T15:34:32.000-03:00
diff --git a/src/main/java/com/auth0/client/mgmt/filter/BaseFilter.java b/src/main/java/com/auth0/client/mgmt/filter/BaseFilter.java
@@ -3,25 +3,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class BaseFilter<T extends BaseFilter> {
-    protected Map<String, Object> parameters;
-
-    protected BaseFilter() {
-        parameters = new HashMap<>();
-    }
-
-    /**
-     * Only retrieve certain fields from the item.
-     *
-     * @param fields        a list of comma separated fields to retrieve.
-     * @param includeFields whether to include or exclude in the response the fields that were given.
-     * @return this filter instance
-     */
-    public T withFields(String fields, boolean includeFields) {
-        parameters.put("fields", fields);
-        parameters.put("include_fields", includeFields);
-        return (T) this;
-    }
+public abstract class BaseFilter {
+    protected Map<String, Object> parameters = new HashMap<>();
 
     public Map<String, Object> getAsMap() {
         return parameters;
diff --git a/src/main/java/com/auth0/client/mgmt/filter/ConnectionFilter.java b/src/main/java/com/auth0/client/mgmt/filter/ConnectionFilter.java
@@ -3,7 +3,7 @@
 /**
  * Class used to filter the results received when calling the Connections endpoint. Related to the {@link com.auth0.client.mgmt.ConnectionsEntity()} entity.
  */
-public class ConnectionFilter extends BaseFilter<ConnectionFilter> {
+public class ConnectionFilter extends FieldsFilter {
 
     /**
      * Filter by strategy
@@ -40,4 +40,9 @@ public ConnectionFilter withPage(int pageNumber, int amountPerPage) {
         return this;
     }
 
+    @Override
+    public ConnectionFilter withFields(String fields, boolean includeFields) {
+        super.withFields(fields, includeFields);
+        return this;
+    }
 }
diff --git a/src/main/java/com/auth0/client/mgmt/filter/DeviceCredentialsFilter.java b/src/main/java/com/auth0/client/mgmt/filter/DeviceCredentialsFilter.java
@@ -3,7 +3,7 @@
 /**
  * Class used to filter the results received when calling the Device Credentials endpoint. Related to the {@link com.auth0.client.mgmt.DeviceCredentialsEntity()} entity.
  */
-public class DeviceCredentialsFilter extends BaseFilter<DeviceCredentialsFilter> {
+public class DeviceCredentialsFilter extends FieldsFilter {
 
     /**
      * Filter by user id
@@ -35,4 +35,9 @@ public DeviceCredentialsFilter withType(String type) {
         return this;
     }
 
+    @Override
+    public DeviceCredentialsFilter withFields(String fields, boolean includeFields) {
+        super.withFields(fields, includeFields);
+        return this;
+    }
 }
diff --git a/src/main/java/com/auth0/client/mgmt/filter/FieldsFilter.java b/src/main/java/com/auth0/client/mgmt/filter/FieldsFilter.java
@@ -3,5 +3,18 @@
 /**
  * Class used to filter the results received when calling an Auth0 endpoint.
  */
-public class FieldsFilter extends BaseFilter<FieldsFilter> {
+public class FieldsFilter extends BaseFilter {
+
+    /**
+     * Only retrieve certain fields from the item.
+     *
+     * @param fields        a list of comma separated fields to retrieve.
+     * @param includeFields whether to include or exclude in the response the fields that were given.
+     * @return this filter instance
+     */
+    public FieldsFilter withFields(String fields, boolean includeFields) {
+        parameters.put("fields", fields);
+        parameters.put("include_fields", includeFields);
+        return this;
+    }
 }
diff --git a/src/main/java/com/auth0/client/mgmt/filter/LogEventFilter.java b/src/main/java/com/auth0/client/mgmt/filter/LogEventFilter.java
@@ -3,7 +3,7 @@
 /**
  * Class used to filter the results received when calling the Logs endpoint. Related to the {@link com.auth0.client.mgmt.LogEventsEntity()} entity.
  */
-public class LogEventFilter extends QueryFilter<LogEventFilter> {
+public class LogEventFilter extends QueryFilter {
 
     /**
      * Filter by checkpoint
@@ -18,4 +18,33 @@ public LogEventFilter withCheckpoint(String from, int take) {
         return this;
     }
 
+    @Override
+    public LogEventFilter withTotals(boolean includeTotals) {
+        super.withTotals(includeTotals);
+        return this;
+    }
+
+    @Override
+    public LogEventFilter withQuery(String query) {
+        super.withQuery(query);
+        return this;
+    }
+
+    @Override
+    public LogEventFilter withSort(String sort) {
+        super.withSort(sort);
+        return this;
+    }
+
+    @Override
+    public LogEventFilter withPage(int pageNumber, int amountPerPage) {
+        super.withPage(pageNumber, amountPerPage);
+        return this;
+    }
+
+    @Override
+    public LogEventFilter withFields(String fields, boolean includeFields) {
+        super.withFields(fields, includeFields);
+        return this;
+    }
 }
diff --git a/src/main/java/com/auth0/client/mgmt/filter/QueryFilter.java b/src/main/java/com/auth0/client/mgmt/filter/QueryFilter.java
@@ -1,16 +1,16 @@
 package com.auth0.client.mgmt.filter;
 
-public abstract class QueryFilter<T extends QueryFilter> extends BaseFilter<T> {
+public class QueryFilter extends FieldsFilter {
 
     /**
      * 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 T withQuery(String query) {
+    public QueryFilter withQuery(String query) {
         parameters.put("q", query);
-        return (T) this;
+        return this;
     }
 
     /**
@@ -19,9 +19,9 @@ public T withQuery(String query) {
      * @param includeTotals whether to include or not the query summary.
      * @return this filter instance
      */
-    public T withTotals(boolean includeTotals) {
+    public QueryFilter withTotals(boolean includeTotals) {
         parameters.put("include_totals", includeTotals);
-        return (T) this;
+        return this;
     }
 
     /**
@@ -30,9 +30,9 @@ public T withTotals(boolean includeTotals) {
      * @param sort the field to use for sorting. Use 'field:order' where order is 1 for ascending and -1 for descending.
      * @return this filter instance
      */
-    public T withSort(String sort) {
+    public QueryFilter withSort(String sort) {
         parameters.put("sort", sort);
-        return (T) this;
+        return this;
     }
 
     /**
@@ -42,10 +42,16 @@ public T withSort(String sort) {
      * @param amountPerPage the amount of items per page to retrieve.
      * @return this filter instance
      */
-    public T withPage(int pageNumber, int amountPerPage) {
+    public QueryFilter withPage(int pageNumber, int amountPerPage) {
         parameters.put("page", pageNumber);
         parameters.put("per_page", amountPerPage);
-        return (T) this;
+        return this;
+    }
+
+    @Override
+    public QueryFilter withFields(String fields, boolean includeFields) {
+        super.withFields(fields, includeFields);
+        return this;
     }
 
 }
diff --git a/src/main/java/com/auth0/client/mgmt/filter/RulesFilter.java b/src/main/java/com/auth0/client/mgmt/filter/RulesFilter.java
@@ -3,7 +3,7 @@
 /**
  * Class used to filter the results received when calling the Rules endpoint. Related to the {@link com.auth0.client.mgmt.RulesEntity()} entity.
  */
-public class RulesFilter extends BaseFilter<RulesFilter> {
+public class RulesFilter extends FieldsFilter {
 
     /**
      * Filter by enabled value
@@ -15,4 +15,9 @@ public RulesFilter withEnabled(boolean enabled) {
         return this;
     }
 
+    @Override
+    public RulesFilter withFields(String fields, boolean includeFields) {
+        super.withFields(fields, includeFields);
+        return this;
+    }
 }
diff --git a/src/main/java/com/auth0/client/mgmt/filter/UserFilter.java b/src/main/java/com/auth0/client/mgmt/filter/UserFilter.java
@@ -3,12 +3,42 @@
 /**
  * Class used to filter the results received when calling the Users endpoint. Related to the {@link com.auth0.client.mgmt.UsersEntity()} entity.
  */
-public class UserFilter extends QueryFilter<UserFilter> {
+public class UserFilter extends QueryFilter {
 
     /**
      * Creates a new instance using the search engine 'v2'.
      */
     public UserFilter() {
         parameters.put("search_engine", "v2");
     }
+
+    @Override
+    public UserFilter withTotals(boolean includeTotals) {
+        super.withTotals(includeTotals);
+        return this;
+    }
+
+    @Override
+    public UserFilter withQuery(String query) {
+        super.withQuery(query);
+        return this;
+    }
+
+    @Override
+    public UserFilter withSort(String sort) {
+        super.withSort(sort);
+        return this;
+    }
+
+    @Override
+    public UserFilter withPage(int pageNumber, int amountPerPage) {
+        super.withPage(pageNumber, amountPerPage);
+        return this;
+    }
+
+    @Override
+    public UserFilter withFields(String fields, boolean includeFields) {
+        super.withFields(fields, includeFields);
+        return this;
+    }
 }
diff --git a/src/test/java/com/auth0/client/mgmt/filter/ConnectionFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/ConnectionFilterTest.java
@@ -1,4 +1,4 @@
-package com.auth0.net;
+package com.auth0.client.mgmt.filter;
 
 import com.auth0.client.mgmt.filter.ConnectionFilter;
 import org.hamcrest.Matchers;
diff --git a/src/test/java/com/auth0/client/mgmt/filter/DeviceCredentialsFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/DeviceCredentialsFilterTest.java
@@ -1,6 +1,5 @@
-package com.auth0.net;
+package com.auth0.client.mgmt.filter;
 
-import com.auth0.client.mgmt.filter.DeviceCredentialsFilter;
 import org.hamcrest.Matchers;
 import org.junit.Before;
 import org.junit.Test;
diff --git a/src/test/java/com/auth0/client/mgmt/filter/FieldFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/FieldFilterTest.java
@@ -0,0 +1,39 @@
+package com.auth0.client.mgmt.filter;
+
+import org.hamcrest.Matchers;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.junit.Assert.assertThat;
+
+public class FieldFilterTest {
+
+    private FieldsFilter filter;
+
+    @Before
+    public void setUp() throws Exception {
+        filter = new FieldsFilter();
+    }
+
+    @Test
+    public void shouldFilterWithFields() throws Exception {
+        FieldsFilter instance = filter.withFields("a,b,c", true);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("fields", (Object) "a,b,c"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("include_fields", (Object) true));
+    }
+
+    @Test
+    public void shouldFilterWithoutFields() throws Exception {
+        FieldsFilter instance = filter.withFields("a,b,c", false);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("fields", (Object) "a,b,c"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("include_fields", (Object) false));
+    }
+}
diff --git a/src/test/java/com/auth0/client/mgmt/filter/LogEventFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/LogEventFilterTest.java
@@ -0,0 +1,86 @@
+package com.auth0.client.mgmt.filter;
+
+import org.hamcrest.Matchers;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.junit.Assert.assertThat;
+
+public class LogEventFilterTest {
+
+    private LogEventFilter filter;
+
+    @Before
+    public void setUp() throws Exception {
+        filter = new LogEventFilter();
+    }
+
+    @Test
+    public void shouldFilterByCheckpoint() throws Exception {
+        LogEventFilter instance = filter.withCheckpoint("log123", 10);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("from", (Object) "log123"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("take", (Object) 10));
+    }
+
+    @Test
+    public void shouldIncludeTotals() throws Exception {
+        LogEventFilter instance = filter.withTotals(true);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("include_totals", (Object) true));
+    }
+
+    @Test
+    public void shouldFilterByQuery() throws Exception {
+        LogEventFilter instance = filter.withQuery("id=log123");
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("q", (Object) "id=log123"));
+    }
+
+    @Test
+    public void shouldSort() throws Exception {
+        LogEventFilter instance = filter.withSort("date:-1");
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("sort", (Object) "date:-1"));
+    }
+
+    @Test
+    public void shouldFilterByPage() throws Exception {
+        LogEventFilter instance = filter.withPage(15, 50);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("page", (Object) 15));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("per_page", (Object) 50));
+    }
+
+    @Test
+    public void shouldFilterByWithFields() throws Exception {
+        LogEventFilter instance = filter.withFields("a,b,c", true);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("fields", (Object) "a,b,c"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("include_fields", (Object) true));
+    }
+
+    @Test
+    public void shouldFilterWithoutFields() throws Exception {
+        LogEventFilter instance = filter.withFields("a,b,c", false);
+
+        assertThat(filter, is(instance));
+        assertThat(filter.getAsMap(), is(notNullValue()));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("fields", (Object) "a,b,c"));
+        assertThat(filter.getAsMap(), Matchers.hasEntry("include_fields", (Object) false));
+    }
+}
diff --git a/src/test/java/com/auth0/client/mgmt/filter/QueryFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/QueryFilterTest.java
diff --git a/src/test/java/com/auth0/client/mgmt/filter/RulesFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/RulesFilterTest.java
diff --git a/src/test/java/com/auth0/client/mgmt/filter/UserFilterTest.java b/src/test/java/com/auth0/client/mgmt/filter/UserFilterTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.auth0.net;`
	`1`	`+package com.auth0.client.mgmt.filter;`
`2`	`2`
`3`	`3`	`import com.auth0.client.mgmt.filter.ConnectionFilter;`
`4`	`4`	`import org.hamcrest.Matchers;`