Funkwhale/ultrasonic-app-subsonic-android
1
0
Fork 0
mirror of https://github.com/ultrasonic/ultrasonic synced 2025-02-18 04:30:48 +01:00
Code Issues Releases Wiki Activity

Merge pull request #47 from ultrasonic/add-get-lyrics

Browse Source 
Add get lyrics
This commit is contained in:
Yahor Berdnikau 2017-09-03 22:26:04 +02:00 committed by GitHub
commit 7143dc4db1
9 changed files with 138 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiGetLyricsTest.kt Normal file
View File

@ -0,0 +1,51 @@
package org.moire.ultrasonic.api.subsonic
import org.amshove.kluent.`should equal to`
import org.junit.Test
/**
* Integration test for [SubsonicAPIClient] for getLyrics() call.
*/
class SubsonicApiGetLyricsTest : SubsonicAPIClientTest() {
@Test
fun `Should handle error response`() {
checkErrorCallParsed(mockWebServerRule) {
client.api.getLyrics().execute()
}
}
@Test
fun `Should handle ok response`() {
mockWebServerRule.enqueueResponse("get_lyrics_ok.json")
val response = client.api.getLyrics().execute()
assertResponseSuccessful(response)
with(response.body().lyrics) {
artist `should equal to` "Amorphis"
title `should equal to` "Alone"
text `should equal to` "Tear dimmed rememberance\nIn a womb of time\nBreath upon " +
"me\nPossessed by the"
}
}
@Test
fun `Should pass artist param in request`() {
val artist = "some-artist"
mockWebServerRule.assertRequestParam(responseResourceName = "get_lyrics_ok.json",
expectedParam = "artist=$artist") {
client.api.getLyrics(artist = artist).execute()
}
}
@Test
fun `Should pass title param in request`() {
val title = "some-title"
mockWebServerRule.assertRequestParam(responseResourceName = "get_lyrics_ok.json",
expectedParam = "title=$title") {
client.api.getLyrics(title = title).execute()
}
}
}

11
subsonic-api/src/integrationTest/resources/get_lyrics_ok.json Normal file
View File

@ -0,0 +1,11 @@
{
"subsonic-response" : {
"status" : "ok",
"version" : "1.15.0",
"lyrics" : {
"artist" : "Amorphis",
"title" : "Alone",
"value" : "Tear dimmed rememberance\nIn a womb of time\nBreath upon me\nPossessed by the"
}
}
}

9
subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicAPIDefinition.kt
View File

@ -4,6 +4,7 @@ import org.moire.ultrasonic.api.subsonic.response.GetAlbumResponse
import org.moire.ultrasonic.api.subsonic.response.GetArtistResponse
import org.moire.ultrasonic.api.subsonic.response.GetArtistsResponse
import org.moire.ultrasonic.api.subsonic.response.GetIndexesResponse
import org.moire.ultrasonic.api.subsonic.response.GetLyricsResponse
import org.moire.ultrasonic.api.subsonic.response.GetMusicDirectoryResponse
import org.moire.ultrasonic.api.subsonic.response.GetPlaylistResponse
import org.moire.ultrasonic.api.subsonic.response.GetPlaylistsResponse
@ -108,9 +109,13 @@ interface SubsonicAPIDefinition {
@Query("comment") comment: String? = null,
@Query("public") public: Boolean? = null,
@Query("songIdToAdd") songIdsToAdd: List<Long>? = null,
@Query("songIndexToRemove") songIndexesToRemove: List<Int>? = null) : Call<SubsonicResponse>
@Query("songIndexToRemove") songIndexesToRemove: List<Int>? = null): Call<SubsonicResponse>
@GET("getPodcasts.view")
fun getPodcasts(@Query("includeEpisodes") includeEpisodes: Boolean? = null,
@Query("id") id: Long? = null) : Call<GetPodcastsResponse>
@Query("id") id: Long? = null): Call<GetPodcastsResponse>
@GET("getLyrics.view")
fun getLyrics(@Query("artist") artist: String? = null,
@Query("title") title: String? = null): Call<GetLyricsResponse>
}

8
subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/Lyrics.kt Normal file
View File

@ -0,0 +1,8 @@
package org.moire.ultrasonic.api.subsonic.models
import com.fasterxml.jackson.annotation.JsonProperty
data class Lyrics(
val artist: String = "",
val title: String = "",
@JsonProperty("value") val text: String = "")

11
subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/GetLyricsResponse.kt Normal file
View File

@ -0,0 +1,11 @@
package org.moire.ultrasonic.api.subsonic.response
import org.moire.ultrasonic.api.subsonic.SubsonicAPIVersions
import org.moire.ultrasonic.api.subsonic.SubsonicError
import org.moire.ultrasonic.api.subsonic.models.Lyrics
class GetLyricsResponse(status: Status,
version: SubsonicAPIVersions,
error: SubsonicError?,
val lyrics: Lyrics = Lyrics())
: SubsonicResponse(status, version, error)

26
ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java
View File

@ -61,6 +61,7 @@ import org.moire.ultrasonic.api.subsonic.response.GetAlbumResponse;
import org.moire.ultrasonic.api.subsonic.response.GetArtistResponse;
import org.moire.ultrasonic.api.subsonic.response.GetArtistsResponse;
import org.moire.ultrasonic.api.subsonic.response.GetIndexesResponse;
import org.moire.ultrasonic.api.subsonic.response.GetLyricsResponse;
import org.moire.ultrasonic.api.subsonic.response.GetMusicDirectoryResponse;
import org.moire.ultrasonic.api.subsonic.response.GetPlaylistResponse;
import org.moire.ultrasonic.api.subsonic.response.GetPlaylistsResponse;
@ -74,6 +75,7 @@ import org.moire.ultrasonic.api.subsonic.response.SubsonicResponse;
import org.moire.ultrasonic.data.APIAlbumConverter;
import org.moire.ultrasonic.data.APIArtistConverter;
import org.moire.ultrasonic.data.APIIndexesConverter;
import org.moire.ultrasonic.data.APILyricsConverter;
import org.moire.ultrasonic.data.APIMusicDirectoryConverter;
import org.moire.ultrasonic.data.APIMusicFolderConverter;
import org.moire.ultrasonic.data.APIPlaylistConverter;
@ -100,7 +102,6 @@ import org.moire.ultrasonic.service.parser.ChatMessageParser;
import org.moire.ultrasonic.service.parser.ErrorParser;
import org.moire.ultrasonic.service.parser.GenreParser;
import org.moire.ultrasonic.service.parser.JukeboxStatusParser;
import org.moire.ultrasonic.service.parser.LyricsParser;
import org.moire.ultrasonic.service.parser.MusicDirectoryParser;
import org.moire.ultrasonic.service.parser.RandomSongsParser;
import org.moire.ultrasonic.service.parser.SearchResult2Parser;
@ -625,20 +626,17 @@ public class RESTMusicService implements MusicService
}
@Override
public Lyrics getLyrics(String artist, String title, Context context, ProgressListener progressListener) throws Exception
{
checkServerVersion(context, "1.2", "Lyrics not supported.");
public Lyrics getLyrics(String artist,
String title,
Context context,
ProgressListener progressListener) throws Exception {
updateProgressListener(progressListener, R.string.parser_reading);
Response<GetLyricsResponse> response = subsonicAPIClient.getApi()
.getLyrics(artist, title).execute();
checkResponseSuccessful(response);
Reader reader = getReader(context, progressListener, "getLyrics", null, asList("artist", "title"), Arrays.<Object>asList(artist, title));
try
{
return new LyricsParser(context).parse(reader, progressListener);
}
finally
{
Util.close(reader);
}
}
return APILyricsConverter.toDomainEntity(response.body().getLyrics());
}
@Override
public void scrobble(String id, boolean submission, Context context, ProgressListener progressListener) throws Exception

78
ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/LyricsParser.java
View File

@ -1,78 +0,0 @@
/*
This file is part of Subsonic.
Subsonic is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Subsonic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Subsonic. If not, see <http://www.gnu.org/licenses/>.
Copyright 2010 (C) Sindre Mehus
*/
package org.moire.ultrasonic.service.parser;
import android.content.Context;
import org.moire.ultrasonic.R;
import org.moire.ultrasonic.domain.Lyrics;
import org.moire.ultrasonic.util.ProgressListener;
import org.xmlpull.v1.XmlPullParser;
import java.io.Reader;
/**
* @author Sindre Mehus
*/
public class LyricsParser extends AbstractParser
{
public LyricsParser(Context context)
{
super(context);
}
public Lyrics parse(Reader reader, ProgressListener progressListener) throws Exception
{
updateProgress(progressListener, R.string.parser_reading);
init(reader);
Lyrics lyrics = null;
int eventType;
do
{
eventType = nextParseEvent();
if (eventType == XmlPullParser.START_TAG)
{
String name = getElementName();
if ("lyrics".equals(name))
{
lyrics = new Lyrics();
lyrics.setArtist(get("artist"));
lyrics.setTitle(get("title"));
}
else if ("error".equals(name))
{
handleError();
}
}
else if (eventType == XmlPullParser.TEXT)
{
if (lyrics != null && lyrics.getText() == null)
{
lyrics.setText(getText());
}
}
} while (eventType != XmlPullParser.END_DOCUMENT);
validate();
return lyrics;
}
}

13
ultrasonic/src/main/kotlin/org/moire/ultrasonic/data/APILyricsConverter.kt Normal file
View File

@ -0,0 +1,13 @@
// Converts Lyrics entity from [org.moire.ultrasonic.api.subsonic.SubsonicAPIClient]
// to app domain entities.
@file:JvmName("APILyricsConverter")
package org.moire.ultrasonic.data
import org.moire.ultrasonic.domain.Lyrics
import org.moire.ultrasonic.api.subsonic.models.Lyrics as APILyrics
fun APILyrics.toDomainEntity(): Lyrics = Lyrics().apply {
artist = this@toDomainEntity.artist
title = this@toDomainEntity.title
text = this@toDomainEntity.text
}

25
ultrasonic/src/test/kotlin/org/moire/ultrasonic/data/APILyricsConverterTest.kt Normal file
View File

@ -0,0 +1,25 @@
@file:Suppress("IllegalIdentifier")
package org.moire.ultrasonic.data
import org.amshove.kluent.`should equal to`
import org.junit.Test
import org.moire.ultrasonic.api.subsonic.models.Lyrics
/**
* Unit test for extension functions in [APILyricsConverter.kt] file.
*/
class APILyricsConverterTest {
@Test
fun `Should convert Lyrics entity to domain`() {
val entity = Lyrics(artist = "some-artist", title = "some-title", text = "song-text")
val convertedEntity = entity.toDomainEntity()
with(convertedEntity) {
artist `should equal to` entity.artist
title `should equal to` entity.title
text `should equal to` entity.text
}
}
}