Merge pull request #192 from alphagov/update_filter_for_multiple_arguments

Added functionality to allow filtering by multiple arguments.

app/dao/notifications_dao.py

@@ -6,6 +6,7 @@ from datetime import (
 )
 
 from flask import current_app
+from werkzeug.datastructures import MultiDict
 
 from app import db
 from app.models import (
@@ -191,10 +192,16 @@ def get_notifications_for_service(service_id, filter_dict=None, page=1):
 
 
 def filter_query(query, filter_dict=None):
-    if filter_dict and 'status' in filter_dict:
-        query = query.filter_by(status=filter_dict['status'])
-    if filter_dict and 'template_type' in filter_dict:
-        query = query.join(Template).filter(Template.template_type == filter_dict['template_type'])
+    if filter_dict is None:
+        filter_dict = MultiDict()
+    else:
+        filter_dict = MultiDict(filter_dict)
+    statuses = filter_dict.getlist('status') if 'status' in filter_dict else None
+    if statuses:
+        query = query.filter(Notification.status.in_(statuses))
+    template_types = filter_dict.getlist('template_type') if 'template_type' in filter_dict else None
+    if template_types:
+        query = query.join(Template).filter(Template.template_type.in_(template_types))
     return query
 
 

app/dao/permissions_dao.py

@@ -32,8 +32,10 @@ class PermissionDAO(DAOClass):
     class Meta:
         model = Permission
 
-    def get_query(self, filter_by_dict={}):
-        if isinstance(filter_by_dict, dict):
+    def get_query(self, filter_by_dict=None):
+        if filter_by_dict is None:
+            filter_by_dict = MultiDict()
+        else:
             filter_by_dict = MultiDict(filter_by_dict)
         query = self.Meta.model.query
         if 'id' in filter_by_dict:

app/schemas.py

@@ -2,7 +2,7 @@ from flask_marshmallow.fields import fields
 from . import ma
 from . import models
 from app.dao.permissions_dao import permission_dao
-from marshmallow import (post_load, ValidationError, validates, validates_schema)
+from marshmallow import (post_load, ValidationError, validates, validates_schema, pre_load)
 from marshmallow_sqlalchemy import field_for
 from utils.recipients import (
     validate_email_address, InvalidEmailError,
@@ -74,6 +74,11 @@ class ServiceSchema(BaseSchema):
         exclude = ("updated_at", "created_at", "api_keys", "templates", "jobs", 'old_id')
 
 
+class NotificationModelSchema(BaseSchema):
+    class Meta:
+        model = models.Notification
+
+
 class TemplateSchema(BaseSchema):
     class Meta:
         model = models.Template
@@ -203,10 +208,29 @@ class EmailDataSchema(ma.Schema):
 
 
 class NotificationsFilterSchema(ma.Schema):
-    template_type = field_for(models.Template, 'template_type', load_only=True, required=False)
-    status = field_for(models.Notification, 'status', load_only=True, required=False)
+    template_type = fields.Nested(TemplateSchema, only='template_type', many=True)
+    status = fields.Nested(NotificationModelSchema, only='status', many=True)
     page = fields.Int(required=False)
 
+    @pre_load
+    def handle_multidict(self, in_data):
+        if isinstance(in_data, dict) and hasattr(in_data, 'getlist'):
+            out_data = dict([(k, in_data.get(k)) for k in in_data.keys()])
+            if 'template_type' in in_data:
+                out_data['template_type'] = [{'template_type': x} for x in in_data.getlist('template_type')]
+            if 'status' in in_data:
+                out_data['status'] = [{"status": x} for x in in_data.getlist('status')]
+
+        return out_data
+
+    @post_load
+    def convert_schema_object_to_field(self, in_data):
+        if 'template_type' in in_data:
+            in_data['template_type'] = [x.template_type for x in in_data['template_type']]
+        if 'status' in in_data:
+            in_data['status'] = [x.status for x in in_data['status']]
+        return in_data
+
     @validates('page')
     def validate_page(self, value):
         try:
@@ -216,6 +240,7 @@ class NotificationsFilterSchema(ma.Schema):
         except:
             raise ValidationError("Not a positive integer")
 
+
 user_schema = UserSchema()
 user_schema_load_json = UserSchema(load_json=True)
 service_schema = ServiceSchema()