alhomaidhi / capstone

Casting API Backend

URL

https://capstoneaaa.herokuapp.com/

Getting Started

The Casting Agency models a company that is responsible for creating movies and managing and assigning actors to those movies. You are an Executive Producer within the company and are creating a system to simplify and streamline your process.

Installing Dependencies

Python 3.7

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

Virtual Enviornment

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

Deployment

Heroku

1. Create an account on heroku
2. Login with CLI
3. SetUp requirements.txt
4. Use a Procfile with a command simialr to this "web: gunicorn app:app" where app is the file name of your python app
5. SetUp envirmonet variables on in the setup.sh file and in the heroku dashboards (under settings).
6. Create database on heroku using "heroku addons:create heroku-postgresql:hobby-dev --app name_of_your_application"
7. Use this command "heroku config --app name_of_your_application" to get the URL of your database (dont forget to update the envirmonet variables)
8. Push your files to git hub and run it click the "deploy" button after connecting heroku app to your github repository.
9. Your app is running now.

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

Key Dependencies

• 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.

Roles

• 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

• Casting Assistant get:actors get:movies

• Casting Director get:actors get:movies patch:actors patch:movies post:actors delete:actors

• Executive Producer get:actors get:movies patch:actors patch:movies post:actors post:movies delete:actors delete:movies

Endpoints

GET '/movies' GET '/actors' DELETE '/movies/int:id' DELETE '/actors/int:id' POST '/movies' POST '/actors' PATCH '/movies/int:id' PATCH '/actors/int:id'

GET '/movies'

• Fetches a list of movies
• Request Arguments: None
• Returns: a list of movies Example: Response: [ { "title": "Scary Movie", "release date": 2002 }, { "title": "The Conjuring", "release date": 2002 } ]

GET '/actors'

• Fetches a list of actors
• Request Arguments: None
• Returns: a list of actors Example: Response: [ { "name": "Abdullah Alhomaidhi", "age": 23, "gender": "male" }, { "name": "Abdullah", "age": 23, "gender": "male" } ]

DELETE '/movies/int:id'

• Deletes a movie
• Request Arguments: id of a movie
• Returns: a success boolean and the id of the deleted movie Example: Request: https://capstoneaaa.herokuapp.com/53 Response: { "deleted": 53, "success": "True" }

DELETE '/actors/int:id'

• Deletes an actor
• Request Arguments: id of an actor
• Returns: a success boolean and the id of the deleted actor Example: Request: https://capstoneaaa.herokuapp.com/actors/1 Response: { "deleted": 1, "success": "True" }

POST '/movies'

• Adds a movie
• Request Arguments: movie object with title and release date
• Returns: a success boolean and the id of the created movie Example: Request:
  { "title":"Scary Movie", "release_date": "2002" } Response: { "created": 53, "success": "true" }

POST '/actors'

• Adds a actor
• Request Arguments: actor object with name, age, and gender
• Returns: a success boolean and the id of the created actor Example: Request:
  { "name":"Abdullah", "age": "23", "gender": "male" } Response: { "created": 4, "success": "true" }

PATCH '/movies/int:id'

• Adds a movie
• Request Arguments: title or release date
• Returns: a success boolean and the id of the updated movie Example: Request: https://capstoneaaa.herokuapp.com/53 { "release_date": "2002" } Response: { "success": "true", "updated": 53 }

PATCH '/actors/int:id'

• Adds an actor
• Request Arguments: name, age or gender
• Returns: a success boolean and the id of the updated actor Example: Request: https://capstoneaaa.herokuapp.com/3 { "name": "Abdullah Alhomaidhi" } Response: { "success": "true", "updated": 3 }

Errors

401 "success": False, "error": 401, "message": "Unauthorized"

404 "success": False, "error": 404, "message": "Not found"

422 "success": False, "error": 422, "message": "Unprocessable Entity"

500 "success": False, "error": 500, "message": "Internal Server Error"

Testing

To run the tests, run

python test_app.py

Setting up authentication

Login link

https://dev-tps54maa.us.auth0.com/authorize? response_type=token& client_id=dvxo5t6N9MttN7wPL3878BDDiszs3cB6& redirect_uri=https://localhost/5000& scope=openid%20profile%20email& audience=http://localhost:8080

Logout link

https://dev-tps54maa.us.auth0.com/v2/logout? client_id=dvxo5t6N9MttN7wPL3878BDDiszs3cB6& returnTo=http://localhost/5000