summaryrefslogtreecommitdiff
path: root/web-server/opendc/models/model.py
blob: bcb833ae15e23226a6350e2da96f6d77efbdf637 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
from uuid import uuid4

from opendc.util.database import DB
from opendc.util.exceptions import ClientError
from opendc.util.rest import Response


class Model:
    """Base class for all models."""

    collection_name = '<specified in subclasses>'

    @classmethod
    def from_id(cls, _id):
        """Fetches the document with given ID from the collection."""
        return cls(DB.fetch_one({'_id': _id}, cls.collection_name))

    @classmethod
    def get_all(cls):
        """Fetches all documents from the collection."""
        return cls(DB.fetch_all({}, cls.collection_name))

    def __init__(self, obj):
        self.obj = obj

    def get_id(self):
        """Returns the ID of the enclosed object."""
        return str(self.obj['_id'])

    def check_exists(self):
        """Raises an error if the enclosed object does not exist."""
        if self.obj is None:
            raise ClientError(Response(404, 'Not found.'))

    def set_property(self, key, value):
        """Sets the given property on the enclosed object, with support for simple nested access."""
        if '.' in key:
            keys = key.split('.')
            self.obj[keys[0]][keys[1]] = value
        else:
            self.obj[key] = value

    def insert(self):
        """Inserts the enclosed object and generates a UUID for it."""
        self.obj['_id'] = str(uuid4())
        DB.insert(self.obj, self.collection_name)

    def update(self):
        """Updates the enclosed object and updates the internal reference to the newly inserted object."""
        DB.update(self.get_id(), self.obj, self.collection_name)

    def delete(self):
        """Deletes the enclosed object in the database, if it existed."""
        if self.obj is None:
            return None

        old_object = self.obj.copy()
        DB.delete_one({'_id': self.get_id()}, self.collection_name)
        return old_object