Listing Ratings

Optional Lesson

This lesson is optional and will not count towards your achievement. To view the completed code, check out the 13-listing-ratings branch.

The last remaining element on the Movie page is the list of ratings on the right-hand side of the page. Although the count in the header is now accurate, the ratings list being returned by the API is still hardcoded.

The list of ratings is populated by the for_movie() method in the RatingDAO, which currently returns a hardcoded list of ratings.

python
api/dao/ratings.py
def for_movie(self, id, sort = 'timestamp', order = 'ASC', limit = 6, skip = 0):
    # TODO: Get ratings for a Movie
    # TODO: Remember to escape the braces in the cypher query with double braces: {{ }}

    return ratings

In this challenge, you will run the following Cypher statement in a read transaction:

cypher
Get Ratings
MATCH (u:User)-[r:RATED]->(m:Movie {tmdbId: $id})
RETURN r {
    .rating,
    .timestamp,
    user: u {
        .userId, .name
    }
} AS review
ORDER BY r.timestamp DESC
SKIP $skip
LIMIT $limit

Your Task

  • Modify the for_movie() method to retrieve the ratings from Neo4j.

  • Remember to use the .format() method on the string to replace the r.timestamp value from the query above with the sort parameter supplied to the method and escape the braces in the Cypher statement using double braces ({{ and }}).

Click to reveal the completed for_movie() method
python
api/dao/ratings.py
def for_movie(self, id, sort = 'timestamp', order = 'ASC', limit = 6, skip = 0):
    # Get ratings for a Movie
    def get_movie_ratings(tx, id, sort, order, limit):
        cypher = """
        MATCH (u:User)-[r:RATED]->(m:Movie {{tmdbId: $id}})
        RETURN r {{
            .rating,
            .timestamp,
            user: u {{
                .userId, .name
            }}
        }} AS review
        ORDER BY r.`{0}` {1}
        SKIP $skip
        LIMIT $limit
        """.format(sort, order)

        result = tx.run(cypher, id=id, limit=limit, skip=skip)

        return [ row.get("review") for row in result ]

    with self.driver.session() as session:
        return session.execute_read(get_movie_ratings, id, sort, order, limit)

Testing

To test that this functionality has been correctly implemented, run the following code in a new terminal session:

sh
Running the test
pytest -s tests/13_listing_ratings__test.py

The test file is located at tests/13_listing_ratings__test.py.

Are you stuck? Click here for help

If you get stuck, you can see a working solution by checking out the 13-listing-ratings branch by running:

sh
Check out the 13-listing-ratings branch
git checkout 13-listing-ratings

You may have to commit or stash your changes before checking out this branch. You can also click here to expand the Support pane.

Verifying the Test

Who was the first user to rate Pulp Fiction?

As part of the test suite, the final test will log the name of the first user to rate the movie Pulp Fiction.

Paste the name of the user the box below without quotes or whitespace and click Check Answer.

  • ✓ Keith Howell

Hint

You can also find the answer by running the following Cypher statement:

cypher
MATCH (u:User)-[r:RATED]->(m:Movie {title: "Pulp Fiction"})
RETURN u.name
ORDER BY r.timestamp ASC
LIMIT 1

Copy the answer without any quotes or whitespace.

Lesson Summary

In this Challenge, you modified the for_movie() method on the RatingDAO to return a paginated list of reviews for a movie from the Neo4j database.

In the next Challenge, you will update the PersonDAO to return list of actors and directors from Neo4j.