Skip to content

Commit

Permalink
Merge pull request #12401 from edx/ahsan/removal-underscore-string-fr…
Browse files Browse the repository at this point in the history
…om-commerce-js

Ahsan/removal underscore string from commerce js
  • Loading branch information
Ahsan Ulhaq committed May 17, 2016
2 parents 1bd2ec2 + 300002b commit 7a43b57
Show file tree
Hide file tree
Showing 5 changed files with 317 additions and 98 deletions.
26 changes: 10 additions & 16 deletions lms/static/js/commerce/views/receipt_view.js
Expand Up @@ -3,7 +3,7 @@
*/
var edx = edx || {};

(function ($, _, _s, Backbone) {
(function ($, _, Backbone) {
'use strict';

edx.commerce = edx.commerce || {};
Expand All @@ -19,11 +19,6 @@ var edx = edx || {};
this.useEcommerceApi = this.ecommerceBasketId || this.ecommerceOrderNumber;
_.bindAll(this, 'renderReceipt', 'renderError', 'getProviderData', 'renderProvider', 'getCourseData');

/* Mix non-conflicting functions from underscore.string (all but include, contains, and reverse) into
* the Underscore namespace.
*/
_.mixin(_s.exports());

this.render();
},

Expand Down Expand Up @@ -125,17 +120,16 @@ var edx = edx || {};
* @return {object} JQuery Promise.
*/
getReceiptData: function (orderId) {
var urlFormat = '/shoppingcart/receipt/%s/';
var urlFormat = '/shoppingcart/receipt/{orderId}/';

if (this.ecommerceOrderNumber) {
urlFormat = '/api/commerce/v1/orders/%s/';
urlFormat = '/api/commerce/v1/orders/{orderId}/';
} else if (this.ecommerceBasketId){
urlFormat = '/api/commerce/v0/baskets/%s/order/';
urlFormat = '/api/commerce/v0/baskets/{orderId}/order/';
}


return $.ajax({
url: _.sprintf(urlFormat, orderId),
url: edx.StringUtils.interpolate(urlFormat, {orderId: orderId}),
type: 'GET',
dataType: 'json'
}).retry({times: 5, timeout: 2000, statusCodes: [404]});
Expand All @@ -146,10 +140,10 @@ var edx = edx || {};
* @return {object} JQuery Promise.
*/
getProviderData: function (providerId) {
var providerUrl = '/api/credit/v1/providers/%s/';
var providerUrl = '/api/credit/v1/providers/{providerId}/';

return $.ajax({
url: _.sprintf(providerUrl, providerId),
url: edx.StringUtils.interpolate(providerUrl, {providerId: providerId}),
type: 'GET',
dataType: 'json',
contentType: 'application/json',
Expand All @@ -164,9 +158,9 @@ var edx = edx || {};
* @return {object} JQuery Promise.
*/
getCourseData: function (courseId) {
var courseDetailUrl = '/api/course_structure/v0/courses/%s/';
var courseDetailUrl = '/api/course_structure/v0/courses/{courseId}/';
return $.ajax({
url: _.sprintf(courseDetailUrl, courseId),
url: edx.StringUtils.interpolate(courseDetailUrl, {courseId: courseId}),
type: 'GET',
dataType: 'json'
});
Expand Down Expand Up @@ -306,7 +300,7 @@ var edx = edx || {};
el: $('#receipt-container')
});

})(jQuery, _, _.str, Backbone); // jshint ignore:line
})(jQuery, _, Backbone); // jshint ignore:line

function completeOrder(event) { // jshint ignore:line
var courseKey = $(event).data("course-key"),
Expand Down
28 changes: 28 additions & 0 deletions lms/static/js/fixtures/commerce/checkout_receipt.html
@@ -0,0 +1,28 @@
<div id="error-container" class="hidden">
<div id="error" class="wrapper-msg wrapper-msg-activate">
<div class=" msg msg-activate">
<span class="msg-icon icon fa fa-exclamation-triangle" aria-hidden="true"></span>

<div class="msg-content">
<h3 class="title">
Error
</h3>
<div class="copy">
<p>dummy error text</p>
</div>
</div>
</div>
</div>
</div>

<div class="container">
<section class="wrapper carousel">
<div id="receipt-container" class="pay-and-verify hidden" data-is-payment-complete='True'
data-platform-name='edx-platform' data-verified='True' data-username='user-1'
data-is-request-in-themed-site='True'>
<h2>Loading Order Data...</h2>
<span>Please wait while we retrieve your order details.</span>
</div>
</section>
</div>

188 changes: 188 additions & 0 deletions lms/static/js/spec/commerce/receipt_view_spec.js
@@ -0,0 +1,188 @@
define([
'jquery',
'jquery.ajax-retry',
'js/commerce/views/receipt_view',
'common/js/spec_helpers/ajax_helpers'
],
function ($, AjaxRetry, ReceiptView, AjaxHelpers){
'use strict';
describe('edx.commerce.ReceiptView', function() {
var data, courseResponseData, providerResponseData, mockRequests, mockRender, createReceiptView;

createReceiptView = function() {
return new ReceiptView({el: $('#receipt-container')});
};

mockRequests = function(requests, method, apiUrl, responseData) {
AjaxHelpers.expectRequest(requests, method, apiUrl);
AjaxHelpers.respondWithJson(requests, responseData);
};

mockRender = function(useEcommerceOrderNumber, isVerified) {
var requests, view, orderUrlFormat;
requests = AjaxHelpers.requests(this);
$("#receipt-container").data("verified", isVerified);
view = createReceiptView();
view.useEcommerceApi = true;
if (useEcommerceOrderNumber){
view.ecommerceOrderNumber = 'EDX-123456';
orderUrlFormat = '/api/commerce/v1/orders/EDX-123456/';
}
else {
view.ecommerceBasketId = 'EDX-123456';
orderUrlFormat = '/api/commerce/v0/baskets/EDX-123456/order/';
}
view.render();
mockRequests(requests, 'GET', orderUrlFormat, data);

mockRequests(
requests, 'GET', '/api/course_structure/v0/courses/course-v1:edx+dummy+2015_T3/', courseResponseData
);

mockRequests(requests, 'GET', '/api/credit/v1/providers/edx/', providerResponseData);
return view;
};

beforeEach(function() {
var receiptFixture, providerFixture;
// Stub analytics tracking
window.analytics = jasmine.createSpyObj('analytics', ['page', 'track', 'trackLink']);

loadFixtures('js/fixtures/commerce/checkout_receipt.html');

receiptFixture = readFixtures('templates/commerce/receipt.underscore');
providerFixture = readFixtures('templates/commerce/provider.underscore');
appendSetFixtures(
'<script id=\"receipt-tpl\" type=\"text/template\" >' + receiptFixture + '</script>' +
'<script id=\"provider-tpl\" type=\"text/template\" >' + providerFixture + '</script>'
);

data = {
"status": "Open",
"billed_to": {
"city": "dummy city",
"first_name": "john",
"last_name": "doe",
"country": "AL",
"line2": "line2",
"line1": "line1",
"state": "",
"postcode": "12345"
},
"lines": [
{
"status": "Open",
"unit_price_excl_tax": "10.00",
"product": {
"attribute_values": [
{
"name": "certificate_type",
"value": "verified"
},
{
"name": "course_key",
"value": "course-v1:edx+dummy+2015_T3"
},
{
"name": "credit_provider",
"value": "edx"
}
],
"stockrecords": [
{
"price_currency": "USD",
"product": 123,
"partner_sku": "1234ABC",
"partner": 1,
"price_excl_tax": "10.00",
"id": 123
}
],
"product_class": "Seat",
"title": "Dummy title",
"url": "https://ecom.edx.org/api/v2/products/123/",
"price": "10.00",
"expires": null,
"is_available_to_buy": true,
"id": 123,
"structure": "child"
},
"line_price_excl_tax": "10.00",
"description": "dummy description",
"title": "dummy title",
"quantity": 1
}
],
"number": "EDX-123456",
"date_placed": "2016-01-01T01:01:01Z",
"currency": "USD",
"total_excl_tax": "10.00"
};
providerResponseData = {
"id": "edx",
"display_name": "edX",
"url": "http://www.edx.org",
"status_url": "http://www.edx.org/status",
"description": "Nothing",
"enable_integration": false,
"fulfillment_instructions": "",
"thumbnail_url": "http://edx.org/thumbnail.png"
};
courseResponseData = {
"id": "course-v1:edx+dummy+2015_T3",
"name": "receipt test",
"category": "course",
"org": "edx",
"run": "2015_T2",
"course": "CS420",
"uri": "http://test.com/api/course_structure/v0/courses/course-v1:edx+dummy+2015_T3/",
"image_url": "/test.jpg",
"start": "2030-01-01T00:00:00Z",
"end": null
};

});

it('sends analytic event when verified receipt is rendered', function() {
mockRender(true, 'True');
expect(window.analytics.track).toHaveBeenCalledWith(
'Completed Order',
{
orderId: 'EDX-123456',
total: '10.00',
currency: 'USD'
}
);

});

it('sends analytic event when non verified receipt is rendered', function() {
mockRender(true, 'False');
expect(window.analytics.track).toHaveBeenCalledWith(
'Completed Order',
{
orderId: 'EDX-123456',
total: '10.00',
currency: 'USD'
}
);

});

it('renders a receipt correctly with Ecommerce Order Number', function() {
var view;

view = mockRender(true, 'True');
expect(view.$('.course_name_placeholder').text()).toContain('receipt test');
});

it('renders a receipt correctly with Ecommerce Basket Id', function() {
var view;

view = mockRender(false, 'True');
expect(view.$('.course_name_placeholder').text()).toContain('receipt test');
});

});
}
);

0 comments on commit 7a43b57

Please sign in to comment.