Packages
arke_server
0.1.21
0.5.1
0.5.0
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-bulk.0
0.3.18
0.3.17
0.3.16
0.3.15
0.3.14
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.1.42
0.1.41
0.1.40
0.1.39
0.1.38
0.1.37
0.1.36
0.1.35
0.1.34
0.1.33
0.1.32
0.1.31
0.1.30
0.1.29
0.1.28
0.1.27
0.1.26
0.1.25
0.1.24
0.1.23
0.1.22
0.1.21
0.1.20
0.1.19
0.1.18
0.1.17
0.1.16
0.1.15
0.1.14
0.1.13
0.1.12
0.1.11
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Arke server
Current section
Files
Jump to
Current section
Files
lib/arke_server/response_manager.ex
# Copyright 2023 Arkemis S.r.l.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
defmodule ArkeServer.ResponseManager do
@moduledoc """
Module to standardize the responses.
The response body can be formatted as follow:
- %{items: [...], count: integer, messages: [...]}
- %{content: %{items: [...], count: integer, messages: [...]}}
- {content: ..., messages: [...]}
If the status is 204 then the body will be empty
"""
import Plug.Conn
defp get_content(%{items: items, count: count}, _encode) do
%{content: %{items: items, count: count}}
end
defp get_content(%{items: items}, encode) do
get_content(%{items: items, count: length(items)}, encode)
end
defp get_content(%{content: content}, _encode) do
%{content: content}
end
defp get_content(nil, _encode), do: %{content: nil}
defp get_content("", _encode), do: %{content: nil}
defp get_content(content, _encode) do
%{content: content}
end
def send_resp(conn, status, data, message \\ [], encode \\ :json)
def send_resp(conn, status, data, message, encode) when is_list(message) do
send_response(conn, status, data, message, encode)
end
@doc false
def send_resp(conn, status, data, message, encode) when is_map(message) do
send_response(conn, status, data, [message], encode)
end
def send_resp(conn, status, data, message, encode) when is_binary(message) do
send_response(conn, status, data, [%{context: nil, message: message}], encode)
end
def send_resp(conn, status, _data, _message, _encode) do
Plug.Conn.send_resp(conn, status, "")
end
@doc false
def send_resp(conn, 204), do: Plug.Conn.send_resp(conn, 204, "")
defp send_response(conn, status, data, messages, encode) do
data =
get_content(data, encode)
|> Map.put_new(:messages, messages)
with {:ok, data} <- Jason.encode(data) do
conn
|> Plug.Conn.put_resp_content_type("application/json")
|> Plug.Conn.send_resp(status, data)
else
_ -> Plug.Conn.send_resp(conn, 400, "invalid data format")
end
end
end