diff --git a/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTest.kt b/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTest.kt new file mode 100644 index 00000000..e0e868d2 --- /dev/null +++ b/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiSearchTest.kt @@ -0,0 +1,125 @@ +package org.moire.ultrasonic.api.subsonic + +import org.amshove.kluent.`should contain` +import org.amshove.kluent.`should equal to` +import org.amshove.kluent.`should equal` +import org.junit.Test +import org.moire.ultrasonic.api.subsonic.models.MusicDirectoryChild +import java.util.Calendar + +/** + * Integration test for [SubsonicAPIClient] for search call. + */ +class SubsonicApiSearchTest : SubsonicAPIClientTest() { + @Test + fun `Should parse error response`() { + checkErrorCallParsed(mockWebServerRule, { + client.api.search().execute() + }) + } + + @Test + fun `Should parse ok response`() { + enqueueOkResponse() + + val response = client.api.search().execute() + + assertResponseSuccessful(response) + with(response.body().searchResult) { + offset `should equal to` 10 + totalHits `should equal to` 53 + matchList.size `should equal to` 1 + matchList[0] `should equal` MusicDirectoryChild(id = 5831L, parent = 5766L, + 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 artist param`() { + enqueueOkResponse() + val artist = "some-artist" + client.api.search(artist = artist).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "artist=$artist" + } + + @Test + fun `Should pass album param`() { + enqueueOkResponse() + val album = "some-album" + client.api.search(album = album).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "album=$album" + } + + @Test + fun `Should pass title param`() { + enqueueOkResponse() + val title = "some-title" + client.api.search(title = title).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "title=$title" + } + + @Test + fun `Should contain any param`() { + enqueueOkResponse() + val any = "AnyString" + client.api.search(any = any).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "any=$any" + } + + @Test + fun `Should contain count param`() { + enqueueOkResponse() + val count = 11 + client.api.search(count = count).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "count=$count" + } + + @Test + fun `Should contain offset param`() { + enqueueOkResponse() + val offset = 54 + client.api.search(offset = offset).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "offset=$offset" + } + + @Test + fun `Should contain newerThan param`() { + enqueueOkResponse() + val newerThan = Calendar.getInstance() + client.api.search(newerThan = newerThan.time.time).execute() + + val request = mockWebServerRule.mockWebServer.takeRequest() + + request.requestLine `should contain` "newerThan=${newerThan.time.time}" + } + + private fun enqueueOkResponse() { + mockWebServerRule.enqueueResponse("search_ok.json") + } +} diff --git a/subsonic-api/src/integrationTest/resources/search_ok.json b/subsonic-api/src/integrationTest/resources/search_ok.json new file mode 100644 index 00000000..47ea4a23 --- /dev/null +++ b/subsonic-api/src/integrationTest/resources/search_ok.json @@ -0,0 +1,35 @@ +{ + "subsonic-response" : { + "status" : "ok", + "version" : "1.15.0", + "searchResult" : { + "offset" : 10, + "totalHits" : 53, + "match" : [ { + "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 e5a38a1c..ce3167ef 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.SearchResponse import org.moire.ultrasonic.api.subsonic.response.SubsonicResponse import retrofit2.Call import retrofit2.http.GET @@ -17,6 +18,7 @@ import retrofit2.http.Query * * For methods description see [http://www.subsonic.org/pages/api.jsp]. */ +@Suppress("TooManyFunctions", "LongParameterList") interface SubsonicAPIDefinition { @GET("ping.view") fun ping(): Call @@ -52,4 +54,13 @@ interface SubsonicAPIDefinition { @GET("getAlbum.view") fun getAlbum(@Query("id") id: Long): Call + + @GET("search.view") + fun search(@Query("artist") artist: String? = null, + @Query("album") album: String? = null, + @Query("title") title: String? = null, + @Query("any") any: String? = null, + @Query("count") count: Int? = null, + @Query("offset") offset: Int? = null, + @Query("newerThan") newerThan: Long? = null): Call } diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchResult.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchResult.kt new file mode 100644 index 00000000..405feb13 --- /dev/null +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/SearchResult.kt @@ -0,0 +1,7 @@ +package org.moire.ultrasonic.api.subsonic.models + +import com.fasterxml.jackson.annotation.JsonProperty + +data class SearchResult(val offset: Int = 0, + val totalHits: Int = 0, + @JsonProperty("match") val matchList: List = emptyList()) diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchResponse.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchResponse.kt new file mode 100644 index 00000000..aac0a817 --- /dev/null +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/SearchResponse.kt @@ -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.SearchResult + +class SearchResponse(status: Status, + version: SubsonicAPIVersions, + error: SubsonicError?, + val searchResult: SearchResult = SearchResult()) + : SubsonicResponse(status, version, error)