Move Req.Utils.stream_gzip/1

wojtekmach · Mar 15, 2024 · f822213 · f822213
1 parent dcb6b40
commit f822213
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 29 deletions.
diff --git a/lib/req/steps.ex b/lib/req/steps.ex
@@ -620,7 +620,7 @@ defmodule Req.Steps do
             :zlib.gzip(iodata)
 
           enumerable ->
-            gzip_stream(enumerable)
+            Req.Utils.stream_gzip(enumerable)
         end
 
       request
@@ -631,34 +631,6 @@ defmodule Req.Steps do
     end
   end
 
-  defp gzip_stream(enumerable) do
-    eof = make_ref()
-
-    enumerable
-    |> Stream.concat([eof])
-    |> Stream.transform(
-      fn ->
-        z = :zlib.open()
-        # https://github.com/erlang/otp/blob/OTP-26.0/erts/preloaded/src/zlib.erl#L551
-        :ok = :zlib.deflateInit(z, :default, :deflated, 16 + 15, 8, :default)
-        z
-      end,
-      fn
-        ^eof, z ->
-          buf = :zlib.deflate(z, [], :finish)
-          {buf, z}
-
-        data, z ->
-          buf = :zlib.deflate(z, data)
-          {buf, z}
-      end,
-      fn z ->
-        :ok = :zlib.deflateEnd(z)
-        :ok = :zlib.close(z)
-      end
-    )
-  end
-
   @doc """
   Runs the request using `Finch`.
 

diff --git a/lib/req/utils.ex b/lib/req/utils.ex
@@ -115,4 +115,41 @@ defmodule Req.Utils do
   def format_http_datetime(datetime) do
     Calendar.strftime(datetime, "%a, %d %b %Y %H:%M:%S GMT")
   end
+
+  @doc """
+  Returns a stream where each element is gzipped.
+
+  ## Examples
+
+      iex> gzipped = Req.Utils.stream_gzip(~w[foo bar baz]) |> Enum.to_list()
+      iex> :zlib.gunzip(gzipped)
+      "foobarbaz"
+  """
+  def stream_gzip(enumerable) do
+    eof = make_ref()
+
+    enumerable
+    |> Stream.concat([eof])
+    |> Stream.transform(
+      fn ->
+        z = :zlib.open()
+        # https://github.com/erlang/otp/blob/OTP-26.0/erts/preloaded/src/zlib.erl#L551
+        :ok = :zlib.deflateInit(z, :default, :deflated, 16 + 15, 8, :default)
+        z
+      end,
+      fn
+        ^eof, z ->
+          buf = :zlib.deflate(z, [], :finish)
+          {buf, z}
+
+        data, z ->
+          buf = :zlib.deflate(z, data)
+          {buf, z}
+      end,
+      fn z ->
+        :ok = :zlib.deflateEnd(z)
+        :ok = :zlib.close(z)
+      end
+    )
+  end
 end