__author__ = 'Aran' from flask import Blueprint import json from GithubAPI.GithubAPI import GitHubAPI_Keys from google.appengine.ext import db import requests import datetime from flask import Flask, request, render_template, redirect, abort, Response from flask.ext.github import GitHub from flask.ext.cors import CORS, cross_origin from flask.ext.autodoc import Autodoc # DB Models from models.User import User from models.Course import Course from models.Project import Project #Validation Utils Libs from SE_API.Validation_Utils import * from SE_API.Respones_Utils import * user_routes = Blueprint("user_routes", __name__) auto = Autodoc() #---------------------------------------------------------- # POST #---------------------------------------------------------- #---------------------------------------------------------- # PUT #---------------------------------------------------------- @user_routes.route('/api/users/updateUser/', methods=["PUT"]) @auto.doc() def updateUser(token): """ >This Call will update user details
Route Parameters
- seToken: 'seToken'

Payload
- JSON Object, Example:
{
'name': 'new name',
'isLecturer': true,
}

Response
200 - User updated
400 - Bad Request """ if not request.data: return bad_request() try: payload = json.loads(request.data) except Exception as e: return bad_request() user = get_user_by_token(token) if user is None: return bad_request("Not a user!") try: user.name = payload['name'] except Exception: pass try: user.isLecturer = payload['isLecturer'] except Exception as e: print e db.put(user) db.save return ok("User updated") @user_routes.route('/api/users/addUserToCourse/', methods=["PUT"]) @auto.doc() def addUserToCourse(token): """ >This Call will add a course to user course list
Route Parameters
- seToken: 'seToken'

Payload
- JSON Object, Example:
{
'courseId': 1234567890
}

Response
200 - User updated
400 - Bad Request """ if not request.data: return bad_request() try: payload = json.loads(request.data) except Exception as e: return bad_request() #check user exists user = get_user_by_token(token) if user is None: return bad_request("Not a user!") #check course Exists course = Course.get_by_id(payload['coursesId']) if course is None: return bad_request("No such Course!") try: user.courses_id_list.append(payload['coursesId']) except Exception as e: print e return bad_request() db.put(user) db.save return Response(response=user.to_JSON(), status=200, mimetype="application/json") # Real response! @user_routes.route('/api/users/addUserToCampus/', methods=["PUT"]) @auto.doc() def addUserToCampus(token): """ >This Call will add a Campus to user Campus list
Route Parameters
- seToken: 'seToken'

Payload
- JSON Object, Example:
{
'campusId': 1234567890
}

Response
200 - User updated
400 - Bad Request """ if not request.data: return bad_request() try: payload = json.loads(request.data) except Exception as e: print e return bad_request() if not is_lecturer(token): #todo: change to lecturer id return forbidden("Invalid token or not a lecturer!") user = get_user_by_token(token) #check Campus Exists campus = Campus.get_by_id(payload['campusId']) if campus is None: return bad_request("No such Campus!") try: if str(payload['campusId']) in user.campuses_id_list: return accepted("Already a member of that campus") user.campuses_id_list.append(str(payload['campusId'])) except Exception as e: print e return bad_request() db.put(user) db.save return Response(response=user.to_JSON(), status=200, mimetype="application/json") # Real response! #---------------------------------------------------------- # GET #---------------------------------------------------------- @user_routes.route('/api/users/getUserByToken/', defaults={'token': None}) @user_routes.route('/api/users/getUserByToken/', methods=["GET"]) @auto.doc() def getUserByToken(token): """ >This Call will return a user by a given token
Route Parameters
- seToken: 'seToken'

Payload
- NONE

Response
200 - JSON Example:
{
'username': 'DarkLord',
'name': 'Darth Vader',
'email': 'darkLord@death.planet,
'isLecturer': 'True',
'seToken': 'xxxxxx-xxxxx-xxxxx-xxxxxx',
'avatar_url': 'http://location.git.com/somthing'
'isFirstLogin': False,
'campuses_id_list': [{
'master_user_id': 111,
'id': 5629499534213120,
'email_ending': "@post.jce.ac.il",
'avatar_url': "https://yt3.ggpht.com/--ZkWxybWGOM/AAAAAAAAAAI/AAAAAAAAAAA/_nAICC_kzzI/s88-c-k-no/photo.jpg",
'title': "JCE" }],
'courses_id_list': ['a','b','c']
}
403 - No User Found """ if token is None: return no_content("Token Is Empty, No User Found") query = User.all() query.filter("seToken =", token) for u in query.run(limit=5): for index, c in enumerate(u.campuses_id_list): c = json.loads(Campus.get_by_id(int(c)).to_JSON()) u.campuses_id_list[index] = c return Response(response=u.to_JSON(), status=200, mimetype="application/json") # Real response! return no_content("No User Found") @user_routes.route('/api/users/getUserById/', defaults={'token': None, 'id': None}) @user_routes.route('/api/users/getUserById//', methods=["GET"]) @auto.doc() def getUserById(token, id): """ >This Call will return a user by a given UserId
Route Parameters
- seToken: 'seToken'

Payload
- NONE

Response
200 - JSON Example:
{
'username': 'DarkLord',
'name': 'Darth Vader',
'email': 'darkLord@death.planet,
'isLecturer': 'True',
'seToken': 'xxxxxx-xxxxx-xxxxx-xxxxxx',
'avatar_url': 'http://location.git.com/somthing'
'isFirstLogin': False,
'campuses_id_list': [{
'master_user_id': 111,
'id': 5629499534213120,
'email_ending': "@post.jce.ac.il",
'avatar_url': "https://yt3.ggpht.com/--ZkWxybWGOM/AAAAAAAAAAI/AAAAAAAAAAA/_nAICC_kzzI/s88-c-k-no/photo.jpg",
'title': "JCE" }],
'courses_id_list': ['a','b','c'],
'id': 234253523
}
403 - No User Found """ if token is None or id is None: return no_content("No Token/ID, No User Found") if get_user_by_token(token) is None: return forbidden('Invalid Token') u = get_user_by_id(int(id)) if u is None: return no_content('No user Found') for index, c in enumerate(u.campuses_id_list): c = json.loads(Campus.get_by_id(int(c)).to_JSON()) u.campuses_id_list[index] = c return Response(response=u.to_JSON(), status=200, mimetype="application/json") # Real response! return no_content("No User Found") @user_routes.route('/api/users/getUsersByCampus//', methods=["GET"]) @auto.doc() def getUsersByCampus(token, campusId): """ >This Call will return all users in Campus
Route Parameters
- seToken: 'seToken'
- campusId: 123456789

Payload
- NONE

Response
200 - JSON Example:
{
'username': 'DarkLord',
'name': 'Darth Vader',
'email': 'darkLord@death.planet,
'isLecturer': 'True',
'seToken': 'xxxxxx-xxxxx-xxxxx-xxxxxx',
'avatar_url': 'http://location.git.com/somthing'
'isFirstLogin': False,
'campuses_id_list': [75894378,5893482,894032],
'courses_id_list': [4324,432432,4324324]
}
403 - No User Found """ if token is None: return no_content("Token Is Empty, No User Found") user = get_user_by_token(token) if user is None: return bad_request("Bad User Token") campus = Campus.get_by_id(int(campusId)) if campus is None: return bad_request("No such Campus") arr = [] for u in enumerate(campus.membersId): u = json.loads(User.get_by_id(int(u)).to_JSON()) arr.append(dict(u)) if len(arr) != 0: return Response(response=json.dumps(arr), status=200, mimetype="application/json") else: return Response(response=[], status=200, mimetype="application/json") @user_routes.route('/api/users/getUsersByCourse//', methods=["GET"]) @auto.doc() def getUsersByCourse(token, courseId): """ >This Call will return all users in Course
Route Parameters
- seToken: 'seToken'
- courseId: 123456789

Payload
- NONE

Response
200 - JSON Example:
{
'username': 'DarkLord',
'name': 'Darth Vader',
'email': 'darkLord@death.planet,
'isLecturer': 'True',
'seToken': 'xxxxxx-xxxxx-xxxxx-xxxxxx',
'avatar_url': 'http://location.git.com/somthing'
'isFirstLogin': False,
'campuses_id_list': [1243567,7583584904],
'courses_id_list': [543543,54353453,543543534]
}
403 - No User Found """ if token is None: return no_content("Token Is Empty, No User Found") user = get_user_by_token(token) if user is None: return bad_request("Bad User Token") course = Course.get_by_id(int(courseId)) if course is None: return bad_request("No such Course") arr = [] for u in enumerate(course.membersId): u = json.loads(User.get_by_id(int(u)).to_JSON()) arr.append(dict(u)) if len(arr) != 0: return Response(response=json.dumps(arr), status=200, mimetype="application/json") else: return Response(response=[], status=200, mimetype="application/json") @user_routes.route('/api/users/getUsersByProject//', methods=["GET"]) @auto.doc() def getUsersByProject(token, projectId): """ >This Call will return all users in Project
Route Parameters
- seToken: 'seToken'
- projectId: 123456789

Payload
- NONE

Response
200 - JSON Example:
{
'username': 'DarkLord',
'name': 'Darth Vader',
'email': 'darkLord@death.planet,
'isLecturer': 'True',
'seToken': 'xxxxxx-xxxxx-xxxxx-xxxxxx',
'avatar_url': 'http://location.git.com/somthing'
'isFirstLogin': False,
'campuses_id_list': [43243532532,5325325325,532532342],
'courses_id_list': [53523,43432423,432432432432]
}
403 - No User Found """ if token is None: return no_content("Token Is Empty, No User Found") user = get_user_by_token(token) if user is None: return bad_request("Bad User Token") project = Project.get_by_id(int(projectId)) if project is None: return bad_request("No such Project") arr = [] for u in enumerate(project.membersId): u = json.loads(User.get_by_id(int(u)).to_JSON()) arr.append(dict(u)) if len(arr) != 0: return Response(response=json.dumps(arr), status=200, mimetype="application/json") else: return Response(response=[], status=200, mimetype="application/json") #---------------------------------------------------------- # DELETE #---------------------------------------------------------- @user_routes.route('/api/users/removeUserFromCampus///', methods=["PUT"]) @auto.doc() def removeUserFromCampus(token, userId, campusId): """ >This Call will remove a user from a campus
Route Parameters
- seToken: 'seToken'
- userId: 0987654321,
- 'campusId': 1234567890


Payload
- NONE {
}

Response
200 - User updated
400 - Bad Request """ requestingUser = get_user_by_token(token) if requestingUser is None: return bad_request("Bad User Token") userToRemove = User.get_by_id(int(userId)) if userToRemove is None: return bad_request("No such user to remove") #check Campus Exists campus = Campus.get_by_id(int(campusId)) if campus is None: return bad_request("No such Campus!") #check if user is owner of Campus if requestingUser.key().id() != campus.master_user_id: # check if user want to delete itself if requestingUser.key().id() != userToRemove.key().id(): return forbidden("No permission to delete user") try: userToRemove.campuses_id_list.remove(campusId) except Exception as e: return bad_request("user is not listed to this campus") db.put(userToRemove) db.save return Response(response=userToRemove.to_JSON(), status=200, mimetype="application/json") # Real response! @user_routes.route('/api/users/removeUserFromCourse///', methods=["PUT"]) @auto.doc() def removeUserFromCourse(token, userId, courseId): """ >This Call will remove a user from a course
Route Parameters
- seToken: 'seToken'
- userId: 0987654321,
- 'courseId': 1234567890


Payload
- NONE {
}

Response
200 - User updated
400 - Bad Request """ requestingUser = get_user_by_token(token) if requestingUser is None: return bad_request("Bad User Token") userToRemove = User.get_by_id(int(userId)) if userToRemove is None: return bad_request("No such user to remove") #check Course Exists course = Course.get_by_id(int(courseId)) if course is None: return bad_request("No such Course!") #check if user is owner of Course if requestingUser.key().id() != course.master_id: # check if user want to delete itself if requestingUser.key().id() != userToRemove.key().id(): return forbidden("No permission to delete user") try: userToRemove.courses_id_list.remove(courseId) course.membersId.remove(userToRemove.key().id()) except Exception as e: return bad_request("user is not listed to this course") db.put(userToRemove) db.put(course) db.save return Response(response=userToRemove.to_JSON(), status=200, mimetype="application/json") # Real response! @user_routes.route('/api/users/removeUserFromProject///', methods=["PUT"]) @auto.doc() def removeUserFromProject(token, userId, projectId): """ >This Call will remove a user from a project
Route Parameters
- seToken: 'seToken'
- userId: 0987654321,
- 'projectId': 1234567890


Payload
- NONE {
}

Response
200 - User updated
400 - Bad Request """ requestingUser = get_user_by_token(token) if requestingUser is None: return bad_request("Bad User Token") userToRemove = User.get_by_id(int(userId)) if userToRemove is None: return bad_request("No such user to remove") #check project Exists project = Project.get_by_id(int(projectId)) if project is None: return bad_request("No such Project!") #check if user is owner of project if requestingUser.key().id() != project.master_id: # check if user want to delete itself if requestingUser.key().id() != userToRemove.key().id(): return forbidden("No permission to delete user") try: userToRemove.projects_id_list.remove(projectId) project.membersId.remove(userToRemove.key().id()) except Exception as e: return bad_request("user is not listed to this project") db.put(userToRemove) db.put(project) db.save return Response(response=userToRemove.to_JSON(), status=200, mimetype="application/json") # Real response! #---------------------------------------------------------- # DOCUMENTATION #---------------------------------------------------------- @user_routes.route('/api/users/help') def documentation(): return auto.html()