Monstercommit adding persistency

- Database moved to flask-sqlalchemy's wrapper thing
- Alembic moved up a level since models can't be their own file anymore
- Add Settlement, ConsumptionType
- Make server routes use the database
- Add consumptions

Note: migrating up from base doesn't work because sqlite has no alter
table, sad.

piket_client/gui.py

@@ -43,9 +43,9 @@ class NameButton(QPushButton):
     """ Wraps a QPushButton to provide a counter. """
 
     def __init__(self, person: dict, *args, **kwargs) -> None:
-        self.person_id = person["id"]
+        self.person_id = person["person_id"]
         self.name = person["name"]
-        self.count = person["count"]
+        self.count = person["consumptions"]["1"]
 
         super().__init__(self.current_label, *args, **kwargs)
         self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
@@ -65,7 +65,7 @@ class NameButton(QPushButton):
         if req.status_code == 200:
             json = req.json()
             person = json["person"]
-            self.count = person["count"]
+            self.count = person["consumptions"]["1"]
             self.setText(self.current_label)
             plop()
         else:
@@ -141,7 +141,9 @@ class PiketMainWindow(QMainWindow):
             True,
         )
         if ok and name:
-            req = requests.post(urljoin(SERVER_URL, "people"), json={"name": name})
+            req = requests.post(
+                urljoin(SERVER_URL, "people"), json={"person": {"name": name}}
+            )
 
             self.main_widget = NameButtons()
             self.setCentralWidget(self.main_widget)

piket_server/__init__.py

@@ -2,10 +2,123 @@
 Piket server, handles events generated by the client.
 """
 
+import datetime
+import os
+
+from sqlalchemy.exc import SQLAlchemyError
 from flask import Flask, jsonify, abort, request
+from flask_sqlalchemy import SQLAlchemy
+
 
+DATA_HOME = os.environ.get("XDG_DATA_HOME", "~/.local/share")
+CONFIG_DIR = os.path.join(DATA_HOME, "piket_server")
+DB_PATH = os.path.expanduser(os.path.join(CONFIG_DIR, "database.sqlite3"))
+DB_URL = f"sqlite:///{DB_PATH}"
 
 app = Flask("piket_server")
+app.config["SQLALCHEMY_DATABASE_URI"] = DB_URL
+app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
+db = SQLAlchemy(app)
+
+
+# ---------- Models ----------
+class Person(db.Model):
+    """ Represents a person to be shown on the lists. """
+
+    __tablename__ = "people"
+
+    person_id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String, nullable=False)
+
+    consumptions = db.relationship("Consumption", backref="person", lazy=True)
+
+    def __repr__(self) -> str:
+        return f"<Person {self.person_id}: {self.name}>"
+
+    @property
+    def as_dict(self) -> dict:
+        return {
+            "person_id": self.person_id,
+            "name": self.name,
+            "consumptions": {
+                ct.consumption_type_id: Consumption.query.filter_by(person=self)
+                .filter_by(consumption_type=ct)
+                .count()
+                for ct in ConsumptionType.query.all()
+            },
+        }
+
+
+class Settlement(db.Model):
+    """ Represents a settlement of the list. """
+
+    __tablename__ = "settlements"
+
+    settlement_id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String, nullable=False)
+
+    consumptions = db.relationship("Consumption", backref="settlement", lazy=True)
+
+    def __repr__(self) -> str:
+        return f"<Settlement {self.settlement_id}: {self.name}>"
+
+
+class ConsumptionType(db.Model):
+    """ Represents a type of consumption to be counted. """
+
+    __tablename__ = "consumption_types"
+
+    consumption_type_id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String, nullable=False)
+    icon = db.Column(db.String)
+
+    consumptions = db.relationship("Consumption", backref="consumption_type", lazy=True)
+
+    def __repr__(self) -> str:
+        return f"<ConsumptionType: {self.name}>"
+
+    @property
+    def as_dict(self) -> dict:
+        return {
+            "consumption_type_id": self.consumption_type_id,
+            "name": self.name,
+            "icon": self.icon,
+        }
+
+
+class Consumption(db.Model):
+    """ Represent one consumption to be counted. """
+
+    __tablename__ = "consumptions"
+
+    consumption_id = db.Column(db.Integer, primary_key=True)
+    person_id = db.Column(db.Integer, db.ForeignKey("people.person_id"), nullable=True)
+    consumption_type_id = db.Column(
+        db.Integer,
+        db.ForeignKey("consumption_types.consumption_type_id"),
+        nullable=False,
+    )
+    settlement_id = db.Column(
+        db.Integer, db.ForeignKey("settlements.settlement_id"), nullable=True
+    )
+    created_at = db.Column(
+        db.DateTime, default=datetime.datetime.utcnow, nullable=False
+    )
+
+    def __repr__(self) -> str:
+        return f"<Consumption: {self.consumption_type.name} for {self.person.name}>"
+
+    @property
+    def as_dict(self) -> dict:
+        return {
+            "person_id": self.person_id,
+            "consumption_type_id": self.consumption_type_id,
+            "settlement_id": self.settlement_id,
+            "created_at": self.created_at.isoformat(),
+        }
+
+
+# ---------- Models ----------
 
 
 @app.route("/ping")
@@ -33,19 +146,16 @@ NEXT_ID = len(PEOPLE)
 @app.route("/people", methods=["GET"])
 def get_people():
     """ Return a list of currently known people. """
-    people = [p for p in PEOPLE.values()]
-    people.sort(key=lambda p: p["name"])
-    return jsonify(people=people)
+    people = Person.query.order_by(Person.name).all()
+    result = [person.as_dict for person in people]
+    return jsonify(people=result)
 
 
 @app.route("/people/<int:person_id>", methods=["GET"])
 def get_person(person_id: int):
-    person = PEOPLE.get(person_id)
-
-    if not person:
-        abort(404)
+    person = Person.query.get_or_404(person_id)
 
-    return jsonify(person=person)
+    return jsonify(person=person.as_dict)
 
 
 @app.route("/people", methods=["POST"])
@@ -56,34 +166,36 @@ def add_person():
     Required parameters:
     - name (str)
     """
-    global NEXT_ID
-
-    data = request.get_json()
-
-    if not data:
-        abort(400)
-
-    name = data.get("name")
+    json = request.get_json()
 
-    if not name:
-        abort(400)
-    person = {"id": NEXT_ID, "name": name, "count": 0}
+    if not json:
+        return jsonify({"error": "Could not parse JSON."}), 400
 
-    PEOPLE[NEXT_ID] = person
+    data = json.get("person") or {}
+    person = Person(name=data.get("name"))
+    try:
+        db.session.add(person)
+        db.session.commit()
+    except SQLAlchemyError:
+        return jsonify({"error": "Invalid arguments for Person."})
 
-    NEXT_ID += 1
-
-    return jsonify(person=person)
+    return jsonify(person=person.as_dict)
 
 
 @app.route("/people/<int:person_id>/add_consumption", methods=["POST"])
 def add_consumption(person_id: int):
-    person = PEOPLE.get(person_id)
-
-    if not person:
-        abort(404)
-
-    increment = int(request.form.get("amount", 1))
-    person["count"] += increment
-
-    return jsonify(person=person)
+    person = Person.query.get_or_404(person_id)
+
+    consumption = Consumption(person=person, consumption_type_id=1)
+    try:
+        db.session.add(consumption)
+        db.session.commit()
+    except SQLAlchemyError:
+        return (
+            jsonify(
+                {"error": "Invalid Consumption parameters.", "person": person.as_dict}
+            ),
+            400,
+        )
+
+    return jsonify(person=person.as_dict, consumption=consumption.as_dict)

piket_server/database/alembic/env.py

@@ -16,20 +16,17 @@ fileConfig(config.config_file_name)
 # for 'autogenerate' support
 # from myapp import mymodel
 # target_metadata = mymodel.Base.metadata
-import piket_server.database.schema
-target_metadata = piket_server.database.schema.BASE.metadata
+import piket_server
+target_metadata = piket_server.db.Model.metadata
 
 # other values from the config, defined by the needs of env.py,
 # can be acquired:
 # my_important_option = config.get_main_option("my_important_option")
 # ... etc.
-data_home = os.environ.get('XDG_DATA_HOME', '~/.local/share')
-config_dir = os.path.join(data_home, 'piket_server')
-os.makedirs(os.path.expanduser(config_dir), mode=0o744, exist_ok=True)
-db_path = os.path.expanduser(os.path.join(config_dir, 'database.sqlite3'))
+from piket_server import CONFIG_DIR, DB_URL
+os.makedirs(os.path.expanduser(CONFIG_DIR), mode=0o744, exist_ok=True)
 
-config.file_config['alembic']['sqlalchemy.url'] = f'sqlite:///{db_path}'
-print(config.get_main_option('sqlalchemy.url'))
+config.file_config['alembic']['sqlalchemy.url'] = DB_URL
 
 
 def run_migrations_offline():

piket_server/alembic/versions/491bb980d1d7_add_settlement_allow_null_person_on_.py

@@ -0,0 +1,39 @@
+"""Add Settlements
+
+Revision ID: 491bb980d1d7
+Revises: de101d627237
+Create Date: 2018-08-22 22:37:49.467438
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '491bb980d1d7'
+down_revision = 'de101d627237'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'settlements',
+        sa.Column('settlement_id', sa.Integer, primary_key=True),
+        sa.Column('name', sa.String, nullable=False)
+    )
+
+    op.add_column(
+        'consumptions',
+        sa.Column(
+            'settlement_id', sa.Integer,
+            sa.ForeignKey('settlements.settlement_id'),
+            nullable=True
+        )
+    )
+
+
+def downgrade():
+    op.drop_column('consumptions', 'settlement_id')
+
+    op.drop_table('settlements')

piket_server/alembic/versions/de101d627237_create_consumptions_consumption_types.py

@@ -0,0 +1,42 @@
+"""Create consumptions, consumption_types
+
+Revision ID: de101d627237
+Revises: a09086bfe84c
+Create Date: 2018-08-21 12:06:29.135898
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'de101d627237'
+down_revision = 'a09086bfe84c'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'consumption_types',
+        sa.Column('consumption_type_id', sa.Integer, nullable=False,
+            primary_key=True),
+        sa.Column('name', sa.String, nullable=False),
+        sa.Column('icon', sa.String, nullable=True),
+    )
+
+    op.create_table(
+        'consumptions',
+        sa.Column('consumption_id', sa.Integer, primary_key=True),
+        sa.Column('person_id', sa.Integer, nullable=True),
+        sa.Column('consumption_type_id', sa.Integer, nullable=False),
+        sa.Column('created_at', sa.DateTime, nullable=False),
+        sa.ForeignKeyConstraint(['consumption_type_id'], ['consumption_types.consumption_type_id'], ),
+        sa.ForeignKeyConstraint(['person_id'], ['people.person_id'], ),
+        sa.PrimaryKeyConstraint('consumption_id')
+    )
+
+
+def downgrade():
+    op.drop_table('consumptions')
+    op.drop_table('consumption_types')

piket_server/database/schema.py

@@ -1,20 +0,0 @@
-"""
-Defines the database schema for the backend.
-"""
-
-from sqlalchemy import Column, Integer, String
-from sqlalchemy.ext.declarative import declarative_base
-
-
-BASE = declarative_base()
-
-
-class Person(BASE):
-    ''' Represents a person to be shown on the lists. '''
-    __tablename__ = 'people'
-
-    person_id = Column(Integer, primary_key=True)
-    name = Column(String, nullable=False)
-
-    def __repr__(self):
-        return f"<Person(id={self.person_id}, name={self.name})>"

setup.py

@@ -29,6 +29,7 @@ setup(
             'server': [
                 'Flask',
                 'SQLAlchemy',
+                'Flask-SQLAlchemy',
                 'alembic',
             ],
             'client': [