- Route Parameters
- - validation_token: 'seToken|email_suffix' -
-
- Payload
- - NONE -
-
- Response -
- 200 - JSON Example:
-
- {
- 'username' : 'github_username',
- 'name' : 'Bob Dylan',
- 'email' : 'email@domain.com',
- 'isLecturer' : true,
- 'seToken' : 'dds2d-sfvvsf-qqq-fdf33-sfaa',
- 'avatar_url' : 'http://location.domain.com/image.jpg',
- 'isFirstLogin' : false,
- 'campuses_id_list': ['22314','243512',...,'356'],
- 'classes_id_list': ['22314','243512',...,'356']
- }
-
- - 403 - Invalid Token - ''' - query = User.all() - query.filter("seToken = ", token) - - for u in query.run(limit=5): - return Response(response=u.to_JSON(), - status=201, - mimetype="application/json") # Real response! - - return Response(response=json.dumps({'message' : 'No User Found'}), - status=400, - mimetype="application/json") - @app.route('/githubOAuth') @@ -229,114 +198,6 @@ def oauth(oauth_token): return cookieMonster(user.seToken) -@app.route('/api/Campuses/create/
- Route Parameters
- - seToken: 'seToken' -
-
- Payload
- - JSON Object, Example:
- {
- 'title': 'Campus name',
- 'email_ending': '@campus.ac.com',
- 'avatar_url': 'http://location.domain.com/image.jpg'
- }
-
-
- Response -
- 201 - Created -
- 403 - Invalid Token/Forbidden - """ - print "1\n" - if not request.data: - return Response(response=json.dumps({'message': 'Bad Request0'}), - status=400, - mimetype="application/json") - payload = json.loads(request.data) - if not is_lecturer(token): #todo: change to lecturer id - return Response(response=json.dumps({'message': 'Invalid token or not a lecturer!'}), - status=403, - mimetype="application/json") - - user = get_user_by_token(token) - - #todo: check legality - - try: - campus = Campus(title=payload['title'], email_ending=payload['email_ending'], master_user_id=user.key().id(), avatar_url=payload['avatar_url']) - except Exception: - return Response(response=json.dumps({'message': 'Bad Request1'}), - status=400, - mimetype="application/json") - - db.put(campus) - db.save - return Response(response=json.dumps(campus.to_JSON()), - status=201, - mimetype="application/json") - - - - -@app.route('/api/Campuses/
- Route Parameters
- - seToken: 'seToken' -
-
- Payload
- - NONE
-
-
- Response -
- 200 - JSON Array, Example:
- [
- { - 'title': 'JCE',
- 'email_ending': '@post.jce.ac.il',
- 'master_user_id': 123453433341, (User that created the campus)
- 'avatar_url': 'http://some.domain.com/imagefile.jpg'
- },
- ....
- {
- ...
- }req
- ]
-
- 403 - Invalid Token
- 500 - Server Error - """ - if is_user_token_valid(token): - arr = [] - query = Campus.all() - for c in query.run(): - arr.append(dict(json.loads(c.to_JSON()))) - print arr - if len(arr) != 0: - return Response(response=json.dumps(arr), - status=200, - mimetype="application/json") - else: - return Response(response=[], - status=200, - mimetype="application/json") - else: - return Response(response=json.dumps({'message': 'Invalid Token'}), - status=403, - mimetype="application/json") - @app.route('/login') @@ -385,3 +246,5 @@ def cookieMonster(uid): response = app.make_response(redirect_to_home ) response.set_cookie('com.sehub.www',value=uid) return response + + diff --git a/SE_API/CampusRoutes.py b/SE_API/CampusRoutes.py new file mode 100644 index 0000000..11af4b3 --- /dev/null +++ b/SE_API/CampusRoutes.py @@ -0,0 +1,144 @@ +__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.Campus import Campus + +#Validation Utils Libs +from SE_API.Validation_Utils import * +from SE_API.Respones_Utils import * +from SE_API.Email_Utils import * + + + +campus_routes = Blueprint("campus_routes", __name__) +auto = Autodoc() + +@campus_routes.route('/api/campuses/create/
+ Route Parameters
+ - seToken: 'seToken' +
+
+ Payload
+ - JSON Object, Example:
+ {
+ 'title': 'Campus name',
+ 'email_ending': '@campus.ac.com',
+ 'avatar_url': 'http://location.domain.com/image.jpg'
+ }
+
+
+ Response +
+ 201 - Created +
+ 403 - Invalid Token/Forbidden + """ + if not request.data: + return bad_request() + if not is_lecturer(token): #todo: change to lecturer id + return forbidden("Invalid token or not a lecturer!") + + #try to parse payload + try: + payload = json.loads(request.data) + except Exception as e: + return bad_request(e) + + #check if name already exists + try: + query = Campus.all() + query.filter("title = ", payload['title']) + for c in query.run(limit=1): + return forbidden("Campus with same name already exists") + except Exception as e: + print e + + user = get_user_by_token(token) + + try: + campus = Campus(title=payload['title'], email_ending=payload['email_ending'], master_user_id=user.key().id(), avatar_url=payload['avatar_url']) + except Exception: + return bad_request() + + + send_create_campus_request(user.email, user.name, campus.title) + notify_se_hub_campus_request(campus, campus.title) + return ok() + + + + + +@campus_routes.route('/api/campuses/getAll/
+ Route Parameters
+ - seToken: 'seToken' +
+
+ Payload
+ - NONE
+
+
+ Response +
+ 200 - JSON Array, Example:
+ [
+ { + 'title': 'JCE',
+ 'email_ending': '@post.jce.ac.il',
+ 'master_user_id': 123453433341, (User that created the campus)
+ 'avatar_url': 'http://some.domain.com/imagefile.jpg'
+ },
+ ....
+ {
+ ...
+ }req
+ ]
+
+ 403 - Invalid Token
+ """ + if is_user_token_valid(token): + arr = [] + query = Campus.all() + for c in query.run(): + arr.append(dict(json.loads(c.to_JSON()))) + print arr + if len(arr) != 0: + return Response(response=json.dumps(arr), + status=200, + mimetype="application/json") + else: + return Response(response=[], + status=200, + mimetype="application/json") + else: + return forbidden("Invalid Token") + + + +@campus_routes.route('/api/campuses/help') +def documentation(): + return auto.html() diff --git a/SE_API/CourseRoutes.py b/SE_API/CourseRoutes.py new file mode 100644 index 0000000..4bae4ea --- /dev/null +++ b/SE_API/CourseRoutes.py @@ -0,0 +1,153 @@ +__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.Course import Course + +#Validation Utils Libs +from SE_API.Validation_Utils import * +from SE_API.Respones_Utils import * + + + +course_routes = Blueprint("course_routes", __name__) +auto = Autodoc() + + +@course_routes.route('/api/courses/create/
+ Route Parameters
+ - seToken: 'seToken' +
+
+ Payload
+ - JSON Object, Example:
+ {
+ 'courseName': 'Advance Math',
+ 'campusName': 'JCE',
+ 'startDate': '2015-14-3'
+ 'endDate': '2015-29-6'
+ 'taskFlag': 'False'
+ }
+
+
+ Response +
+ 201 - Created +
+ 400 - Bad Request +
+ 403 - Invalid token or not a lecturer + """ + if not request.data: + 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) + + #try to parse payload + try: + payload = json.loads(request.data) + except Exception as e: + return bad_request(e) + + + try: + start_date = datetime.date(payload['startDate']['year'],payload['startDate']['month'],payload['startDate']['day']) + end_date = datetime.date(payload['endDate']['year'],payload['endDate']['month'],payload['endDate']['day']) + + if end_date <= start_date: + return bad_request("end date cant be before (or same day) start date") + + course = Course(courseName=payload['courseName'], campusName=payload['campusName'], + startDate=start_date, endDate=end_date) + + #check if name already exists + try: + query = Course.all() + query.filter("courseName = ", payload['courseName']) + for c in query.run(limit=1): + return forbidden("Campus with same name already exists") + except Exception as e: + print e + + + except Exception: + return bad_request() + + + + db.put(course) + db.save + return Response(response=course.to_JSON(), + status=201, + mimetype="application/json") + + + +@course_routes.route('/api/courses/getCourseByCampusName/
+ Route Parameters
+ - name: 'campus name' +
+
+ Payload
+ - NONE +
+
+ Response +
+ 200 - JSON Example:
+
+ {
+ 'courseName': 'Advance Math',
+ 'campusName': 'JCE',
+ 'startDate': '2015-14-3'
+ 'endDate': '2015-29-6'
+ 'taskFlag': 'False'
+ }
+
+ + """ + arr = [] + query = Course.all() + query.filter("campusName = ", name) + + for c in query.run(): + arr.append(dict(json.loads(c.to_JSON()))) + print arr + if len(arr) != 0: + return Response(response=json.dumps(arr), + status=200, + mimetype="application/json") + else: + return Response(response=[], + status=200, + mimetype="application/json") + + +@course_routes.route('/api/courses/help') +def documentation(): + return auto.html() \ No newline at end of file diff --git a/SE_API/Email_Utils.py b/SE_API/Email_Utils.py new file mode 100644 index 0000000..683f7e8 --- /dev/null +++ b/SE_API/Email_Utils.py @@ -0,0 +1,127 @@ +__author__ = 'sagi' + + +from google.appengine.api import mail + + +def send_validation_email(token, email, name): + emailSuffix = str(email).split('@')[1] + message = mail.EmailMessage(sender="SE-Hub Support
+ http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" + to get access to your Campus :) + + Please let us know if you have any questions. + + SE-Hub (c) 2015 niptop Team. + """ + + message.html = """ + +
+
+ 
+
+
+
+
+
+
+
+ http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" + + to access you virtual class. +
+ Hey """+name+"""- Just one More Step...
+Dear """+name+""":
+ + To Activate your SE-Hub Account please click on the link below:+ http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" + + to access you virtual class. +
+ Please let us know if you have any questions. +
+ SE-Hub (c) 2015 niptop Team. + + + """ + + message.send() + +def send_create_campus_request(email, name, campus_name): + message = mail.EmailMessage(sender="SE-Hub Support
+ + Please let us know if you have any questions. + + SE-Hub (c) 2015 niptop Team. + """ + + message.html = """ + +
+
+
+
+
+
+
+
+
+
+ + to access you virtual class. +
+ Thank You For Choosing SE-Hub!
+Dear """+name+""":
+ + Your Request for creating a new Campus named """+campus_name + """ + is Being Evaluated. + You Will Receive an e-mail When We finish the process+ + to access you virtual class. +
+ Please let us know if you have any questions. +
+ SE-Hub (c) 2015 niptop Team. + + + """ + message.send() + + +def notify_se_hub_campus_request(campus, campus_name): + message = mail.EmailMessage(sender="SE-Hub Support
+
+
+
+
+
+
+
+
+
+ """ + str(campus.to_JSON()) + """ +
+ SE-Hub (c) 2015 niptop Team. + + + """ + message.send() diff --git a/SE_API/ProjectRoutes.py b/SE_API/ProjectRoutes.py new file mode 100644 index 0000000..18d2fb1 --- /dev/null +++ b/SE_API/ProjectRoutes.py @@ -0,0 +1,134 @@ +__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.Project import Project + +#Validation Utils Libs +from SE_API.Validation_Utils import * +from SE_API.Respones_Utils import * + + + +project_routes = Blueprint("project_routes", __name__) +auto = Autodoc() + +@project_routes.route('/api/projects/create/', methods=['POST'])
+@auto.doc()
+def create_project(token):
+ """
+ This call will create a new project in the DB
+
+ Route Parameters
+ - seToken: 'seToken' +
+
+ Payload
+ - JSON Object, Example:
+ {
+ 'projectName': 'Advance Math',
+ 'courseName': 'JCE',
+ 'logo_url': 'http://location.domain.com/image.jpg'
+ 'gitRepository': 'http://location.git.com/somthing'
+ }
+
+
+ Response +
+ 201 - Created +
+ 400 - Bad Request +
+ 403 - Invalid token or not a lecturer + """ + if not request.data: + return bad_request() + payload = json.loads(request.data) + if not is_lecturer(token): #todo: change to lecturer id + return forbidden("Invalid token or not a lecturer!") + + user = get_user_by_token(token) + + #todo: check legality + + try: + project = Project(projectName=payload['projectName'], courseName=payload['courseName'], masterId=user.key().id(), gitRepository=payload['gitRepository'], membersId=[token]) + except Exception as e: + print e + return bad_request() + + db.put(project) + db.save + return Response(response=project.to_JSON(), + status=201, + mimetype="application/json") + + + + + +@project_routes.route('/api/projects/getProjectsByCourseName/', methods=["GET"])
+@auto.doc()
+def getProjectsByCourseName(name):
+ """
+ >This Call will return an array of all projects in a given course
+
+ Route Parameters
+ - name: 'course name' +
+
+ Payload
+ - NONE +
+
+ Response +
+ 200 - JSON Example:
+
+ """ + + arr = [] + query = Project.all() + query.filter("courseName = ", name) + + for p in query.run(): + arr.append(dict(json.loads(p.to_JSON()))) + print arr + if len(arr) != 0: + return Response(response=json.dumps(arr), + status=200, + mimetype="application/json") + else: + return Response(response=[], + status=200, + mimetype="application/json") + + + + +@project_routes.route('/api/projects/help') +def documentation(): + return auto.html() \ No newline at end of file diff --git a/SE_API/Respones_Utils.py b/SE_API/Respones_Utils.py index b789974..3fe0e3f 100644 --- a/SE_API/Respones_Utils.py +++ b/SE_API/Respones_Utils.py @@ -3,6 +3,29 @@ __author__ = 'Aran' from flask import Response import json + +def ok(message='OK'): + return Response(response=json.dumps({'message': message}), + status=200, + mimetype="application/json") + +def created(message='Created'): + return Response(response=json.dumps({'message': message}), + status=201, + mimetype="application/json") + +def accepted(message='Accepted'): + return Response(response=json.dumps({'message': message}), + status=202, + mimetype="application/json") + + +def no_content(message='No Content'): + return Response(response=json.dumps({'message': message}), + status=204, + mimetype="application/json") + + def bad_request(message='Bad Request'): return Response(response=json.dumps({'message': message}), status=400, diff --git a/SE_API/UserRoutes.py b/SE_API/UserRoutes.py new file mode 100644 index 0000000..e487f2a --- /dev/null +++ b/SE_API/UserRoutes.py @@ -0,0 +1,75 @@ +__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 + +#Validation Utils Libs +from SE_API.Validation_Utils import * +from SE_API.Respones_Utils import * + + +user_routes = Blueprint("user_routes", __name__) +auto = Autodoc() + + +@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:
+
+ 403 - No User Found + """ + query = User.all() + query.filter("seToken = ", token) + + for u in query.run(limit=5): + return Response(response=u.to_JSON(), + status=200, + mimetype="application/json") # Real response! + + return bad_request("No User Found") + + +@user_routes.route('/api/users/help') +def documentation(): + return auto.html() \ No newline at end of file diff --git a/SE_API/Validation_Utils.py b/SE_API/Validation_Utils.py index e99b2bd..90df681 100644 --- a/SE_API/Validation_Utils.py +++ b/SE_API/Validation_Utils.py @@ -2,7 +2,7 @@ __author__ = 'sagi' from google.appengine.ext import db from models.User import User from models.Campus import Campus -from google.appengine.api import mail + def get_user_by_token(token): @@ -32,50 +32,3 @@ def is_lecturer(token): if user is None: return False return user.isLecturer - - -def send_validation_email(token, email, name): - emailSuffix = str(email).split('@')[1] - message = mail.EmailMessage(sender="SE-Hub Support",
- subject="SE-Hub Activate Account")
-
- message.to = email
-
- message.body = """
- Dear """+name+""":
-
- To Activate your SE-Hub Account please click on the link below:
- http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" - to get access to your Campus :) - - Please let us know if you have any questions. - - SE-Hub (c) 2015 niptop Team. - """ - - message.html = """ - -
- Please let us know if you have any questions. -
- SE-Hub (c) 2015 niptop Team. - - - """ - - message.send() diff --git a/Testing/UserAPI_Test.py b/Testing/UserAPI_Test.py index 179979e..e907400 100644 --- a/Testing/UserAPI_Test.py +++ b/Testing/UserAPI_Test.py @@ -17,20 +17,27 @@ class UserTestPlan(unittest.TestCase): print 'Initialized' def test_getUserByToken_invalid(self): - r = requests.get(self.__class__.url_+'api/getUserByToken/invalidtoken') - self.assertEquals(r.status_code, 204) - + r = requests.get(self.__class__.url_+'api/users/getUserByToken/invalidtoken') + self.assertEquals(r.status_code, 403) def test_getUserByToken_valid(self): - r = requests.get(self.__class__.url_+'api/getUserByToken/'+__CONFIG__['TOKENS']['STUDENT']) + r = requests.get(self.__class__.url_+'api/users/getUserByToken/'+__CONFIG__['TOKENS']['STUDENT']) self.assertEquals(r.status_code, 200) self.assertEquals(r.json()['username'], 'qa_student') - def test_getUserByToken_empty(self): - r = requests.get(self.__class__.url_+'api/getUserByToken/') + r = requests.get(self.__class__.url_+'api/users/getUserByToken/') self.assertEquals(r.status_code, 400) + def test_isStudent_Student(self): + r = requests.get(self.__class__.url_+'api/users/getUserByToken/'+__CONFIG__['TOKENS']['STUDENT']) + self.assertEquals(r.status_code, 200) + self.assertFalse(r.json()['isLecturer']) + + def test_isLecturer_Lecturer(self): + r = requests.get(self.__class__.url_+'api/users/getUserByToken/'+__CONFIG__['TOKENS']['LECTURER']) + self.assertEquals(r.status_code, 200) + self.assertTrue(r.json()['isLecturer']) if __name__ == '__main__': diff --git a/lib/flask_autodoc/templates/autodoc_default.html b/lib/flask_autodoc/templates/autodoc_default.html index 0d9b490..a512bd9 100644 --- a/lib/flask_autodoc/templates/autodoc_default.html +++ b/lib/flask_autodoc/templates/autodoc_default.html @@ -49,6 +49,9 @@
diff --git a/models/Course.py b/models/Course.py
index 83557a7..fd2dc08 100644
--- a/models/Course.py
+++ b/models/Course.py
@@ -6,17 +6,25 @@ from google.appengine.ext import db
class Course(db.Model):
courseName = db.StringProperty(required=True)
campusName = db.StringProperty(required=True)
- projects = db.StringListProperty(required=True)
+ master_id = db.IntegerProperty(required=True)
+ # projects = db.StringListProperty(required=True,default=[])
startDate = db.DateProperty(required=True)
- endDate = db.DateProperty(required=False)
- taskFlag = db.BooleanProperty(required=True)
+ endDate = db.DateProperty(required=True)
def to_JSON(self):
data = {'courseName' : self.courseName,
'campusName' : self.campusName,
- 'projects' : self.projects,
- 'startDate' : self.startDate,
- 'endDate' : self.endDate,
- 'taskFlag' : self.taskFlag,
+ 'master_id' : self.master_id,
+ # 'projects' : self.projects,
+ 'startDate' : {
+ 'year': self.startDate.year,
+ 'month': self.startDate.month,
+ 'day': self.startDate.day,
+ },
+ 'endDate' : {
+ 'year': self.endDate.year,
+ 'month': self.endDate.month,
+ 'day': self.endDate.day,
+ }
}
return json.dumps(data)
diff --git a/models/Project.py b/models/Project.py
index edecd83..579ecdd 100644
--- a/models/Project.py
+++ b/models/Project.py
@@ -5,13 +5,17 @@ from google.appengine.ext import db
class Project(db.Model):
projectName = db.StringProperty(required=True)
- grade = db.IntegerProperty(required=True)
- logo_url = db.StringProperty(required=True)
+ courseName = db.StringProperty(required=True)
+ master_id = db.IntegerProperty(required=True)
+ grade = db.IntegerProperty(required=True, default=0)
+ logo_url = db.StringProperty(required=False)
gitRepository = db.StringProperty(required=True)
membersId = db.StringListProperty(required=True)
def to_JSON(self):
data = {'projectName' : self.projectName,
+ 'courseName' : self.courseName,
+ 'master_id' : self.master_id,
'grade' : self.grade,
'logo_url' : self.logo_url,
'gitRepository' : self.gitRepository,
diff --git a/templates/API_Doc/api_doc_index.html b/templates/API_Doc/api_doc_index.html
new file mode 100644
index 0000000..6e88ea7
--- /dev/null
+++ b/templates/API_Doc/api_doc_index.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
+
+
+
+ New Campus!
++ """ + str(campus.to_JSON()) + """ +
+ SE-Hub (c) 2015 niptop Team. + + + """ + message.send() diff --git a/SE_API/ProjectRoutes.py b/SE_API/ProjectRoutes.py new file mode 100644 index 0000000..18d2fb1 --- /dev/null +++ b/SE_API/ProjectRoutes.py @@ -0,0 +1,134 @@ +__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.Project import Project + +#Validation Utils Libs +from SE_API.Validation_Utils import * +from SE_API.Respones_Utils import * + + + +project_routes = Blueprint("project_routes", __name__) +auto = Autodoc() + +@project_routes.route('/api/projects/create/
+ Route Parameters
+ - seToken: 'seToken' +
+
+ Payload
+ - JSON Object, Example:
+ {
+ 'projectName': 'Advance Math',
+ 'courseName': 'JCE',
+ 'logo_url': 'http://location.domain.com/image.jpg'
+ 'gitRepository': 'http://location.git.com/somthing'
+ }
+
+
+ Response +
+ 201 - Created +
+ 400 - Bad Request +
+ 403 - Invalid token or not a lecturer + """ + if not request.data: + return bad_request() + payload = json.loads(request.data) + if not is_lecturer(token): #todo: change to lecturer id + return forbidden("Invalid token or not a lecturer!") + + user = get_user_by_token(token) + + #todo: check legality + + try: + project = Project(projectName=payload['projectName'], courseName=payload['courseName'], masterId=user.key().id(), gitRepository=payload['gitRepository'], membersId=[token]) + except Exception as e: + print e + return bad_request() + + db.put(project) + db.save + return Response(response=project.to_JSON(), + status=201, + mimetype="application/json") + + + + + +@project_routes.route('/api/projects/getProjectsByCourseName/
+ Route Parameters
+ - name: 'course name' +
+
+ Payload
+ - NONE +
+
+ Response +
+ 200 - JSON Example:
+
+ {
+ 'projectName': 'Advance Math',
+ 'courseName': 'JCE',
+ 'grade': 98,
+ 'logo_url': 'http://location.domain.com/image.jpg',
+ 'gitRepository': 'http://location.git.com/somthing',
+ 'membersId': ['bob', 'dylan', 'quentin', 'terentino']
+ }
+
+ + """ + + arr = [] + query = Project.all() + query.filter("courseName = ", name) + + for p in query.run(): + arr.append(dict(json.loads(p.to_JSON()))) + print arr + if len(arr) != 0: + return Response(response=json.dumps(arr), + status=200, + mimetype="application/json") + else: + return Response(response=[], + status=200, + mimetype="application/json") + + + + +@project_routes.route('/api/projects/help') +def documentation(): + return auto.html() \ No newline at end of file diff --git a/SE_API/Respones_Utils.py b/SE_API/Respones_Utils.py index b789974..3fe0e3f 100644 --- a/SE_API/Respones_Utils.py +++ b/SE_API/Respones_Utils.py @@ -3,6 +3,29 @@ __author__ = 'Aran' from flask import Response import json + +def ok(message='OK'): + return Response(response=json.dumps({'message': message}), + status=200, + mimetype="application/json") + +def created(message='Created'): + return Response(response=json.dumps({'message': message}), + status=201, + mimetype="application/json") + +def accepted(message='Accepted'): + return Response(response=json.dumps({'message': message}), + status=202, + mimetype="application/json") + + +def no_content(message='No Content'): + return Response(response=json.dumps({'message': message}), + status=204, + mimetype="application/json") + + def bad_request(message='Bad Request'): return Response(response=json.dumps({'message': message}), status=400, diff --git a/SE_API/UserRoutes.py b/SE_API/UserRoutes.py new file mode 100644 index 0000000..e487f2a --- /dev/null +++ b/SE_API/UserRoutes.py @@ -0,0 +1,75 @@ +__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 + +#Validation Utils Libs +from SE_API.Validation_Utils import * +from SE_API.Respones_Utils import * + + +user_routes = Blueprint("user_routes", __name__) +auto = Autodoc() + + +@user_routes.route('/api/users/getUserByToken/
+ 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': ['JCA','JCB','JCC'],
+ 'classes_id_list': ['a','b','c']
+ }
+
+ + 403 - No User Found + """ + query = User.all() + query.filter("seToken = ", token) + + for u in query.run(limit=5): + return Response(response=u.to_JSON(), + status=200, + mimetype="application/json") # Real response! + + return bad_request("No User Found") + + +@user_routes.route('/api/users/help') +def documentation(): + return auto.html() \ No newline at end of file diff --git a/SE_API/Validation_Utils.py b/SE_API/Validation_Utils.py index e99b2bd..90df681 100644 --- a/SE_API/Validation_Utils.py +++ b/SE_API/Validation_Utils.py @@ -2,7 +2,7 @@ __author__ = 'sagi' from google.appengine.ext import db from models.User import User from models.Campus import Campus -from google.appengine.api import mail + def get_user_by_token(token): @@ -32,50 +32,3 @@ def is_lecturer(token): if user is None: return False return user.isLecturer - - -def send_validation_email(token, email, name): - emailSuffix = str(email).split('@')[1] - message = mail.EmailMessage(sender="SE-Hub Support
- http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" - to get access to your Campus :) - - Please let us know if you have any questions. - - SE-Hub (c) 2015 niptop Team. - """ - - message.html = """ - -
-
-
-
-
-
-
-
-
-
- http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" - - to access you virtual class. -
- Hey """+name+"""- Just one More Step...
-Dear """+name+""":
- - To Activate your SE-Hub Account please click on the link below:- http://se-hub.appspot.com/api/validation/confirm/"""+token+"""|"""+emailSuffix+""" - - to access you virtual class. -
- Please let us know if you have any questions. -
- SE-Hub (c) 2015 niptop Team. - - - """ - - message.send() diff --git a/Testing/UserAPI_Test.py b/Testing/UserAPI_Test.py index 179979e..e907400 100644 --- a/Testing/UserAPI_Test.py +++ b/Testing/UserAPI_Test.py @@ -17,20 +17,27 @@ class UserTestPlan(unittest.TestCase): print 'Initialized' def test_getUserByToken_invalid(self): - r = requests.get(self.__class__.url_+'api/getUserByToken/invalidtoken') - self.assertEquals(r.status_code, 204) - + r = requests.get(self.__class__.url_+'api/users/getUserByToken/invalidtoken') + self.assertEquals(r.status_code, 403) def test_getUserByToken_valid(self): - r = requests.get(self.__class__.url_+'api/getUserByToken/'+__CONFIG__['TOKENS']['STUDENT']) + r = requests.get(self.__class__.url_+'api/users/getUserByToken/'+__CONFIG__['TOKENS']['STUDENT']) self.assertEquals(r.status_code, 200) self.assertEquals(r.json()['username'], 'qa_student') - def test_getUserByToken_empty(self): - r = requests.get(self.__class__.url_+'api/getUserByToken/') + r = requests.get(self.__class__.url_+'api/users/getUserByToken/') self.assertEquals(r.status_code, 400) + def test_isStudent_Student(self): + r = requests.get(self.__class__.url_+'api/users/getUserByToken/'+__CONFIG__['TOKENS']['STUDENT']) + self.assertEquals(r.status_code, 200) + self.assertFalse(r.json()['isLecturer']) + + def test_isLecturer_Lecturer(self): + r = requests.get(self.__class__.url_+'api/users/getUserByToken/'+__CONFIG__['TOKENS']['LECTURER']) + self.assertEquals(r.status_code, 200) + self.assertTrue(r.json()['isLecturer']) if __name__ == '__main__': diff --git a/lib/flask_autodoc/templates/autodoc_default.html b/lib/flask_autodoc/templates/autodoc_default.html index 0d9b490..a512bd9 100644 --- a/lib/flask_autodoc/templates/autodoc_default.html +++ b/lib/flask_autodoc/templates/autodoc_default.html @@ -49,6 +49,9 @@
+ SE-Hub Docs Index +
+ + + + + + + \ No newline at end of file diff --git a/templates/css/theme.css b/templates/css/theme.css index a4067cd..a8b0155 100644 --- a/templates/css/theme.css +++ b/templates/css/theme.css @@ -15,9 +15,18 @@ md-list .md-button { width: 100%; } +.welcome-logo-banner{ + width: 100%; +} + /* Using Data-URI converted from svg until
-
+
+