Add Spotify OAuth support and autotagger integration #3123

rhlahuja · 2019-01-20T02:20:06Z

Addressing #2694, I've added OAuth support for the Spotify plugin using Client Credentials Flow. This requires a registered application and Client ID/Secret to be provided via client_id and client_secret under the spotify options in config.yaml.

I've also started working on adding Spotify support for the importer (incomplete album_for_id and track_for_id funcs included in this PR with some logic copied from the Discogs plugin), since I've come across more than a few releases that don't exist in MusicBrainz/Discogs/Beatport/Bandcamp but do in Spotify. However, I realize that the Spotify API doesn't provide certain fields like album media, catalognum, etc. like these other beets sources do. So, @sampsyo, do you think it's still worth extending the autotagger with Spotify matches, despite offering incomplete metadata?

sampsyo · 2019-01-20T03:59:17Z

Awesome; this is a great start!

We can register for a proper API key. For the tests, however, we should avoid needing to communicate with the actual Spotify API server—instead, the tests should mock the API’s responses so they can be run even without a connection to the Internet.

rhlahuja · 2019-01-20T04:24:41Z

Ah of course! I forgot to adjust the tests but will soon. Thanks for this awesome piece of software, by the way!

…

On Sat, Jan 19, 2019, 7:59 PM Adrian Sampson ***@***.***> wrote: Awesome; this is a great start! We can register for a proper API key. For the tests, however, we should avoid needing to communicate with the actual Spotify API server—instead, the tests should mock the API’s responses so they can be run even without a connection to the Internet. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3123 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFIKbah2bRbW_88-8Xmpu1QRmvXy8aXOks5vE-megaJpZM4aJbo6> .

sampsyo

Very nice! This is looking good. I had only a couple of small style comments after a review. Could you please also look into documenting the new functionality for the plugin?

beetsplug/spotify.py

rhlahuja · 2019-01-20T20:48:11Z

I've added some documentation to spotify.rst regarding the new functionality, and happy to add more if necessary.

One thing I'm not quite sure about is the proper implementation of the album_distance and track_distance functions. For now, I've simply copied these from the Beatport plugin, but let me know if we need to add anything else. I've also specified the Spotify ID for AlbumInfo.album_id and TrackInfo.track_id values which I think is correct behavior, but would like to confirm.

Thanks again for the swift replies all your work on this awesome project!

Edit: typo

sampsyo

Nice! I have just a few writing suggestions for improving the docs. Other than this, do you think this is ready to merge?

sampsyo · 2019-01-20T22:13:17Z

docs/plugins/spotify.rst

@@ -67,10 +106,20 @@ in config.yaml under the ``spotify:`` section:
  track/album/artist fields before sending them to Spotify.  Can be useful for
  changing certain abbreviations, like ft. -> feat.  See the examples below.
  Default: None.
+- **tokenfile**: Filename of the JSON file stored in the beets configuration
+  directory to use for caching the OAuth access token.
+  Default: ``spotify_token.json``.


Hmm… perhaps we shouldn't even mention this option in the docs. I don't expect anyone will ever need to change it, and omitting the unnecessary options should make the docs page a little easier to read. (FWIW, we don't document tokenfile for the other OAuth-based plugins we have.)

sampsyo · 2019-01-20T22:14:00Z

docs/plugins/spotify.rst

+     * Back Seat Driver (Spirit Guide) -> Back Seat Driver (Spirit Guide) (source)
+     * 2AM                             -> 2AM (source)
+    [A]pply, More candidates, Skip, Use as-is, as Tracks, Group albums,
+    Enter search, enter Id, aBort, eDit, edit Candidates, plaY?


I'm not sure having the whole candidate display is necessary here. Maybe the just the first two lines would be enough to get the idea across?

docs/plugins/spotify.rst

sampsyo · 2019-01-20T22:17:04Z

docs/plugins/spotify.rst

+library with the ``beet spotify`` command. Using the `Spotify Search API`_,
+any tracks that can be matched with a Spotify ID are returned, and the
+results can be either pasted in to a playlist or opened directly in the
+Spotify app.


Here's a slightly more direct way to say this without the passive voice: "Also, the plugin can use the Spotify Search API to provide metadata matches for the importer."

This part of the doc is actually referring to the beet spotify command which lists Spotify URLs for existing library tracks, but good point about using the active voice. I've consolidated this with the portion below and it now reads:

The spotify plugin generates Spotify playlists from tracks in your
library with the beet spotify command using the Spotify Search API.
Also, the plugin can use the Spotify Album and Track APIs to provide
metadata matches for the importer.

Not sure if we even need to specifically mention that we're using the Search/Album/Track APIs, I can remove that if not.

sampsyo · 2019-01-20T22:18:01Z

docs/plugins/spotify.rst

+
+Spotify URLs and IDs may also be provided to the ``Enter release ID:`` prompt
+during ``beet import`` to autotag music with data from the Spotify
+`Album`_ and `Track`_ APIs.


We can probably get away without mentioning this here—the "search by ID" functionality is a standard part of any plugin that extends the importer with a metadata backend, so the above description (and the detail below) probably covers this just fine.

rhlahuja · 2019-01-20T22:59:34Z

This should be ready to merge assuming album_distance and track_distance are fine as-is. I've also addressed an edge case with TrackInfo.index not being set if only a single track is being looked up / imported (need to query the Album API and enumerate through tracks to find its position on the entire release, since the Track API only provides medium_index).

rhlahuja · 2019-01-20T23:16:42Z

Actually, I should also add some logic to populate TrackInfo.medium_total. Let's hold off on merging until I can get to that later today.

sampsyo · 2019-01-21T02:49:49Z

Looking good! Just one last thing: do you want to include that API key in the default configuration? If so, perhaps we should mention that it's actually optional to register for your own Spotify app; you can just use the included key unless you really want to change it. If not, then maybe we should not provide a default to force people to register with Spotify themselves.

rhlahuja · 2019-01-21T08:54:06Z

Yea, that client ID/secret isn't actually valid (just randomly generated strings), so I agree we should either register a dedicated Spotify app and include those creds or remove them entirely and force people to register one themselves. I noticed the Discogs plugin sets a default client ID/secret which I'm assuming is for a dedicated app, so it seems like that's the preferred approach? Not sure if we would run into issues with rate limiting or anything else with many users sharing the same app. Which option do you prefer?

sampsyo · 2019-01-21T13:52:36Z

Sounds good. Let's start by offering an "official" app key and revisit (i.e., reset the key and force people to register for their own apps) if it becomes a problem. Here are credentials for an app I just registered:

client ID: 4e414367a1d14c75a5c5129a627fcab8
client secret: f82bdc09b2254f1a8286815d02fd46dc

rhlahuja · 2019-01-21T16:39:25Z

Awesome, I changed the default to those and removed all mentions of the Spotify app from the docs (or should we still include that it's optional?). This should be ready to merge now if everything else looks good.

sampsyo · 2019-01-21T20:10:18Z

Looks perfect! I'll merge this now.

Add Spotify OAuth support and autotagger integration

rhlahuja added 7 commits January 19, 2019 18:06

Update spotify.py

204a145

black -S -l 79 autoformat

8231973

unregister import_begin listener

1a9f20e

remove unused import

3639971

b64encode with bytes

160d66d

try b64 encode/decode

8bdd927

address py3 compatibility later

c1cb7a2

rhlahuja added 13 commits January 19, 2019 22:55

resolve python2/3 bytes/str incompatibilities, simplify authentication

e6c8f79

try oauth token mock

dc77943

appease Flake8

337cf2a

revert unnecessary double --> single quotes

104f618

better naming, documentation

3309c55

add docstrings, separate TrackInfo generation

e95b8a6

support album autotagging

91b2e33

modularize Spotify ID parsing

60c9201

better naming, formatting

9a30000

fix test, document Spotify ID

b95eaa8

add more docstrings

02aa79a

use open.spotify.com URL for data_url

bb1ed67

copy album_distance, track_distance from Beatport plugin

695dbfa

sampsyo reviewed Jan 20, 2019

View reviewed changes

beetsplug/spotify.py Outdated Show resolved Hide resolved

beetsplug/spotify.py Outdated Show resolved Hide resolved

beetsplug/spotify.py Outdated Show resolved Hide resolved

rhlahuja added 2 commits January 20, 2019 11:24

fix formatting

287c767

document new functionality, use Spotify ID for AlbumInfo.album_id

082357b

remove unused doc

2da738b

rhlahuja changed the title ~~Add Spotify OAuth support~~ Add Spotify OAuth support and autotagger integration Jan 20, 2019

rhlahuja added 2 commits January 20, 2019 12:55

doc wording/formatting

645c053

doc wording

7b1e64a

sampsyo reviewed Jan 20, 2019

View reviewed changes

remove tokenfile doc, use active voice

f61aacf

rhlahuja added 3 commits January 20, 2019 15:00

set TrackInfo.index in track_for_id

b4d54b0

doc typo

78a46fd

add TrackInfo.medium

dbf17f7

capture TrackInfo.medium_total

844b940

rhlahuja added 2 commits January 21, 2019 01:30

fix var reference, add docstring

415b21c

naming

cb8b087

use official client ID/secret, remove usage from docs

b50e148

inline auth_header property

dab62f2

sampsyo merged commit dab62f2 into beetbox:master Jan 21, 2019

sampsyo added a commit that referenced this pull request Jan 21, 2019

Merge pull request #3123 from rhlahuja/spotify-oauth

1a14c85

Add Spotify OAuth support and autotagger integration

sampsyo added a commit that referenced this pull request Jan 21, 2019

Changelog for #3123

10083c6

rhlahuja mentioned this pull request Jan 22, 2019

Add Spotify candidates and item_candidates #3125

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Spotify OAuth support and autotagger integration #3123

Add Spotify OAuth support and autotagger integration #3123

rhlahuja commented Jan 20, 2019 •

edited

Loading

sampsyo commented Jan 20, 2019

rhlahuja commented Jan 20, 2019 via email •

edited

Loading

sampsyo left a comment

rhlahuja commented Jan 20, 2019 •

edited

Loading

sampsyo left a comment

sampsyo Jan 20, 2019

sampsyo Jan 20, 2019

sampsyo Jan 20, 2019

rhlahuja Jan 20, 2019 •

edited

Loading

sampsyo Jan 20, 2019

rhlahuja commented Jan 20, 2019

rhlahuja commented Jan 20, 2019

sampsyo commented Jan 21, 2019

rhlahuja commented Jan 21, 2019

sampsyo commented Jan 21, 2019

rhlahuja commented Jan 21, 2019

sampsyo commented Jan 21, 2019

Add Spotify OAuth support and autotagger integration #3123

Add Spotify OAuth support and autotagger integration #3123

Conversation

rhlahuja commented Jan 20, 2019 • edited Loading

sampsyo commented Jan 20, 2019

rhlahuja commented Jan 20, 2019 via email • edited Loading

sampsyo left a comment

Choose a reason for hiding this comment

rhlahuja commented Jan 20, 2019 • edited Loading

sampsyo left a comment

Choose a reason for hiding this comment

sampsyo Jan 20, 2019

Choose a reason for hiding this comment

sampsyo Jan 20, 2019

Choose a reason for hiding this comment

sampsyo Jan 20, 2019

Choose a reason for hiding this comment

rhlahuja Jan 20, 2019 • edited Loading

Choose a reason for hiding this comment

sampsyo Jan 20, 2019

Choose a reason for hiding this comment

rhlahuja commented Jan 20, 2019

rhlahuja commented Jan 20, 2019

sampsyo commented Jan 21, 2019

rhlahuja commented Jan 21, 2019

sampsyo commented Jan 21, 2019

rhlahuja commented Jan 21, 2019

sampsyo commented Jan 21, 2019

rhlahuja commented Jan 20, 2019 •

edited

Loading

rhlahuja commented Jan 20, 2019 via email •

edited

Loading

rhlahuja commented Jan 20, 2019 •

edited

Loading

rhlahuja Jan 20, 2019 •

edited

Loading