Replace Client.streaming with Client.stream

http4s · Sep 30, 2018 · a0a565d · a0a565d
1 parent 1de73ae
commit a0a565d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/client/src/main/scala/org/http4s/client/Client.scala b/client/src/main/scala/org/http4s/client/Client.scala
@@ -80,8 +80,14 @@ trait Client[F[_]] {
   @deprecated("Use toHttpApp. Call `.mapF(OptionT.liftF)` if OptionT is really desired.", "0.19")
   def toHttpService: HttpService[F]
 
+  /** Run the request as a stream.  The response lifecycle is equivalent
+    * to the returned Stream's. */
+  def stream(req: Request[F]): Stream[F, Response[F]]
+
+  @deprecated("Use `client.stream(req).flatMap(f)`", "0.19.0-RC1")
   def streaming[A](req: Request[F])(f: Response[F] => Stream[F, A]): Stream[F, A]
 
+  @deprecated("Use `Stream.eval(req).flatMap(client.stream).flatMap(f)`", "0.19.0-RC1")
   def streaming[A](req: F[Request[F]])(f: Response[F] => Stream[F, A]): Stream[F, A]
 
   def expectOr[A](req: Request[F])(onError: Response[F] => F[Throwable])(

diff --git a/client/src/main/scala/org/http4s/client/DefaultClient.scala b/client/src/main/scala/org/http4s/client/DefaultClient.scala
@@ -117,11 +117,14 @@ private[client] abstract class DefaultClient[F[_]](implicit F: Bracket[F, Throwa
   def toHttpService: HttpService[F] =
     toHttpApp.mapF(OptionT.liftF(_))
 
+  def stream(req: Request[F]): Stream[F, Response[F]] =
+    Stream.resource(run(req))
+
   def streaming[A](req: Request[F])(f: Response[F] => Stream[F, A]): Stream[F, A] =
-    Stream.resource(run(req)).flatMap(f)
+    stream(req).flatMap(f)
 
   def streaming[A](req: F[Request[F]])(f: Response[F] => Stream[F, A]): Stream[F, A] =
-    Stream.eval(req).flatMap(streaming(_)(f))
+    Stream.eval(req).flatMap(stream).flatMap(f)
 
   def expectOr[A](req: Request[F])(onError: Response[F] => F[Throwable])(
       implicit d: EntityDecoder[F, A]): F[A] = {

diff --git a/client/src/test/scala/org/http4s/client/ClientSyntaxSpec.scala b/client/src/test/scala/org/http4s/client/ClientSyntaxSpec.scala
@@ -237,28 +237,21 @@ class ClientSyntaxSpec extends Http4sSpec with Http4sClientDsl[IO] with MustThro
         EntityDecoder.text[IO].orElse(edec)) must returnValue("Accept: text/*, image/jpeg")
     }
 
-    "streaming returns a stream" in {
+    "stream returns a stream" in {
       client
-        .streaming(req)(_.body.through(fs2.text.utf8Decode))
-        .compile
-        .toVector
-        .unsafeRunSync() must_== Vector("hello")
-    }
-
-    "streaming returns a stream from a request task" in {
-      client
-        .streaming(req)(_.body.through(fs2.text.utf8Decode))
+        .stream(req)
+        .flatMap(_.body.through(fs2.text.utf8Decode))
         .compile
         .toVector
         .unsafeRunSync() must_== Vector("hello")
     }
 
     "streaming disposes of the response on success" in {
-      assertDisposes(_.streaming(req)(_.body).compile.drain)
+      assertDisposes(_.stream(req).compile.drain)
     }
 
     "streaming disposes of the response on failure" in {
-      assertDisposes(_.streaming(req)(_ => Stream.raiseError[IO](SadTrombone)).compile.drain)
+      assertDisposes(_.stream(req).flatMap(_ => Stream.raiseError[IO](SadTrombone)).compile.drain)
     }
 
     "toService disposes of the response on success" in {