From 46fcfa6d6d41d3423157a35c60c35a6786376369 Mon Sep 17 00:00:00 2001 From: yiorgos marinellis Date: Wed, 26 Feb 2020 20:21:59 +0100 Subject: [PATCH] Add a dummny DeliveryNote entity --- ereuse_devicehub/config.py | 3 +- .../resources/deliverynote/__init__.py | 30 ++++ .../resources/deliverynote/models.py | 140 ++++++++++++++++++ .../resources/deliverynote/models.pyi | 103 +++++++++++++ .../resources/deliverynote/schemas.py | 13 ++ .../resources/deliverynote/views.py | 87 +++++++++++ 6 files changed, 375 insertions(+), 1 deletion(-) create mode 100644 ereuse_devicehub/resources/deliverynote/__init__.py create mode 100644 ereuse_devicehub/resources/deliverynote/models.py create mode 100644 ereuse_devicehub/resources/deliverynote/models.pyi create mode 100644 ereuse_devicehub/resources/deliverynote/schemas.py create mode 100644 ereuse_devicehub/resources/deliverynote/views.py diff --git a/ereuse_devicehub/config.py b/ereuse_devicehub/config.py index dea5e2a5..be15650d 100644 --- a/ereuse_devicehub/config.py +++ b/ereuse_devicehub/config.py @@ -7,7 +7,7 @@ from teal.config import Config from teal.enums import Currency from teal.utils import import_resource -from ereuse_devicehub.resources import action, agent, inventory, lot, tag, user +from ereuse_devicehub.resources import action, agent, deliverynote, inventory, lot, tag, user from ereuse_devicehub.resources.device import definitions from ereuse_devicehub.resources.documents import documents from ereuse_devicehub.resources.enums import PriceSoftware @@ -20,6 +20,7 @@ class DevicehubConfig(Config): import_resource(tag), import_resource(agent), import_resource(lot), + import_resource(deliverynote), import_resource(documents), import_resource(inventory)), ) diff --git a/ereuse_devicehub/resources/deliverynote/__init__.py b/ereuse_devicehub/resources/deliverynote/__init__.py new file mode 100644 index 00000000..d08e54ef --- /dev/null +++ b/ereuse_devicehub/resources/deliverynote/__init__.py @@ -0,0 +1,30 @@ +import pathlib +from typing import Callable, Iterable, Tuple + +from teal.resource import Converters, Resource + +from ereuse_devicehub.db import db +from ereuse_devicehub.resources.deliverynote import schemas +from ereuse_devicehub.resources.deliverynote.views import DeliveryNoteView + + +class DeliveryNoteDef(Resource): + SCHEMA = schemas.DeliveryNote + VIEW = DeliveryNoteView + # AUTH = True + AUTH = False + ID_CONVERTER = Converters.uuid + + def __init__(self, app, + import_name=__name__.split('.')[0], + static_folder=None, + static_url_path=None, + template_folder=None, + url_prefix=None, + subdomain=None, + url_defaults=None, + root_path=None, + cli_commands: Iterable[Tuple[Callable, str or None]] = tuple()): + import pdb; pdb.set_trace() + super().__init__(app, import_name, static_folder, static_url_path, template_folder, + url_prefix, subdomain, url_defaults, root_path, cli_commands) diff --git a/ereuse_devicehub/resources/deliverynote/models.py b/ereuse_devicehub/resources/deliverynote/models.py new file mode 100644 index 00000000..772a7bef --- /dev/null +++ b/ereuse_devicehub/resources/deliverynote/models.py @@ -0,0 +1,140 @@ +import uuid +from datetime import datetime +from typing import Union + +from boltons import urlutils +from citext import CIText +from flask import g +from sqlalchemy import TEXT, Enum as DBEnum +from sqlalchemy.dialects.postgresql import UUID +from sqlalchemy_utils import LtreeType +from sqlalchemy_utils.types.ltree import LQUERY +from teal.db import CASCADE_OWN, UUIDLtree, check_range, IntEnum +from teal.resource import url_for_resource + +from ereuse_devicehub.db import create_view, db, exp, f +from ereuse_devicehub.resources.models import Thing +from ereuse_devicehub.resources.user.models import User +from ereuse_devicehub.resources.enums import TransferState + + +class DeliveryNote(Thing): + id = db.Column(UUID(as_uuid=True), primary_key=True) # uuid is generated on init by default + # creator = db.relationship(User, primaryjoin=owner_address == User.ethereum_address) + documentID = db.Column(CIText(), nullable=False) + # supplier = db.relationship(User, primaryjoin=owner_address == User.ethereum_address) + # deposit = db.Column(db.Integer, check_range('deposit', min=0, max=100), default=0) + # owner_address = db.Column(CIText(), + # db.ForeignKey(User.ethereum_address), + # nullable=False, + # default=lambda: g.user.ethereum_address) + # transfer_state = db.Column(IntEnum(TransferState), default=TransferState.Initial, nullable=False) + # transfer_state.comment = TransferState.__doc__ + # lots = db.relationship(Lot, + # backref=db.backref('deliverynotes', lazy=True, collection_class=set), + # secondary=lambda: LotDevice.__table__, + # lazy=True, + # collection_class=set) + """The **children** devices that the lot has. + + # Note that the lot can have more devices, if they are inside + # descendant lots. + # """ + # parents = db.relationship(lambda: Lot, + # viewonly=True, + # lazy=True, + # collection_class=set, + # secondary=lambda: LotParent.__table__, + # primaryjoin=lambda: Lot.id == LotParent.child_id, + # secondaryjoin=lambda: LotParent.parent_id == Lot.id, + # cascade='refresh-expire', # propagate changes outside ORM + # backref=db.backref('children', + # viewonly=True, + # lazy=True, + # cascade='refresh-expire', + # collection_class=set) + # ) + # """The parent lots.""" + + # all_devices = db.relationship(Device, + # viewonly=True, + # lazy=True, + # collection_class=set, + # secondary=lambda: LotDeviceDescendants.__table__, + # primaryjoin=lambda: Lot.id == LotDeviceDescendants.ancestor_lot_id, + # secondaryjoin=lambda: LotDeviceDescendants.device_id == Device.id) + # """All devices, including components, inside this lot and its + # descendants. + # """ + # deposit = db.Column(db.Integer, check_range('deposit', min=0, max=100), default=0) + # owner_address = db.Column(CIText(), + # db.ForeignKey(User.ethereum_address), + # nullable=False, + # default=lambda: g.user.ethereum_address) + # owner = db.relationship(User, primaryjoin=owner_address == User.ethereum_address) + # transfer_state = db.Column(IntEnum(TransferState), default=TransferState.Initial, nullable=False) + # transfer_state.comment = TransferState.__doc__ + # receiver_address = db.Column(CIText(), + # db.ForeignKey(User.ethereum_address), + # nullable=True) + # receiver = db.relationship(User, primaryjoin=receiver_address == User.ethereum_address) + # deliverynote_address = db.Column(CIText(), nullable=True) + + def __init__(self) -> None: + """Initializes a delivery note + """ + super().__init__(id=uuid.uuid4()) + + @property + def type(self) -> str: + return self.__class__.__name__ + + @property + def url(self) -> urlutils.URL: + """The URL where to GET this action.""" + return urlutils.URL(url_for_resource(DeliveryNote, item_id=self.id)) + + + # def delete(self): + # """Deletes the lot. + + # This method removes the children lots and children + # devices orphan from this lot and then marks this lot + # for deletion. + # """ + # self.remove_children(*self.children) + # db.session.delete(self) + + # def _refresh_models_with_relationships_to_lots(self): + # session = db.Session.object_session(self) + # for model in session: + # if isinstance(model, (Device, Lot, Path)): + # session.expire(model) + + # def __contains__(self, child: Union['Lot', Device]): + # if isinstance(child, Lot): + # return Path.has_lot(self.id, child.id) + # elif isinstance(child, Device): + # device = db.session.query(LotDeviceDescendants) \ + # .filter(LotDeviceDescendants.device_id == child.id) \ + # .filter(LotDeviceDescendants.ancestor_lot_id == self.id) \ + # .one_or_none() + # return device + # else: + # raise TypeError('Lot only contains devices and lots, not {}'.format(child.__class__)) + + def __repr__(self) -> str: + # return ''.format(self) + return ''.format(self) + + +# class LotDevice(db.Model): +# device_id = db.Column(db.BigInteger, db.ForeignKey(Device.id), primary_key=True) +# lot_id = db.Column(UUID(as_uuid=True), db.ForeignKey(Lot.id), primary_key=True) +# created = db.Column(db.DateTime, nullable=False, default=datetime.utcnow) +# author_id = db.Column(UUID(as_uuid=True), +# db.ForeignKey(User.id), +# nullable=False, +# default=lambda: g.user.id) +# author = db.relationship(User, primaryjoin=author_id == User.id) +# author_id.comment = """The user that put the device in the lot.""" diff --git a/ereuse_devicehub/resources/deliverynote/models.pyi b/ereuse_devicehub/resources/deliverynote/models.pyi new file mode 100644 index 00000000..e552bbf4 --- /dev/null +++ b/ereuse_devicehub/resources/deliverynote/models.pyi @@ -0,0 +1,103 @@ +import uuid +from datetime import datetime +from typing import Iterable, Optional, Set, Union +from uuid import UUID + +from boltons import urlutils +from sqlalchemy import Column +from sqlalchemy.orm import Query, relationship +from sqlalchemy_utils import Ltree + +from ereuse_devicehub.db import db +from ereuse_devicehub.resources.device.models import Device +from ereuse_devicehub.resources.models import Thing + +LotQuery = Union[Query, Iterable['Lot']] + + +class Lot(Thing): + id = ... # type: Column + name = ... # type: Column + closed = ... # type: Column + devices = ... # type: relationship + paths = ... # type: relationship + description = ... # type: Column + all_devices = ... # type: relationship + parents = ... # type: relationship + deposit = ... # type: Column + owner_address = ... # type: Column + owner = ... # type: relationship + transfer_state = ... # type: Column + receiver_address = ... # type: Column + receiver = ... # type: relationship + deliverynote_address = ... # type: Column + + def __init__(self, name: str, closed: bool = closed.default.arg) -> None: + super().__init__() + self.id = ... # type: UUID + self.name = ... # type: str + self.closed = ... # type: bool + self.devices = ... # type: Set[Device] + self.paths = ... # type: Set[Path] + self.description = ... # type: str + self.all_devices = ... # type: Set[Device] + self.parents = ... # type: Set[Lot] + self.children = ... # type: Set[Lot] + self.owner_address = ... # type: UUID + self.transfer_state = ... + self.receiver_address = ... # type: str + self.deliverynote_address = ... # type: str + + def add_children(self, *children: Union[Lot, uuid.UUID]): + pass + + def remove_children(self, *children: Union[Lot, uuid.UUID]): + pass + + @classmethod + def roots(cls) -> LotQuery: + pass + + @property + def descendants(self) -> LotQuery: + pass + + @classmethod + def descendantsq(cls, id) -> LotQuery: + pass + + @property + def url(self) -> urlutils.URL: + pass + + def delete(self): + pass + + +class Path: + id = ... # type: Column + lot_id = ... # type: Column + lot = ... # type: relationship + path = ... # type: Column + created = ... # type: Column + + def __init__(self, lot: Lot) -> None: + super().__init__() + self.id = ... # type: UUID + self.lot = ... # type: Lot + self.path = ... # type: Ltree + self.created = ... # type: datetime + + +class LotDeviceDescendants(db.Model): + device_id = ... # type: Column + ancestor_lot_id = ... # type: Column + parent_lot_id = ... # type: Column + device_parent_id = ... # type: Column + + def __init__(self) -> None: + super().__init__() + self.device_id = ... # type: int + self.ancestor_lot_id = ... # type: UUID + self.parent_lot_id = ... # type: UUID + self.device_parent_id = ... # type: Optional[int] diff --git a/ereuse_devicehub/resources/deliverynote/schemas.py b/ereuse_devicehub/resources/deliverynote/schemas.py new file mode 100644 index 00000000..2152c65b --- /dev/null +++ b/ereuse_devicehub/resources/deliverynote/schemas.py @@ -0,0 +1,13 @@ +from marshmallow import fields as f +from teal.marshmallow import SanitizedStr, URL, EnumField + +from ereuse_devicehub.marshmallow import NestedOn +from ereuse_devicehub.resources.deliverynote import models as m +from ereuse_devicehub.resources.models import STR_SIZE +from ereuse_devicehub.resources.schemas import Thing + + +class DeliveryNote(Thing): + id = f.UUID(dump_only=True) + documentID = SanitizedStr(validate=f.validate.Length(max=STR_SIZE), required=True) + url = URL(dump_only=True, description=m.DeliveryNote.url.__doc__) diff --git a/ereuse_devicehub/resources/deliverynote/views.py b/ereuse_devicehub/resources/deliverynote/views.py new file mode 100644 index 00000000..0efe0cf4 --- /dev/null +++ b/ereuse_devicehub/resources/deliverynote/views.py @@ -0,0 +1,87 @@ +import datetime +import uuid +from collections import deque +from enum import Enum +from typing import Dict, List, Set, Union + +import marshmallow as ma +import teal.cache +from flask import Response, jsonify, request +from marshmallow import Schema as MarshmallowSchema, fields as f +from teal.marshmallow import EnumField +from teal.resource import View +from sqlalchemy.orm import joinedload + +from ereuse_devicehub.db import db +from ereuse_devicehub.query import things_response +from ereuse_devicehub.resources.deliverynote.models import DeliveryNote + + +class DeliveryNoteView(View): + class FindArgs(MarshmallowSchema): + """Allowed arguments for the ``find`` + method (GET collection) endpoint + """ + search = f.Str(missing=None) + + def post(self): + l = request.get_json() + dlvnote = DeliveryNote(**l) + db.session.add(dlvnote) + db.session().final_flush() + ret = self.schema.jsonify(dlvnote) + ret.status_code = 201 + db.session.commit() + return ret + + # def patch(self, id): + # patch_schema = self.resource_def.SCHEMA(only=('name', 'description', 'transfer_state', 'receiver_address', 'deposit', 'deliverynote_address', 'devices', 'owner_address'), partial=True) + # d = request.get_json(schema=patch_schema) + # dlvnote = DeliveryNote.query.filter_by(id=id).one() + # device_fields = ['transfer_state', 'receiver_address', 'deposit', 'deliverynote_address', 'owner_address'] + # computers = [x for x in dlvnote.all_devices if isinstance(x, Computer)] + # for key, value in d.items(): + # setattr(dlvnote, key, value) + # if key in device_fields: + # for dev in computers: + # setattr(dev, key, value) + # db.session.commit() + # return Response(status=204) + + def one(self, id: uuid.UUID): + """Gets one action.""" + import pdb; pdb.set_trace() + deliverynote = DeliveryNote.query.filter_by(id=id).one() # type: DeliveryNote + return self.schema.jsonify(deliverynote) + + @teal.cache.cache(datetime.timedelta(minutes=5)) + def find(self, args: dict): + """Gets deliverynotes. + + By passing the value `UiTree` in the parameter `format` + of the query you get a recursive nested suited for ui-tree:: + + [ + {title: 'lot1', + nodes: [{title: 'child1', nodes:[]}] + ] + + Note that in this format filters are ignored. + + Otherwise it just returns the standard flat view of lots that + you can filter. + """ + query = DeliveryNote.query + if args['search']: + query = query.filter(DeliveryNote.name.ilike(args['search'] + '%')) + dlvnote = query.paginate(per_page=6 if args['search'] else 30) + return things_response( + self.schema.dump(dlvnote.items, many=True, nested=0), + dlvnote.page, dlvnote.per_page, dlvnote.total, dlvnote.prev_num, dlvnote.next_num + ) + + def delete(self, id): + dlvnote = DeliveryNote.query.filter_by(id=id).one() + dlvnote.delete() + db.session.commit() + return Response(status=204)