api: Migrate to Flask Restful

This change updates the API to use Flask Restful instead of our own
in-house REST library. This change reduces the maintenance effort and
allows us to drastically simplify the API implementation needed for the
OpenDC v2 API.

9 files changed, 0 insertions, 382 deletions

diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py
deleted file mode 100644
index e69de29b..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py
+++ /dev/null
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py
deleted file mode 100644
index fa53ce6b..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py
+++ /dev/null
@@ -1,60 +0,0 @@
-from datetime import datetime
-
-from opendc.models.portfolio import Portfolio
-from opendc.models.project import Project
-from opendc.models.topology import Topology
-from opendc.util.database import Database
-from opendc.util.rest import Response
-
-
-def GET(request):
-    """Get this Project."""
-
-    request.check_required_parameters(path={'projectId': 'string'})
-
-    project = Project.from_id(request.params_path['projectId'])
-
-    project.check_exists()
-    project.check_user_access(request.current_user['sub'], False)
-
-    return Response(200, 'Successfully retrieved project', project.obj)
-
-
-def PUT(request):
-    """Update a project's name."""
-
-    request.check_required_parameters(body={'project': {'name': 'name'}}, path={'projectId': 'string'})
-
-    project = Project.from_id(request.params_path['projectId'])
-
-    project.check_exists()
-    project.check_user_access(request.current_user['sub'], True)
-
-    project.set_property('name', request.params_body['project']['name'])
-    project.set_property('datetime_last_edited', Database.datetime_to_string(datetime.now()))
-    project.update()
-
-    return Response(200, 'Successfully updated project.', project.obj)
-
-
-def DELETE(request):
-    """Delete this Project."""
-
-    request.check_required_parameters(path={'projectId': 'string'})
-
-    project = Project.from_id(request.params_path['projectId'])
-
-    project.check_exists()
-    project.check_user_access(request.current_user['sub'], True)
-
-    for topology_id in project.obj['topologyIds']:
-        topology = Topology.from_id(topology_id)
-        topology.delete()
-
-    for portfolio_id in project.obj['portfolioIds']:
-        portfolio = Portfolio.from_id(portfolio_id)
-        portfolio.delete()
-
-    old_object = project.delete()
-
-    return Response(200, 'Successfully deleted project.', old_object)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py
deleted file mode 100644
index e69de29b..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py
+++ /dev/null
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py
deleted file mode 100644
index 18b4d007..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py
+++ /dev/null
@@ -1,35 +0,0 @@
-from opendc.models.portfolio import Portfolio
-from opendc.models.project import Project
-from opendc.util.rest import Response
-
-
-def POST(request):
-    """Add a new Portfolio for this Project."""
-
-    request.check_required_parameters(path={'projectId': 'string'},
-                                      body={
-                                          'portfolio': {
-                                              'name': 'string',
-                                              'targets': {
-                                                  'enabledMetrics': 'list',
-                                                  'repeatsPerScenario': 'int',
-                                              },
-                                          }
-                                      })
-
-    project = Project.from_id(request.params_path['projectId'])
-
-    project.check_exists()
-    project.check_user_access(request.current_user['sub'], True)
-
-    portfolio = Portfolio(request.params_body['portfolio'])
-
-    portfolio.set_property('projectId', project.get_id())
-    portfolio.set_property('scenarioIds', [])
-
-    portfolio.insert()
-
-    project.obj['portfolioIds'].append(portfolio.get_id())
-    project.update()
-
-    return Response(200, 'Successfully added Portfolio.', portfolio.obj)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py
deleted file mode 100644
index 7ddfe0ce..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py
+++ /dev/null
@@ -1,85 +0,0 @@
-from opendc.util.database import DB
-
-test_id = 24 * '1'
-
-
-def test_add_portfolio_missing_parameter(client):
-    assert '400' in client.post(f'/v2/projects/{test_id}/portfolios').status
-
-
-def test_add_portfolio_non_existing_project(client, mocker):
-    mocker.patch.object(DB, 'fetch_one', return_value=None)
-    assert '404' in client.post(f'/v2/projects/{test_id}/portfolios',
-                                json={
-                                    'portfolio': {
-                                        'name': 'test',
-                                        'targets': {
-                                            'enabledMetrics': ['test'],
-                                            'repeatsPerScenario': 2
-                                        }
-                                    }
-                                }).status
-
-
-def test_add_portfolio_not_authorized(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'projectId': test_id,
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'VIEW'
-                            }]
-                        })
-    assert '403' in client.post(f'/v2/projects/{test_id}/portfolios',
-                                json={
-                                    'portfolio': {
-                                        'name': 'test',
-                                        'targets': {
-                                            'enabledMetrics': ['test'],
-                                            'repeatsPerScenario': 2
-                                        }
-                                    }
-                                }).status
-
-
-def test_add_portfolio(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'projectId': test_id,
-                            'portfolioIds': [test_id],
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'EDIT'
-                            }]
-                        })
-    mocker.patch.object(DB,
-                        'insert',
-                        return_value={
-                            '_id': test_id,
-                            'name': 'test',
-                            'targets': {
-                                'enabledMetrics': ['test'],
-                                'repeatsPerScenario': 2
-                            },
-                            'projectId': test_id,
-                            'scenarioIds': [],
-                        })
-    mocker.patch.object(DB, 'update', return_value=None)
-    res = client.post(
-        f'/v2/projects/{test_id}/portfolios',
-        json={
-            'portfolio': {
-                'name': 'test',
-                'targets': {
-                    'enabledMetrics': ['test'],
-                    'repeatsPerScenario': 2
-                }
-            }
-        })
-    assert 'projectId' in res.json['content']
-    assert 'scenarioIds' in res.json['content']
-    assert '200' in res.status
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py
deleted file mode 100644
index 03e6758b..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py
+++ /dev/null
@@ -1,119 +0,0 @@
-from opendc.util.database import DB
-
-test_id = 24 * '1'
-test_id_2 = 24 * '2'
-
-
-def test_get_project_non_existing(client, mocker):
-    mocker.patch.object(DB, 'fetch_one', return_value=None)
-    assert '404' in client.get(f'/v2/projects/{test_id}').status
-
-
-def test_get_project_no_authorizations(client, mocker):
-    mocker.patch.object(DB, 'fetch_one', return_value={'authorizations': []})
-    res = client.get(f'/v2/projects/{test_id}')
-    assert '403' in res.status
-
-
-def test_get_project_not_authorized(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'authorizations': []
-                        })
-    res = client.get(f'/v2/projects/{test_id}')
-    assert '403' in res.status
-
-
-def test_get_project(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'EDIT'
-                            }]
-                        })
-    res = client.get(f'/v2/projects/{test_id}')
-    assert '200' in res.status
-
-
-def test_update_project_missing_parameter(client):
-    assert '400' in client.put(f'/v2/projects/{test_id}').status
-
-
-def test_update_project_non_existing(client, mocker):
-    mocker.patch.object(DB, 'fetch_one', return_value=None)
-    assert '404' in client.put(f'/v2/projects/{test_id}', json={'project': {'name': 'S'}}).status
-
-
-def test_update_project_not_authorized(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'VIEW'
-                            }]
-                        })
-    mocker.patch.object(DB, 'update', return_value={})
-    assert '403' in client.put(f'/v2/projects/{test_id}', json={'project': {'name': 'S'}}).status
-
-
-def test_update_project(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'OWN'
-                            }]
-                        })
-    mocker.patch.object(DB, 'update', return_value={})
-
-    res = client.put(f'/v2/projects/{test_id}', json={'project': {'name': 'S'}})
-    assert '200' in res.status
-
-
-def test_delete_project_non_existing(client, mocker):
-    mocker.patch.object(DB, 'fetch_one', return_value=None)
-    assert '404' in client.delete(f'/v2/projects/{test_id}').status
-
-
-def test_delete_project_different_user(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'googleId': 'other_test',
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'VIEW'
-                            }],
-                            'topologyIds': []
-                        })
-    mocker.patch.object(DB, 'delete_one', return_value=None)
-    assert '403' in client.delete(f'/v2/projects/{test_id}').status
-
-
-def test_delete_project(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'googleId': 'test',
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'OWN'
-                            }],
-                            'topologyIds': [],
-                            'portfolioIds': [],
-                        })
-    mocker.patch.object(DB, 'update', return_value=None)
-    mocker.patch.object(DB, 'delete_one', return_value={'googleId': 'test'})
-    res = client.delete(f'/v2/projects/{test_id}')
-    assert '200' in res.status
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py
deleted file mode 100644
index e69de29b..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py
+++ /dev/null
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py
deleted file mode 100644
index 47f2a207..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py
+++ /dev/null
@@ -1,31 +0,0 @@
-from datetime import datetime
-
-from opendc.models.project import Project
-from opendc.models.topology import Topology
-from opendc.util.rest import Response
-from opendc.util.database import Database
-
-
-def POST(request):
-    """Add a new Topology to the specified project and return it"""
-
-    request.check_required_parameters(path={'projectId': 'string'}, body={'topology': {'name': 'string'}})
-
-    project = Project.from_id(request.params_path['projectId'])
-
-    project.check_exists()
-    project.check_user_access(request.current_user['sub'], True)
-
-    topology = Topology({
-        'projectId': project.get_id(),
-        'name': request.params_body['topology']['name'],
-        'rooms': request.params_body['topology']['rooms'],
-    })
-
-    topology.insert()
-
-    project.obj['topologyIds'].append(topology.get_id())
-    project.set_property('datetimeLastEdited', Database.datetime_to_string(datetime.now()))
-    project.update()
-
-    return Response(200, 'Successfully inserted topology.', topology.obj)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py
deleted file mode 100644
index 2e872415..00000000
--- a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py
+++ /dev/null
@@ -1,52 +0,0 @@
-from opendc.util.database import DB
-
-test_id = 24 * '1'
-
-
-def test_add_topology_missing_parameter(client):
-    assert '400' in client.post(f'/v2/projects/{test_id}/topologies').status
-
-
-def test_add_topology(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'OWN'
-                            }],
-                            'topologyIds': []
-                        })
-    mocker.patch.object(DB,
-                        'insert',
-                        return_value={
-                            '_id': test_id,
-                            'datetimeCreated': '000',
-                            'datetimeLastEdited': '000',
-                            'topologyIds': []
-                        })
-    mocker.patch.object(DB, 'update', return_value={})
-    res = client.post(f'/v2/projects/{test_id}/topologies', json={'topology': {'name': 'test project', 'rooms': []}})
-    assert 'rooms' in res.json['content']
-    assert '200' in res.status
-
-
-def test_add_topology_not_authorized(client, mocker):
-    mocker.patch.object(DB,
-                        'fetch_one',
-                        return_value={
-                            '_id': test_id,
-                            'projectId': test_id,
-                            'authorizations': [{
-                                'userId': 'test',
-                                'authorizationLevel': 'VIEW'
-                            }]
-                        })
-    assert '403' in client.post(f'/v2/projects/{test_id}/topologies',
-                                json={
-                                    'topology': {
-                                        'name': 'test_topology',
-                                        'rooms': {}
-                                    }
-                                }).status