Merge pull request #34 from smartrent/CMWAPIS-174-202_json_response

lib/response.ex

@@ -63,6 +63,13 @@ defmodule Solicit.Response do
     |> json(%{details: details})
   end
 
+  @spec accepted(Plug.Conn.t(), term(), term()) :: Plug.Conn.t()
+  def accepted(conn, details, fields \\ nil) do
+    conn
+    |> put_status(:accepted)
+    |> json(as_json(details, fields))
+  end
+
   # 204
   @doc """
   Returns a successful no_content response. Normally used when deleting.

md/response.md

@@ -69,6 +69,25 @@ This is used for an accepted response. Normally used to signify that the request
 
 Returns `Plug.Conn.t()` with a status of `202` and the details passed in as the payload.
 
+### Response.accepted/3
+
+Usage:
+
+This is used for an accepted response. Normally used to signify that the request was accepted, but might not have finished processing.
+
+```elixir
+  Response.accepted(conn, %{license_plate: _, state: _}, fields)
+```
+
+Returns `Plug.Conn.t()` with a status of `202` and a payload of
+
+```elixir
+%{
+  "license_plate" => _,
+  "state" => _
+}
+```
+
 ### Response.no_content/1
 
 Usage:

test/response_test.exs

@@ -92,6 +92,28 @@ defmodule Solicit.ResponseTest do
     end
   end
 
+  describe "accepted/3" do
+    test "Should return 202 with all fields by default" do
+      response =
+        build_conn()
+        |> Response.accepted(%{license_plate: "Test", state: "VA"})
+        |> json_response(:accepted)
+
+      assert response == %{"license_plate" => "Test", "state" => "VA"}
+    end
+
+    test "Should return 202 with defined fields" do
+      response =
+        build_conn()
+        |> Response.accepted(%{license_plate: "Test", state: "VA"}, [
+          :license_plate
+        ])
+        |> json_response(:accepted)
+
+      assert response == %{"license_plate" => "Test"}
+    end
+  end
+
   describe "no_content" do
     test "Should return 204" do
       assert Response.no_content(build_conn()).status == 204