Merge pull request #219 from jwien001/main

Add request! function

.github/workflows/elixir.yml

@@ -18,7 +18,7 @@ jobs:
              otp: '25.x'
            lint: lint
 
-   runs-on: ubuntu-18.04
+   runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - uses: actions/cache@v2

lib/finch.ex

@@ -344,4 +344,19 @@ defmodule Finch do
     build(method, url, headers, body)
     |> request(name, opts)
   end
+
+  @doc """
+  Sends an HTTP request and returns a `Finch.Response` struct
+  or raises an exception in case of failure.
+
+  See `request/3` for more detailed information.
+  """
+  @spec request!(Request.t(), name(), keyword()) ::
+          Response.t()
+  def request!(%Request{} = req, name, opts \\ []) do
+    case request(req, name, opts) do
+      {:ok, resp} -> resp
+      {:error, exception} -> raise exception
+    end
+  end
 end

test/finch_test.exs

@@ -530,6 +530,30 @@ defmodule FinchTest do
     end
   end
 
+  describe "request!/3" do
+    test "returns response on successful request", %{bypass: bypass, finch_name: finch_name} do
+      start_supervised!({Finch, name: finch_name})
+      query_string = "query=value"
+
+      Bypass.expect_once(bypass, "GET", "/", fn conn ->
+        assert conn.query_string == query_string
+        Plug.Conn.send_resp(conn, 200, "OK")
+      end)
+
+      assert %{status: 200} =
+               Finch.build(:get, endpoint(bypass, "?" <> query_string))
+               |> Finch.request!(finch_name)
+    end
+
+    test "raises exception on bad request", %{finch_name: finch_name} do
+      start_supervised!({Finch, name: finch_name})
+
+      assert_raise(Mint.TransportError, fn ->
+        Finch.build(:get, "http://idontexist.wat") |> Finch.request!(finch_name)
+      end)
+    end
+  end
+
   describe "connection options" do
     test "are passed through to the conn", %{bypass: bypass} do
       expect_any(bypass)