nekojanai/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity

Move single used schemas to Filter operation schema

Browse source
This commit is contained in:
Egor Kislitsyn 2020-04-27 23:54:11 +04:00
parent 7e7a3e1544
commit 46aae346f8
No known key found for this signature in database
GPG key ID: 1B49CB15B71E7805
8 changed files with 158 additions and 222 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

158
lib/pleroma/web/api_spec/operations/filter_operation.ex
View file

@ -6,10 +6,6 @@ defmodule Pleroma.Web.ApiSpec.FilterOperation do
alias OpenApiSpex.Operation
alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Helpers
alias Pleroma.Web.ApiSpec.Schemas.Filter
alias Pleroma.Web.ApiSpec.Schemas.FilterCreateRequest
alias Pleroma.Web.ApiSpec.Schemas.FiltersResponse
alias Pleroma.Web.ApiSpec.Schemas.FilterUpdateRequest
def open_api_operation(action) do
operation = String.to_existing_atom("#{action}_operation")
@ -23,7 +19,7 @@ def index_operation do
operationId: "FilterController.index",
security: [%{"oAuth" => ["read:filters"]}],
responses: %{
200 => Operation.response("Filters", "application/json", FiltersResponse)
200 => Operation.response("Filters", "application/json", array_of_filters())
}
}
end
@ -33,9 +29,9 @@ def create_operation do
tags: ["apps"],
summary: "Create a filter",
operationId: "FilterController.create",
requestBody: Helpers.request_body("Parameters", FilterCreateRequest, required: true),
requestBody: Helpers.request_body("Parameters", create_request(), required: true),
security: [%{"oAuth" => ["write:filters"]}],
responses: %{200 => Operation.response("Filter", "application/json", Filter)}
responses: %{200 => Operation.response("Filter", "application/json", filter())}
}
end
@ -47,7 +43,7 @@ def show_operation do
operationId: "FilterController.show",
security: [%{"oAuth" => ["read:filters"]}],
responses: %{
200 => Operation.response("Filter", "application/json", Filter)
200 => Operation.response("Filter", "application/json", filter())
}
}
end
@ -58,10 +54,10 @@ def update_operation do
summary: "Update a filter",
parameters: [id_param()],
operationId: "FilterController.update",
requestBody: Helpers.request_body("Parameters", FilterUpdateRequest, required: true),
requestBody: Helpers.request_body("Parameters", update_request(), required: true),
security: [%{"oAuth" => ["write:filters"]}],
responses: %{
200 => Operation.response("Filter", "application/json", Filter)
200 => Operation.response("Filter", "application/json", filter())
}
}
end
@ -86,4 +82,146 @@ def delete_operation do
defp id_param do
Operation.parameter(:id, :path, :string, "Filter ID", example: "123", required: true)
end
defp filter do
%Schema{
title: "Filter",
type: :object,
properties: %{
id: %Schema{type: :string},
phrase: %Schema{type: :string, description: "The text to be filtered"},
context: %Schema{
type: :array,
items: %Schema{type: :string, enum: ["home", "notifications", "public", "thread"]},
description: "The contexts in which the filter should be applied."
},
expires_at: %Schema{
type: :string,
format: :"date-time",
description:
"When the filter should no longer be applied. String (ISO 8601 Datetime), or null if the filter does not expire.",
nullable: true
},
irreversible: %Schema{
type: :boolean,
description:
"Should matching entities in home and notifications be dropped by the server?"
},
whole_word: %Schema{
type: :boolean,
description: "Should the filter consider word boundaries?"
}
},
example: %{
"id" => "5580",
"phrase" => "@twitter.com",
"context" => [
"home",
"notifications",
"public",
"thread"
],
"whole_word" => false,
"expires_at" => nil,
"irreversible" => true
}
}
end
defp array_of_filters do
%Schema{
title: "ArrayOfFilters",
description: "Array of Filters",
type: :array,
items: filter(),
example: [
%{
"id" => "5580",
"phrase" => "@twitter.com",
"context" => [
"home",
"notifications",
"public",
"thread"
],
"whole_word" => false,
"expires_at" => nil,
"irreversible" => true
},
%{
"id" => "6191",
"phrase" => ":eurovision2019:",
"context" => [
"home"
],
"whole_word" => true,
"expires_at" => "2019-05-21T13:47:31.333Z",
"irreversible" => false
}
]
}
end
defp create_request do
%Schema{
title: "FilterCreateRequest",
allOf: [
update_request(),
%Schema{
type: :object,
properties: %{
irreversible: %Schema{
type: :bolean,
description:
"Should the server irreversibly drop matching entities from home and notifications?",
default: false
}
}
}
],
example: %{
"phrase" => "knights",
"context" => ["home"]
}
}
end
defp update_request do
%Schema{
title: "FilterUpdateRequest",
type: :object,
properties: %{
phrase: %Schema{type: :string, description: "The text to be filtered"},
context: %Schema{
type: :array,
items: %Schema{type: :string, enum: ["home", "notifications", "public", "thread"]},
description:
"Array of enumerable strings `home`, `notifications`, `public`, `thread`. At least one context must be specified."
},
irreversible: %Schema{
type: :bolean,
description:
"Should the server irreversibly drop matching entities from home and notifications?"
},
whole_word: %Schema{
type: :bolean,
description: "Consider word boundaries?",
default: true
}
# TODO: probably should implement filter expiration
# expires_in: %Schema{
# type: :string,
# format: :"date-time",
# description:
# "ISO 8601 Datetime for when the filter expires. Otherwise,
# null for a filter that doesn't expire."
# }
},
required: [:phrase, :context],
example: %{
"phrase" => "knights",
"context" => ["home"]
}
}
end
end

51
lib/pleroma/web/api_spec/schemas/filter.ex
View file

@ -1,51 +0,0 @@
# 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.Filter do
alias OpenApiSpex.Schema
require OpenApiSpex
OpenApiSpex.schema(%{
title: "Filter",
type: :object,
properties: %{
id: %Schema{type: :string},
phrase: %Schema{type: :string, description: "The text to be filtered"},
context: %Schema{
type: :array,
items: %Schema{type: :string, enum: ["home", "notifications", "public", "thread"]},
description: "The contexts in which the filter should be applied."
},
expires_at: %Schema{
type: :string,
format: :"date-time",
description:
"When the filter should no longer be applied. String (ISO 8601 Datetime), or null if the filter does not expire.",
nullable: true
},
irreversible: %Schema{
type: :boolean,
description:
"Should matching entities in home and notifications be dropped by the server?"
},
whole_word: %Schema{
type: :boolean,
description: "Should the filter consider word boundaries?"
}
},
example: %{
"id" => "5580",
"phrase" => "@twitter.com",
"context" => [
"home",
"notifications",
"public",
"thread"
],
"whole_word" => false,
"expires_at" => nil,
"irreversible" => true
}
})
end

30
lib/pleroma/web/api_spec/schemas/filter_create_request.ex
View file

@ -1,30 +0,0 @@
# 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.FilterCreateRequest do
alias OpenApiSpex.Schema
require OpenApiSpex
OpenApiSpex.schema(%{
title: "FilterCreateRequest",
allOf: [
%OpenApiSpex.Reference{"$ref": "#/components/schemas/FilterUpdateRequest"},
%Schema{
type: :object,
properties: %{
irreversible: %Schema{
type: :bolean,
description:
"Should the server irreversibly drop matching entities from home and notifications?",
default: false
}
}
}
],
example: %{
"phrase" => "knights",
"context" => ["home"]
}
})
end

41
lib/pleroma/web/api_spec/schemas/filter_update_request.ex
View file

@ -1,41 +0,0 @@
# 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.FilterUpdateRequest do
alias OpenApiSpex.Schema
require OpenApiSpex
OpenApiSpex.schema(%{
title: "FilterUpdateRequest",
type: :object,
properties: %{
phrase: %Schema{type: :string, description: "The text to be filtered"},
context: %Schema{
type: :array,
items: %Schema{type: :string, enum: ["home", "notifications", "public", "thread"]},
description:
"Array of enumerable strings `home`, `notifications`, `public`, `thread`. At least one context must be specified."
},
irreversible: %Schema{
type: :bolean,
description:
"Should the server irreversibly drop matching entities from home and notifications?"
},
whole_word: %Schema{type: :bolean, description: "Consider word boundaries?", default: true}
# TODO: probably should implement filter expiration
# expires_in: %Schema{
# type: :string,
# format: :"date-time",
# description:
# "ISO 8601 Datetime for when the filter expires. Otherwise,
# null for a filter that doesn't expire."
# }
},
required: [:phrase, :context],
example: %{
"phrase" => "knights",
"context" => ["home"]
}
})
end

40
lib/pleroma/web/api_spec/schemas/filters_response.ex
View file

@ -1,40 +0,0 @@
# 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.FiltersResponse do
require OpenApiSpex
alias Pleroma.Web.ApiSpec.Schemas.Filter
OpenApiSpex.schema(%{
title: "FiltersResponse",
description: "Array of Filters",
type: :array,
items: Filter,
example: [
%{
"id" => "5580",
"phrase" => "@twitter.com",
"context" => [
"home",
"notifications",
"public",
"thread"
],
"whole_word" => false,
"expires_at" => nil,
"irreversible" => true
},
%{
"id" => "6191",
"phrase" => ":eurovision2019:",
"context" => [
"home"
],
"whole_word" => true,
"expires_at" => "2019-05-21T13:47:31.333Z",
"irreversible" => false
}
]
})
end

7
lib/pleroma/web/mastodon_api/controllers/filter_controller.ex
View file

@ -35,7 +35,7 @@ def create(%{assigns: %{user: user}, body_params: params} = conn, _) do
context: params.context,
hide: params.irreversible,
whole_word: params.whole_word
# expires_at
# TODO: support `expires_in` parameter (as in Mastodon API)
}
{:ok, response} = Filter.create(query)
@ -57,13 +57,12 @@ def update(
) do
params =
params
|> Map.from_struct()
|> Map.delete(:irreversible)
|> Map.put(:hide, params.irreversible)
|> Map.put(:hide, params[:irreversible])
|> Enum.reject(fn {_key, value} -> is_nil(value) end)
|> Map.new()
# TODO: add expires_in -> expires_at
# TODO: support `expires_in` parameter (as in Mastodon API)
with %Filter{} = filter <- Filter.get(filter_id, user),
{:ok, %Filter{} = filter} <- Filter.update(filter, params) do

4
lib/pleroma/web/mastodon_api/views/filter_view.ex
View file

@ -7,8 +7,8 @@ defmodule Pleroma.Web.MastodonAPI.FilterView do
alias Pleroma.Web.CommonAPI.Utils
alias Pleroma.Web.MastodonAPI.FilterView
def render("index.json", %{filters: filters} = opts) do
render_many(filters, FilterView, "show.json", opts)
def render("index.json", %{filters: filters}) do
render_many(filters, FilterView, "show.json")
end
def render("show.json", %{filter: filter}) do

49
test/web/mastodon_api/controllers/filter_controller_test.exs
View file

@ -5,15 +5,8 @@
defmodule Pleroma.Web.MastodonAPI.FilterControllerTest do
use Pleroma.Web.ConnCase
alias Pleroma.Web.ApiSpec
alias Pleroma.Web.ApiSpec.Schemas.Filter
alias Pleroma.Web.ApiSpec.Schemas.FilterCreateRequest
alias Pleroma.Web.ApiSpec.Schemas.FiltersResponse
alias Pleroma.Web.ApiSpec.Schemas.FilterUpdateRequest
alias Pleroma.Web.MastodonAPI.FilterView
import OpenApiSpex.TestAssertions
test "creating a filter" do
%{conn: conn} = oauth_access(["write:filters"])
@ -27,13 +20,12 @@ test "creating a filter" do
|> put_req_header("content-type", "application/json")
|> post("/api/v1/filters", %{"phrase" => filter.phrase, context: filter.context})
assert response = json_response(conn, 200)
assert response = json_response_and_validate_schema(conn, 200)
assert response["phrase"] == filter.phrase
assert response["context"] == filter.context
assert response["irreversible"] == false
assert response["id"] != nil
assert response["id"] != ""
assert_schema(response, "Filter", ApiSpec.spec())
end
test "fetching a list of filters" do
@ -59,7 +51,7 @@ test "fetching a list of filters" do
response =
conn
|> get("/api/v1/filters")
|> json_response(200)
|> json_response_and_validate_schema(200)
assert response ==
render_json(
@ -67,8 +59,6 @@ test "fetching a list of filters" do
"index.json",
filters: [filter_two, filter_one]
)
assert_schema(response, "FiltersResponse", ApiSpec.spec())
end
test "get a filter" do
@ -85,8 +75,7 @@ test "get a filter" do
conn = get(conn, "/api/v1/filters/#{filter.filter_id}")
assert response = json_response(conn, 200)
assert_schema(response, "Filter", ApiSpec.spec())
assert response = json_response_and_validate_schema(conn, 200)
end
test "update a filter" do
@ -115,11 +104,10 @@ test "update a filter" do
context: new.context
})
assert response = json_response(conn, 200)
assert response = json_response_and_validate_schema(conn, 200)
assert response["phrase"] == new.phrase
assert response["context"] == new.context
assert response["irreversible"] == true
assert_schema(response, "Filter", ApiSpec.spec())
end
test "delete a filter" do
@ -136,33 +124,6 @@ test "delete a filter" do
conn = delete(conn, "/api/v1/filters/#{filter.filter_id}")
assert response = json_response(conn, 200)
assert response == %{}
end
describe "OpenAPI" do
test "Filter example matches schema" do
api_spec = ApiSpec.spec()
schema = Filter.schema()
assert_schema(schema.example, "Filter", api_spec)
end
test "FiltersResponse example matches schema" do
api_spec = ApiSpec.spec()
schema = FiltersResponse.schema()
assert_schema(schema.example, "FiltersResponse", api_spec)
end
test "FilterCreateRequest example matches schema" do
api_spec = ApiSpec.spec()
schema = FilterCreateRequest.schema()
assert_schema(schema.example, "FilterCreateRequest", api_spec)
end
test "FilterUpdateRequest example matches schema" do
api_spec = ApiSpec.spec()
schema = FilterUpdateRequest.schema()
assert_schema(schema.example, "FilterUpdateRequest", api_spec)
end
assert json_response_and_validate_schema(conn, 200) == %{}
end
end