Merge pull request #898 from zalando/aruha-1528-audience

Change audience from underscore to dash
zalando · Jun 28, 2018 · bbfb446 · bbfb446
2 parents b4bf11a + 66eb25f
commit bbfb446
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 16 deletions.
diff --git a/docs/_data/nakadi-event-bus-api.yaml b/docs/_data/nakadi-event-bus-api.yaml
@@ -2510,11 +2510,11 @@ definitions:
       audience:
         type: string
         x-extensible-enum:
-          - component_internal
-          - business_unit_internal
-          - company_internal
-          - external_partner
-          - external_public
+          - component-internal
+          - business-unit-internal
+          - company-internal
+          - external-partner
+          - external-public
         description: |
           Intended target audience of the event type. Relevant for standards around quality of design and documentation,
           reviews, discoverability, changeability, and permission granting. See the guidelines

diff --git a/src/acceptance-test/java/org/zalando/nakadi/webservice/UserJourneyAT.java b/src/acceptance-test/java/org/zalando/nakadi/webservice/UserJourneyAT.java
@@ -90,7 +90,7 @@ public void userJourneyM1() throws InterruptedException, IOException {
                 .body("name", equalTo(eventTypeName))
                 .body("owning_application", equalTo(owningApp))
                 .body("category", equalTo("undefined"))
-                .body("audience", equalTo("external_public"))
+                .body("audience", equalTo("external-public"))
                 .body("ordering_key_fields", equalTo(Lists.newArrayList("foo", "bar.baz")))
                 .body("schema.type", equalTo("json_schema"))
                 .body("schema.schema", equalTo("{\"type\": \"object\", \"properties\": {\"foo\": " +

diff --git a/src/main/java/org/zalando/nakadi/config/JsonConfig.java b/src/main/java/org/zalando/nakadi/config/JsonConfig.java
@@ -19,11 +19,12 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
+import org.zalando.nakadi.domain.Audience;
 import org.zalando.problem.ProblemModule;
 
 import java.io.IOException;
 
-import static com.fasterxml.jackson.databind.PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES;
+import static com.fasterxml.jackson.databind.PropertyNamingStrategy.SNAKE_CASE;
 import static com.fasterxml.jackson.databind.SerializationFeature.WRITE_DATES_AS_TIMESTAMPS;
 import static java.util.Arrays.stream;
 import static java.util.stream.Collectors.joining;
@@ -35,7 +36,7 @@ public class JsonConfig {
     @Primary
     public ObjectMapper jacksonObjectMapper() {
         final ObjectMapper objectMapper = new ObjectMapper()
-                .setPropertyNamingStrategy(CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);
+                .setPropertyNamingStrategy(SNAKE_CASE);
 
         objectMapper.registerModule(enumModule());
         objectMapper.registerModule(new Jdk8Module());
@@ -75,12 +76,24 @@ public Enum deserialize(final JsonParser jp, final DeserializationContext ctxt)
             @SuppressWarnings("unchecked")
             final Class<? extends Enum> rawClass = (Class<Enum<?>>) type.getRawClass();
             final String jpValueAsString = jp.getValueAsString();
+
             try {
-                return Enum.valueOf(rawClass, jpValueAsString.toUpperCase());
+                if (rawClass.equals(Audience.class)) {
+                    return Audience.fromString(jpValueAsString);
+                } else {
+                    return Enum.valueOf(rawClass, jpValueAsString.toUpperCase());
+                }
             } catch (final IllegalArgumentException e) {
-                final String possibleValues = stream(rawClass.getEnumConstants())
-                        .map(enumValue -> enumValue.name().toLowerCase())
-                        .collect(joining(", "));
+                final String possibleValues;
+                if (rawClass.equals(Audience.class)) {
+                    possibleValues = stream(rawClass.getEnumConstants())
+                            .map(enumValue -> enumValue.name().toLowerCase().replaceAll("_", "-"))
+                            .collect(joining(", "));
+                } else {
+                    possibleValues = stream(rawClass.getEnumConstants())
+                            .map(enumValue -> enumValue.name().toLowerCase())
+                            .collect(joining(", "));
+                }
                 throw new JsonMappingException("Illegal enum value: '" + jpValueAsString
                         + "'. Possible values: [" + possibleValues + "]");
             }
@@ -95,7 +108,11 @@ private static class LowerCaseEnumJsonSerializer extends StdSerializer<Enum> {
         @Override
         public void serialize(final Enum value, final JsonGenerator jgen, final SerializerProvider provider)
                 throws IOException {
-            jgen.writeString(value.name().toLowerCase());
+            if (value.getClass().equals(Audience.class)) {
+                jgen.writeString(((Audience)value).getText());
+            } else {
+                jgen.writeString(value.name().toLowerCase());
+            }
         }
     }
 }
diff --git a/src/main/java/org/zalando/nakadi/domain/Audience.java b/src/main/java/org/zalando/nakadi/domain/Audience.java
@@ -1,5 +1,28 @@
 package org.zalando.nakadi.domain;
 
 public enum Audience {
-    COMPONENT_INTERNAL, BUSINESS_UNIT_INTERNAL, COMPANY_INTERNAL, EXTERNAL_PARTNER, EXTERNAL_PUBLIC
+    COMPONENT_INTERNAL("component-internal"),
+    BUSINESS_UNIT_INTERNAL("business-unit-internal"),
+    COMPANY_INTERNAL("company-internal"),
+    EXTERNAL_PARTNER("external-partner"),
+    EXTERNAL_PUBLIC("external-public");
+
+    private String text;
+
+    Audience(final String text) {
+        this.text = text;
+    }
+
+    public String getText() {
+        return this.text;
+    }
+
+    public static Audience fromString(final String text) {
+        for (final Audience audience : Audience.values()) {
+            if (audience.text.equals(text)) {
+                return audience;
+            }
+        }
+        throw new IllegalArgumentException();
+    }
 }
diff --git a/src/test/resources/sample-event-type-update.json b/src/test/resources/sample-event-type-update.json
@@ -11,5 +11,5 @@
   "options" : {
     "retention_time": 86400000
   },
-  "audience": "external_public"
+  "audience": "external-public"
 }
diff --git a/src/test/resources/sample-event-type.json b/src/test/resources/sample-event-type.json
@@ -7,6 +7,6 @@
     "type": "json_schema",
     "schema": "{\"type\": \"object\", \"properties\": {\"foo\": {\"type\": \"string\"}, \"bar\": {\"type\": \"object\", \"properties\": {\"baz\": {\"type\": \"string\"}}}}, \"required\": [\"foo\"]}"
   },
-  "audience": "external_public",
+  "audience": "external-public",
   "ordering_key_fields": ["foo", "bar.baz"]
 }