Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F85949120
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Flag For Later
Award Token
Authored By
Unknown
Size
20 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/lib/pleroma/web/api_spec/operations/chat_operation.ex b/lib/pleroma/web/api_spec/operations/chat_operation.ex
index 038ebb29d..5bd41ec4f 100644
--- a/lib/pleroma/web/api_spec/operations/chat_operation.ex
+++ b/lib/pleroma/web/api_spec/operations/chat_operation.ex
@@ -1,81 +1,111 @@
# 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.ChatOperation do
alias OpenApiSpex.Operation
- alias OpenApiSpex.Schema
+ alias Pleroma.Web.ApiSpec.Helpers
+ alias Pleroma.Web.ApiSpec.Schemas.ChatMessageCreateRequest
+ alias Pleroma.Web.ApiSpec.Schemas.ChatMessageResponse
+ alias Pleroma.Web.ApiSpec.Schemas.ChatMessagesResponse
+ alias Pleroma.Web.ApiSpec.Schemas.ChatResponse
+ alias Pleroma.Web.ApiSpec.Schemas.ChatsResponse
@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 create_operation do
%Operation{
tags: ["chat"],
summary: "Create a chat",
+ parameters: [
+ Operation.parameter(
+ :ap_id,
+ :path,
+ :string,
+ "The ActivityPub id of the recipient of this chat.",
+ required: true,
+ example: "https://lain.com/users/lain"
+ )
+ ],
responses: %{
200 =>
- Operation.response("Chat", "application/json", %Schema{
- type: :object,
- description: "A created chat is returned",
- properties: %{
- id: %Schema{type: :integer}
- }
- })
- }
+ Operation.response("The created or existing chat", "application/json", ChatResponse)
+ },
+ security: [
+ %{
+ "oAuth" => ["write"]
+ }
+ ]
}
end
def index_operation do
%Operation{
tags: ["chat"],
summary: "Get a list of chats that you participated in",
+ parameters: [
+ Operation.parameter(:limit, :query, :integer, "How many results to return", example: 20),
+ Operation.parameter(:min_id, :query, :string, "Return only chats after this id"),
+ Operation.parameter(:max_id, :query, :string, "Return only chats before this id")
+ ],
responses: %{
- 200 =>
- Operation.response("Chats", "application/json", %Schema{
- type: :array,
- description: "A list of chats",
- items: %Schema{
- type: :object,
- description: "A chat"
- }
- })
- }
+ 200 => Operation.response("The chats of the user", "application/json", ChatsResponse)
+ },
+ security: [
+ %{
+ "oAuth" => ["read"]
+ }
+ ]
}
end
def messages_operation do
%Operation{
tags: ["chat"],
summary: "Get the most recent messages of the chat",
+ parameters: [
+ Operation.parameter(:id, :path, :string, "The ID of the Chat"),
+ Operation.parameter(:limit, :query, :integer, "How many results to return", example: 20),
+ Operation.parameter(:min_id, :query, :string, "Return only messages after this id"),
+ Operation.parameter(:max_id, :query, :string, "Return only messages before this id")
+ ],
responses: %{
200 =>
- Operation.response("Messages", "application/json", %Schema{
- type: :array,
- description: "A list of chat messages",
- items: %Schema{
- type: :object,
- description: "A chat message"
- }
- })
- }
+ Operation.response("The messages in the chat", "application/json", ChatMessagesResponse)
+ },
+ security: [
+ %{
+ "oAuth" => ["read"]
+ }
+ ]
}
end
def post_chat_message_operation do
%Operation{
tags: ["chat"],
summary: "Post a message to the chat",
+ parameters: [
+ Operation.parameter(:id, :path, :string, "The ID of the Chat")
+ ],
+ requestBody: Helpers.request_body("Parameters", ChatMessageCreateRequest, required: true),
responses: %{
200 =>
- Operation.response("Message", "application/json", %Schema{
- type: :object,
- description: "A chat message"
- })
- }
+ Operation.response(
+ "The newly created ChatMessage",
+ "application/json",
+ ChatMessageResponse
+ )
+ },
+ security: [
+ %{
+ "oAuth" => ["write"]
+ }
+ ]
}
end
end
diff --git a/lib/pleroma/web/api_spec/schemas/chat_message_create_request.ex b/lib/pleroma/web/api_spec/schemas/chat_message_create_request.ex
new file mode 100644
index 000000000..4dafcda43
--- /dev/null
+++ b/lib/pleroma/web/api_spec/schemas/chat_message_create_request.ex
@@ -0,0 +1,20 @@
+# 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.Schemas.ChatMessageCreateRequest do
+ alias OpenApiSpex.Schema
+ require OpenApiSpex
+
+ OpenApiSpex.schema(%{
+ title: "ChatMessageCreateRequest",
+ description: "POST body for creating an chat message",
+ type: :object,
+ properties: %{
+ content: %Schema{type: :string, description: "The content of your message"}
+ },
+ example: %{
+ "content" => "Hey wanna buy feet pics?"
+ }
+ })
+end
diff --git a/lib/pleroma/web/api_spec/schemas/chat_message_response.ex b/lib/pleroma/web/api_spec/schemas/chat_message_response.ex
new file mode 100644
index 000000000..e94c00369
--- /dev/null
+++ b/lib/pleroma/web/api_spec/schemas/chat_message_response.ex
@@ -0,0 +1,38 @@
+# 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.Schemas.ChatMessageResponse do
+ alias OpenApiSpex.Schema
+
+ require OpenApiSpex
+
+ OpenApiSpex.schema(%{
+ title: "ChatMessageResponse",
+ description: "Response schema for a ChatMessage",
+ type: :object,
+ properties: %{
+ id: %Schema{type: :string},
+ actor: %Schema{type: :string, description: "The ActivityPub id of the actor"},
+ chat_id: %Schema{type: :string},
+ content: %Schema{type: :string},
+ created_at: %Schema{type: :string, format: :datetime},
+ emojis: %Schema{type: :array}
+ },
+ example: %{
+ "actor" => "https://dontbulling.me/users/lain",
+ "chat_id" => "1",
+ "content" => "hey you again",
+ "created_at" => "2020-04-21T15:06:45.000Z",
+ "emojis" => [
+ %{
+ "static_url" => "https://dontbulling.me/emoji/Firefox.gif",
+ "visible_in_picker" => false,
+ "shortcode" => "firefox",
+ "url" => "https://dontbulling.me/emoji/Firefox.gif"
+ }
+ ],
+ "id" => "14"
+ }
+ })
+end
diff --git a/lib/pleroma/web/api_spec/schemas/chat_messages_response.ex b/lib/pleroma/web/api_spec/schemas/chat_messages_response.ex
new file mode 100644
index 000000000..302bdec95
--- /dev/null
+++ b/lib/pleroma/web/api_spec/schemas/chat_messages_response.ex
@@ -0,0 +1,41 @@
+# 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.Schemas.ChatMessagesResponse do
+ alias Pleroma.Web.ApiSpec.Schemas.ChatMessageResponse
+
+ require OpenApiSpex
+
+ OpenApiSpex.schema(%{
+ title: "ChatMessagesResponse",
+ description: "Response schema for multiple ChatMessages",
+ type: :array,
+ items: ChatMessageResponse,
+ example: [
+ %{
+ "emojis" => [
+ %{
+ "static_url" => "https://dontbulling.me/emoji/Firefox.gif",
+ "visible_in_picker" => false,
+ "shortcode" => "firefox",
+ "url" => "https://dontbulling.me/emoji/Firefox.gif"
+ }
+ ],
+ "created_at" => "2020-04-21T15:11:46.000Z",
+ "content" => "Check this out :firefox:",
+ "id" => "13",
+ "chat_id" => "1",
+ "actor" => "https://dontbulling.me/users/lain"
+ },
+ %{
+ "actor" => "https://dontbulling.me/users/lain",
+ "content" => "Whats' up?",
+ "id" => "12",
+ "chat_id" => "1",
+ "emojis" => [],
+ "created_at" => "2020-04-21T15:06:45.000Z"
+ }
+ ]
+ })
+end
diff --git a/lib/pleroma/web/api_spec/schemas/chat_response.ex b/lib/pleroma/web/api_spec/schemas/chat_response.ex
new file mode 100644
index 000000000..a80f4d173
--- /dev/null
+++ b/lib/pleroma/web/api_spec/schemas/chat_response.ex
@@ -0,0 +1,73 @@
+# 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.Schemas.ChatResponse do
+ alias OpenApiSpex.Schema
+
+ require OpenApiSpex
+
+ OpenApiSpex.schema(%{
+ title: "ChatResponse",
+ description: "Response schema for a Chat",
+ type: :object,
+ properties: %{
+ id: %Schema{type: :string},
+ recipient: %Schema{type: :string},
+ # TODO: Make this reference the account structure.
+ recipient_account: %Schema{type: :object},
+ unread: %Schema{type: :integer}
+ },
+ example: %{
+ "recipient" => "https://dontbulling.me/users/lain",
+ "recipient_account" => %{
+ "pleroma" => %{
+ "is_admin" => false,
+ "confirmation_pending" => false,
+ "hide_followers_count" => false,
+ "is_moderator" => false,
+ "hide_favorites" => true,
+ "ap_id" => "https://dontbulling.me/users/lain",
+ "hide_follows_count" => false,
+ "hide_follows" => false,
+ "background_image" => nil,
+ "skip_thread_containment" => false,
+ "hide_followers" => false,
+ "relationship" => %{},
+ "tags" => []
+ },
+ "avatar" =>
+ "https://dontbulling.me/media/065a4dd3c6740dab13ff9c71ec7d240bb9f8be9205c9e7467fb2202117da1e32.jpg",
+ "following_count" => 0,
+ "header_static" => "https://originalpatchou.li/images/banner.png",
+ "source" => %{
+ "sensitive" => false,
+ "note" => "lain",
+ "pleroma" => %{
+ "discoverable" => false,
+ "actor_type" => "Person"
+ },
+ "fields" => []
+ },
+ "statuses_count" => 1,
+ "locked" => false,
+ "created_at" => "2020-04-16T13:40:15.000Z",
+ "display_name" => "lain",
+ "fields" => [],
+ "acct" => "lain@dontbulling.me",
+ "id" => "9u6Qw6TAZANpqokMkK",
+ "emojis" => [],
+ "avatar_static" =>
+ "https://dontbulling.me/media/065a4dd3c6740dab13ff9c71ec7d240bb9f8be9205c9e7467fb2202117da1e32.jpg",
+ "username" => "lain",
+ "followers_count" => 0,
+ "header" => "https://originalpatchou.li/images/banner.png",
+ "bot" => false,
+ "note" => "lain",
+ "url" => "https://dontbulling.me/users/lain"
+ },
+ "id" => "1",
+ "unread" => 2
+ }
+ })
+end
diff --git a/lib/pleroma/web/api_spec/schemas/chats_response.ex b/lib/pleroma/web/api_spec/schemas/chats_response.ex
new file mode 100644
index 000000000..3349e0691
--- /dev/null
+++ b/lib/pleroma/web/api_spec/schemas/chats_response.ex
@@ -0,0 +1,69 @@
+# 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.Schemas.ChatsResponse do
+ alias Pleroma.Web.ApiSpec.Schemas.ChatResponse
+
+ require OpenApiSpex
+
+ OpenApiSpex.schema(%{
+ title: "ChatsResponse",
+ description: "Response schema for multiple Chats",
+ type: :array,
+ items: ChatResponse,
+ example: [
+ %{
+ "recipient" => "https://dontbulling.me/users/lain",
+ "recipient_account" => %{
+ "pleroma" => %{
+ "is_admin" => false,
+ "confirmation_pending" => false,
+ "hide_followers_count" => false,
+ "is_moderator" => false,
+ "hide_favorites" => true,
+ "ap_id" => "https://dontbulling.me/users/lain",
+ "hide_follows_count" => false,
+ "hide_follows" => false,
+ "background_image" => nil,
+ "skip_thread_containment" => false,
+ "hide_followers" => false,
+ "relationship" => %{},
+ "tags" => []
+ },
+ "avatar" =>
+ "https://dontbulling.me/media/065a4dd3c6740dab13ff9c71ec7d240bb9f8be9205c9e7467fb2202117da1e32.jpg",
+ "following_count" => 0,
+ "header_static" => "https://originalpatchou.li/images/banner.png",
+ "source" => %{
+ "sensitive" => false,
+ "note" => "lain",
+ "pleroma" => %{
+ "discoverable" => false,
+ "actor_type" => "Person"
+ },
+ "fields" => []
+ },
+ "statuses_count" => 1,
+ "locked" => false,
+ "created_at" => "2020-04-16T13:40:15.000Z",
+ "display_name" => "lain",
+ "fields" => [],
+ "acct" => "lain@dontbulling.me",
+ "id" => "9u6Qw6TAZANpqokMkK",
+ "emojis" => [],
+ "avatar_static" =>
+ "https://dontbulling.me/media/065a4dd3c6740dab13ff9c71ec7d240bb9f8be9205c9e7467fb2202117da1e32.jpg",
+ "username" => "lain",
+ "followers_count" => 0,
+ "header" => "https://originalpatchou.li/images/banner.png",
+ "bot" => false,
+ "note" => "lain",
+ "url" => "https://dontbulling.me/users/lain"
+ },
+ "id" => "1",
+ "unread" => 2
+ }
+ ]
+ })
+end
diff --git a/test/web/pleroma_api/controllers/chat_controller_test.exs b/test/web/pleroma_api/controllers/chat_controller_test.exs
index 0750c7273..52a34d23f 100644
--- a/test/web/pleroma_api/controllers/chat_controller_test.exs
+++ b/test/web/pleroma_api/controllers/chat_controller_test.exs
@@ -1,159 +1,201 @@
# Pleroma: A lightweight social networking server
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.Web.PleromaAPI.ChatControllerTest do
use Pleroma.Web.ConnCase, async: true
alias Pleroma.Chat
+ alias Pleroma.Web.ApiSpec
+ alias Pleroma.Web.ApiSpec.Schemas.ChatResponse
+ alias Pleroma.Web.ApiSpec.Schemas.ChatsResponse
+ alias Pleroma.Web.ApiSpec.Schemas.ChatMessageResponse
+ alias Pleroma.Web.ApiSpec.Schemas.ChatMessagesResponse
alias Pleroma.Web.CommonAPI
+ import OpenApiSpex.TestAssertions
import Pleroma.Factory
describe "POST /api/v1/pleroma/chats/:id/messages" do
setup do: oauth_access(["write:statuses"])
test "it posts a message to the chat", %{conn: conn, user: user} do
other_user = insert(:user)
{:ok, chat} = Chat.get_or_create(user.id, other_user.ap_id)
result =
conn
|> post("/api/v1/pleroma/chats/#{chat.id}/messages", %{"content" => "Hallo!!"})
|> json_response(200)
assert result["content"] == "Hallo!!"
assert result["chat_id"] == chat.id |> to_string()
+ assert_schema(result, "ChatMessageResponse", ApiSpec.spec())
end
end
describe "GET /api/v1/pleroma/chats/:id/messages" do
setup do: oauth_access(["read:statuses"])
test "it paginates", %{conn: conn, user: user} do
recipient = insert(:user)
Enum.each(1..30, fn _ ->
{:ok, _} = CommonAPI.post_chat_message(user, recipient, "hey")
end)
chat = Chat.get(user.id, recipient.ap_id)
result =
conn
|> get("/api/v1/pleroma/chats/#{chat.id}/messages")
|> json_response(200)
assert length(result) == 20
+ assert_schema(result, "ChatMessagesResponse", ApiSpec.spec())
result =
conn
|> get("/api/v1/pleroma/chats/#{chat.id}/messages", %{"max_id" => List.last(result)["id"]})
|> json_response(200)
assert length(result) == 10
+ assert_schema(result, "ChatMessagesResponse", ApiSpec.spec())
end
test "it returns the messages for a given chat", %{conn: conn, user: user} do
other_user = insert(:user)
third_user = insert(:user)
{:ok, _} = CommonAPI.post_chat_message(user, other_user, "hey")
{:ok, _} = CommonAPI.post_chat_message(user, third_user, "hey")
{:ok, _} = CommonAPI.post_chat_message(user, other_user, "how are you?")
{:ok, _} = CommonAPI.post_chat_message(other_user, user, "fine, how about you?")
chat = Chat.get(user.id, other_user.ap_id)
result =
conn
|> get("/api/v1/pleroma/chats/#{chat.id}/messages")
|> json_response(200)
result
|> Enum.each(fn message ->
assert message["chat_id"] == chat.id |> to_string()
end)
assert length(result) == 3
+ assert_schema(result, "ChatMessagesResponse", ApiSpec.spec())
# Trying to get the chat of a different user
result =
conn
|> assign(:user, other_user)
|> get("/api/v1/pleroma/chats/#{chat.id}/messages")
assert result |> json_response(404)
end
end
describe "POST /api/v1/pleroma/chats/by-ap-id/:id" do
setup do: oauth_access(["write:statuses"])
test "it creates or returns a chat", %{conn: conn} do
other_user = insert(:user)
result =
conn
|> post("/api/v1/pleroma/chats/by-ap-id/#{URI.encode_www_form(other_user.ap_id)}")
|> json_response(200)
assert result["id"]
+ assert_schema(result, "ChatResponse", ApiSpec.spec())
end
end
describe "GET /api/v1/pleroma/chats" do
setup do: oauth_access(["read:statuses"])
test "it paginates", %{conn: conn, user: user} do
Enum.each(1..30, fn _ ->
recipient = insert(:user)
{:ok, _} = Chat.get_or_create(user.id, recipient.ap_id)
end)
result =
conn
|> get("/api/v1/pleroma/chats")
|> json_response(200)
assert length(result) == 20
+ assert_schema(result, "ChatsResponse", ApiSpec.spec())
result =
conn
|> get("/api/v1/pleroma/chats", %{max_id: List.last(result)["id"]})
|> json_response(200)
assert length(result) == 10
+
+ assert_schema(result, "ChatsResponse", ApiSpec.spec())
end
test "it return a list of chats the current user is participating in, in descending order of updates",
%{conn: conn, user: user} do
har = insert(:user)
jafnhar = insert(:user)
tridi = insert(:user)
{:ok, chat_1} = Chat.get_or_create(user.id, har.ap_id)
:timer.sleep(1000)
{:ok, _chat_2} = Chat.get_or_create(user.id, jafnhar.ap_id)
:timer.sleep(1000)
{:ok, chat_3} = Chat.get_or_create(user.id, tridi.ap_id)
:timer.sleep(1000)
# bump the second one
{:ok, chat_2} = Chat.bump_or_create(user.id, jafnhar.ap_id)
result =
conn
|> get("/api/v1/pleroma/chats")
|> json_response(200)
ids = Enum.map(result, & &1["id"])
assert ids == [
chat_2.id |> to_string(),
chat_3.id |> to_string(),
chat_1.id |> to_string()
]
+
+ assert_schema(result, "ChatsResponse", ApiSpec.spec())
+ end
+ end
+
+ describe "schemas" do
+ test "Chat example matches schema" do
+ api_spec = ApiSpec.spec()
+ schema = ChatResponse.schema()
+ assert_schema(schema.example, "ChatResponse", api_spec)
+ end
+
+ test "Chats example matches schema" do
+ api_spec = ApiSpec.spec()
+ schema = ChatsResponse.schema()
+ assert_schema(schema.example, "ChatsResponse", api_spec)
+ end
+
+ test "ChatMessage example matches schema" do
+ api_spec = ApiSpec.spec()
+ schema = ChatMessageResponse.schema()
+ assert_schema(schema.example, "ChatMessageResponse", api_spec)
+ end
+
+ test "ChatsMessage example matches schema" do
+ api_spec = ApiSpec.spec()
+ schema = ChatMessagesResponse.schema()
+ assert_schema(schema.example, "ChatMessagesResponse", api_spec)
end
end
end
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Tue, Nov 17, 7:12 PM (14 h, 24 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1839737
Default Alt Text
(20 KB)
Attached To
Mode
rPUBE pleroma-upstream
Attached
Detach File
Event Timeline