Refactor and rename Service --> OrchestraModel class.

This commit is contained in:
Santiago Lamora 2019-11-20 10:29:39 +01:00
parent 37854207dc
commit 98c5482f5b
3 changed files with 79 additions and 12 deletions

View File

@ -1,28 +1,69 @@
from django.utils.html import format_html from django.utils.html import format_html
class Service: class OrchestraModel:
""" Base class from which all orchestra models will inherit. """
api_name = None api_name = None
verbose_name = None verbose_name = None
fields = () fields = ()
param_defaults = {}
def __init__(self, data={}): def __init__(self, **kwargs):
if self.verbose_name is None: if self.verbose_name is None:
self.verbose_name = self.api_name self.verbose_name = self.api_name
self.data = data for (param, default) in self.param_defaults.items():
setattr(self, param, kwargs.get(param, default))
def get(self, key): # def get(self, key):
# retrieve attr of the object and if undefined get raw data # # retrieve attr of the object and if undefined get raw data
return getattr(self, key, self.data.get(key)) # return getattr(self, key, self.data.get(key))
@classmethod
def new_from_json(cls, data, **kwargs):
""" Create a new instance based on a JSON dict. Any kwargs should be
supplied by the inherited, calling class.
Args:
data: A JSON dict, as converted from the JSON in the orchestra API.
"""
json_data = data.copy()
if kwargs:
for key, val in kwargs.items():
json_data[key] = val
c = cls(**json_data)
c._json = data
return c
class DatabaseService(Service): class DatabaseUser(OrchestraModel):
api_name = 'databaseusers'
fields = ('username',)
param_defaults = {
'username': None,
}
class DatabaseService(OrchestraModel):
api_name = 'database' api_name = 'database'
fields = ('name', 'type', 'users') fields = ('name', 'type', 'users')
param_defaults = {
"id": None,
"name": None,
"type": None,
"users": None,
}
@classmethod
def new_from_json(cls, data, **kwargs):
users = None
if 'users' in data:
users = [DatabaseUser.new_from_json(user_data) for user_data in data['users']]
return super().new_from_json(data=data, users=users)
class MailService(Service): class MailService(OrchestraModel):
api_name = 'address' api_name = 'address'
verbose_name = 'Mail' verbose_name = 'Mail'
fields = ('mail_address', 'aliases', 'type', 'type_detail') fields = ('mail_address', 'aliases', 'type', 'type_detail')
@ -54,7 +95,7 @@ class MailService(Service):
return {'usage': 0, 'total': 213} return {'usage': 0, 'total': 213}
class MailinglistService(Service): class MailinglistService(OrchestraModel):
api_name = 'mailinglist' api_name = 'mailinglist'
verbose_name = 'Mailing list' verbose_name = 'Mailing list'
fields = ('name', 'status', 'address_name', 'admin_email', 'configure') fields = ('name', 'status', 'address_name', 'admin_email', 'configure')

View File

@ -3,7 +3,32 @@
{% block content %} {% block content %}
<h1>Section title</h1> <h1>{{ service.verbose_name }}</h1>
<p>Little description of what to be expected...</p> <p>{{ service.description }}</p>
<table class="table table-hover">
<thead class="thead-dark">
<tr>
{% for field_name in service.fields %}
<th scope="col">{{ field_name }}</th>
{% endfor %}
</tr>
</thead>
<tbody>
{% for resource in object_list %}
<tr>
<td>{{ resource.name }}</td>
<td>{{ resource.type }}</td>
<td>
{% for user in resource.users %}
{{ user.username }}
{% empty %}
No users for this database.
{% endfor %}
</td>
</tr>
{% endfor %}
</tbody>
{% include "musician/components/table_paginator.html" %}
</table>
{% endblock %} {% endblock %}

View File

@ -45,7 +45,7 @@ class ServiceListView(CustomContextMixin, ExtendedPaginationMixin, UserTokenRequ
"ServiceListView requires a definiton of 'service'") "ServiceListView requires a definiton of 'service'")
json_qs = self.orchestra.retrieve_service_list(self.service_class.api_name) json_qs = self.orchestra.retrieve_service_list(self.service_class.api_name)
return [self.service_class(data) for data in json_qs] return [self.service_class.new_from_json(data) for data in json_qs]
def get_context_data(self, **kwargs): def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs) context = super().get_context_data(**kwargs)
@ -89,6 +89,7 @@ class MailingListsView(ServiceListView):
class DatabasesView(ServiceListView): class DatabasesView(ServiceListView):
template_name = "musician/databases.html"
service_class = DatabaseService service_class = DatabaseService