summaryrefslogtreecommitdiff
path: root/opendc/api
diff options
context:
space:
mode:
authorjc0b <j@jc0b.computer>2020-06-26 12:30:16 +0200
committerjc0b <j@jc0b.computer>2020-06-26 12:30:16 +0200
commitf1017676a150de60b13ff2b33ca83079d87aebfc (patch)
tree15c84fd426f65d54c70d405b9a2fc82b579c2812 /opendc/api
parent6f51282cd7c3945ddd0fac68407a7a7be57aa2ba (diff)
parent19bede4fc7f7320bb4eb16c3fe1a211b19ab4714 (diff)
Merged refactoring changes with upstream
Diffstat (limited to 'opendc/api')
-rw-r--r--opendc/api/v2/simulations/endpoint.py5
-rw-r--r--opendc/api/v2/simulations/simulationId/endpoint.py54
-rw-r--r--opendc/api/v2/topologies/topologyId/endpoint.py23
-rw-r--r--opendc/api/v2/users/endpoint.py18
-rw-r--r--opendc/api/v2/users/userId/endpoint.py37
5 files changed, 32 insertions, 105 deletions
diff --git a/opendc/api/v2/simulations/endpoint.py b/opendc/api/v2/simulations/endpoint.py
index dfeb8d5e..62257d40 100644
--- a/opendc/api/v2/simulations/endpoint.py
+++ b/opendc/api/v2/simulations/endpoint.py
@@ -11,10 +11,7 @@ from opendc.util.rest import Response
def POST(request):
"""Create a new simulation, and return that new simulation."""
- try:
- request.check_required_parameters(body={'simulation': {'name': 'string'}})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(body={'simulation': {'name': 'string'}})
topology = Topology({'name': 'Default topology'})
topology.insert()
diff --git a/opendc/api/v2/simulations/simulationId/endpoint.py b/opendc/api/v2/simulations/simulationId/endpoint.py
index b08cf8be..8d29202d 100644
--- a/opendc/api/v2/simulations/simulationId/endpoint.py
+++ b/opendc/api/v2/simulations/simulationId/endpoint.py
@@ -10,19 +10,12 @@ from opendc.util.rest import Response
def GET(request):
"""Get this Simulation."""
- try:
- request.check_required_parameters(path={'simulationId': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(path={'simulationId': 'string'})
simulation = Simulation.from_id(request.params_path['simulationId'])
- validation_error = simulation.validate()
- if validation_error is not None:
- return validation_error
- access_error = simulation.validate_user_access(request.google_id, False)
- if access_error is not None:
- return access_error
+ simulation.check_exists()
+ simulation.check_user_access(request.google_id, False)
return Response(200, 'Successfully retrieved simulation', simulation.obj)
@@ -30,20 +23,12 @@ def GET(request):
def PUT(request):
"""Update a simulation's name."""
- try:
- request.check_required_parameters(body={'simulation': {'name': 'name'}}, path={'simulationId': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(body={'simulation': {'name': 'name'}}, path={'simulationId': 'string'})
simulation = Simulation.from_id(request.params_path['simulationId'])
- validation_error = simulation.validate()
- if validation_error is not None:
- return validation_error
-
- access_error = simulation.validate_user_access(request.google_id, True)
- if access_error is not None:
- return access_error
+ simulation.check_exists()
+ simulation.check_user_access(request.google_id, True)
simulation.set_property('name', request.params_body['simulation']['name'])
simulation.set_property('datetime_last_edited', Database.datetime_to_string(datetime.now()))
@@ -55,30 +40,15 @@ def PUT(request):
def DELETE(request):
"""Delete this Simulation."""
- # Make sure required parameters are there
-
- try:
- request.check_required_parameters(path={'simulationId': 'string'})
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # Instantiate a Simulation and make sure it exists
+ request.check_required_parameters(path={'simulationId': 'string'})
- simulation = Simulation.from_primary_key((request.params_path['simulationId'], ))
-
- if not simulation.exists():
- return Response(404, '{} not found.'.format(simulation))
-
- # Make sure this User is allowed to delete this Simulation
+ simulation = Simulation.from_id(request.params_path['simulationId'])
- if not simulation.google_id_has_at_least(request.google_id, 'OWN'):
- return Response(403, 'Forbidden from deleting {}.'.format(simulation))
+ simulation.check_exists()
+ simulation.check_user_access(request.google_id, True)
- # Delete this Simulation from the database
+ # FIXME cascading
simulation.delete()
- # Return this Simulation
-
- return Response(200, 'Successfully deleted {}.'.format(simulation), simulation.to_JSON())
+ return Response(200, f'Successfully deleted simulation.', simulation.obj)
diff --git a/opendc/api/v2/topologies/topologyId/endpoint.py b/opendc/api/v2/topologies/topologyId/endpoint.py
index ef541daa..3470ad94 100644
--- a/opendc/api/v2/topologies/topologyId/endpoint.py
+++ b/opendc/api/v2/topologies/topologyId/endpoint.py
@@ -6,29 +6,12 @@ from opendc.util.rest import Response
def GET(request):
"""Get this Topology."""
- # Make sure required parameters are there
-
- try:
- request.check_required_parameters(path={'topologyId': 'int'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # Instantiate a Topology from the database
+ request.check_required_parameters(path={'topologyId': 'int'})
topology = Topology.from_id(request.params_path['topologyId'])
- # Make sure this Topology exists
-
- validation_error = topology.validate()
- if validation_error is not None:
- return validation_error
-
- # Make sure this user is authorized to view this Topology
-
- access_error = topology.validate_user_access(request.google_id, False)
- if access_error is not None:
- return access_error
+ topology.check_exists()
- # Return this Topology
+ topology.check_user_access(request.google_id, False)
return Response(200, 'Successfully retrieved topology.', topology.obj)
diff --git a/opendc/api/v2/users/endpoint.py b/opendc/api/v2/users/endpoint.py
index b1a3675d..c6041756 100644
--- a/opendc/api/v2/users/endpoint.py
+++ b/opendc/api/v2/users/endpoint.py
@@ -7,16 +7,11 @@ from opendc.util.rest import Response
def GET(request):
"""Search for a User using their email address."""
- try:
- request.check_required_parameters(query={'email': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(query={'email': 'string'})
user = User.from_email(request.params_query['email'])
- validation_error = user.validate()
- if validation_error is not None:
- return validation_error
+ user.check_exists()
return Response(200, f'Successfully retrieved user.', user.obj)
@@ -24,18 +19,13 @@ def GET(request):
def POST(request):
"""Add a new User."""
- try:
- request.check_required_parameters(body={'user': {'email': 'string'}})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(body={'user': {'email': 'string'}})
user = User(request.params_body['user'])
user.set_property('googleId', request.google_id)
user.set_property('authorizations', [])
- validation_error = user.validate_insertion()
- if validation_error is not None:
- return validation_error
+ user.check_already_exists()
user.insert()
return Response(200, f'Successfully created user.', user.obj)
diff --git a/opendc/api/v2/users/userId/endpoint.py b/opendc/api/v2/users/userId/endpoint.py
index 3fb2ecc8..e68a2bb3 100644
--- a/opendc/api/v2/users/userId/endpoint.py
+++ b/opendc/api/v2/users/userId/endpoint.py
@@ -6,16 +6,11 @@ from opendc.util.rest import Response
def GET(request):
"""Get this User."""
- try:
- request.check_required_parameters(path={'userId': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(path={'userId': 'string'})
user = User.from_id(request.params_path['userId'])
- validation_error = user.validate()
- if validation_error is not None:
- return validation_error
+ user.check_exists()
return Response(200, f'Successfully retrieved user.', user.obj)
@@ -23,20 +18,16 @@ def GET(request):
def PUT(request):
"""Update this User's given name and/or family name."""
- try:
- request.check_required_parameters(body={'user': {
- 'givenName': 'string',
- 'familyName': 'string'
- }},
- path={'userId': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(body={'user': {
+ 'givenName': 'string',
+ 'familyName': 'string'
+ }},
+ path={'userId': 'string'})
user = User.from_id(request.params_path['userId'])
- validation_error = user.validate(request.google_id)
- if validation_error is not None:
- return validation_error
+ user.check_exists()
+ user.check_correct_user(request.google_id)
user.set_property('givenName', request.params_body['user']['givenName'])
user.set_property('familyName', request.params_body['user']['familyName'])
@@ -49,16 +40,12 @@ def PUT(request):
def DELETE(request):
"""Delete this User."""
- try:
- request.check_required_parameters(path={'userId': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ request.check_required_parameters(path={'userId': 'string'})
user = User.from_id(request.params_path['userId'])
- validation_error = user.validate(request.google_id)
- if validation_error is not None:
- return validation_error
+ user.check_exists()
+ user.check_correct_user(request.google_id)
user.delete()