yutipy 2.2.4__tar.gz → 2.2.6__tar.gz

{yutipy-2.2.4 → yutipy-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.2.4
+Version: 2.2.6
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>

{yutipy-2.2.4 → yutipy-2.2.6}/docs/api_reference.rst

@@ -132,12 +132,6 @@ Generic Exceptions
     :noindex:
     :exclude-members: add_note, args, with_traceback
 
-.. autoclass:: yutipy.exceptions.NetworkException
-    :members:
-    :inherited-members:
-    :noindex:
-    :exclude-members: add_note, args, with_traceback
-
 Service Exceptions
 ------------------
 

yutipy-2.2.6/tests/test_lastfm.py

@@ -0,0 +1,118 @@
+import pytest
+
+from yutipy.lastfm import LastFm
+from yutipy.models import UserPlaying
+from tests import BaseResponse
+
+
+@pytest.fixture
+def lastfm():
+    return LastFm(api_key="test_api_key")
+
+
+class MockResponseActivity(BaseResponse):
+    @staticmethod
+    def json():
+        return {
+            "recenttracks": {
+                "track": [
+                    {
+                        "artist": {"mbid": "", "#text": "Test Artist"},
+                        "image": [
+                            {
+                                "size": "small",
+                                "#text": "https://example.com/image/small.jpg",
+                            },
+                            {
+                                "size": "extralarge",
+                                "#text": "https://example.com/image/extralarge.jpg",
+                            },
+                        ],
+                        "mbid": "",
+                        "album": {
+                            "mbid": "",
+                            "#text": "Test Album",
+                        },
+                        "name": "Test Track",
+                        "@attr": {"nowplaying": True},
+                        "url": "https://www.last.fm/music/test+track",
+                    }
+                ]
+            }
+        }
+
+
+class MockResponseProfile(BaseResponse):
+    @staticmethod
+    def json():
+        return {
+            "user": {
+                "name": "john",
+                "realname": "Real John",
+                "image": [
+                    {
+                        "size": "small",
+                        "#text": "https://example.com/image/john",
+                    },
+                    {
+                        "size": "extralarge",
+                        "#text": "https://example.com/image/john",
+                    },
+                ],
+                "url": "https://example.com/john",
+                "type": "user",
+            }
+        }
+
+
+@pytest.fixture
+def mock_response_activity(lastfm, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return MockResponseActivity()
+
+    monkeypatch.setattr(lastfm._LastFm__session, "get", mock_get)
+
+
+@pytest.fixture
+def mock_response_profile(lastfm, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return MockResponseProfile()
+
+    monkeypatch.setattr(lastfm._LastFm__session, "get", mock_get)
+
+
+def test_get_currently_playing(lastfm, mock_response_activity):
+    username = "bob"
+    currently_playing = lastfm.get_currently_playing(username=username)
+    assert currently_playing is not None
+    assert isinstance(currently_playing, UserPlaying)
+    assert currently_playing.title == "Test Track"
+    assert currently_playing.album_title == "Test Album"
+    assert "extralarge" in currently_playing.album_art
+    assert currently_playing.is_playing is True
+
+
+def test_get_user_profile(lastfm, mock_response_profile):
+    username = "john"
+    profile = lastfm.get_user_profile(username=username)
+    assert profile is not None
+    assert profile["username"] == username
+    assert profile["name"] == "Real John"
+    assert profile["type"] == "user"
+
+
+def test_invalid_username(lastfm, monkeypatch):
+    def mock_get(*args, **kwargs):
+        class MockResponse(BaseResponse):
+            @staticmethod
+            def json():
+                return {"message": "User not found", "error": 6}
+
+        return MockResponse()
+
+    monkeypatch.setattr(lastfm._LastFm__session, "get", mock_get)
+
+    username = "alksdjfalsjdfweurppqoweiuwu"
+    profile = lastfm.get_user_profile(username=username)
+    assert profile is not None
+    assert "error" in profile

{yutipy-2.2.4 → yutipy-2.2.6}/yutipy/lastfm.py

@@ -2,6 +2,7 @@ __all__ = ["LastFm", "LastFmException"]
 
 import os
 from dataclasses import asdict
+from time import time
 from pprint import pprint
 from typing import Optional
 
@@ -73,6 +74,46 @@ class LastFm:
         """Checks if the session is closed."""
         return self._is_session_closed
 
+    def get_user_profile(self, username: str):
+        """
+        Fetches the user profile information for the provided username.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the user's profile information or error is username does not exist.
+        """
+        query = (
+            f"?method=user.getinfo&user={username}&api_key={self.api_key}&format=json"
+        )
+        query_url = self.__api_url + query
+
+        try:
+            response = self.__session.get(query_url, timeout=30)
+        except requests.RequestException as e:
+            logger.warning(f"Failed to fetch user profile: {e}")
+            return None
+
+        response_json = response.json()
+        result = response_json.get("user")
+        error = response_json.get("message")
+        if result:
+            images = [
+                {"size": image.get("size"), "url": image.get("#text")}
+                for image in result.get("image", [])
+            ]
+            return {
+                "name": result.get("realname"),
+                "username": result.get("name"),
+                "type": result.get("type"),
+                "url": result.get("url"),
+                "images": images,
+            }
+        elif error:
+            return {"error": error}
+        else:
+            return None
+
     def get_currently_playing(self, username: str) -> Optional[UserPlaying]:
         """
         Fetches information about the currently playing or most recent track for a user.
@@ -100,29 +141,34 @@ class LastFm:
 
         response_json = response.json()
         result = response_json.get("recenttracks", {}).get("track", [])[0]
-        album_art = [
-            img.get("#text")
-            for img in result.get("image", [])
-            if img.get("size") == "extralarge"
-        ]
-        return UserPlaying(
-            album_art="".join(album_art),
-            album_title=result.get("album", {}).get("#text"),
-            artists=", ".join(separate_artists(result.get("artist", {}).get("#text"))),
-            id=result.get("mbid"),
-            timestamp=result.get("date", {}).get("uts"),
-            title=result.get("name"),
-            url=result.get("url"),
-            is_playing=result.get("@attr", {}).get("nowplaying", False),
-        )
+        is_playing = result.get("@attr", {}).get("nowplaying", False)
+        if result and is_playing:
+            album_art = [
+                img.get("#text")
+                for img in result.get("image", [])
+                if img.get("size") == "extralarge"
+            ]
+            return UserPlaying(
+                album_art="".join(album_art),
+                album_title=result.get("album", {}).get("#text"),
+                artists=", ".join(
+                    separate_artists(result.get("artist", {}).get("#text"))
+                ),
+                id=result.get("mbid"),
+                timestamp=result.get("date", {}).get("uts") or time(),
+                title=result.get("name"),
+                url=result.get("url"),
+                is_playing=is_playing,
+            )
+        return None
 
 
 if __name__ == "__main__":
     with LastFm() as lastfm:
         username = input("Enter Lasfm Username: ").strip()
-        result = lastfm.get_currently_playing(username=username, limit=5)
+        result = lastfm.get_user_profile(username=username)
 
         if result:
-            pprint(asdict(result))
+            pprint(result)
         else:
             print("No result was found. Make sure the username is correct!")

{yutipy-2.2.4 → yutipy-2.2.6}/yutipy/spotify.py

@@ -196,8 +196,9 @@ class Spotify:
             logger.debug(f"Authentication response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.warning(f"Network error during Spotify authentication: {e}")
-            return None
+            raise requests.RequestException(
+                f"Network error during Spotify authentication: {e}"
+            )
 
         if response.status_code == 200:
             response_json = response.json()
@@ -210,6 +211,9 @@ class Spotify:
 
     def __refresh_access_token(self):
         """Refreshes the token if it has expired."""
+        if not self.__access_token:
+            raise SpotifyAuthException("No access token was found.")
+
         try:
             if time() - self.__token_requested_at >= self.__token_expires_in:
                 token_info = self.__get_access_token()
@@ -224,12 +228,16 @@ class Spotify:
                 self.__token_requested_at = token_info.get("requested_at")
 
             logger.info("The access token is still valid, no need to refresh.")
+        except (AuthenticationException, requests.RequestException) as e:
+            logger.warning(
+                f"Failed to refresh the access toke due to following error: {e}"
+            )
         except TypeError:
             logger.debug(
                 f"token requested at: {self.__token_requested_at} | token expires in: {self.__token_expires_in}"
             )
             logger.info(
-                "Something went wrong while trying to refresh the token. Set logging level to `DEBUG` to see the issue."
+                "Something went wrong while trying to refresh the access token. Set logging level to `DEBUG` to see the issue."
             )
 
     def save_access_token(self, token_info: dict) -> None:
@@ -341,6 +349,7 @@ class Spotify:
                 )
                 response.raise_for_status()
             except requests.RequestException as e:
+                logger.warning(f"Network error during Spotify search: {e}")
                 return None
 
             if response.status_code != 200:
@@ -408,6 +417,7 @@ class Spotify:
             )
             response.raise_for_status()
         except requests.RequestException as e:
+            logger.warning(f"Network error during Spotify search (advanced): {e}")
             return None
 
         if response.status_code != 200:
@@ -441,6 +451,7 @@ class Spotify:
                 )
                 response.raise_for_status()
             except requests.RequestException as e:
+                logger.warning(f"Network error during Spotify get artist ids: {e}")
                 return None
 
             if response.status_code != 200:
@@ -820,8 +831,9 @@ class SpotifyAuth:
             logger.debug(f"Authentication response status code: {response.status_code}")
             response.raise_for_status()
         except requests.RequestException as e:
-            logger.warning(f"Network error during Spotify authentication: {e}")
-            return None
+            raise requests.RequestException(
+                f"Network error during Spotify authentication: {e}"
+            )
 
         if response.status_code == 200:
             response_json = response.json()
@@ -837,20 +849,30 @@ class SpotifyAuth:
         if not self.__access_token:
             raise SpotifyAuthException("No access token was found.")
 
-        if time() - self.__token_requested_at >= self.__token_expires_in:
-            token_info = self.__get_access_token(refresh_token=self.__refresh_token)
+        try:
+            if time() - self.__token_requested_at >= self.__token_expires_in:
+                token_info = self.__get_access_token(refresh_token=self.__refresh_token)
 
-            try:
-                self.save_access_token(token_info)
-            except NotImplementedError as e:
-                logger.warning(e)
+                try:
+                    self.save_access_token(token_info)
+                except NotImplementedError as e:
+                    logger.warning(e)
 
-            self.__access_token = token_info.get("access_token")
-            self.__refresh_token = token_info.get("refresh_token")
-            self.__token_expires_in = token_info.get("expires_in")
-            self.__token_requested_at = token_info.get("requested_at")
+                self.__access_token = token_info.get("access_token")
+                self.__refresh_token = token_info.get("refresh_token")
+                self.__token_expires_in = token_info.get("expires_in")
+                self.__token_requested_at = token_info.get("requested_at")
 
-        logger.info("The access token is still valid, no need to refresh.")
+            logger.info("The access token is still valid, no need to refresh.")
+        except (AuthenticationException, requests.RequestException) as e:
+            logger.warning(f"Failed to refresh the access toke due to following error: {e}")
+        except TypeError:
+            logger.debug(
+                f"token requested at: {self.__token_requested_at} | token expires in: {self.__token_expires_in}"
+            )
+            logger.warning(
+                "Something went wrong while trying to refresh the access token. Set logging level to `DEBUG` to see the issue."
+            )
 
     @staticmethod
     def generate_state() -> str:
@@ -1028,7 +1050,7 @@ class SpotifyAuth:
         except NotImplementedError as e:
             logger.warning(e)
 
-    def get_user_profile(self):
+    def get_user_profile(self) -> Optional[dict]:
         """
         Fetches the user's display name and profile images.
 
@@ -1063,10 +1085,11 @@ class SpotifyAuth:
             logger.warning(f"Unexpected response: {response.json()}")
             return None
 
-        response_json = response.json()
+        result = response.json()
         return {
-            "display_name": response_json.get("display_name"),
-            "images": response_json.get("images", []),
+            "display_name": result.get("display_name"),
+            "images": result.get("images", []),
+            "url": result.get("external_urls", {}).get("spotify")
         }
 
     def get_currently_playing(self) -> Optional[UserPlaying]:
@@ -1105,6 +1128,7 @@ class SpotifyAuth:
             response = self.__session.get(query_url, headers=header, timeout=30)
             response.raise_for_status()
         except requests.RequestException as e:
+            logger.warning(f"Error while getting Spotify user activity: {e}")
             return None
 
         if response.status_code == 204:

{yutipy-2.2.4 → yutipy-2.2.6}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.2.4
+Version: 2.2.6
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>

yutipy-2.2.4/tests/test_lastfm.py

@@ -1,60 +0,0 @@
-import pytest
-
-from yutipy.lastfm import LastFm
-from yutipy.models import UserPlaying
-from tests import BaseResponse
-
-
-@pytest.fixture
-def lastfm():
-    return LastFm(api_key="test_api_key")
-
-
-class MockResponse(BaseResponse):
-    @staticmethod
-    def json():
-        return {
-            "recenttracks": {
-                "track": [
-                    {
-                        "artist": {"mbid": "", "#text": "Test Artist"},
-                        "image": [
-                            {
-                                "size": "small",
-                                "#text": "https://example.com/image/small.jpg",
-                            },
-                            {
-                                "size": "extralarge",
-                                "#text": "https://example.com/image/extralarge.jpg",
-                            },
-                        ],
-                        "mbid": "",
-                        "album": {
-                            "mbid": "",
-                            "#text": "Test Album",
-                        },
-                        "name": "Test Track",
-                        "url": "https://www.last.fm/music/test+track",
-                    }
-                ]
-            }
-        }
-
-
-@pytest.fixture
-def mock_response(lastfm, monkeypatch):
-    def mock_get(*args, **kwargs):
-        return MockResponse()
-
-    monkeypatch.setattr(lastfm._LastFm__session, "get", mock_get)
-
-
-def test_get_currently_playing(lastfm, mock_response):
-    username = "bob"
-    currently_playing = lastfm.get_currently_playing(username=username)
-    assert currently_playing is not None
-    assert isinstance(currently_playing, UserPlaying)
-    assert currently_playing.title == "Test Track"
-    assert currently_playing.album_title == "Test Album"
-    assert "extralarge" in currently_playing.album_art
-    assert currently_playing.is_playing is False