MOBILE-213: Implementation of CreatedForYou screen

app/src/main/java/org/listenbrainz/android/di/PlaylistRepositoryModule.kt

@@ -0,0 +1,16 @@
+package org.listenbrainz.android.di
+
+import dagger.Binds
+import dagger.Module
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import org.listenbrainz.android.repository.playlists.PlaylistDataRepository
+import org.listenbrainz.android.repository.playlists.PlaylistDataRepositoryImpl
+
+@Module
+@InstallIn(SingletonComponent::class)
+abstract class PlaylistRepositoryModule {
+
+    @Binds
+    abstract fun bindsPlaylistRepository(repository: PlaylistDataRepositoryImpl?): PlaylistDataRepository?
+}

app/src/main/java/org/listenbrainz/android/di/ServiceModule.kt

@@ -21,6 +21,7 @@ import org.listenbrainz.android.service.CBService
 import org.listenbrainz.android.service.FeedService
 import org.listenbrainz.android.service.ListensService
 import org.listenbrainz.android.service.MBService
+import org.listenbrainz.android.service.PlaylistService
 import org.listenbrainz.android.service.SocialService
 import org.listenbrainz.android.service.UserService
 import org.listenbrainz.android.service.Yim23Service
@@ -92,6 +93,12 @@ class ServiceModule {
         constructRetrofit(appPreferences)
         .create(UserService::class.java)
 
+    @Singleton
+    @Provides
+    fun providesPlaylistService(appPreferences: AppPreferences) : PlaylistService =
+        constructRetrofit(appPreferences)
+            .create(PlaylistService::class.java)
+
     @Singleton
     @Provides
     fun providesArtistService(): ArtistService = Retrofit.Builder()

app/src/main/java/org/listenbrainz/android/model/createdForYou/AdditionalMetadata.kt

@@ -0,0 +1,11 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class AdditionalMetadata(
+    @SerializedName("algorithm_metadata")
+    val algorithmMetadata: AlgorithmMetadata = AlgorithmMetadata(),
+    @SerializedName("expires_at")
+    val expiresAt: String? = null,
+)

app/src/main/java/org/listenbrainz/android/model/createdForYou/AlgorithmMetadata.kt

@@ -0,0 +1,9 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class AlgorithmMetadata(
+    @SerializedName("source_patch")
+    val sourcePatch: String? = null
+)

app/src/main/java/org/listenbrainz/android/model/createdForYou/CreatedForYouExtensionData.kt

@@ -0,0 +1,17 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class CreatedForYouExtensionData(
+    @SerializedName("additional_metadata")
+    val additionalMetadata: AdditionalMetadata = AdditionalMetadata(),
+    @SerializedName("created_for")
+    val createdFor: String? = null,
+    @SerializedName("creator")
+    val creator: String? = null,
+    @SerializedName("last_modified_at")
+    val lastModifiedAt: String? = null,
+    @SerializedName("public")
+    val public: Boolean? = null
+)

app/src/main/java/org/listenbrainz/android/model/createdForYou/CreatedForYouPayload.kt

@@ -0,0 +1,15 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class CreatedForYouPayload(
+    @SerializedName("count")
+    val count: Int? = null,
+    @SerializedName("offset")
+    val offset: Int? = null,
+    @SerializedName("playlist_count")
+    val playlistCount: Int? = null,
+    @SerializedName("playlists")
+    val playlists: List<CreatedForYouPlaylists> = listOf()
+)

app/src/main/java/org/listenbrainz/android/model/createdForYou/CreatedForYouPlaylist.kt

@@ -0,0 +1,29 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class CreatedForYouPlaylist(
+    @SerializedName("annotation")
+    val annotation: String? = null,
+    @SerializedName("creator")
+    val creator: String? = null,
+    @SerializedName("date")
+    val date: String? = null,
+    @SerializedName("extension")
+    val extension: Extension = Extension(),
+    @SerializedName("identifier")
+    val identifier: String? = null,
+    @SerializedName("title")
+    val title: String? = null,
+    @SerializedName("track")
+    val track: List<Any> = listOf()
+){
+    // Get the MBID of the playlist
+    fun getPlaylistMBID(): String? {
+        // Regex to extract the MBID from the identifier
+        val regex = """playlist/([a-f0-9\-]+)""".toRegex()
+        val matchResult = identifier?.let { regex.find(it) }
+        return matchResult?.groupValues?.get(1)
+    }
+}

app/src/main/java/org/listenbrainz/android/model/createdForYou/CreatedForYouPlaylists.kt

@@ -0,0 +1,16 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class CreatedForYouPlaylists(
+    @SerializedName("playlist")
+    val playlist: CreatedForYouPlaylist = CreatedForYouPlaylist()
+){
+    fun getPlaylistMBID(): String? {
+        val url = playlist.identifier
+        val regex = """playlist/([a-f0-9\-]+)""".toRegex()
+        val matchResult = url?.let { regex.find(it) }
+        return matchResult?.groupValues?.get(1)
+    }
+}

app/src/main/java/org/listenbrainz/android/model/createdForYou/Extension.kt

@@ -0,0 +1,9 @@
+package org.listenbrainz.android.model.createdForYou
+
+
+import com.google.gson.annotations.SerializedName
+
+data class Extension(
+    @SerializedName("https://musicbrainz.org/doc/jspf#playlist")
+    val createdForYouExtensionData: CreatedForYouExtensionData = CreatedForYouExtensionData()
+)

app/src/main/java/org/listenbrainz/android/model/playlist/AdditionalMetadata.kt

@@ -0,0 +1,11 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class AdditionalMetadata(
+    @SerializedName("algorithm_metadata")
+    val algorithmMetadata: AlgorithmMetadata = AlgorithmMetadata(),
+    @SerializedName("expires_at")
+    val expiresAt: String? = null
+)

app/src/main/java/org/listenbrainz/android/model/playlist/AdditionalMetadataTrack.kt

@@ -0,0 +1,13 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class AdditionalMetadataTrack(
+    @SerializedName("artists")
+    val artists: List<PlaylistArtist> = listOf(),
+    @SerializedName("caa_id")
+    val caaId: Long? = null,
+    @SerializedName("caa_release_mbid")
+    val caaReleaseMbid: String? = null
+)

app/src/main/java/org/listenbrainz/android/model/playlist/AlgorithmMetadata.kt

@@ -0,0 +1,9 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class AlgorithmMetadata(
+    @SerializedName("source_patch")
+    val sourcePatch: String? = null
+)

app/src/main/java/org/listenbrainz/android/model/playlist/CopyPlaylistResponse.kt

@@ -0,0 +1,11 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class CopyPlaylistResponse(
+    @SerializedName("playlist_mbid")
+    val playlistMbid: String,
+    @SerializedName("status")
+    val status: String
+)

app/src/main/java/org/listenbrainz/android/model/playlist/Extension.kt

@@ -0,0 +1,9 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class Extension(
+    @SerializedName("https://musicbrainz.org/doc/jspf#playlist")
+    val playlistExtensionData: PlaylistExtensionData = PlaylistExtensionData()
+)

app/src/main/java/org/listenbrainz/android/model/playlist/PlaylistArtist.kt

@@ -0,0 +1,13 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class PlaylistArtist(
+    @SerializedName("artist_credit_name")
+    val artistCreditName: String? = null,
+    @SerializedName("artist_mbid")
+    val artistMbid: String? = null,
+    @SerializedName("join_phrase")
+    val joinPhrase: String? = null
+)

app/src/main/java/org/listenbrainz/android/model/playlist/PlaylistData.kt

@@ -0,0 +1,21 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class PlaylistData(
+    @SerializedName("annotation")
+    val annotation: String? = null,
+    @SerializedName("creator")
+    val creator: String? = null,
+    @SerializedName("date")
+    val date: String? = null,
+    @SerializedName("extension")
+    val extension: Extension = Extension(),
+    @SerializedName("identifier")
+    val identifier: String? = null,
+    @SerializedName("title")
+    val title: String? = null,
+    @SerializedName("track")
+    val track: List<PlaylistTrack> = listOf()
+)

app/src/main/java/org/listenbrainz/android/model/playlist/PlaylistExtensionData.kt

@@ -0,0 +1,17 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class PlaylistExtensionData(
+    @SerializedName("additional_metadata")
+    val additionalMetadata: AdditionalMetadata = AdditionalMetadata(),
+    @SerializedName("created_for")
+    val createdFor: String? = null,
+    @SerializedName("creator")
+    val creator: String? = null,
+    @SerializedName("last_modified_at")
+    val lastModifiedAt: String? = null,
+    @SerializedName("public")
+    val `public`: Boolean? = null
+)

app/src/main/java/org/listenbrainz/android/model/playlist/PlaylistPayload.kt

@@ -0,0 +1,9 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class PlaylistPayload(
+    @SerializedName("playlist")
+    val playlist: PlaylistData = PlaylistData()
+)

app/src/main/java/org/listenbrainz/android/model/playlist/PlaylistTrack.kt

@@ -0,0 +1,62 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+import org.listenbrainz.android.model.AdditionalInfo
+import org.listenbrainz.android.model.MbidMapping
+import org.listenbrainz.android.model.Metadata
+import org.listenbrainz.android.model.TrackMetadata
+import org.listenbrainz.android.model.feed.FeedListenArtist
+
+data class PlaylistTrack(
+    @SerializedName("album")
+    val album: String? = null,
+    @SerializedName("creator")
+    val creator: String? = null,
+    @SerializedName("duration")
+    val duration: Int? = null,
+    @SerializedName("extension")
+    val extension: TrackExtension = TrackExtension(),
+    @SerializedName("identifier")
+    val identifier: List<String> = listOf(),
+    @SerializedName("title")
+    val title: String? = null
+){
+    fun toMetadata(): Metadata{
+        val artistMBID = extension.trackExtensionData.additionalMetadata.artists.map{it.artistMbid?:""}
+        val artist = extension.trackExtensionData.additionalMetadata.artists
+        val data = Metadata(
+            trackMetadata = TrackMetadata(
+                artistName = creator?:"",
+                releaseName = album,
+                trackName = title?:"",
+                mbidMapping = MbidMapping(
+                    artistMbids = artistMBID,
+                    artists = artist.map {
+                        FeedListenArtist(
+                            it.artistCreditName?:"",
+                            it.artistMbid,
+                            it.joinPhrase
+                        )
+                    },
+                    recordingMbid = getRecordingMBID(),
+                    recordingName = title?:""
+                ),
+                additionalInfo = AdditionalInfo(
+                    artistMbids = artistMBID,
+                    artistNames = artist.map { it.artistCreditName?:"" },
+                    durationMs = duration?:0,
+                    recordingMbid = getRecordingMBID(),
+                )
+            )
+        )
+        return data
+    }
+
+    fun getRecordingMBID(): String?{
+        val url = identifier.firstOrNull()
+        val regex = """recording/([a-f0-9\-]+)""".toRegex()
+        val matchResult = url?.let { regex.find(it) }
+        return matchResult?.groupValues?.get(1)
+    }
+}

app/src/main/java/org/listenbrainz/android/model/playlist/TrackExtension.kt

@@ -0,0 +1,9 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class TrackExtension(
+    @SerializedName("https://musicbrainz.org/doc/jspf#track")
+    val trackExtensionData: TrackExtensionData = TrackExtensionData()
+)

app/src/main/java/org/listenbrainz/android/model/playlist/TrackExtensionData.kt

@@ -0,0 +1,15 @@
+package org.listenbrainz.android.model.playlist
+
+
+import com.google.gson.annotations.SerializedName
+
+data class TrackExtensionData(
+    @SerializedName("added_at")
+    val addedAt: String? = null,
+    @SerializedName("added_by")
+    val addedBy: String? = null,
+    @SerializedName("additional_metadata")
+    val additionalMetadata: AdditionalMetadataTrack = AdditionalMetadataTrack(),
+    @SerializedName("artist_identifiers")
+    val artistIdentifiers: List<String> = listOf()
+)

app/src/main/java/org/listenbrainz/android/repository/playlists/PlaylistDataRepository.kt

@@ -0,0 +1,14 @@
+package org.listenbrainz.android.repository.playlists
+
+import org.listenbrainz.android.model.playlist.CopyPlaylistResponse
+import org.listenbrainz.android.model.playlist.PlaylistPayload
+import org.listenbrainz.android.util.Resource
+
+interface PlaylistDataRepository {
+
+    // Fetches the playlist with tracks for the given MBID
+    suspend fun fetchPlaylist(playlistMbid: String?): Resource<PlaylistPayload?>
+
+    //Duplicates the playlist with the given MBID and returns the new playlist MBID
+    suspend fun copyPlaylist(playlistMbid: String?): Resource<CopyPlaylistResponse?>
+}