Add Exports

piket_server/__init__.py

@@ -54,6 +54,27 @@ class Person(db.Model):
         }
 
 
+class Export(db.Model):
+    """ Represents a set of exported Settlements. """
+
+    __tablename__ = "exports"
+
+    export_id = db.Column(db.Integer, primary_key=True)
+    created_at = db.Column(
+        db.DateTime, default=datetime.datetime.utcnow, nullable=False
+    )
+
+    settlements = db.relationship("Settlement", backref="export", lazy=True)
+
+    @property
+    def as_dict(self) -> dict:
+        return {
+            "export_id": self.export_id,
+            "created_at": self.created_at.isoformat(),
+            "settlements": [s.settlement_id for s in self.settlements],
+        }
+
+
 class Settlement(db.Model):
     """ Represents a settlement of the list. """
 
@@ -61,6 +82,7 @@ class Settlement(db.Model):
 
     settlement_id = db.Column(db.Integer, primary_key=True)
     name = db.Column(db.String, nullable=False)
+    export_id = db.Column(db.Integer, db.ForeignKey("exports.export_id"), nullable=True)
 
     consumptions = db.relationship("Consumption", backref="settlement", lazy=True)
 
@@ -73,12 +95,24 @@ class Settlement(db.Model):
             "settlement_id": self.settlement_id,
             "name": self.name,
             "consumption_summary": self.consumption_summary,
+            "unique_people": self.unique_people,
         }
 
     @property
+    def unique_people(self) -> int:
+        q = (
+            Consumption.query.filter_by(settlement=self)
+            .filter_by(reversed=False)
+            .group_by(Consumption.person_id)
+            .count()
+        )
+        return q
+
+    @property
     def consumption_summary(self) -> dict:
         q = (
             Consumption.query.filter_by(settlement=self)
+            .filter_by(reversed=False)
             .group_by(Consumption.consumption_type_id)
             .outerjoin(ConsumptionType)
             .with_entities(
@@ -374,3 +408,35 @@ def add_settlement():
     db.session.commit()
 
     return jsonify(settlement=s.as_dict)
+
+
+# Export
+@app.route("/exports", methods=["GET"])
+def get_exports():
+    """ Return a list of the created Exports. """
+    result = Export.query.all()
+    return jsonify(exports=[e.as_dict for e in result])
+
+
+@app.route("/exports/<int:export_id>", methods=["GET"])
+def get_export(export_id: int):
+    """ Return an overview for the given Export. """
+    e = Export.query.get_or_404(export_id)
+
+    ss = [s.as_dict for s in e.settlements]
+
+    return jsonify(export=e.as_dict, settlements=ss)
+
+
+@app.route("/exports", methods=["POST"])
+def add_export():
+    """ Create an Export, and link all un-exported Settlements to it. """
+    e = Export()
+
+    db.session.add(e)
+    db.session.commit()
+
+    Settlement.query.filter_by(export=None).update({"export_id": e.export_id})
+    db.session.commit()
+
+    return jsonify(export=e.as_dict), 201

piket_server/alembic/versions/b4f944f8dcf6_add_export_table.py

@@ -0,0 +1,39 @@
+"""Add Export table
+
+Revision ID: b4f944f8dcf6
+Revises: de101d627237
+Create Date: 2018-10-11 11:45:37.452396
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "b4f944f8dcf6"
+down_revision = "de101d627237"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "exports",
+        sa.Column("export_id", sa.Integer(), nullable=False),
+        sa.Column("created_at", sa.DateTime(), nullable=False),
+        sa.PrimaryKeyConstraint("export_id"),
+    )
+
+    with op.batch_alter_table("settlements") as batch_op:
+        batch_op.add_column(sa.Column("export_id", sa.Integer(), nullable=True))
+        batch_op.create_foreign_key(
+            "fk_settlements_exports", "exports", ["export_id"], ["export_id"]
+        )
+
+
+def downgrade():
+    with op.batch_alter_table("settlements") as batch_op:
+        batch_op.drop_constraint("fk_settlements_exports", type_="foreignkey")
+        batch_op.drop_column("export_id")
+
+    op.drop_table("exports")