Funkwhale
/
ultrasonic-app-subsonic-android
mirror of https://github.com/ultrasonic/ultrasonic
1
0
Fork 0
Code Issues Releases Wiki Activity

Add new search3 api call. 

Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
This commit is contained in:
Yahor Berdnikau 2017-08-27 11:39:38 +02:00
parent 9ce47c3be0
commit d97590b346
5 changed files with 195 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1,112 @@
package org.moire.ultrasonic.api.subsonic
import org.amshove.kluent.`should equal to`
import org.amshove.kluent.`should equal`
import org.junit.Test
import org.moire.ultrasonic.api.subsonic.models.Album
import org.moire.ultrasonic.api.subsonic.models.Artist
import org.moire.ultrasonic.api.subsonic.models.MusicDirectoryChild
/**
* Integration test for [SubsonicAPIClient] for search3 call.
*/
class SubsonicApiSearchThreeTest : SubsonicAPIClientTest() {
@Test
fun `Should parse error response`() {
checkErrorCallParsed(mockWebServerRule, {
client.api.search3("some-query").execute()
})
}
@Test
fun `Should parse ok response`() {
mockWebServerRule.enqueueResponse("search3_ok.json")
val response = client.api.search3("some-query").execute()
assertResponseSuccessful(response)
with(response.body().searchResult) {
artistList.size `should equal to` 1
artistList[0] `should equal` Artist(id = 505, name = "The Prodigy", coverArt = "ar-505",
albumCount = 5)
albumList.size `should equal to` 1
albumList[0] `should equal` Album(id = 855, name = "Always Outnumbered, Never Outgunned",
artist = "The Prodigy", artistId = 505, coverArt = "al-855", songCount = 12,
duration = 3313, created = parseDate("2016-10-23T20:57:27.000Z"),
year = 2004, genre = "Electronic")
songList.size `should equal to` 1
songList[0] `should equal` MusicDirectoryChild(id = 5831, parent = 5766, isDir = false,
title = "You'll Be Under My Wheels", album = "Need for Speed Most Wanted",
artist = "The Prodigy", track = 17, year = 2005, genre = "Rap",
coverArt = "5766", size = 5607024, contentType = "audio/mpeg",
suffix = "mp3", duration = 233, bitRate = 192,
path = "Compilations/Need for Speed Most Wanted/17 You'll Be Under My Wheels.mp3",
isVideo = false, playCount = 0, discNumber = 1,
created = parseDate("2016-10-23T20:09:02.000Z"), albumId = 568,
artistId = 505, type = "music")
}
}
@Test
fun `Should pass query as request param`() {
val query = "some-wip-query"
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3(query = query).execute()
}, expectedParam = "query=$query")
}
@Test
fun `Should pass artist count as request param`() {
val artistCount = 67
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3("some", artistCount = artistCount).execute()
}, expectedParam = "artistCount=$artistCount")
}
@Test
fun `Should pass artist offset as request param`() {
val artistOffset = 34
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3("some", artistOffset = artistOffset).execute()
}, expectedParam = "artistOffset=$artistOffset")
}
@Test
fun `Should pass album count as request param`() {
val albumCount = 21
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3("some", albumCount = albumCount).execute()
}, expectedParam = "albumCount=$albumCount")
}
@Test
fun `Should pass album offset as request param`() {
val albumOffset = 43
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3("some", albumOffset = albumOffset).execute()
}, expectedParam = "albumOffset=$albumOffset")
}
@Test
fun `Should pass song count as request param`() {
val songCount = 15
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3("some", songCount = songCount).execute()
}, expectedParam = "songCount=$songCount")
}
@Test
fun `Should pass music folder id as request param`() {
val musicFolderId = 43L
mockWebServerRule.assertRequestParam(responseResourceName = "search3_ok.json", apiRequest = {
client.api.search3("some", musicFolderId = musicFolderId).execute()
}, expectedParam = "musicFolderId=$musicFolderId")
}
}

51
subsonic-api/src/integrationTest/resources/search3_ok.json Normal file
View File

@ -0,0 +1,51 @@
{
"subsonic-response" : {
"status" : "ok",
"version" : "1.15.0",
"searchResult3" : {
"artist" : [ {
"id" : "505",
"name" : "The Prodigy",
"coverArt" : "ar-505",
"albumCount" : 5
} ],
"album" : [ {
"id" : "855",
"name" : "Always Outnumbered, Never Outgunned",
"artist" : "The Prodigy",
"artistId" : "505",
"coverArt" : "al-855",
"songCount" : 12,
"duration" : 3313,
"created" : "2016-10-23T20:57:27.000Z",
"year" : 2004,
"genre" : "Electronic"
} ],
"song" : [ {
"id" : "5831",
"parent" : "5766",
"isDir" : false,
"title" : "You'll Be Under My Wheels",
"album" : "Need for Speed Most Wanted",
"artist" : "The Prodigy",
"track" : 17,
"year" : 2005,
"genre" : "Rap",
"coverArt" : "5766",
"size" : 5607024,
"contentType" : "audio/mpeg",
"suffix" : "mp3",
"duration" : 233,
"bitRate" : 192,
"path" : "Compilations/Need for Speed Most Wanted/17 You'll Be Under My Wheels.mp3",
"isVideo" : false,
"playCount" : 0,
"discNumber" : 1,
"created" : "2016-10-23T20:09:02.000Z",
"albumId" : "568",
"artistId" : "505",
"type" : "music"
} ]
}
}
}

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

@ -9,6 +9,7 @@ import org.moire.ultrasonic.api.subsonic.response.LicenseResponse
import org.moire.ultrasonic.api.subsonic.response.MusicFoldersResponse
import org.moire.ultrasonic.api.subsonic.response.SearchTwoResponse
import org.moire.ultrasonic.api.subsonic.response.SearchResponse
import org.moire.ultrasonic.api.subsonic.response.SearchThreeResponse
import org.moire.ultrasonic.api.subsonic.response.SubsonicResponse
import retrofit2.Call
import retrofit2.http.GET
@ -73,4 +74,13 @@ interface SubsonicAPIDefinition {
@Query("albumOffset") albumOffset: Int? = null,
@Query("songCount") songCount: Int? = null,
@Query("musicFolderId") musicFolderId: Long? = null): Call<SearchTwoResponse>
@GET("search3.view")
fun search3(@Query("query") query: String,
@Query("artistCount") artistCount: Int? = null,
@Query("artistOffset") artistOffset: Int? = null,
@Query("albumCount") albumCount: Int? = null,
@Query("albumOffset") albumOffset: Int? = null,
@Query("songCount") songCount: Int? = null,
@Query("musicFolderId") musicFolderId: Long? = null): Call<SearchThreeResponse>
}

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

@ -0,0 +1,9 @@
package org.moire.ultrasonic.api.subsonic.models
import com.fasterxml.jackson.annotation.JsonProperty
data class SearchThreeResult(
@JsonProperty("artist") val artistList: List<Artist> = emptyList(),
@JsonProperty("album") val albumList: List<Album> = emptyList(),
@JsonProperty("song") val songList: List<MusicDirectoryChild> = emptyList()
)

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

@ -0,0 +1,13 @@
package org.moire.ultrasonic.api.subsonic.response
import com.fasterxml.jackson.annotation.JsonProperty
import org.moire.ultrasonic.api.subsonic.SubsonicAPIVersions
import org.moire.ultrasonic.api.subsonic.SubsonicError
import org.moire.ultrasonic.api.subsonic.models.SearchThreeResult
class SearchThreeResponse(
status: Status,
version: SubsonicAPIVersions,
error: SubsonicError?,
@JsonProperty("searchResult3") val searchResult: SearchThreeResult = SearchThreeResult())
: SubsonicResponse(status, version, error)