Skip to content

Latest commit

 

History

History
443 lines (311 loc) · 10.5 KB

README.md

File metadata and controls

443 lines (311 loc) · 10.5 KB
Raw

Casting Agency

Casting Agency is a company that is responsible for creating movies and managing movies and assigning actors with different roles. there are three different roles which are Assistant role, Director Role and Producer role,all have different permissions to perform actions on database

Here is hosted heroku Link

Motivation for project

This is my Last project of Full stack nano degree program by Udacity

Reference :

https://github.com/udacity/FSND/blob/master/BasicFlaskAuth/app.py
https://github.com/cr21/cr-casting-agency

Project Dependencies

Python 3

Install letest version of python3 [here] (https://www.python.org/downloads/)

Virtual Enviornment

In my code i have created conda virtual enviornment because of some issues in my machine. check here to create virtual enviornment in conda

you can create python virtual environment.Instruction for create virtual enviornment is [here] (https://docs.python.org/3/tutorial/venv.html)

Example in my code :

conda create -n myenv python=3.6

source activate myenv

For python virtual enviornment setup you can do following in your terminal

python3 -m venv env source env/bin/activate

for more details check [this] (https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)

After creating virtual environment hit following command to install project requirements.

pip install -r requirements.txt

Database Setup

Set the following environmental variable for Auth0 in setup.sh file if you run project locally and for heroku you can set all this variables in heroku dashboard.

# you have to replace following details with your setup.
export DATABASE_URL='postgres://postgres:1234@localhost:5432/casting_fsnd'
export TEST_DATABASE_URL='postgres://postgres:1234@localhost:5432/casting_test_fsnd'
export AUTH0_DOMAIN='tagadiya.auth0.com'
export ALGORITHMS=['RS256']
export API_AUDIENCE='casting'

export assistant='Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkJhU1ZlUFRRaXBFX2hVd2hNRUFqUyJ9.eyJpc3MiOiJodHRwczovL3RhZ2FkaXlhLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZWU3NWM3MTBmZjUwMjAwMTM3ZjgwMzIiLCJhdWQiOiJjYXN0aW5nIiwiaWF0IjoxNTkyMzg3MTkzLCJleHAiOjE1OTI0NzM1OTIsImF6cCI6IjZzbkNUcXdVZFBKVzJNRExmSlBsOGFtcHAzWWVJUkpjIiwic2NvcGUiOiIiLCJwZXJtaXNzaW9ucyI6WyJnZXQ6YWN0b3JzIiwiZ2V0Om1vdmllcyJdfQ.UGN5AXZe4SQ9o2fZ6SK1vfuxzf2rAkuSbccujz64nO3Irj6BQuZtrsTEkIeAXq5PNEYrHC-QTX4I-rWh7KRNBLZuhJ5bolz6vtL-b5cDzQJoZCpoMJLQtNVMPTgwkXggn0lRsahi_ICULx9HuMki7YuKOtfRzYSzxHZWGobb04fyvFCWR-UHmhSj-xay4B_hnFqqA9rjAgkqZXqdQyOvjVouCya382YJJRpHtbavJ5yfzDqk_i_hv07sYLZXTh4FzjpzZIeTFrm3axPCyLc09B7-J_uhpCPqxY280otKMN3mEQeAgwXpfgv9A8l_h0kF8oVTaEACueWdJaiKzuHM8g' 

export director='Bearer
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkJhU1ZlUFRRaXBFX2hVd2hNRUFqUyJ9.eyJpc3MiOiJodHRwczovL3RhZ2FkaXlhLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZWU3NWQ0ODBmZjUwMjAwMTM3ZjgxNGMiLCJhdWQiOiJjYXN0aW5nIiwiaWF0IjoxNTkyMzg3MzYwLCJleHAiOjE1OTI0NzM3NTksImF6cCI6IjZzbkNUcXdVZFBKVzJNRExmSlBsOGFtcHAzWWVJUkpjIiwic2NvcGUiOiIiLCJwZXJtaXNzaW9ucyI6WyJkZWxldGU6YWN0b3JzIiwiZ2V0OmFjdG9ycyIsImdldDptb3ZpZXMiLCJwYXRjaDphY3RvcnMiLCJwYXRjaDptb3ZpZXMiLCJwb3N0OmFjdG9ycyJdfQ.F_iVCn2zqDW3dB_zzMeZwL0G1oGtuSpDULa3VXONugJPPJqdxzvHgVhykzS8odx9PLe65FKPiWDie93YxwA_NpbnUcYGGTGBnWj7cmTDr0RXeDK2BDi5lkaWmS_p09zrU0NQoNQ7-lVuqS6qOcuYd0Oy4L-iRRQbUKgrmLg9q23HsQ9rnP6eU6gnKUVd3ZeG2Uz8EVCholiG2nq1D5cRcfc6nDHuvTQtSD3kzwVYjE6CXj4q4c0yxskAjXXxQzx2d8Q3aIPS3ou8OQs4InoWj45jxr6re9wZtFhYddQQXPg1CdYPmkcCtxtMVfxEOPTb1KQv4vMeVEkWUq5R2jKI7Q'

export producer='Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkJhU1ZlUFRRaXBFX2hVd2hNRUFqUyJ9.eyJpc3MiOiJodHRwczovL3RhZ2FkaXlhLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZWU3NWUyOTkyMmQxMzAwMTkxODdmZWMiLCJhdWQiOiJjYXN0aW5nIiwiaWF0IjoxNTkyMzg3NDM5LCJleHAiOjE1OTI0NzM4MzgsImF6cCI6IjZzbkNUcXdVZFBKVzJNRExmSlBsOGFtcHAzWWVJUkpjIiwic2NvcGUiOiIiLCJwZXJtaXNzaW9ucyI6WyJkZWxldGU6YWN0b3JzIiwiZGVsZXRlOm1vdmllcyIsImdldDphY3RvcnMiLCJnZXQ6bW92aWVzIiwicGF0Y2g6YWN0b3JzIiwicGF0Y2g6bW92aWVzIiwicG9zdDphY3RvcnMiLCJwb3N0Om1vdmllcyJdfQ.YjztTrx8Jx5rqjFMUQdLxRcS_ksEl0X-c2QAJFkWdVDE2CgLTwTqZ8YSwAzwo6rd8WMk4Gqn9Kv1GVq0_4WPOhRqtURDjZoYoQ-2weL-pJilRunIIJV9rFFYmjebzwL7wXlgYeRr1LgkiXAXdzEMGN2oMyFeNVxzpAhqIDClhcYDtX_YBzh6w4fAAd1rstB5bNdEZa42tXJSdRuXOQT61DvPOqJcXhAZDAiPfmJ7kpH10zSpoZIu9rWaftChftkHCVLz27Sd-iiZWBVuaI_5mmw-5ujIOof81CPWO7i-eeTZey9RA1ElKe8-sVhHVkx34HxVycBbChlb7MuplTYKYQ'

Run server

hit python3 app.py in your working directory

Task for Setup Auth0

  1. Create a new Auth0 Account

  2. Select a unique tenant domain

  3. Create a new, single page web application

  4. Create a new API

    • in API Settings:
      • Enable RBAC
      • Enable Add Permissions in the Access Token

  5. Create new API permissions:

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

  6. Create new roles for:

    • Assistant

      • Can view all actors and all 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

  7. Endpoints

Authentication

The API has three registered users:

  1. Assistant
email: assistant@gmail.com
password: Assistant@123
  1. Director
email: director.casting@gmail.com
password: Director@123
  1. Producer
email: executive.producer@gmail.com
password: Executive@123

The Auth0 domain and api audience can be found in setup.sh.

Endpoints

GET POST PATCH DELETE

GET ‘/movies’ 
 
- get a List of all Available Movies

http://0.0.0.0:8080/movies

Response:
{
  "movies": [
    {
      "id": 1,
      "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
      "title": "Jannat"
    },
    {
      "id": 2,
      "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
      "title": "Partner"
    },
    {
      "id": 3,
      "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
      "title": "Super 30"
    },
    {
      "id": 4,
      "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
      "title": "Avengers-End game"
    }
  ],
  "status_code": 200,
  "success": true,
  "total_record": 4
}



GET ‘/actors’

- Get a List of all Available Actors

Request : 

http://0.0.0.0:8080/actors

Response:

{
  "actors": [
    {
      "age": 39,
      "gender": "Male",
      "id": 1,
      "name": "Emraan Hashmi"
    },
    {
      "age": 50,
      "gender": "Male",
      "id": 2,
      "name": "salman khan"
    },
    {
      "age": 40,
      "gender": "Male",
      "id": 3,
      "name": "Hrithik Roshan"
    },
    {
      "age": 45,
      "gender": "Male",
      "id": 4,
      "name": "Tony Starc"
    }
  ],
  "status_code": 200,
  "success": true,
  "total_record": 4
}



GET ‘/movies/<int:movie_id>’

- Get a List of Movies for given id  in request

Request: 

http://0.0.0.0:8080/movies/3/details

Response:
{
  "movie": {
    "actor": {
      "age": 40,
      "gender": "Male",
      "id": 3,
      "name": "Hrithik Roshan"
    },
    "id": 3,
    "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
    "title": "Super 30"
  },
  "status_code": 200,
  "success": true
}


GET ‘/actors/<int:actor_id>’

- get a List of Actors for specific id parameter in request.

Request :

http://0.0.0.0:8080/actors/4/details

Response:

{
  "actor": {
    "age": 45,
    "gender": "Male",
    "id": 4,
    "movies": [
      {
        "id": 4,
        "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
        "title": "Avengers-End game"
      }
    ],
    "name": "Tony Starc"
  },
  "status_code": 200,
  "success": true
}

DELETE ‘/movies/<int:movie_id>’

- Delete Movie with specific Movie id

Request :

http://0.0.0.0:8080/movies/1

Response :

{
   "movie_id": 1,
   "status_code": 200,
   "success": true
}


DELETE ‘/actors/<int:actor_id>’
- Delete Actor with specific Actor id

Request  :

http://0.0.0.0:8080/actors/1

Response :

{
   "actor_id": 1,
   "status_code": 200,
   "success": true
}


POST '/actors'
- This endpoint is used for creating new actor

Request body:
{
  "name":"sapna pabbi",
  "age":28,
  "gender": "Female"
}
Give Authorization : 'Bearer TOKEN'
    
Returns:

  {
    "actor": {
      "age": 28,
      "gender": "Female",
      "id": 5,
      "name": "sapna pabbi"
    },
    "message": "sapna pabbi created",
    "status_code": 200,
    "success": true
  }
  

POST: /Movies

- This endpoint is used for creating new Movie

Request :

http://0.0.0.0:8080/movies
 
Request body:
{
    "title":"Inside Age",
    "release_date": "{{current_timestamp}}",
    "actor_id":2
  }

Add Authorization : 'Bearer TOKEN'
  
Returns:
   
   {
  "Movie": {
    "id": 5,
    "release_date": "Wed, 17 Jun 2020 09:12:09 GMT",
    "title": "Inside Age"
  },
  "message": "Inside Age created",
  "status_code": 200,
  "success": true
}


PATCH ‘/movies/<int:movie_id>’

- EDIT  Movie for given particular id parameter in request

Request :

http://0.0.0.0:8080/movies/2

Give Authorization Header : 'Bearer Token'

Request body:
{
    "title":"Inaside age 2"
}

Response:

{
  "movie": {
    "id": 2,
    "release_date": "Wed, 17 Jun 2020 00:00:00 GMT",
    "title": "Inaside age 2"
  },
  "status_code": 200,
  "success": true
}

  1. Testing with pytest

    • You can also run unit tests by opening your terminal
    • run : python3 test_app.py

  2. you can check all endpoints with postman for heroku deployed app

  3. For Deployment on Heroku follow below considered steps

  • cd into your project directory
  • run following commands first just for assure.
 1. python manage.py db init
 2. python manage.py db migrate
 3. python manage.py db upgrade
 4. pip freeze > requirements.txt
 5. commit and push all your changes on github
 6. heroku create name_of_your_app
 7. git remote add heroku heroku_git_url
 8. heroku addons:create heroku-postgresql:hobby-dev --app name_of_your_application
 9. heroku config --app name_of_your_application
 10.Go to heroku dashboard and go to app > setting > Reveal Config Vars and configure all environment variables which are given in setup.sh
 11.git push heroku master
 12.heroku run python manage.py db upgrade --app name_of_your_application

And now you have a live application! Open the application from your Heroku Dashboard and see it work live! Make additional requests using curl or Postman as you build your application and make more complex endpoints.