andreweinkoetz / foodo-backend Goto Github PK

Problem:

Users which are currently registered lack some of our required attributes (e.g. dislikes, goal,..)

Severity:

No problem as it will be set during registration process.

ToDo:

• Create dump of current test db (or single collections)
• Wipe models: User, Token, AuthCode
• Test functionality, if fails restore dump

Currently, the backend provides the status code 501 (service not available). I do not think this is a very reasonable error code for failed login due to no user found.

Using a more sophisticated logging functionality than console.log would be quite nice especially when it comes to debugging the deployed backend on Amazon EB.
Possible packages:

• winston

Need an endpoint to receive the details of a specific standard recipe

As mentioned in #3 , all :id params in routes have to be replaced after we enable the authentication via the oauth-service.

The userId is only stored within the token (stored in req.body.token.token). Accessing the userId would require to access req.body.token.token.user._id
This is bad practice: To improve accessing the userId after a valid authentication, The userId should be stored in req.body.userId.

• user/:id/recipe/:id (for update)
• user/:id/recipe/ (for create)

Under ingredient: /setallergies (POST) with

{ _id: INGREDIENT_ID, notForAllergy: [ INGREDIENT_ID ] } as body

/user/recipes/substitute PUT:
{ substituteId: INGREDIENT_ID,
originalId: INGREDIENT_ID,
amount: AMOUNT_OF_SUBSTITUTE,
_id: USERRECIPE_ID }

/user/recipes/substitute DELETE:
{ historyId: ID_OF_NEW_HISTORY,
_id: USERRECIPE_ID }

Question:

Below you can find the information i extracted from the db-dump of our advisors. If you want to take a look yourself at all the models and examples - i imported their entire db into a mlab mongodb:

mlab DB import

As i am responsible for designing our db model (or at least the starting layout) please give me your feedback regarding the food attributes (long list) e.g. is that enough info? Do we need more or less?

And if you have some ideas regarding the model for recipes and ingredients (examples from advisors below) just leave a comment :-)

Thanks!

Information relevant for food attributes (nutrition values of single food items & recipes) based on data from advisors:

• Cholesterol
• Phosphorous
• VitaminABetaCarotin
• Carbohydrate
• KCal
• Copper
• DietaryFiber
• TotalFat
• VitaminB12
• Wasser
• Iron
• VitaminE
• AddedSugars
• Calcium
• Zinc
• Magnesium
• Manganese
• VitaminARetinol
• PUFA
• Folate
• Riboflavin
• Thiamine
• Protein
• Salt
• Fluoride
• Omega3
• VitaminB6
• MUFA
• AlcoholConcentrate
• VitaminC
• Iodine
• SFA
• VitaminD
• Cholesterol
• Phosphorous
• VitaminABetaCarotin
• Carbohydrate
• KCal
• Copper
• DietaryFiber
• TotalFat
• VitaminB12
• Wasser
• Iron
• VitaminE
• AddedSugars
• Calcium
• Zinc
• Magnesium
• Manganese
• VitaminARetinol
• PUFA
• Folate
• Riboflavin
• Thiamine
• Protein
• Salt
• Fluoride
• Omega3
• VitaminB6
• MUFA
• AlcoholConcentrate
• VitaminC
• Iodine
• SFA
• VitaminD

Properties of example recipes (2,100 examples):

{
    "name": String,
    "preparationTime": Time as Int32,
    "meal": Type as String (e.g. lunch),
    "ingredients":[ Array of ingredients with their food attributes ],
    "directions": [ Strings of instruction steps ],
    "foodProperties": { same as in ingredients }
    "servings": [
        // Examples:
        {
            "name": "1/2 Rezeptmenge",
            "weight": 615
        },
        {
            "name": "1 Rezeptmenge",
            "weight": 1230
        }
    ],
    "noGoNutrition": [ Strings of probably IDs (?) maybe used for allergies],
    "imgUrl": String,
    "kcal": Int32,
    "people": "ca. 1 Liter" // unclear,
    "factor": 1 // unclear
} 

Properties of example ingredient:

{
      "dataSource": "BLS", // unclear, maybe irrelevant
      "name": String,
      "foodGroup": "Other", // ?
      "foodAttributes": { nutrition values as above }
      "servings": [ as above]
}

Please comment your required endpoints and their functionality below this issue.
I will split them into multiple issues once we gathered some endpoints.

Current top-level routes are:

• /auth (for user & authentication purposes)
• /ingredient (for all queries regarding ingredients)
• /recipe (for all queries regarding recipes)

From my point of view there would be one route i would like to add:

• /auth/changepw (to enable user to change his password)
• /recipe/ (POST) with recipe as json, to insert new recipe
• /recipe/:id (GET) to receive details of a specific standard recipe

For the user profile, we need following routes to post and delete:

• user/:id/goal
• user/:id/dislike
• user/:id/allergy
• user/:id/lifestyle
• user/:id/locale (to save 'en' or 'de' as users language preference)

aggregated in issue #5

To create and update a user recipe, we need:

• user/:id/recipe/ (for update)
• user/:id/recipe/ (for create)

aggregated in issue #7

Further improvement:

All userId related endpoints will be replaced.
Reason:
The user id is provided with after validating the access token. Selection via req.params is therefore not necessary and can be replaced:

• i.e. user/:id/allergy/ will be accessible on user/allergy

See #9 for this

• user/:id/goal
• user/:id/dislike
• user/:id/allergy
• user/:id/lifestyle
• user/:id/locale (to save 'en' or 'de' as users language preference)

For @MrMaux we need the populated ingredients array of the origRecipe in the userRecipe. Meaning that in getUserRecipe we need the ingredients also of the origRecipe to be populated in order to compare how much the nutriscore has changed.

Current routes have to be renamed in order to match the current standard of apis.

e.g. instead of /recipe/:id it will be /recipes/:id

We need an endpoint to get substitutes based on our algorithm.
The endpoint should be based on /recipe.

Endpoint /recipe/substitution

=> for second prototype:

• Upper case first letter
• Change applcation into Foodo Website or Foodo App

As we display the last edited by clientId, a nicer name would be a good enhancement for the second prototype.

/ingredients/setlifestyles POST
{ _id: INGREDIENT_ID,
notForLifestyles: [ LIFESTYLE_ID ]
}

Rewrite whole document