Рефакторинг обработчиков. Часть 1 #21

src/handlers/admin/admin_handler_users.erl

@@ -1,61 +1,90 @@
 -module(admin_handler_users).
--include("records.hrl").
+-behaviour(cowboy_handler).
+
 -export([init/2]).
+-export([trails/0]).
+
+-include("records.hrl").
 
 init(Req, _Opts) ->
   case cowboy_req:method(Req) of
     <<"GET">> -> list_users(Req);
-    _ -> send_error(Req, 405, <<"Method not allowed">>)
+    _         -> handler_utils:send_error(Req, 405, <<"Method not allowed">>)
   end.
 
-list_users(Req) ->
-  case handler_auth:authenticate(Req) of
-    {ok, AdminId, Req1} ->
-      case admin_utils:is_admin(AdminId) of
-        true ->
-          {ok, Users} = core_user:list_users(),
-          send_json(Req1, 200, [user_to_map(U) || U <- Users]);
-        false ->
-          send_error(Req1, 403, <<"Admin access required">>)
-      end;
-    {error, Code, Message, Req1} ->
-      send_error(Req1, Code, Message)
-  end.
+trails() ->
+  [
+    #{
+      path        => <<"/v1/admin/users">>,
+      method      => <<"GET">>,
+      description => <<"List all users (admin)">>,
+      tags        => [<<"Users">>],
+      parameters  => [
+        #{name => <<"role">>,   in => <<"query">>, schema => #{type => string, enum => [<<"user">>, <<"bot">>]}},
+        #{name => <<"status">>, in => <<"query">>, schema => #{type => string, enum => [<<"active">>, <<"frozen">>, <<"deleted">>]}},
+        #{name => <<"q">>,      in => <<"query">>, schema => #{type => string}, description => <<"Search by email or nickname">>},
+        #{name => <<"limit">>,  in => <<"query">>, schema => #{type => integer}},
+        #{name => <<"offset">>, in => <<"query">>, schema => #{type => integer}}
+      ],
+      responses => #{
+        200 => #{
+          description => <<"Array of users">>,
+          content => #{<<"application/json">> => #{schema => #{
+            type  => array,
+            items => user_schema()
+          }}}
+        }
+      }
+    }
+  ].
 
-user_to_map(User) when is_map(User) ->
+user_schema() ->
   #{
-    id         => maps:get(id, User),
-    email      => maps:get(email, User),
-    role       => maps:get(role, User, <<"user">>),
-    status     => maps:get(status, User, <<"active">>),
-    created_at => datetime_to_iso8601(maps:get(created_at, User)),
-    updated_at => datetime_to_iso8601(maps:get(updated_at, User))
-  };
-user_to_map(User) ->
-  #{
-    id         => User#user.id,
-    email      => User#user.email,
-    role       => atom_to_binary(User#user.role, utf8),
-    status     => atom_to_binary(User#user.status, utf8),
-    created_at => datetime_to_iso8601(User#user.created_at),
-    updated_at => datetime_to_iso8601(User#user.updated_at)
+    type       => object,
+    properties => #{
+      id           => #{type => string},
+      email        => #{type => string, format => <<"email">>},
+      role         => #{type => string, enum => [<<"user">>, <<"bot">>]},
+      status       => #{type => string, enum => [<<"active">>, <<"frozen">>, <<"deleted">>]},
+      reason       => #{type => string, nullable => true},
+      nickname     => #{type => string, nullable => true},
+      avatar_url   => #{type => string, nullable => true},
+      timezone     => #{type => string, nullable => true},
+      language     => #{type => string, nullable => true},
+      social_links => #{type => array, items => #{type => string}, nullable => true},
+      phone        => #{type => string, nullable => true},
+      preferences  => #{type => object, nullable => true},
+      last_login   => #{type => string, format => <<"date-time">>},
+      created_at   => #{type => string, format => <<"date-time">>},
+      updated_at   => #{type => string, format => <<"date-time">>}
+    }
   }.
 
-datetime_to_iso8601({{Y,M,D},{H,Min,S}}) ->
-  iolist_to_binary(io_lib:format("~4..0B-~2..0B-~2..0BT~2..0B:~2..0B:~2..0BZ", [Y,M,D,H,Min,S]));
-datetime_to_iso8601(_) -> null.
+list_users(Req) ->
+  case handler_utils:auth_admin(Req) of
+    {ok, _AdminId, Req1} ->
+      Filters = parse_user_filters(Req1),
+      Pagination = handler_utils:parse_pagination_params(Req1),
+      {ok, Total, Users} = logic_user:list_users_admin(Filters, Pagination),
+      Json = [handler_utils:user_to_json(U) || U <- Users],
+      ExtraHeaders = pagination_headers(Pagination, Total),
+      handler_utils:send_json(Req1, 200, Json, ExtraHeaders);
+    {error, Code, Msg, Req1} ->
+      handler_utils:send_error(Req1, Code, Msg)
+  end.
 
-send_json(Req, Status, Data) ->
-  Headers = #{
-    <<"content-type">> => <<"application/json">>,
-    <<"access-control-allow-origin">> => <<"*">>,
-    <<"access-control-expose-headers">> => <<"Content-Range">>
-  },
-  Body = jsx:encode(Data),
-  cowboy_req:reply(Status, Headers, Body, Req),
-  {ok, Body, []}.
+parse_user_filters(Req) ->
+  Qs = cowboy_req:parse_qs(Req),
+  #{
+    role   => proplists:get_value(<<"role">>, Qs),
+    status => proplists:get_value(<<"status">>, Qs),
+    q      => proplists:get_value(<<"q">>, Qs)
+  }.
 
-send_error(Req, Status, Message) ->
-  Body = jsx:encode(#{error => Message}),
-  cowboy_req:reply(Status, #{<<"content-type">> => <<"application/json">>}, Body, Req),
-  {ok, Body, []}.
+pagination_headers(#{limit := Limit, offset := Offset}, Total) ->
+  RangeEnd = min(Offset + Limit - 1, Total - 1),
+  #{
+    <<"content-range">>                 => iolist_to_binary(io_lib:format("items ~B-~B/~B", [Offset, RangeEnd, Total])),
+    <<"x-total-count">>                 => integer_to_binary(Total),
+    <<"access-control-expose-headers">> => <<"Content-Range, X-Total-Count">>
+  }.