query parameters to query mongodb

Author: Andrea Cioni

scripts/set_offline_id.py

@@ -2,13 +2,17 @@
 import ssl
 import argparse
 import pymongo
+import bson
 import uuid
 
 parser = argparse.ArgumentParser()
 parser.add_argument('mongo_url',
                     help='URL')
 parser.add_argument('db_name',
                     help='Database name')
+parser.add_argument('--user',
+                    default='everyone',
+                    help='Filter by owner')
 args = parser.parse_args()
 
 client = pymongo.MongoClient(args.mongo_url, ssl_cert_reqs=ssl.CERT_NONE)
@@ -17,8 +21,13 @@
 apply_to = ['shopping_lists', 'recipes', 'menu', 'ingredients']
 
 for coll_name in apply_to:
-  print('Setting offline_id to:', coll_name)
-  documents = db[coll_name].find({'offline_id': None})
+  print('Setting offline_id to:', coll_name, 'owner:', args.user)
+
+  if(args.user == 'everyone'):
+    documents = db[coll_name].find({'offline_id': None})
+  else:
+    documents = db[coll_name].find({'offline_id': None, 'owner': bson.ObjectId(args.user)})
+
   for doc in documents:
     print('Update doc', doc['_id'])
     db[coll_name].update_one({'_id': doc['_id']}, {'$set': {'offline_id': str(uuid.uuid4())}})

tests/test_ingredient.py

@@ -34,8 +34,8 @@ def delete_ingredient(client, ing_id, auth_headers):
     return client.delete('/api/v1/ingredients/{}'.format(ing_id), headers=auth_headers)
 
 
-def get_all_ingredients(client, auth_headers, page=1, per_page=10):
-    return client.get('/api/v1/ingredients?page={}&per_page={}'.format(page, per_page), headers=auth_headers)
+def get_all_ingredients(client, auth_headers, page=1, per_page=10, order_by='', desc=False):
+    return client.get('/api/v1/ingredients?page={}&per_page={}&order_by={}&desc={}'.format(page, per_page, order_by, desc), headers=auth_headers)
 
 def get_ingredient(client, ing_id, auth_headers):
     return client.get('/api/v1/ingredients/{}'.format(ing_id), headers=auth_headers)
@@ -361,3 +361,100 @@ def test_create_update_timestamp(client: FlaskClient, auth_headers):
         and response.json['name'] == 'Tomato' \
         and response.json['insert_timestamp'] == insert_timestamp \
         and response.json['update_timestamp'] > update_timestamp
+
+
+def test_get_last_updated(client: FlaskClient, auth_headers):
+    response = create_ingredient(client, {
+        'name': 'Rice',
+    }, auth_headers)
+
+    assert response.status_code == 201  
+    
+    idx_1 = response.json['_id']
+    insert_timestamp_1 = response.json['insert_timestamp']
+    update_timestamp_1 = response.json['update_timestamp']
+
+    response = create_ingredient(client, {
+        'name': 'Tomato',
+    }, auth_headers)
+
+    assert response.status_code == 201  
+    
+    idx_2 = response.json['_id']
+    insert_timestamp_2 = response.json['insert_timestamp']
+    update_timestamp_2 = response.json['update_timestamp']
+
+    response = get_all_ingredients(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_2
+
+    response = patch_ingredient(client, idx_1, {
+        'name': 'Rice',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_1 \
+        and response.json['update_timestamp'] > update_timestamp_1
+    
+    update_timestamp_1 = response.json['update_timestamp']
+
+    response = get_all_ingredients(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_1 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_1
+
+    response = put_ingredient(client, idx_1, {
+        'name': 'Rice',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_1 \
+        and response.json['update_timestamp'] > update_timestamp_1
+
+    update_timestamp_1 = response.json['update_timestamp']
+
+    response = get_all_ingredients(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_1 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_1
+    
+    response = patch_ingredient(client, idx_2, {
+        'name': 'Tomato',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_2 \
+        and response.json['update_timestamp'] > update_timestamp_2
+    
+    update_timestamp_2 = response.json['update_timestamp']
+
+    response = get_all_ingredients(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_2 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_2
+
+    response = put_ingredient(client, idx_2, {
+        'name': 'Tomato',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_2 \
+        and response.json['update_timestamp'] > update_timestamp_2
+
+    update_timestamp_2 = response.json['update_timestamp']
+
+    response = get_all_ingredients(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_2 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_2
+        

tests/test_menu.py

@@ -35,8 +35,8 @@ def get_menu(client, menu_id, auth_headers):
     return client.get('/api/v1/menus/{}'.format(menu_id), headers=auth_headers)
 
 
-def get_all_menus(client, auth_headers, page=1, per_page=10):
-    return client.get('/api/v1/menus?page={}&per_page={}'.format(page, per_page), headers=auth_headers)
+def get_all_menus(client, auth_headers, page=1, per_page=10, order_by='', desc=False):
+    return client.get('/api/v1/menus?page={}&per_page={}&order_by={}&desc={}'.format(page, per_page, order_by, desc), headers=auth_headers)
 
 
 def get_all_menus_by_day(client, auth_headers, day):
@@ -436,4 +436,100 @@ def test_create_update_timestamp(client: FlaskClient, auth_headers):
     assert response.status_code == 200 \
         and response.json['date'] == '2020-02-14' \
         and response.json['insert_timestamp'] == insert_timestamp \
-        and response.json['update_timestamp'] > update_timestamp
+        and response.json['update_timestamp'] > update_timestamp
+
+def test_get_last_updated(client: FlaskClient, auth_headers):
+    response = create_menu(client, {
+        'date': '2019-09-06',
+    }, auth_headers)
+
+    assert response.status_code == 201  
+    
+    idx_1 = response.json['_id']
+    insert_timestamp_1 = response.json['insert_timestamp']
+    update_timestamp_1 = response.json['update_timestamp']
+
+    response = create_menu(client, {
+        'date': '2019-10-06',
+    }, auth_headers)
+
+    assert response.status_code == 201  
+    
+    idx_2 = response.json['_id']
+    insert_timestamp_2 = response.json['insert_timestamp']
+    update_timestamp_2 = response.json['update_timestamp']
+
+    response = get_all_menus(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_2
+
+    response = patch_menu(client, idx_1, {
+        'name': 'Rice',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_1 \
+        and response.json['update_timestamp'] > update_timestamp_1
+    
+    update_timestamp_1 = response.json['update_timestamp']
+
+    response = get_all_menus(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_1 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_1
+
+    response = put_menu(client, idx_1, {
+        'date': '2019-10-06',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_1 \
+        and response.json['update_timestamp'] > update_timestamp_1
+
+    update_timestamp_1 = response.json['update_timestamp']
+
+    response = get_all_menus(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_1 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_1
+    
+    response = patch_menu(client, idx_2, {
+        'date': '2019-10-06',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_2 \
+        and response.json['update_timestamp'] > update_timestamp_2
+    
+    update_timestamp_2 = response.json['update_timestamp']
+
+    response = get_all_menus(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_2 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_2
+
+    response = put_menu(client, idx_2, {
+        'date': '2019-10-06',
+    }, auth_headers)
+
+    assert response.status_code == 200 \
+        and response.json['insert_timestamp'] == insert_timestamp_2 \
+        and response.json['update_timestamp'] > update_timestamp_2
+
+    update_timestamp_2 = response.json['update_timestamp']
+
+    response = get_all_menus(client, auth_headers, order_by='update_timestamp', desc=True, page=1, per_page=1)
+
+    assert response.status_code == 200 \
+        and len(response.json['results']) == 1 \
+        and response.json['results'][0]['_id'] == idx_2 \
+        and response.json['results'][0]['update_timestamp'] == update_timestamp_2
+        

weekly_menu/webapp/api/__init__.py

@@ -1,3 +1,6 @@
+import re
+
+from datetime import datetime
 from functools import wraps
 from flask import request, jsonify, make_response
 from json import dumps
@@ -10,8 +13,15 @@
 
 from .exceptions import InvalidPayloadSupplied, BadRequest, Forbidden
 
+# Constant fields
+
 API_PREFIX = '/api'
 
+class QueryArgs:
+    DAY = 'day'
+    ORDER_BY = 'order_by'
+    DESC = 'desc'
+
 # Pagination
 DEFAULT_PAGE_SIZE = 10
 
@@ -66,6 +76,44 @@ def wrapper(*args, **kwargs):
 
     return decorate
 
+def parse_query_args(func):
+    query_args_reqparse = reqparse.RequestParser()
+    query_args_reqparse.add_argument(
+        QueryArgs.DAY,
+        type=str,
+        location=['args'],
+        required=False,
+        default=None
+    )
+    query_args_reqparse.add_argument(
+        QueryArgs.ORDER_BY,
+        type=str,
+        location=['args'],
+        required=False,
+        default=None
+    )
+    query_args_reqparse.add_argument(
+        QueryArgs.DESC,
+        type=bool,
+        location=['args'],
+        required=False,
+        default=False
+    )
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        query_args = query_args_reqparse.parse_args()
+
+        kwargs['query_args'] = {
+            QueryArgs.DAY: query_args[QueryArgs.DAY],
+            QueryArgs.ORDER_BY: query_args[QueryArgs.ORDER_BY],
+            QueryArgs.DESC: query_args[QueryArgs.DESC],
+
+        }
+
+        return func(*args, **kwargs)
+    return wrapper
+
+
 
 def get_payload(kwname='payload'):
     def decorate(func):
@@ -124,7 +172,7 @@ def wrapper(*args, **kwargs):
         if per_page <= 0:
             raise BadRequest('per_page argument must be greater than zero')
 
-        kwargs['req_args'] = {
+        kwargs['page_args'] = {
             'page': page,
             'per_page': per_page
         }
@@ -175,3 +223,39 @@ def put_embedded_document(new_doc: mongo.EmbeddedDocument, old_doc: mongo.Embedd
 
 def patch_embedded_document(new_doc: mongo.EmbeddedDocument, old_doc: mongo.EmbeddedDocument):
     return _update_embedded_document(new_doc, old_doc, patch=True)
+
+
+def _build_query_by_params(base_query, query_args):
+    if QueryArgs.DAY in query_args and query_args[QueryArgs.DAY] is not None:
+        if bool(re.search('^[0-9]{4}-[0-1][0-9]-[0-3][0-9]$', query_args[QueryArgs.DAY])):
+            try:
+                searched_day = datetime.strptime(query_args[QueryArgs.DAY], '%Y-%m-%d')
+            except ValueError as ex:
+                raise BadRequest('invalid day parameter supplied: {}'.format(ex))
+        else:
+            raise BadRequest('invalid day format')
+        
+        base_query = base_query & Q(date=searched_day)
+    
+    return base_query
+
+def _apply_ordering(filtered_objects, query_args):
+    if(query_args[QueryArgs.ORDER_BY] != None and query_args[QueryArgs.ORDER_BY] != ''):
+        if(query_args[QueryArgs.DESC] == True):
+            filtered_objects = filtered_objects.order_by('-' + query_args[QueryArgs.ORDER_BY]) # descending "-"
+        else:
+            filtered_objects = filtered_objects.order_by('+' + query_args[QueryArgs.ORDER_BY]) # ascending "+"
+
+    return filtered_objects 
+
+def _apply_pagination(ordered_objects, page_args):
+    return ordered_objects.paginate(page=page_args['page'], per_page=page_args['per_page'])
+
+def search_on_model(coll_class: mongo.Document.__class__, base_query, query_args, page_args):
+    query_filter = _build_query_by_params(base_query, query_args)
+
+    filtered_objects = coll_class.objects(query_filter)
+    ordered_objects = _apply_ordering(filtered_objects, query_args)
+    paginated_objects = _apply_pagination(ordered_objects, page_args)
+
+    return paginated_objects

weekly_menu/webapp/api/models/menu.py

@@ -19,4 +19,4 @@ class Menu(BaseDocument):
     }
 
     def __repr__(self):
-           return "<Menu '{}'>".format(self.name)
+           return "<Menu '{}'>".format(self.name)