✨ (Flask-Smorest) Add start/end code for lectures in this section

Author: jslvtr

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/README.md

@@ -0,0 +1,13 @@
+---
+title: "Improvements to our first REST API"
+description: "Let's add a few routes to our first REST API, so it better matches what a production REST API would look like."
+---
+
+# Improvements to our first REST API
+
+- [ ] Set metadata above
+- [ ] Start writing!
+- [ ] Create `start` folder
+- [ ] Create `end` folder
+- [ ] Write TL;DR
+- [ ] Create per-file diff between `end` and `start` (use "Compare Folders")

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/end/.flaskenv

@@ -0,0 +1,2 @@
+FLASK_APP=app
+FLASK_ENV=development

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/end/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.10
+EXPOSE 5000
+WORKDIR /app
+COPY ./requirements.txt requirements.txt
+RUN pip install --no-cache-dir --upgrade -r requirements.txt
+COPY . .
+CMD ["flask", "run", "--host", "0.0.0.0"]

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/end/app.py

@@ -0,0 +1,124 @@
+import uuid
+from flask import Flask, request
+from flask_smorest import abort
+
+from db import stores, items
+
+
+app = Flask(__name__)
+
+
+@app.get("/items/<string:id>")
+def get_item(item_id):
+    try:
+        return items[item_id]
+    except KeyError:
+        abort(404, message="Item not found.")
+
+
+@app.delete("/items/<string:id>")
+def delete_item(item_id):
+    try:
+        del items[item_id]
+        return {"message": "Item deleted."}
+    except KeyError:
+        abort(404, message="Item not found.")
+
+
+@app.put("/items/<string:id>")
+def update_item(item_id):
+    item_data = request.get_json()
+    # There's  more validation to do here!
+    # Like making sure price is a number, and also both items are optional
+    # Difficult to do with an if statement...
+    if "price" not in item_data or "name" not in item_data:
+        abort(
+            400,
+            message="Bad request. Ensure 'price', and 'name' are included in the JSON payload.",
+        )
+    try:
+        item = items[item_id]
+
+        # https://blog.teclado.com/python-dictionary-merge-update-operators/
+        item |= item_data
+
+        return item
+    except KeyError:
+        abort(404, message="Item not found.")
+
+
+@app.get("/items")
+def get_all_items():
+    return {"items": list(items.values())}
+
+
+@app.post("/items")
+def create_item():
+    item_data = request.get_json()
+    # Here not only we need to validate data exists,
+    # But also what type of data. Price should be a float,
+    # for example.
+    if (
+        "price" not in item_data
+        or "store_id" not in item_data
+        or "name" not in item_data
+    ):
+        abort(
+            400,
+            message="Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.",
+        )
+    for item in items.values():
+        if (
+            item_data["name"] == item["name"]
+            and item_data["store_id"] == item["store_id"]
+        ):
+            abort(400, message=f"Item already exists.")
+
+    item_id = uuid.uuid4().hex
+    item = {**item_data, "id": item_id}
+    items[item_id] = item
+
+    return item
+
+
+@app.get("/stores/<string:id>")
+def get_store(store_id):
+    try:
+        # You presumably would want to include the store's items here too
+        # More on that when we look at databases
+        return stores[store_id]
+    except KeyError:
+        abort(404, message="Store not found.")
+
+
+@app.delete("/stores/<string:id>")
+def delete_store(store_id):
+    try:
+        del stores[store_id]
+        return {"message": "Store deleted."}
+    except KeyError:
+        abort(404, message="Store not found.")
+
+
+@app.get("/stores")
+def get_all_stores():
+    return {"stores": list(stores.values())}
+
+
+@app.post("/stores")
+def create_store():
+    store_data = request.get_json()
+    if "name" not in store_data:
+        abort(
+            400,
+            message="Bad request. Ensure 'name' is included in the JSON payload.",
+        )
+    for store in stores.values():
+        if store_data["name"] == store["name"]:
+            abort(400, message=f"Store already exists.")
+
+    store_id = uuid.uuid4().hex
+    store = {**store_data, "id": store_id}
+    stores[store_id] = store
+
+    return store

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/end/db.py

@@ -0,0 +1,12 @@
+"""
+db.py
+---
+
+Later on, this file will be replaced by SQLAlchemy. For now, it mimics a database.
+Our data storage is:
+    - stores have a unique ID and a name
+    - items have a unique ID, a name, a price, and a store ID.
+"""
+
+stores = {}
+items = {}

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/end/requirements.txt

@@ -0,0 +1,2 @@
+flask
+python-dotenv

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/start/Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.10
+EXPOSE 5000
+WORKDIR /app
+RUN pip install flask
+COPY . .
+CMD ["flask", "run", "--host", "0.0.0.0"]

docs/docs/05_flask_smorest/02_improvements_on_first_rest_api/start/app.py

@@ -0,0 +1,57 @@
+import uuid
+from flask import Flask, request
+
+app = Flask(__name__)
+
+stores = {}
+items = {}
+
+
+@app.get("/item/<string:id>")
+def get_item(id):
+    try:
+        return items[id]
+    except KeyError:
+        return {"message": "Item not found"}, 404
+
+
+@app.post("/items")
+def create_item():
+    request_data = request.get_json()
+    new_item_id = uuid.uuid4().hex
+    new_item = {
+        "name": request_data["name"],
+        "price": request_data["price"],
+        "store_id": request_data["store_id"],
+    }
+    items[new_item_id] = new_item
+    return new_item
+
+
+@app.get("/items")
+def get_all_items():
+    return {"items": list(items.value())}
+
+
+@app.get("/stores/<string:id>")
+def get_store(id):
+    try:
+        # Here you might also want to add the items in this store
+        # We'll do that later on in the course
+        return stores[id]
+    except KeyError:
+        return {"message": "Store not found"}, 404
+
+
+@app.post("/stores")
+def create_store():
+    request_data = request.get_json()
+    new_store_id = uuid.uuid4().hex
+    new_store = {"id": new_store_id, "name": request_data["name"]}
+    stores[new_store_id] = new_store
+    return new_store, 201
+
+
+@app.get("/stores")
+def get_all_stores():
+    return {"stores": list(stores.value())}

docs/docs/05_flask_smorest/03_api_with_method_views/README.md

@@ -0,0 +1,16 @@
+---
+title: How to use Blueprints and MethodViews
+description: Flask-Smorest MethodViews allow us to simplify API Resources by defining all methods that interact with the resource in one Python class.
+---
+
+# How to use Flask-Smorest MethodViews and Blueprints
+
+- [ ] Set metadata above
+- [ ] Start writing!
+- [ ] Create `start` folder
+- [ ] Create `end` folder
+- [ ] Write TL;DR
+- [ ] Create per-file diff between `end` and `start` (use "Compare Folders")
+
+## Adding MethodViews and to our application
+

docs/docs/05_flask_smorest/03_api_with_method_views/end/.flaskenv

@@ -0,0 +1,2 @@
+FLASK_APP=app
+FLASK_ENV=development