add /release-group endpoint

critiquebrainz/ws/__init__.py

@@ -102,8 +102,11 @@ def _register_blueprints(app):
     from critiquebrainz.ws.user.views import user_bp
     from critiquebrainz.ws.review.bulk import bulk_review_bp
     from critiquebrainz.ws.artist.views import artist_bp
+    from critiquebrainz.ws.release_group.views import release_group_bp
     app.register_blueprint(oauth_bp, url_prefix="/oauth")
     app.register_blueprint(review_bp, url_prefix="/review")
     app.register_blueprint(user_bp, url_prefix="/user")
     app.register_blueprint(bulk_review_bp, url_prefix="/reviews")
     app.register_blueprint(artist_bp, url_prefix="/artist")
+    app.register_blueprint(release_group_bp, url_prefix="/release-group")
+

critiquebrainz/ws/constants.py

@@ -3,4 +3,5 @@
     'review',
     'vote',
     'artist',
+    'release_group',
 )

critiquebrainz/ws/release_group/views.py

@@ -0,0 +1,155 @@
+from flask import Blueprint, jsonify
+import critiquebrainz.db.review as db_review
+import critiquebrainz.db.rating_stats as db_rating_stats
+from brainzutils.musicbrainz_db import release_group as db_release_group
+import brainzutils.musicbrainz_db.exceptions as db_exceptions
+from critiquebrainz.decorators import crossdomain
+from critiquebrainz.ws.exceptions import NotFound
+
+release_group_bp = Blueprint('ws_release_group', __name__)
+
+
+@release_group_bp.route('/<uuid:release_group_mbid>', methods=['GET', 'OPTIONS'])
+@crossdomain(headers="Authorization, Content-Type")
+def release_group_entity_handler(release_group_mbid):
+    """Get list of reviews.
+
+    **Request Example:**
+
+    .. code-block:: bash
+
+        $ curl "https://critiquebrainz.org/ws/1/release-group/f0bd8ae8-321f-43d8-af87-e2f90d1b3817" \\
+                -X GET
+
+    **Response Example:**
+
+    .. code-block:: json
+
+    {
+        "avg_rating": 4.0,
+        "latest_reviews": [
+            {
+                "created": "Wed, 01 Dec 2021 16:28:50 GMT",
+                "edits": 0,
+                "entity_id": "f0bd8ae8-321f-43d8-af87-e2f90d1b3817",
+                "entity_type": "release_group",
+                "full_name": "Creative Commons Attribution-ShareAlike 3.0 Unported",
+                "id": "b08b37f6-c644-470d-af48-e77b14331e09",
+                "info_url": "https://creativecommons.org/licenses/by-sa/3.0/",
+                "is_draft": false,
+                "is_hidden": false,
+                "language": "en",
+                "last_revision": {
+                    "id": 11167,
+                    "rating": 4,
+                    "review_id": "b08b37f6-c644-470d-af48-e77b14331e09",
+                    "text": "Hollywood Greats, a cover mount from The Daily Mirror, was one of my first ever newspaper cover mounts I got - and sadly it led me to believe that all newspaper covermounts were free goldmines ready to be plundered; how wrong was I!\r\n\r\n10 great original studio recordings, and 5 so-so tracks from \"underground\" artists, however those 5 artists were so underground that even the internet knows nothing of them.\r\n\r\nI'm probably biased with this one as it was my first - but a good collection either way.",
+                    "timestamp": "Wed, 01 Dec 2021 16:28:50 GMT"
+                },
+                "last_updated": "Wed, 01 Dec 2021 16:28:50 GMT",
+                "license_id": "CC BY-SA 3.0",
+                "popularity": 1,
+                "published_on": "Wed, 01 Dec 2021 16:28:50 GMT",
+                "rating": 4,
+                "source": null,
+                "source_url": null,
+                "text": "Hollywood Greats, a cover mount from The Daily Mirror, was one of my first ever newspaper cover mounts I got - and sadly it led me to believe that all newspaper covermounts were free goldmines ready to be plundered; how wrong was I!\r\n\r\n10 great original studio recordings, and 5 so-so tracks from \"underground\" artists, however those 5 artists were so underground that even the internet knows nothing of them.\r\n\r\nI'm probably biased with this one as it was my first - but a good collection either way.",
+                "user": {
+                    "created": "Sat, 15 Aug 2020 15:48:39 GMT",
+                    "display_name": "sound.and.vision",
+                    "id": "dfdae69f-275f-41a2-82c7-ac5d1f9c8129",
+                    "karma": 16,
+                    "user_type": "Noob"
+                },
+                "votes_negative_count": 0,
+                "votes_positive_count": 1
+            }
+        ],
+        "rating_stats": {
+            "1": 0,
+            "2": 0,
+            "3": 0,
+            "4": 1,
+            "5": 0
+        },
+        "release_group": {
+            "id": "f0bd8ae8-321f-43d8-af87-e2f90d1b3817",
+            "title": "Hollywood Greats",
+            "type": "Album"
+        },
+        "reviews_count": 1,
+        "top_reviews": [
+            {
+                "created": "Wed, 01 Dec 2021 16:28:50 GMT",
+                "edits": 0,
+                "entity_id": "f0bd8ae8-321f-43d8-af87-e2f90d1b3817",
+                "entity_type": "release_group",
+                "full_name": "Creative Commons Attribution-ShareAlike 3.0 Unported",
+                "id": "b08b37f6-c644-470d-af48-e77b14331e09",
+                "info_url": "https://creativecommons.org/licenses/by-sa/3.0/",
+                "is_draft": false,
+                "is_hidden": false,
+                "language": "en",
+                "last_revision": {
+                    "id": 11167,
+                    "rating": 4,
+                    "review_id": "b08b37f6-c644-470d-af48-e77b14331e09",
+                    "text": "Hollywood Greats, a cover mount from The Daily Mirror, was one of my first ever newspaper cover mounts I got - and sadly it led me to believe that all newspaper covermounts were free goldmines ready to be plundered; how wrong was I!\r\n\r\n10 great original studio recordings, and 5 so-so tracks from \"underground\" artists, however those 5 artists were so underground that even the internet knows nothing of them.\r\n\r\nI'm probably biased with this one as it was my first - but a good collection either way.",
+                    "timestamp": "Wed, 01 Dec 2021 16:28:50 GMT"
+                },
+                "last_updated": "Wed, 01 Dec 2021 16:28:50 GMT",
+                "license_id": "CC BY-SA 3.0",
+                "popularity": 1,
+                "published_on": "Wed, 01 Dec 2021 16:28:50 GMT",
+                "rating": 4,
+                "source": null,
+                "source_url": null,
+                "text": "Hollywood Greats, a cover mount from The Daily Mirror, was one of my first ever newspaper cover mounts I got - and sadly it led me to believe that all newspaper covermounts were free goldmines ready to be plundered; how wrong was I!\r\n\r\n10 great original studio recordings, and 5 so-so tracks from \"underground\" artists, however those 5 artists were so underground that even the internet knows nothing of them.\r\n\r\nI'm probably biased with this one as it was my first - but a good collection either way.",
+                "user": {
+                    "created": "Sat, 15 Aug 2020 15:48:39 GMT",
+                    "display_name": "sound.and.vision",
+                    "id": "dfdae69f-275f-41a2-82c7-ac5d1f9c8129",
+                    "karma": 16,
+                    "user_type": "Noob"
+                },
+                "votes_negative_count": 0,
+                "votes_positive_count": 1
+            }
+        ]
+    }
+    :statuscode 200: no error
+    :statuscode 404: release group not found
+    
+    :resheader Content-Type: *application/json*
+    """
+
+
+    try:
+        release_group = db_release_group.get_release_group_by_id(str(release_group_mbid))
+    except db_exceptions.NoDataFoundException:
+        raise NotFound("Can't find an release group with ID: {release_group_mbid}".format(release_group_mbid=release_group_mbid))
+
+    ratings_stats, average_rating = db_rating_stats.get_stats(release_group_mbid, "release_group")
+
+    reviews_limit = 5
+
+    top_reviews, reviews_count = db_review.list_reviews(
+        entity_id=release_group_mbid,
+        entity_type='release_group',
+        sort='popularity',
+        limit=reviews_limit,
+        offset=0,
+    )
+
+    latest_reviews, reviews_count = db_review.list_reviews(
+        entity_id=release_group_mbid,
+        entity_type='release_group',
+        sort='published_on',
+        limit=reviews_limit,
+        offset=0,
+    )
+
+    top_reviews = [db_review.to_dict(p) for p in top_reviews]
+    latest_reviews = [db_review.to_dict(p) for p in latest_reviews]
+
+    return jsonify(release_group=release_group, avg_rating=average_rating, rating_stats=ratings_stats, reviews_count=reviews_count, top_reviews=top_reviews, latest_reviews=latest_reviews)