mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-20 07:21:13 -05:00
136 lines
4.9 KiB
Python
136 lines
4.9 KiB
Python
from datetime import datetime
|
|
import json
|
|
|
|
from flask import Blueprint, jsonify, request
|
|
|
|
from app.dao.monthly_billing_dao import (
|
|
get_billing_data_for_financial_year,
|
|
get_monthly_billing_by_notification_type
|
|
)
|
|
from app.dao.date_util import get_financial_year, get_months_for_financial_year
|
|
from app.errors import register_errors
|
|
from app.models import SMS_TYPE, EMAIL_TYPE
|
|
from app.utils import convert_utc_to_bst
|
|
from app.dao.annual_billing_dao import (dao_get_free_sms_fragment_limit_for_year,
|
|
dao_get_all_free_sms_fragment_limit,
|
|
dao_create_or_update_annual_billing_for_year)
|
|
from app.billing.billing_schemas import create_or_update_free_sms_fragment_limit_schema
|
|
from app.errors import InvalidRequest
|
|
from app.schema_validation import validate
|
|
from app.models import AnnualBilling
|
|
|
|
billing_blueprint = Blueprint(
|
|
'billing',
|
|
__name__,
|
|
url_prefix='/service/<uuid:service_id>/billing'
|
|
)
|
|
|
|
|
|
register_errors(billing_blueprint)
|
|
|
|
|
|
@billing_blueprint.route('/monthly-usage')
|
|
def get_yearly_usage_by_month(service_id):
|
|
try:
|
|
year = int(request.args.get('year'))
|
|
start_date, end_date = get_financial_year(year)
|
|
results = []
|
|
for month in get_months_for_financial_year(year):
|
|
billing_for_month = get_monthly_billing_by_notification_type(service_id, month, SMS_TYPE)
|
|
if billing_for_month:
|
|
results.append(_transform_billing_for_month(billing_for_month))
|
|
return json.dumps(results)
|
|
|
|
except TypeError:
|
|
return jsonify(result='error', message='No valid year provided'), 400
|
|
|
|
|
|
@billing_blueprint.route('/yearly-usage-summary')
|
|
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]
|
|
response = [
|
|
_get_total_billable_units_and_rate_for_notification_type(billing_data, notification_type)
|
|
for notification_type in notification_types
|
|
]
|
|
|
|
return json.dumps(response)
|
|
|
|
except TypeError:
|
|
return jsonify(result='error', message='No valid year provided'), 400
|
|
|
|
|
|
def _get_total_billable_units_and_rate_for_notification_type(billing_data, noti_type):
|
|
total_sent = 0
|
|
rate = 0
|
|
for entry in billing_data:
|
|
for monthly_total in entry.monthly_totals:
|
|
if entry.notification_type == noti_type:
|
|
total_sent += monthly_total['billing_units'] \
|
|
if noti_type == EMAIL_TYPE else (monthly_total['billing_units'] * monthly_total['rate_multiplier'])
|
|
rate = monthly_total['rate']
|
|
|
|
return {
|
|
"notification_type": noti_type,
|
|
"billing_units": total_sent,
|
|
"rate": rate
|
|
}
|
|
|
|
|
|
def _transform_billing_for_month(billing_for_month):
|
|
month_name = datetime.strftime(convert_utc_to_bst(billing_for_month.start_date), "%B")
|
|
billing_units = rate = 0
|
|
|
|
for total in billing_for_month.monthly_totals:
|
|
billing_units += (total['billing_units'] * total['rate_multiplier'])
|
|
rate = total['rate']
|
|
|
|
return {
|
|
"month": month_name,
|
|
"billing_units": billing_units,
|
|
"notification_type": billing_for_month.notification_type,
|
|
"rate": rate
|
|
}
|
|
|
|
|
|
@billing_blueprint.route('/free-sms-fragment-limit', methods=["GET"])
|
|
def get_free_sms_fragment_limit(service_id):
|
|
|
|
financial_year_start = request.args.get('financial_year_start')
|
|
|
|
if financial_year_start is None:
|
|
results = dao_get_all_free_sms_fragment_limit(service_id)
|
|
|
|
if len(results) == 0:
|
|
raise InvalidRequest('no annual billing information for this service', status_code=404)
|
|
return jsonify(data=[row.serialize_free_sms_items() for row in results]), 200
|
|
else:
|
|
result = dao_get_free_sms_fragment_limit_for_year(service_id, financial_year_start)
|
|
if result is None:
|
|
raise InvalidRequest('no free-sms-fragment-limit-info for this service and year', status_code=404)
|
|
|
|
return jsonify(data=result.serialize_free_sms_items()), 200
|
|
|
|
|
|
@billing_blueprint.route('/free-sms-fragment-limit', methods=["POST"])
|
|
def create_or_update_free_sms_fragment_limit(service_id):
|
|
|
|
form = validate(request.get_json(), create_or_update_free_sms_fragment_limit_schema)
|
|
|
|
financial_year_start = form.get('financial_year_start')
|
|
free_sms_fragment_limit = form.get('free_sms_fragment_limit')
|
|
|
|
result = dao_get_free_sms_fragment_limit_for_year(service_id, financial_year_start)
|
|
|
|
if result:
|
|
result.free_sms_fragment_limit = free_sms_fragment_limit
|
|
else:
|
|
result = AnnualBilling(service_id=service_id, financial_year_start=financial_year_start,
|
|
free_sms_fragment_limit=free_sms_fragment_limit)
|
|
|
|
dao_create_or_update_annual_billing_for_year(result)
|
|
|
|
return jsonify(data=form), 201
|