added api spec

docs/API/pleroma_api.md

@@ -49,7 +49,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
 * Method: `POST`
 * Authentication: required
 * Params:
-    * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
+    * `list`: STRING or FILE containing a whitespace-separated list of accounts to block
 * Response: HTTP 200 on success, 500 on error
 
 ## `/api/pleroma/mutes_import`
@@ -57,7 +57,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
 * Method: `POST`
 * Authentication: required
 * Params:
-    * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
+    * `list`: STRING or FILE containing a whitespace-separated list of accounts to mute
 * Response: HTTP 200 on success, 500 on error
 
 

lib/pleroma/web/api_spec/operations/user_import_operation.ex

@@ -0,0 +1,80 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.ApiSpec.UserImportOperation do
+  alias OpenApiSpex.Operation
+  alias OpenApiSpex.Schema
+  alias Pleroma.Web.ApiSpec.Schemas.ApiError
+
+  import Pleroma.Web.ApiSpec.Helpers
+
+  @spec open_api_operation(atom) :: Operation.t()
+  def open_api_operation(action) do
+    operation = String.to_existing_atom("#{action}_operation")
+    apply(__MODULE__, operation, [])
+  end
+
+  def follow_operation do
+    %Operation{
+      tags: ["follow_import"],
+      summary: "Imports your follows.",
+      operationId: "UserImportController.follow",
+      requestBody: request_body("Parameters", import_request(), required: true),
+      responses: %{
+        200 => ok_response(),
+        500 => Operation.response("Error", "application/json", ApiError)
+      },
+      security: [%{"oAuth" => ["write:follow"]}]
+    }
+  end
+
+  def blocks_operation do
+    %Operation{
+      tags: ["blocks_import"],
+      summary: "Imports your blocks.",
+      operationId: "UserImportController.blocks",
+      requestBody: request_body("Parameters", import_request(), required: true),
+      responses: %{
+        200 => ok_response(),
+        500 => Operation.response("Error", "application/json", ApiError)
+      },
+      security: [%{"oAuth" => ["write:blocks"]}]
+    }
+  end
+
+  def mutes_operation do
+    %Operation{
+      tags: ["mutes_import"],
+      summary: "Imports your mutes.",
+      operationId: "UserImportController.mutes",
+      requestBody: request_body("Parameters", import_request(), required: true),
+      responses: %{
+        200 => ok_response(),
+        500 => Operation.response("Error", "application/json", ApiError)
+      },
+      security: [%{"oAuth" => ["write:mutes"]}]
+    }
+  end
+
+  defp import_request do
+    %Schema{
+      type: :object,
+      required: [:list],
+      properties: %{
+        list: %Schema{
+          description:
+            "STRING or FILE containing a whitespace-separated list of accounts to import.",
+          anyOf: [
+            %Schema{type: :string, format: :binary},
+            %Schema{type: :string}
+          ]
+        }
+      }
+    }
+  end
+
+  defp ok_response do
+    Operation.response("Ok", "application/json", %Schema{type: :string, example: "ok"})
+  end
+end

lib/pleroma/web/pleroma_api/controllers/user_import_controller.ex

@@ -9,16 +9,20 @@ defmodule Pleroma.Web.PleromaAPI.UserImportController do
 
   alias Pleroma.Plugs.OAuthScopesPlug
   alias Pleroma.User
+  alias Pleroma.Web.ApiSpec
 
   plug(OAuthScopesPlug, %{scopes: ["follow", "write:follows"]} when action == :follow)
   plug(OAuthScopesPlug, %{scopes: ["follow", "write:blocks"]} when action == :blocks)
   plug(OAuthScopesPlug, %{scopes: ["follow", "write:mutes"]} when action == :mutes)
 
-  def follow(conn, %{"list" => %Plug.Upload{path: path}}) do
+  plug(OpenApiSpex.Plug.CastAndValidate)
-    follow(conn, %{"list" => File.read!(path)})
+  defdelegate open_api_operation(action), to: ApiSpec.UserImportOperation
+
+  def follow(%{body_params: %{list: %Plug.Upload{path: path}}} = conn, _) do
+    follow(%Plug.Conn{conn | body_params: %{list: File.read!(path)}}, %{})
   end
 
-  def follow(%{assigns: %{user: follower}} = conn, %{"list" => list}) do
+  def follow(%{assigns: %{user: follower}, body_params: %{list: list}} = conn, _) do
     identifiers =
       list
       |> String.split("\n")
@@ -31,20 +35,20 @@ defmodule Pleroma.Web.PleromaAPI.UserImportController do
     json(conn, "job started")
   end
 
-  def blocks(conn, %{"list" => %Plug.Upload{path: path}}) do
+  def blocks(%{body_params: %{list: %Plug.Upload{path: path}}} = conn, _) do
-    blocks(conn, %{"list" => File.read!(path)})
+    blocks(%Plug.Conn{conn | body_params: %{list: File.read!(path)}}, %{})
   end
 
-  def blocks(%{assigns: %{user: blocker}} = conn, %{"list" => list}) do
+  def blocks(%{assigns: %{user: blocker}, body_params: %{list: list}} = conn, _) do
     User.Import.blocks_import(blocker, prepare_user_identifiers(list))
     json(conn, "job started")
   end
 
-  def mutes(conn, %{"list" => %Plug.Upload{path: path}}) do
+  def mutes(%{body_params: %{list: %Plug.Upload{path: path}}} = conn, _) do
-    mutes(conn, %{"list" => File.read!(path)})
+    mutes(%Plug.Conn{conn | body_params: %{list: File.read!(path)}}, %{})
   end
 
-  def mutes(%{assigns: %{user: user}} = conn, %{"list" => list}) do
+  def mutes(%{assigns: %{user: user}, body_params: %{list: list}} = conn, _) do
     User.Import.mutes_import(user, prepare_user_identifiers(list))
     json(conn, "job started")
   end

test/user/import_test.exs

@@ -3,7 +3,6 @@
 # SPDX-License-Identifier: AGPL-3.0-only
 
 defmodule Pleroma.User.ImportTest do
-
   alias Pleroma.Repo
   alias Pleroma.Tests.ObanHelpers
   alias Pleroma.User
@@ -37,7 +36,6 @@ defmodule Pleroma.User.ImportTest do
     end
   end
 
-
   describe "blocks_import" do
     test "it imports user blocks from list" do
       [user1, user2, user3] = insert_list(3, :user)

test/web/pleroma_api/controllers/user_import_controller_test.exs

@@ -23,9 +23,11 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
     test "it returns HTTP 200", %{conn: conn} do
       user2 = insert(:user)
 
-      assert "job started" == conn
+      assert "job started" ==
-      |> post("/api/pleroma/follow_import", %{"list" => "#{user2.ap_id}"})
+               conn
-      |> json_response(:ok)
+               |> put_req_header("content-type", "application/json")
+               |> post("/api/pleroma/follow_import", %{"list" => "#{user2.ap_id}"})
+               |> json_response_and_validate_schema(200)
     end
 
     test "it imports follow lists from file", %{conn: conn} do
@@ -37,9 +39,13 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
            "Account address,Show boosts\n#{user2.ap_id},true"
          end}
       ]) do
-        assert "job started" == conn
+        assert "job started" ==
-        |> post("/api/pleroma/follow_import", %{"list" => %Plug.Upload{path: "follow_list.txt"}})
+                 conn
-        |> json_response(:ok)
+                 |> put_req_header("content-type", "application/json")
+                 |> post("/api/pleroma/follow_import", %{
+                   "list" => %Plug.Upload{path: "follow_list.txt"}
+                 })
+                 |> json_response_and_validate_schema(200)
 
         assert [{:ok, job_result}] = ObanHelpers.perform_all()
         assert job_result == [user2]
@@ -49,11 +55,13 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
     test "it imports new-style mastodon follow lists", %{conn: conn} do
       user2 = insert(:user)
 
-      response = conn
+      response =
-      |> post("/api/pleroma/follow_import", %{
+        conn
-            "list" => "Account address,Show boosts\n#{user2.ap_id},true"}
+        |> put_req_header("content-type", "application/json")
-      )
+        |> post("/api/pleroma/follow_import", %{
-      |> json_response(:ok)
+          "list" => "Account address,Show boosts\n#{user2.ap_id},true"
+        })
+        |> json_response_and_validate_schema(200)
 
       assert response == "job started"
     end
@@ -68,6 +76,7 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
         conn =
           build_conn()
           |> put_req_header("authorization", "Bearer #{token.token}")
+          |> put_req_header("content-type", "application/json")
           |> post("/api/pleroma/follow_import", %{"list" => "#{another_user.ap_id}"})
 
         if token == token3 do
@@ -93,9 +102,11 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
         ]
         |> Enum.join("\n")
 
-      assert "job started" == conn
+      assert "job started" ==
-      |> post("/api/pleroma/follow_import", %{"list" => identifiers})
+               conn
-      |> json_response(:ok)
+               |> put_req_header("content-type", "application/json")
+               |> post("/api/pleroma/follow_import", %{"list" => identifiers})
+               |> json_response_and_validate_schema(200)
 
       assert [{:ok, job_result}] = ObanHelpers.perform_all()
       assert job_result == users
@@ -109,9 +120,11 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
     test "it returns HTTP 200", %{conn: conn} do
       user2 = insert(:user)
 
-      assert "job started" == conn
+      assert "job started" ==
-      |> post("/api/pleroma/blocks_import", %{"list" => "#{user2.ap_id}"})
+               conn
-      |> json_response(:ok)
+               |> put_req_header("content-type", "application/json")
+               |> post("/api/pleroma/blocks_import", %{"list" => "#{user2.ap_id}"})
+               |> json_response_and_validate_schema(200)
     end
 
     test "it imports blocks users from file", %{conn: conn} do
@@ -120,10 +133,13 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
       with_mocks([
         {File, [], read!: fn "blocks_list.txt" -> "#{user2.ap_id} #{user3.ap_id}" end}
       ]) do
-
+        assert "job started" ==
-        assert "job started" == conn
+                 conn
-        |> post("/api/pleroma/blocks_import", %{"list" => %Plug.Upload{path: "blocks_list.txt"}})
+                 |> put_req_header("content-type", "application/json")
-        |> json_response(:ok)
+                 |> post("/api/pleroma/blocks_import", %{
+                   "list" => %Plug.Upload{path: "blocks_list.txt"}
+                 })
+                 |> json_response_and_validate_schema(200)
 
         assert [{:ok, job_result}] = ObanHelpers.perform_all()
         assert job_result == users
@@ -143,9 +159,11 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
         ]
         |> Enum.join(" ")
 
-      assert "job started" == conn
+      assert "job started" ==
-      |> post("/api/pleroma/blocks_import", %{"list" => identifiers})
+               conn
-      |> json_response(:ok)
+               |> put_req_header("content-type", "application/json")
+               |> post("/api/pleroma/blocks_import", %{"list" => identifiers})
+               |> json_response_and_validate_schema(200)
 
       assert [{:ok, job_result}] = ObanHelpers.perform_all()
       assert job_result == users
@@ -159,25 +177,30 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
     test "it returns HTTP 200", %{user: user, conn: conn} do
       user2 = insert(:user)
 
-      assert "job started" == conn
+      assert "job started" ==
-      |> post("/api/pleroma/mutes_import", %{"list" => "#{user2.ap_id}"})
+               conn
-      |> json_response(:ok)
+               |> put_req_header("content-type", "application/json")
+               |> post("/api/pleroma/mutes_import", %{"list" => "#{user2.ap_id}"})
+               |> json_response_and_validate_schema(200)
 
       assert [{:ok, job_result}] = ObanHelpers.perform_all()
       assert job_result == [user2]
       assert Pleroma.User.mutes?(user, user2)
     end
 
-
     test "it imports mutes users from file", %{user: user, conn: conn} do
       users = [user2, user3] = insert_list(2, :user)
 
       with_mocks([
         {File, [], read!: fn "mutes_list.txt" -> "#{user2.ap_id} #{user3.ap_id}" end}
       ]) do
-        assert "job started" == conn
+        assert "job started" ==
-        |> post("/api/pleroma/mutes_import", %{"list" => %Plug.Upload{path: "mutes_list.txt"}})
+                 conn
-        |> json_response(:ok)
+                 |> put_req_header("content-type", "application/json")
+                 |> post("/api/pleroma/mutes_import", %{
+                   "list" => %Plug.Upload{path: "mutes_list.txt"}
+                 })
+                 |> json_response_and_validate_schema(200)
 
         assert [{:ok, job_result}] = ObanHelpers.perform_all()
         assert job_result == users
@@ -188,15 +211,22 @@ defmodule Pleroma.Web.PleromaAPI.UserImportControllerTest do
     test "it imports mutes with different nickname variations", %{user: user, conn: conn} do
       users = [user2, user3, user4, user5, user6] = insert_list(5, :user)
 
-      identifiers = [
+      identifiers =
-        user2.ap_id, user3.nickname, "@" <> user4.nickname,
+        [
-        user5.nickname <> "@localhost", "@" <> user6.nickname <> "@localhost"
+          user2.ap_id,
-      ]
+          user3.nickname,
-      |> Enum.join(" ")
+          "@" <> user4.nickname,
+          user5.nickname <> "@localhost",
+          "@" <> user6.nickname <> "@localhost"
+        ]
+        |> Enum.join(" ")
+
+      assert "job started" ==
+               conn
+               |> put_req_header("content-type", "application/json")
+               |> post("/api/pleroma/mutes_import", %{"list" => identifiers})
+               |> json_response_and_validate_schema(200)
 
-      assert "job started" == conn
-      |> post("/api/pleroma/mutes_import", %{"list" => identifiers})
-      |> json_response(:ok)
       assert [{:ok, job_result}] = ObanHelpers.perform_all()
       assert job_result == users
       assert Enum.all?(users, &Pleroma.User.mutes?(user, &1))