feat(api): add user contact retrieval API with stub implementation (#35)

Author: yakimenko73

lib/webtrit_adapter_client.ex

@@ -157,6 +157,16 @@ defmodule WebtritAdapterClient do
     request(client, options)
   end
 
+  @spec get_user_contact(Tesla.Client.t(), String.t()) :: result()
+  def get_user_contact(client, user_id) do
+    options = [
+      method: :get,
+      url: "/user/contacts/#{user_id}"
+    ]
+
+    request(client, options)
+  end
+
   @spec get_user_history_list(Tesla.Client.t(), Tesla.Env.query() | nil) :: result()
   def get_user_history_list(client, query \\ []) do
     options = [

lib/webtrit_adapter_web/controllers/api/v1/user/contact_controller.ex

@@ -6,7 +6,7 @@ defmodule WebtritAdapterWeb.Api.V1.User.ContactController do
   alias Portabilling.Api
   alias WebtritAdapterWeb.Api.V1.CastAndValidateRenderError
   alias WebtritAdapterWeb.Api.V1.FallbackController
-  alias WebtritAdapterWeb.Api.V1.CommonResponse
+  alias WebtritAdapterWeb.Api.V1.{CommonResponse, CommonSchema}
   alias WebtritAdapterWeb.Api.V1.User.ContactSchema
   alias WebtritAdapterWeb.Api.V1.User.ControllerMapping
 
@@ -104,4 +104,40 @@ defmodule WebtritAdapterWeb.Api.V1.User.ContactController do
         {:error, :internal_server_error, :external_api_issue}
     end
   end
+
+  OpenApiSpexExt.operation(:show,
+    summary: "Retrieve a contact by UserId",
+    description: """
+    Retrieve extension number and name of a specific user
+    within the same **Adaptee** by their UserId.
+    """,
+    parameters: [
+      user_id: [
+        in: :path,
+        description: "The unique identifier of the user",
+        schema: CommonSchema.UserId
+      ]
+    ],
+    responses: [
+      CommonResponse.unauthorized(),
+      CommonResponse.forbidden(),
+      CommonResponse.not_found([
+        :session_not_found,
+        :user_not_found,
+        :contact_not_found
+      ]),
+      CommonResponse.unprocessable(),
+      CommonResponse.external_api_issue(),
+      CommonResponse.functionality_not_implemented(),
+      ok: {
+        "Ok",
+        "application/json",
+        CommonSchema.Contact
+      }
+    ]
+  )
+
+  def show(_conn, _params, _user_id) do
+    {:error, :not_implemented, :functionality_not_implemented}
+  end
 end

lib/webtrit_adapter_web/router.ex

@@ -69,7 +69,7 @@ defmodule WebtritAdapterWeb.Router do
 
       scope "/user", User do
         resources "/", InfoController, only: [:show, :delete], singleton: true
-        resources "/contacts", ContactController, only: [:index]
+        resources "/contacts", ContactController, only: [:index, :show], params: "user_id"
         resources "/history", HistoryController, only: [:index]
         resources "/recordings", RecordingController, only: [:show], param: "recording_id"