Capstone-FSND

Project Casting Agency Site -- Final project to complete the Full Stack Nanodegree from Udacity

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

In this application you can:

1. Dispaly Actors/Movies
2. Delete Actors/Movies
3. Add new Actors/Movies
4. Edit existing Actors/Movies

We are always working on enchancing the users' experience and we are always welcoming your improvments.

Want to fix a bug? Or perhaps, add a feature?

If you are intrested in contributing into improving our application then kindly read the following:

• Follow the PEP8 style guide
• Our API follows the RESTFull principles

Dependancies

-Python 3

To install the requirements , in the root directory run pip install -r requirements.txt

Backend

To run the application locally

Note 1: you can create a local Postgres database for the main app to run using the command createdb capstone and update the URI for the database in the code.

Note 2: On the first run in app.py uncomment these two lines:

with app.app_context():
   db_drop_and_create_all()

In the root directory run bash setup.sh then run flask run --reload or manually run the following commands: bash:

export FLASK_APP=app
export FLASK_ENV=development
flask run --reload

=================================== or PowerShell:

$env:FLASK_APP="app"
$env:FLASK_DEBUG="true"
flask run --reload`

If you get an error ModuleNotFoundError instead of running flask run --reload try running python -m flask run this can help ensure that Python treats the project_directory as the root directory for imports.

Testing

You MUST have a local database for tests,to create a one run the command createdb capstone_test. In the root directory of the project run python test_app.py The test file will automatically fill the database and drop all the tables after it is done.

API Documentation

Getting Started

Base URL: (hosted on Render) https://capstone-fsnd.onrender.com || (running locally) https://localhost:5000/

Authentication

There is three roles in this application and it is required to have the apropiate role to use the endpoints

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

You need to set the environment variable to use with your Bearer token:

bash:

export TOKEN=YOUR_TOKEN

or PowerShell:

$env:TOKEN=YOUR_TOKEN

Error Handling

We are using HTTP response codes to indicate the success or failure of an API request. The responses are formated in JSON indicating that a failure happend and showing the error code and message.

Example:

{
    'success': False,
    'error_code': 404,
    'message': 'resource not found'
}

Errors that might be returned:

-400: Bad Request

-404: Resource Not Found

-405: Method Not Allowed

-422: Not Processable

Endpoint Library

GET /health

Shows the state of the application.

curl https://capstone-fsnd.onrender.com/health

Response Example:

Up and Running!

GET /actors | GET /movies

The response indicates the succes of the request and retreaves a list of all actors/movies paginated and limited to 10 actors/movies per page.

• Request Arguments (optional): /?page=<page_number>
• Returns: The list of actors/movies with a maximum of 10 actors/movies each actor with (id, name, gender, age), each movie with (id, title, release_date) Total number of actors/movies Current page number

Request URL example:

curl -H "Authorization: Bearer $TOKEN" https://capstone-fsnd.onrender.com/movies?page=2

Response Example:

{
  "current_page": 2,
  "movies": [
    {
      "id": 11,
      "release_date": "Fri, 11 Jun 1993 00:00:00 GMT",
      "title": "Jurassic Park"
    },
    {
      "id": 12,
      "release_date": "Fri, 18 Dec 2009 00:00:00 GMT",
      "title": "Avatar"
    }
  ],
  "success": true,
  "total_movies": 17
}

DELETE /actor/<actor_id> | DELETE /movie/<movie_id>

Deletes the actor/movie of the given ID

• Request Arguments: /<item_id>
• Returns: ID of the deleted item with the total number of remaining items

Request URL example:

curl -X DELETE -H "Authorization: Bearer $TOKEN" https://capstone-fsnd.onrender.com/movies/5

Response Example:

{
  "deleted": "5",
  "success": true,
  "total_movies": 16
}

POST /actors | POST /movies

Add a new actor/movie

• Request Arguments: for a new actor: name, gender, age for a new movie: title, release_date
• Returns: The added item id and the updated total number of existing items

Request URL example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" -d '{"name": "Leonardo DiCaprio", "age": 48, "gender": "Male"}' https://capstone-fsnd.onrender.com/actors

Response Example:

{
  "added": 18,
  "success": true,
  "total_movies": 17
}

PATCH /actor/<actor_id> | PATCH /movie/<movie_id>

Updates an existing actor/movie partially

• Request Arguments (at least one of the following): for a new actor: name, gender, age for a new movie: title, release_date
• Returns: The updated item

Request URL example:

curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" -d '{"age": 22}' https://capstone-fsnd.onrender.com/actors/3

Response Example:

{
  "success": true,
  "updated": {
    "age": 22,
    "gender": "Male",
    "id": 3,
    "name": "Some actor"
  }
}