repackage project

edx_adapt.py

@@ -0,0 +1,3 @@
+import edx_adapt.api.adapt_api
+
+edx_adapt.api.adapt_api.run()

edx_adapt/api/adapt_api.py

@@ -0,0 +1,33 @@
+from flask import Flask
+from flask.ext.cors import CORS
+from flask_restful import Api
+
+# import API resources
+import resources.course_resources as CR
+# import data module
+import edx_adapt.data.mockRepository as mock
+
+app = Flask(__name__)
+CORS(app)
+api = Api(app)
+
+# TODO: load from settings
+base = '/api/v1'
+
+data = mock.MockRepository()
+
+api.add_resource(CR.Courses, base + '/course',
+                 resource_class_kwargs={'data': data})
+api.add_resource(CR.Skills, base + '/course/<str:course_id>/skill',
+                 resource_class_kwargs={'data': data})
+api.add_resource(CR.Users, base + '/course/<str:course_id>/user',
+                 resource_class_kwargs={'data': data})
+api.add_resource(CR.Problems, base + '/course/<str:course_id>', base + '/course/<str:course_id>/skill/<str:skill_name>',
+                 resource_class_kwargs={'data': data})
+
+
+def run():
+    app.run()
+
+if __name__ == '__main__':
+    app.run()

edx_adapt/api/resources/course_resources.py

@@ -0,0 +1,131 @@
+""" This file contains api resource classes dealing with course information.
+For example, CRUDding courses, users, problems, skills...
+"""
+
+from flask_restful import Resource, abort, reqparse
+
+from edx_adapt.data import DataException
+
+course_parser = reqparse.RequestParser()
+course_parser.add_argument('course_id', type=str, required=True, help="Please supply a course ID")
+
+
+class Courses(Resource):
+    def __init__(self, **kwargs):
+        self.repo = kwargs['data']
+        """@type repo: DataInterface"""
+
+    def get(self):
+        courses = []
+        try:
+            courses = self.repo.get_course_ids()
+        except DataException as e:
+            abort(500, message=e.message)
+        return {'course_ids': courses}, 200
+
+    def post(self):
+        args = course_parser.parse_args()
+        try:
+            self.repo.post_course(args['course_id'])
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'success': True}, 200
+
+
+skill_parser = reqparse.RequestParser()
+skill_parser.add_argument('skill_name', type=str, required=True, help="Please supply the name of a skill")
+
+
+class Skills(Resource):
+    def __init__(self, **kwargs):
+        self.repo = kwargs['data']
+        """@type repo: DataInterface"""
+
+    def get(self, course_id):
+        skills = []
+        try:
+            skills = self.repo.get_skills(course_id)
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'skills': skills}, 200
+
+    def post(self, course_id):
+        args = skill_parser.parse_args()
+        try:
+            self.repo.post_skill(course_id, args['skill_name'])
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'success': True}, 200
+
+
+user_parser = reqparse.RequestParser()
+user_parser.add_argument('user_id', type=str, required=True, help="Please supply a user ID")
+
+
+class Users(Resource):
+    def __init__(self, **kwargs):
+        self.repo = kwargs['data']
+        """@type repo: DataInterface"""
+
+    def get(self, course_id):
+        finished_users = []
+        progress_users = []
+        try:
+            finished_users = self.repo.get_finished_users(course_id)
+            progress_users = self.repo.get_in_progress_users(course_id)
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'users': {'finished': finished_users, 'in_progress': progress_users}}, 200
+
+    def post(self, course_id):
+        args = user_parser.parse_args()
+        try:
+            self.repo.enroll_user(course_id, args['user_id'])
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'success': True}, 200
+
+
+problem_parser = reqparse.RequestParser()
+problem_parser.add_argument('problem_name', type=str, required=True, help="Please supply a problem name")
+problem_parser.add_argument('tutor_url', type=str, required=True,
+                            help="Please supply a link to the problem's page in your tutor")
+problem_parser.add_argument('skills', type=list, required=True,
+                            help="Please supply a list of skills that this problem teaches")
+problem_parser.add_argument('pretest', type=bool,
+                            help="Set True if this is a pretest problem. Mutually exclusive with posttest")
+problem_parser.add_argument('posttest', type=bool,
+                            help="Set True if this is a posttest problem. Mutually exclusive with pretest")
+
+class Problems(Resource):
+    def __init__(self, **kwargs):
+        self.repo = kwargs['data']
+        """@type repo: DataInterface"""
+
+    def get(self, course_id, skill_name):
+        problems = []
+        try:
+            problems = self.repo.get_problems(course_id, skill_name)
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'problems': problems}, 200
+
+    def post(self, course_id):
+        args = problem_parser.parse_args()
+        try:
+            if args['pretest']:
+                self.repo.post_pretest_problem(course_id, args['skills'], args['problem_name'], args['tutor_url'])
+            elif args['posttest']:
+                self.repo.post_posttest_problem(course_id, args['skills'], args['problem_name'], args['tutor_url'])
+            else:
+                self.repo.post_problem(course_id, args['skills'], args['problem_name'], args['tutor_url'])
+        except DataException as e:
+            abort(500, message=e.message)
+
+        return {'success': True}, 200

api/resources/tutor_resources.py → edx_adapt/api/resources/tutor_resources.py

@@ -2,10 +2,13 @@
 as users take the course.
 """
 
-import time, threading
+import threading
+import time
+
 from flask_restful import Resource, abort, reqparse
-from ...data.interface import DataInterface, DataException
-from ...select.interface import SelectInterface, SelectException
+
+from edx_adapt.data import DataException
+from edx_adapt.select.interface import SelectException
 
 """ Handle request for user's current and next problem """
 class UserProblems(Resource):
@@ -20,7 +23,7 @@ def get(self, course_id, user_id):
             nex = self.repo.get_next_problem(course_id, user_id)
             cur = self.repo.get_current_problem(course_id, user_id)
         except DataException as e:
-            abort(404, message = e.message)
+            abort(404, message=e.message)
 
         okay = True
         if 'error' in nex:

select/interface.py → edx_adapt/select/interface.py

@@ -1,6 +1,3 @@
-from data.interface import DataInterface
-from model.interface import ModelInterface
-
 class SelectInterface(object):
     """ This is the interface for the adaptive problem
     selection logic. It interacts with the inputted data interface and