Merge pull request #195 from surik/depricate-callflow-title

denizkilic · web-flow · commit 3e7353a769df · 2022-04-28T10:58:21.000+02:00
Deprecate CallFlow Title usage
diff --git a/api/src/main/java/com/messagebird/MessageBirdServiceImpl.java b/api/src/main/java/com/messagebird/MessageBirdServiceImpl.java
@@ -363,7 +363,7 @@ private void handleHttpFailStatuses(final int status, String body) throws Unauth
     <P> APIResponse doRequest(final String method, final String url, final Map<String, String> headers, final P payload) throws GeneralException {
         HttpURLConnection connection = null;
         InputStream inputStream = null;
-
+        
         if (METHOD_PATCH.equalsIgnoreCase(method)) {
             // It'd perhaps be cleaner to call this in the constructor, but
             // we'd then need to throw GeneralExceptions from there. This means
diff --git a/api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlow.java b/api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlow.java
@@ -37,10 +37,12 @@ public void setId(String id) {
         this.id = id;
     }
 
+    @Deprecated
     public String getTitle() {
         return title;
     }
 
+    @Deprecated
     public void setTitle(String title) {
         this.title = title;
     }
diff --git a/api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlowRequest.java b/api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlowRequest.java
@@ -36,10 +36,12 @@ public void setId(String id) {
         this.id = id;
     }
 
+    @Deprecated
     public String getTitle() {
         return title;
     }
 
+    @Deprecated
     public void setTitle(String title) {
         this.title = title;
     }
diff --git a/api/src/test/java/com/messagebird/MessageBirdClientTest.java b/api/src/test/java/com/messagebird/MessageBirdClientTest.java
@@ -427,7 +427,6 @@ public void shouldThrowIllegalArgumentExceptionWhenSourceOfVoiceCallIsMissing()
         voiceCall.setDestination("ANY_DESTINATION");
 
         final VoiceCallFlow voiceCallFlow = new VoiceCallFlow();
-        voiceCallFlow.setTitle("Test title");
         VoiceStep voiceStep = new VoiceStep();
         voiceStep.setAction("say");
 
@@ -448,7 +447,6 @@ public void shouldThrowIllegalArgumentExceptionWhenDestinationOfVoiceCallIsMissi
         voiceCall.setSource("ANY_SOURCE");
 
         final VoiceCallFlow voiceCallFlow = new VoiceCallFlow();
-        voiceCallFlow.setTitle("Test title");
         VoiceStep voiceStep = new VoiceStep();
         voiceStep.setAction("say");
 
diff --git a/api/src/test/java/com/messagebird/SpyService.java b/api/src/test/java/com/messagebird/SpyService.java
@@ -70,7 +70,7 @@ static <P> SpyService expects(final String method, final String url, final P pay
         service.method = method;
         service.url = url;
         service.payload = payload;
-
+    
         return service;
     }
 
diff --git a/api/src/test/java/com/messagebird/TestUtil.java b/api/src/test/java/com/messagebird/TestUtil.java
@@ -28,7 +28,6 @@ static VoiceCall createVoiceCall(String destination) {
         voiceCall.setDestination(destination);
 
         final VoiceCallFlow voiceCallFlow = new VoiceCallFlow();
-        voiceCallFlow.setTitle("Test title");
         VoiceStep voiceStep = new VoiceStep();
         voiceStep.setAction("say");
 
@@ -211,7 +210,6 @@ public static VoiceStep createVoiceStep() {
 
     public static VoiceCallFlowRequest createVoiceCallFlowRequest() {
         final VoiceCallFlowRequest voiceCallFlow = new VoiceCallFlowRequest();
-        voiceCallFlow.setTitle("ANY_TITLE");
         voiceCallFlow.setRecord(true);
         voiceCallFlow.setSteps(Collections.singletonList(createVoiceStep()));
         voiceCallFlow.setDefaultCall(true);
diff --git a/api/src/test/java/com/messagebird/VoiceCallFlowTest.java b/api/src/test/java/com/messagebird/VoiceCallFlowTest.java
@@ -64,6 +64,21 @@ public void testView() throws GeneralException, UnauthorizedException, NotFoundE
         this.testVoiceCallFlowAgainstFixture(voiceCallFlow);
     }
 
+    @Test
+    public void testViewTitlePresent() throws GeneralException, UnauthorizedException, NotFoundException {
+        String responseFixture = Resources.readResourceText("/fixtures/call_flow_view_title.json");
+        MessageBirdService messageBirdService = SpyService
+            .expects("GET", "call-flows/e781a76f-14ad-45b0-8490-409300244e20")
+            .withVoiceCallAPIBaseURL()
+            .andReturns(new APIResponse(responseFixture));
+        MessageBirdClient messageBirdClient = new MessageBirdClient(messageBirdService);
+        VoiceCallFlow voiceCallFlow = messageBirdClient
+            .viewVoiceCallFlow("e781a76f-14ad-45b0-8490-409300244e20")
+            .getData()
+            .get(0);
+        this.testVoiceCallFlowAgainstFixture(voiceCallFlow, true);
+    }
+
     @Test (expected = IllegalArgumentException.class)
     public void testViewShouldThrowInvalidArgumentException() throws NotFoundException, GeneralException, UnauthorizedException {
         String responseFixture = Resources.readResourceText("/fixtures/call_flow_view.json");
@@ -81,7 +96,6 @@ public void testUpdate() throws GeneralException, UnauthorizedException, NotFoun
         String responseFixture = Resources.readResourceText("/fixtures/call_flow_update_response.json");
 
         VoiceCallFlowRequest voiceCallFlowRequest = new VoiceCallFlowRequest("e781a76f-14ad-45b0-8490-409300244e20");
-        voiceCallFlowRequest.setTitle("Forward call to 316123456782");
         voiceCallFlowRequest.setDefaultCall(true);
         voiceCallFlowRequest.setRecord(true);
         voiceCallFlowRequest.setSteps(
@@ -220,9 +234,15 @@ public void testDeleteIllegalArgumentException() throws NotFoundException, Gener
      * In order to reuse this method for further tests you need to make sure that the fixtures
      * match the date in this test. See call_flows_post.json
      */
+
     private void testVoiceCallFlowAgainstFixture(VoiceCallFlow voiceCallFlow) {
+        testVoiceCallFlowAgainstFixture(voiceCallFlow, false);
+    }
+
+    private void testVoiceCallFlowAgainstFixture(VoiceCallFlow voiceCallFlow, boolean hasTitle) {
         assertEquals(voiceCallFlow.getId(), "e781a76f-14ad-45b0-8490-409300244e20");
-        assertEquals(voiceCallFlow.getTitle(), "Forward call to 31612345678");
+        if (!hasTitle) assertEquals(voiceCallFlow.getTitle(), null);
+        if (hasTitle) assertNotEquals(voiceCallFlow.getTitle(), null);
         assertEquals(voiceCallFlow.isRecord(), true);
         assertEquals(voiceCallFlow.isDefaultCall(), false);
         assertEquals(voiceCallFlow.getCreatedAt().toString(), "Tue Aug 06 16:13:06 CEST 2019");
diff --git a/api/src/test/resources/fixtures/call_flow_update_response.json b/api/src/test/resources/fixtures/call_flow_update_response.json
@@ -2,7 +2,6 @@
   "data": [
     {
       "id": "e781a76f-14ad-45b0-8490-409300244e20",
-      "title": "Forward call to 31612345678",
       "steps": [
         {
           "id": "a8e44a38-b935-482f-b17f-ed3472c6292c",
diff --git a/api/src/test/resources/fixtures/call_flow_view.json b/api/src/test/resources/fixtures/call_flow_view.json
@@ -2,7 +2,6 @@
   "data": [
     {
       "id": "e781a76f-14ad-45b0-8490-409300244e20",
-      "title": "Forward call to 31612345678",
       "steps": [
         {
           "id": "a8e44a38-b935-482f-b17f-ed3472c6292c",
diff --git a/api/src/test/resources/fixtures/call_flow_view_title.json b/api/src/test/resources/fixtures/call_flow_view_title.json
@@ -0,0 +1,41 @@
+{
+  "data": [
+    {
+      "title": "Call title",
+      "id": "e781a76f-14ad-45b0-8490-409300244e20",
+      "steps": [
+        {
+          "id": "a8e44a38-b935-482f-b17f-ed3472c6292c",
+          "action": "transfer",
+          "options": {
+            "destination"         : "31612345678",
+            "payload"             : "Test payload",
+            "language"            : "en-GB",
+            "voice"               : "male",
+            "repeat"              : 1,
+            "media"               : "test.mp3",
+            "length"              : 1,
+            "maxLength"           : 2,
+            "timeout"             : 3,
+            "finishOnKey"         : "1",
+            "transcribe"          : "false",
+            "transcribeLanguage"  : "en-GB",
+            "record"              : "both",
+            "url"                 : "http://",
+            "ifMachine"           : "ifMachine",
+            "machineTimeout"      : 200,
+            "onFinish"            : "http://",
+            "mask"                : false
+          }
+        }
+      ],
+      "record": true,
+      "default": false,
+      "createdAt": "2019-08-06T14:13:06Z",
+      "updatedAt": "2019-08-06T14:13:06Z"
+    }
+  ],
+  "_links": {
+    "self": "/call-flows/70fbdda2-4f1f-44ce-8792-75af32cf598c"
+  }
+}
diff --git a/api/src/test/resources/fixtures/call_flows_list.json b/api/src/test/resources/fixtures/call_flows_list.json
@@ -2,7 +2,6 @@
   "data": [
     {
       "id": "e781a76f-14ad-45b0-8490-409300244e20",
-      "title": "Forward call to 31612345678",
       "steps": [
         {
           "id": "a8e44a38-b935-482f-b17f-ed3472c6292c",
diff --git a/api/src/test/resources/fixtures/call_flows_post.json b/api/src/test/resources/fixtures/call_flows_post.json
@@ -2,7 +2,6 @@
   "data": [
     {
       "id": "e781a76f-14ad-45b0-8490-409300244e20",
-      "title": "Forward call to 31612345678",
       "steps": [
         {
           "id": "a8e44a38-b935-482f-b17f-ed3472c6292c",
diff --git a/examples/src/main/java/ExampleCreateVoiceCallFlow.java b/examples/src/main/java/ExampleCreateVoiceCallFlow.java
@@ -24,7 +24,6 @@ public static void main(String[] args) {
 
         final VoiceCallFlowRequest voiceCallFlowRequest = new VoiceCallFlowRequest();
 
-        voiceCallFlowRequest.setTitle(args[1]);
         voiceCallFlowRequest.setRecord(true); // Can be false as well, see docs
         VoiceStep voiceStep = new VoiceStep();
         voiceCallFlowRequest.setSteps(Collections.singletonList(voiceStep)); // VoiceStep Object
diff --git a/examples/src/main/java/ExampleSendVoiceCall.java b/examples/src/main/java/ExampleSendVoiceCall.java
@@ -33,9 +33,7 @@ public static void main(String[] args) {
             voiceCall.setDestination(args[1]);
             voiceCall.setWebhook("https://example.com/","foobar");
 
-            //Title and steps are required fields for creating callFlow
             final VoiceCallFlow voiceCallFlow = new VoiceCallFlow();
-            voiceCallFlow.setTitle("Test title");
             //action is required
             VoiceStep voiceStep = new VoiceStep();
             voiceStep.setAction("say");
diff --git a/examples/src/main/java/ExampleUpdateVoiceCallFlow.java b/examples/src/main/java/ExampleUpdateVoiceCallFlow.java
@@ -24,7 +24,6 @@ public static void main(String[] args) {
 
         final VoiceCallFlowRequest voiceCallFlowRequest = new VoiceCallFlowRequest();
 
-        voiceCallFlowRequest.setTitle(args[2]);
         voiceCallFlowRequest.setRecord(true); // Can be false as well, see docs
         VoiceStep voiceStep = new VoiceStep();
         voiceCallFlowRequest.setSteps(Collections.singletonList(voiceStep)); // VoiceStep Object

Original file line number	Diff line number	Diff line change
`@@ -37,10 +37,12 @@ public void setId(String id) {`
`37`	`37`	`this.id = id;`
`38`	`38`	`}`
`39`	`39`
	`40`	`+ @Deprecated`
`40`	`41`	`public String getTitle() {`
`41`	`42`	`return title;`
`42`	`43`	`}`
`43`	`44`
	`45`	`+ @Deprecated`
`44`	`46`	`public void setTitle(String title) {`
`45`	`47`	`this.title = title;`
`46`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,10 +36,12 @@ public void setId(String id) {`
`36`	`36`	`this.id = id;`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ @Deprecated`
`39`	`40`	`public String getTitle() {`
`40`	`41`	`return title;`
`41`	`42`	`}`
`42`	`43`
	`44`	`+ @Deprecated`
`43`	`45`	`public void setTitle(String title) {`
`44`	`46`	`this.title = title;`
`45`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ static <P> SpyService expects(final String method, final String url, final P pay`
`70`	`70`	`service.method = method;`
`71`	`71`	`service.url = url;`
`72`	`72`	`service.payload = payload;`
`73`		`-`
	`73`	`+`
`74`	`74`	`return service;`
`75`	`75`	`}`
`76`	`76`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`	`"data": [`
`3`	`3`	`{`
`4`	`4`	`"id": "e781a76f-14ad-45b0-8490-409300244e20",`
`5`		`- "title": "Forward call to 31612345678",`
`6`	`5`	`"steps": [`
`7`	`6`	`{`
`8`	`7`	`"id": "a8e44a38-b935-482f-b17f-ed3472c6292c",`