Rename option to auto-decompress

Author: adamw

core/src/main/scala/sttp/client4/RequestOptions.scala

@@ -10,7 +10,8 @@ case class RequestOptions(
     readTimeout: Duration,
     maxRedirects: Int,
     redirectToGet: Boolean,
-    disableAutoDecompression: Boolean,
+    decompressResponseBody: Boolean,
+    compressRequestBody: Option[String],
     httpVersion: Option[HttpVersion],
     loggingOptions: LoggingOptions
 )

core/src/main/scala/sttp/client4/SttpApi.scala

@@ -31,7 +31,8 @@ trait SttpApi extends SttpExtensions with UriInterpolator {
         DefaultReadTimeout,
         FollowRedirectsBackend.MaxRedirects,
         redirectToGet = false,
-        disableAutoDecompression = false,
+        decompressResponseBody = true,
+        compressRequestBody = None,
         httpVersion = None,
         loggingOptions = LoggingOptions()
       ),

core/src/main/scala/sttp/client4/internal/BodyFromResponseAs.scala

@@ -26,7 +26,7 @@ abstract class BodyFromResponseAs[F[_], RegularResponse, WSResponse, Stream](imp
           m.eval(g(result, meta)).map((_, replayableBody))
         }
 
-      case (rfm: ResponseAsFromMetadata[T, _], _) => doApply(rfm(meta), meta, response)
+      case (rfm: ResponseAsFromMetadata[T, _] @unchecked, _) => doApply(rfm(meta), meta, response)
 
       case (ResponseAsBoth(l, r), _) =>
         doApply(l, meta, response).flatMap {

core/src/main/scala/sttp/client4/requestBuilder.scala

@@ -301,15 +301,27 @@ trait PartialRequestBuilder[+PR <: PartialRequestBuilder[PR, R], +R]
     */
   def redirectToGet(r: Boolean): PR = withOptions(options.copy(redirectToGet = r))
 
-  /** Disables auto-decompression of response bodies which are received with supported `Content-Encoding headers. */
-  def disableAutoDecompression: PR = withOptions(options.copy(disableAutoDecompression = true))
+  /** Disables auto-decompression of response bodies which are received with supported `Content-Encoding` headers. */
+  def disableAutoDecompression: PR = withOptions(options.copy(decompressResponseBody = false))
 
-  /** True iff auto-decompression is disabled.
+  /** True iff auto-decompression is enabled (which is the default).
     *
     * @see
     *   disableAutoDecompression
     */
-  def autoDecompressionDisabled: Boolean = options.disableAutoDecompression
+  def autoDecompressionEnabled: Boolean = options.decompressResponseBody
+
+  /** Compress the request body with the given encoding.
+    *
+    * The backend must support the encoding, otherwise an exception is thrown / a failed effect is returned. All
+    * backends support the [[sttp.model.Encodings.Gzip]] and [[sttp.model.Encodings.Deflate]] encodings.
+    *
+    * Note that the server might not support compressed bodies. By default request bodies are not compressed.
+    *
+    * @see
+    *   [[sttp.model.Encodings]]
+    */
+  def compressBody(encoding: String): PR = withOptions(options.copy(compressRequestBody = Some(encoding)))
 
   /** Set the HTTP version with which this request should be sent. Supported only in a few backends. */
   def httpVersion(version: HttpVersion): PR = withOptions(options.copy(httpVersion = Some(version)))

core/src/main/scalajvm/sttp/client4/httpurlconnection/HttpURLConnectionBackend.scala

@@ -250,7 +250,7 @@ class HttpURLConnectionBackend private (
 
     val code = StatusCode(c.getResponseCode)
     val wrappedIs =
-      if (c.getRequestMethod != "HEAD" && !code.equals(StatusCode.NoContent) && !request.autoDecompressionDisabled) {
+      if (c.getRequestMethod != "HEAD" && !code.equals(StatusCode.NoContent) && request.autoDecompressionEnabled) {
         wrapInput(contentEncoding, handleNullInput(is))
       } else handleNullInput(is)
     val responseMetadata = ResponseMetadata(code, c.getResponseMessage, headers)

http4s-backend/src/main/scala/sttp/client4/http4s/Http4sBackend.scala

@@ -74,7 +74,7 @@ class Http4sBackend[F[_]: Async](
                   responseMetadata,
                   Left(
                     onFinalizeSignal(
-                      decompressResponseBodyIfNotHead(r.method, response, r.autoDecompressionDisabled),
+                      decompressResponseBodyIfNotHead(r.method, response, r.autoDecompressionEnabled),
                       signalBodyComplete
                     )
                   )
@@ -178,9 +178,9 @@ class Http4sBackend[F[_]: Async](
   private def decompressResponseBodyIfNotHead[T](
       m: Method,
       hr: http4s.Response[F],
-      disableAutoDecompression: Boolean
+      enableAutoDecompression: Boolean
   ): http4s.Response[F] =
-    if (m == Method.HEAD || disableAutoDecompression) hr else decompressResponseBody(hr)
+    if (m == Method.HEAD || !enableAutoDecompression) hr else decompressResponseBody(hr)
 
   private def decompressResponseBody(hr: http4s.Response[F]): http4s.Response[F] = {
     val body = hr.headers

okhttp-backend/src/main/scala/sttp/client4/okhttp/OkHttpBackend.scala

@@ -85,7 +85,7 @@ abstract class OkHttpBackend[F[_], S <: Streams[S], P](
       if (
         method != Method.HEAD && !res
           .code()
-          .equals(StatusCode.NoContent.code) && !request.autoDecompressionDisabled
+          .equals(StatusCode.NoContent.code) && request.autoDecompressionEnabled
       ) {
         encoding
           .filterNot(_.isEmpty)

pekko-http-backend/src/main/scala/sttp/client4/pekkohttp/PekkoHttpBackend.scala

@@ -134,15 +134,15 @@ class PekkoHttpBackend private (
     val body = bodyFromPekko(
       r.response,
       responseMetadata,
-      wsFlow.map(Right(_)).getOrElse(Left(decodePekkoResponse(hr, r.autoDecompressionDisabled)))
+      wsFlow.map(Right(_)).getOrElse(Left(decodePekkoResponse(hr, r.autoDecompressionEnabled)))
     )
 
     body.map(client4.Response(_, code, statusText, headers, Nil, r.onlyMetadata))
   }
 
   // http://doc.akka.io/docs/akka-http/10.0.7/scala/http/common/de-coding.html
-  private def decodePekkoResponse(response: HttpResponse, disableAutoDecompression: Boolean): HttpResponse =
-    if (!response.status.allowsEntity() || disableAutoDecompression) response
+  private def decodePekkoResponse(response: HttpResponse, enableAutoDecompression: Boolean): HttpResponse =
+    if (!response.status.allowsEntity() || !enableAutoDecompression) response
     else customEncodingHandler.orElse(EncodingHandler(standardEncoding)).apply(response -> response.encoding)
 
   private def standardEncoding: (HttpResponse, HttpEncoding) => HttpResponse = {