Merge pull request #771 from edx/mjfrey/course-api-util

DRY: Use utility function to get course info from LMS

ecommerce/coupons/views.py

@@ -14,12 +14,12 @@ from django.utils.translation import ugettext_lazy as _
 from django.shortcuts import render
 from django.utils import timezone
 from django.views.generic import TemplateView, View
-from edx_rest_api_client.client import EdxRestApiClient
 from edx_rest_api_client.exceptions import SlumberHttpBaseException
 from oscar.core.loading import get_class, get_model
 
 from ecommerce.core.url_utils import get_ecommerce_url, get_lms_url
 from ecommerce.core.views import StaffOnlyMixin
+from ecommerce.courses.utils import get_course_info_from_lms
 from ecommerce.extensions.api import exceptions
 from ecommerce.extensions.analytics.utils import prepare_analytics_data
 from ecommerce.extensions.api.constants import APIConstants as AC
@@ -136,11 +136,8 @@ class CouponOfferView(TemplateView):
                 }
             valid_voucher, msg = voucher_is_valid(voucher, product, self.request)
             if valid_voucher:
-                api = EdxRestApiClient(
-                    get_lms_url('api/courses/v1/'),
-                )
                 try:
-                    course = api.courses(product.course_id).get()
+                    course = get_course_info_from_lms(product.course_id)
                 except SlumberHttpBaseException as e:
                     logger.exception('Could not get course information. [%s]', e)
                     return {

ecommerce/courses/tests/test_utils.py

+import hashlib
+
 import ddt
+import httpretty
+
+from django.core.cache import cache
 
+from ecommerce.core.url_utils import get_lms_url
 from ecommerce.courses.models import Course
-from ecommerce.courses.utils import mode_for_seat
+from ecommerce.courses.tests.factories import CourseFactory
+from ecommerce.courses.utils import get_course_info_from_lms, mode_for_seat
 from ecommerce.extensions.catalogue.tests.mixins import CourseCatalogTestMixin
 from ecommerce.tests.testcases import TestCase
 
 
+@httpretty.activate
 @ddt.ddt
 class UtilsTests(CourseCatalogTestMixin, TestCase):
     @ddt.unpack
@@ -24,3 +32,20 @@ class UtilsTests(CourseCatalogTestMixin, TestCase):
         course = Course.objects.create(id='edx/Demo_Course/DemoX')
         seat = course.create_or_update_seat(certificate_type, id_verification_required, 10.00, self.partner)
         self.assertEqual(mode_for_seat(seat), mode)
+
+    def test_get_course_info_from_lms(self):
+        """ Check to see if course info gets cached """
+        course = CourseFactory()
+        course_url = get_lms_url('api/courses/v1/courses/{}/'.format(course.id))
+        httpretty.register_uri(httpretty.GET, course_url, body=course.name, status=200, content_type='application/json')
+
+        cache_key = 'courses_api_detail_{}'.format(course.id)
+        cache_hash = hashlib.md5(cache_key).hexdigest()
+        cached_course = cache.get(cache_hash)
+        self.assertIsNone(cached_course)
+
+        response = get_course_info_from_lms(course.id)
+        self.assertEqual(response, course.name)
+
+        cached_course = cache.get(cache_hash)
+        self.assertEqual(cached_course, response)

ecommerce/courses/utils.py

+import hashlib
+
+from django.conf import settings
+from django.core.cache import cache
+from edx_rest_api_client.client import EdxRestApiClient
+
+from ecommerce.core.url_utils import get_lms_url
+
+
 def mode_for_seat(seat):
     """ Returns the Enrollment mode for a given seat product. """
     certificate_type = getattr(seat.attr, 'certificate_type', '')
@@ -8,3 +17,15 @@ def mode_for_seat(seat):
         return 'audit'
 
     return certificate_type
+
+
+def get_course_info_from_lms(course_key):
+    """ Get course information from LMS via the course api and cache """
+    api = EdxRestApiClient(get_lms_url('api/courses/v1/'))
+    cache_key = 'courses_api_detail_{}'.format(course_key)
+    cache_hash = hashlib.md5(cache_key).hexdigest()
+    course = cache.get(cache_hash)
+    if not course:  # pragma: no cover
+        course = api.courses(course_key).get()
+        cache.set(cache_hash, course, settings.COURSES_API_CACHE_TIMEOUT)
+    return course

ecommerce/extensions/basket/views.py

 from __future__ import unicode_literals
 
-import hashlib
 import logging
 
-from django.conf import settings
 from django.http import HttpResponseBadRequest, HttpResponseRedirect
-from django.core.cache import cache
 from django.core.urlresolvers import reverse
 from django.utils.translation import ugettext_lazy as _
 from requests.exceptions import ConnectionError, Timeout
@@ -17,7 +14,7 @@ from slumber.exceptions import SlumberBaseException
 from ecommerce.core.constants import ENROLLMENT_CODE_PRODUCT_CLASS_NAME, SEAT_PRODUCT_CLASS_NAME
 from ecommerce.core.url_utils import get_lms_url, get_lms_enrollment_base_api_url
 from ecommerce.coupons.views import get_voucher_from_code
-from ecommerce.courses.utils import mode_for_seat
+from ecommerce.courses.utils import get_course_info_from_lms, mode_for_seat
 from ecommerce.extensions.analytics.utils import prepare_analytics_data
 from ecommerce.extensions.basket.utils import get_certificate_type_display_value, prepare_basket, get_basket_switch_data
 from ecommerce.extensions.offer.utils import format_benefit_value
@@ -111,22 +108,16 @@ class BasketSummaryView(BasketView):
         formset = context.get('formset', [])
         lines = context.get('line_list', [])
         lines_data = []
-        api = EdxRestApiClient(get_lms_url('api/courses/v1/'))
         is_verification_required = is_bulk_purchase = False
         switch_link_text = partner_sku = ''
 
         for line in lines:
             course_key = CourseKey.from_string(line.product.attr.course_key)
-            cache_key = 'courses_api_detail_{}'.format(course_key)
-            cache_hash = hashlib.md5(cache_key).hexdigest()
             course_name = None
             image_url = None
             short_description = None
             try:
-                course = cache.get(cache_hash)
-                if not course:
-                    course = api.courses(course_key).get()
-                    cache.set(cache_hash, course, settings.COURSES_API_CACHE_TIMEOUT)
+                course = get_course_info_from_lms(course_key)
                 image_url = get_lms_url(course['media']['course_image']['uri'])
                 short_description = course['short_description']
                 course_name = course['name']