def article_comments_delete(article_id, comment_id):
"""Delete specific comment
:param article_id: article ID
:param comment_id: comment ID
"""
# check if the article ID contains special characters
if utils.has_special_characters(article_id):
# 404
error = messages.no_such_article()
return jsonify(error), 404
# check if the comment ID contains special characters
if utils.has_special_characters(comment_id):
# 404
error = messages.no_such_article_or_comment()
return jsonify(error), 404
# get articles helper
articles_helper = utils.get_db_helper(current_app, ARTICLES_HELPER)
try:
articles_helper.delete_comment(article_id, comment_id)
except errors.NoSuchArticleError:
# 404
error = messages.no_such_article()
return jsonify(error), 404
except errors.NoSuchArticleOrCommentError:
# 404
error = messages.no_such_article_or_comment()
return jsonify(error), 404
# everything are going well
return '', 200
def get_settings(name, app):
"""Get specified settings' value
:param name: name
:param app: current instance of app
:return: the value of settings
"""
if not isinstance(name, str):
return
helper = get_db_helper(app, 'settings_helper')
result = helper.get_one(name)
if not result:
return
return result['value']
def article_comments_save(article_id):
"""Push comment
The request's content-type should be **application/json**
Post Data
- from: from user
- body: body of comment
- reply_id: comment ID for reply to, *optional*
- timestamp: created or updated timestamp
:param article_id: article ID
"""
# check if the article ID contains special characters
if utils.has_special_characters(article_id):
# 404
error = messages.no_such_article()
return jsonify(error), 404
# get post data
data = request.get_json()
# check attributes
keys = ['from', 'body', 'timestamp']
if not utils.is_contained(data, keys):
error = messages.invalid_post_data(keys)
return jsonify(error), 400
# get articles helper
articles_helper = utils.get_db_helper(current_app, ARTICLES_HELPER)
try:
articles_helper.post_comment(article_id, data=data)
except errors.NoSuchArticleError:
error = messages.no_such_article()
return jsonify(error), 404
return '', 201
def article_content(article_id):
"""Fetch article's content by id
Query parameter
comment_sizes: number, fetch comments size
:param article_id: string, the id of article
:return:
- 200 normally
- 400 invalid query parameter
- 404 not found
"""
default_size = settings_helper.get_settings('default_size', current_app)
max_size = settings_helper.get_settings('max_size', current_app)
# get comments size
comments_size = request.args.get('comments_size',
default_size if default_size else 10)
# convert and check
try:
[comments_size
] = wrappers.convert_and_check_natural_number(comments_size)
except errors.NotANumberError:
# not a number
error = messages.not_a_number('comments_size')
return jsonify(error), 400
except ValueError:
# not a natural number
error = messages.not_a_natural_number('comments_size')
return jsonify(error), 400
# if comments_size is equal to 0 then set it to maximum value
comments_size = comments_size if comments_size != 0 else max_size
# check if the article ID contains special characters
if utils.has_special_characters(article_id):
# 404
error = messages.no_such_article()
return jsonify(error), 404
articles_helper = utils.get_db_helper(current_app, ARTICLES_HELPER)
# fetch content
try:
content = articles_helper.get_content(article_id,
comments_size=comments_size)
except errors.NoSuchArticleError:
# 404
error = messages.no_such_article()
return jsonify(error), 404
# pretty print if required or in debug mode
pretty_flag = current_app.config[
'JSONIFY_PRETTYPRINT_REGULAR'] or current_app.debug
headers, data = utils.set_next_page_and_data(content['reviews'],
comments_size, 0, content,
pretty_flag)
# 200
return make_response(data, 200, headers)
def articles_list_fetch():
"""Fetch articles list
Query parameters
- size: number, fetch size, 10 by default
- offset: number, fetch start position, 0 by default
- tags: string or strings array, tags
:return:
- 200 normally
- 400 invalid query parameters
- 404 not found
"""
default_size = settings_helper.get_settings('default_size', current_app)
max_size = settings_helper.get_settings('max_size', current_app)
# get request parameters
size = request.args.get('size', default_size if default_size else 10)
offset = request.args.get('offset', 0)
# try to convert parameters to number and do some check
try:
size, offset = wrappers.convert_and_check_natural_number(size, offset)
except errors.NotANumberError:
# not a number
error = messages.not_a_number('size/offset')
return jsonify(error), 400
except ValueError:
# not a positive number
error = messages.not_a_natural_number('size/offset')
return jsonify(error), 400
size = size if size != 0 else max_size
# get tags from request
tags = request.args.get('tags')
# convert tags to list if it is not a None
if tags is not None:
tags = utils.convert_string_to_list(tags)
# get articles helper
articles_helper = utils.get_db_helper(current_app, ARTICLES_HELPER)
# fetch list
a_list = articles_helper.get_list(size=size, offset=offset, tags=tags)
# 404 not found
if a_list is None or len(a_list) == 0:
error = messages.articles_list_not_found(tags, offset)
return jsonify(error), 404
# get all counts of articles
all_counts = articles_helper.get_articles_counts()
# pretty print if required or in debug mode
pretty_flag = current_app.config[
'JSONIFY_PRETTYPRINT_REGULAR'] or current_app.debug
headers, data = utils.set_next_page_and_data(all_counts, size, offset,
a_list, pretty_flag)
# 200
return make_response(data, 200, headers)
def article_comments_fetch(article_id):
"""Fetch article's comments by id
Query parameters
- size: number, fetch size
- page: number, fetch start position
:param article_id: article ID
:return:
- 200 normally
- 400 invalid query parameters
- 404 not found
"""
# check is the provided article id contains a special characters or not
if utils.has_special_characters(article_id):
# 404
error = messages.no_such_article()
return jsonify(error), 404
default_size = settings_helper.get_settings('default_size', current_app)
max_size = settings_helper.get_settings('max_size', current_app)
size = request.args.get('size', default_size if default_size else 10)
offset = request.args.get('offset', 0)
# convert to number and checking
try:
size, offset = wrappers.convert_and_check_natural_number(size, offset)
except errors.NotANumberError:
# not a number
error = messages.not_a_number('size/offset')
return jsonify(error), 400
except ValueError:
# values <= 0
error = messages.not_a_positive_number('size/offset')
return jsonify(error), 400
size = size if size != 0 else max_size
articles_helper = utils.get_db_helper(current_app, ARTICLES_HELPER)
# fetch comments
try:
comments, count = articles_helper.get_comments(article_id,
size=size,
offset=offset)
except errors.NoSuchArticleError:
# 404
error = messages.no_such_article()
return jsonify(error), 404
# pretty print if required or in debug mode
pretty_flag = current_app.config[
'JSONIFY_PRETTYPRINT_REGULAR'] or current_app.debug
headers, data = utils.set_next_page_and_data(count, size, offset, comments,
pretty_flag)
# 200
return make_response(data, 200, headers)