feat: add show admin endpoint

wip

Author: Yashin Santos

apps/rest_api/lib/controllers/admin/user.ex

@@ -26,4 +26,20 @@ defmodule RestAPI.Controller.Admin.User do
         error
     end
   end
+
+  def show(conn, %{"id" => username} = params) do
+    params
+    |> Map.put(:username, username)
+    |> ResourceManager.get_identity()
+    |> case do
+      {:ok, identity} when is_map(identity) ->
+        conn
+        |> put_status(:created)
+        |> put_view(User)
+        |> render("show.json", response: identity)
+
+      {:error, error_reason} ->
+        error_reason
+    end
+  end
 end

apps/rest_api/lib/ports/resource_manager.ex

@@ -7,16 +7,25 @@ defmodule RestAPI.Ports.ResourceManager do
   @type possible_create_identity_response ::
           {:ok, struct()} | {:error, Ecto.Changeset.t() | :invalid_params}
 
+  @type possible_get_identity_responses ::
+          {:ok, struct()} | {:error, :not_found | :invalid_params}
+
   @doc "Delegates to ResourceManager.create_identity/1"
   @callback create_identity(input :: map()) :: possible_create_identity_response()
 
   @doc "Delegates to ResourceManager.password_allowed?/1"
   @callback password_allowed?(password :: String.t()) :: boolean()
 
+  @callback get_identity(input :: String.t()) :: possible_get_identity_responses()
+
   @doc "Create a new identity with it's credentials"
   @spec create_identity(input :: map()) :: possible_create_identity_response()
   def create_identity(input), do: implementation().create_identity(input)
 
+  @doc "Returns an user or application identity seaching by the given input"
+  @spec get_identity(input :: String.t()) :: possible_get_identity_responses()
+  def get_identity(input), do: implementation().get_identity(input)
+
   @doc "Checks if the given password is strong enough to be used"
   @spec password_allowed?(password :: String.t()) :: boolean()
   def password_allowed?(password), do: implementation().password_allowed?(password)

apps/rest_api/lib/views/admin/user.ex

@@ -13,4 +13,15 @@ defmodule RestAPI.Views.Admin.User do
       update_at: response.updated_at
     }
   end
+
+  def render("show.json", %{response: response}) do
+    %{
+      id: response.id,
+      username: response.username,
+      status: response.status,
+      is_admin: response.is_admin,
+      inserted_at: response.inserted_at,
+      updated_at: response.updated_at
+    }
+  end
 end

apps/rest_api/test/controllers/admin/user_test.exs

@@ -5,6 +5,7 @@ defmodule RestAPI.Controllers.Admin.User do
   alias RestAPI.Ports.{AuthenticatorMock, AuthorizerMock, ResourceManagerMock}
 
   @create_endpoint "/admin/v1/users"
+  @show_endpoint "/admin/v1/users/"
 
   describe "POST #{@create_endpoint}" do
     setup do
@@ -163,6 +164,63 @@ defmodule RestAPI.Controllers.Admin.User do
     end
   end
 
+  describe "GET #{@show_endpoint}" do
+    setup do
+      access_token = "my-access-token"
+      claims = default_claims()
+
+      {:ok, access_token: access_token, claims: claims, user: insert!(:user)}
+    end
+
+    test "should render user identity", %{
+      conn: conn,
+      access_token: access_token,
+      claims: claims,
+      user: user
+    } do
+      username = user.username
+
+      expect(AuthenticatorMock, :validate_access_token, fn token ->
+        assert access_token == token
+        {:ok, claims}
+      end)
+
+      expect(AuthenticatorMock, :get_session, fn %{"jti" => jti} ->
+        assert claims["jti"] == jti
+        {:ok, success_session(claims)}
+      end)
+
+      expect(AuthorizerMock, :authorize_admin, fn %Plug.Conn{} -> :ok end)
+
+      expect(ResourceManagerMock, :get_identity, fn input ->
+        assert is_map(input)
+
+        {:ok,
+         %{
+           id: user.id,
+           inserted_at: NaiveDateTime.utc_now(),
+           is_admin: user.is_admin,
+           status: user.status,
+           updated_at: NaiveDateTime.utc_now(),
+           username: username
+         }}
+      end)
+
+      assert %{
+               "id" => _id,
+               "inserted_at" => _inserted_at,
+               "updated_at" => _updated_at,
+               "is_admin" => false,
+               "status" => "active",
+               "username" => ^username
+             } =
+               conn
+               |> put_req_header("authorization", "Bearer #{access_token}")
+               |> get(@show_endpoint <> "username")
+               |> json_response(201)
+    end
+  end
+
   defp default_claims do
     %{
       "jti" => "03eds74a-c291-4b5f",

apps/rest_api/test/support/conn_case.ex

@@ -24,6 +24,7 @@ defmodule RestAPI.ConnCase do
       import Phoenix.ConnTest
       import RestAPI.ConnCase
       import Mox
+      import ResourceManager.Factory
 
       alias RestAPI.Router.Helpers, as: Routes