Merge pull request #1029 from alphagov/post-version-of-search-form

Post version of search form

app/errors.py

@@ -1,10 +1,11 @@
 from flask import (
     jsonify,
-    current_app
-)
+    current_app,
+    json)
 from sqlalchemy.exc import SQLAlchemyError, DataError
 from sqlalchemy.orm.exc import NoResultFound
 from marshmallow import ValidationError
+from jsonschema import ValidationError as JsonSchemaValidationError
 from app.authentication.auth import AuthError
 from app.notifications import SendNotificationToQueueError
 
@@ -50,6 +51,11 @@ def register_errors(blueprint):
         current_app.logger.error(error)
         return jsonify(result='error', message=error.messages), 400
 
+    @blueprint.errorhandler(JsonSchemaValidationError)
+    def validation_error(error):
+        current_app.logger.exception(error)
+        return jsonify(json.loads(error.message)), 400
+
     @blueprint.errorhandler(InvalidRequest)
     def invalid_data(error):
         response = jsonify(error.to_dict())

app/inbound_sms/inbound_sms_schemas.py

@@ -0,0 +1,9 @@
+get_inbound_sms_for_service_schema = {
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "schema for parameters allowed when searching for to field=",
+    "type": "object",
+    "properties": {
+        "phone_number": {"type": "string", "format": "phone_number"},
+        "limit": {"type": ["integer", "null"], "minimum": 1}
+    }
+}

app/inbound_sms/rest.py

@@ -1,8 +1,9 @@
 from flask import (
     Blueprint,
     jsonify,
-    request
-)
+    request,
+    current_app, json)
+from jsonschema import ValidationError
 
 from notifications_utils.recipients import validate_and_format_phone_number
 
@@ -12,6 +13,9 @@ from app.dao.inbound_sms_dao import (
     dao_get_inbound_sms_by_id
 )
 from app.errors import register_errors
+from app.schema_validation import validate
+
+from app.inbound_sms.inbound_sms_schemas import get_inbound_sms_for_service_schema
 
 inbound_sms = Blueprint(
     'inbound_sms',
@@ -22,18 +26,25 @@ inbound_sms = Blueprint(
 register_errors(inbound_sms)
 
 
-@inbound_sms.route('')
+@inbound_sms.route('', methods=['POST', 'GET'])
 def get_inbound_sms_for_service(service_id):
-    limit = request.args.get('limit')
-    user_number = request.args.get('user_number')
 
-    if user_number:
-        # we use this to normalise to an international phone number
-        user_number = validate_and_format_phone_number(user_number, international=True)
+    if request.method == 'GET':
+        limit = request.args.get('limit')
+        user_number = request.args.get('user_number')
 
-    results = dao_get_inbound_sms_for_service(service_id, limit, user_number)
+        if user_number:
+            # we use this to normalise to an international phone number
+            user_number = validate_and_format_phone_number(user_number, international=True)
 
-    return jsonify(data=[row.serialize() for row in results])
+        results = dao_get_inbound_sms_for_service(service_id, limit, user_number)
+
+        return jsonify(data=[row.serialize() for row in results])
+    else:
+        form = validate(request.get_json(), get_inbound_sms_for_service_schema)
+        results = dao_get_inbound_sms_for_service(service_id, form.get('limit'), form.get('phone_number'))
+
+        return jsonify(data=[row.serialize() for row in results])
 
 
 @inbound_sms.route('/summary')
@@ -49,6 +60,6 @@ def get_inbound_sms_summary_for_service(service_id):
 
 @inbound_sms.route('/<uuid:inbound_sms_id>', methods=['GET'])
 def get_inbound_by_id(service_id, inbound_sms_id):
-    inbound_sms = dao_get_inbound_sms_by_id(service_id, inbound_sms_id)
+    message = dao_get_inbound_sms_by_id(service_id, inbound_sms_id)
 
-    return jsonify(inbound_sms.serialize()), 200
+    return jsonify(message.serialize()), 200