We’d like you to build simple REST API for us - a basic movie database interacting with external API. Here’s full specification of endpoints that we’d like it to have:

• POST /movies:
  • Request body should contain only movie title, and its presence should be validated.
  • Based on passed title, other movie details should be fetched from http://www.omdbapi.com/ (or other similar, public movie database) - and saved to application database.
  • Request response should include full movie object, along with all data fetched from external API.
• GET /movies:
  • Should fetch list of all movies already present in application database.
  • Additional filtering, sorting is fully optional - but some implementation is a bonus.
• POST /comments:
  • Request body should contain ID of movie already present in database, and comment text body.
  • Comment should be saved to application database and returned in request response.
• GET /comments:
  • Should fetch list of all comments present in application database.
  • Should allow filtering comments by associated movie, by passing its ID.

• Your goal is to implement REST API in Django, however you're free to use any third-party libraries and database of your choice - sharing your reasoning behind choosing them is welcome!
• At least basic tests of endpoints and their functionality are obligatory. Their exact scope and form is left up to you.
• The application's code should be kept in a public repository so that we can read it, pull it and build it ourselves. Remember to include README file or at least basic notes on application requirements and setup - we should be able to easily and quickly get it running.
• Written application must be hosted and publicly available for us online - we recommend Heroku.

As mentioned in assigment section above application provides simple rest api for issuing comments/reviews of movies from external database.

Solution is based on django-rest framework which is extending django capabilities with many rest friendly modules. For more information check project website.

Note:

• For sake of simplicity and due to non production character of this application, debug mode in django is not diabled on production environment.

• For your convenience I left source branches for pull requests without squash so you can check what problems I was struggling with.

As it was requested application is prepared to use with heroku services.

1. Follow heroku manual to setup your account
2. Create new application as it's descirbed in manual
3. Deploy application:

   $> git push heroku master 

4. Run migration scripts:

   $> heroku run python manage.py migrate

5. Now you can visit deployed application

   $> heroku open

Note:

• postgresDb would be added automatically, if not add it manually

Apllication is already configured to deploy to domain: sratatata-movies.herokuapp.com automatically after push to master branch so you can visit it on mentioned url.

If changes needed just issue pull request to master branch, after changes accepted, they would go live after passing tests.

See www.omdbapi.com for more details

By default settings.py is looking for environment variable OMDB_SECRET with OMDB api-key set. Please set mentioned variable:

set OMDB_SECRET=<your_api_key>

or insert it into settings.py directly.

# Custom secret necessary to access to OMDB database
# See http://www.omdbapi.com/apikey.aspx
# OMDB_SECRET = os.environ.get('OMDB_SECRET')
OMDB_SECRET = <your_api_key>

Api key could be obtained here on omdb website

# using httpie
$> http GET https://sratatata-movies.herokuapp.com/movies

Query Parameters:

• (optional) title:string - filter movies with title LIKE value
• (optional) year:int - filter movies with year exact equal value
• (optional) sort_by:string - choose single column to generic_sort by (default order is asc)
• (optional) order:string - choose asc or desc

Please notice that unknown parameters would disable all filtering Filters could be used together

Example output:

HTTP/1.1 200 OK
Allow: GET, POST, HEAD, OPTIONS
Connection: keep-alive
Content-Length: 105
Content-Type: application/json
Date: Mon, 30 Jul 2018 21:21:02 GMT
Server: gunicorn/19.9.0
Vary: Accept, Cookie
Via: 1.1 vegur
X-Frame-Options: SAMEORIGIN

[
    {
        "title": "Inception", 
        "year": "2010"
    }, 
    {
        "title": "Matrix", 
        "year": "1993–"
    }
]

Example with filters:

# using httpie
$> http GET https://sratatata-movies.herokuapp.com/movies?year=2010

Outputs:

HTTP/1.1 200 OK
Allow: GET, POST, HEAD, OPTIONS
Connection: keep-alive
Content-Length: 105
Content-Type: application/json
Date: Mon, 30 Jul 2018 21:21:02 GMT
Server: gunicorn/19.9.0
Vary: Accept, Cookie
Via: 1.1 vegur
X-Frame-Options: SAMEORIGIN

[
    {
        "title": "Inception", 
        "year": "2010"
    }
]

Statuses:

• 200 - ok - List of movies was returned

# using httpie
$> http POST https://sratatata-movies.herokuapp.com/movies title="Psy"

Json body:

   { "title":"Psy" }

Example output:

HTTP 201 Created
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "title": "Psy",
    "year": "1989"
}

Statuses

• 201 - created : movie was successfully added to database
• 400 - bad request : title was empty or fetching data from external database was unsuccessful

# using httpie
$> http GET https://sratatata-movies.herokuapp.com/comments

Query Parameters:

• (optional) movie:int - enable comment filtering by movie id

Please note that filtering is enabled by query parameter because requested in the assignment resource url is not nested (GET: /comments).
Alternately could be done GET: /movies/<id:int>/comments

Example output:

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

[
    {
        "id": 2,
        "movie": 4,
        "body": "Amazing!"
    },
    {
        "id": 3,
        "movie": 4,
        "body": "Sink!"
    }
]

Statuses:

• 200 - ok - List of comments was returned

# using httpie
$> http POST https://sratatata-movies.herokuapp.com/comments movie=4 body="Amazing!"

Json body:

   { "movie":4, body:"Amazing!" }

Example output

HTTP 201 Created
Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 2,
    "movie": 4,
    "body": "Amazing!"
}

Statuses

• 201 - created : comment was added to database
• 400 - bad request : movie was not found or comment body was empty