Adds approvals to study schema. Adds approvals endpoint

crc/api.yml

@@ -173,6 +173,30 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Study"
+  /study/{study_id}/approvals:
+    parameters:
+      - name: study_id
+        in: path
+        required: true
+        description: The id of the study for which workflows should be returned.
+        schema:
+          type: integer
+          format: int32
+    get:
+      operationId: crc.api.approval.get_approvals_for_study
+      summary: Returns approvals for a single study
+      tags:
+        - Studies
+        - Approvals
+      responses:
+        '200':
+          description: An array of approvals
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Approval"
   /workflow-specification:
     get:
       operationId: crc.api.workflow.all_specifications

crc/api/approval.py

@@ -5,7 +5,7 @@ from crc.models.approval import Approval, ApprovalModel, ApprovalSchema
 from crc.services.approval_service import ApprovalService
 
 
-def get_approvals(approver_uid = None):
+def get_approvals(approver_uid=None):
     if not approver_uid:
         db_approvals = ApprovalService.get_all_approvals()
     else:
@@ -15,6 +15,14 @@ def get_approvals(approver_uid = None):
     results = ApprovalSchema(many=True).dump(approvals)
     return results
 
+
+def get_approvals_for_study(study_id=None):
+    db_approvals = ApprovalService.get_approvals_for_study(study_id)
+    approvals = [Approval.from_model(approval_model) for approval_model in db_approvals]
+    results = ApprovalSchema(many=True).dump(approvals)
+    return results
+
+
 def update_approval(approval_id, body):
     if approval_id is None:
         raise ApiError('unknown_approval', 'Please provide a valid Approval ID.')

crc/api/study.py

@@ -48,12 +48,10 @@ def update_study(study_id, body):
 
 
 def get_study(study_id):
-    study_service = StudyService()
-    study = study_service.get_study(study_id)
+    study = StudyService.get_study(study_id)
     if (study is None):
         raise ApiError("Study not found", status_code=404)
-    schema = StudySchema()
-    return schema.dump(study)
+    return StudySchema().dump(study)
 
 
 def delete_study(study_id):

crc/models/api_models.py

@@ -119,7 +119,7 @@ class NavigationItemSchema(ma.Schema):
 
 class WorkflowApi(object):
     def __init__(self, id, status, next_task, navigation,
-                 spec_version, is_latest_spec, workflow_spec_id, total_tasks, completed_tasks, last_updated):
+                 spec_version, is_latest_spec, workflow_spec_id, total_tasks, completed_tasks, last_updated, title):
         self.id = id
         self.status = status
         self.next_task = next_task  # The next task that requires user input.
@@ -130,13 +130,14 @@ class WorkflowApi(object):
         self.total_tasks = total_tasks
         self.completed_tasks = completed_tasks
         self.last_updated = last_updated
+        self.title = title
 
 class WorkflowApiSchema(ma.Schema):
     class Meta:
         model = WorkflowApi
         fields = ["id", "status", "next_task", "navigation",
                   "workflow_spec_id", "spec_version", "is_latest_spec", "total_tasks", "completed_tasks",
-                  "last_updated"]
+                  "last_updated", "title"]
         unknown = INCLUDE
 
     status = EnumField(WorkflowStatus)
@@ -147,7 +148,7 @@ class WorkflowApiSchema(ma.Schema):
     def make_workflow(self, data, **kwargs):
         keys = ['id', 'status', 'next_task', 'navigation',
                 'workflow_spec_id', 'spec_version', 'is_latest_spec', "total_tasks", "completed_tasks",
-                "last_updated"]
+                "last_updated", "title"]
         filtered_fields = {key: data[key] for key in keys}
         filtered_fields['next_task'] = TaskSchema().make_task(data['next_task'])
         return WorkflowApi(**filtered_fields)

crc/models/study.py

@@ -107,7 +107,7 @@ class Study(object):
                  id=None,
                  protocol_builder_status=None,
                  sponsor="", hsr_number="", ind_number="", categories=[],
-                 files=[], **argsv):
+                 files=[], approvals=[], **argsv):
         self.id = id
         self.user_uid = user_uid
         self.title = title
@@ -118,6 +118,7 @@ class Study(object):
         self.hsr_number = hsr_number
         self.ind_number = ind_number
         self.categories = categories
+        self.approvals = approvals
         self.warnings = []
         self.files = files
 
@@ -150,12 +151,13 @@ class StudySchema(ma.Schema):
     hsr_number = fields.String(allow_none=True)
     sponsor = fields.String(allow_none=True)
     ind_number = fields.String(allow_none=True)
-    files = fields.List(fields.Nested(FileSchema), dump_only=True)
+    files = fields.List(fields.Nested(SimpleFileSchema), dump_only=True)
+    approvals = fields.List(fields.Nested('ApprovalSchema'), dump_only=True)
 
     class Meta:
         model = Study
         additional = ["id", "title", "last_updated", "primary_investigator_id", "user_uid",
-                      "sponsor", "ind_number", "files"]
+                      "sponsor", "ind_number", "approvals", "files"]
         unknown = INCLUDE
 
     @marshmallow.post_load

crc/services/approval_service.py

@@ -19,6 +19,12 @@ class ApprovalService(object):
         db_approvals = session.query(ApprovalModel).filter_by(approver_uid=approver_uid).all()
         return db_approvals
 
+    @staticmethod
+    def get_approvals_for_study(study_id):
+        """Returns a list of all approvals for the given study"""
+        db_approvals = session.query(ApprovalModel).filter_by(study_id=study_id).all()
+        return db_approvals
+
     @staticmethod
     def get_all_approvals():
         """Returns a list of all approvlas"""

crc/services/study_service.py

@@ -19,6 +19,8 @@ from crc.services.file_service import FileService
 from crc.services.ldap_service import LdapService
 from crc.services.protocol_builder import ProtocolBuilderService
 from crc.services.workflow_processor import WorkflowProcessor
+from crc.services.approval_service import ApprovalService
+from crc.models.approval import ApprovalSchema
 
 
 class StudyService(object):
@@ -54,6 +56,8 @@ class StudyService(object):
         study = Study.from_model(study_model)
         study.categories = StudyService.get_categories()
         workflow_metas = StudyService.__get_workflow_metas(study_id)
+        study.files = FileService.get_files_for_study(study.id)
+        study.approvals = ApprovalService.get_approvals_for_study(study.id)
 
         files = FileService.get_files_for_study(study.id)
         files = (File.from_models(model, FileService.get_file_data(model.id),