Add skeleton app with namespaces

app/fizz/fizzbaz/__init__.py

@@ -0,0 +1,2 @@
+from .model import Fizzbaz  # noqa
+from .schema import FizzbazSchema  # noqa

app/fizz/fizzbaz/controller.py

@@ -0,0 +1,56 @@
+from flask import request
+from flask_accepts import accepts, responds
+from flask_restplus import Namespace, Resource
+from flask.wrappers import Response
+from typing import List
+
+from .schema import FizzbazSchema
+from .service import FizzbazService
+from .model import Fizzbaz
+from .interface import FizzbazInterface
+
+api = Namespace('Fizzbaz', description='A modular namespace within fizz')  # noqa
+
+
+@api.route('/')
+class FizzbazResource(Resource):
+    '''Fizzbazs'''
+
+    @responds(schema=FizzbazSchema, many=True)
+    def get(self) -> List[Fizzbaz]:
+        '''Get all Fizzbazs'''
+
+        return FizzbazService.get_all()
+
+    @accepts(schema=FizzbazSchema, api=api)
+    @responds(schema=FizzbazSchema)
+    def post(self) -> Fizzbaz:
+        '''Create a Single Fizzbaz'''
+
+        return FizzbazService.create(request.parsed_obj)
+
+
+@api.route('/<int:fizzbazId>')
+@api.param('fizzbazId', 'Fizzbaz database ID')
+class FizzbazIdResource(Resource):
+    @responds(schema=FizzbazSchema)
+    def get(self, fizzbazId: int) -> Fizzbaz:
+        '''Get Single Fizzbaz'''
+
+        return FizzbazService.get_by_id(fizzbazId)
+
+    def delete(self, fizzbazId: int) -> Response:
+        '''Delete Single Fizzbaz'''
+        from flask import jsonify
+
+        id = FizzbazService.delete_by_id(fizzbazId)
+        return jsonify(dict(status='Success', id=id))
+
+    @accepts(schema=FizzbazSchema, api=api)
+    @responds(schema=FizzbazSchema)
+    def put(self, fizzbazId: int) -> Fizzbaz:
+        '''Update Single Fizzbaz'''
+
+        changes: FizzbazInterface = request.parsed_obj
+        Fizzbaz = FizzbazService.get_by_id(fizzbazId)
+        return FizzbazService.update(Fizzbaz, changes)

app/fizz/fizzbaz/controller_test.py

@@ -0,0 +1,84 @@
+
+from unittest.mock import patch
+from flask.testing import FlaskClient
+
+from app.test.fixtures import client, app  # noqa
+from .service import FizzbazService
+from .schema import FizzbazSchema
+from .model import Fizzbaz
+from .interface import FizzbazInterface
+from .. import BASE_ROUTE
+
+
+def make_fizzbaz(id: int = 123, name: str = 'Test fizzbaz',
+                 purpose: str = 'Test purpose') -> Fizzbaz:
+    return Fizzbaz(
+        fizzbaz_id=id, name=name, purpose=purpose
+    )
+
+
+class TestFizzbazResource:
+    @patch.object(FizzbazService, 'get_all',
+                  lambda: [make_fizzbaz(123, name='Test Fizzbaz 1'),
+                           make_fizzbaz(456, name='Test Fizzbaz 2')])
+    def test_get(self, client: FlaskClient):  # noqa
+        with client:
+            results = client.get(f'/api/{BASE_ROUTE}/fizzbaz',
+                                 follow_redirects=True).get_json()
+            expected = FizzbazSchema(many=True).dump(
+                [make_fizzbaz(123, name='Test Fizzbaz 1'),
+                 make_fizzbaz(456, name='Test Fizzbaz 2')]
+            ).data
+            for r in results:
+                assert r in expected
+
+    @patch.object(FizzbazService, 'create',
+                  lambda create_request: Fizzbaz(**create_request))
+    def test_post(self, client: FlaskClient):  # noqa
+        with client:
+
+            payload = dict(name='Test fizzbaz', purpose='Test purpose')
+            result = client.post(f'/api/{BASE_ROUTE}/fizzbaz/', json=payload).get_json()
+            expected = FizzbazSchema().dump(Fizzbaz(
+                name=payload['name'],
+                purpose=payload['purpose'],
+            )).data
+            assert result == expected
+
+
+def fake_update(fizzbaz: Fizzbaz, changes: FizzbazInterface) -> Fizzbaz:
+    # To fake an update, just return a new object
+    updated_Fizzbaz = Fizzbaz(fizzbaz_id=fizzbaz.fizzbaz_id,
+                              name=changes['name'],
+                              purpose=changes['purpose'])
+    return updated_Fizzbaz
+
+
+class TestFizzbazIdResource:
+    @patch.object(FizzbazService, 'get_by_id',
+                  lambda id: make_fizzbaz(id=id))
+    def test_get(self, client: FlaskClient):  # noqa
+        with client:
+            result = client.get(f'/api/{BASE_ROUTE}/fizzbaz/123').get_json()
+            expected = Fizzbaz(fizzbaz_id=123)
+            assert result['fizzbazId'] == expected.fizzbaz_id
+
+    @patch.object(FizzbazService, 'delete_by_id',
+                  lambda id: [id])
+    def test_delete(self, client: FlaskClient):  # noqa
+        with client:
+            result = client.delete(f'/api/{BASE_ROUTE}/fizzbaz/123').get_json()
+            expected = dict(status='Success', id=[123])
+            assert result == expected
+
+    @patch.object(FizzbazService, 'get_by_id',
+                  lambda id: make_fizzbaz(id=id))
+    @patch.object(FizzbazService, 'update', fake_update)
+    def test_put(self, client: FlaskClient):  # noqa
+        with client:
+            result = client.put(f'/api/{BASE_ROUTE}/fizzbaz/123',
+                                json={'name': 'New Fizzbaz',
+                                      'purpose': 'New purpose'}).get_json()
+            expected = FizzbazSchema().dump(
+                Fizzbaz(fizzbaz_id=123, name='New Fizzbaz', purpose='New purpose')).data
+            assert result == expected

app/fizz/fizzbaz/interface.py

@@ -0,0 +1,7 @@
+from mypy_extensions import TypedDict
+
+
+class FizzbazInterface(TypedDict, total=False):
+    fizzbaz_id: int
+    name: str
+    purpose: str

app/fizz/fizzbaz/model.py

@@ -0,0 +1,19 @@
+from sqlalchemy import Integer, Column, String
+from app import db  # noqa
+from .interface import FizzbazInterface
+from typing import Any
+
+
+class Fizzbaz(db.Model):  # type: ignore
+    '''A snazzy Fizzbaz'''
+
+    __tablename__ = 'fizzbaz'
+
+    fizzbaz_id = Column(Integer(), primary_key=True)
+    name = Column(String(255))
+    purpose = Column(String(255))
+
+    def update(self, changes: FizzbazInterface):
+        for key, val in changes.items():
+            setattr(self, key, val)
+        return self

app/fizz/fizzbaz/model_test.py

@@ -0,0 +1,22 @@
+from pytest import fixture
+from flask_sqlalchemy import SQLAlchemy
+from app.test.fixtures import app, db  # noqa
+from .model import Fizzbaz
+
+
+@fixture
+def fizzbaz() -> Fizzbaz:
+    return Fizzbaz(
+        fizzbaz_id=1, name='Test fizzbaz', purpose='Test purpose'
+    )
+
+
+def test_Fizzbaz_create(fizzbaz: Fizzbaz):
+    assert fizzbaz
+
+
+def test_Fizzbaz_retrieve(fizzbaz: Fizzbaz, db: SQLAlchemy):  # noqa
+    db.session.add(fizzbaz)
+    db.session.commit()
+    s = Fizzbaz.query.first()
+    assert s.__dict__ == fizzbaz.__dict__

app/fizz/fizzbaz/schema.py

@@ -0,0 +1,9 @@
+from marshmallow import fields, Schema
+
+
+class FizzbazSchema(Schema):
+    '''Fizzbaz schema'''
+
+    fizzbazId = fields.Number(attribute='fizzbaz_id')
+    name = fields.String(attribute='name')
+    purpose = fields.String(attribute='purpose')

app/fizz/fizzbaz/service.py

@@ -0,0 +1,41 @@
+from app import db
+from typing import List
+from .model import Fizzbaz
+from .interface import FizzbazInterface
+
+
+class FizzbazService():
+    @staticmethod
+    def get_all() -> List[Fizzbaz]:
+        return Fizzbaz.query.all()
+
+    @staticmethod
+    def get_by_id(fizzbaz_id: int) -> Fizzbaz:
+        return Fizzbaz.query.get(fizzbaz_id)
+
+    @staticmethod
+    def update(fizzbaz: Fizzbaz, Fizzbaz_change_updates: FizzbazInterface) -> Fizzbaz:
+        fizzbaz.update(Fizzbaz_change_updates)
+        db.session.commit()
+        return fizzbaz
+
+    @staticmethod
+    def delete_by_id(fizzbaz_id: int) -> List[int]:
+        fizzbaz = Fizzbaz.query.filter(Fizzbaz.fizzbaz_id == fizzbaz_id).first()
+        if not fizzbaz:
+            return []
+        db.session.delete(fizzbaz)
+        db.session.commit()
+        return [fizzbaz_id]
+
+    @staticmethod
+    def create(new_attrs: FizzbazInterface) -> Fizzbaz:
+        new_fizzbaz = Fizzbaz(
+            name=new_attrs['name'],
+            purpose=new_attrs['purpose']
+        )
+
+        db.session.add(new_fizzbaz)
+        db.session.commit()
+
+        return new_fizzbaz

app/fizz/fizzbaz/service_test.py

@@ -0,0 +1,60 @@
+from flask_sqlalchemy import SQLAlchemy
+from typing import List
+from app.test.fixtures import app, db  # noqa
+from .model import Fizzbaz
+from .service import FizzbazService  # noqa
+from .interface import FizzbazInterface
+
+
+def test_get_all(db: SQLAlchemy):  # noqa
+    yin: Fizzbaz = Fizzbaz(fizzbaz_id=1, name='Yin', purpose='thing 1')
+    yang: Fizzbaz = Fizzbaz(fizzbaz_id=2, name='Yang', purpose='thing 2')
+    db.session.add(yin)
+    db.session.add(yang)
+    db.session.commit()
+
+    results: List[Fizzbaz] = FizzbazService.get_all()
+
+    assert len(results) == 2
+    assert yin in results and yang in results
+
+
+def test_update(db: SQLAlchemy):  # noqa
+    yin: Fizzbaz = Fizzbaz(fizzbaz_id=1, name='Yin', purpose='thing 1')
+
+    db.session.add(yin)
+    db.session.commit()
+    updates: FizzbazInterface = dict(name='New Fizzbaz name')
+
+    FizzbazService.update(yin, updates)
+
+    result: Fizzbaz = Fizzbaz.query.get(yin.fizzbaz_id)
+    assert result.name == 'New Fizzbaz name'
+
+
+def test_delete_by_id(db: SQLAlchemy):  # noqa
+    yin: Fizzbaz = Fizzbaz(fizzbaz_id=1, name='Yin', purpose='thing 1')
+    yang: Fizzbaz = Fizzbaz(fizzbaz_id=2, name='Yang', purpose='thing 2')
+    db.session.add(yin)
+    db.session.add(yang)
+    db.session.commit()
+
+    FizzbazService.delete_by_id(1)
+    db.session.commit()
+
+    results: List[Fizzbaz] = Fizzbaz.query.all()
+
+    assert len(results) == 1
+    assert yin not in results and yang in results
+
+
+def test_create(db: SQLAlchemy):  # noqa
+
+    yin: FizzbazInterface = dict(name='Fancy new fizzbaz', purpose='Fancy new purpose')
+    FizzbazService.create(yin)
+    results: List[Fizzbaz] = Fizzbaz.query.all()
+
+    assert len(results) == 1
+
+    for k in yin.keys():
+        assert getattr(results[0], k) == yin[k]