def _read_detail(self, request, *args, **kwargs): if 'map_id' in kwargs: try: map_obj = Map.objects.get(pk=kwargs['map_id']) except Map.DoesNotExist: return rc(rcs.NOT_FOUND) return map_obj return rc(rcs.BAD_REQUEST)
def _read_rank(self, request, *args, **kwargs): if 'id' in kwargs: try: profile = UserProfile.objects.get(pk=kwargs['id']) except UserProfile.DoesNotExist: return rc(rcs.NOT_FOUND, "UserProfile with specified id doesn't exist") return profile.position return rc(rcs.BAD_REQUEST)
def _read_detail(self, request, *args, **kwargs): if 'id' in kwargs: try: user = User.objects.get(pk=kwargs['id']) except User.DoesNotExist: return rc(rcs.NOT_FOUND, "User with specified id doesn't exist") return user return rc(rcs.BAD_REQUEST)
def _read_detail(self, request, *args, **kwargs):
if 'id' in kwargs:
try:
run = Run.objects.get(pk=kwargs['id'])
return run
except Run.DoesNotExist:
return rc(rcs.NOT_FOUND, "Run with specified id doesn't exist")
return rc(rcs.BAD_REQUEST)
def _read_detail(self, request, *args, **kwargs): if 'id' in kwargs: try: run = Run.objects.get(pk=kwargs['id']) return run except Run.DoesNotExist: return rc(rcs.NOT_FOUND, "Run with specified id doesn't exist") return rc(rcs.BAD_REQUEST)
def _read_detail(self, request, *args, **kwargs):
if 'map_id' in kwargs:
try:
map_obj = Map.objects.get(pk=kwargs['map_id'])
except Map.DoesNotExist:
return rc(rcs.NOT_FOUND)
return map_obj
return rc(rcs.BAD_REQUEST)
def _read_rank(self, request, *args, **kwargs):
if 'id' in kwargs:
try:
profile = UserProfile.objects.get(pk=kwargs['id'])
except UserProfile.DoesNotExist:
return rc(rcs.NOT_FOUND,
"UserProfile with specified id doesn't exist")
return profile.position
return rc(rcs.BAD_REQUEST)
def _read_detail(self, request, *args, **kwargs):
if 'id' in kwargs:
try:
user = User.objects.get(pk=kwargs['id'])
except User.DoesNotExist:
return rc(rcs.NOT_FOUND,
"User with specified id doesn't exist")
return user
return rc(rcs.BAD_REQUEST)
def _update_playtime(self, request, *args, **kwargs): if 'id' in kwargs: try: profile = UserProfile.objects.get(id=kwargs['id']) except UserProfile.DoesNotExist: return rc(rcs.BAD_REQUEST, "UserProfile with specified id doesn't exist") profile.update_playtime(request.form.cleaned_data['seconds']) return rc(rcs.ALL_OK) return rc(rcs.BAD_REQUEST)
def _read_rank(self, request, *args, **kwargs): if 'map_id' in kwargs: try: map_obj = Map.objects.get(pk=kwargs['map_id']) except Map.DoesNotExist: return rc(rcs.NOT_FOUND) offset = max(0, int(kwargs['offset'])-1) if 'offset' in kwargs else 0 return BestRun.objects.filter(map=map_obj) \ .select_related()[offset:offset+5] return rc(rcs.BAD_REQUEST)
def _update_playtime(self, request, *args, **kwargs):
if 'id' in kwargs:
try:
profile = UserProfile.objects.get(id=kwargs['id'])
except UserProfile.DoesNotExist:
return rc(rcs.BAD_REQUEST,
"UserProfile with specified id doesn't exist")
profile.update_playtime(request.form.cleaned_data['seconds'])
return rc(rcs.ALL_OK)
return rc(rcs.BAD_REQUEST)
def _create_new(self, request, *args, **kwargs):
event_type = request.form.cleaned_data.get('event_type')
verb_dict = {
'join': "joined",
'leave': "left",
}
if event_type in ['join', 'leave']:
action.send(request.form.user, verb=verb_dict[event_type],
target=request.server)
return rc(rcs.ALL_OK)
return rc(rcs.BAD_REQUEST)
def _read_map_rank(self, request, *args, **kwargs):
if 'id' in kwargs and 'map_id' in kwargs:
try:
profile = UserProfile.objects.get(pk=kwargs['id'])
except UserProfile.DoesNotExist:
return rc(rcs.NOT_FOUND, "UserProfile with specified id doesn't exist")
return {
'position': profile.map_position(kwargs['map_id']),
'bestrun': profile.best_score(kwargs['map_id']),
}
return rc(rcs.BAD_REQUEST)
def _read_map_rank(self, request, *args, **kwargs):
if 'id' in kwargs and 'map_id' in kwargs:
try:
profile = UserProfile.objects.get(pk=kwargs['id'])
except UserProfile.DoesNotExist:
return rc(rcs.NOT_FOUND,
"UserProfile with specified id doesn't exist")
return {
'position': profile.map_position(kwargs['map_id']),
'bestrun': profile.best_score(kwargs['map_id']),
}
return rc(rcs.BAD_REQUEST)
def _create_new(self, request, *args, **kwargs):
event_type = request.form.cleaned_data.get('event_type')
verb_dict = {
'join': "joined",
'leave': "left",
}
if event_type in ['join', 'leave']:
action.send(request.form.user,
verb=verb_dict[event_type],
target=request.server)
return rc(rcs.ALL_OK)
return rc(rcs.BAD_REQUEST)
def _read_rank(self, request, *args, **kwargs):
if 'map_id' in kwargs:
try:
map_obj = Map.objects.get(pk=kwargs['map_id'])
except Map.DoesNotExist:
return rc(rcs.NOT_FOUND)
offset = max(0,
int(kwargs['offset']) -
1) if 'offset' in kwargs else 0
return BestRun.objects.filter(map=map_obj) \
.select_related()[offset:offset+5]
return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs): """ URL **/api/1/runs/new/** Shortdesc Handles posting of Run objects to webapp. Longdesc Creates a Run object. Checks for new badges and adds a Celery task to rebuild ranks. Arguments - none Data - map_id / integer / ID of the finished map - user_id / integer / ID of the user who finished the map (use None for anonymous user) - nickname / string / currently used nickname by the user - time / decimal / user result - checkpoints / string / semicolon-delimited (;) list of checkpoint times Results - 400 - when data fails validation dictionary containing error message(s) - 200 - when everything went fine Run object """ allowed_actions = ['new'] if action in allowed_actions: return getattr(self, '_create_' + action)(request, *args, **kwargs) return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs):
"""
URL
**/api/1/runs/new/**
Shortdesc
Handles posting of Run objects to webapp.
Longdesc
Creates a Run object.
Checks for new badges and adds a Celery task to rebuild ranks.
Arguments
- none
Data
- map_id / integer / ID of the finished map
- user_id / integer / ID of the user who finished the map
(use None for anonymous user)
- nickname / string / currently used nickname by the user
- time / decimal / user result
- checkpoints / string / semicolon-delimited (;) list of checkpoint times
Results
- 400 - when data fails validation
dictionary containing error message(s)
- 200 - when everything went fine
Run object
"""
allowed_actions = ['new']
if action in allowed_actions:
return getattr(self, '_create_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, action):
"""
URL
**/api/1/ping/**
Shortdesc
Updates server and its users last connection time.
Arguments
- none
Data
- users / dictionary / (int)user_id:(string)nickname dictionary
- anonymous / tuple / a tuple with anonymous' nicknames
- map / string / currently played map
Result
- 200 - when everything went fine
a dictionary containing a list of new awards given
to the users on this server
"""
if action != 'ping':
return rc(rcs.BAD_REQUEST)
server = request.server
users_dict = request.data.get('users', {})
badges_list = list()
if users_dict:
user_ids = users_dict.keys()
# get a list of newly awarded badges
badges_awarded = BadgeAward.objects.filter(
user__id__in=user_ids,
awarded_at__gt=F('user__profile__last_connection_at')
)
for badge in badges_awarded:
badges_list.append({
"name": badges._registry[badge.slug].levels[badge.level].name,
"user_id": badge.user.id,
})
# removing the relationship for users not present on the server
server.players.exclude(id__in=user_ids).update(
last_played_server=None
)
# updating users' last connection time
UserProfile.objects.filter(id__in=user_ids).update(
last_played_server=request.server,
last_connection_at=datetime.now()
)
# TODO save nicknames of logged users
server.anonymous_players = request.data.get('anonymous', ())
server.played_map = get_object_or_None(Map, name=request.data.get('map'))
server.save()
return {
'awards': badges_list,
}
def create(self, request, action):
"""
URL
**/api/1/ping/**
Shortdesc
Updates server and its users last connection time.
Arguments
- none
Data
- users / dictionary / (int)user_id:(string)nickname dictionary
- anonymous / tuple / a tuple with anonymous' nicknames
- map / string / currently played map
Result
- 200 - when everything went fine
a dictionary containing a list of new awards given
to the users on this server
"""
if action != 'ping':
return rc(rcs.BAD_REQUEST)
server = request.server
users_dict = request.data.get('users', {})
badges_list = list()
if users_dict:
user_ids = users_dict.keys()
# get a list of newly awarded badges
badges_awarded = BadgeAward.objects.filter(
user__id__in=user_ids,
awarded_at__gt=F('user__profile__last_connection_at'))
for badge in badges_awarded:
badges_list.append({
"name":
badges._registry[badge.slug].levels[badge.level].name,
"user_id":
badge.user.id,
})
# removing the relationship for users not present on the server
server.players.exclude(id__in=user_ids).update(
last_played_server=None)
# updating users' last connection time
UserProfile.objects.filter(id__in=user_ids).update(
last_played_server=request.server,
last_connection_at=datetime.now())
# TODO save nicknames of logged users
server.anonymous_players = request.data.get('anonymous', ())
server.played_map = get_object_or_None(Map,
name=request.data.get('map'))
server.save()
return {
'awards': badges_list,
}
def _create_ghost(self, request, *args, **kwargs):
try:
map_obj = Map.objects.get(pk=kwargs['map_id'])
except (Map.DoesNotExist, KeyError):
return rc(rcs.BAD_REQUEST, "Map with specified map_id doesn't exist")
try:
user = User.objects.get(pk=kwargs['user_id'])
except (User.DoesNotExist, KeyError):
return rc(rcs.BAD_REQUEST, "User with specified user_id doesn't exist")
try:
best_run = BestRun.objects.get(map=map_obj, user=user)
except BestRun.DoesNotExist:
return rc(rcs.BAD_REQUEST, "There's no BestRun matching"
" this user/map pair.")
best_run.ghost_file = request.form.cleaned_data.get('ghost_file')
best_run.save()
return rc(rcs.ALL_OK)
def _update_skin(self, request, *args, **kwargs):
if 'id' in kwargs:
try:
profile = UserProfile.objects.get(id=kwargs['id'])
except UserProfile.DoesNotExist:
return rc(rcs.BAD_REQUEST)
profile.has_skin = True
form = request.form.cleaned_data
profile.skin_name = form['skin_name']
if 'body_color' in form and 'feet_color' in form:
profile.skin_body_color_raw = form['body_color']
profile.skin_body_color = rgblong_to_hex(form['body_color'])
profile.skin_feet_color_raw = form['feet_color']
profile.skin_feet_color = rgblong_to_hex(form['feet_color'])
else:
profile.skin_body_color_raw = None
profile.skin_body_color = ''
profile.skin_feet_color_raw = None
profile.skin_feet_color = ''
profile.save()
return profile
return rc(rcs.BAD_REQUEST)
def _update_skin(self, request, *args, **kwargs): if 'id' in kwargs: try: profile = UserProfile.objects.get(id=kwargs['id']) except UserProfile.DoesNotExist: return rc(rcs.BAD_REQUEST) profile.has_skin = True form = request.form.cleaned_data profile.skin_name = form['skin_name'] if 'body_color' in form and 'feet_color' in form: profile.skin_body_color_raw = form['body_color'] profile.skin_body_color = rgblong_to_hex(form['body_color']) profile.skin_feet_color_raw = form['feet_color'] profile.skin_feet_color = rgblong_to_hex(form['feet_color']) else: profile.skin_body_color_raw = None profile.skin_body_color = '' profile.skin_feet_color_raw = None profile.skin_feet_color = '' profile.save() return profile return rc(rcs.BAD_REQUEST)
def _create_ghost(self, request, *args, **kwargs):
try:
map_obj = Map.objects.get(pk=kwargs['map_id'])
except (Map.DoesNotExist, KeyError):
return rc(rcs.BAD_REQUEST,
"Map with specified map_id doesn't exist")
try:
user = User.objects.get(pk=kwargs['user_id'])
except (User.DoesNotExist, KeyError):
return rc(rcs.BAD_REQUEST,
"User with specified user_id doesn't exist")
try:
best_run = BestRun.objects.get(map=map_obj, user=user)
except BestRun.DoesNotExist:
return rc(rcs.BAD_REQUEST, "There's no BestRun matching"
" this user/map pair.")
best_run.ghost_file = request.form.cleaned_data.get('ghost_file')
best_run.save()
return rc(rcs.ALL_OK)
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/maps/detail/{map_id}/**
Shortdesc
Returns an instance of Map.
Arguments
- map_id / integer / ID of the map
Data
- none
Result
- 404 - when Map with specified map_id doesn't exist
- 400 - when there was no map_id specified
- 200 - when everything went fine
Map object
URL
**/api/1/maps/list/[{type}/]**
Shortdesc
Returns a list containing all Map objects
Arguments
- type / string / types of map (seperated by space)
Data
- none
Result
- 200 - when everything went fine
a list of Map objects
URL
**/api/1/maps/rank/{map_id}/[{offset}/]**
Shortdesc
Returns a list containing 5 elements of map rank,
starting with offset (default is 1)
Arguments
- map_id / integer / ID of the map
- offset / integer /
Data
- none
Result
- 200 - when everything went fine
a list of BestRun objects
"""
# without '_read_' prefix
allowed_actions = ['list', 'detail', 'rank']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/maps/detail/{map_id}/**
Shortdesc
Returns an instance of Map.
Arguments
- map_id / integer / ID of the map
Data
- none
Result
- 404 - when Map with specified map_id doesn't exist
- 400 - when there was no map_id specified
- 200 - when everything went fine
Map object
URL
**/api/1/maps/list/[{type}/]**
Shortdesc
Returns a list containing all Map objects
Arguments
- type / string / types of map (seperated by space)
Data
- none
Result
- 200 - when everything went fine
a list of Map objects
URL
**/api/1/maps/rank/{map_id}/[{offset}/]**
Shortdesc
Returns a list containing 5 elements of map rank,
starting with offset (default is 1)
Arguments
- map_id / integer / ID of the map
- offset / integer /
Data
- none
Result
- 200 - when everything went fine
a list of BestRun objects
"""
# without '_read_' prefix
allowed_actions = ['list', 'detail', 'rank']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs):
"""
URL
**/api/1/activity/new/**
Arguments
- none
Data
- user_id / integer / ID of User associated to this event
- event_type / string /
Result
- 200 - when everything went fine
"""
allowed_actions = ['new']
if action in allowed_actions:
return getattr(self, '_create_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs): """ URL **/api/1/activity/new/** Arguments - none Data - user_id / integer / ID of User associated to this event - event_type / string / Result - 200 - when everything went fine """ allowed_actions = ['new'] if action in allowed_actions: return getattr(self, '_create_' + action)(request, *args, **kwargs) return rc(rcs.BAD_REQUEST)
def read(self, request, action):
"""
URL
**/api/1/hello/**
Shortdesc
Allows gameserver to check if webapp is online.
Arguments
- none
Data
- none
Result
- 200 - always
PONG
"""
if action != 'hello':
return rc(rcs.BAD_REQUEST)
return "PONG"
def read(self, request, action): """ URL **/api/1/hello/** Shortdesc Allows gameserver to check if webapp is online. Arguments - none Data - none Result - 200 - always PONG """ if action != 'hello': return rc(rcs.BAD_REQUEST) return "PONG"
def read(self, request, action, *args, **kwargs): """ URL **/api/1/anonclient/servers/** Shortdesc Returns a list of Teerace servers. Arguments - none Data - none Result - 200 list of Server objects """ allowed_actions = ['servers'] if action in allowed_actions: return getattr(self, '_read_' + action)(request, *args, **kwargs) return rc(rcs.BAD_REQUEST)
def create(self, request, file_type, *args, **kwargs):
"""
URL
**/api/1/files/demo/{user_id}/{map_id}/**
Shortdesc
Adds new demo
Additional notes
It requires demo_file in request.FILES
Arguments
- user_id / integer / ID of User associated to demo
- map_id / integer / ID of Map associated to demo
Data
- none
Result
- 400 - when Map with specified map_id doesn't exist
- 400 - when User with specified user_id doesn't exist
- 400 - when BestRun with specified Map/User doesn't exist
- 200 - when everything went fine
URL
**/api/1/files/ghost/{user_id}/{map_id}/**
Shortdesc
Adds new ghost
Additional notes
It requires ghost_file in request.FILES
Arguments
- user_id / integer / ID of User associated to ghost
- map_id / integer / ID of Map associated to ghost
Data
- none
Result
- 400 - when Map with specified map_id doesn't exist
- 400 - when User with specified user_id doesn't exist
- 400 - when BestRun with specified Map/User doesn't exist
- 200 - when everything went fine
"""
# without '_create_' prefix
allowed_actions = ['demo', 'ghost']
if file_type in allowed_actions:
return getattr(self, '_create_' + file_type)(request, *args,
**kwargs)
return rc(rcs.BAD_REQUEST)
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/anonclient/servers/**
Shortdesc
Returns a list of Teerace servers.
Arguments
- none
Data
- none
Result
- 200
list of Server objects
"""
allowed_actions = ['servers']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, file_type, *args, **kwargs):
"""
URL
**/api/1/files/demo/{user_id}/{map_id}/**
Shortdesc
Adds new demo
Additional notes
It requires demo_file in request.FILES
Arguments
- user_id / integer / ID of User associated to demo
- map_id / integer / ID of Map associated to demo
Data
- none
Result
- 400 - when Map with specified map_id doesn't exist
- 400 - when User with specified user_id doesn't exist
- 400 - when BestRun with specified Map/User doesn't exist
- 200 - when everything went fine
URL
**/api/1/files/ghost/{user_id}/{map_id}/**
Shortdesc
Adds new ghost
Additional notes
It requires ghost_file in request.FILES
Arguments
- user_id / integer / ID of User associated to ghost
- map_id / integer / ID of Map associated to ghost
Data
- none
Result
- 400 - when Map with specified map_id doesn't exist
- 400 - when User with specified user_id doesn't exist
- 400 - when BestRun with specified Map/User doesn't exist
- 200 - when everything went fine
"""
# without '_create_' prefix
allowed_actions = ['demo', 'ghost']
if file_type in allowed_actions:
return getattr(self, '_create_' + file_type)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs):
"""
URL
**/api/1/anonclient/get_token/**
Shortdesc
Returns API token of the matched User.
Arguments
- none
Data
- username / string / username of the user
- password / string / user's password
Result
- 200, when there was no match
False
- 200, when there is a match
Matched user API token
"""
allowed_actions = ['get_token']
if action in allowed_actions:
return getattr(self, '_create_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def update(self, request, action, *args, **kwargs):
"""
URL
**/api/1/users/skin/{id}/**
Shortdesc
Updates user skin settings
Arguments
- id / ID of the user
Data
- skin_name / string /
name of used skin; if it's not an official skin,
defaults to 'default'
- body_color / integer / rgblong representation of body color
- feet_color / integer / rgblong representation of feet color
Result
- 400, when data fails validation
- 400, when requested UserProfile doesn't exist
- 200, when everything went fine
UserProfile object
URL
**/api/1/users/playtime/{id}/**
Shortdesc
Updates user playtime (time the player spends on the server)
Arguments
- id / ID of the user
Data
- seconds / integer / number of seconds to update the count
Result
- 400, when data fails validation
- 400, when requested UserProfile doesn't exist
- 200, when everything went fine
"""
# without '_update_' prefix
allowed_actions = ['skin', 'playtime']
if action in allowed_actions:
return getattr(self, '_update_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/runs/detail/{id}/**
Shortdesc
Returns an instance of Run.
Arguments
- id / integer / ID of requested Run
Data
- none
Result
- 404 - when Run with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
Run object
"""
# without '_read_' prefix
allowed_actions = ['detail']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def update(self, request, action, *args, **kwargs):
"""
URL
**/api/1/users/skin/{id}/**
Shortdesc
Updates user skin settings
Arguments
- id / ID of the user
Data
- skin_name / string /
name of used skin; if it's not an official skin,
defaults to 'default'
- body_color / integer / rgblong representation of body color
- feet_color / integer / rgblong representation of feet color
Result
- 400, when data fails validation
- 400, when requested UserProfile doesn't exist
- 200, when everything went fine
UserProfile object
URL
**/api/1/users/playtime/{id}/**
Shortdesc
Updates user playtime (time the player spends on the server)
Arguments
- id / ID of the user
Data
- seconds / integer / number of seconds to update the count
Result
- 400, when data fails validation
- 400, when requested UserProfile doesn't exist
- 200, when everything went fine
"""
# without '_update_' prefix
allowed_actions = ['skin', 'playtime']
if action in allowed_actions:
return getattr(self, '_update_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/runs/detail/{id}/**
Shortdesc
Returns an instance of Run.
Arguments
- id / integer / ID of requested Run
Data
- none
Result
- 404 - when Run with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
Run object
"""
# without '_read_' prefix
allowed_actions = ['detail']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs): """ URL **/api/1/anonclient/get_token/** Shortdesc Returns API token of the matched User. Arguments - none Data - username / string / username of the user - password / string / user's password Result - 200, when there was no match False - 200, when there is a match Matched user API token """ allowed_actions = ['get_token'] if action in allowed_actions: return getattr(self, '_create_' + action)(request, *args, **kwargs) return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs): """ URL **/api/1/users/auth_token/** Shortdesc Handles user/password checking. Longdesc Returns User object or False, whether provided api token passes the test. Arguments - none Data - api_token / string / user's API token Result - 200, when data fails validation False - 200, when user data are correct User object URL **/api/1/users/get_by_name/** Shortdesc Returns User object of the matched username. Arguments - none Data - username / string / searched user name Result - 404, when there was no match - 200, when there is a match User object """ allowed_actions = ['auth_token', 'get_by_name'] if action in allowed_actions: return getattr(self, '_create_' + action)(request, *args, **kwargs) return rc(rcs.BAD_REQUEST)
def create(self, request, action, *args, **kwargs):
"""
URL
**/api/1/users/auth_token/**
Shortdesc
Handles user/password checking.
Longdesc
Returns User object or False, whether provided
api token passes the test.
Arguments
- none
Data
- api_token / string / user's API token
Result
- 200, when data fails validation
False
- 200, when user data are correct
User object
URL
**/api/1/users/get_by_name/**
Shortdesc
Returns User object of the matched username.
Arguments
- none
Data
- username / string / searched user name
Result
- 404, when there was no match
- 200, when there is a match
User object
"""
allowed_actions = ['auth_token', 'get_by_name']
if action in allowed_actions:
return getattr(self, '_create_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def create(self, request, action):
"""
URL
**/api/1/ping/**
Shortdesc
Updates server and its users last connection time.
Arguments
- none
Data
- users / dictionary / (int)user_id:(string)nickname dictionary
- anonymous / tuple / a tuple with anonymous' nicknames
- map / string / currently played map
Result
- 200 - when everything went fine
PONG
"""
if action != 'ping':
return rc(rcs.BAD_REQUEST)
server = request.server
users_dict = request.data.get('users')
if users_dict:
user_ids = users_dict.keys()
# removing the relationship for users not present on the server
server.players.exclude(id__in=user_ids).update(
last_played_server=None
)
# updating users' last connection time
UserProfile.objects.filter(id__in=user_ids).update(
last_played_server=request.server,
last_connection_at=datetime.now()
)
# TODO save nicknames of logged users
server.anonymous_players = request.data.get('anonymous') or ()
server.played_map = get_object_or_None(Map, name=request.data.get('map'))
server.save()
return "PONG"
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/users/detail/{id}/**
Shortdesc
Returns an instance of User.
Arguments
- id / integer / ID of requested User
Data
- none
Result
- 404 - when User with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
User object
URL
**/api/1/users/profile/{id}/**
Shortdesc
Returns an instance of user's UserProfile.
Arguments
- id / integer / ID of requested UserProfile
Data
- none
Result
- 404 - when UserProfile with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
UserProfile object
URL
**/api/1/users/rank/{id}/**
Shortdesc
Returns user global rank.
Arguments
- id / integer / ID of User
Data
- none
Result
- 404 - when UserProfile with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
(integer) user global rank
OR None when the user is not ranked
URL
**/api/1/users/map_rank/{id}/{map_id}/**
Shortdesc
Returns user global rank.
Arguments
- id / integer / ID of the user
- map_id / integer / ID of the map
Data
- none
Result
- 404 - when UserProfile with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
(integer) user map rank
"""
# without '_read_' prefix
allowed_actions = ['detail', 'profile', 'rank', 'map_rank']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
def read(self, request, action, *args, **kwargs):
"""
URL
**/api/1/users/detail/{id}/**
Shortdesc
Returns an instance of User.
Arguments
- id / integer / ID of requested User
Data
- none
Result
- 404 - when User with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
User object
URL
**/api/1/users/profile/{id}/**
Shortdesc
Returns an instance of user's UserProfile.
Arguments
- id / integer / ID of requested UserProfile
Data
- none
Result
- 404 - when UserProfile with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
UserProfile object
URL
**/api/1/users/rank/{id}/**
Shortdesc
Returns user global rank.
Arguments
- id / integer / ID of User
Data
- none
Result
- 404 - when UserProfile with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
(integer) user global rank
OR None when the user is not ranked
URL
**/api/1/users/map_rank/{id}/{map_id}/**
Shortdesc
Returns user global rank.
Arguments
- id / integer / ID of the user
- map_id / integer / ID of the map
Data
- none
Result
- 404 - when UserProfile with specified ID doesn't exist
- 400 - when there was no ID specified
- 200 - when everything went fine
(integer) user map rank
"""
# without '_read_' prefix
allowed_actions = ['detail', 'profile', 'rank', 'map_rank']
if action in allowed_actions:
return getattr(self, '_read_' + action)(request, *args, **kwargs)
return rc(rcs.BAD_REQUEST)
