Usage DAO can now return rates and billable amount, alongside units.

app/dao/notification_usage_dao.py

@@ -157,20 +157,66 @@ def rate_multiplier():
 
 @statsd(namespace="dao")
 def get_total_billable_units_for_sent_sms_notifications_in_date_range(start_date, end_date, service_id):
-    rates = get_rates_for_year(start_date, end_date, SMS_TYPE)
-    print(rates)
 
-    result = db.session.query(
+    billable_units = 0
-        func.sum(
+    total_cost = 0.0
-            NotificationHistory.billable_units * func.coalesce(NotificationHistory.rate_multiplier, 1)
+
-        ).label('billable_units')
+    rate_boundaries = discover_rate_bounds_for_billing_query(start_date, end_date)
-    ).filter(
+    for rate_boundary in rate_boundaries:
-        NotificationHistory.service_id == service_id,
+        result = db.session.query(
-        NotificationHistory.notification_type == 'sms',
+            func.sum(
-        NotificationHistory.created_at >= start_date,
+                NotificationHistory.billable_units * func.coalesce(NotificationHistory.rate_multiplier, 1)
-        NotificationHistory.created_at <= end_date,
+            ).label('billable_units')
-        NotificationHistory.status.in_(NOTIFICATION_STATUS_TYPES_BILLABLE)
+        ).filter(
-    )
+            NotificationHistory.service_id == service_id,
-    if result.scalar():
+            NotificationHistory.notification_type == 'sms',
-        return int(result.scalar())
+            NotificationHistory.created_at >= rate_boundary['start_date'],
-    return 0
+            NotificationHistory.created_at < rate_boundary['end_date'],
+            NotificationHistory.status.in_(NOTIFICATION_STATUS_TYPES_BILLABLE)
+        )
+        billable_units_by_rate_boundry = result.scalar()
+        if billable_units_by_rate_boundry:
+            billable_units += int(billable_units_by_rate_boundry)vi end_date
+            total_cost += int(billable_units_by_rate_boundry) * rate_boundary['rate']
+
+    return billable_units, total_cost
+
+
+def discover_rate_bounds_for_billing_query(start_date, end_date):
+    bounds = []
+    rates = get_rates_for_year(start_date, end_date, SMS_TYPE)
+
+    def current_valid_from(index):
+        return rates[index].valid_from
+
+    def next_valid_from(index):
+        return rates[index + 1].valid_from
+
+    def current_rate(index):
+        return rates[index].rate
+
+    def append_rate(rate_start_date, rate_end_date, rate):
+        bounds.append({
+            'start_date': rate_start_date,
+            'end_date': rate_end_date,
+            'rate': rate
+        })
+
+    if len(rates) == 1:
+        append_rate(start_date, end_date, current_rate(0))
+        return bounds
+
+    for i in range(len(rates)):
+        # first boundary
+        if i == 0:
+            append_rate(start_date, next_valid_from(i), current_rate(i))
+
+        # last boundary
+        elif i == (len(rates) - 1):
+            append_rate(current_valid_from(i), end_date, current_rate(i))
+
+        # other boundaries
+        else:
+            append_rate(current_valid_from(i), next_valid_from(i), current_rate(i))
+
+    return bounds

tests/app/dao/test_notification_usage_dao.py

@@ -4,11 +4,19 @@ from datetime import datetime, timedelta
 import pytest
 
 from app.dao.date_util import get_financial_year
-from app.dao.notification_usage_dao import (get_rates_for_year, get_yearly_billing_data,
+from app.dao.notification_usage_dao import (
-                                            get_monthly_billing_data,
+    get_rates_for_year,
-                                            get_total_billable_units_for_sent_sms_notifications_in_date_range)
+    get_yearly_billing_data,
-from app.models import Rate, NOTIFICATION_STATUS_SUCCESS, NOTIFICATION_DELIVERED, NOTIFICATION_STATUS_TYPES_BILLABLE, \
+    get_monthly_billing_data,
-    NOTIFICATION_CREATED, NOTIFICATION_STATUS_TYPES_NON_BILLABLE
+    get_total_billable_units_for_sent_sms_notifications_in_date_range,
+    discover_rate_bounds_for_billing_query
+)
+from app.models import (
+    Rate,
+    NOTIFICATION_DELIVERED,
+    NOTIFICATION_STATUS_TYPES_BILLABLE,
+    NOTIFICATION_STATUS_TYPES_NON_BILLABLE,
+    Notification)
 from tests.app.conftest import sample_notification, sample_email_template, sample_letter_template, sample_service
 from tests.app.db import create_notification
 from freezegun import freeze_time
@@ -258,6 +266,8 @@ def set_up_rate(notify_db, start_date, value):
 
 @freeze_time("2016-01-10 12:00:00.000000")
 def test_returns_total_billable_units_for_sms_notifications(notify_db, notify_db_session, sample_service):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 0.016)
+
     sample_notification(
         notify_db, notify_db_session, service=sample_service, billable_units=1, status=NOTIFICATION_DELIVERED)
     sample_notification(
@@ -270,13 +280,16 @@ def test_returns_total_billable_units_for_sms_notifications(notify_db, notify_db
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
 
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id) == 10
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 10
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 0.16
 
 
 @freeze_time("2016-01-10 12:00:00.000000")
 def test_returns_total_billable_units_multiplied_by_multipler_for_sms_notifications(
         notify_db, notify_db_session, sample_service
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     sample_notification(
         notify_db, notify_db_session, service=sample_service, rate_multiplier=1.0, status=NOTIFICATION_DELIVERED)
     sample_notification(
@@ -289,13 +302,94 @@ def test_returns_total_billable_units_multiplied_by_multipler_for_sms_notificati
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
 
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id) == 18
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 18
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 45
+
+
+def test_returns_total_billable_units_multiplied_by_multipler_for_sms_notifications_for_several_rates(
+        notify_db, notify_db_session, sample_service
+):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2)
+    set_up_rate(notify_db, datetime(2016, 10, 1), 4)
+    set_up_rate(notify_db, datetime(2017, 1, 1), 6)
+
+    eligble_rate_1 = datetime(2016, 2, 1)
+    eligble_rate_2 = datetime(2016, 11, 1)
+    eligble_rate_3 = datetime(2017, 2, 1)
+
+    sample_notification(
+        notify_db,
+        notify_db_session,
+        service=sample_service,
+        rate_multiplier=1.0,
+        status=NOTIFICATION_DELIVERED,
+        created_at=eligble_rate_1)
+
+    sample_notification(
+        notify_db,
+        notify_db_session,
+        service=sample_service,
+        rate_multiplier=2.0,
+        status=NOTIFICATION_DELIVERED,
+        created_at=eligble_rate_2)
+
+    sample_notification(
+        notify_db,
+        notify_db_session,
+        service=sample_service,
+        rate_multiplier=5.0,
+        status=NOTIFICATION_DELIVERED,
+        created_at=eligble_rate_3)
+
+    start = datetime(2016, 1, 1)
+    end = datetime(2018, 1, 1)
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 8
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 40
+
+
+def test_returns_total_billable_units_for_sms_notifications_for_several_rates_where_dates_match_rate_boundary(
+        notify_db, notify_db_session, sample_service
+):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2)
+    set_up_rate(notify_db, datetime(2016, 10, 1), 4)
+    set_up_rate(notify_db, datetime(2017, 1, 1), 6)
+
+    eligble_rate_1_start = datetime(2016, 1, 1, 0, 0, 0, 0)
+    eligble_rate_1_end = datetime(2016, 9, 30, 23, 59, 59, 999)
+    eligble_rate_2_start = datetime(2016, 10, 1, 0, 0, 0, 0)
+    eligble_rate_2_end = datetime(2016, 12, 31, 23, 59, 59, 999)
+    eligble_rate_3_start = datetime(2017, 1, 1, 0, 0, 0, 0)
+    eligble_rate_3_whenever = datetime(2017, 12, 12, 0, 0, 0, 0)
+
+    def make_notification(created_at):
+        sample_notification(
+            notify_db,
+            notify_db_session,
+            service=sample_service,
+            rate_multiplier=1.0,
+            status=NOTIFICATION_DELIVERED,
+            created_at=created_at)
+
+    make_notification(eligble_rate_1_start)
+    make_notification(eligble_rate_1_end)
+    make_notification(eligble_rate_2_start)
+    make_notification(eligble_rate_2_end)
+    make_notification(eligble_rate_3_start)
+    make_notification(eligble_rate_3_whenever)
+
+    start = datetime(2016, 1, 1)
+    end = datetime(2018, 1, 1)
+
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 6
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 24.0
 
 
 @freeze_time("2016-01-10 12:00:00.000000")
 def test_returns_total_billable_units_for_sms_notifications_ignoring_letters_and_emails(
         notify_db, notify_db_session, sample_service
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     email_template = sample_email_template(notify_db, notify_db_session, service=sample_service)
     letter_template = sample_letter_template(sample_service)
 
@@ -324,13 +418,16 @@ def test_returns_total_billable_units_for_sms_notifications_ignoring_letters_and
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
 
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id) == 2
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 2
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 5
 
 
 @freeze_time("2016-01-10 12:00:00.000000")
 def test_returns_total_billable_units_for_sms_notifications_for_only_requested_service(
         notify_db, notify_db_session
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     service_1 = sample_service(notify_db, notify_db_session, service_name=str(uuid.uuid4()))
     service_2 = sample_service(notify_db, notify_db_session, service_name=str(uuid.uuid4()))
     service_3 = sample_service(notify_db, notify_db_session, service_name=str(uuid.uuid4()))
@@ -358,13 +455,16 @@ def test_returns_total_billable_units_for_sms_notifications_for_only_requested_s
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
 
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, service_1.id) == 2
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, service_1.id)[0] == 2
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, service_1.id)[1] == 5
 
 
 @freeze_time("2016-01-10 12:00:00.000000")
 def test_returns_total_billable_units_for_sms_notifications_handling_null_values(
     notify_db, notify_db_session, sample_service
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     sample_notification(
         notify_db,
         notify_db_session,
@@ -376,7 +476,8 @@ def test_returns_total_billable_units_for_sms_notifications_handling_null_values
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
 
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id) == 2
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 2
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 5
 
 
 @pytest.mark.parametrize('billable_units, states', ([
@@ -387,6 +488,8 @@ def test_returns_total_billable_units_for_sms_notifications_handling_null_values
 def test_ignores_non_billable_states_when_returning_billable_units_for_sms_notifications(
     notify_db, notify_db_session, sample_service, billable_units, states
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     for state in states:
         sample_notification(
             notify_db,
@@ -401,13 +504,18 @@ def test_ignores_non_billable_states_when_returning_billable_units_for_sms_notif
 
     assert get_total_billable_units_for_sent_sms_notifications_in_date_range(
         start, end, sample_service.id
-    ) == billable_units
+    )[0] == billable_units
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(
+        start, end, sample_service.id
+    )[1] == billable_units * 2.5
 
 
 @freeze_time("2016-01-10 12:00:00.000000")
 def test_restricts_to_time_period_when_returning_billable_units_for_sms_notifications(
     notify_db, notify_db_session, sample_service
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     sample_notification(
         notify_db,
         notify_db_session,
@@ -429,12 +537,71 @@ def test_restricts_to_time_period_when_returning_billable_units_for_sms_notifica
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
 
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id) == 1
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 1
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 2.5
 
 
 def test_returns_zero_if_no_matching_rows_when_returning_billable_units_for_sms_notifications(
         notify_db, notify_db_session, sample_service
 ):
+    set_up_rate(notify_db, datetime(2016, 1, 1), 2.5)
+
     start = datetime.utcnow() - timedelta(minutes=10)
     end = datetime.utcnow() + timedelta(minutes=10)
-    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id) == 0
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[0] == 0
+    assert get_total_billable_units_for_sent_sms_notifications_in_date_range(start, end, sample_service.id)[1] == 0.0
+
+
+def test_should_calculate_rate_boundaries_for_billing_query_for_single_relevant_rate(notify_db, notify_db_session):
+    start_date, end_date = get_financial_year(2016)
+    set_up_rate(notify_db, datetime(2016, 1, 1), 0.016)
+    rate_boundaries = discover_rate_bounds_for_billing_query(start_date, end_date)
+    print(rate_boundaries)
+    assert len(rate_boundaries) == 1
+    assert rate_boundaries[0]['start_date'] == start_date
+    assert rate_boundaries[0]['end_date'] == end_date
+    assert rate_boundaries[0]['rate'] == 0.016
+
+
+def test_should_calculate_rate_boundaries_for_billing_query_for_two_relevant_rates(notify_db, notify_db_session):
+    start_date, end_date = get_financial_year(2016)
+
+    rate_1_valid_from = datetime(2016, 1, 1)
+    rate_2_valid_from = datetime(2017, 1, 1)
+
+    set_up_rate(notify_db, rate_1_valid_from, 0.02)
+    set_up_rate(notify_db, rate_2_valid_from, 0.04)
+    rate_boundaries = discover_rate_bounds_for_billing_query(start_date, end_date)
+    assert len(rate_boundaries) == 2
+    assert rate_boundaries[0]['start_date'] == start_date
+    assert rate_boundaries[0]['end_date'] == rate_2_valid_from
+    assert rate_boundaries[0]['rate'] == 0.02
+
+    assert rate_boundaries[1]['start_date'] == rate_2_valid_from
+    assert rate_boundaries[1]['end_date'] == end_date
+    assert rate_boundaries[1]['rate'] == 0.04
+
+
+def test_should_calculate_rate_boundaries_for_billing_query_for_three_relevant_rates(notify_db, notify_db_session):
+    start_date, end_date = get_financial_year(2016)
+    rate_1_valid_from = datetime(2016, 1, 1)
+    rate_2_valid_from = datetime(2017, 1, 1)
+    rate_3_valid_from = datetime(2017, 2, 1)
+
+    set_up_rate(notify_db, rate_1_valid_from, 0.02)
+    set_up_rate(notify_db, rate_2_valid_from, 0.04)
+    set_up_rate(notify_db, rate_3_valid_from, 0.06)
+    rate_boundaries = discover_rate_bounds_for_billing_query(start_date, end_date)
+    assert len(rate_boundaries) == 3
+
+    assert rate_boundaries[0]['start_date'] == start_date
+    assert rate_boundaries[0]['end_date'] == rate_2_valid_from
+    assert rate_boundaries[0]['rate'] == 0.02
+
+    assert rate_boundaries[1]['start_date'] == rate_2_valid_from
+    assert rate_boundaries[1]['end_date'] == rate_3_valid_from
+    assert rate_boundaries[1]['rate'] == 0.04
+
+    assert rate_boundaries[2]['start_date'] == rate_3_valid_from
+    assert rate_boundaries[2]['end_date'] == end_date
+    assert rate_boundaries[2]['rate'] == 0.06