Dashboard facelift [REFERENCE]

.github/workflows/python-app.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     steps:
     - uses: actions/checkout@v2

psiturk/amt_services.py

@@ -79,7 +79,6 @@ def wrapper(*args, **kwargs):
             response = func(*args, **kwargs)
             return AmtServicesSuccessResponse(operation=func.__name__, data=response)
         except Exception as e:
-            # print(e)
             return AmtServicesErrorResponse(operation=func.__name__, exception=e)
 
     return wrapper
@@ -189,7 +188,8 @@ def get_assignments(self, assignment_status=None, hit_ids=None):
         for hit_id in hit_ids:
             paginator = self.mtc.get_paginator('list_assignments_for_hit')
             args = dict(
-                HITId=hit_id
+                HITId=hit_id,
+                PaginationConfig={'PageSize': 100}
             )
             if assignment_status:
                 args['AssignmentStatuses'] = [assignment_status]
@@ -220,6 +220,43 @@ def get_assignment(self, assignment_id):
             'status': assignment['AssignmentStatus'],
         }
         return worker_data
+
+    @amt_service_response
+    def get_bonuses(self, hit_id=None, assignment_ids=None):
+        """Get paid bonuses."""
+        bonuses = []
+        if hit_id:
+            paginator = self.mtc.get_paginator('list_bonus_payments')
+            args = dict(
+                HITId=hit_id,
+                PaginationConfig={'PageSize': 100}
+            )
+            for page in paginator.paginate(**args):
+                bonuses.extend(page['BonusPayments'])
+        elif assignment_ids:
+            if not isinstance(assignment_ids, list):
+                assignment_ids = [assignment_ids]
+            for assignment_id in assignment_ids:
+                paginator = self.mtc.get_paginator('list_bonus_payments')
+                args = dict(
+                    AssignmentId=assignment_id,
+                    PaginationConfig={'PageSize': 100}
+                )
+                for page in paginator.paginate(**args):
+                    bonuses.extend(page['BonusPayments'])
+        bonus_data = [{
+            'workerId': bonus['WorkerId'],
+            'bonusAmount': bonus['BonusAmount'],
+            'assignmentId': bonus['AssignmentId'],
+            'reason': bonus['Reason'],
+            'grantTime': bonus['GrantTime']
+        } for bonus in bonuses]
+        return bonus_data
+
+    @amt_service_response
+    def notify_workers(self, worker_ids, message_subject, message_body):
+        """Notify workers"""
+        return self.mtc.notify_workers(WorkerIds=worker_ids, Subject=message_subject, MessageText=message_body)
 
     @amt_service_response
     def bonus_assignment(self, assignment_id, worker_id, amount, reason=""):
@@ -268,7 +305,9 @@ def setup_mturk_connection(self):
         aws_access_key_id = self.config.get('AWS Access', 'aws_access_key_id')
         aws_secret_access_key = self.config.get('AWS Access',
                                                 'aws_secret_access_key')
-
+        session_kwargs = {
+            'region_name': 'us-east-1'
+        }
         if aws_access_key_id and aws_secret_access_key:
             session_kwargs['aws_access_key_id'] = aws_access_key_id
             session_kwargs['aws_secret_access_key'] = aws_secret_access_key

psiturk/amt_services_wrapper.py

@@ -203,6 +203,22 @@ def count_workers(self, codeversion='latest', mode='live', status='completed'):
         worker_count = Participant.count_workers(query=query, group_bys=[])
         return worker_count
 
+    @amt_services_wrapper_response
+    def notify_workers(self, worker_ids, m_subject, m_body):
+        """Sends an email to all workers specified in worker_ids
+
+        Args:
+            workers (_type_): A list of worker ids (up to 100)
+            m_subject (_type_): The subject of the email (max 200 chars)
+            m_body (_type_): The body of the email (max 4096 chars)
+
+        Returns:
+            _type_: _description_
+        """
+        if not worker_ids:
+            raise Exception("Worker IDs not specified!")
+        return self.amt_services.notify_workers(worker_ids, m_subject, m_body)
+
     @amt_services_wrapper_response
     def count_available(self, hits=None):
         if not hits:
@@ -230,6 +246,14 @@ def count_maybe_will_complete(self, hits=None):
             elif status == 'Unassignable':
                 maybe_will_complete_count += hit.options['number_assignments_pending']
         return maybe_will_complete_count
+
+    @amt_services_wrapper_response
+    def get_bonuses(self, hit_id=None, assignment_ids=None):
+        """
+        Returns all bonuses if hit_id is set, or specific assignment bonuses.
+        """
+        bonus_data = self.amt_services.get_bonuses(hit_id, assignment_ids).data
+        return {'bonuses': bonus_data}
 
     @amt_services_wrapper_response
     def get_assignments(self, hit_ids=None, assignment_status=None, all_studies=False):