add examples/complete_db

Author: thnee

examples/complete_db/__init__.py

@@ -0,0 +1 @@
+from .app import create_app

examples/complete_db/app.py

@@ -0,0 +1,29 @@
+from complete_db.ext import af, db, ma
+from flask import Flask
+from werkzeug.utils import import_string
+
+
+def create_app(conf=None):
+    app = Flask(__name__)
+
+    if not conf:
+        conf = "base"
+
+    config = import_string(f"complete_db.conf.{conf.lower()}")()
+    app.config.from_object(config)
+
+    db.init_app(app)
+    ma.init_app(app)
+    af.init_app(app, db)
+
+    app.errorhandler(af.ApiError)(af.api_error_handler)
+
+    with app.app_context():
+        from complete_db import blueprints  # noqa
+        from complete_db import models  # noqa
+
+        db.create_all()
+
+    app.register_blueprint(blueprints.api_v1.bp, url_prefix="/v1")
+
+    return app

examples/complete_db/blueprints/__init__.py

@@ -0,0 +1 @@
+from . import api_v1

examples/complete_db/blueprints/api_v1/__init__.py

@@ -0,0 +1,2 @@
+from . import urls
+from .blueprint import bp

examples/complete_db/blueprints/api_v1/blueprint.py

@@ -0,0 +1,7 @@
+import flask
+
+
+bp = flask.Blueprint(
+    name="api_v1",
+    import_name="api_v1",
+)

examples/complete_db/blueprints/api_v1/schemas.py

@@ -0,0 +1,61 @@
+from complete_db.ext import ma
+from complete_db.models import Author, Book
+
+
+class AuthorSchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = Author
+        load_instance = True
+
+    id = ma.Integer(dump_only=True)
+    name = ma.String()
+
+
+class AuthorsBooksListKwargsSchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = Author
+        load_instance = True
+
+    id = ma.auto_field(data_key="author_id", required=True)
+
+
+class BookListSchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = Book
+        load_instance = True
+
+    id = ma.Integer()
+    author = ma.Nested(AuthorSchema())
+    title = ma.String()
+    year = ma.Integer()
+    description = ma.String()
+
+
+class BookCreateSchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = Book
+        load_instance = True
+
+    author_id = ma.Integer(required=True)
+    title = ma.String(required=True)
+    year = ma.Integer(required=True)
+    description = ma.String()
+
+
+class BookDetailKwargsSchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = Book
+        load_instance = True
+
+    id = ma.Integer(required=True)
+
+
+class BookDetailBodySchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = Book
+        load_instance = True
+
+    id = ma.Integer(dump_only=True)
+    title = ma.String(required=True)
+    year = ma.Integer(required=True)
+    description = ma.String(required=True)

examples/complete_db/blueprints/api_v1/urls.py

@@ -0,0 +1,24 @@
+from . import views
+from .blueprint import bp
+
+
+bp.add_url_rule(
+    rule="/authors",
+    endpoint="authors_index",
+    view_func=views.AuthorsIndex.as_view("authors_index"),
+)
+bp.add_url_rule(
+    rule="/authors/<author_id>/books",
+    endpoint="authors_books_list",
+    view_func=views.AuthorsBooksList.as_view("authors_books_list"),
+)
+bp.add_url_rule(
+    rule="/books",
+    endpoint="books_index",
+    view_func=views.BooksIndex.as_view("books_index"),
+)
+bp.add_url_rule(
+    rule="/books/<id>",
+    endpoint="book_detail",
+    view_func=views.BookDetail.as_view("book_detail"),
+)

examples/complete_db/blueprints/api_v1/views.py

@@ -0,0 +1,62 @@
+from complete_db.models import Author, Book
+
+import flask_api_framework as af
+
+from .schemas import (
+    AuthorsBooksListKwargsSchema,
+    AuthorSchema,
+    BookCreateSchema,
+    BookDetailBodySchema,
+    BookDetailKwargsSchema,
+    BookListSchema,
+)
+
+
+class AuthorsIndex(af.List, af.Create):
+    """
+    List all authors.
+    Same body schema for List and Create.
+    """
+
+    body_schema = AuthorSchema()
+
+    def get_instances(self):
+        return Author.query.all()
+
+
+class AuthorsBooksList(af.List):
+    """
+    List all books for a specific author defined by a view arg.
+    """
+
+    kwargs_schema = AuthorsBooksListKwargsSchema()
+    body_schema = BookListSchema()
+
+    def get_instances(self):
+        q = Book.query
+        q = q.filter_by(author=self.loaded_kwargs)
+        return q.all()
+
+
+class BooksIndex(af.List, af.Create):
+    """
+    List all books, and Create new book.
+    When listing, allow filtering via query params.
+    Different body schemas for List and Create.
+    """
+
+    list_body_schema = BookListSchema()
+    create_body_schema = BookCreateSchema()
+
+    def get_instances(self):
+        return Book.query.all()
+
+
+class BookDetail(af.Read, af.Update, af.Delete):
+    """
+    Read, Update, or Delete one specific book.
+    Same body schema for Read, Update, Delete.
+    """
+
+    kwargs_schema = BookDetailKwargsSchema()
+    body_schema = BookDetailBodySchema()

examples/complete_db/conf.py

@@ -0,0 +1,9 @@
+class base:
+    SQLALCHEMY_DATABASE_URI = "sqlite:///:memory:"
+    JSON_SORT_KEYS = False
+    FLASK_ADMIN_FLUID_LAYOUT = True
+    FLASK_ADMIN_SWATCH = "yeti"
+
+
+class test(base):
+    TESTING = True

examples/complete_db/ext.py

@@ -0,0 +1,9 @@
+import flask_marshmallow
+import flask_sqlalchemy
+
+import flask_api_framework
+
+
+db = flask_sqlalchemy.SQLAlchemy()
+ma = flask_marshmallow.Marshmallow()
+af = flask_api_framework.ApiFramework()

examples/complete_db/models.py

@@ -0,0 +1,20 @@
+from complete_db.ext import db
+from sqlalchemy.orm import relationship
+
+
+class Author(db.Model):
+    id = db.Column(db.Integer(), primary_key=True)
+    name = db.Column(db.String(100))
+
+    books = relationship("Book", back_populates="author")
+
+
+class Book(db.Model):
+    id = db.Column(db.Integer(), primary_key=True)
+    title = db.Column(db.String(100))
+    year = db.Column(db.Integer())
+    description = db.Column(db.Text())
+
+    author_id = db.Column(db.Integer(), db.ForeignKey("author.id"))
+
+    author = relationship("Author", back_populates="books")

tests/examples/test_complete_db.py

@@ -0,0 +1,133 @@
+import pytest
+
+
+@pytest.mark.parametrize(
+    "examples_client", [["complete_db", "create_app"]], indirect=True
+)
+def test_complete(examples_client):
+    r = examples_client.post(
+        "/v1/authors",
+        json=dict(
+            name="asdf",
+        ),
+    )
+    assert r.status_code == 201
+    assert r.json["name"] == "asdf"
+
+    r = examples_client.post(
+        "/v1/authors",
+        json=dict(
+            name="qwer",
+        ),
+    )
+    assert r.status_code == 201
+    assert r.json["name"] == "qwer"
+
+    r = examples_client.get("/v1/authors")
+    assert r.status_code == 200
+    assert len(r.json["items"]) == 2
+
+    r = examples_client.post(
+        "/v1/books",
+        json=dict(
+            author_id=1,
+            title="asdf 1",
+            year=1982,
+            description="asdf1 asdf1 asdf1",
+        ),
+    )
+    assert r.status_code == 201
+
+    r = examples_client.post(
+        "/v1/books",
+        json=dict(
+            author_id=1,
+            title="asdf 2",
+            year=1982,
+            description="asdf2 asdf2 asdf2",
+        ),
+    )
+    assert r.status_code == 201
+
+    r = examples_client.post(
+        "/v1/books",
+        json=dict(
+            author_id=2,
+            title="asdf 3",
+            year=1982,
+            description="asdf3 asdf3 asdf3",
+        ),
+    )
+    assert r.status_code == 201
+
+    r = examples_client.post(
+        "/v1/books",
+        json=dict(
+            year=1982,
+        ),
+    )
+    assert r.status_code == 400
+    assert r.json["source"] == "body"
+
+    r = examples_client.get("/v1/books")
+    assert r.status_code == 200
+    assert len(r.json["items"]) == 3
+
+    r = examples_client.get("/v1/authors/1/books")
+    assert r.status_code == 200
+    assert len(r.json["items"]) == 2
+
+    r = examples_client.get("/v1/books/1")
+    assert r.status_code == 200
+    assert r.json["id"] == 1
+    assert r.json["title"] == "asdf 1"
+
+    r = examples_client.get("/v1/books/asdf")
+    assert r.status_code == 400
+    assert r.json["source"] == "kwargs"
+
+    r = examples_client.patch(
+        "/v1/books/1",
+        json=dict(
+            title="something else",
+        ),
+    )
+    assert r.status_code == 200
+    assert r.json["title"] == "something else"
+
+    r = examples_client.get("/v1/books/1")
+    assert r.status_code == 200
+    assert r.json["id"] == 1
+    assert r.json["title"] == "something else"
+    assert r.json["description"] == "asdf1 asdf1 asdf1"
+
+    r = examples_client.put(
+        "/v1/books/1",
+        json=dict(
+            title="zxcv",
+        ),
+    )
+    assert r.status_code == 400
+
+    r = examples_client.put(
+        "/v1/books/1",
+        json=dict(
+            title="zxcv",
+            year=1983,
+            description="zxcv zxcv zxcv",
+        ),
+    )
+    assert r.status_code == 200
+
+    r = examples_client.get("/v1/books/1")
+    assert r.status_code == 200
+    assert r.json["id"] == 1
+    assert r.json["title"] == "zxcv"
+    assert r.json["year"] == 1983
+    assert r.json["description"] == "zxcv zxcv zxcv"
+
+    r = examples_client.delete("/v1/books/1")
+    assert r.status_code == 200
+
+    r = examples_client.get("/v1/books/1")
+    assert r.status_code == 404