Add coupon categories - ENT-1053

AUTHORS

@@ -18,3 +18,4 @@ Bill DeRusha <bill@edx.org>
 Ivan Ivić <iivic@edx.org>
 Saleem Latif <saleem_ee@hotmail.com>
 Asad Iqbal <aiqbal@edx.org>
+Mushtaq Ali <mushtaak@gmail.com>

ecommerce/extensions/api/v2/tests/views/test_coupons.py

@@ -20,7 +20,7 @@ from testfixtures import LogCapture
 
 from ecommerce.coupons.tests.mixins import CouponMixin, DiscoveryMockMixin
 from ecommerce.courses.tests.factories import CourseFactory
-from ecommerce.extensions.api.v2.views.coupons import CouponViewSet
+from ecommerce.extensions.api.v2.views.coupons import DEPRECATED_COUPON_CATEGORIES, CouponViewSet
 from ecommerce.extensions.catalogue.tests.mixins import DiscoveryTestMixin
 from ecommerce.extensions.voucher.models import CouponVouchers
 from ecommerce.invoice.models import Invoice
@@ -1147,3 +1147,10 @@ class CouponCategoriesListViewTests(TestCase):
         response_data = json.loads(response.content)
         self.assertEqual(response_data['count'], 1)
         self.assertEqual(response_data['results'][0]['name'], 'Coupon test category')
+
+    def test_deprecated_category_filtering(self):
+        """ Verify the endpoint doesn't return deprecated coupon categories. """
+        response = self.client.get(self.path)
+        response_data = json.loads(response.content)
+        received_coupon_categories = [category['name'] for category in response_data['results']]
+        self.assertFalse(any(coupon in received_coupon_categories for coupon in DEPRECATED_COUPON_CATEGORIES))

ecommerce/extensions/api/v2/views/coupons.py

@@ -42,6 +42,8 @@ Range = get_model('offer', 'Range')
 StockRecord = get_model('partner', 'StockRecord')
 Voucher = get_model('voucher', 'Voucher')
 
+DEPRECATED_COUPON_CATEGORIES = ['Bulk Enrollment']
+
 
 class CouponViewSet(EdxOrderPlacementMixin, viewsets.ModelViewSet):
     """ Coupon resource. """
@@ -505,4 +507,4 @@ class CouponCategoriesListView(generics.ListAPIView):
 
     def get_queryset(self):
         parent_category = Category.objects.get(slug='coupons')
-        return parent_category.get_children()
+        return parent_category.get_children().exclude(name__in=DEPRECATED_COUPON_CATEGORIES)

ecommerce/extensions/catalogue/migrations/0032_add_coupon_categories.py

+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.11 on 2018-06-28 12:17
+from __future__ import unicode_literals
+
+from django.db import migrations
+from oscar.apps.catalogue.categories import create_from_breadcrumbs
+from oscar.core.loading import get_model
+
+Category = get_model('catalogue', 'Category')
+
+COUPON_CATEGORY_NAME = 'Coupons'
+
+DEFAULT_CATEGORIES = [
+    'Bulk Enrollment - Prepay',
+    'Bulk Enrollment - Upon Redemption',
+    'Bulk Enrollment - Integration',
+]
+
+def create_default_categories(apps, schema_editor):
+    """Create default coupon categories."""
+    for category in DEFAULT_CATEGORIES:
+        create_from_breadcrumbs('{} > {}'.format(COUPON_CATEGORY_NAME, category))
+
+
+def remove_default_categories(apps, schema_editor):
+    """Remove default coupon categories."""
+    Category.objects.get(name=COUPON_CATEGORY_NAME).get_children().filter(
+        name__in=DEFAULT_CATEGORIES
+    ).delete()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('catalogue', '0031_course_entitlement_idverifyreq_attr'),
+    ]
+
+    operations = [
+        migrations.RunPython(create_default_categories, remove_default_categories)
+    ]