changes from code snippet audit

Author: yallen011

.env-example

@@ -1,3 +1,5 @@
+.DS_Store
+
 # Compiled class file
 *.class
 

.gitignore

@@ -42,16 +42,86 @@ So to run the OutboundTextToSpeechExample class, you would run the following:
 foreman run java -cp build/libs/nexmo-java-code-snippets-with-dependencies.jar com.nexmo.quickstart.voice.OutboundTextToSpeech
 ```
 
+Foreman allows you to run only parts of your application instead of having to run the entire jar.
 If you set the environment variable `QUICKSTART_DEBUG` to any value, extra information
 will be output to the console from the Nexmo Client library.
 
+## Running NCCO Webhook Examples
+
+Sign up for a free [ngrok](https://ngrok.com/) account
+
+Download and install from the ngrok site or use Homebrew (mac0S)
+
+```sh
+brew install cask ngrok
+```
+
+### Connect the installed ngrok to your ngrok account
+1. Go to your ngrok dashboard.
+2. Go to Setup & Installation
+3. Copy the token from the **Connect your account** step without the `./` prefix. What you copy should look like this:
+```shell script
+ngrok authentication 112skjl4jlwlkjdl4lkj66565lkjmn56n==e4w4l
+```
+4. Start a HTTP tunnel forwarding to your local port. Check your snippet to locate the port ngrok should forward to.
+For the Voice NCCO snippets we use port 3000, so our command would be:
+```shell script
+ngrok http 3000
+```
+
+You may then enter `http://localhost:4040/inspect/http` in your web browser to see a more detailed view of your requests, or use the 
+console to http status and message of your requests. 
+
+### Setup a Vonage Application 
+
+After setting up `ngrok` you will need to setup a Vonage application that will be used for monitoring your webhooks. Add a vonage feature
+that you would like your webhook to monitor for. In this example, we will setup a Vonage application and add voice capabilities. 
+
+Setup a Vonage Application with voice capabilities using the [Vonage Developer Portal](https://dashboard.nexmo.com/)
+1. On the developer portal, go to Applications.
+2. Click on the **Create new application** button.
+3. Give your applications a name.
+4. Under *Capabilities*, toggle the *Voice* capability.
+Go back to the terminal that has ngrok fired up and grab the forwarding url. Add that domain as the prefix to the path for the 
+webhook. Resulting url should look similar to the following:
+```sh
+ http://17e80b46d273.ngrok.io/webhook/answer
+```
+Go back to the *Voice* capabilities section and add the urls for the webhooks. Ex:
+
+**Answer URL:** http://17e80b46d273.ngrok.io/webhook/answer
+
+**Event URL:** http://17e80b46d273.ngrok.io/webhook/event
+
+**Answer Fallback URL:** http://17e80b46d273.ngrok.io/webhook/fallback (if no path is specified in the snippet use a random domain)
+
+5. Click the **generate public and private key** button. A private key file called private.key should be downloaded to your computer.
+6. Move the private key to the nexmo-java-code-snippets project root.
+7. Go the developer portal and click **Generate application**
+8. In your `.env` file, add the environment variables for your application that is needed to run the snippet to. For the voice dtmf webhook snippet,
+we would need the *application id*, and *private key file location* 
+9. (Optional) Link the number associated with your nexmo account to your app. In the developer portal, click the Link button
+on the application details screen to link that number to your application. This will allow you to test webhooks that require you to 
+call or text a number to test the NCCOs for that snippet.
+
+## Advanced Insight Webhook
+
+To run the Advanced Insight Webhook, you must start the webserver first then run the Advanced Insight snippet
+
+Using your IDE, right click on AsyncInsightTrigger and select Run.
+
+After the web server has started, run the Advanced Insight snippet with foreman.
+````sh
+foreman run java -cp build/libs/nexmo-java-code-snippets-with-dependencies.jar com.nexmo.quickstart.insight.AdvancedInsightAsync
+````
+
 ## Request an Example
 
 Please [raise an issue](https://github.com/nexmo-community/nexmo-java-quickstart/issues) to request an example that isn't present within the quickstart. Pull requests will be gratefully received.
 
 ## License
 
-This code is licensed under the [MIT](LICENSE.txt) license.
+This code is licensed under the [MIT](LICENSE.md) license.
 
 [gradle]: https://gradle.org/
 [foreman]: https://github.com/ddollar/foreman

README.md

@@ -1,28 +1,32 @@
 
-apply plugin: 'java'
+plugins {
+ id 'java'
+}
 
 // Uncomment the following lines to work with a local copy of nexmo-java:
-// configurations.all {
-//    resolutionStrategy.dependencySubstitution {
-//        substitute module("com.nexmo:client") with project(":client")
-//    }
-// }
+ configurations.all {
+    resolutionStrategy.dependencySubstitution {
+        substitute module("com.nexmo:client") with project(":client")
+    }
+ }
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    testCompile 'junit:junit:4.12'
+    testImplementation 'junit:junit:4.12'
 
-    compile 'com.nexmo:client:5.2.0'
-    compile "com.sparkjava:spark-core:2.6.0"
-    compile 'javax.xml.bind:jaxb-api:2.3.0'
+    implementation 'com.nexmo:client:5.2.0'
+    implementation 'com.sparkjava:spark-core:2.6.0'
+    implementation 'javax.xml.bind:jaxb-api:2.3.0'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.9.9'
 }
 
-task fatJar(type: Jar, dependsOn:configurations.runtime) {
-    baseName = project.name + '-with-dependencies'
-    from { configurations.runtime.collect { it.isDirectory() ? it : zipTree(it) } }
+task fatJar(type: Jar, dependsOn:configurations.runtimeClasspath) {
+    archiveBaseName = project.name + '-with-dependencies'
+    from { configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } }
     with jar
 }
+
 assemble.dependsOn fatJar

build.gradle

@@ -1,4 +1,4 @@
 // Uncomment the following (and update the path if necessary)
 // to work with a local copy of nexmo-java:
-//include ':client'
-//project(':client').projectDir = new File(settingsDir, '../nexmo-java')
+include ':client'
+project(':client').projectDir = new File(settingsDir, '../nexmo-java')

settings.gradle

@@ -40,5 +40,7 @@ public static void main(String... args) {
         ApplicationClient applicationClient = client.getApplicationClient();
 
         applicationClient.deleteApplication(NEXMO_APPLICATION_ID);
+
+        System.out.println("Application Deleted");
     }
 }

src/main/java/com/nexmo/quickstart/application/DeleteApplication.java

@@ -49,7 +49,7 @@ public static void main(String[] args) throws Exception {
             return "";
         };
 
-        Spark.port(8080);
+        Spark.port(3000);
         Spark.get("/webhooks/inbound-sms", inboundSmsAsGet);
         Spark.post("/webhooks/inbound-sms", inboundSmsAsPost);
     }

src/main/java/com/nexmo/quickstart/sms/ReceiveSMS.java

@@ -40,12 +40,12 @@ public static void main(String[] args) throws Exception {
 
         NexmoClient client = NexmoClient.builder().apiKey(NEXMO_API_KEY).apiSecret(NEXMO_API_SECRET).build();
 
-        TextMessage message = new TextMessage("Acme Inc", TO_NUMBER, "Blue Öyster Cult \uD83E\uDD18", true);
+        TextMessage message = new TextMessage("17603592332", TO_NUMBER, "Blue Öyster Cult \uD83E\uDD18", true);
 
         SmsSubmissionResponse responses = client.getSmsClient().submitMessage(message);
 
         for (SmsSubmissionResponseMessage responseMessage : responses.getMessages()) {
-            System.out.println(message);
+            System.out.println(responseMessage);
         }
     }
 }

src/main/java/com/nexmo/quickstart/sms/SendUnicodeMessage.java

@@ -28,7 +28,7 @@ public static void main(String... args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/cr0wst/9417cac4c0d9004805a04aed403ae94a/raw/b95e3cd5126587d25986e0bf832eb33a7538394d/tts_long.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         /*

src/main/java/com/nexmo/quickstart/voice/EarmuffCall.java

@@ -31,7 +31,7 @@
 import static com.nexmo.quickstart.Util.envVar;
 
 public class ModifyCall {
-    public static void main(String[] args) throws Exception {
+    public static void main(String[] args) throws InterruptedException {
         configureLogging();
 
         String NEXMO_NUMBER = envVar("NEXMO_NUMBER");
@@ -48,7 +48,7 @@ public static void main(String[] args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/ChrisGuzman/d6add5b23a8cf913dcdc5a8eabc223ef/raw/a1eb52e0ce2d3cef98bab14d27f3adcdff2af881/long_talk.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         Thread.sleep(20000);

src/main/java/com/nexmo/quickstart/voice/ModifyCall.java

@@ -28,7 +28,7 @@ public static void main(String... args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/cr0wst/9417cac4c0d9004805a04aed403ae94a/raw/b95e3cd5126587d25986e0bf832eb33a7538394d/tts_long.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         /*

src/main/java/com/nexmo/quickstart/voice/MuteCall.java

@@ -25,7 +25,7 @@ public static void main(String[] args) throws Exception {
         Call call = new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://nexmo-community.github.io/ncco-examples/first_call_talk.json"
+                "https://nexmo-community.github.io/ncco-examples/talk.json"
         );
         call.setEventUrl(EVENT_URL);
         client.getVoiceClient().createCall(call);

src/main/java/com/nexmo/quickstart/voice/OutboundTextToSpeechWithEventUrl.java

@@ -51,7 +51,7 @@ public static void main(String[] args) {
 
             res.type("application/json");
 
-            return new Ncco(record, connect);
+            return new Ncco(record, connect).toJson();
         };
 
         /*

src/main/java/com/nexmo/quickstart/voice/RecordCallSplitAudio.java

@@ -28,7 +28,7 @@ public static void main(String... args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/cr0wst/9417cac4c0d9004805a04aed403ae94a/raw/b95e3cd5126587d25986e0bf832eb33a7538394d/tts_long.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         /*

src/main/java/com/nexmo/quickstart/voice/RetrieveCallInfo.java

@@ -1,5 +1,6 @@
 package com.nexmo.quickstart.voice;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.nexmo.client.NexmoClient;
 import com.nexmo.client.voice.CallInfoPage;
@@ -13,7 +14,7 @@
 import static com.nexmo.quickstart.Util.envVar;
 
 public class RetrieveInfoForAllCalls {
-    public static void main(String... args) throws Exception {
+    public static void main(String... args) throws Exception, JsonProcessingException {
         configureLogging();
 
         final String NEXMO_APPLICATION_ID = envVar("NEXMO_APPLICATION_ID");
@@ -32,7 +33,14 @@ public static void main(String... args) throws Exception {
         CallInfoPage calls = client.getVoiceClient().listCalls(filter);
 
         // com.fasterxml.jackson.databind.ObjectMapper;
-        System.out.println(new ObjectMapper().writer().writeValueAsString(calls));
+        calls.iterator().forEachRemaining(callInfo -> {
+            try {
+                System.out.println(new ObjectMapper().writer().writeValueAsString(callInfo));
+            } catch (JsonProcessingException e) {
+                e.printStackTrace();
+            }
+        });
+
     }
 
     private static Date getTodaysDate() {

src/main/java/com/nexmo/quickstart/voice/RetrieveInfoForAllCalls.java

@@ -25,6 +25,7 @@
 import com.nexmo.client.NexmoClient;
 import com.nexmo.client.voice.Call;
 import com.nexmo.client.voice.CallEvent;
+import com.nexmo.client.voice.DtmfResponse;
 
 import static com.nexmo.quickstart.Util.configureLogging;
 import static com.nexmo.quickstart.Util.envVar;
@@ -46,13 +47,15 @@ public static void main(String[] args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/ChrisGuzman/d6add5b23a8cf913dcdc5a8eabc223ef/raw/a1eb52e0ce2d3cef98bab14d27f3adcdff2af881/long_talk.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         Thread.sleep(20000);
 
         final String UUID = call.getUuid();
         final String DIGITS = "332393";
-        client.getVoiceClient().sendDtmf(UUID, DIGITS);
+
+        DtmfResponse response = client.getVoiceClient().sendDtmf(UUID, DIGITS);
+        System.out.println(response.getMessage());
     }
 }

src/main/java/com/nexmo/quickstart/voice/SendDtmfToCall.java

@@ -3,6 +3,7 @@
 import com.nexmo.client.NexmoClient;
 import com.nexmo.client.voice.Call;
 import com.nexmo.client.voice.CallEvent;
+import com.nexmo.client.voice.TalkResponse;
 import com.nexmo.client.voice.VoiceName;
 
 import static com.nexmo.quickstart.Util.configureLogging;
@@ -33,6 +34,7 @@ public static void main(String[] args) throws Exception {
         client.getVoiceClient().startTalk(UUID, TEXT, VoiceName.KIMBERLY, 0);
 
         Thread.sleep(5000);
-        client.getVoiceClient().stopTalk(UUID);
+        TalkResponse response = client.getVoiceClient().stopTalk(UUID);
+        System.out.println(response.getMessage());
     }
 }

src/main/java/com/nexmo/quickstart/voice/SendTalkToCall.java

@@ -46,7 +46,7 @@ public static void main(String[] args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/ChrisGuzman/d6add5b23a8cf913dcdc5a8eabc223ef/raw/a1eb52e0ce2d3cef98bab14d27f3adcdff2af881/long_talk.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         Thread.sleep(20000);

src/main/java/com/nexmo/quickstart/voice/StreamAudioToCall.java

@@ -3,6 +3,7 @@
 import com.nexmo.client.NexmoClient;
 import com.nexmo.client.voice.Call;
 import com.nexmo.client.voice.CallEvent;
+import com.nexmo.client.voice.ModifyCallResponse;
 
 import static com.nexmo.quickstart.Util.configureLogging;
 import static com.nexmo.quickstart.Util.envVar;
@@ -28,7 +29,7 @@ public static void main(String... args) throws Exception {
         CallEvent call = client.getVoiceClient().createCall(new Call(
                 TO_NUMBER,
                 NEXMO_NUMBER,
-                "https://gist.githubusercontent.com/cr0wst/9417cac4c0d9004805a04aed403ae94a/raw/b95e3cd5126587d25986e0bf832eb33a7538394d/tts_long.json"
+                "https://gist.githubusercontent.com/yallen011/e720c5d127791e0995a9359c195c1eaa/raw/882dfde8e26ebcd167628a576d244d8915cbaac4/long-tts.json"
         ));
 
         /*
@@ -38,6 +39,7 @@ public static void main(String... args) throws Exception {
 
         final String UUID = call.getUuid();
         final String NCCO_URL = "https://developer.nexmo.com/ncco/tts.json";
-        client.getVoiceClient().transferCall(UUID, NCCO_URL);
+        ModifyCallResponse response = client.getVoiceClient().transferCall(UUID, NCCO_URL);
+        System.out.println(response);
     }
 }