moon
/
spc-pleroma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'neetzsche/add_url_to_scrobbles' into 'develop' 

Add optional URL value for scrobbles

See merge request pleroma/pleroma!3977
This commit is contained in:
HJ 2023-11-29 15:59:19 +00:00
parent bc7fcc2dba e216603477
commit 6a6a631c81
5 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/scrobble-url.add Normal file
View File

@ -0,0 +1 @@
Adds the capability to add a URL to a scrobble (optional field)

6
lib/pleroma/web/api_spec/operations/pleroma_scrobble_operation.ex
View File

@ -59,6 +59,7 @@ defp create_request do
album: %Schema{type: :string, description: "The album of the media playing"}, album: %Schema{type: :string, description: "The album of the media playing"},
artist: %Schema{type: :string, description: "The artist of the media playing"}, artist: %Schema{type: :string, description: "The artist of the media playing"},
length: %Schema{type: :integer, description: "The length of the media playing"}, length: %Schema{type: :integer, description: "The length of the media playing"},
externalLink: %Schema{type: :string, description: "A URL referencing the media playing"},
visibility: %Schema{ visibility: %Schema{
allOf: [VisibilityScope], allOf: [VisibilityScope],
default: "public", default: "public",
@ -69,7 +70,8 @@ defp create_request do
"title" => "Some Title", "title" => "Some Title",
"artist" => "Some Artist", "artist" => "Some Artist",
"album" => "Some Album", "album" => "Some Album",
"length" => 180_000 "length" => 180_000,
"externalLink" => "https://www.last.fm/music/Some+Artist/_/Some+Title"
} }
} }
end end
@ -83,6 +85,7 @@ defp scrobble do
title: %Schema{type: :string, description: "The title of the media playing"}, title: %Schema{type: :string, description: "The title of the media playing"},
album: %Schema{type: :string, description: "The album of the media playing"}, album: %Schema{type: :string, description: "The album of the media playing"},
artist: %Schema{type: :string, description: "The artist of the media playing"}, artist: %Schema{type: :string, description: "The artist of the media playing"},
externalLink: %Schema{type: :string, description: "A URL referencing the media playing"},
length: %Schema{ length: %Schema{
type: :integer, type: :integer,
description: "The length of the media playing", description: "The length of the media playing",
@ -97,6 +100,7 @@ defp scrobble do
"artist" => "Some Artist", "artist" => "Some Artist",
"album" => "Some Album", "album" => "Some Album",
"length" => 180_000, "length" => 180_000,
"externalLink" => "https://www.last.fm/music/Some+Artist/_/Some+Title",
"created_at" => "2019-09-28T12:40:45.000Z" "created_at" => "2019-09-28T12:40:45.000Z"
} }
} }

2
lib/pleroma/web/common_api/activity_draft.ex
View File

@ -83,7 +83,7 @@ def listen(user, params) do
defp listen_object(draft) do defp listen_object(draft) do
object = object =
draft.params draft.params
|> Map.take([:album, :artist, :title, :length]) |> Map.take([:album, :artist, :title, :length, :externalLink])
|> Map.new(fn {key, value} -> {to_string(key), value} end) |> Map.new(fn {key, value} -> {to_string(key), value} end)
|> Map.put("type", "Audio") |> Map.put("type", "Audio")
|> Map.put("to", draft.to) |> Map.put("to", draft.to)

1
lib/pleroma/web/pleroma_api/views/scrobble_view.ex
View File

@ -27,6 +27,7 @@ def render("show.json", %{activity: %Activity{data: %{"type" => "Listen"}} = act
title: object.data["title"] |> HTML.strip_tags(), title: object.data["title"] |> HTML.strip_tags(),
artist: object.data["artist"] |> HTML.strip_tags(), artist: object.data["artist"] |> HTML.strip_tags(),
album: object.data["album"] |> HTML.strip_tags(), album: object.data["album"] |> HTML.strip_tags(),
externalLink: object.data["externalLink"],
length: object.data["length"] length: object.data["length"]
} }
end end

12
test/pleroma/web/pleroma_api/controllers/scrobble_controller_test.exs
View File

@ -18,7 +18,8 @@ test "works correctly" do
"title" => "lain radio episode 1", "title" => "lain radio episode 1",
"artist" => "lain", "artist" => "lain",
"album" => "lain radio", "album" => "lain radio",
"length" => "180000" "length" => "180000",
"externalLink" => "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+1"
}) })
assert %{"title" => "lain radio episode 1"} = json_response_and_validate_schema(conn, 200) assert %{"title" => "lain radio episode 1"} = json_response_and_validate_schema(conn, 200)
@ -33,21 +34,24 @@ test "works correctly" do
CommonAPI.listen(user, %{ CommonAPI.listen(user, %{
title: "lain radio episode 1", title: "lain radio episode 1",
artist: "lain", artist: "lain",
album: "lain radio" album: "lain radio",
externalLink: "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+1"
}) })
{:ok, _activity} = {:ok, _activity} =
CommonAPI.listen(user, %{ CommonAPI.listen(user, %{
title: "lain radio episode 2", title: "lain radio episode 2",
artist: "lain", artist: "lain",
album: "lain radio" album: "lain radio",
externalLink: "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+2"
}) })
{:ok, _activity} = {:ok, _activity} =
CommonAPI.listen(user, %{ CommonAPI.listen(user, %{
title: "lain radio episode 3", title: "lain radio episode 3",
artist: "lain", artist: "lain",
album: "lain radio" album: "lain radio",
externalLink: "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+3"
}) })
conn = get(conn, "/api/v1/pleroma/accounts/#{user.id}/scrobbles") conn = get(conn, "/api/v1/pleroma/accounts/#{user.id}/scrobbles")