yutipy 1.5.1__tar.gz → 1.6.1__tar.gz

{yutipy-1.5.1 → yutipy-1.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 1.5.1
+Version: 1.6.1
 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-1.5.1 → yutipy-1.6.1}/docs/api_reference.rst

@@ -41,6 +41,12 @@ Spotify
     :noindex:
     :exclude-members: is_session_closed
 
+.. autoclass:: yutipy.spotify.SpotifyAuth
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: is_session_closed
+
 YouTube Music
 -------------
 

{yutipy-1.5.1 → yutipy-1.6.1}/docs/usage_examples.rst

@@ -73,7 +73,11 @@ Alternatively, you can manually provide these values when creating an object of
 Spotify
 -------
 
-To use the Spotify API, you need to set the ``SPOTIFY_CLIENT_ID`` and ``SPOTIFY_CLIENT_SECRET`` for Spotify. You can do this by creating a ``.env`` file in the root directory of your project with the following content:
+Client Credentials Grant Type
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To use the Spotify API with Client Credentials flow, you need to set the ``SPOTIFY_CLIENT_ID`` and ``SPOTIFY_CLIENT_SECRET`` for Spotify.
+You can do this by creating a ``.env`` file in the root directory of your project with the following content:
 
 .. admonition:: .env
 
@@ -82,7 +86,7 @@ To use the Spotify API, you need to set the ``SPOTIFY_CLIENT_ID`` and ``SPOTIFY_
         SPOTIFY_CLIENT_ID=<your_spotify_client_id>
         SPOTIFY_CLIENT_SECRET=<your_spotify_client_secret>
 
-Alternatively, you can manually provide these values when creating an object of the `Spotify` class:
+Alternatively, you can manually provide these values when creating an object of the ``Spotify`` class:
 
 .. code-block:: python
 
@@ -109,6 +113,89 @@ OR, if you have the ":abbr:`ISRC (International Standard Recording Code)`" or ":
         result = spotify.search_advanced("Artist Name", "Song Title", isrc="USAT29900609", upc="00602517078194")
         print(result)
 
+Authorization Code Flow
+~~~~~~~~~~~~~~~~~~~~~~~
+
+To use the Spotify API with the Authorization Code Flow, you need to set the ``SPOTIFY_CLIENT_ID``, ``SPOTIFY_CLIENT_SECRET``, and ``SPOTIFY_REDIRECT_URI``.
+You can do this by creating a ``.env`` file in the root directory of your project with the following content:
+
+.. admonition:: .env
+
+    .. code-block:: bash
+
+        SPOTIFY_CLIENT_ID=<your_spotify_client_id>
+        SPOTIFY_CLIENT_SECRET=<your_spotify_client_secret>
+        SPOTIFY_REDIRECT_URI=<your_redirect_uri>
+
+Alternatively, you can manually provide these values when creating an object of the ``SpotifyAuth`` class.
+
+Here’s an example of how to use the ``SpotifyAuth`` class in a web application:
+
+.. code-block:: python
+
+    from flask import Flask, request, session, redirect, url_for
+    from yutipy.spotify import SpotifyAuth, SpotifyAuthException
+
+    app = Flask(__name__)
+    app.secret_key = "your_secret_key"  # Replace with a secure secret key
+
+    # Initialize SpotifyAuth with your credentials
+    SPOTIFY_CLIENT_ID = "your_spotify_client_id"
+    SPOTIFY_CLIENT_SECRET = "your_spotify_client_secret"
+    SPOTIFY_REDIRECT_URI = "http://localhost:5000/callback"
+
+    spotify_auth = SpotifyAuth(
+        client_id=SPOTIFY_CLIENT_ID,
+        client_secret=SPOTIFY_CLIENT_SECRET,
+        redirect_uri=SPOTIFY_REDIRECT_URI,
+        scopes=["user-read-email", "user-read-private"],
+    )
+
+    @app.route("/")
+    def home():
+        """Home route to start the authorization process."""
+        state = spotify_auth.generate_state()
+        session["state"] = state  # Save the state in the session for validation
+        auth_url = spotify_auth.get_authorization_url(state=state)
+        return redirect(auth_url)
+
+    @app.route("/callback")
+    def callback():
+        """Callback route to handle Spotify's response after user authorization."""
+        code = request.args.get("code")
+        state = request.args.get("state")
+        expected_state = session.get("state")
+
+        if not code or not state:
+            return "Authorization failed: Missing code or state.", 400
+
+        try:
+            spotify_auth.callback_handler(code, state, expected_state)
+            user_profile = spotify_auth.get_user_profile()
+            if user_profile:
+                return f"Successfully authenticated! Welcome, {user_profile['display_name']}."
+            else:
+                return "Authentication successful, but failed to fetch user profile."
+        except SpotifyAuthException as e:
+            return f"Authorization failed: {e}", 400
+
+    @app.route("/logout")
+    def logout():
+        """Logout route to close the session."""
+        spotify_auth.close_session()
+        session.clear()
+        return "Logged out successfully."
+
+    if __name__ == "__main__":
+        app.run(debug=True)
+
+.. note::
+
+    - Avoid hard-coding your credentials in the code. Instead, define them in a ``.env`` file, which will be automatically read by the library.
+    - Ensure that the redirect URI matches the one configured in your Spotify Developer Dashboard.
+    - This example uses Flask, but it can be adapted to other web frameworks as needed.
+
+
 YouTube Music
 -------------
 

yutipy-1.6.1/tests/test_spotify.py

@@ -0,0 +1,130 @@
+import pytest
+
+from yutipy.exceptions import SpotifyException
+from yutipy.models import MusicInfo
+from yutipy.spotify import Spotify, SpotifyAuth
+
+
+@pytest.fixture(scope="module")
+def spotify():
+    try:
+        return Spotify()
+    except SpotifyException:
+        pytest.skip("Spotify credentials not found")
+
+
+@pytest.fixture(scope="module")
+def spotify_auth():
+    return SpotifyAuth(
+        client_id="test_client_id",
+        client_secret="test_client_secret",
+        redirect_uri="http://localhost/callback",
+        scopes=["user-read-email", "user-read-private"],
+    )
+
+
+def test_search(spotify):
+    artist = "Adele"
+    song = "Hello"
+    result = spotify.search(artist, song)
+    assert result is not None
+    assert isinstance(result, MusicInfo)
+    assert result.title == song
+    assert artist in result.artists
+
+
+def test_search_advanced_with_isrc(spotify):
+    artist = "Adele"
+    song = "Hello"
+    isrc = "GBBKS1500214"
+    result = spotify.search_advanced(artist, song, isrc=isrc)
+    assert result is not None
+    assert result.isrc == isrc
+
+
+def test_search_advanced_with_upc(spotify):
+    artist = "Miles Davis"
+    album = "Kind Of Blue (Legacy Edition)"
+    upc = "888880696069"
+    result = spotify.search_advanced(artist, album, upc=upc)
+    print(result)
+    assert result is not None
+
+
+def test_get_artists_ids(spotify):
+    artist = "Adele"
+    artist_ids = spotify._get_artists_ids(artist)
+    assert isinstance(artist_ids, list)
+    assert len(artist_ids) > 0
+
+
+def test_close_session(spotify):
+    spotify.close_session()
+    assert spotify.is_session_closed
+
+
+def test_get_authorization_url(spotify_auth):
+    state = spotify_auth.generate_state()
+    auth_url = spotify_auth.get_authorization_url(state=state)
+    assert "https://accounts.spotify.com/authorize" in auth_url
+    assert "response_type=code" in auth_url
+    assert f"client_id={spotify_auth.client_id}" in auth_url
+
+
+def test_get_user_profile(spotify_auth, monkeypatch):
+    def mock_authorization_header():
+        return {"Authorization": "Bearer test_token"}
+
+    def mock_get(*args, **kwargs):
+        class MockResponse:
+            status_code = 200
+
+            @staticmethod
+            def raise_for_status():
+                pass  # Simulates a successful response with no exceptions raised
+
+            @staticmethod
+            def json():
+                return {
+                    "display_name": "Test User",
+                    "images": [
+                        {
+                            "url": "https://example.com/image.jpg",
+                            "height": 300,
+                            "width": 300,
+                        }
+                    ],
+                }
+
+        return MockResponse()
+
+    monkeypatch.setattr(
+        spotify_auth, "_SpotifyAuth__authorization_header", mock_authorization_header
+    )
+    monkeypatch.setattr(spotify_auth._SpotifyAuth__session, "get", mock_get)
+
+    user_profile = spotify_auth.get_user_profile()
+    assert user_profile is not None
+    assert user_profile["display_name"] == "Test User"
+    assert len(user_profile["images"]) == 1
+    assert user_profile["images"][0]["url"] == "https://example.com/image.jpg"
+
+
+def test_callback_handler(spotify_auth, monkeypatch):
+    def mock_get_access_token(*args, **kwargs):
+        return {
+            "access_token": "test_access_token",
+            "refresh_token": "test_refresh_token",
+            "expires_in": 3600,
+            "requested_at": 1234567890,
+        }
+
+    monkeypatch.setattr(
+        spotify_auth, "_SpotifyAuth__get_access_token", mock_get_access_token
+    )
+
+    spotify_auth.callback_handler("test_code", "test_state", "test_state")
+    assert spotify_auth._SpotifyAuth__access_token == "test_access_token"
+    assert spotify_auth._SpotifyAuth__refresh_token == "test_refresh_token"
+    assert spotify_auth._SpotifyAuth__token_expires_in == 3600
+    assert spotify_auth._SpotifyAuth__token_requested_at == 1234567890

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/__init__.py

@@ -3,6 +3,7 @@ from .itunes import Itunes
 from .kkbox import KKBox
 from .musicyt import MusicYT
 from .spotify import Spotify
+from .utils import disable_logging, enable_logging
 from .yutipy_music import YutipyMusic
 
 __all__ = [
@@ -12,4 +13,6 @@ __all__ = [
     "MusicYT",
     "Spotify",
     "YutipyMusic",
+    "enable_logging",
+    "disable_logging",
 ]

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/cli/search.py

@@ -14,7 +14,7 @@ from yutipy.itunes import Itunes
 from yutipy.kkbox import KKBox
 from yutipy.musicyt import MusicYT
 from yutipy.spotify import Spotify
-from yutipy.utils.logger import disable_logging, enable_logging
+from yutipy.logger import disable_logging, enable_logging
 from yutipy.yutipy_music import YutipyMusic
 
 

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/deezer.py

@@ -13,7 +13,7 @@ from yutipy.exceptions import (
 )
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
-from yutipy.utils.logger import logger
+from yutipy.logger import logger
 
 
 class Deezer:
@@ -323,7 +323,7 @@ class Deezer:
 
 if __name__ == "__main__":
     import logging
-    from yutipy.utils.logger import enable_logging
+    from yutipy.logger import enable_logging
 
     enable_logging(level=logging.DEBUG)
     deezer = Deezer()

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/exceptions.py

@@ -11,60 +11,44 @@ __all__ = [
 class YutipyException(Exception):
     """Base class for exceptions in the Yutipy package."""
 
-    pass
+
+# Generic Exceptions
+class AuthenticationException(YutipyException):
+    """Exception raised for authentication errors."""
+
+
+class InvalidResponseException(YutipyException):
+    """Exception raised for invalid responses from APIs."""
+
+
+class InvalidValueException(YutipyException):
+    """Exception raised for invalid values."""
+
+
+class NetworkException(YutipyException):
+    """Exception raised for network-related errors."""
 
 
 # Service Exceptions
 class DeezerException(YutipyException):
     """Exception raised for errors related to the Deezer API."""
 
-    pass
-
 
 class ItunesException(YutipyException):
     """Exception raised for errors related to the iTunes API."""
 
-    pass
-
 
 class KKBoxException(YutipyException):
     """Exception raised for erros related to the KKBOX Open API."""
 
-    pass
-
 
 class MusicYTException(YutipyException):
     """Exception raised for errors related to the YouTube Music API."""
 
-    pass
-
 
 class SpotifyException(YutipyException):
     """Exception raised for errors related to the Spotify API."""
 
-    pass
-
-
-# Generic Exceptions
-class AuthenticationException(YutipyException):
-    """Exception raised for authentication errors."""
-
-    pass
-
-
-class InvalidResponseException(YutipyException):
-    """Exception raised for invalid responses from APIs."""
-
-    pass
-
-
-class InvalidValueException(YutipyException):
-    """Exception raised for invalid values."""
-
-    pass
-
-
-class NetworkException(YutipyException):
-    """Exception raised for network-related errors."""
 
-    pass
+class SpotifyAuthException(AuthenticationException):
+    """Exception raised for Spotify authorization code grant type / flow"""

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/itunes.py

@@ -18,7 +18,7 @@ from yutipy.utils.helpers import (
     guess_album_type,
     is_valid_string,
 )
-from yutipy.utils.logger import logger
+from yutipy.logger import logger
 
 
 class Itunes:
@@ -228,7 +228,7 @@ class Itunes:
 
 if __name__ == "__main__":
     import logging
-    from yutipy.utils.logger import enable_logging
+    from yutipy.logger import enable_logging
 
     enable_logging(level=logging.DEBUG)
     itunes = Itunes()

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/kkbox.py

@@ -18,7 +18,7 @@ from yutipy.exceptions import (
 )
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
-from yutipy.utils.logger import logger
+from yutipy.logger import logger
 
 load_dotenv()
 
@@ -417,7 +417,7 @@ class KKBox:
 
 if __name__ == "__main__":
     import logging
-    from yutipy.utils.logger import enable_logging
+    from yutipy.logger import enable_logging
 
     enable_logging(level=logging.DEBUG)
     kkbox = KKBox(KKBOX_CLIENT_ID, KKBOX_CLIENT_SECRET)

{yutipy-1.5.1 → yutipy-1.6.1}/yutipy/musicyt.py

@@ -13,7 +13,7 @@ from yutipy.exceptions import (
 )
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
-from yutipy.utils.logger import logger
+from yutipy.logger import logger
 
 
 class MusicYT:
@@ -296,7 +296,7 @@ class MusicYT:
 if __name__ == "__main__":
     import logging
 
-    from yutipy.utils.logger import enable_logging
+    from yutipy.logger import enable_logging
 
     enable_logging(level=logging.DEBUG)
     music_yt = MusicYT()