From f1639bab489ddbd9d5059a66863b6f378db878e9 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Wed, 15 Nov 2017 22:05:52 +0100 Subject: [PATCH 1/5] Delete unused parser. Signed-off-by: Yahor Berdnikau --- .../service/parser/UserInfoParser.java | 67 ------------------- 1 file changed, 67 deletions(-) delete mode 100644 ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/UserInfoParser.java diff --git a/ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/UserInfoParser.java b/ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/UserInfoParser.java deleted file mode 100644 index d1ca92d3..00000000 --- a/ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/UserInfoParser.java +++ /dev/null @@ -1,67 +0,0 @@ -package org.moire.ultrasonic.service.parser; - -import android.content.Context; - -import org.moire.ultrasonic.R; -import org.moire.ultrasonic.domain.UserInfo; -import org.moire.ultrasonic.util.ProgressListener; - -import org.xmlpull.v1.XmlPullParser; - -import java.io.Reader; - -/** - * @author Joshua Bahnsen - */ -public class UserInfoParser extends AbstractParser -{ - public UserInfoParser(Context context) - { - super(context); - } - - public UserInfo parse(Reader reader, ProgressListener progressListener) throws Exception - { - updateProgress(progressListener, R.string.parser_reading); - init(reader); - UserInfo result = new UserInfo(); - int eventType; - - do - { - eventType = nextParseEvent(); - - if (eventType == XmlPullParser.START_TAG) - { - String name = getElementName(); - - if ("user".equals(name)) - { - result.setAdminRole(getBoolean("adminRole")); - result.setCommentRole(getBoolean("commentRole")); - result.setCoverArtRole(getBoolean("coverArtRole")); - result.setDownloadRole(getBoolean("downloadRole")); - result.setEmail(get("email")); - result.setJukeboxRole(getBoolean("jukeboxRole")); - result.setPlaylistRole(getBoolean("playlistRole")); - result.setPodcastRole(getBoolean("podcastRole")); - result.setScrobblingEnabled(getBoolean("scrobblingEnabled")); - result.setSettingsRole(getBoolean("settingsRole")); - result.setShareRole(getBoolean("shareRole")); - result.setStreamRole(getBoolean("streamRole")); - result.setUploadRole(getBoolean("uploadRole")); - result.setUserName(get("username")); - } - else if ("error".equals(name)) - { - handleError(); - } - } - } while (eventType != XmlPullParser.END_DOCUMENT); - - validate(); - updateProgress(progressListener, R.string.parser_reading_done); - - return result; - } -} From 9cecebb3144c948f36a66eadee74fb38467a4412 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Thu, 16 Nov 2017 21:19:24 +0100 Subject: [PATCH 2/5] Add getChatMessages() call. Signed-off-by: Yahor Berdnikau --- .../SubsonicApiGetChatMessagesTest.kt | 45 +++++++++++++++++++ .../resources/get_chat_messages_ok.json | 17 +++++++ .../api/subsonic/SubsonicAPIDefinition.kt | 7 ++- .../api/subsonic/models/ChatMessage.kt | 6 +++ .../subsonic/response/ChatMessagesResponse.kt | 18 ++++++++ 5 files changed, 91 insertions(+), 2 deletions(-) create mode 100644 subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiGetChatMessagesTest.kt create mode 100644 subsonic-api/src/integrationTest/resources/get_chat_messages_ok.json create mode 100644 subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/ChatMessage.kt create mode 100644 subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/ChatMessagesResponse.kt diff --git a/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiGetChatMessagesTest.kt b/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiGetChatMessagesTest.kt new file mode 100644 index 00000000..910c58a0 --- /dev/null +++ b/subsonic-api/src/integrationTest/kotlin/org/moire/ultrasonic/api/subsonic/SubsonicApiGetChatMessagesTest.kt @@ -0,0 +1,45 @@ +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.ChatMessage + +/** + * Integration test for [SubsonicAPIDefinition.getChatMessages] call. + */ +class SubsonicApiGetChatMessagesTest : SubsonicAPIClientTest() { + @Test + fun `Should handle error response`() { + val response = checkErrorCallParsed(mockWebServerRule) { + client.api.getChatMessages().execute() + } + + response.chatMessages `should equal` emptyList() + } + + @Test + fun `Should handle ok response`() { + mockWebServerRule.enqueueResponse("get_chat_messages_ok.json") + + val response = client.api.getChatMessages().execute() + + assertResponseSuccessful(response) + with(response.body().chatMessages) { + size `should equal to` 2 + this[0] `should equal` ChatMessage(username = "sindre", time = 1269771845310, + message = "Sindre was here") + this[1] `should equal` ChatMessage(username = "ben", time = 1269771842504, + message = "Ben too") + } + } + + @Test + fun `Should pass since in request param`() { + val since = 21388L + + mockWebServerRule.assertRequestParam(expectedParam = "since=$since") { + client.api.getChatMessages(since = since).execute() + } + } +} diff --git a/subsonic-api/src/integrationTest/resources/get_chat_messages_ok.json b/subsonic-api/src/integrationTest/resources/get_chat_messages_ok.json new file mode 100644 index 00000000..b406b539 --- /dev/null +++ b/subsonic-api/src/integrationTest/resources/get_chat_messages_ok.json @@ -0,0 +1,17 @@ +{ + "subsonic-response" : { + "status" : "ok", + "version" : "1.15.0", + "chatMessages" : { + "chatMessage" : [ { + "username" : "sindre", + "time" : 1269771845310, + "message" : "Sindre was here" + }, { + "username" : "ben", + "time" : 1269771842504, + "message" : "Ben too" + } ] + } + } +} \ 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 276fcda0..c315e313 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 @@ -3,6 +3,7 @@ package org.moire.ultrasonic.api.subsonic import okhttp3.ResponseBody import org.moire.ultrasonic.api.subsonic.models.AlbumListType import org.moire.ultrasonic.api.subsonic.models.JukeboxAction +import org.moire.ultrasonic.api.subsonic.response.ChatMessagesResponse import org.moire.ultrasonic.api.subsonic.response.GenresResponse import org.moire.ultrasonic.api.subsonic.response.GetAlbumList2Response import org.moire.ultrasonic.api.subsonic.response.GetAlbumListResponse @@ -212,6 +213,8 @@ interface SubsonicAPIDefinition { @Query("musicFolderId") musicFolderId: Long? = null): Call @GET("getUser.view") - fun getUser( - @Query("username") username: String): Call + fun getUser(@Query("username") username: String): Call + + @GET("getChatMessages.view") + fun getChatMessages(@Query("since") since: Long? = null): Call } diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/ChatMessage.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/ChatMessage.kt new file mode 100644 index 00000000..7e76a466 --- /dev/null +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/models/ChatMessage.kt @@ -0,0 +1,6 @@ +package org.moire.ultrasonic.api.subsonic.models + +data class ChatMessage( + val username: String = "", + val time: Long = 0, + val message: String = "") diff --git a/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/ChatMessagesResponse.kt b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/ChatMessagesResponse.kt new file mode 100644 index 00000000..4e41ccc8 --- /dev/null +++ b/subsonic-api/src/main/kotlin/org/moire/ultrasonic/api/subsonic/response/ChatMessagesResponse.kt @@ -0,0 +1,18 @@ +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.ChatMessage + +class ChatMessagesResponse( + status: Status, + version: SubsonicAPIVersions, + error: SubsonicError?) : SubsonicResponse(status, version, error) { + @JsonProperty("chatMessages") private val wrapper = ChatMessagesWrapper() + + val chatMessages: List get() = wrapper.messagesList +} + +internal class ChatMessagesWrapper( + @JsonProperty("chatMessage") val messagesList: List = emptyList()) From 6c1039126e6f13159847be49dd93b9eca3978dab Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Thu, 16 Nov 2017 21:32:36 +0100 Subject: [PATCH 3/5] Add converter function for ChatMessage entity to domain entity. Signed-off-by: Yahor Berdnikau --- .../data/APIChatMessageConverter.kt | 15 +++++++ .../data/APIChatMessageConverterTest.kt | 40 +++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 ultrasonic/src/main/kotlin/org/moire/ultrasonic/data/APIChatMessageConverter.kt create mode 100644 ultrasonic/src/test/kotlin/org/moire/ultrasonic/data/APIChatMessageConverterTest.kt diff --git a/ultrasonic/src/main/kotlin/org/moire/ultrasonic/data/APIChatMessageConverter.kt b/ultrasonic/src/main/kotlin/org/moire/ultrasonic/data/APIChatMessageConverter.kt new file mode 100644 index 00000000..96119075 --- /dev/null +++ b/ultrasonic/src/main/kotlin/org/moire/ultrasonic/data/APIChatMessageConverter.kt @@ -0,0 +1,15 @@ +// Contains helper functions to convert from api ChatMessage entity to domain entity +@file:JvmName("APIChatMessageConverter") +package org.moire.ultrasonic.data + +import org.moire.ultrasonic.domain.ChatMessage +import org.moire.ultrasonic.api.subsonic.models.ChatMessage as ApiChatMessage + +fun ApiChatMessage.toDomainEntity(): ChatMessage = ChatMessage().apply { + username = this@toDomainEntity.username + time = this@toDomainEntity.time + message = this@toDomainEntity.message +} + +fun List.toDomainEntitiesList(): List = this + .map { it.toDomainEntity() } diff --git a/ultrasonic/src/test/kotlin/org/moire/ultrasonic/data/APIChatMessageConverterTest.kt b/ultrasonic/src/test/kotlin/org/moire/ultrasonic/data/APIChatMessageConverterTest.kt new file mode 100644 index 00000000..fc213ca5 --- /dev/null +++ b/ultrasonic/src/test/kotlin/org/moire/ultrasonic/data/APIChatMessageConverterTest.kt @@ -0,0 +1,40 @@ +@file:Suppress("IllegalIdentifier") + +package org.moire.ultrasonic.data + +import org.amshove.kluent.`should equal to` +import org.amshove.kluent.`should equal` +import org.junit.Test +import org.moire.ultrasonic.api.subsonic.models.ChatMessage + +/** + * Unit test for functions converting api [ChatMessage] to domain entity. + */ +class APIChatMessageConverterTest { + @Test + fun `Should convert entity`() { + val entity = ChatMessage("Woohoo", 553434L, "Wow") + + val domainEntity = entity.toDomainEntity() + + with(domainEntity) { + username `should equal to` entity.username + time `should equal to` entity.time + message `should equal to` entity.message + } + } + + @Test + fun `Should convert list of entities`() { + val entitiesList = listOf(ChatMessage("AAA"), ChatMessage("BBB")) + + val domainEntitiesList = entitiesList.toDomainEntitiesList() + + with(domainEntitiesList) { + size `should equal to` entitiesList.size + forEachIndexed { index, chatMessage -> + chatMessage `should equal` entitiesList[index].toDomainEntity() + } + } + } +} From 74bf89ef26475559c698ea13a9ab2b18f3e38cd5 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Thu, 16 Nov 2017 21:33:04 +0100 Subject: [PATCH 4/5] Use new api getChatMessages() call. Signed-off-by: Yahor Berdnikau --- .../ultrasonic/service/RESTMusicService.java | 36 +++++++------------ 1 file changed, 12 insertions(+), 24 deletions(-) diff --git a/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java b/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java index 7e456b1d..506c1021 100644 --- a/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java +++ b/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java @@ -58,6 +58,7 @@ import org.moire.ultrasonic.api.subsonic.SubsonicAPIClient; import org.moire.ultrasonic.api.subsonic.models.AlbumListType; import org.moire.ultrasonic.api.subsonic.models.JukeboxAction; import org.moire.ultrasonic.api.subsonic.models.MusicDirectoryChild; +import org.moire.ultrasonic.api.subsonic.response.ChatMessagesResponse; import org.moire.ultrasonic.api.subsonic.response.GenresResponse; import org.moire.ultrasonic.api.subsonic.response.GetAlbumList2Response; import org.moire.ultrasonic.api.subsonic.response.GetAlbumListResponse; @@ -86,6 +87,7 @@ import org.moire.ultrasonic.api.subsonic.response.StreamResponse; 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.APIChatMessageConverter; import org.moire.ultrasonic.data.APIIndexesConverter; import org.moire.ultrasonic.data.APIJukeboxConverter; import org.moire.ultrasonic.data.APILyricsConverter; @@ -1245,31 +1247,17 @@ public class RESTMusicService implements MusicService return APIUserConverter.toDomainEntity(response.body().getUser()); } - @Override - public List getChatMessages(Long since, Context context, ProgressListener progressListener) throws Exception - { - checkServerVersion(context, "1.2", "Chat not supported."); + @Override + public List getChatMessages(Long since, + Context context, + ProgressListener progressListener) throws Exception { + updateProgressListener(progressListener, R.string.parser_reading); + Response response = subsonicAPIClient.getApi() + .getChatMessages(since).execute(); + checkResponseSuccessful(response); - HttpParams params = new BasicHttpParams(); - HttpConnectionParams.setSoTimeout(params, SOCKET_READ_TIMEOUT_GET_RANDOM_SONGS); - - List parameterNames = new ArrayList(); - List parameterValues = new ArrayList(); - - parameterNames.add("since"); - parameterValues.add(since); - - Reader reader = getReader(context, progressListener, "getChatMessages", params, parameterNames, parameterValues); - - try - { - return new ChatMessageParser(context).parse(reader, progressListener); - } - finally - { - Util.close(reader); - } - } + return APIChatMessageConverter.toDomainEntitiesList(response.body().getChatMessages()); + } @Override public void addChatMessage(String message, Context context, ProgressListener progressListener) throws Exception From b6f9c733bc88f161039a394866c796ecda710278 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Thu, 16 Nov 2017 21:34:22 +0100 Subject: [PATCH 5/5] Delete unused ChatMessageParser. Signed-off-by: Yahor Berdnikau --- .../ultrasonic/service/RESTMusicService.java | 1 - .../service/parser/ChatMessageParser.java | 59 ------------------- 2 files changed, 60 deletions(-) delete mode 100644 ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/ChatMessageParser.java diff --git a/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java b/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java index 506c1021..c83c048c 100644 --- a/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java +++ b/ultrasonic/src/main/java/org/moire/ultrasonic/service/RESTMusicService.java @@ -115,7 +115,6 @@ import org.moire.ultrasonic.domain.Share; import org.moire.ultrasonic.domain.UserInfo; import org.moire.ultrasonic.domain.Version; import org.moire.ultrasonic.service.parser.BookmarkParser; -import org.moire.ultrasonic.service.parser.ChatMessageParser; import org.moire.ultrasonic.service.parser.ErrorParser; import org.moire.ultrasonic.service.parser.MusicDirectoryParser; import org.moire.ultrasonic.service.parser.SubsonicRESTException; diff --git a/ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/ChatMessageParser.java b/ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/ChatMessageParser.java deleted file mode 100644 index 43b8618b..00000000 --- a/ultrasonic/src/main/java/org/moire/ultrasonic/service/parser/ChatMessageParser.java +++ /dev/null @@ -1,59 +0,0 @@ -package org.moire.ultrasonic.service.parser; - -import android.content.Context; - -import org.moire.ultrasonic.R; -import org.moire.ultrasonic.domain.ChatMessage; -import org.moire.ultrasonic.util.ProgressListener; - -import org.xmlpull.v1.XmlPullParser; - -import java.io.Reader; -import java.util.ArrayList; -import java.util.List; - -/** - * @author Joshua Bahnsen - */ -public class ChatMessageParser extends AbstractParser -{ - - public ChatMessageParser(Context context) - { - super(context); - } - - public List parse(Reader reader, ProgressListener progressListener) throws Exception - { - updateProgress(progressListener, R.string.parser_reading); - init(reader); - List result = new ArrayList(); - int eventType; - - do - { - eventType = nextParseEvent(); - if (eventType == XmlPullParser.START_TAG) - { - String name = getElementName(); - if ("chatMessage".equals(name)) - { - ChatMessage chatMessage = new ChatMessage(); - chatMessage.setUsername(get("username")); - chatMessage.setTime(getLong("time")); - chatMessage.setMessage(get("message")); - result.add(chatMessage); - } - else if ("error".equals(name)) - { - handleError(); - } - } - } while (eventType != XmlPullParser.END_DOCUMENT); - - validate(); - updateProgress(progressListener, R.string.parser_reading_done); - - return result; - } -}