Create favoriting endpoint and corresponding docs

Author: erganemic

README.md

@@ -47,4 +47,5 @@ And send requests to http://$SERVER\_IP:5000
 * [Pantry](pantry.md) : `/v1/pantry/`
 * [Photos](photos.md) : `/v1/photos/`
 * [Exp](exp.md) : `/v1/exp/`
+* [Favorite](favorite.md) : `/v1/favorite/`
 

favorite.md

@@ -0,0 +1,172 @@
+
+# API Reference: Favorite
+
+The Favorite API supports basic CRUD operations favorited recipes
+
+## Register
+
+Used to create a new favorite recipe
+
+**URL** : `/v1/favorite/create/<username>`
+
+**Methods** : `POST`
+
+**Auth required** : YES
+
+**Data constraints**
+
+```json
+{
+    "recipe_name": "recipe name",
+    "recipe_id": "unique recipe id",
+    "picture": "url of recipe picture"
+}
+```
+
+**Data example**
+
+```json
+{
+    "recipe_name": "chicken",
+    "recipe_id": "400",
+    "picture": "google.com"
+}
+```
+
+### Success Response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+{
+    "recipe_name": "chicken",
+    "recipe_id": "400",
+    "picture": "google.com"
+}
+```
+
+### Error Response
+
+**Condition** : If <username> can't be found
+
+**Code** : `404 Not Found`
+
+**Content** :
+
+```json
+{
+    "error": "requested user not found"
+}
+```
+
+**Condition** : If favorite recipe couldn't be created or saved
+
+**Code** : `400 BAD REQUEST`
+
+**Content** :
+
+```json
+{
+    "error": "could not favorite requested recipe"
+}
+```
+
+
+## Read
+
+Used to get all favorite recipes associated with a given user
+
+**URL** : `/v1/favorite/<username>`
+
+**Methods** : `GET`
+
+**Auth required** : YES
+
+### Success Response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+{
+    "favorites": [{
+        "picture": "google.com",
+        "recipe_id": 400,
+        "recipe_name": "chicken"
+    }, {
+        "picture": "google.com",
+        "recipe_id": 401,
+        "recipe_name": "chicken"
+    }, {
+        "picture": "google.com",
+        "recipe_id": 402,
+        "recipe_name": "chicken"
+    }]
+}
+```
+
+### Error Response
+
+**Condition** : If <username> can't be found
+
+**Code** : `404 Not Found`
+
+**Content** :
+
+```json
+{
+    "error": "requested user not found"
+}
+```
+
+
+## Delete
+
+Removes favorited recipe from the database for a particular user
+
+**URL** : `/v1/favorite/delete/<username>?recipe_id=<recipe_id>`
+
+**Methods** : `DELETE`
+
+**Auth required** : YES
+
+### Success Response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+{
+    "deleted": "<recipe_id>"
+}
+```
+
+### Error Response
+
+**Condition** : If the username passed does not correspond to a user in the db
+
+**Code** : `404 NOT FOUND`
+
+**Content** :
+
+```json
+{
+    "error": "requested user not found"
+}
+```
+
+**Condition** : The requested favorited recipe could not be deleted
+
+**Code** : `400 BAD REQUEST`
+
+**Content** :
+
+```json
+{
+    "error": "Deletion unsuccessful"
+}
+```

lastMeal/__init__.py

@@ -41,4 +41,7 @@ def create_app(test_config=None):
     from lastMeal.api.v1 import recipe
     app.register_blueprint(recipe.bp)
 
+    from lastMeal.api.v1 import favorite
+    app.register_blueprint(favorite.bp)
+
     return app

lastMeal/api/v1/favorite.py

@@ -0,0 +1,70 @@
+from flask import (
+    Blueprint, flash, g, redirect, render_template, request, session, url_for, make_response, Response
+)
+import json
+from lastMeal.models.user import User
+from lastMeal.models.favorite import Favorite
+from bson.objectid import ObjectId
+
+from flask_jwt_extended import get_jwt_identity
+from flask_jwt_extended import jwt_required
+import requests
+
+bp = Blueprint('favorite', __name__, url_prefix='/v1/favorite')
+
+@bp.route('/create/<username>', methods=['POST'])
+#@jwt_required()
+def create_favorite(username):
+#    if (username != get_jwt_identity()):
+#        return ({"error": "unauthorized"}, 401)
+
+    request_data = request.json
+    user = User.objects(username=username).first()
+    if user == None:
+        return ({"error": "requested user not found"}, 404)
+    recipe_id = request_data["recipe_id"]
+    if Favorite.objects(recipe_id=recipe_id).first() != None:
+        return ({"error": "can't favorite a recipe twice"}, 400)
+    recipe_name = request_data["recipe_name"]
+    picture = request_data["picture"]
+
+    try:
+        my_favorite = Favorite(user=user, recipe_id=recipe_id, recipe_name=recipe_name, picture=picture)
+        my_favorite.save()
+        return ({"recipe_name": recipe_name, "recipe_id": recipe_id, "picture": picture}, 201)
+    except Exception as e:
+        print(e)
+        return ({"error": "could not favorite requested recipe"}, 400)
+
+@bp.route('/delete/<username>', methods=["DELETE"])
+#@jwt_required()
+def delete_favorite(username):
+#    if (username != get_jwt_identity()):
+#        return ({"error": "unauthorized"}, 401)
+
+    recipe_id = request.args.get("recipe_id")
+
+    user = User.objects(username=username).first()
+    if user == None:
+        return ({"error": "requested user not found"}, 404)
+
+    try:
+        Favorite.objects(user=user, recipe_id=recipe_id).delete()
+        return ({"deleted": recipe_id}, 200)
+    except Exception as e:
+        print(e)
+        return ({"error": "Deletion unsuccessful"}, 400)
+
+@bp.route('/<username>', methods=["GET"])
+#@jwt_required()
+def read_favorite(username):
+#    if (username != get_jwt_identity()):
+#        return ({"error": "unauthorized"}, 401)
+    user = User.objects(username=username).first()
+    if user == None:
+        return ({"error": "requested user not found"}, 404)
+    favorites = Favorite.objects(user=user)
+    info_list = []
+    for item in favorites:
+        info_list.append({"picture": item.picture, "recipe_id": int(item.recipe_id), "recipe_name": item.recipe_name})
+    return ({"favorites": info_list}, 200)

lastMeal/models/favorite.py

@@ -0,0 +1,11 @@
+from mongoengine import *
+from mongoengine.errors import ValidationError
+from lastMeal.models.user import User
+
+connect('lastMeal')
+
+class Favorite(Document):
+    recipe_id = DecimalField(required=True, unique=True)
+    recipe_name = StringField(max_length=100, required=True)
+    picture = StringField(max_length=100, required=True)
+    user = ReferenceField(User, required=True)

pantry.md

@@ -176,7 +176,7 @@ Used to change the contents of an ingredient item
 
 Removes ingredient from the database
 
-**URL** : `/v1/pantry/delete/<ingredient_id>`
+**URL** : `/v1/pantry/delete/<username>?ingredient=<ingredient_id>`
 
 **Methods** : `DELETE`