List categories (#109)

* List categories

- Added `listCategories(chartKey)` to API
- Updated README
- Tests

* Removed `chartKey` from response

---------

Co-authored-by: Steve Chaloner <[email protected]>

Author: schaloner

README.md

@@ -207,6 +207,20 @@ Event event = client.events.create(chart.key);
 System.out.println("Created event with key " + event.key);
 ```
 
+### Listing categories
+
+```java
+import seatsio.SeatsioClient;
+import seatsio.Category;
+
+SeatsioClient client = new SeatsioClient(Region.EU, "<WORKSPACE SECRET KEY>");
+
+List<Category> categories = client.charts.listCategories("the chart key");
+categories.forEach(category -> {
+  System.out.println("Category " + category.label);
+});
+```
+
 ## Error handling
 
 When an API call results in a 4xx or 5xx error (e.g. when a chart could not be found), a SeatsioException is thrown.

src/main/java/seatsio/charts/Charts.java

@@ -1,5 +1,6 @@
 package seatsio.charts;
 
+import com.google.gson.Gson;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
@@ -111,6 +112,13 @@ public void removeCategory(String chartKey, CategoryKey categoryKey) {
                 .routeParam("categoryKey", categoryKey.toString()));
     }
 
+    public List<Category> listCategories(String chartKey) {
+        final String response = unirest.stringResponse(get(baseUrl + "/charts/{key}/categories")
+                .routeParam("key", chartKey));
+        final Gson gson = gson();
+        return gson.fromJson(response, ListCategoriesResponse.class).categories;
+    }
+
     public Chart copy(String key) {
         String response = unirest.stringResponse(UnirestWrapper.post(baseUrl + "/charts/{key}/version/published/actions/copy")
                 .routeParam("key", key));
@@ -238,4 +246,8 @@ private Map<String, Object> toMap(ChartListParams chartListParams) {
         }
         return chartListParams.asMap();
     }
+
+    private static final class ListCategoriesResponse {
+        public List<Category> categories;
+    }
 }

src/test/java/seatsio/charts/ManageCategoriesTest.java

@@ -3,12 +3,14 @@
 import com.google.common.collect.ImmutableMap;
 import org.junit.jupiter.api.Test;
 import seatsio.SeatsioClientTest;
+import seatsio.SeatsioException;
 
 import java.util.List;
 import java.util.Map;
 
 import static com.google.common.collect.Lists.newArrayList;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 @SuppressWarnings("unchecked")
 public class ManageCategoriesTest extends SeatsioClientTest {
@@ -53,6 +55,23 @@ public void removeCategory() {
         );
     }
 
+    @Test
+    public void listCategories() {
+        List<Category> categories = newArrayList(
+                new Category(CategoryKey.of(1L), "Category 1", "#aaaaaa"),
+                new Category(CategoryKey.of("cat2"), "Category 2", "#bbbbbb", true)
+        );
+        Chart chart = client.charts.create("aChart", "BOOTHS", categories);
+
+        final List<Category> categoryList = client.charts.listCategories(chart.key);
+        assertThat(categoryList).isEqualTo(categories);
+    }
+
+    @Test
+    public void listCategories_unknownChart() {
+        assertThrows(SeatsioException.class, () -> client.charts.listCategories("unknownChart"));
+    }
+
     private List<Map<?, ?>> categories(Map<?, ?> drawing) {
         Map<?, ?> categoriesMap = (Map<?, ?>) drawing.get("categories");
         return (List<Map<?, ?>>) categoriesMap.get("list");