Merge pull request #7 from PersephonyAPI/issue/6

Deseao · web-flow · commit 648697f1e771 · 2018-11-29T15:44:28.000-06:00
Remove CallsRequester#create with callConnectUrl and statusCallbackUrl
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ To include the SDK in your build, follow the instructions on [Jitpack](https://j
 
 ## Testing your Installation
 
-Test the SDK is working by sending yourself a phone call.
+Test the SDK is working by sending yourself a text message.
 
 ```java
 public class Example {
@@ -26,18 +26,12 @@ public class Example {
     public static void main(String[] args) throws PersyException {
         PersyClient client = new PersyClient(accountId, authToken);
 
-        client.calls.create(To, From, "https://www.persephony.com/testApp/voice", (String)null);
+        client.messages.create(From, To, "Welcome to Persephony!");
     }
 }
 ```
 
-When you run this code you should get a phone call. On answering the call, you should hear a short message ("Thanks for using Persephony!"). This indicates that you've successfully setup your SDK.
-
-`https://www.persephony.com/testApp/voice` contains a small Persephony application that also uses the Persephony Java SDK. When a request is made to its `/voice` endpoint, it will respond with the following PerCL script, which produces the message you heard.
-
-```json
-[{"Say": {"text": "Thanks for using Persephony!"}}]
-```
+When you run this code you should get a text message.
 
 ### Running Unit Tests
 
diff --git a/src/main/java/com/vailsys/persephony/api/call/CallOptions.java b/src/main/java/com/vailsys/persephony/api/call/CallOptions.java
@@ -7,7 +7,6 @@
  * creating a Call.
  *
  * @see com.vailsys.persephony.api.call.CallsRequester#create(String,String,String,CallOptions)
- * @see com.vailsys.persephony.api.call.CallsRequester#create(String,String,String,String,CallOptions)
  */
 public class CallOptions extends CommonFields {
 	/**
diff --git a/src/main/java/com/vailsys/persephony/api/call/CallsRequester.java b/src/main/java/com/vailsys/persephony/api/call/CallsRequester.java
@@ -129,69 +129,6 @@ public Call create(String to, String from, String applicationId, CallOptions cal
 		}
 	}
 
-	/**
-	 * Create a new call through the Persephony API using an unregistered
-	 * Persephony-compatible application. This function wraps an HTTP POST
-	 * request to the Persephony API's /Account/$accountId/Calls endpoint. This
-	 * places a new call from the {@code actingAccountId} to the number
-	 * provided from the number provided.
-	 *
-	 * @param to The number to call out to (DNIS). This can be any valid phone
-	 * number formatted in E.164 format.
-	 * @param from The number to call from (ANI). This must be a number
-	 * purchase from Persephony or a verified phone number owned by the user.
-	 * @param callConnectUrl Like with a registered Persephony application,
-	 * this is the URL that Persephony makes requests to when the call
-	 * connects. See the {@code callConnectUrl} in the Persephony Application
-	 * documentation.
-	 * @param statusCallbackUrl The URL to which Persephony will report call
-	 * status notifications. See the {@code statusCallbackUrl} in the
-	 * Persephony Application documentation.
-	 *
-	 * @return The {@link com.vailsys.persephony.api.call.Call} object returned by
-	 * Persephony that represents the call that was created.
-	 * @throws PersyException when the request fails or the JSON is invalid.
-	 */
-	public Call create(String to, String from, String callConnectUrl, String statusCallbackUrl) throws PersyException {
-		return this.create(to, from, callConnectUrl, statusCallbackUrl, null);
-	}
-
-	/**
-	 * Create a new call through the Persephony API using an unregistered
-	 * Persephony-compatible application. This function wraps an HTTP POST
-	 * request to the Persephony API's /Account/$accountId/Calls endpoint. This
-	 * places a new call from the {@code actingAccountId} to the number
-	 * provided from the number provided.
-	 *
-	 * @param to The number to call out to (DNIS). This can be any valid phone
-	 * number formatted in E.164 format.
-	 * @param from The number to call from (ANI). This must be a number
-	 * purchase from Persephony or a verified phone number owned by the user.
-	 * @param callConnectUrl Like with a registered Persephony application,
-	 * this is the URL that Persephony makes requests to when the call
-	 * connects. See the {@code callConnectUrl} in the Persephony Application
-	 * documentation.
-	 * @param statusCallbackUrl The URL to which Persephony will report call
-	 * status notifications. See the {@code statusCallbackUrl} in the
-	 * Persephony Application documentation.
-	 * @param callOptions Optional arguments that can be provided when creating
-	 * a call. See Persephony documentation for details.
-	 *
-	 * @return The {@link com.vailsys.persephony.api.call.Call} object returned by
-	 * Persephony that represents the call that was created.
-	 *
-	 * @see com.vailsys.persephony.api.call.CallOptions
-	 * @throws PersyException when the request fails or the JSON is invalid.
-	 */
-	public Call create(String to, String from, String callConnectUrl, String statusCallbackUrl, CallOptions callOptions) throws PersyException {
-		try {
-			return Call.fromJson(this.POST(this.path, new CreateCallRequest(to, from, callConnectUrl, statusCallbackUrl, callOptions).toJson()));
-		}
-		catch (JsonIOException jioe) {
-			throw new PersyJSONException(jioe);
-		}
-	}
-
 	/**
 	 * Retrieve a list of calls associated with the {@code actingAccountId}.
 	 * This wraps a HTTP GET request to the Persephony API's
diff --git a/src/main/java/com/vailsys/persephony/api/call/CreateCallRequest.java b/src/main/java/com/vailsys/persephony/api/call/CreateCallRequest.java
@@ -19,9 +19,6 @@ class CreateCallRequest {
 
 	public String applicationId;
 
-	public String callConnectUrl;
-	public String statusCallbackUrl;
-
 	public CallOptions options;
 
 	/**
@@ -37,59 +34,9 @@ class CreateCallRequest {
 	 * a call. See Persephony documentation for details.
 	 */
 	public CreateCallRequest(String to, String from, String applicationId, CallOptions options) {
-		this(to, from, null, null, applicationId, options);
-	}
-
-	/**
-	 * Setup a new call creation payload using an raw URLs.
-	 *
-	 * @param to The number to call out to (DNIS). This can be any valid phone
-	 * number formatted in E.164 format.
-	 * @param from The number to call from (ANI). This must be a number
-	 * purchase from Persephony or a verified phone number owned by the user.
-	 * @param callConnectUrl Like with a registered Persephony application,
-	 * this is the URL that Persephony makes requests to when the call
-	 * connects. See the {@code callConnectUrl} in the Persephony Application
-	 * documentation.
-	 * @param statusCallbackUrl The URL to which Persephony will report call
-	 * status notifications. See the {@code statusCallbackUrl} in the
-	 * Persephony Application documentation.
-	 * @param options Optional arguments that can be provided when creating
-	 * a call. See Persephony documentation for details.
-	 */
-	public CreateCallRequest(String to, String from, String callConnectUrl, String statusCallbackUrl, CallOptions options) {
-		this(to, from, callConnectUrl, statusCallbackUrl, null, options);
-	}
-
-	/**
-	 * Setup a new call creation payload. This is a catch all constructor that
-	 * exists to reduce code duplication but should never be used outside the
-	 * overloaded constructors for this class.
-	 *
-	 * @param to The number to call out to (DNIS). This can be any valid phone
-	 * number formatted in E.164 format.
-	 * @param from The number to call from (ANI). This must be a number
-	 * purchase from Persephony or a verified phone number owned by the user.
-	 * @param applicationId The {@code applicationId} for the registered
-	 * Persephony application which should handle this call.
-	 * @param callConnectUrl Like with a registered Persephony application,
-	 * this is the URL that Persephony makes requests to when the call
-	 * connects. See the {@code callConnectUrl} in the Persephony Application
-	 * documentation.
-	 * @param statusCallbackUrl The URL to which Persephony will report call
-	 * status notifications. See the {@code statusCallbackUrl} in the
-	 * Persephony Application documentation.
-	 * @param options Optional arguments that can be provided when creating
-	 * a call. See Persephony documentation for details.
-	 */
-	private CreateCallRequest(String to, String from, String callConnectUrl, String statusCallbackUrl, String applicationId, CallOptions options) {
 		this.to = to;
 		this.from = from;
-
 		this.applicationId = applicationId;
-
-		this.callConnectUrl = callConnectUrl;
-		this.statusCallbackUrl = statusCallbackUrl;
 		this.options = options;
 	}
 
diff --git a/src/test/java/com/vailsys/persephony/api/call/CallsRequesterTest.java b/src/test/java/com/vailsys/persephony/api/call/CallsRequesterTest.java
@@ -76,48 +76,11 @@ public void placeApplicationCallWithOptions(String from, String to, String appli
 		assertTrue(this.callsR.create(from, to, applicationId, options).equals(Call.fromJson(CallsRequesterTest.aTestCall)));
 	}
 
-	@Then("^place a call from (\\+?[1-9]\\d{1,14}) to (\\+?[1-9]\\d{1,14}) using callConnectUrl$")
-	public void placeCallConnectUrlCall(String from, String to) throws Throwable {
-		String callConnectUrl = "http://vailsys.com/callConnect";
-		CreateCallRequest query = new CreateCallRequest(from, to, callConnectUrl, (String)null, null);
-
-		Helper.getMockServer().when(
-			request().withMethod("POST").withPath(this.callsR.getPath()).withBody(query.toJson())
-		).respond(
-			response().withStatusCode(200).withBody(CallsRequesterTest.aTestCall)
-		);
-
-		assertTrue(this.callsR.create(from, to, callConnectUrl, (String)null).equals(Call.fromJson(CallsRequesterTest.aTestCall)));
-	}
-
-	@Then("^place a call from (\\+?[1-9]\\d{1,14}) to (\\+?[1-9]\\d{1,14}) using callConnectUrl with options$")
-	public void placeCallConnectUrlCallWithOptions(String from, String to) throws Throwable {
-		Integer timeout = 55;
-		String callConnectUrl = "http://vailsys.com/callConnect";
-
+	@Then("^place a call from (\\+?[1-9]\\d{1,14}) to (\\+?[1-9]\\d{1,14}) using application (AP[0-9A-Fa-f]{40}) with requestId (.*)$")
+	public void placeApplicationCallWithRequestId(String from, String to, String applicationId, String requestId) throws Throwable {
 		CallOptions options = new CallOptions();
-		options.setTimeout(timeout);
-
-		CreateCallRequest query = new CreateCallRequest(to, from, callConnectUrl, (String)null, options);
-
-		Helper.getMockServer().when(
-			request().withMethod("POST").withPath(this.callsR.getPath()).withBody(query.toJson())
-		).respond(
-			response().withStatusCode(200).withBody(CallsRequesterTest.aTestCall)
-		);
-
-		assertTrue(this.callsR.create(to, from, callConnectUrl, (String)null, options).equals(Call.fromJson(CallsRequesterTest.aTestCall)));
-	}
-
-	@Then("^place a call from (\\+?[1-9]\\d{1,14}) to (\\+?[1-9]\\d{1,14}) using callConnectUrl with requestId (.*)")
-	public void placeCallConnectUrlCallWithRequestId(String from, String to, String requestId) throws Throwable {
-		String callConnectUrl = "http://vailsys.com/callConnect";
-
-		CallOptions options = new CallOptions();
-		options.setTimeout(10);
 		options.setRequestId(requestId);
-
-		CreateCallRequest query = new CreateCallRequest(to, from, callConnectUrl, (String)null, options);
+		CreateCallRequest query = new CreateCallRequest(to, from, applicationId, options);
 
 
 		Helper.getMockServer().when(
@@ -126,49 +89,13 @@ public void placeCallConnectUrlCallWithRequestId(String from, String to, String
 				response().withStatusCode(200).withBody(CallsRequesterTest.aTestCall)
 		);
 
-		this.callsR.create(to, from, callConnectUrl, (String)null, options);
+		assertTrue(this.callsR.create(to, from, applicationId, options).equals(Call.fromJson(CallsRequesterTest.aTestCall)));
 
 		Helper.getMockServer().verify(
-				request().withMethod("POST").withPath(this.callsR.getPath()).withBody(new JsonBody("{from:'" + from + "',to:'" + to + "', callConnectUrl:'" + callConnectUrl + "',timeout:10,requestId:'" +requestId + "'}")),
+				request().withMethod("POST").withPath(this.callsR.getPath()).withBody(new JsonBody("{from:'" + from + "',to:'" + to + "', applicationId:'" + applicationId + "',requestId:'" +requestId + "'}")),
 				VerificationTimes.exactly(1)
 		);
 	}
-
-	@Then("^place a call from (\\+?[1-9]\\d{1,14}) to (\\+?[1-9]\\d{1,14}) using callConnectUrl and statusCallbackUrl$")
-	public void placeCallConnectUrlCallWithStatusCallbackUrl(String from, String to) throws Throwable {
-		String callConnectUrl = "http://vailsys.com/call";
-		String statusCallbackUrl = "http://vailsys.com/status";
-		CreateCallRequest query = new CreateCallRequest(from, to, callConnectUrl, statusCallbackUrl, null);
-
-		Helper.getMockServer().when(
-			request().withMethod("POST").withPath(this.callsR.getPath()).withBody(query.toJson())
-		).respond(
-			response().withStatusCode(200).withBody(CallsRequesterTest.aTestCall)
-		);
-
-		assertTrue(this.callsR.create(from, to, callConnectUrl, statusCallbackUrl).equals(Call.fromJson(CallsRequesterTest.aTestCall)));
-	}
-
-	@Then("^place a call from (\\+?[1-9]\\d{1,14}) to (\\+?[1-9]\\d{1,14}) using callConnectUrl and statusCallbackUrl with options$")
-	public void placeCallConnectUrlCallAndStatusCallbackUrlWithOptions(String from, String to) throws Throwable {
-		Integer timeout = 55;
-		String callConnectUrl = "http://vailsys.com/call";
-		String statusCallbackUrl = "http://vailsys.com/status";
-
-		CallOptions options = new CallOptions();
-		options.setTimeout(timeout);
-
-		CreateCallRequest query = new CreateCallRequest(from, to, callConnectUrl, statusCallbackUrl, options);
-
-		Helper.getMockServer().when(
-			request().withMethod("POST").withPath(this.callsR.getPath()).withBody(query.toJson())
-		).respond(
-			response().withStatusCode(200).withBody(CallsRequesterTest.aTestCall)
-		);
-
-		assertTrue(this.callsR.create(from, to, callConnectUrl, statusCallbackUrl, options).equals(Call.fromJson(CallsRequesterTest.aTestCall)));
-	}
-
 	
 	@Then("^get a list of calls$")
 	public void getCallsList() throws Throwable {
diff --git a/src/test/java/com/vailsys/persephony/api/call/CreateCallRequestTest.java b/src/test/java/com/vailsys/persephony/api/call/CreateCallRequestTest.java
@@ -1,7 +1,5 @@
 package com.vailsys.persephony.api.call;
 
-import static com.vailsys.persephony.json.PersyGson.gson;
-
 import cucumber.api.java.en.Given;
 import cucumber.api.java.en.Then;
 
@@ -16,8 +14,6 @@ public class CreateCallRequestTest {
 
 	String applicationId = null;
 
-	String callConnectUrl = null;
-	String statusCallbackUrl = null;
 
 	CallOptions options = null;
 	String sendDigits = null;
@@ -26,10 +22,8 @@ public class CreateCallRequestTest {
 
 	CreateCallRequest request;
 
-	@Given("^an applicationId based CreateCallRequest without options.$")
-	public void createWithApplicationId() {
-		this.callConnectUrl = null;
-		this.statusCallbackUrl = null;
+	@Given("^a CreateCallRequest without options.$")
+	public void create() {
 		this.applicationId = "AP1234567890123456789012345678901234567890";
 
 		this.sendDigits = null;
@@ -40,24 +34,8 @@ public void createWithApplicationId() {
 		this.request = new CreateCallRequest(this.to, this.from, this.applicationId, null);
 	}
 
-	@Given("^an url based CreateCallRequest without options.$")
-	public void createWithUrls() {
-		this.callConnectUrl = "127.0.0.1/call";
-		this.statusCallbackUrl = "127.0.0.1/status";
-		this.applicationId = null;
-
-		this.sendDigits = null;
-		this.ifMachine = null;
-		this.timeout = null;
-		this.options = null;
-
-		this.request = new CreateCallRequest(this.to, this.from, this.callConnectUrl, this.statusCallbackUrl, null);
-	}
-
-	@Given("^an applicationId based CreateCallRequest with options.$")
-	public void createWithApplicationIdAndOptions() {
-		this.statusCallbackUrl = null;
-		this.applicationId = null;
+	@Given("^a CreateCallRequest with options.$")
+	public void createWithOptions() {
 		this.applicationId = "AP1234567890123456789012345678901234567890";
 
 		this.sendDigits = "1234";
@@ -72,44 +50,18 @@ public void createWithApplicationIdAndOptions() {
 		this.request = new CreateCallRequest(this.to, this.from, this.applicationId, this.options);
 	}
 
-	@Given("^an url based CreateCallRequest with options.$")
-	public void createWithUrlsAndOptions() {
-		this.callConnectUrl = "127.0.0.1/call";
-		this.statusCallbackUrl = "127.0.0.1/status";
-		this.applicationId = null;
-
-		this.sendDigits = "1234";
-		this.ifMachine = IfMachine.HANGUP;
-		this.timeout = 16;
-
-		this.options = new CallOptions();
-		this.options.setSendDigits(this.sendDigits);
-		this.options.setIfMachine(this.ifMachine);
-		this.options.setTimeout(this.timeout);
-
-		this.request = new CreateCallRequest(this.to, this.from, this.callConnectUrl, this.statusCallbackUrl, this.options);
-	}
-
 	@Then("^check that it set all fields correctly.$")
 	public void checkToField() {
 		assertThat(this.request.to, is(this.to));
 		assertThat(this.request.from, is(this.from));
 		assertThat(this.request.applicationId, is(this.applicationId));
-		assertThat(this.request.callConnectUrl, is(this.callConnectUrl));
-		assertThat(this.request.statusCallbackUrl, is(this.statusCallbackUrl));
 		assertThat(this.request.options, is(this.options));
 	}
 
-	@Then("^check that it can produce JSON from the applicationId based object.$")
-	public void checkJsonAppIdNoOptions() {
+	@Then("^check that it can produce JSON from the base object.$")
+	public void checkJson() {
 		String json = "{\"to\":\""+this.request.to+"\",\"from\":\""+this.request.from+"\",\"applicationId\":\""+this.request.applicationId+"\"}";
 		assertThat(this.request.toJson(), is(json));
 	}
 
-	@Then("^check that it can produce JSON from the url based object with options.$")
-	public void checkJsonUrlWithOptions() {
-		String json = "{\"to\":\""+this.request.to+"\",\"from\":\""+this.request.from+"\",\"callConnectUrl\":\""+this.request.callConnectUrl+"\",\"statusCallbackUrl\":\""+this.request.statusCallbackUrl+"\",\"sendDigits\":\""+this.sendDigits+"\",\"ifMachine\":\"hangup\",\"timeout\":"+this.timeout+"}";
-		assertThat(this.request.toJson(), is(json));
-	}
-
 }
diff --git a/src/test/resources/com/vailsys/persephony/api/call/CallsRequester.feature b/src/test/resources/com/vailsys/persephony/api/call/CallsRequester.feature
diff --git a/src/test/resources/com/vailsys/persephony/api/call/CreateCallRequest.feature b/src/test/resources/com/vailsys/persephony/api/call/CreateCallRequest.feature

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`* creating a Call.`
`8`	`8`	`*`
`9`	`9`	`* @see com.vailsys.persephony.api.call.CallsRequester#create(String,String,String,CallOptions)`
`10`		`- * @see com.vailsys.persephony.api.call.CallsRequester#create(String,String,String,String,CallOptions)`
`11`	`10`	`*/`
`12`	`11`	`public class CallOptions extends CommonFields {`
`13`	`12`	`/**`