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

Added a new endpoint for yearly usage totals using ft_billing.

Browse Source
This commit is contained in:
Rebecca Law
2018-05-11 16:25:16 +01:00
parent 99d1357c37
commit d98581cfe6
6 changed files with 193 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
app/billing/billing_schemas.py
View File

@@ -1,5 +1,6 @@
from datetime import datetime
create_or_update_free_sms_fragment_limit_schema = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "POST annual billing schema",
@@ -24,3 +25,17 @@ def serialize_ft_billing_remove_emails(data):
}
results.append(json_result)
return results
def serialize_ft_billing_yearly_totals(data):
yearly_totals = []
for total in data:
json_result = {
"notification_type": total.notification_type,
"billing_units": total.billable_units,
"rate": float(total.rate),
"letter_total": float(total.billable_units * total.rate) if total.notification_type == 'letter' else 0
}
yearly_totals.append(json_result)
return yearly_totals

25
app/billing/rest.py
View File

@@ -5,7 +5,8 @@ from flask import Blueprint, jsonify, request
from app.billing.billing_schemas import (
create_or_update_free_sms_fragment_limit_schema,
serialize_ft_billing_remove_emails
serialize_ft_billing_remove_emails,
serialize_ft_billing_yearly_totals,
)
from app.dao.annual_billing_dao import (
dao_get_free_sms_fragment_limit_for_year,
@@ -15,7 +16,7 @@ from app.dao.annual_billing_dao import (
)
from app.dao.date_util import get_current_financial_year_start_year
from app.dao.date_util import get_months_for_financial_year
from app.dao.fact_billing_dao import fetch_monthly_billing_for_year
from app.dao.fact_billing_dao import fetch_monthly_billing_for_year, fetch_billing_totals_for_year
from app.dao.monthly_billing_dao import (
get_billing_data_for_financial_year,
get_monthly_billing_by_notification_type
@@ -47,6 +48,18 @@ def get_yearly_usage_by_monthly_from_ft_billing(service_id):
return jsonify(data)
@billing_blueprint.route('/ft-yearly-usage-summary')
def get_yearly_billing_usage_summary_from_ft_billing(service_id):
try:
year = int(request.args.get('year'))
except TypeError:
return jsonify(result='error', message='No valid year provided'), 400
billing_data = fetch_billing_totals_for_year(service_id, year)
data = serialize_ft_billing_yearly_totals(billing_data)
return jsonify(data)
@billing_blueprint.route('/monthly-usage')
def get_yearly_usage_by_month(service_id):
try:
@@ -70,7 +83,7 @@ def get_yearly_billing_usage_summary(service_id):
try:
year = int(request.args.get('year'))
billing_data = get_billing_data_for_financial_year(service_id, year)
notification_types = [SMS_TYPE, EMAIL_TYPE, LETTER_TYPE]
notification_types = [EMAIL_TYPE, LETTER_TYPE, SMS_TYPE]
response = [
_get_total_billable_units_and_rate_for_notification_type(billing_data, notification_type)
for notification_type in notification_types
@@ -102,8 +115,8 @@ def _get_total_billable_units_and_rate_for_notification_type(billing_data, noti_
return {
"notification_type": noti_type,
"billing_units": total_sent,
"rate": rate,
"letter_total": letter_total
"rate": float(rate),
"letter_total": round(float(letter_total), 3)
}
@@ -132,7 +145,7 @@ def _transform_billing_for_month_letters(billing_for_month):
"month": month_name,
"billing_units": (total['billing_units'] * total['rate_multiplier']),
"notification_type": billing_for_month.notification_type,
"rate": total['rate']
"rate": float(total['rate'])
}
x.append(y)
if len(billing_for_month.monthly_totals) == 0:

2
app/celery/reporting_tasks.py
View File

@@ -27,4 +27,4 @@ def create_nightly_billing(day_start=None):
update_fact_billing(data, process_day)
current_app.logger.info(
"create-nightly-billing task complete. {} rows updated for day: {}".format(len(transit_data, process_day)))
"create-nightly-billing task complete. {} rows updated for day: {}".format(len(transit_data), process_day))

25
app/dao/fact_billing_dao.py
View File

@@ -19,6 +19,31 @@ from app.models import (
from app.utils import convert_utc_to_bst, convert_bst_to_utc
def fetch_billing_totals_for_year(service_id, year):
year_start_date, year_end_date = get_financial_year(year)
yearly_data = db.session.query(
func.sum(FactBilling.notifications_sent).label("notifications_sent"),
func.sum(FactBilling.billable_units * FactBilling.rate_multiplier).label("billable_units"),
FactBilling.service_id,
FactBilling.rate,
FactBilling.notification_type
).filter(
FactBilling.service_id == service_id,
FactBilling.bst_date >= year_start_date,
FactBilling.bst_date <= year_end_date
).group_by(
FactBilling.service_id,
FactBilling.rate,
FactBilling.notification_type
).order_by(
FactBilling.service_id,
FactBilling.notification_type
).all()
return yearly_data
def fetch_monthly_billing_for_year(service_id, year):
year_start_date, year_end_date = get_financial_year(year)
utcnow = datetime.utcnow()

90
tests/app/billing/test_billing.py
View File

@@ -67,24 +67,23 @@ def test_get_yearly_billing_summary_returns_correct_breakdown(client, sample_tem
assert len(resp_json) == 3
_assert_dict_equals(resp_json[0], {
'notification_type': SMS_TYPE,
'billing_units': 8,
'rate': 0.12,
'letter_total': 0
})
_assert_dict_equals(resp_json[1], {
'notification_type': EMAIL_TYPE,
'billing_units': 0,
'rate': 0,
'letter_total': 0
})
_assert_dict_equals(resp_json[2], {
_assert_dict_equals(resp_json[1], {
'notification_type': LETTER_TYPE,
'billing_units': 2,
'rate': 0,
'letter_total': 0.72
})
_assert_dict_equals(resp_json[2], {
'notification_type': SMS_TYPE,
'billing_units': 8,
'rate': 0.12,
'letter_total': 0
})
def test_get_yearly_billing_usage_breakdown_returns_400_if_missing_year(client, sample_service):
@@ -485,6 +484,21 @@ def test_get_yearly_usage_by_monthly_from_ft_billing(client, notify_db_session):
def test_compare_ft_billing_to_monthly_billing(client, notify_db_session):
service = set_up_yearly_data()
monthly_billing_response = client.get('/service/{}/billing/monthly-usage?year=2016'.format(service.id),
headers=[create_authorization_header()])
ft_billing_response = client.get('service/{}/billing/ft-monthly-usage?year=2016'.format(service.id),
headers=[('Content-Type', 'application/json'), create_authorization_header()])
monthly_billing_json_resp = json.loads(monthly_billing_response.get_data(as_text=True))
ft_billing_json_resp = json.loads(ft_billing_response.get_data(as_text=True))
assert monthly_billing_json_resp == ft_billing_json_resp
def set_up_yearly_data():
service = create_service()
sms_template = create_template(service=service, template_type="sms")
email_template = create_template(service=service, template_type="email")
@@ -542,14 +556,68 @@ def test_compare_ft_billing_to_monthly_billing(client, notify_db_session):
"rate_multiplier": 1, "billing_units": int(d),
"total_cost": 0.33 * int(d)}]
)
return service
monthly_billing_response = client.get('/service/{}/billing/monthly-usage?year=2016'.format(service.id),
def test_get_yearly_billing_usage_summary_from_ft_billing_comapre_to_monthyl_billing(
client, notify_db_session
):
service = set_up_yearly_data()
monthly_billing_response = client.get('/service/{}/billing/yearly-usage-summary?year=2016'.format(service.id),
headers=[create_authorization_header()])
ft_billing_response = client.get('service/{}/billing/ft-monthly-usage?year=2016'.format(service.id),
ft_billing_response = client.get('service/{}/billing/ft-yearly-usage-summary?year=2016'.format(service.id),
headers=[('Content-Type', 'application/json'), create_authorization_header()])
monthly_billing_json_resp = json.loads(monthly_billing_response.get_data(as_text=True))
ft_billing_json_resp = json.loads(ft_billing_response.get_data(as_text=True))
assert monthly_billing_json_resp == ft_billing_json_resp
assert len(monthly_billing_json_resp) == 3
assert len(ft_billing_json_resp) == 3
for i in range(0, 3):
assert sorted(monthly_billing_json_resp[i]) == sorted(ft_billing_json_resp[i])
def test_get_yearly_billing_usage_summary_from_ft_billing_returns_400_if_missing_year(client, sample_service):
response = client.get(
'/service/{}/billing/ft-yearly-usage-summary'.format(sample_service.id),
headers=[create_authorization_header()]
)
assert response.status_code == 400
assert json.loads(response.get_data(as_text=True)) == {
'message': 'No valid year provided', 'result': 'error'
}
def test_get_yearly_billing_usage_summary_from_ft_billing_returns_empty_list_if_no_billing_data(
client, sample_service
):
response = client.get(
'/service/{}/billing/ft-yearly-usage-summary?year=2016'.format(sample_service.id),
headers=[create_authorization_header()]
)
assert response.status_code == 200
assert json.loads(response.get_data(as_text=True)) == []
def test_get_yearly_billing_usage_summary_from_ft_billing(client, notify_db_session):
service = set_up_yearly_data()
response = client.get('/service/{}/billing/ft-yearly-usage-summary?year=2016'.format(service.id),
headers=[create_authorization_header()]
)
assert response.status_code == 200
json_response = json.loads(response.get_data(as_text=True))
assert len(json_response) == 3
assert json_response[0]['notification_type'] == 'email'
assert json_response[0]['billing_units'] == 275
assert json_response[0]['rate'] == 0
assert json_response[0]['letter_total'] == 0
assert json_response[1]['notification_type'] == 'letter'
assert json_response[1]['billing_units'] == 275
assert json_response[1]['rate'] == 0.33
assert json_response[1]['letter_total'] == 90.75
assert json_response[2]['notification_type'] == 'sms'
assert json_response[2]['billing_units'] == 825
assert json_response[2]['rate'] == 0.0162
assert json_response[0]['letter_total'] == 0

79
tests/app/dao/test_ft_billing_dao.py
View File

@@ -8,6 +8,7 @@ from app import db
from app.dao.fact_billing_dao import (
fetch_monthly_billing_for_year, fetch_billing_data_for_day, get_rates_for_billing,
get_rate,
fetch_billing_totals_for_year,
)
from app.models import FactBilling
from app.utils import convert_utc_to_bst
@@ -21,6 +22,34 @@ from tests.app.db import (
)
def set_up_yearly_data():
service = create_service()
sms_template = create_template(service=service, template_type="sms")
email_template = create_template(service=service, template_type="email")
letter_template = create_template(service=service, template_type="letter")
for year in (2016, 2017):
for month in range(1, 13):
mon = str(month).zfill(2)
for day in range(1, monthrange(year, month)[1] + 1):
d = str(day).zfill(2)
create_ft_billing(bst_date='{}-{}-{}'.format(year, mon, d),
service=service,
template=sms_template,
notification_type='sms',
rate=0.162)
create_ft_billing(bst_date='{}-{}-{}'.format(year, mon, d),
service=service,
template=email_template,
notification_type='email',
rate=0)
create_ft_billing(bst_date='{}-{}-{}'.format(year, mon, d),
service=service,
template=letter_template,
notification_type='letter',
rate=0.33)
return service
def test_fetch_billing_data_for_today_includes_data_with_the_right_status(notify_db_session):
service = create_service()
template = create_template(service=service, template_type="email")
@@ -256,31 +285,7 @@ def test_fetch_monthly_billing_for_year_adds_data_for_today(notify_db_session):
def test_fetch_monthly_billing_for_year_return_financial_year(notify_db_session):
service = create_service()
sms_template = create_template(service=service, template_type="sms")
email_template = create_template(service=service, template_type="email")
letter_template = create_template(service=service, template_type="letter")
for year in (2016, 2017):
for month in range(1, 13):
mon = str(month).zfill(2)
for day in range(1, monthrange(year, month)[1] + 1):
d = str(day).zfill(2)
create_ft_billing(bst_date='{}-{}-{}'.format(year, mon, d),
service=service,
template=sms_template,
notification_type='sms',
rate=0.162)
create_ft_billing(bst_date='{}-{}-{}'.format(year, mon, d),
service=service,
template=email_template,
notification_type='email',
rate=0)
create_ft_billing(bst_date='{}-{}-{}'.format(year, mon, d),
service=service,
template=letter_template,
notification_type='letter',
rate=0.33)
service = set_up_yearly_data()
results = fetch_monthly_billing_for_year(service.id, 2016)
# returns 3 rows, per month, returns financial year april to end of march
@@ -304,3 +309,27 @@ def test_fetch_monthly_billing_for_year_return_financial_year(notify_db_session)
assert results[2].rate == Decimal('0.162')
assert str(results[3].month) == "2016-05-01"
assert str(results[35].month) == "2017-03-01"
def test_fetch_billing_totals_for_year(notify_db_session):
service = set_up_yearly_data()
results = fetch_billing_totals_for_year(service_id=service.id, year=2016)
assert len(results) == 3
assert results[0].notification_type == 'email'
assert results[0].service_id == service.id
assert results[0].notifications_sent == 365
assert results[0].billable_units == 365
assert results[0].rate == Decimal('0')
assert results[1].notification_type == 'letter'
assert results[1].service_id == service.id
assert results[1].notifications_sent == 365
assert results[1].billable_units == 365
assert results[1].rate == Decimal('0.33')
assert results[2].notification_type == 'sms'
assert results[2].service_id == service.id
assert results[2].notifications_sent == 365
assert results[2].billable_units == 365
assert results[2].rate == Decimal('0.162')