Merge branch 'develop'

Author: Gerald Unterrainer

pom.xml

@@ -10,7 +10,7 @@
 
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>rest-client</artifactId>
-	<version>0.0.3</version>
+	<version>0.0.4</version>
 	<name>RestClient</name>
 	<packaging>jar</packaging>
 

src/main/java/info/unterrainer/commons/restclient/BaseBuilder.java

@@ -1,7 +1,14 @@
 package info.unterrainer.commons.restclient;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
+
+import org.mapstruct.ap.internal.util.Strings;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JavaType;
@@ -10,7 +17,9 @@
 import info.unterrainer.commons.restclient.RestClient.HttpGetCall;
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 
+@Slf4j
 @RequiredArgsConstructor(access = AccessLevel.PACKAGE)
 public abstract class BaseBuilder<T, R extends BaseBuilder<T, R>> {
 
@@ -23,36 +32,121 @@ protected enum Retry {
 	protected final RestClient client;
 	protected final Class<?> type;
 
-	protected String url;
+	protected List<String> url = new ArrayList<>();
 	protected JavaType javaType;
 	protected TypeReference<?> typeReference;
 	protected Map<String, String> headers = new HashMap<>();
+	protected Map<String, String> parameters = new HashMap<>();
 	protected Retry retry = Retry.ONCE;
 
+	/**
+	 * Add a string to an URL.
+	 * <p>
+	 * The URL will be composed of all the parts you add.<br>
+	 * The parts will be checked for trailing and leading slashes, which will be
+	 * removed before adding the URL-part (separated by slashes).<br>
+	 * Null values are ignored. So to add an empty URL-part that should result in
+	 * something like this: 'here/we//go' (between here and go), just add an empty
+	 * string.
+	 *
+	 * @param urlPart the part of the URL to add
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
 	@SuppressWarnings("unchecked")
-	public R url(final String url) {
-		this.url = url;
+	public R addUrl(final String urlPart) {
+		if (urlPart != null)
+			url.add(urlPart);
 		return (R) this;
 	}
 
+	/**
+	 * Sets the return-type to be of {@link ListJson} with the generic type you
+	 * provided when starting this builder.
+	 *
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
 	@SuppressWarnings("unchecked")
 	public R isListJson() {
 		javaType = client.jsonMapper.getTypeFactory().constructParametricType(ListJson.class, type);
 		return (R) this;
 	}
 
+	/**
+	 * Adds a header to the call.
+	 * <p>
+	 * All the headers are saved to a map and added later on, when you make the
+	 * call.<br>
+	 * Input containing null as key or value will be ignored.
+	 *
+	 * @param key   the key of the header-field to add
+	 * @param value the value of the header-field to add
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
 	@SuppressWarnings("unchecked")
 	public R addHeader(final String key, final String value) {
-		headers.put(key, value);
+		if (key != null && value != null)
+			headers.put(key, value);
+		return (R) this;
+	}
+
+	/**
+	 * Add a query-parameter to the call.
+	 * <p>
+	 * All the parameters are saved in a map and added later on, when you make the
+	 * call.<br>
+	 * The parameters will be checked for trailing and leading '&' and '?', which
+	 * will be removed before adding it to the map.<br>
+	 * Input containing null as key or value will be ignored.
+	 *
+	 * @param key   the key of the parameter to add
+	 * @param value the value of the parameter to add
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
+	@SuppressWarnings("unchecked")
+	public R addParam(final String key, final String value) {
+		if (key != null && value != null) {
+			String k = cutLeadingTrailing("&", key);
+			k = cutLeadingTrailing("?", k);
+			try {
+				k = URLEncoder.encode(k, "UTF-8");
+			} catch (UnsupportedEncodingException e) {
+				log.error(String.format("The given key-value %s could not be URL-encoded.", k), e);
+			}
+
+			String v = cutLeadingTrailing("&", value);
+			v = cutLeadingTrailing("?", v);
+			try {
+				v = URLEncoder.encode(v, "UTF-8");
+			} catch (UnsupportedEncodingException e) {
+				log.error(String.format("The given parameter-value %s could not be URL-encoded.", v), e);
+			}
+			parameters.put(k, v);
+		}
 		return (R) this;
 	}
 
+	/**
+	 * By specifying this, you tell the client to retry this call for some time, if
+	 * it fails (see {@link RestClient#retryShort(HttpGetCall)}).
+	 * <p>
+	 * The default is to just try it once and then give up and return an error.
+	 *
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
 	@SuppressWarnings("unchecked")
 	public R retryShort() {
 		retry = Retry.SHORT;
 		return (R) this;
 	}
 
+	/**
+	 * By specifying this, you tell the client to retry this call for quite some
+	 * time, if it fails (see {@link RestClient#retryEnduring(HttpGetCall)}).
+	 * <p>
+	 * The default is to just try it once and then give up and return an error.
+	 *
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
 	@SuppressWarnings("unchecked")
 	public R retryEnduring() {
 		retry = Retry.ENDURING;
@@ -63,7 +157,21 @@ public R retryEnduring() {
 
 	protected abstract HttpGetCall<T> provideJavaTypeCall(String url, JavaType javaType, Map<String, String> headers);
 
+	/**
+	 * Execute the call.
+	 *
+	 * @return the return value of type you specified when you created this builder.
+	 */
 	public T execute() {
+		String url = Strings.join(this.url.stream().map(e -> cutLeadingTrailing("/", e)).collect(Collectors.toList()),
+				"/");
+
+		String params = Strings.join(
+				parameters.entrySet().stream().map(e -> e.getKey() + "=" + e.getValue()).collect(Collectors.toList()),
+				"&");
+		if (!params.isBlank())
+			url += "?" + params;
+
 		switch (retry) {
 		case SHORT:
 			return client.retryShort(provide(url, type, javaType, headers));
@@ -81,4 +189,13 @@ private HttpGetCall<T> provide(final String url, final Class<?> type, final Java
 			return provideJavaTypeCall(url, javaType, headers);
 		return provideCall(url, (Class<T>) type, headers);
 	}
+
+	private String cutLeadingTrailing(final String s, final String input) {
+		String u = input;
+		while (u.startsWith(s))
+			u = u.substring(1);
+		while (u.endsWith(s))
+			u = u.substring(0, u.length() - 2);
+		return u;
+	}
 }

src/main/java/info/unterrainer/commons/restclient/KeycloakContext.java

@@ -75,7 +75,7 @@ void update(final RestClient client) {
 			response = client.<TokenResponseJson>post(TokenResponseJson.class)
 					.addHeader("Content-Type", "application/x-www-form-urlencoded")
 					.addHeader("Accept", "application/json")
-					.url(keycloakUrl)
+					.addUrl(keycloakUrl)
 					.retryShort()
 					.mediaType("application/x-www-form-urlencoded")
 					.body(body)

src/test/java/info/unterrainer/commons/restclient/BuilderTests.java

@@ -20,7 +20,7 @@ public void BeforeAll() {
 	@Test
 	public void correctCredentialsConnect() {
 		String response = restClient.<String>get(String.class)
-				.url("https://elite-server.lan.elite-zettl.at/")
+				.addUrl("https://elite-server.lan.elite-zettl.at/")
 				.execute();
 
 		System.out.println(response);
@@ -29,7 +29,7 @@ public void correctCredentialsConnect() {
 	@Test
 	public void jsonDeserializationWorks() {
 		MessageJson response = restClient.<MessageJson>get(MessageJson.class)
-				.url("https://elite-server.lan.elite-zettl.at/")
+				.addUrl("https://elite-server.lan.elite-zettl.at/")
 				.execute();
 
 		System.out.println(response);

src/test/java/info/unterrainer/commons/restclient/KeycloakContextTests.java

@@ -25,7 +25,8 @@ public void BeforeAll() {
 	public void listJsonDeserializationWorks() {
 		ListJson<EliteUserJson> users = kcc.<ListJson<EliteUserJson>>get(restClient, EliteUserJson.class)
 				.isListJson()
-				.url("https://elite-server.lan.elite-zettl.at/users")
+				.addUrl("https://elite-server.lan.elite-zettl.at")
+				.addUrl("users")
 				.execute();
 
 		System.out.println(users);