swingmusic/server/app/db/playlists.py

"""
This file contains the Playlists class for interacting with the playlist documents in MongoDB.
"""

from app import db, models
from bson import ObjectId

convert_many = db.convert_many
convert_one = db.convert_one


class Playlists(db.Mongo):
    """
    The class for all playlist-related database operations.
    """

    def __init__(self):
        super(Playlists, self).__init__("PLAYLISTS")
        self.collection = self.db["PLAYLISTS"]

    def insert_playlist(self, playlist: dict) -> None:
        """
        Inserts a new playlist object into the database.
        """
        return self.collection.update_one(
            {"name": playlist["name"]},
            {"$set": playlist},
            upsert=True,
        ).upserted_id

    def get_all_playlists(self) -> list:
        """
        Returns all the playlists in the database.
        """
        playlists = self.collection.find()
        return convert_many(playlists)

    def get_playlist_by_id(self, id: str) -> dict:
        """
        Returns a single playlist matching the id in the query params.
        """
        playlist = self.collection.find_one({"_id": ObjectId(id)})
        return convert_one(playlist)

    def add_track_to_playlist(self, playlistid: str, track: dict) -> None:
        """
        Adds a track to a playlist.
        """

        return self.collection.update_one(
            {"_id": ObjectId(playlistid)},
            {"$push": {"pre_tracks": track}},
        )

    def get_playlist_by_name(self, name: str) -> dict:
        """
        Returns a single playlist matching the name in the query params.
        """
        playlist = self.collection.find_one({"name": name})
        return convert_one(playlist)