new: dev: update bookmark range

bukuserver/server.py

@@ -124,63 +124,6 @@ def get_tiny_url(rec_id):
     return res
 
 
-def bookmark_range_operations(starting_id, ending_id):
-
-    try:
-        starting_id = int(starting_id)
-        ending_id = int(ending_id)
-    except ValueError:
-        return jsonify(response.response_template['failure']), status.HTTP_400_BAD_REQUEST, \
-               {'ContentType': 'application/json'}
-    res = None
-    bukudb = getattr(flask.g, 'bukudb', get_bukudb())
-    max_id = bukudb.get_max_id()
-    if starting_id > max_id or ending_id > max_id:
-        return jsonify(response.response_template['failure']), status.HTTP_400_BAD_REQUEST, \
-               {'ContentType': 'application/json'}
-
-    if request.method == 'GET':
-        result = {
-            'bookmarks': {}
-        }
-        for i in range(starting_id, ending_id + 1, 1):
-            bookmark = bukudb.get_rec_by_id(i)
-            result['bookmarks'][i] = {
-                'url': bookmark[1],
-                'title': bookmark[2],
-                'tags': list([_f for _f in bookmark[3].split(',') if _f]),
-                'description': bookmark[4]
-            }
-        res = jsonify(result)
-    elif request.method == 'DELETE':
-        for i in range(starting_id, ending_id + 1, 1):
-            result_flag = bukudb.delete_rec(i)
-            if result_flag is False:
-                return (jsonify(response.response_template['failure']),
-                        status.HTTP_400_BAD_REQUEST,
-                        {'ContentType': 'application/json'})
-        res = (jsonify(response.response_template['success']),
-               status.HTTP_200_OK,
-               {'ContentType': 'application/json'})
-    elif request.method == 'PUT':
-        for i in range(starting_id, ending_id + 1, 1):
-            updated_bookmark = request.form[str(i)]
-            result_flag = bukudb.update_rec(
-                i,
-                updated_bookmark['url'],
-                updated_bookmark['title'],
-                updated_bookmark['tags'],
-                updated_bookmark['description'])
-
-            if result_flag is False:
-                return (jsonify(response.response_template['failure']),
-                        status.HTTP_400_BAD_REQUEST,
-                        {'ContentType': 'application/json'})
-        res = jsonify(response.response_template['success']), status.HTTP_200_OK, \
-               {'ContentType': 'application/json'}
-    return res
-
-
 def search_bookmarks():
     arg_obj = request.form if request.method == 'DELETE' else request.args
     search_bookmarks_form = forms.SearchBookmarksForm(request.args)
@@ -309,9 +252,10 @@ def create_app(db_file=None):
     app.add_url_rule('/api/bookmarks/<int:rec_id>/refresh', 'refresh_bookmark', refresh_bookmark, methods=['POST'])
     app.add_url_rule('/api/bookmarks/<int:rec_id>/tiny', 'get_tiny_url', get_tiny_url, methods=['GET'])
     app.add_url_rule('/api/network_handle', 'network_handle', handle_network, methods=['POST'])
+    bookmark_range_api_view = ApiBookmarkRangeView.as_view('bookmark_range_api')
     app.add_url_rule(
-        '/api/bookmarks/<starting_id>/<ending_id>',
+        '/api/bookmarks/<int:starting_id>/<int:ending_id>',
-        'bookmark_range_operations', bookmark_range_operations, methods=['GET', 'PUT', 'DELETE'])
+        view_func=bookmark_range_api_view, methods=['GET', 'PUT', 'DELETE'])
     app.add_url_rule(
         '/api/bookmarks/search',
         'search_bookmarks',
@@ -453,6 +397,64 @@ class ApiBookmarkView(MethodView):
         return res
 
 
+class ApiBookmarkRangeView(MethodView):
+
+    def get(self, starting_id: int, ending_id: int):
+        bukudb = getattr(flask.g, 'bukudb', get_bukudb())
+        max_id = bukudb.get_max_id()
+        if starting_id > max_id or ending_id > max_id:
+            return jsonify(response.response_template['failure']), status.HTTP_400_BAD_REQUEST, \
+                   {'ContentType': 'application/json'}
+        result = {'bookmarks': {}}  # type: ignore
+        for i in range(starting_id, ending_id + 1, 1):
+            bookmark = bukudb.get_rec_by_id(i)
+            result['bookmarks'][i] = {
+                'url': bookmark[1],
+                'title': bookmark[2],
+                'tags': list([_f for _f in bookmark[3].split(',') if _f]),
+                'description': bookmark[4]
+            }
+        res = jsonify(result)
+        return res
+
+    def put(self, starting_id: int, ending_id: int):
+        bukudb = getattr(flask.g, 'bukudb', get_bukudb())
+        max_id = bukudb.get_max_id()
+        if starting_id > max_id or ending_id > max_id:
+            return jsonify(response.response_template['failure']), status.HTTP_400_BAD_REQUEST, \
+                   {'ContentType': 'application/json'}
+        for i in range(starting_id, ending_id + 1, 1):
+            updated_bookmark = request.data.get(str(i))  # type: ignore
+            result_flag = bukudb.update_rec(
+                i,
+                updated_bookmark.get('url'),
+                updated_bookmark.get('title'),
+                updated_bookmark.get('tags'),
+                updated_bookmark.get('description'))
+            if result_flag is False:
+                return (
+                    jsonify(response.response_template['failure']),
+                    status.HTTP_400_BAD_REQUEST,
+                    {'ContentType': 'application/json'})
+        res = jsonify(response.response_template['success'])
+        return res
+
+    def delete(self, starting_id: int, ending_id: int):
+        bukudb = getattr(flask.g, 'bukudb', get_bukudb())
+        max_id = bukudb.get_max_id()
+        if starting_id > max_id or ending_id > max_id:
+            return jsonify(response.response_template['failure']), status.HTTP_400_BAD_REQUEST, \
+                   {'ContentType': 'application/json'}
+        idx = min([starting_id, ending_id])
+        result_flag = bukudb.delete_rec(idx, starting_id, ending_id, is_range=True)
+        if result_flag is False:
+            res = jsonify(response.response_template['failure'])
+            res.status_code = status.HTTP_400_BAD_REQUEST
+        else:
+            res = jsonify(response.response_template['success'])
+        return res
+
+
 class CustomFlaskGroup(FlaskGroup):  # pylint: disable=too-few-public-methods
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

tests/test_server.py

@@ -1,3 +1,5 @@
+import json
+
 from click.testing import CliRunner
 import flask
 import pytest
@@ -60,6 +62,9 @@ def test_api_empty_db(client, url, exp_res):
         ['/api/bookmarks/1', response_template['failure'], 400, 'delete'],
         ['/api/bookmarks/1/refresh', response_template['failure'], 400, 'post'],
         ['/api/bookmarks/1/tiny', response_template['failure'], 400, 'get'],
+        ['/api/bookmarks/1/2', response_template['failure'], 400, 'get'],
+        ['/api/bookmarks/1/2', response_template['failure'], 400, 'put'],
+        ['/api/bookmarks/1/2', response_template['failure'], 400, 'delete'],
     ]
 )
 def test_invalid_id(client, url, exp_res, status_code, method):
@@ -186,3 +191,29 @@ def test_network_handle(client, kwargs, status_code, exp_res):
     rd = client.post('/api/network_handle', **kwargs)
     assert rd.status_code == status_code
     assert rd.get_json() == exp_res
+
+
+def test_bookmark_range_api(client):
+    status_code = 200
+    kwargs_list = [
+        dict(data={'url': 'http://google.com'}),
+        dict(data={'url': 'http://example.com'})]
+    for kwargs in kwargs_list:
+        rd = client.post('/api/bookmarks', **kwargs)
+        assert rd.status_code == status_code
+    rd = client.get('/api/bookmarks/1/2')
+    assert rd.status_code == status_code
+    assert rd.get_json() == {
+        'bookmarks': {
+            '1': {'description': '', 'tags': [], 'title': '', 'url': 'http://google.com'},
+            '2': {'description': '', 'tags': [], 'title': '', 'url': 'http://example.com'}}}
+    put_data = json.dumps({1: {'tags': 'tag1'}, 2: {'tags': 'tag2'}})
+    headers = {'content-type': 'application/json'}
+    rd = client.put('/api/bookmarks/1/2', data=put_data, headers=headers)
+    assert rd.status_code == status_code
+    assert rd.get_json() == response_template['success']
+    rd = client.delete('/api/bookmarks/1/2')
+    assert rd.status_code == status_code
+    assert rd.get_json() == response_template['success']
+    rd = client.get('/api/bookmarks')
+    assert rd.get_json() == {'bookmarks': []}