From dd115757b62079e34d1052b3ef50250f8464fdbc Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Fri, 25 Aug 2017 21:32:36 +0200 Subject: [PATCH] Add search2 api request. Signed-off-by: Yahor Berdnikau --- .../api/subsonic/SubsonicApiSearchTwoTest.kt | 111 ++++++++++++++++++ .../integrationTest/resources/search2_ok.json | 50 ++++++++ .../api/subsonic/SubsonicAPIDefinition.kt | 10 ++ .../api/subsonic/models/SearchTwoResult.kt | 9 ++ .../subsonic/response/SearchTwoResponse.kt | 12 ++ 5 files changed, 192 insertions(+) create mode 100644 subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTwoTest.kt create mode 100644 subsonic-api/src/integrationTest/resources/search2_ok.json create mode 100644 subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchTwoResult.kt create mode 100644 subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchTwoResponse.kt diff --git a/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTwoTest.kt b/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTwoTest.kt new file mode 100644 index 00000000..2ea69087 --- /dev/null +++ b/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTwoTest.kt @@ -0,0 +1,111 @@ +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.Artist +import org.moire.ultrasonic.api.subsonic.models.MusicDirectoryChild + +/** + * Integration test for [SubsonicAPIClient] for search2 call. + */ +class SubsonicApiSearchTwoTest : SubsonicAPIClientTest() { + @Test + fun `Should handle error response`() { + checkErrorCallParsed(mockWebServerRule, { + client.api.search2("some-query").execute() + }) + } + + @Test + fun `Should parse ok response`() { + mockWebServerRule.enqueueResponse("search2_ok.json") + + val response = client.api.search2("some-query").execute() + + assertResponseSuccessful(response) + with(response.body().searchResult) { + artistList.size `should equal to` 1 + artistList[0] `should equal` Artist(id = 522, name = "The Prodigy") + albumList.size `should equal to` 1 + albumList[0] `should equal` MusicDirectoryChild(id = 8867, parent = 522, isDir = true, + title = "Always Outnumbered, Never Outgunned", + album = "Always Outnumbered, Never Outgunned", artist = "The Prodigy", + year = 2004, genre = "Electronic", coverArt = "8867", playCount = 0, + created = parseDate("2016-10-23T20:57:27.000Z")) + 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 id in request param`() { + val query = "some" + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2(query).execute() + }, expectedParam = "query=$query") + } + + @Test + fun `Should pass artist count in request param`() { + val artistCount = 45 + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2("some", artistCount = artistCount).execute() + }, expectedParam = "artistCount=$artistCount") + } + + @Test + fun `Should pass artist offset in request param`() { + val artistOffset = 13 + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2("some", artistOffset = artistOffset).execute() + }, expectedParam = "artistOffset=$artistOffset") + } + + @Test + fun `Should pass album count in request param`() { + val albumCount = 30 + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2("some", albumCount = albumCount).execute() + }, expectedParam = "albumCount=$albumCount") + } + + @Test + fun `Should pass album offset in request param`() { + val albumOffset = 91 + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2("some", albumOffset = albumOffset).execute() + }, expectedParam = "albumOffset=$albumOffset") + } + + @Test + fun `Should pass song count in request param`() { + val songCount = 22 + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2("some", songCount = songCount).execute() + }, expectedParam = "songCount=$songCount") + } + + @Test + fun `Should pass music folder id in request param`() { + val musicFolderId = 565L + + mockWebServerRule.assertRequestParam(responseResourceName = "search2_ok.json", apiRequest = { + client.api.search2("some", musicFolderId = musicFolderId).execute() + }, expectedParam = "musicFolderId=$musicFolderId") + } +} diff --git a/subsonic-api/src/integrationTest/resources/search2_ok.json b/subsonic-api/src/integrationTest/resources/search2_ok.json new file mode 100644 index 00000000..ee321cab --- /dev/null +++ b/subsonic-api/src/integrationTest/resources/search2_ok.json @@ -0,0 +1,50 @@ +{ + "subsonic-response" : { + "status" : "ok", + "version" : "1.15.0", + "searchResult2" : { + "artist" : [ { + "id" : "522", + "name" : "The Prodigy" + } ], + "album" : [ { + "id" : "8867", + "parent" : "522", + "isDir" : true, + "title" : "Always Outnumbered, Never Outgunned", + "album" : "Always Outnumbered, Never Outgunned", + "artist" : "The Prodigy", + "year" : 2004, + "genre" : "Electronic", + "coverArt" : "8867", + "playCount" : 0, + "created" : "2016-10-23T20:57:27.000Z" + } ], + "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" + } ] + } + } +} \ No newline at end of file diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicAPIDefinition.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicAPIDefinition.kt index ce3167ef..7c3d3ad3 100644 --- a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicAPIDefinition.kt +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicAPIDefinition.kt @@ -7,6 +7,7 @@ import org.moire.ultrasonic.api.subsonic.response.GetIndexesResponse import org.moire.ultrasonic.api.subsonic.response.GetMusicDirectoryResponse 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.SubsonicResponse import retrofit2.Call @@ -63,4 +64,13 @@ interface SubsonicAPIDefinition { @Query("count") count: Int? = null, @Query("offset") offset: Int? = null, @Query("newerThan") newerThan: Long? = null): Call + + @GET("search2.view") + fun search2(@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 } diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchTwoResult.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchTwoResult.kt new file mode 100644 index 00000000..4a0fbb92 --- /dev/null +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchTwoResult.kt @@ -0,0 +1,9 @@ +package org.moire.ultrasonic.api.subsonic.models + +import com.fasterxml.jackson.annotation.JsonProperty + +data class SearchTwoResult( + @JsonProperty("artist") val artistList: List = emptyList(), + @JsonProperty("album") val albumList: List = emptyList(), + @JsonProperty("song") val songList: List = emptyList() +) diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchTwoResponse.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchTwoResponse.kt new file mode 100644 index 00000000..32a90b41 --- /dev/null +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchTwoResponse.kt @@ -0,0 +1,12 @@ +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.SearchTwoResult + +class SearchTwoResponse(status: Status, + version: SubsonicAPIVersions, + error: SubsonicError?, + @JsonProperty("searchResult2") val searchResult: SearchTwoResult = SearchTwoResult()) + : SubsonicResponse(status, version, error)