darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-20 15:31:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

rename limit_days to whole_days on template statistics endpoint

Browse Source 
and return data for one more day.

we're not really limiting to 7 days - we're returning 7 entire days,
plus whatever time has elapsed since midnight today. I felt it would be
best to rename the variable to `whole_days` to imply that it's not
"limit this data set to seven days", it's "give me at least seven days".

the endpoint is backwards compatible so we can rename the variable on the front-end later
This commit is contained in:
Leo Hemsted
2018-07-10 14:39:51 +01:00
parent 7fda32b7cf
commit d2d267e5d8
2 changed files with 40 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
app/template_statistics/rest.py
View File

@@ -29,17 +29,18 @@ register_errors(template_statistics)
@template_statistics.route('')
def get_template_statistics_for_service_by_day(service_id):
whole_days = request.args.get('whole_days', request.args.get('limit_days', ''))
try:
limit_days = int(request.args.get('limit_days', ''))
whole_days = int(whole_days)
except ValueError:
error = '{} is not an integer'.format(request.args.get('limit_days'))
message = {'limit_days': [error]}
error = '{} is not an integer'.format(whole_days)
message = {'whole_days': [error]}
raise InvalidRequest(message, status_code=400)
if limit_days < 1 or limit_days > 7:
raise InvalidRequest({'limit_days': ['limit_days must be between 1 and 7']}, status_code=400)
if whole_days < 0 or whole_days > 7:
raise InvalidRequest({'whole_days': ['whole_days must be between 0 and 7']}, status_code=400)
return jsonify(data=_get_template_statistics_for_last_n_days(service_id, limit_days))
return jsonify(data=_get_template_statistics_for_last_n_days(service_id, whole_days))
@template_statistics.route('/<template_id>')
@@ -54,10 +55,12 @@ def get_template_statistics_for_template_id(service_id, template_id):
return jsonify(data=data)
def _get_template_statistics_for_last_n_days(service_id, limit_days):
def _get_template_statistics_for_last_n_days(service_id, whole_days):
template_stats_by_id = Counter()
for day in last_n_days(limit_days):
# 0 whole_days = last 1 days (ie since midnight today) = today.
# 7 whole days = last 8 days (ie since midnight this day last week) = a week and a bit
for day in last_n_days(whole_days + 1):
# "{SERVICE_ID}-template-usage-{YYYY-MM-DD}"
key = cache_key_for_service_template_usage_per_day(service_id, day)
stats = redis_store.get_all_from_hash(key)