Merge pull request #2888 from alphagov/international-letter-rates

Add international letter rates

app/dao/fact_billing_dao.py

@@ -4,7 +4,7 @@ from flask import current_app
 from notifications_utils.timezones import convert_bst_to_utc, convert_utc_to_bst
 from sqlalchemy.dialects.postgresql import insert
 from sqlalchemy import func, desc, Date, Integer, and_
-from sqlalchemy.sql.expression import literal
+from sqlalchemy.sql.expression import case, literal
 
 from app import db
 from app.dao.date_util import (
@@ -28,6 +28,7 @@ from app.models import (
     NOTIFICATION_STATUS_TYPES_BILLABLE_FOR_LETTERS,
     AnnualBilling,
     Organisation,
+    INTERNATIONAL_POSTAGE_TYPES,
 )
 from app.utils import get_london_midnight_in_utc, get_notification_table_to_use
 
@@ -146,13 +147,21 @@ def fetch_letter_costs_for_all_services(start_date, end_date):
 
 
 def fetch_letter_line_items_for_all_services(start_date, end_date):
+    formatted_postage = case(
+        [(FactBilling.postage.in_(INTERNATIONAL_POSTAGE_TYPES), "international")], else_=FactBilling.postage
+    ).label("postage")
+
+    postage_order = case(((formatted_postage == "second", 1),
+                          (formatted_postage == "first", 2),
+                          (formatted_postage == "international", 3)))
+
     query = db.session.query(
         Organisation.name.label("organisation_name"),
         Organisation.id.label("organisation_id"),
         Service.name.label("service_name"),
         Service.id.label("service_id"),
         FactBilling.rate.label("letter_rate"),
-        FactBilling.postage.label("postage"),
+        formatted_postage,
         func.sum(FactBilling.notifications_sent).label("letters_sent"),
     ).select_from(
         Service
@@ -170,11 +179,11 @@ def fetch_letter_line_items_for_all_services(start_date, end_date):
         Service.id,
         Service.name,
         FactBilling.rate,
-        FactBilling.postage
+        formatted_postage
     ).order_by(
         Organisation.name,
         Service.name,
-        FactBilling.postage.desc(),
+        postage_order,
         FactBilling.rate,
     )
     return query.all()

app/models.py

@@ -1356,6 +1356,8 @@ SECOND_CLASS = 'second'
 EUROPE = 'europe'
 REST_OF_WORLD = 'rest-of-world'
 POSTAGE_TYPES = [FIRST_CLASS, SECOND_CLASS, EUROPE, REST_OF_WORLD]
+UK_POSTAGE_TYPES = [FIRST_CLASS, SECOND_CLASS]
+INTERNATIONAL_POSTAGE_TYPES = [EUROPE, REST_OF_WORLD]
 RESOLVE_POSTAGE_FOR_FILE_NAME = {
     FIRST_CLASS: 1,
     SECOND_CLASS: 2,

app/platform_stats/rest.py

@@ -9,6 +9,7 @@ from app.dao.fact_billing_dao import (
 )
 from app.dao.fact_notification_status_dao import fetch_notification_status_totals_for_all_services
 from app.errors import register_errors, InvalidRequest
+from app.models import UK_POSTAGE_TYPES
 from app.platform_stats.platform_stats_schema import platform_stats_request
 from app.service.statistics import format_admin_stats
 from app.schema_validation import validate
@@ -65,7 +66,8 @@ def get_usage_for_all_services():
     letter_breakdown = fetch_letter_line_items_for_all_services(start_date, end_date)
 
     lb_by_service = [
-        (lb.service_id, "{} {} class letters at {}p".format(lb.letters_sent, lb.postage, int(lb.letter_rate * 100)))
+        (lb.service_id,
+         f"{lb.letters_sent} {postage_description(lb.postage)} letters at {format_letter_rate(lb.letter_rate)}")
         for lb in letter_breakdown
     ]
     combined = {}
@@ -106,3 +108,17 @@ def get_usage_for_all_services():
         x['organisation_name'],
         x['service_name']
     )))
+
+
+def postage_description(postage):
+    if postage in UK_POSTAGE_TYPES:
+        return f'{postage} class'
+    else:
+        return 'international'
+
+
+def format_letter_rate(number):
+    if number >= 1:
+        return f"£{number:,.2f}"
+
+    return f"{number * 100:.0f}p"

migrations/versions/0324_int_letter_rates.py

@@ -0,0 +1,54 @@
+"""
+
+Revision ID: 0324_int_letter_rates
+Revises: 0323_broadcast_message
+Create Date: 2020-07-08 12:20:20.700128
+
+"""
+import itertools
+import uuid
+from datetime import datetime
+
+from alembic import op
+from sqlalchemy.sql import text
+
+from app.models import LetterRate
+
+
+revision = '0324_int_letter_rates'
+down_revision = '0323_broadcast_message'
+
+base_rate = 76
+start_date = datetime(2020, 7, 1, 0, 0)
+
+
+def upgrade():
+    """
+    Insert these letter rates for a post_class of both `europe` and `rest-of-world`:
+    1 sheet - £0.84
+    2 sheets - £0.92
+    3 sheets - £1.00
+    4 sheets - £1.08
+    5 sheets - £1.16
+    """
+    op.bulk_insert(LetterRate.__table__, [
+        {
+            'id': uuid.uuid4(),
+            'start_date': start_date,
+            'end_date': None,
+            'sheet_count': sheet_count,
+            'rate': (base_rate + (8 * sheet_count)) / 100.0,
+            'crown': crown,
+            'post_class': post_class,
+        }
+        for sheet_count, crown, post_class in itertools.product(
+            range(1, 6),
+            [True, False],
+            ['europe', 'rest-of-world']
+        )
+    ])
+
+
+def downgrade():
+    conn = op.get_bind()
+    conn.execute(text("DELETE FROM letter_rates WHERE start_date = :start"), start=start_date)

tests/app/celery/test_reporting_tasks.py

@@ -243,6 +243,22 @@ def test_create_nightly_billing_for_day_different_letter_postage(
         billable_units=2,
         postage='second'
     )
+    create_notification(
+        created_at=yesterday,
+        template=sample_letter_template,
+        status='delivered',
+        sent_by='dvla',
+        billable_units=1,
+        postage='europe'
+    )
+    create_notification(
+        created_at=yesterday,
+        template=sample_letter_template,
+        status='delivered',
+        sent_by='dvla',
+        billable_units=3,
+        postage='rest-of-world'
+    )
 
     records = FactBilling.query.all()
     assert len(records) == 0
@@ -251,18 +267,31 @@ def test_create_nightly_billing_for_day_different_letter_postage(
     create_nightly_billing_for_day(yesterday_str)
 
     records = FactBilling.query.order_by('postage').all()
-    assert len(records) == 2
+    assert len(records) == 4
+
     assert records[0].notification_type == LETTER_TYPE
     assert records[0].bst_date == datetime.date(yesterday)
-    assert records[0].postage == 'first'
-    assert records[0].notifications_sent == 2
-    assert records[0].billable_units == 4
+    assert records[0].postage == 'europe'
+    assert records[0].notifications_sent == 1
+    assert records[0].billable_units == 1
 
     assert records[1].notification_type == LETTER_TYPE
     assert records[1].bst_date == datetime.date(yesterday)
-    assert records[1].postage == 'second'
-    assert records[1].notifications_sent == 1
-    assert records[1].billable_units == 2
+    assert records[1].postage == 'first'
+    assert records[1].notifications_sent == 2
+    assert records[1].billable_units == 4
+
+    assert records[2].notification_type == LETTER_TYPE
+    assert records[2].bst_date == datetime.date(yesterday)
+    assert records[2].postage == 'rest-of-world'
+    assert records[2].notifications_sent == 1
+    assert records[2].billable_units == 3
+
+    assert records[3].notification_type == LETTER_TYPE
+    assert records[3].bst_date == datetime.date(yesterday)
+    assert records[3].postage == 'second'
+    assert records[3].notifications_sent == 1
+    assert records[3].billable_units == 2
 
 
 def test_create_nightly_billing_for_day_letter(

tests/app/dao/test_ft_billing_dao.py

@@ -326,10 +326,12 @@ def test_get_rates_for_billing(notify_db_session):
     create_rate(start_date=datetime.utcnow(), value=33, notification_type='email')
     create_letter_rate(start_date=datetime.utcnow(), rate=0.66, post_class='first')
     create_letter_rate(start_date=datetime.utcnow(), rate=0.33, post_class='second')
+    create_letter_rate(start_date=datetime.utcnow(), rate=0.84, post_class='europe')
+    create_letter_rate(start_date=datetime.utcnow(), rate=0.84, post_class='rest-of-world')
     non_letter_rates, letter_rates = get_rates_for_billing()
 
     assert len(non_letter_rates) == 3
-    assert len(letter_rates) == 2
+    assert len(letter_rates) == 4
 
 
 @freeze_time('2017-06-01 12:00')
@@ -353,10 +355,17 @@ def test_get_rate(notify_db_session):
     assert letter_rate == Decimal('0.3')
 
 
-@pytest.mark.parametrize("letter_post_class,expected_rate", [("first", "0.61"), ("second", "0.35")])
+@pytest.mark.parametrize("letter_post_class,expected_rate", [
+    ("first", "0.61"),
+    ("second", "0.35"),
+    ("europe", "0.92"),
+    ("rest-of-world", "1.05"),
+])
 def test_get_rate_filters_letters_by_post_class(notify_db_session, letter_post_class, expected_rate):
     create_letter_rate(start_date=datetime(2017, 5, 30, 23, 0), sheet_count=2, rate=0.61, post_class='first')
     create_letter_rate(start_date=datetime(2017, 5, 30, 23, 0), sheet_count=2, rate=0.35, post_class='second')
+    create_letter_rate(start_date=datetime(2017, 5, 30, 23, 0), sheet_count=2, rate=0.92, post_class='europe')
+    create_letter_rate(start_date=datetime(2017, 5, 30, 23, 0), sheet_count=2, rate=1.05, post_class='rest-of-world')
 
     non_letter_rates, letter_rates = get_rates_for_billing()
     rate = get_rate(non_letter_rates, letter_rates, "letter", datetime(2018, 10, 1), True, 2, letter_post_class)
@@ -614,7 +623,7 @@ def test_fetch_letter_costs_for_all_services(notify_db_session):
     assert len(results) == 3
     assert results[0] == (org.name, org.id, service.name, service.id, Decimal('3.40'))
     assert results[1] == (org_2.name, org_2.id, service_2.name, service_2.id, Decimal('14.00'))
-    assert results[2] == (None, None, service_3.name, service_3.id, Decimal('8.25'))
+    assert results[2] == (None, None, service_3.name, service_3.id, Decimal('24.45'))
 
 
 def test_fetch_letter_line_items_for_all_service(notify_db_session):
@@ -623,12 +632,14 @@ def test_fetch_letter_line_items_for_all_service(notify_db_session):
 
     results = fetch_letter_line_items_for_all_services(datetime(2019, 6, 1), datetime(2019, 9, 30))
 
-    assert len(results) == 5
+    assert len(results) == 7
     assert results[0] == (org_1.name, org_1.id, service_1.name, service_1.id, Decimal('0.45'), 'second', 6)
     assert results[1] == (org_1.name, org_1.id, service_1.name, service_1.id, Decimal("0.35"), 'first', 2)
     assert results[2] == (org_2.name, org_2.id, service_2.name, service_2.id, Decimal("0.65"), 'second', 20)
     assert results[3] == (org_2.name, org_2.id, service_2.name, service_2.id, Decimal("0.50"), 'first', 2)
-    assert results[4] == (None, None, service_3.name, service_3.id, Decimal("0.55"), 'second', 15)
+    assert results[4] == (None, None, service_3.name, service_3.id, Decimal("0.35"), 'second', 2)
+    assert results[5] == (None, None, service_3.name, service_3.id, Decimal("0.50"), 'first', 1)
+    assert results[6] == (None, None, service_3.name, service_3.id, Decimal("1.55"), 'international', 15)
 
 
 @freeze_time('2019-06-01 13:30')

tests/app/db.py

@@ -941,7 +941,13 @@ def set_up_usage_data(start_date):
                       notifications_sent=12, billable_unit=5, rate=.65, postage='second')
 
     create_ft_billing(bst_date=two_days_later, template=letter_template_4,
-                      notifications_sent=15, billable_unit=4, rate=.55, postage='second')
+                      notifications_sent=7, billable_unit=4, rate=1.55, postage='rest-of-world')
+    create_ft_billing(bst_date=two_days_later, template=letter_template_4,
+                      notifications_sent=8, billable_unit=4, rate=1.55, postage='europe')
+    create_ft_billing(bst_date=two_days_later, template=letter_template_4,
+                      notifications_sent=2, billable_unit=1, rate=.35, postage='second')
+    create_ft_billing(bst_date=two_days_later, template=letter_template_4,
+                      notifications_sent=1, billable_unit=1, rate=.50, postage='first')
 
     create_ft_billing(bst_date=start_date, template=email_template, notifications_sent=10)
 

tests/app/platform_stats/test_rest.py

@@ -153,5 +153,7 @@ def test_get_usage_for_all_services(notify_db_session, admin_request):
     assert response[3]["service_id"] == str(service_3.id)
     assert response[3]["sms_cost"] == 0
     assert response[3]["sms_fragments"] == 0
-    assert response[3]["letter_cost"] == 8.25
-    assert response[3]["letter_breakdown"] == "15 second class letters at 55p\n"
+    assert response[3]["letter_cost"] == 24.45
+    assert response[3]["letter_breakdown"] == (
+        "2 second class letters at 35p\n1 first class letters at 50p\n15 international letters at £1.55\n"
+    )