36683546e6
To make versioning of the api clearer, I've broken up the api into subfolders and kept the models at the top api layer. Should make things easier to understand and update. Change-Id: I357582d6fcc2eaf59ebe721cc4fef3a3e98da492
123 lines
3.6 KiB
Python
123 lines
3.6 KiB
Python
# Copyright (C) 2015 Catalyst IT Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from django.db import models
|
|
from uuid import uuid4
|
|
from django.utils import timezone
|
|
from jsonfield import JSONField
|
|
|
|
|
|
def hex_uuid():
|
|
return uuid4().hex
|
|
|
|
|
|
class Registration(models.Model):
|
|
"""
|
|
Wrapper object for the request and related actions.
|
|
Stores the state registration and a log for the
|
|
action.
|
|
"""
|
|
uuid = models.CharField(max_length=200, default=hex_uuid,
|
|
primary_key=True)
|
|
# who is this:
|
|
reg_ip = models.GenericIPAddressField()
|
|
keystone_user = JSONField(default={})
|
|
|
|
# which ActionView initiated this
|
|
action_view = models.CharField(max_length=200)
|
|
|
|
# Effectively a log of what the actions are doing.
|
|
action_notes = JSONField(default={})
|
|
|
|
approved = models.BooleanField(default=False)
|
|
|
|
completed = models.BooleanField(default=False)
|
|
|
|
created = models.DateTimeField(default=timezone.now)
|
|
approved_on = models.DateTimeField(null=True)
|
|
completed_on = models.DateTimeField(null=True)
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(Registration, self).__init__(*args, **kwargs)
|
|
# in memory dict to be used for passing data between actions:
|
|
self.cache = {}
|
|
|
|
@property
|
|
def actions(self):
|
|
return self.action_set.order_by('order')
|
|
|
|
@property
|
|
def tokens(self):
|
|
return self.token_set.all()
|
|
|
|
def to_dict(self):
|
|
actions = []
|
|
for action in self.actions:
|
|
actions.append({
|
|
"action_name": action.action_name,
|
|
"data": action.action_data,
|
|
"valid": action.valid
|
|
})
|
|
|
|
return {
|
|
"ip_address": self.reg_ip, "notes": self.action_notes,
|
|
"approved": self.approved, "completed": self.completed,
|
|
"actions": actions, "uuid": self.uuid,
|
|
"keystone_user": self.keystone_user
|
|
}
|
|
|
|
def add_action_note(self, action, note):
|
|
if action in self.action_notes:
|
|
self.action_notes[action].append(note)
|
|
else:
|
|
self.action_notes[action] = [note]
|
|
self.save()
|
|
|
|
|
|
class Token(models.Model):
|
|
"""
|
|
UUID token object bound to a registration.
|
|
"""
|
|
|
|
registration = models.ForeignKey(Registration)
|
|
token = models.CharField(max_length=200, primary_key=True)
|
|
created = models.DateTimeField(default=timezone.now)
|
|
expires = models.DateTimeField()
|
|
|
|
def to_dict(self):
|
|
return {
|
|
"registration": self.registration.uuid,
|
|
"token": self.token, "expires": self.expires
|
|
}
|
|
|
|
|
|
class Notification(models.Model):
|
|
"""
|
|
Notification linked to a registration with some notes.
|
|
"""
|
|
|
|
notes = JSONField(default={})
|
|
registration = models.ForeignKey(Registration)
|
|
created = models.DateTimeField(default=timezone.now)
|
|
acknowledged = models.BooleanField(default=False)
|
|
|
|
def to_dict(self):
|
|
return {
|
|
"pk": self.pk,
|
|
"notes": self.notes,
|
|
"registration": self.registration.uuid,
|
|
"acknowledged": self.acknowledged,
|
|
"created": self.created
|
|
}
|