Casting Agency Project

Udacity Full-Stack Web Developer Nanodegree Program Capstone Project

Project Motivation

The Casting Agency Project models a company that is responsible for creating movies and managing and assigning actors to those movies.

This project is simply a workspace for practicing and showcasing different set of skills related with web development. These include data modelling, API design, authentication and authorization and cloud deployment.

Key Dependencies & Platforms

• Flask is a lightweight backend microservices framework. Flask is required to handle requests and responses.

• SQLAlchemy is the Python SQL toolkit and ORM we'll use handle the lightweight sqlite database. You'll primarily work in app.py and can reference models.py.

• Flask-CORS is the extension we'll use to handle cross origin requests from our frontend server.

• Auth0 is the authentication and authorization system we'll use to handle users with different roles with more secure and easy ways

• PostgreSQL this project is integrated with a popular relational database PostgreSQL, though other relational databases can be used with a little effort.

• Heroku is the cloud platform used for deployment

Running Locally

Installing Dependencies

Python 3.9

Follow instructions to install the latest version of python for your platform in the python docs

Virtual Environment

We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organized. Instructions for setting up a virtual environment for your platform can be found in the python docs

Once you have your virtual environment setup and running, install dependencies by running:

pip install -r requirements.txt

This will install all of the required packages we selected within the requirements.txt file.

Database Setup

With Postgres running, restore a database using the capstone_run.psql file provided. In terminal run:

createdb capstone
psql capstone < capstone_run.psql

Running Tests

To run the tests, run

dropdb capstone_test
createdb capstone_test
psql capstone_test < capstone_run.psql
python test_app.py

Auth0 Setup

You need to setup an Auth0 account.

Environment variables needed: (setup.sh)

export AUTH0_DOMAIN="xxxxxxxxxx.auth0.com" # Choose your tenant domain
export ALGORITHMS="RS256"
export API_AUDIENCE="xxxxxxxxx" # Create an API in Auth0

Roles

Create three roles for users under Users & Roles section in Auth0

• Casting Assistant
  • Can view actors and movies
• Casting Director
  • All permissions a Casting Assistant has and…
  • Add or delete an actor from the database
  • Modify actors or movies
• Executive Producer
  • All permissions a Casting Director has and…
  • Add or delete a movie from the database

Permissions

Following permissions should be created under created API settings.

• view:actors
• view:movies
• delete:actors
• post:actors
• update:actors
• update:movies
• post:movies
• delete:movies

Set JWT Tokens in auth_config.json

Use the following link to create users and sign them in. This way, you can generate

https://{{YOUR_DOMAIN}}/authorize?audience={{API_IDENTIFIER}}&response_type=token&client_id={{YOUR_CLIENT_ID}}&redirect_uri={{YOUR_CALLBACK_URI}}

Launching The App

1. Initialize and activate a virtualenv:

   virtualenv --no-site-packages env_capstone
   source env_capstone/bin/activate

2. Install the dependencies:

   pip install -r requirements.txt

3. Configure database path to connect local postgres database in models.py

   database_path = "postgres://{}/{}".format('localhost:5432', 'capstone')

Note: For default postgres installation, default user name is postgres with no password. Thus, no need to speficify them in database path. You can also omit host and post (localhost:5432). But if you need, you can use this template:

postgresql://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]

For more details look at the documentation (31.1.1.2. Connection URIs)

4. Setup the environment variables for Auth0 under datasetup.sh/datasetup.bat running:

   source ./datasetup.sh 

   or

   datasetup.bat 

5. To run the server locally, execute:

   export FLASK_APP=flaskr
   export FLASK_DEBUG=True
   export FLASK_ENVIRONMENT=debug
   flask run --reload

API Documentation

Models

There are two models:

• Movie
  • title
  • release_date
• Actor
  • name
  • age
  • gender

Error Handling

Errors are returned as JSON objects in the following format:

{
    "success": False, 
    "error": 400,
    "message": "bad request"
}

The API will return three error types when requests fail:

• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 404: Resource Not Found
• 422: Not Processable
• 500: Internal Server Error

Endpoints

GET /movies

• Get all movies

• Require view:movies permission

• Example Request: curl 'http://localhost:5000/movies'

• Expected Result:

  {
  	"movies": [
  		{
  		"actors": [
  			{
  			"age": 54,
  			"gender": "M",
  			"id": 1,
  			"movie_id": 2,
  			"name": "Tom Hanks"
  			},
  			{
  			"age": 45,
  			"gender": "M",
  			"id": 4,
  			"movie_id": 2,
  			"name": "Robert Downey, Jr."
  			},
  			{
  			"age": 45,
  			"gender": "F",
  			"id": 5,
  			"movie_id": 2,
  			"name": "Julia Roberts"
  			}
  		],
  		"id": 2,
  		"release_date": "Fri, 04 May 2012 00:00:00 GMT",
  		"title": "Yahşi Batı"
  		},
  		...
  	],
  	"success": true
  }

GET /actors

• Get all actors

• Requires view:actors permission

• Example Request: curl 'http://localhost:5000/actors'

• Expected Result:

  {
  	"actors": [
  		{
  		"age": 45,
  		"gender": "M",
  		"id": 6,
  		"movie_id": 1,
  		"name": "Cem Yılmaz"
  		},
  		{
  		"age": 54,
  		"gender": "M",
  		"id": 1,
  		"movie_id": 2,
  		"name": "Tom Hanks"
  		},
  		{
  		"age": 44,
  		"gender": "M",
  		"id": 2,
  		"movie_id": 3,
  		"name": "Brad Pitt"
  		}
  	],
  	"success": true
  }

POST /movies

• Creates a new movie.

• Requires post:movies permission

• Requires the title and release date.

• Example Request: (Create)

  curl --location --request POST 'http://localhost:5000/movies' \
  	--header 'Content-Type: application/json' \
  	--data-raw '{
  		"title": "Pek Yakında",
  		"release_date": "19-02-2020"
  	}'

• Example Response:

  {
  	"success": true
  }

POST /actors

• Creates a new actor.

• Requires post:actors permission

• Requires the name, age and gender of the actor.

• Example Request: (Create)

  curl --location --request POST 'http://localhost:5000/actors' \
  	--header 'Content-Type: application/json' \
  	--data-raw '{
  		"name": "Cem Yılmaz",
  		"age": "45",
  		"gender": "M",
          "movie_id": 1
      }'

• Example Response:

  {
  	"success": true
  }

DELETE /movies/int:movie_id

• Deletes the movie with given id

• Require delete:movies permission

• Example Request: curl --request DELETE 'http://localhost:5000/movies/1'

• Example Response:

  {
  	"deleted": 1,
  	"success": true
  }

DELETE /actors/int:actor_id

• Deletes the actor with given id

• Require delete:actors permission

• Example Request: curl --request DELETE 'http://localhost:5000/actors/1'

• Example Response:

  {
  	"deleted": 1,
  	"success": true
  }

PATCH /movies/<movie_id>

• Updates the movie where <movie_id> is the existing movie id

• Require update:movies permission

• Responds with a 404 error if <movie_id> is not found

• Update the corresponding fields for Movie with id <movie_id>

• Example Request:

   curl --location --request PATCH 'http://localhost:5000/movies/1' \
   	--header 'Content-Type: application/json' \
   	--data-raw '{
   		"title": "Eyvah eyvah 2"
       }'

• Example Response:

  {
  	"success": true, 
  	"updated": {
  		"id": 1, 
  		"release_date": "Wed, 04 May 2016 00:00:00 GMT", 
  		"title": "Eyvah eyvah 2"
  	}
  }

PATCH /actors/<actor_id>

• Updates the actor where <actor_id> is the existing actor id

• Require update:actors

• Responds with a 404 error if <actor_id> is not found

• Update the given fields for Actor with id <actor_id>

• Example Request:

   curl --location --request PATCH 'http://localhost:5000/actors/1' \
   	--header 'Content-Type: application/json' \
   	--data-raw '{
   		"name": "Tom Hanks"
       }'

• Example Response:

  {
  	"success": true, 
  	"updated": {
  		"age": 54, 
  		"gender": "M", 
  		"id": 1, 
  		"name": "Tom Hanks"
  	}
  }

Live Application URl :

https://fsnd-capstone-a261584c79ff.herokuapp.com/