Skip to content

feat: Support multiple duplicate queryparams #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ try {
request.addHeader("Authorization", "Bearer YOUR_API_KEY");
request.addQueryParam("limit", "100");
request.addQueryParam("offset", "0");
// Will be parsed to categories=cake&categories=pie&categories=baking
request.addQueryParam("categories", "cake&pie&baking");
request.setBody("{\"name\": \"My Request Body\"}");
request.setMethod(Method.POST);
String param = "param";
Expand Down
15 changes: 14 additions & 1 deletion src/main/java/com/sendgrid/Client.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;
import java.util.Arrays;
import java.util.List;

import org.apache.http.Header;
import org.apache.http.HttpMessage;
Expand Down Expand Up @@ -129,8 +131,19 @@ public URI buildUri(String baseUri, String endpoint, Map<String, String> queryPa
builder.setPath(endpoint);

if (queryParams != null) {
String multiValueDelimiter = "&";

for (Map.Entry<String, String> entry : queryParams.entrySet()) {
builder.setParameter(entry.getKey(), entry.getValue());
String value = entry.getValue();

if (value.indexOf(multiValueDelimiter) != -1) {
List<String> values = Arrays.asList(value.split(multiValueDelimiter));
for (String val : values) {
builder.addParameter(entry.getKey(), val);
}
} else {
builder.setParameter(entry.getKey(), entry.getValue());
}
}
}

Expand Down
28 changes: 24 additions & 4 deletions src/test/java/com/sendgrid/ClientTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;

Expand Down Expand Up @@ -62,6 +64,7 @@ public void testbuildUri() {
Map<String,String> queryParams = new HashMap<String,String>();
queryParams.put("test1", "1");
queryParams.put("test2", "2");
queryParams.put("test3", "3&4&5");
try {
uri = client.buildUri(baseUri, endpoint, queryParams);
} catch (URISyntaxException ex) {
Expand All @@ -70,10 +73,23 @@ public void testbuildUri() {
Assert.assertTrue(errors.toString(), false);
}

String url = uri.toString();
System.out.println(url);
Assert.assertTrue(url.equals("https://api.test.com/endpoint?test2=2&test1=1") ||
url.equals("https://api.test.com/endpoint?test1=1&test2=2"));
URL url = null;
try {
url = uri.toURL();
} catch (MalformedURLException ex) {
StringWriter errors = new StringWriter();
ex.printStackTrace(new PrintWriter(errors));
Assert.assertTrue(errors.toString(), false);
}

Assert.assertTrue(url.getProtocol().equals("https"));
Assert.assertTrue(url.getHost().equals("api.test.com"));
Assert.assertTrue(url.getPath().equals("/endpoint"));
Assert.assertTrue(this.queryParamHasCorrectValue(url, "test1", "1"));
Assert.assertTrue(this.queryParamHasCorrectValue(url, "test2", "2"));
Assert.assertTrue(this.queryParamHasCorrectValue(url, "test3", "3"));
Assert.assertTrue(this.queryParamHasCorrectValue(url, "test3", "4"));
Assert.assertTrue(this.queryParamHasCorrectValue(url, "test3", "5"));
}

@Test
Expand Down Expand Up @@ -174,4 +190,8 @@ public void testPut() {
public void testDelete() {
testMethod(Method.DELETE, 204);
}

private boolean queryParamHasCorrectValue(URL url, String key, String value) {
return url.getQuery().indexOf(key + "=" + value) != -1;
}
}