class EcommerceAPITests(EcommerceApiTestMixin, TestCase): """ Tests for the E-Commerce API client. """ SKU = '1234' def setUp(self): super(EcommerceAPITests, self).setUp() self.url = reverse('commerce:baskets') self.user = UserFactory() self.api = EcommerceAPI() def test_constructor_url_strip(self): """ Verifies that the URL is stored with trailing slashes removed. """ url = 'http://example.com' api = EcommerceAPI(url, 'edx') self.assertEqual(api.url, url) api = EcommerceAPI(url + '/', 'edx') self.assertEqual(api.url, url) @override_settings(ECOMMERCE_API_URL=None, ECOMMERCE_API_SIGNING_KEY=None) def test_no_settings(self): """ If the settings ECOMMERCE_API_URL and ECOMMERCE_API_SIGNING_KEY are invalid, the constructor should raise a ValueError. """ self.assertRaises(InvalidConfigurationError, EcommerceAPI) @httpretty.activate @data(True, False) def test_create_basket(self, is_payment_required): """ Verify the method makes a call to the E-Commerce API with the correct headers and data. """ self._mock_ecommerce_api(is_payment_required=is_payment_required) response_data = self.api.create_basket(self.user, self.SKU, self.PROCESSOR) # Validate the request sent to the E-Commerce API endpoint. request = httpretty.last_request() self.assertValidBasketRequest(request, self.user, self.ECOMMERCE_API_SIGNING_KEY, self.SKU, self.PROCESSOR) # Validate the data returned by the method self.assertEqual(response_data['id'], self.BASKET_ID) if is_payment_required: self.assertEqual(response_data['order'], None) self.assertEqual(response_data['payment_data'], self.PAYMENT_DATA) else: self.assertEqual(response_data['order'], {"number": self.ORDER_NUMBER}) self.assertEqual(response_data['payment_data'], None) @httpretty.activate @data(400, 401, 405, 406, 429, 500, 503) def test_create_basket_with_invalid_http_status(self, status): """ If the E-Commerce API returns a non-200 status, the method should raise an InvalidResponseError. """ self._mock_ecommerce_api(status=status, body=json.dumps({'user_message': 'FAIL!'})) self.assertRaises(InvalidResponseError, self.api.create_basket, self.user, self.SKU, self.PROCESSOR) @httpretty.activate def test_create_basket_with_invalid_json(self): """ If the E-Commerce API returns un-parseable data, the method should raise an InvalidResponseError. """ self._mock_ecommerce_api(body='TOTALLY NOT JSON!') self.assertRaises(InvalidResponseError, self.api.create_basket, self.user, self.SKU, self.PROCESSOR) @httpretty.activate def test_create_basket_with_timeout(self): """ If the call to the E-Commerce API times out, the method should raise a TimeoutError. """ def request_callback(_request, _uri, _headers): """ Simulates API timeout """ raise Timeout self._mock_ecommerce_api(body=request_callback) self.assertRaises(TimeoutError, self.api.create_basket, self.user, self.SKU, self.PROCESSOR)
def post(self, request, *args, **kwargs): # pylint: disable=unused-argument """ Attempt to create the basket and enroll the user. """ user = request.user valid, course_key, error = self._is_data_valid(request) if not valid: return DetailResponse(error, status=HTTP_406_NOT_ACCEPTABLE) # Don't do anything if an enrollment already exists course_id = unicode(course_key) enrollment = CourseEnrollment.get_enrollment(user, course_key) if enrollment and enrollment.is_active: msg = Messages.ENROLLMENT_EXISTS.format(course_id=course_id, username=user.username) return DetailResponse(msg, status=HTTP_409_CONFLICT) # If there is no honor course mode, this most likely a Prof-Ed course. Return an error so that the JS # redirects to track selection. honor_mode = CourseMode.mode_for_course(course_key, CourseMode.HONOR) if not honor_mode: msg = Messages.NO_HONOR_MODE.format(course_id=course_id) return DetailResponse(msg, status=HTTP_406_NOT_ACCEPTABLE) elif not honor_mode.sku: # If there are no course modes with SKUs, enroll the user without contacting the external API. msg = Messages.NO_SKU_ENROLLED.format(enrollment_mode=CourseMode.HONOR, course_id=course_id, username=user.username) log.debug(msg) self._enroll(course_key, user) return DetailResponse(msg) # Setup the API and report any errors if settings are not valid. try: api = EcommerceAPI() except InvalidConfigurationError: self._enroll(course_key, user) msg = Messages.NO_ECOM_API.format(username=user.username, course_id=unicode(course_key)) log.debug(msg) return DetailResponse(msg) # Make the API call try: response_data = api.create_basket( user, honor_mode.sku, payment_processor="cybersource", ) payment_data = response_data["payment_data"] if payment_data is not None: # it is time to start the payment flow. # NOTE this branch does not appear to be used at the moment. return JsonResponse(payment_data) elif response_data['order']: # the order was completed immediately because there was no charge. msg = Messages.ORDER_COMPLETED.format(order_number=response_data['order']['number']) log.debug(msg) return DetailResponse(msg) else: # Enroll in the honor mode directly as a failsafe. # This MUST be removed when this code handles paid modes. self._enroll(course_key, user) msg = u'Unexpected response from basket endpoint.' log.error( msg + u' Could not enroll user %(username)s in course %(course_id)s.', {'username': user.id, 'course_id': course_id}, ) raise InvalidResponseError(msg) except ApiError as err: # The API will handle logging of the error. return InternalRequestErrorResponse(err.message)