Add 'expand' flag to the web plugin #2050

maxammann · 2016-06-13T12:12:45Z

Hello,

I'm currently developing an android app to synchronize your beets library with your android phone. This addition helps me to implement the query and simply some stuff.

There are some screenshots of my app attached.

jackwilsdon · 2016-06-13T12:15:36Z

beetsplug/web/__init__.py

@@ -55,7 +55,7 @@ def _rep(obj, expand=False):
        return out


-def json_generator(items, root):
+def json_generator(items, root, expand=False):


Do you think you could document the expand argument in the docstring too?

jackwilsdon · 2016-06-13T12:19:58Z

Looks like our flake8 test is failing due to some lines being more than 79 characters in length, but apart from that (and the comments I previously made) this looks great! Thanks! 🎉

jackwilsdon · 2016-06-13T12:22:18Z

beetsplug/web/__init__.py

    yield ']}'


+def is_expand(args):


Do we really need this method? It might be simpler to just do this:

return flask.jsonify(_rep(entities[0], expand=flask.request.args.get('expand')))

Not sure, if I remove the method I would need to use the "in" operator

return flask.jsonify(_rep(entities[0], expand='expand' in flask.request.args))

This would also cause duplicate code. What do you think?

Hmm, we'd be better with @sampsyo's opinion on this I think.

Here's how I'd (personally) write the method:

def is_expand(): """Returns whether the current request is for an expanded response.""" return flask.request.args.get('expand') is not None

We can directly access flask.request.args without passing it in, as it's a property of the flask module.

maxammann · 2016-06-13T12:42:51Z

Thanks, added the recommendations

maxammann · 2016-06-13T13:03:23Z

Is there a reson for line 40: del out['path']

The path variable would be very useful as I do not know the extension of the individual files and I'm not sure how the "format" tag is defined.

Thanks in advance!

jackwilsdon · 2016-06-13T13:05:12Z

Hmm, looks like that was added by @sampsyo in 8493909. Not entirely sure why it's there, maybe we'd be better not giving the "full" path but instead the path relative to the beets library?

maxammann · 2016-06-13T13:10:18Z

Oh yes, didn't notice that it returns the full path. How about replacing it with obj.destination(fragment=True) instead of deleting it?

EDIT: Going to open a new pull request soon

sampsyo · 2016-06-13T17:14:50Z

Cool! This looks like a great project. Is it open-source also?

In the future, I'd love to talk to you about basing this kind of thing on the new AURA API we're developing: /~https://github.com/beetbox/aura

This API, when we've got it implemented, will include native support for stuff like this via "includes," which will let clients request exactly what data they want in their response. It would be great to collaborate on this if you're interested.

maxammann · 2016-06-13T17:56:42Z

Yeah of course! FOSS FTW! :P
/~https://github.com/maxammann/music-cyclon (Still very bare repo whichi is being bootstrapped atm)

Started the rewrite a few days ago when I realized I could just integrate it directly into beets 😄
I also wanted to follow the material design guide lines.
Also a better api would be gold for music-cyclon as the unspecific requests are very slow and take a lot of time.

The synchronize part is the first milestone. I'm not sure yet whether streaming will be a thing or maybe remotly managing the library. For now synchronizing with poweramp integration is enough for me. Let me know what you think!

Looking forward to talk per chat or maybe even VOIP.

jackwilsdon · 2016-06-13T18:11:46Z

You could join the beets IRC channel on freenode 😄. You can join here: freenode webchat.

jackwilsdon · 2016-06-13T19:36:21Z

Wow @sampsyo, I can't believe I've never seen aura! It looks very fleshed out and well designed 😄. What's the long term plan for beets and aura? Create an aura plugin for beets?

sampsyo · 2016-06-13T23:22:01Z

Yeah, that's the plan! The hope is to start with a new beets plugin that fits the API and then work on other parts of the ecosystem.

ghost · 2016-06-18T10:42:01Z

docs/plugins/web.rst

@@ -197,6 +197,7 @@ The interface and response format is similar to the item API, except replacing
 the encapsulation key ``"items"`` with ``"albums"`` when requesting ``/album/``
 or ``/album/5,7``. In addition we can request the cover art of an album with
 ``GET /album/5/art``.
+You can also add the '?expand' flag to get the individual items of an album.



can you provide an example of the usage of ?expand here?

sampsyo · 2016-06-18T18:54:46Z

This looks ready to merge as soon as we have a changelog entry.

maxammann · 2016-06-26T16:32:51Z

@sampsyo
Web plugin Changelog:

Added an option to show the items of an album
Added the 'path' tag to the json outpu of a file which shows the relative path to the file
Normalized the json output

sampsyo · 2016-06-26T17:20:14Z

Could you please add that to changelog.rst? Then somebody can hit that green button.

This allows you to query the individual items of an album

…' variable

maxammann · 2016-06-26T18:02:41Z

Updated fork and added changelog

sampsyo · 2016-06-26T18:20:59Z

Awesome; thank you! ✨

maxammann · 2016-06-26T18:22:21Z

Thanks as well :P
Do you know when the next release is going to be published?

sampsyo · 2016-06-26T18:24:32Z

We don't have a precise release schedule, usually, but please feel free to weigh in if you think a faster release would ever be useful.

jackwilsdon reviewed Jun 13, 2016
View reviewed changes

ghost reviewed Jun 18, 2016
View reviewed changes

This was referenced Jun 26, 2016

Support basic authentification maxammann/music-cyclon#1

Closed

Pending pull request for beets maxammann/music-cyclon#2

Closed

maxammann added 7 commits June 26, 2016 19:53

Adding 'expand' flag for json requests

5831b99

This allows you to query the individual items of an album

Added documentation for the new 'expand' flag

4be45ea

Fixed lines which are mor than 79 characters

041adf4

Added documentation for the expand parameter

619344c

Modified and simplified is_expand(...) method

2ae2654

Expose the relative path to the library instead of omitting the 'path…

5e8ac9e

…' variable

Added changelog for beetbox#2050

cfd70c2

maxammann force-pushed the master branch from dd73cfd to cfd70c2 Compare June 26, 2016 18:02

sampsyo merged commit 77a869d into beetbox:master Jun 26, 2016

sampsyo mentioned this pull request Aug 29, 2016

Feature Request: API should return song/album paths #2177

Closed

ghost mentioned this pull request Sep 1, 2016

Slowdown with beet web - regression #2182

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'expand' flag to the web plugin #2050

Add 'expand' flag to the web plugin #2050

maxammann commented Jun 13, 2016 •

edited

Loading

jackwilsdon Jun 13, 2016 •

edited

Loading

jackwilsdon commented Jun 13, 2016 •

edited

Loading

jackwilsdon Jun 13, 2016 •

edited

Loading

maxammann Jun 13, 2016

jackwilsdon Jun 13, 2016 •

edited

Loading

maxammann commented Jun 13, 2016

maxammann commented Jun 13, 2016

jackwilsdon commented Jun 13, 2016

maxammann commented Jun 13, 2016 •

edited

Loading

sampsyo commented Jun 13, 2016

maxammann commented Jun 13, 2016 •

edited

Loading

jackwilsdon commented Jun 13, 2016

jackwilsdon commented Jun 13, 2016

sampsyo commented Jun 13, 2016

ghost Jun 18, 2016

sampsyo commented Jun 18, 2016

maxammann commented Jun 26, 2016

sampsyo commented Jun 26, 2016

maxammann commented Jun 26, 2016

sampsyo commented Jun 26, 2016

maxammann commented Jun 26, 2016

sampsyo commented Jun 26, 2016

Add 'expand' flag to the web plugin #2050

Add 'expand' flag to the web plugin #2050

Conversation

maxammann commented Jun 13, 2016 • edited Loading

jackwilsdon Jun 13, 2016 • edited Loading

Choose a reason for hiding this comment

jackwilsdon commented Jun 13, 2016 • edited Loading

jackwilsdon Jun 13, 2016 • edited Loading

Choose a reason for hiding this comment

maxammann Jun 13, 2016

Choose a reason for hiding this comment

jackwilsdon Jun 13, 2016 • edited Loading

Choose a reason for hiding this comment

maxammann commented Jun 13, 2016

maxammann commented Jun 13, 2016

jackwilsdon commented Jun 13, 2016

maxammann commented Jun 13, 2016 • edited Loading

sampsyo commented Jun 13, 2016

maxammann commented Jun 13, 2016 • edited Loading

jackwilsdon commented Jun 13, 2016

jackwilsdon commented Jun 13, 2016

sampsyo commented Jun 13, 2016

ghost Jun 18, 2016

Choose a reason for hiding this comment

sampsyo commented Jun 18, 2016

maxammann commented Jun 26, 2016

sampsyo commented Jun 26, 2016

maxammann commented Jun 26, 2016

sampsyo commented Jun 26, 2016

maxammann commented Jun 26, 2016

sampsyo commented Jun 26, 2016

maxammann commented Jun 13, 2016 •

edited

Loading

jackwilsdon Jun 13, 2016 •

edited

Loading

jackwilsdon commented Jun 13, 2016 •

edited

Loading

jackwilsdon Jun 13, 2016 •

edited

Loading

jackwilsdon Jun 13, 2016 •

edited

Loading

maxammann commented Jun 13, 2016 •

edited

Loading

maxammann commented Jun 13, 2016 •

edited

Loading