Merge pull request #208 from opentok/feature/play-dtmf

[WIP DEVX-5642] add play dtmf to opentok

Author: pardel

src/main/java/com/opentok/OpenTok.java

@@ -700,6 +700,33 @@ public Sip dial(String sessionId, String token, SipProperties properties) throws
         }
     }
 
+    /**
+     * Send DTMF digits to all clients in a session.
+     *
+     * @param sessionId The session ID.
+     * @param dtmfDigits The string of DTMF digits to send. This can include 0-9, "*", "#",
+     * and "p". A p indicates a pause of 500ms (if you need to add a delay in sending the digits).
+     *
+     * @throws OpenTokException
+     */
+    public void playDTMF(String sessionId, String dtmfDigits) throws OpenTokException {
+        client.playDtmfAll(sessionId, dtmfDigits);
+    }
+
+    /**
+     * Send DTMF digits a specific client in a session.
+     *
+     * @param sessionId The session ID.
+     * @param connectionId The session ID of the client to receive the DTMF digits.
+     * @param dtmfDigits The string of DTMF digits to send. This can include 0-9, "*", "#",
+     * and "p". A p indicates a pause of 500ms (if you need to add a delay in sending the digits).
+     *
+     * @throws OpenTokException
+     */
+    public void playDTMF(String sessionId, String connectionId, String dtmfDigits) throws OpenTokException {
+        client.playDtmfSingle(sessionId, connectionId, dtmfDigits);
+    }
+
     /**
      * Used to create an OpenTok object with advanced settings. You can set
      * the request timeout for API calls and a proxy to use for API calls.

src/main/java/com/opentok/util/HttpClient.java

@@ -775,6 +775,54 @@ public String sipDial(String sessionId, String token, SipProperties props) throw
         }
         return responseString;
     }
+
+    public String playDtmf(String url, String dtmfDigits) throws OpenTokException {
+        String responseString = null;
+        String requestBody = null;
+
+        JsonNodeFactory nodeFactory = JsonNodeFactory.instance;
+        ObjectNode requestJson = nodeFactory.objectNode();
+
+        requestJson.put("digits", dtmfDigits);
+        try {
+            requestBody = new ObjectMapper().writeValueAsString(requestJson);
+        } catch (JsonProcessingException e) {
+            throw new OpenTokException("Could not send a signal. The JSON body encoding failed.", e);
+        }
+
+        Future<Response> request = this.preparePost(url)
+                .setBody(requestBody)
+                .setHeader("Content-Type", "application/json")
+                .execute();
+
+        try {
+            Response response = request.get();
+            switch (response.getStatusCode()) {
+                case 200:
+                    responseString = response.getResponseBody();
+                    break;
+                default:
+                    throw new RequestException("Could not get a proper response. response code: " +
+                            response.getStatusCode());
+            }
+        } catch (InterruptedException | ExecutionException e) {
+            throw new RequestException("Could not play dtmf");
+        }
+
+        return responseString;
+    }
+
+    public String playDtmfAll(String sessionId, String dtmfDigits) throws OpenTokException {
+        String url = this.apiUrl + "/v2/project/" + this.apiKey + "/session/" + sessionId + "/play-dtmf";
+        return playDtmf(url, dtmfDigits);
+    }
+
+    public String playDtmfSingle(String sessionId, String connectionId, String dtmfDigits) throws OpenTokException {
+        String url = this.apiUrl + "/v2/project/" + this.apiKey + "/session/" + sessionId +
+                "/connection/"+ connectionId + "/play-dtmf";
+        return playDtmf(url, dtmfDigits);
+    }
+
     public String getStream(String sessionId, String streamId) throws RequestException {
         String responseString = null;
         String url = this.apiUrl + "/v2/project/" + this.apiKey + "/session/" + sessionId + "/stream/" + streamId;

src/test/java/com/opentok/test/OpenTokTest.java

@@ -2095,6 +2095,43 @@ public void testSipDial() throws OpenTokException {
                 findAll(postRequestedFor(urlMatching(url)))));
         Helpers.verifyUserAgent();
     }
+
+    @Test
+    public void testPlayDtmfAll() throws OpenTokException {
+        String sessionId = "SESSIONID";
+        String path = "/v2/project/" + apiKey + "/session/" + sessionId + "/play-dtmf";
+        stubFor(post(urlEqualTo(path))
+                .willReturn(aResponse()
+                        .withStatus(200)));
+
+        String dtmfString = "0p6p4p4pp60p#";
+
+        sdk.playDTMF(sessionId, dtmfString);
+        verify(postRequestedFor(urlMatching(path)));
+        assertTrue(Helpers.verifyTokenAuth(apiKey, apiSecret,
+                findAll(deleteRequestedFor(urlMatching(path)))));
+        Helpers.verifyUserAgent();
+    }
+
+    @Test
+    public void testPlayDtmfSingle() throws OpenTokException {
+        String sessionId = "SESSIONID";
+        String connectionId = "CONNECTIONID";
+        String path = "/v2/project/" + apiKey + "/session/" + sessionId +
+                "/connection/" + connectionId +"/play-dtmf";
+        stubFor(post(urlEqualTo(path))
+                .willReturn(aResponse()
+                        .withStatus(200)));
+
+        String dtmfString = "0p6p4p4pp60p#";
+
+        sdk.playDTMF(sessionId, connectionId, dtmfString);
+        verify(postRequestedFor(urlMatching(path)));
+        assertTrue(Helpers.verifyTokenAuth(apiKey, apiSecret,
+                findAll(deleteRequestedFor(urlMatching(path)))));
+        Helpers.verifyUserAgent();
+    }
+
     @Test
     public void testforceDisconnect() throws OpenTokException {
         String sessionId = "SESSIONID";