Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set prefix permission #71

Merged
merged 6 commits into from
Feb 3, 2022
Merged

Set prefix permission #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ee0962f
Transfer commit.
Jan 25, 2022
a5e4af9
Logic looks good. BUT, OpenAPI definitions aren't quite right.
Jan 25, 2022
3724eb6
Merge branch 'main' into set_prefix_permission
chrisarmstrong151 Jan 26, 2022
2c70dac
Linting for prefix files
HadleyKing Feb 3, 2022
092d862
Linting & doc updates for POST_api_prefixes_modify
HadleyKing Feb 3, 2022
23585f4
Linting and docs for prefix token functions
HadleyKing Feb 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 113 additions & 139 deletions bco_api/api/scripts/method_specific/POST_api_prefixes_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,52 @@
# For getting objects out of the database.
from ..utilities import DbUtils
#!/usr/bin/env python3
"""Create a prefix

# Checking that a user is in a group.
from ..utilities import UserUtils
Create a prefix to be used to classify BCOs and to determine permissions
for objects created under that prefix. The requestor must be in the group
prefix_admins to create a prefix.
"""

# Model fields
from ...models import prefixes

# Checking prefixes
import re

# Responses
from api.scripts.utilities import DbUtils
from api.scripts.utilities import UserUtils
from api.models import prefixes

from rest_framework import status
from rest_framework.response import Response




def POST_api_prefixes_create(
incoming
):
def POST_api_prefixes_create(request):
"""Create a prefix

Parameters
----------
request: rest_framework.request.Request
Django request object.

Returns
-------
rest_framework.response.Response
An HttpResponse that allows its data to be rendered into
arbitrary media types.
"""

# TODO: replace user/group looping with basic filtering
# on the model. Loops now are slower than a single
# filter call.

# Instantiate any necessary imports.
db = DbUtils.DbUtils()
uu = UserUtils.UserUtils()
db_utils = DbUtils.DbUtils()
user_utils = UserUtils.UserUtils()

# Define the bulk request.
bulk_request = incoming.data['POST_api_prefixes_create']['prefixes']
bulk_request = request.data['POST_api_prefixes_create']

# Get all existing prefixes.
available_prefixes = list(
prefixes.objects.all().values_list(
'prefix',
flat = True
)
)
prefixes.objects.all().values_list('prefix', flat = True))

# Construct an array to return information about processing
# the request.
Expand All @@ -43,130 +55,92 @@ def POST_api_prefixes_create(
# Since bulk_request is an array, go over each
# item in the array.
for creation_object in bulk_request:

# Create a list to hold information about errors.
errors = {}

# Standardize the prefix name.
standardized = creation_object['prefix'].upper()

# TODO: abstract this error check to schema checker?

# Check for each error.

# Create a flag for if one of these checks fails.
error_check = False

# Does the prefix follow the regex for prefixes?
if not re.match(
r"^[A-Z]{3,5}$",
standardized
):

error_check = True

# Bad request because the prefix doesn't follow
# the naming rules.
errors['400_bad_request_malformed_prefix'] = db.messages(
parameters = {
'prefix': standardized.upper()
}
)['400_bad_request_malformed_prefix']

# Has the prefix already been created?
if standardized in available_prefixes:

error_check = True

# Update the request status.
errors['409_prefix_conflict'] = db.messages(
parameters = {
'prefix': standardized.upper()
}
)['409_prefix_conflict']

# Does the user exist?
if uu.check_user_exists(un = creation_object['owner_user']) is False:

error_check = True

# Bad request.
errors['404_user_not_found'] = db.messages(
parameters = {
'username': creation_object['owner_user']
}
)['404_user_not_found']

# Does the group exist?
if uu.check_group_exists(n = creation_object['owner_group']) is False:

error_check = True

# Bad request.
errors['404_group_not_found'] = db.messages(
parameters = {
'group': creation_object['owner_group']
}
)['404_group_not_found']

# Was the expiration date validly formatted and, if so,
# is it after right now?
if 'expiration_date' in creation_object:
if db.check_expiration(dt_string = creation_object['expiration_date']) is not None:
# Go over each prefix proposed.
for prfx in creation_object['prefixes']:
# Create a list to hold information about errors.
errors = {}
# Standardize the prefix name.
standardized = prfx['prefix'].upper()
# TODO: abstract this error check to schema checker?
# Check for each error.
# Create a flag for if one of these checks fails.
error_check = False
# Does the prefix follow the regex for prefixes?
if not re.match(r"^[A-Z]{3,5}$", standardized):
error_check = True
# Bad request because the prefix doesn't follow
# the naming rules.
errors['400_bad_request_malformed_prefix'] = db_utils.messages(
parameters = {'prefix': standardized.upper()}
)['400_bad_request_malformed_prefix']

# Has the prefix already been created?
if standardized in available_prefixes:
error_check = True
# Update the request status.
errors['409_prefix_conflict'] = db_utils.messages(
parameters = {
'prefix': standardized.upper()
}
)['409_prefix_conflict']

# Does the user exist?
if user_utils.check_user_exists(un = creation_object['owner_user']) is False:

error_check = True

# Bad request.
errors['400_invalid_expiration_date'] = db.messages(
parameters = {
'expiration_date': creation_object['expiration_date']
}
)['400_invalid_expiration_date']

# Did any check fail?
if error_check is False:
# The prefix has not been created, so create it.
DbUtils.DbUtils().write_object(
p_app_label = 'api',
p_model_name = 'prefixes',
p_fields = ['created_by', 'description', 'owner_group', 'owner_user', 'prefix'],
p_data = {
'created_by': uu.user_from_request(
request = incoming
).username,
'description': creation_object['description'],
'owner_group': creation_object['owner_group'],
'owner_user': creation_object['owner_user'],
'prefix': standardized
}
)

DbUtils.DbUtils().write_object(
p_app_label = 'api',
p_model_name ='prefix_table',
p_fields = ['n_objects', 'prefix'],
p_data = {
'n_objects': 0,
'prefix': standardized
}
)

# Created the prefix.
errors['201_prefix_create'] = db.messages(
parameters = {
errors['404_user_not_found'] = db_utils.messages(
parameters = {'username': creation_object['owner_user']}
)['404_user_not_found']

# Does the group exist?
if user_utils.check_group_exists(n = creation_object['owner_group']) is False:
error_check = True
# Bad request.
errors['404_group_not_found'] = db_utils.messages(
parameters = {'group': creation_object['owner_group']}
)['404_group_not_found']

# Was the expiration date validly formatted and, if so,
# is it after right now?
if 'expiration_date' in prfx:
if db_utils.check_expiration(dt_string = prfx['expiration_date']) is not None:
error_check = True
# Bad request.
errors['400_invalid_expiration_date'] = db_utils.messages(
parameters = {
'expiration_date': prfx['expiration_date']}
)['400_invalid_expiration_date']
# Did any check fail?
if error_check is False:
# The prefix has not been created, so create it.
DbUtils.DbUtils().write_object(
p_app_label = 'api',
p_model_name = 'prefixes',
p_fields = ['created_by', 'description', 'owner_group', 'owner_user', 'prefix'],
p_data = {
'created_by': user_utils.user_from_request(
request = request
).username,
'description': prfx['description'],
'owner_group': creation_object['owner_group'],
'owner_user': creation_object['owner_user'],
'prefix': standardized
}
)['201_prefix_create']

# Append the possible "errors".
returning.append(errors)

)

# Created the prefix.
errors['201_prefix_create'] = db_utils.messages(
parameters = {
'prefix': standardized
}
)['201_prefix_create']

# Append the possible "errors".
returning.append(errors)

# As this view is for a bulk operation, status 200
# means that the request was successfully processed,
# but NOT necessarily each item in the request.
return(
Response(
status = status.HTTP_200_OK,
data = returning
)
)
return Response(status = status.HTTP_200_OK, data = returning)
Loading