Chart summary reports now support a bookWholeTablesMode (#58)

Author: mroloux

README.md

@@ -30,14 +30,14 @@ Then you can refer to seatsio-java as a regular package:
 ```
 // build.gradle
 dependencies {
-  compile 'com.github.seatsio:seatsio-java:67.3.0'
+  compile 'com.github.seatsio:seatsio-java:67.4.0'
 }
 
 // pom.xml
 <dependency>
   <groupId>com.github.seatsio</groupId>
   <artifactId>seatsio-java</artifactId>
-  <version>67.3.0</version>
+  <version>67.4.0</version>
 </dependency>
 ```
 

src/main/java/seatsio/reports/Reports.java

@@ -45,17 +45,22 @@ protected <T> List<T> fetchReportFiltered(String reportType, String eventKey, St
 
     protected abstract <T> TypeToken<Map<String, List<T>>> getTypeToken();
 
-    protected <T> Map<String, T> fetchSummaryReport(String reportType, String eventKey) {
-        String result = fetchRawSummaryReport(reportType, eventKey);
+    protected <T> Map<String, T> fetchSummaryReport(String reportType, String key) {
+        return fetchSummaryReport(reportType, key, null);
+    }
+
+    protected <T> Map<String, T> fetchSummaryReport(String reportType, String key, Map<String, Object> queryParams) {
+        String result = fetchRawSummaryReport(reportType, key, queryParams);
         TypeToken<Map<String, T>> typeToken = getSummaryTypeToken();
         return gson().fromJson(result, typeToken.getType());
     }
 
     protected abstract <T> TypeToken<Map<String, T>> getSummaryTypeToken();
 
-    private String fetchRawSummaryReport(String reportType, String eventKey) {
+    private String fetchRawSummaryReport(String reportType, String key, Map<String, Object> queryParams) {
         return unirest.stringResponse(get(baseUrl + "/reports/" + reportItemType + "/{key}/{reportType}/summary")
-                .routeParam("key", eventKey)
+                .queryString(queryParams)
+                .routeParam("key", key)
                 .routeParam("reportType", reportType));
     }
 }

src/main/java/seatsio/reports/charts/ChartReports.java

@@ -23,39 +23,43 @@ public Map<String, List<ChartObjectInfo>> byObjectType(String chartKey, ChartRep
         return fetchChartReport("byObjectType", chartKey, bookWholeTablesMode);
     }
 
-    public Map<String, ChartReportSummaryItem> summaryByObjectType(String eventKey) {
-        return fetchSummaryReport("byObjectType", eventKey);
+    public Map<String, ChartReportSummaryItem> summaryByObjectType(String eventKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
+        return fetchSummaryReport("byObjectType", eventKey, toQueryParams(bookWholeTablesMode));
     }
 
     public Map<String, List<ChartObjectInfo>> byCategoryKey(String chartKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
         return fetchChartReport("byCategoryKey", chartKey, bookWholeTablesMode);
     }
 
-    public Map<String, ChartReportSummaryItem> summaryByCategoryKey(String eventKey) {
-        return fetchSummaryReport("byCategoryKey", eventKey);
+    public Map<String, ChartReportSummaryItem> summaryByCategoryKey(String eventKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
+        return fetchSummaryReport("byCategoryKey", eventKey, toQueryParams(bookWholeTablesMode));
     }
 
     public Map<String, List<ChartObjectInfo>> byCategoryLabel(String chartKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
         return fetchChartReport("byCategoryLabel", chartKey, bookWholeTablesMode);
     }
 
-    public Map<String, ChartReportSummaryItem> summaryByCategoryLabel(String eventKey) {
-        return fetchSummaryReport("byCategoryLabel", eventKey);
+    public Map<String, ChartReportSummaryItem> summaryByCategoryLabel(String eventKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
+        return fetchSummaryReport("byCategoryLabel", eventKey, toQueryParams(bookWholeTablesMode));
     }
 
     public Map<String, List<ChartObjectInfo>> bySection(String chartKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
         return fetchChartReport("bySection", chartKey, bookWholeTablesMode);
     }
 
-    public Map<String, ChartReportSummaryItem> summaryBySection(String eventKey) {
-        return fetchSummaryReport("bySection", eventKey);
+    public Map<String, ChartReportSummaryItem> summaryBySection(String eventKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
+        return fetchSummaryReport("bySection", eventKey, toQueryParams(bookWholeTablesMode));
     }
 
     private Map<String, List<ChartObjectInfo>> fetchChartReport(String reportType, String chartKey, ChartReportBookWholeTablesMode bookWholeTablesMode) {
-        Map<String, Object> queryParams = bookWholeTablesMode == null ? null : ImmutableMap.of("bookWholeTables", bookWholeTablesMode.queryParam());
+        Map<String, Object> queryParams = toQueryParams(bookWholeTablesMode);
         return fetchReport(reportType, chartKey, queryParams);
     }
 
+    private Map<String, Object> toQueryParams(ChartReportBookWholeTablesMode bookWholeTablesMode) {
+        return bookWholeTablesMode == null ? null : ImmutableMap.of("bookWholeTables", bookWholeTablesMode.queryParam());
+    }
+
     protected TypeToken<Map<String, List<ChartObjectInfo>>> getTypeToken() {
         return new TypeToken<Map<String, List<ChartObjectInfo>>>() {
         };

src/test/java/seatsio/reports/charts/ChartReportsSummaryTest.java

@@ -9,6 +9,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static seatsio.events.EventObjectInfo.NO_SECTION;
+import static seatsio.reports.charts.ChartReportBookWholeTablesMode.TRUE;
 import static seatsio.reports.charts.ChartReportSummaryItemBuilder.aChartReportSummaryItem;
 
 public class ChartReportsSummaryTest extends SeatsioClientTest {
@@ -17,7 +18,7 @@ public class ChartReportsSummaryTest extends SeatsioClientTest {
     public void summaryByObjectType() {
         String chartKey = createTestChart();
 
-        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByObjectType(chartKey);
+        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByObjectType(chartKey, null);
 
         ChartReportSummaryItem seatReport = aChartReportSummaryItem()
                 .withCount(32)
@@ -46,11 +47,38 @@ public void summaryByObjectType() {
         ));
     }
 
+    @Test
+    public void summaryByObjectType_bookWholeTablesTrue() {
+        String chartKey = createTestChartWithTables();
+
+        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByObjectType(chartKey, TRUE);
+
+        ChartReportSummaryItem tablesReport = aChartReportSummaryItem()
+                .withCount(2)
+                .withBySection(ImmutableMap.of(NO_SECTION, 2))
+                .withByCategoryKey(ImmutableMap.of("9", 2))
+                .withByCategoryLabel(ImmutableMap.of("Cat1", 2))
+                .build();
+        ChartReportSummaryItem emptyReport = aChartReportSummaryItem()
+                .withCount(0)
+                .withBySection(new HashMap<>())
+                .withByCategoryKey(new HashMap<>())
+                .withByCategoryLabel(new HashMap<>())
+                .build();
+
+        assertThat(report).isEqualTo(ImmutableMap.of(
+                "seat", emptyReport,
+                "generalAdmission", emptyReport,
+                "booth", emptyReport,
+                "table", tablesReport
+        ));
+    }
+
     @Test
     public void summaryByCategoryKey() {
         String chartKey = createTestChart();
 
-        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByCategoryKey(chartKey);
+        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByCategoryKey(chartKey, null);
 
         ChartReportSummaryItem cat9Report = aChartReportSummaryItem()
                 .withCount(116)
@@ -75,7 +103,7 @@ public void summaryByCategoryKey() {
     public void summaryByCategoryLabel() {
         String chartKey = createTestChart();
 
-        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByCategoryLabel(chartKey);
+        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryByCategoryLabel(chartKey, null);
 
         ChartReportSummaryItem cat1Report = aChartReportSummaryItem()
                 .withCount(116)
@@ -100,7 +128,7 @@ public void summaryByCategoryLabel() {
     public void summaryBySection() {
         String chartKey = createTestChart();
 
-        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryBySection(chartKey);
+        Map<String, ChartReportSummaryItem> report = client.chartReports.summaryBySection(chartKey, null);
 
         ChartReportSummaryItem noSectionReport = aChartReportSummaryItem()
                 .withCount(232)