Search, view tracks websocket endpoints, service to like media. #489

mikevanes · 2024-11-28T13:00:22Z

~~Adds a generic get method which can call any method on the Spotify API. Used to retrieve views in the Spotify card. This abuses the Spotipy _get method.~~

~~Please have a look at the one comment I made which from my point of view is strange behavior.~~

Doesn't make use of the build in pager as this would require significant refactoring of that method and is imo for now not worth it. I see it as very unlikely that someone would need more than 50playlists displayed.

EDIT

This branch was largely refactored. It adds multiple websocket endpoints:

liked_media_handler =>to retrieve all liked songs of a user.
search_handler => to search a playlist, track etc.
view_handler => to retrieve a view, e.g. recently-played
tracks_handler => retrieves a list of tracks from a playlist

Also adds an service to like a song.

fcusson · 2024-11-28T16:23:21Z

@mikevanes keep up the good work on your PR, but with the changes I'll have to implement to get the account properly working using both the Public and Private APIs I'll have a lot of refactor to do. Keep working from the dev branch, I'll work from a feature branch and I'll integrate your changes cleanly in the new architecture (I might actually do a full rewrite of the Spotify Account class. There are some drawbacks I see from the original implementation. I want to move to DataCoordinators and also I see a lot of code repeat I can probably remove.

…ic_get_ws

fcusson · 2024-11-28T13:41:30Z

custom_components/spotcast/spotify/account.py

+            locale=locale,
+            platform=platform,
+            types=types,
+            limit=limit,


use the _async_pager for anything relying on offset and limits

I used the pager but see if you agree on the solution. This was the only way I saw it would work.

fcusson · 2024-11-29T14:01:37Z

custom_components/spotcast/spotify/account.py

@@ -952,6 +948,36 @@ async def async_generic_playlists(
        return await self.hass.async_add_executor_job(
            partial(self._internal_cont._get, url, None, **params)
        )
+
+    async def async_search(


THere is already an async_search method. This method is generalised for any type of search. But you would have to build a SearchQuery object to utilize it

fcusson · 2024-11-29T14:06:30Z

Hi @mikevanes, just saw you added (or overwritten) a async_search function. The current impolementation is supposed to be generic and should already suite the use case you seem to be trying to implement.

If you have any issue with the current async_search, please let discuss, because I don't want it to remove functionality from the play_from_search service.

If you need help understanding how it works and how to build a valid SearchQuery to send to the function, I can also help you with that

fcusson · 2024-11-29T14:45:37Z

@mikevanes. Converted to draft to not receive notification on each push. Please move to ready for review when you are

mikevanes · 2024-11-29T14:48:36Z

@fcusson im sorry for spamming you :) I hadn’t seen the generic search function, I’ll use that tomorrow doesn't seem that difficult, but I am no python developer.

The async pager won’t work I’m afraid for the view method as the _get method which is called for a completely different signature from all the other spotipy methods. Or atleast I couldn't figure out how to get that working.

fcusson · 2024-11-29T14:58:16Z

@mikevanes no stress, wouldn't call it spam.

Can you send me an example reply. I'll see if there is a way to make it work in the pager

mikevanes · 2024-11-30T12:18:38Z

@fcusson I fixed the comments you mentioned, please see if you agree on my solution for the pager in the view method. In the code I explained why I did it this way. For now this PR is done for me.

custom_components/spotcast/spotify/account.py

fcusson · 2024-11-30T12:35:17Z

@mikevanes seems, good, I requested a small change, this is to make it simpler to unit test the code.

Also, I want to ensure I maintain 100% coverage of the code with test. I will need some unit-test on the functions. Either you can look at writing them, or please provide examples of responses for different use cases so that I can create test on them.

Feature/generic get ws

mikevanes · 2024-12-12T08:25:04Z

@fcusson I have added the documentation for all endpoints. If it is easy to do, it would be nice to have a sensor in HA that provides the current song with id, name and icon uri.

fcusson

Added some small change to harmonize documentation. I'll take care of the issues with hassfest. I'll send a new pr to your fork

custom_components/spotcast/spotify/account.py

fcusson · 2024-12-12T11:05:56Z

docs/services/like_media.md

+        - spotify:track:2dbJ0mn0vTVz6mc3rk2t77
+    account: 01JDG07KSBTYWZGJSBJ1EW6XEF
+```
+### `spotify_uris` (list of str)


ensure blank space between sections

use python style type definition list[str]

fcusson · 2024-12-12T11:08:22Z

docs/websocket/search.md

+
+The result of the transaction.
+
+#### `total` (int)


Add quote style indentation for sub level definition see raw account doc for example

fcusson · 2024-12-12T11:10:13Z

docs/websocket/tracks.md

+{
+    "id": 15,
+    "type": "spotcast/tracks",
+    "playlist_id": "37i9dQZF1DXcBWIGoYBM5M" or "spotify:playlist:37i9dQZF1DXcBWIGoYBM5M",


only show one consistent example. I would prefer we show example with uri. The definition of playlist_id is sufficient to provide the rest

fcusson · 2024-12-12T11:10:46Z

docs/websocket/tracks.md

+
+The result of the transaction.
+
+#### `total` (int)


add quote indentation

fcusson · 2024-12-12T11:10:56Z

docs/websocket/liked_media.md

+
+The result of the transaction.
+
+#### `total` (int)


add quote indentation

…lows

fcusson · 2024-12-12T12:17:46Z

fixed Hassfest fails. Should be good to go, but I had to bump the minimal version to 2024.12 due to a change in the options flow

mikevanes · 2024-12-14T09:25:49Z

@fcusson The documentation should be fixed now. You can merge your branch as far as I am concerned

fcusson · 2024-12-14T13:01:36Z

@mikevanes can you please approve my pr on your fork. We'll need it to pass validation

Feature/generic get ws

fcusson · 2024-12-14T13:57:55Z

will deal with test failing in dev

Mike van Es added 3 commits November 28, 2024 13:59

Adds a generic get method

fbc89e9

Adds a generic get method. Which abuses the _get method of spotipy

86beb1e

Add missing import

6ee3bcc

mikevanes marked this pull request as ready for review November 28, 2024 15:51

Mike van Es added 8 commits November 29, 2024 13:30

Generic get => view_handler, adds a search endpoint

c39a817

Merge branch 'dev' of https://github.com/fondberg/spotcast into gener…

2bc9eb8

…ic_get_ws

Fix syntax

df4727a

Fix url

891eb4a

Fix mistakes

5f7decc

Add account in search handler

3dbd616

Remove locale in search

de2ff8f

song => track

104848f

mikevanes changed the title ~~Adds a generic get method~~ Adds a search and a view endpoints to the websocket. Nov 29, 2024

fcusson requested changes Nov 29, 2024

View reviewed changes

Add HREF to search result.

adfe849

fcusson marked this pull request as draft November 29, 2024 14:45

mikevanes marked this pull request as ready for review November 29, 2024 15:18

mikevanes marked this pull request as draft November 29, 2024 15:22

Mike van Es added 3 commits November 30, 2024 13:08

Use already existing search method. Added comments as explanation

5cb754c

Remove unused partial import

c91a8ee

Align search with new return time.

9855836

mikevanes marked this pull request as ready for review November 30, 2024 12:18

fcusson requested changes Nov 30, 2024

View reviewed changes

custom_components/spotcast/spotify/account.py Outdated Show resolved Hide resolved

added service definition

55cf26d

fcusson mentioned this pull request Dec 11, 2024

Spotcast v5 playlist styles #485

Closed

Mike van Es added 2 commits December 11, 2024 15:05

Merge pull request #1 from fcusson/feature/generic_get_ws

73f8e8f

Feature/generic get ws

Adds documentation

acac78e

mikevanes marked this pull request as ready for review December 12, 2024 08:25

mikevanes changed the title ~~Adds a search and a view endpoints to the websocket.~~ Search, view tracks websocket endpoints, service to like media. Dec 12, 2024

fcusson requested changes Dec 12, 2024

View reviewed changes

fcusson added 13 commits December 12, 2024 06:15

typo

39a8be6

moved config and option flow to config_flow.py for hassfest validation

1b79898

tweaked github actions

1ff1a9e

typo

78d4ce7

reorg selector strings to fit documentation

3494ddf

fixed issue with selector definition

c82db7f

fixed config flow and options flow test with new python module structure

9cb29ce

added pylint to dev requirements

d475bb7

fixed option flow for HASS2024.12

335c33e

bumped minimal version due to breaking change in 2024.12 for option f…

e8f66e0

…lows

added pythonpath to linter definition

f9fd6c3

moved location of pythonpath definition

74fa79f

typo

097d39d

Fix documentation

d85a0d3

mikevanes requested a review from fcusson December 14, 2024 09:25

Merge pull request #2 from fcusson/feature/generic_get_ws

f3f6407

Feature/generic get ws

fcusson approved these changes Dec 14, 2024

View reviewed changes

fcusson merged commit b9c19df into fondberg:dev Dec 14, 2024
2 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search, view tracks websocket endpoints, service to like media. #489

Search, view tracks websocket endpoints, service to like media. #489

mikevanes commented Nov 28, 2024 •

edited

Loading

fcusson commented Nov 28, 2024

fcusson Nov 28, 2024

mikevanes Nov 30, 2024

fcusson Nov 29, 2024

mikevanes Nov 30, 2024

fcusson commented Nov 29, 2024

fcusson commented Nov 29, 2024

mikevanes commented Nov 29, 2024 •

edited

Loading

fcusson commented Nov 29, 2024

mikevanes commented Nov 30, 2024

fcusson commented Nov 30, 2024

mikevanes commented Dec 12, 2024

fcusson left a comment

fcusson Dec 12, 2024

fcusson Dec 12, 2024

fcusson Dec 12, 2024

fcusson Dec 12, 2024

fcusson Dec 12, 2024

fcusson commented Dec 12, 2024

mikevanes commented Dec 14, 2024 •

edited

Loading

fcusson commented Dec 14, 2024

fcusson commented Dec 14, 2024

Search, view tracks websocket endpoints, service to like media. #489

Search, view tracks websocket endpoints, service to like media. #489

Conversation

mikevanes commented Nov 28, 2024 • edited Loading

EDIT

fcusson commented Nov 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fcusson commented Nov 29, 2024

fcusson commented Nov 29, 2024

mikevanes commented Nov 29, 2024 • edited Loading

fcusson commented Nov 29, 2024

mikevanes commented Nov 30, 2024

fcusson commented Nov 30, 2024

mikevanes commented Dec 12, 2024

fcusson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fcusson commented Dec 12, 2024

mikevanes commented Dec 14, 2024 • edited Loading

fcusson commented Dec 14, 2024

fcusson commented Dec 14, 2024

mikevanes commented Nov 28, 2024 •

edited

Loading

mikevanes commented Nov 29, 2024 •

edited

Loading

mikevanes commented Dec 14, 2024 •

edited

Loading