Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix to issue #4 and test case #30

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 57 additions & 13 deletions src/vast-vmap.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,60 @@ var VASTAds, VASTAd, VASTLinear, VASTNonLinear, VASTCompanion;
* identifier.
*/
function fetchXML(url, identifier, onSuccess, onFailure) {
var request = new XMLHttpRequest();
request.onreadystatechange = function() {
if (request.readyState === 4) {
if (request.status === 200) {
if (request.responseXML !== null) {
onSuccess(request.responseXML, identifier);
var request;

// IE 9 CORS method
if (window.XDomainRequest)
{
request = new XDomainRequest();

request.onload = function()
{

if (request.contentType != null && request.responseText != null)
{

// IE < 10 requires to parse the XML as string in order to use the getElementsByTagNameNS method
var parser = new DOMParser();
var doc = parser.parseFromString(request.responseText, 'text/xml');

onSuccess(doc, identifier);

}
else
onFailure(request, identifier);

};

request.onerror = request.ontimeout = function()
{
onFailure(request, identifier);
};

}
else // The standard one
{

request = new XMLHttpRequest();

request.onreadystatechange = function() {
if (request.readyState === 4) {
if (request.status === 200) {
if (request.responseXML !== null) {
onSuccess(request.responseXML, identifier);
} else {
onFailure(request, identifier);
}
} else {
onFailure(request, identifier);
}
} else {
onFailure(request, identifier);
}
}
};
};

}

request.open("GET", url, true);
request.withCredentials = true; // Accept cookies
request.send(null);
}

Expand All @@ -53,8 +91,9 @@ function fetchXML(url, identifier, onSuccess, onFailure) {
* @param { {function()}} onError Function to call when no ads are fetched
* or there was an error requesting the endpoint
* @param {?VASTAd} parentAd The ad containing the results from this query
* @param {funciton()}} onFinish Fuction to call when request is finished
*/
function queryVAST(endpoint, onFetched, onError, parentAd) {
function queryVAST(endpoint, onFetched, onError, parentAd, onFinish) {
fetchXML(endpoint, null, function(doc) {
try {
new VASTAds(doc, onFetched, onError, parentAd);
Expand All @@ -70,9 +109,14 @@ function queryVAST(endpoint, onFetched, onError, parentAd) {

onError();
}

if (onFinish) onFinish();

}, function (e) {
console.error("Failed to load VAST from '" + endpoint + "':", e);
onError();

if (onFinish) onFinish();
});
}

Expand Down Expand Up @@ -473,7 +517,7 @@ function VASTAds(root, onAdsAvailable, onError, parentAd) {
if (that.onAdsAvailable) {
var oaf = that.onAdsAvailable;
that.onAdsAvailable = null;
oaf.call(that, that);
oaf.call(that, ads);
}
};
})(ad, allowPods, that);
Expand Down Expand Up @@ -1086,7 +1130,7 @@ function VASTLinear(ad, root) {
this.clickThrough = null;
this.duration = null;
this.adParameters = null;

var i;

var clicks = root.getElementsByTagName("VideoClicks");
Expand Down
86 changes: 86 additions & 0 deletions test/assets/vast_multiple_wrappers/vast_final.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?xml version="1.0" encoding="utf-8"?>
<VAST version="2.0">
<Ad id="73843">
<InLine>
<AdSystem><![CDATA[smartclip]]></AdSystem>
<AdTitle><![CDATA[FI - GSK Panadol Forte w48-51 / Gr. 1d, PostRoll]]></AdTitle>
<Description><![CDATA[Description]]></Description>
<Impression id="SMARTCLIP"><![CDATA[http://stats.smartclip.net/stats/beacon?3;14320;82950;400x300
;6092258;16040156;0;439609;;smd_id1=829ace6d-f523-417e-a4ea-1fbceb0f91c4;1795298916]]></Impression><Impression
id="smartclip_x"><![CDATA[http://cdn.smartclip.net/assets/9999999/blank.gif]]></Impression>
<Impression id="Impression"><![CDATA[http://servedby.flashtalking.com/imp/2/55692;1545406;261;pixel
;SmartClip;AutoTag/?ft_creative=1242819&ft_configuration=0&ft_section=iltalehti.html5.fi.smartclip_400x300
&cachebuster=1763165317]]></Impression>
<Impression id="3rdparty"><![CDATA[http://track.adform.net/adfserve/?bn=9210903;1x1inv=1;srctype
=3;ord=1763165317]]></Impression>
<Impression id="3rdparty"><![CDATA[http://visitanalytics.userreport.com/hit.gif?t=SMC439609-1106
&RND=1763165317]]></Impression>
<Impression id="3rdparty"><![CDATA[http://visitanalytics.userreport.com/hit.gif?t=SMC439609&RND=1763165317
]]></Impression>
<Impression id="SMARTCLIP_dsp1"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=10]]></Impression
><Impression id="SMARTCLIP_dsp2"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=28]]></Impression
><Impression id="SMARTCLIP_dsp3"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=30]]></Impression
><Impression id="SMARTCLIP_dsp4"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=31]]></Impression
><Impression id="SMARTCLIP_dsp5"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=39]]></Impression
><Impression id="SMARTCLIP_dsp6"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=29]]></Impression
>
<Impression id="SMARTCLIP_dsp7"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=40]]></Impression
>
<Impression id="SMARTCLIP_dsp8"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=43]]></Impression
><Impression id="SMARTCLIP_dsp9"><![CDATA[http://ad.sxp.smartclip.net/sync?type=red&dsp=11]]></Impression
>
<Creatives>
<Creative id="16040156" AdID="73843" sequence="1">
<Linear>
<Duration>00:00:21</Duration>
<TrackingEvents>
<Tracking event="start"><![CDATA[http://stats.smartclip.net/stats/start?3;14320;82950;400x300
;6092258;16040156;0;439609;;smd_id1=829ace6d-f523-417e-a4ea-1fbceb0f91c4;1409220644]]></Tracking>
<Tracking event="firstQuartile"><![CDATA[http://stats.smartclip.net/stats/firstqt?3;14320
;82950;400x300;6092258;16040156;0;439609;;smd_id1=829ace6d-f523-417e-a4ea-1fbceb0f91c4;1352135857]]>
</Tracking>
<Tracking event="midpoint"><![CDATA[http://stats.smartclip.net/stats/midpoint?3;14320;82950
;400x300;6092258;16040156;0;439609;;smd_id1=829ace6d-f523-417e-a4ea-1fbceb0f91c4;1101684290]]></Tracking
>
<Tracking event="thirdQuartile"><![CDATA[http://stats.smartclip.net/stats/thirdqt?3;14320
;82950;400x300;6092258;16040156;0;439609;;smd_id1=829ace6d-f523-417e-a4ea-1fbceb0f91c4;1500881193]]>
</Tracking>
<Tracking event="complete"><![CDATA[http://stats.smartclip.net/stats/complete?3;14320;82950
;400x300;6092258;16040156;0;439609;;smd_id1=829ace6d-f523-417e-a4ea-1fbceb0f91c4;2136076487]]></Tracking
>
<Tracking event="complete"><![CDATA[http://cdn.smartclip.net/assets/9999999/blank.gif]]></Tracking
>

<Tracking event="start"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?58978262-0-13-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>
<Tracking event="firstQuartile"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?58978262-0-14-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>
<Tracking event="midpoint"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?58978262-0-15-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>
<Tracking event="thirdQuartile"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?58978262-0-16-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>
<Tracking event="complete"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?58978262-0-17-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>
<Tracking event="mute"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?30315065-0-38-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>
<Tracking event="fullscreen"><![CDATA[http://stat240.flashtalking.com/reportV3/ft.stat?58978262-0-313-0-99999999999999-1763165317-iltalehti
.html5.fi.smartclip_400x300]]></Tracking>

</TrackingEvents>
<VideoClicks>
<ClickThrough><![CDATA[http://linear.test.com]]></ClickThrough>
</VideoClicks>
<MediaFiles>
<MediaFile id="" width="640" height="360" bitrate="670" type="video/mp4" delivery="progressive"
maintainAspectRatio="true" scalable="true"><![CDATA[http://cdn.flashtalking.com/52971/101870_241115_GSK_Panadol_670
.mp4]]></MediaFile>
<MediaFile id="" width="640" height="360" bitrate="300" type="video/mp4" delivery="progressive" maintainAspectRatio
="true" scalable="true"><![CDATA[http://cdn.flashtalking.com/52971/101870_241115_GSK_Panadol_300.mp4
]]></MediaFile>
</MediaFiles>
</Linear>
</Creative>
</Creatives>
</InLine>
</Ad>
</VAST>
27 changes: 27 additions & 0 deletions test/assets/vast_multiple_wrappers/vast_wrapper_2.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<VAST version="2.0">
<Ad id="">
<Wrapper>
<AdSystem>sxc</AdSystem>
<VASTAdTagURI>
<![CDATA[./test/assets/vast_multiple_wrappers/vast_wrapper_3.xml]]>
</VASTAdTagURI>
<Error></Error>
<Impression>
<![CDATA[http://cdn.smartclip.net/assets/9999999/blank.gif]]>
</Impression>
<Creatives>
<Creative AdID="">
<Linear>
<VideoClicks>
<ClickTracking>
</ClickTracking>
</VideoClicks>
<TrackingEvents>
</TrackingEvents>
</Linear>
</Creative>
</Creatives>
</Wrapper>
</Ad>
</VAST>
61 changes: 61 additions & 0 deletions test/assets/vast_multiple_wrappers/vast_wrapper_3.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<?xml version="1.0" encoding="utf-8"?>
<VAST version="2.0">
<Ad id="73843">
<Wrapper>
<AdSystem>SMARTX</AdSystem>
<VASTAdTagURI>
<![CDATA[./test/assets/vast_multiple_wrappers/vast_final.xml]]>
</VASTAdTagURI>
<Error></Error>
<Impression>
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=imp&crea=85529&ite=DIR_73843&cpg=DIR_6305 &adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631&ep=1448961277 &pac=1&unili=1&uuli=MTY3ODkuMDpESVJfNzM4NDM&url=]]>
</Impression>
<Creatives>
<Creative AdID="73843">
<Linear>
<VideoClicks>
<ClickTracking>
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=cli&crea=85529&ite=DIR_73843&cpg =DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631&ep=1448961277 &url=]]>
</ClickTracking>
</VideoClicks>
<TrackingEvents>
<Tracking event="creativeView">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=creativeView&crea =85529&ite=DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="start">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=start&crea=85529&ite=DIR_73843 &cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="firstQuartile">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=firstQuartile &crea=85529&ite=DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="midpoint">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=midpoint&crea=85529 &ite=DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="thirdQuartile">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=thirdQuartile &crea=85529&ite=DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="complete">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=complete&crea=85529 &ite=DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="mute">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=mute&crea=85529&ite=DIR_73843 &cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="unmute">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=unmute&crea=85529&ite =DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="pause">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=pause&crea=85529&ite=DIR_73843 &cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="resume">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=resume&crea=85529&ite =DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
<Tracking event="fullscreen">
<![CDATA[http://stats-irl.sxp.smartclip.net/count?type=fullscreen&crea=85529 &ite=DIR_73843&cpg=DIR_6305&adv=DIR_2021&plc=59654&sit=1106&net=9&pub=803&iid=5cc6ee5f-0c45-429b-b2de-95a2942ab631 &ep=1448961277&url=http://stats-irl.sxp.smartclip.net/img/trpx.gif]]>
</Tracking>
</TrackingEvents>
</Linear>
</Creative>
</Creatives>
</Wrapper>
</Ad>
</VAST>
20 changes: 20 additions & 0 deletions test/assets/vast_multiple_wrappers/vast_wrapper_entry.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<VAST version="2.0">
<Ad id="EAS_cu_0_12050">
<Wrapper>
<AdSystem version="EmediateAd">4.47.2</AdSystem>
<VASTAdTagURI>./test/assets/vast_multiple_wrappers/vast_wrapper_2.xml</VASTAdTagURI>
<Impression id="EAS_camp_0_235136">http://localhost</Impression>
<Creatives>
<Creative id="EAS_cre_0_411983" AdID="123456">
<Linear>
<TrackingEvents>
</TrackingEvents>
<VideoClicks>
</VideoClicks>
</Linear>
</Creative>
</Creatives>
</Wrapper>
</Ad>
</VAST>
39 changes: 39 additions & 0 deletions test/test-multiple-wrapper-singlead-linear.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
var assert = buster.referee.assert;
var refute = buster.referee.refute;

buster.testCase("Multiple wrapped ad", {
prepare: function(done) {
var that = this;
queryVAST("./test/assets/vast_multiple_wrappers/vast_wrapper_entry.xml", function(ads) {
that.vast = ads;
done();
});
},

setUp: function() {
this.ad = this.vast.getAd();
this.ad.sentImpression = false;
},

"has ad": function() {
refute.isNull(this.ad);
},

"finds linear": function() {
refute.isNull(this.ad.linear);
},

"finds linear click through": function() {
assert.equals(this.ad.linear.clickThrough, "http://linear.test.com");

},

"finds linear media files": function() {
assert.equals(this.ad.linear.mediaFiles.length, 2);
},

"finds linear media files": function() {
assert.equals(this.ad.linear.duration, 21);
},

})