Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MBS-13781: Support browsing genres by collection in the API #3394

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

MBS-13781: Support browsing genres by collection in the API #3394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 40 additions & 12 deletions lib/MusicBrainz/Server/Controller/WS/2/Genre.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,19 @@ extends 'MusicBrainz::Server::ControllerBase::WS::2';

use MusicBrainz::Server::WebService::TXTSerializer;
use aliased 'MusicBrainz::Server::WebService::WebServiceStash';
use MusicBrainz::Server::Validation qw( is_guid );

my $ws_defs = Data::OptList::mkopt([
genre => {
method => 'GET',
# TODO: Add include when implementing MBS-10062
# inc => [ qw(aliases) ],
optional => [ qw(fmt limit offset) ],
linked => [ qw( collection ) ],
},
genre => {
method => 'GET',
optional => [ qw(fmt limit offset) ],
},
genre => {
action => '/ws/2/genre/lookup',
Expand All @@ -30,6 +36,8 @@ with 'MusicBrainz::Server::Controller::WS::2::Role::Lookup' => {
model => 'Genre',
};

with 'MusicBrainz::Server::Controller::WS::2::Role::BrowseByCollection';

sub serializers {
[
'MusicBrainz::Server::WebService::XMLSerializer',
Expand All @@ -43,6 +51,38 @@ sub base : Chained('root') PathPart('genre') CaptureArgs(0) { }
# Nothing extra to load yet, but this is required by Role::Lookup
sub genre_toplevel {}

sub genre_browse : Private {
my ($self, $c) = @_;

my ($resource, $id) = @{ $c->stash->{linked} };
my ($limit, $offset) = $self->_limit_and_offset($c);

if (!is_guid($id)) {
$c->stash->{error} = 'Invalid mbid.';
$c->detach('bad_req');
}

my $genres;

if ($resource eq 'collection') {
$genres = $self->browse_by_collection($c, 'genre', $id, $limit, $offset);
}

my $stash = WebServiceStash->new;

$self->genre_toplevel($c, $stash, $genres->{items});

$c->res->content_type($c->stash->{serializer}->mime_type . '; charset=utf-8');
$c->res->body($c->stash->{serializer}->serialize('genre-list', $genres, $c->stash->{inc}, $stash));
}

sub genre_search : Chained('root') PathPart('genre') Args(0) {
my ($self, $c) = @_;

$c->detach('genre_browse') if $c->stash->{linked};
$c->detach('not_implemented');
}

sub genre_all : Chained('base') PathPart('all') {
my ($self, $c) = @_;

Expand Down Expand Up @@ -74,18 +114,6 @@ sub genre_all : Chained('base') PathPart('all') {
));
}

sub genre_browse : Private {
my ($self, $c) = @_;

$c->detach('not_implemented');
}

sub genre_search : Chained('root') PathPart('genre') Args(0) {
my ($self, $c) = @_;

$c->detach('genre_browse') if $c->stash->{linked};
$c->detach('not_implemented');
}
__PACKAGE__->meta->make_immutable;
1;

Expand Down
69 changes: 69 additions & 0 deletions t/lib/t/MusicBrainz/Server/Controller/WS/2/BrowseGenres.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
package t::MusicBrainz::Server::Controller::WS::2::BrowseGenres;
use utf8;
use strict;
use warnings;

use Test::Routine;
use Test::More;
use HTTP::Status qw( :constants );

with 't::Mechanize', 't::Context';

use MusicBrainz::Server::Test::WS qw(
ws2_test_xml
ws2_test_xml_forbidden
ws2_test_xml_unauthorized
);

test all => sub {

my $test = shift;
my $c = $test->c;

MusicBrainz::Server::Test->prepare_test_database($c, '+webservice');

ws2_test_xml 'browse genres via public collection',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1a' =>
'<?xml version="1.0"?>
<metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#">
<genre-list count="1">
<genre id="51cfaac4-6696-480b-8f1b-27cfc789109c">
<name>grime</name>
<disambiguation>stuff</disambiguation>
</genre>
</genre-list>
</metadata>';

ws2_test_xml 'browse genres via private collection',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b' =>
'<?xml version="1.0"?>
<metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#">
<genre-list count="1">
<genre id="51cfaac4-6696-480b-8f1b-27cfc789109c">
<name>grime</name>
<disambiguation>stuff</disambiguation>
</genre>
</genre-list>
</metadata>',
{ username => 'the-anti-kuno', password => 'notreally' };

ws2_test_xml_forbidden 'browse genres via private collection, no credentials',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b';

ws2_test_xml_unauthorized 'browse genres via private collection, bad credentials',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b',
{ username => 'the-anti-kuno', password => 'idk' };

my $res = $test->mech->get('/ws/2/genre?collection=3c37b9fa-a6c1-37d2-9e90-657a116d337c&limit=-1');
is($res->code, HTTP_BAD_REQUEST);

$res = $test->mech->get('/ws/2/genre?collection=3c37b9fa-a6c1-37d2-9e90-657a116d337c&offset=a+bit');
is($res->code, HTTP_BAD_REQUEST);

$res = $test->mech->get('/ws/2/genre?collection=3c37b9fa-a6c1-37d2-9e90-657a116d337c&limit=10&offset=-1');
is($res->code, HTTP_BAD_REQUEST);

};

1;

6 changes: 3 additions & 3 deletions t/lib/t/MusicBrainz/Server/Controller/WS/2/Collection.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ test 'collection lookup' => sub {
<collection entity-type="genre" type="Genre" id="7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b">
<name>private genre collection</name>
<editor>the-anti-kuno</editor>
<genre-list count="0" />
<genre-list count="1" />
</collection>
<collection entity-type="instrument" type="Instrument" id="cdef54c4-2798-4d39-a0c9-5074191f9b6e">
<name>private instrument collection</name>
Expand Down Expand Up @@ -104,7 +104,7 @@ test 'collection lookup' => sub {
<collection entity-type="genre" type="Genre" id="7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1a">
<name>public genre collection</name>
<editor>the-anti-kuno</editor>
<genre-list count="0" />
<genre-list count="1" />
</collection>
<collection id="7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1f" type="Instrument" entity-type="instrument">
<name>public instrument collection</name>
Expand Down Expand Up @@ -230,7 +230,7 @@ test 'collection lookup' => sub {
<collection entity-type="genre" type="Genre" id="7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1a">
<name>public genre collection</name>
<editor>the-anti-kuno</editor>
<genre-list count="0" />
<genre-list count="1" />
</collection>
<collection id="7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1f" type="Instrument" entity-type="instrument">
<name>public instrument collection</name>
Expand Down
58 changes: 58 additions & 0 deletions t/lib/t/MusicBrainz/Server/Controller/WS/2/JSON/BrowseGenres.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
package t::MusicBrainz::Server::Controller::WS::2::JSON::BrowseGenres;
use utf8;
use strict;
use warnings;

use Test::Routine;
use MusicBrainz::Server::Test ws_test_json => {
version => 2,
};
use MusicBrainz::Server::Test::WS qw(
ws2_test_json_forbidden
ws2_test_json_unauthorized
);

with 't::Mechanize', 't::Context';

test 'browse genres via collection' => sub {

MusicBrainz::Server::Test->prepare_test_database(shift->c, '+webservice');

ws_test_json 'browse genres via public collection',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1a' =>
{
'genre-offset' => 0,
'genre-count' => 1,
genres => [
{
id => '51cfaac4-6696-480b-8f1b-27cfc789109c',
name => 'grime',
disambiguation => 'stuff',
}],
};

ws_test_json 'browse genres via private collection',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b' =>
{
'genre-offset' => 0,
'genre-count' => 1,
genres => [
{
id => '51cfaac4-6696-480b-8f1b-27cfc789109c',
name => 'grime',
disambiguation => 'stuff',
}],
},
{ username => 'the-anti-kuno', password => 'notreally' };


ws2_test_json_forbidden 'browse genres via private collection, no credentials',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b';

ws2_test_json_unauthorized 'browse genres via private collection, bad credentials',
'/genre?collection=7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b',
{ username => 'the-anti-kuno', password => 'idk' };

};

1;
4 changes: 2 additions & 2 deletions t/lib/t/MusicBrainz/Server/Controller/WS/2/JSON/Collection.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ test 'collection lookup' => sub {
'type' => 'Genre',
'type-id' => '1210f9ce-e138-3b08-94b5-05d21032b696',
'editor' => 'the-anti-kuno',
'genre-count' => '0',
'genre-count' => '1',
},
{
'id' => '7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1b',
Expand All @@ -123,7 +123,7 @@ test 'collection lookup' => sub {
'type' => 'Genre',
'type-id' => '1210f9ce-e138-3b08-94b5-05d21032b696',
'editor' => 'the-anti-kuno',
'genre-count' => '0',
'genre-count' => '1',
},
{
'id' => '7749c811-d77c-4ea5-9a9e-e2a4e7ae0d1f',
Expand Down
2 changes: 2 additions & 0 deletions t/sql/webservice.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1635,6 +1635,8 @@ INSERT INTO editor_collection_artist (collection, artist) VALUES (3, 9496);
INSERT INTO editor_collection_artist (collection, artist) VALUES (4, 135345);
INSERT INTO editor_collection_event (collection, event) VALUES (5, 7);
INSERT INTO editor_collection_event (collection, event) VALUES (6, 8);
INSERT INTO editor_collection_genre (collection, genre) VALUES (23, 3);
INSERT INTO editor_collection_genre (collection, genre) VALUES (24, 3);
INSERT INTO editor_collection_instrument (collection, instrument) VALUES (7, 7);
INSERT INTO editor_collection_instrument (collection, instrument) VALUES (8, 7);
INSERT INTO editor_collection_label (collection, label) VALUES (9, 8092);
Expand Down