Merge branch 'develop'

Author: Gerald Unterrainer

pom.xml

@@ -10,7 +10,7 @@
 
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>rest-client</artifactId>
-	<version>0.0.9</version>
+	<version>0.0.10</version>
 	<name>RestClient</name>
 	<packaging>jar</packaging>
 
@@ -33,5 +33,10 @@
 			<artifactId>okhttp</artifactId>
 			<version>3.14.9</version>
 		</dependency>
+		<dependency>
+			<groupId>com.squareup.okio</groupId>
+			<artifactId>okio</artifactId>
+			<version>1.17.2</version>
+		</dependency>
 	</dependencies>
 </project>

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

@@ -41,6 +41,19 @@ protected enum Retry {
 	protected Map<String, String> headers = new HashMap<>();
 	protected Map<String, String> parameters = new HashMap<>();
 	protected Retry retry = Retry.ONCE;
+	protected boolean isGZipped;
+
+	/**
+	 * Adds the header {@code "Content-Encoding": "gzip"} which triggers
+	 * GZIP-compression within our RestClient.
+	 *
+	 * @return a {@link BaseBuilder} to provide a fluent interface.
+	 */
+	@SuppressWarnings("unchecked")
+	public R gzip() {
+		addHeader("Content-Encoding", "gzip");
+		return (R) this;
+	}
 
 	/**
 	 * Add a string to an URL.

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

@@ -0,0 +1,92 @@
+package info.unterrainer.commons.restclient;
+
+import java.io.IOException;
+
+import okhttp3.Headers;
+import okhttp3.Interceptor;
+import okhttp3.MediaType;
+import okhttp3.Request;
+import okhttp3.Request.Builder;
+import okhttp3.RequestBody;
+import okhttp3.Response;
+import okhttp3.ResponseBody;
+import okio.BufferedSink;
+import okio.GzipSink;
+import okio.GzipSource;
+import okio.Okio;
+
+public class GzipInterceptor implements Interceptor {
+	@Override
+	public Response intercept(final Interceptor.Chain chain) throws IOException {
+
+		Request originalRequest = chain.request();
+
+		if (acceptGzipAlreadySetAndNoContentToZip(originalRequest))
+			return chain.proceed(originalRequest);
+
+		Builder newRequestBuilder = originalRequest.newBuilder().addHeader("Accept-Encoding", "gzip");
+		if (contentToZip(originalRequest))
+			newRequestBuilder.method(originalRequest.method(), gzip(originalRequest.body()));
+
+		// Make the call.
+		Response response = chain.proceed(newRequestBuilder.build());
+
+		if (isGzipped(response))
+			return unzip(response);
+		else
+			return response;
+	}
+
+	private boolean acceptGzipAlreadySetAndNoContentToZip(final Request originalRequest) {
+		return originalRequest.header("Accept-Encoding") == "gzip"
+				&& (originalRequest.body() == null || originalRequest.header("Content-Encoding") != "gzip");
+	}
+
+	private RequestBody gzip(final RequestBody body) {
+		return new RequestBody() {
+			@Override
+			public MediaType contentType() {
+				return body.contentType();
+			}
+
+			@Override
+			public long contentLength() {
+				return -1; // We don't know the compressed length in advance!
+			}
+
+			@Override
+			public void writeTo(final BufferedSink sink) throws IOException {
+				BufferedSink gzipSink = Okio.buffer(new GzipSink(sink));
+				body.writeTo(gzipSink);
+				gzipSink.close();
+			}
+		};
+	}
+
+	private Response unzip(final Response response) throws IOException {
+
+		if (response.body() == null)
+			return response;
+
+		GzipSource gzipSource = new GzipSource(response.body().source());
+		String bodyString = Okio.buffer(gzipSource).readUtf8();
+
+		ResponseBody responseBody = ResponseBody.create(response.body().contentType(), bodyString);
+
+		Headers strippedHeaders = response.headers()
+				.newBuilder()
+				.removeAll("Content-Encoding")
+				.removeAll("Content-Length")
+				.build();
+		return response.newBuilder().headers(strippedHeaders).body(responseBody).message(response.message()).build();
+
+	}
+
+	private Boolean isGzipped(final Response response) {
+		return response.header("Content-Encoding") != null && response.header("Content-Encoding").equals("gzip");
+	}
+
+	private boolean contentToZip(final Request originalRequest) {
+		return originalRequest.body() != null && originalRequest.header("Content-Encoding") == "gzip";
+	}
+}

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

@@ -0,0 +1,7 @@
+package info.unterrainer.commons.restclient;
+
+public class Information {
+	public static final String name = "REST-Client";
+	public static final String buildTime = "2021-06-28T07:57:53Z";
+	public static final String pomVersion = "0.0.10";
+}

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

@@ -48,6 +48,7 @@ public RestClient(final JsonMapper jsonMapper, final String userName, final Stri
 				.connectTimeout(connectTimeoutInMillis, TimeUnit.MILLISECONDS)
 				.readTimeout(readTimeoutInMillis, TimeUnit.MILLISECONDS)
 				.writeTimeout(writeTimeoutInMillis, TimeUnit.MILLISECONDS)
+				.addInterceptor(new GzipInterceptor())
 				.followRedirects(true);
 		if (userName != null || password != null)
 			c.authenticator((route, response) -> {