jobquest / jobquest-be Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 223 KB

JobQuest is a text-based RPG-style campaign that aids in the job search process, while making it fun!

Home Page: https://job-quest-fe.herokuapp.com/

Python 98.92% HTML 0.41% Mako 0.66%

jobquest-be's People

Contributors

Stargazers

Watchers

jobquest-be's Issues

Endpoint - GET Completed Quests for User

Endpoint to return all quests for a user where completion_status is true

GET api/v1/users/:id/quests?completion_status=true

Response

status: 200
body: 

{
  "data":  {
      "id": "Null"
      "type": "quests",
      "attributes": { 
            "quests": [ 
                 { "id": "1",
                   "type": "active",
                   "name": "Slay the Wildabeast", 
                   "xp": "200", 
                   "encounter_req": "3",
                   "progress": "1" 
                  }, 
                 { "id": "2",
                   "type": "passive", 
                   "name": "Brew a Potion of Confidence", 
                   "xp": "200", 
                   "encounter_req": "3",
                   "progress": "1" 
                  }, 
                  { "id": "3",
                   "type": "supportive",
                   "name": "Mend A Wizard's Spellbook", 
                   "xp": "200", 
                   "encounter_req": "3",
                   "progress": "1"
                  }, 
                  { "id": "4",
                   "type": "passive", 
                   "name": "Unlock the Tome of Job Readiness", 
                   "xp": "200", 
                   "encounter_req": "3",
                   "progress": "1"
                  }, 
                  { "id": "5",
                   "type": "supportive",
                   "name": "Write A Sonnet For Inspiration", 
                   "xp": "200", 
                   "encounter_req": "3",
                   "progress": "1"
                  }, 
               ]
            }
        }
    }
}

Refactor models out of models.py and into separate py files

Currently all models live in models.py - it would be great to abstract this out into separate model files for readability.

Create Monster Microservice

Decide whether to use Crystal or Flask
Connect to D&D API

Initialize BE Repo

Start a blank repo that is under the organization of JobQuest

Endpoint - GET Current Quests for User

Create endpoint to GET Current Quests for User

Request

GET api/v1/users/:id/quests?completion_status=false

Response

status: 200
body: 

{
  "data":  {
      "id": "Null",
      "type": "quests",
      "attributes": { 
            "quests": [ 
                 { "id": "1",
                   "type": "active",
                   "name": "Slay the Wildabeast", 
                   "xp": "200", 
                   "encounter_req": "3",
                   "level": "1",
                   "progress": "1"
                  }, 
                 { "id": "2",
                   "type": "passive", 
                   "name": "Brew a Potion of Confidence", 
                   "xp": "200", 
                   "encounter_req": "3"
                   "level": "1",
                   "progress": "2"
                  }, 
                  { "id": "3",
                   "type": "supportive",
                   "name": "Mend A Wizard's Spellbook", 
                   "xp": "200", 
                   "encounter_req": "3"
                   "level": "1",
                   "progress": "1"
                  }, 
               ]
            }
        }
    }
}

Endpoint returns all quests associated with a specific user (user_quests) where completion_status equals false

Deploy to Heroku & Integrate Travis CI

Endpoint - GET User by email

Create endpoint to GET user by email

Request

GET api/v1/users
{ 
  "email": "[email protected]"
}

Response

status: 200
body: 

{
  "data":  {
      "type": "users",
      "id": "1",
      "attributes": {
          "email": "[email protected]",
          "username": "NihilisticWaffle"
          "xp": "10000"
       }
    }
}

New User Needs to Automatically Generate 1st 3 Quests

When a User hits the GET /api/v1/users/1/quests?completion_status= endpoint for the first time, we need to generate the first 3 UserQuest records - one for each type of Quest at level = 1

Refactor to use custom methods from Models

Go through code and eliminate duplicate code

Complete Adding Data Resources & Seeding Database

Add all the data resources needed for quests, encounters & actions
Import/seed database via CSV file

Endpoint GET '/api/v1/users`

Endpoint to return all encounters associated with a particular quest

GET api/v1/users

Response

status: 200
body: 

{
  "data":  {
      "id": "None"
      "type": "users",
      "attributes": [
             { 
                 "id": "1",
                 "username": "iandouglas",  
                 "email":  "[email protected]",
                 "xp": 0
            },
            { 
                 "id": "2",
                 "username": "shaunda",  
                 "email":  "[email protected]",
                 "xp": 300
            },
            { 
                 "id": "3",
                 "username": "olga",  
                 "email":  "[email protected]",
                 "xp": 400
            },
           ....
      ]
      }
}

Update PATCH User Quests to Generate New Quests

Generate New Quest:

The endpoint for PATCH /api/v1/users/:id/quests needs to generate a UserQuest record which replaces quests when completion_status is changed to True.
The new UserQuest record should have the quest_id for the Quest of the same type AND the next level

Increase User XP

A User's xp should be increased by the Quest xp when a completion_status is changed to True

Setup Environment for Python/Flask

Install pyenv brew install pyenv
Install python (v3.9) pyenv install 3.9.1 pyenv global 3.9.1
Install pip (v3)
Install flask (v1.1)
Determine other gems & dependencies we might need

Endpoint - PATCH Quest for User

Create endpoint for PATCH Quest for User
Endpoint updates progress with the number of encounter the user is currently on, EX. 1 of 3, 2 of 3, 3 of 3.
When the patch request includes a 4, the user_quest is marked completed

Request (Still in Progress)

PATCH api/v1/users/:id/quests 
body: 

{
"quest_id": "1", 
"progress": "2"  
}

Response

status: 201
body: 

{
  "data":  {
      "id": "1",
      "type": "user_quests",
      "attributes": { 
            "response": "successful", 
            "progress": "2", 
            "completion_status": "false"
        }
    }
}

Request (Complete)

PATCH api/v1/users/:id/quests 
body: 

{
"quest_id": "1", 
"progress": "3"  
}

Response

status: 201
body: 

{
  "data":  {
      "id": "1",
      "type": "user_quests",
      "attributes": { 
            "response": "successful", 
            "progress": "3",
            "completion_status": "true"
        }
    }
}

Add model level testing

Add model level testing for the following models:

BUG - User Can Generate First 3 Quests Multiple Times

Describe the bug
When we hit the endpoint api/v1/users/2/quests?completion_status=false, even when we already have the first 3 quests assigned, we are getting those reassigned again. It should be the first time, when the user has 0 user-quest records, that we generate the first 3 quests.

Endpoint - GET Encounters for Quest by Progress

Endpoint to return all encounters associated with a particular quest

GET api/v1/quests/:id/encounters?progress=1

Response

status: 200
body: 

{
  "data":  {
      "id": "1"
      "type": "encounters",
      "attributes": { 
                 "progress": "1",
                 "monster_image": "some_url_path_here",  
                 "actions": [
                       { "id": "1",
                          "description": "Apply to 1 Job" 
                       }, 
                       { "id": "2", 
                          "description": "Attend A Networking Event" 
                       }     
                  ]      
            }
      }
}

Construct Schema Design

All tables and attributes determined on the schema

Create outline for README
Explain what the App does
Link all members:
- [ ] emails
- [ ] linkedIn profiles
- [ ] GitHub accounts
Add endpoints
Add instructions for installation
List out technology/ dependencies for the project
Add images/links from Postman
- [ ] Sad path
- [ ] Happy path

Decide on Git Workflow Style

Rebase
Merge

jobquest / jobquest-be Goto Github PK

jobquest-be's People

Contributors

Stargazers

Watchers

jobquest-be's Issues

Recommend Projects

Recommend Topics

Recommend Org