cocoon_ads.js

(function () {

    if (!window.Cocoon && window.cordova && typeof require !== 'undefined') {
        cordova.require('cocoon-plugin-common.Cocoon');
    }
    var Cocoon = window.Cocoon;

    /**
     * @fileOverview

     <h2>About Atomic Plugins</h2>
     <p>Atomic Plugins provide an elegant and minimalist API and are designed with portability in mind from the beginning. Framework dependencies are avoided by design so the plugins can run on any platform and can be integrated with any app framework or game engine.
     <br/><p>You can contribute and help to create more awesome plugins. </p>
     <h2>Atomic Plugins for Ads</h2>
     <p>This repo contains Ad APIs designed using the Atomic Plugins paradigm. Monetize your app and take advantage of all the features provided: elegant API, flexible monetization solution that works across multiple platforms, full support for banners and full screen ads (interstitials), single API for different Ad Providers, etc. The API is already available in many languagues and we have the plan to add more in the future.</p>
     <p>Currently there are 2 Ad providers implemented but new ones can be easily added:</p>
     <ul>
     <li>MoPub with optional adapters</li>
     <li>AdMob</li>
     </ul>
     <h3>Setup your project</h3>
     <p>Releases are deployed to NPM.
     You only have to install the desired plugins using Cordova CLI and <a href="https://cocoon.io"/>Cocoon Cloud service</a>.</p>
     <ul>
     // MoPub<br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-admob</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-mopub</code><br/><br/>
     // Optional MoPub adapters for iOS and Android<br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub-adcolony</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub-admob</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub-chartboost</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub-greystripe</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub-inmobi</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub-millennialmedia</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-mopub-admob</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-mopub-chartboost</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-mopub-millennial</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-mopub-adcolony</code><br/><br/>
     // AdMob<br/>
     <code>cordova plugin add cocoon-plugin-ads-android-admob</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-android-mopub</code><br/><br/>
     // Optional AdMob adapters for iOS and Android<br/>
     <code>cordova plugin add cocoon-plugin-ads-android-admob-adcolony</code><br/>
     <code>cordova plugin add cocoon-plugin-ads-ios-admob-adcolony</code><br/>
     </ul>
     <h3>Documentation</h3>
     <p>In this section you will find all the documentation you need for using this plugin in your Cordova project.
     Select the specific namespace below to open the relevant documentation section:</p>
     <ul>
     <li><a href="http://ludei.github.io/atomic-plugins-docs/dist/doc/js/Cocoon.Ad.html">Cocoon Ads</a></li>
     </ul>
     <h3>Full example</h3>
     See a full example here: <a href="https://github.com/CocoonIO/cocoon-template-ads"/>Ads demo</a>
     * @version 1.0
     */

    /**
     * Cocoon.Ad class provides an easy to use Ads API that can be used with different Ad providers with built-in support for multiple banners and interstitials.
     * @namespace Cocoon.Ad
     */

    Cocoon.define("Cocoon.Ad", function (extension) {
        "use strict";

        /**
         * The predefined possible layouts for a banner ad.
         * @name Cocoon.Ad.BannerLayout
         * @memberOf Cocoon.Ad
         * @property {string} TOP_CENTER Specifies that the banner must be shown in the top of the screen and vertically centered.
         * @property {string} BOTTOM_CENTER Specifies that the banner must be shown in the bottom of the screen and vertically centered.
         * @property {string} CUSTOM Specifies that the uses sets a custom banner position
         */
        extension.BannerLayout =
            {
                TOP_CENTER: "TOP_CENTER",
                BOTTOM_CENTER: "BOTTOM_CENTER",
                CUSTOM: "CUSTOM"
            };

        /**
         * The predefined possible sizes for a banner ad.
         * @name Cocoon.Ad.BannerSize
         * @memberOf Cocoon.Ad
         * @property {string} SMART Smart banner size according to screen size (Phones and Tablets)
         * @property {string} BANNER Standard banner size (Phones and Tablets)
         * @property {string} MEDIUM_RECT Medium rectangle size (Phones and Tablets)
         * @property {string} LEADERBOARD Leaderboard size (Tablets)
         */
        extension.BannerSize =
            {
                SMART: "SMART",
                BANNER: "BANNER",
                MEDIUM_RECT: "MEDIUM_RECT",
                LEADERBOARD: "LEADERBOARD"
            };

        /**
         * @private
         */
        extension.Banner = function (bannerId, serviceName) {
            this.id = bannerId;
            this.serviceName = serviceName;
            this.signal = new Cocoon.Signal();
            this.width = 0;
            this.height = 0;
            this.ready = false;
        };

        /**
         *
         * @namespace Cocoon.Ad.Banner
         * @example
         *
         * banner = Cocoon.Ad.createBanner();
         *
         * banner.on("load", function(){
    *    console.log("Banner loaded " + banner.width, banner.height);
    *    banner.show();
    * });
         *
         * banner.on("fail", function(){
    *    console.log("Banner failed to load");
    * });
         *
         * banner.on("show", function(){
    *    console.log("Banner shown a modal content");
    * });
         *
         * banner.on("dismiss", function(){
    *    console.log("Banner dismissed the modal content");
    * });
         *
         * banner.on("click", function(){
    *    console.log("Banner clicked");
    * });
         *
         * banner.load();
         */
        extension.Banner.prototype = {

            /**
             * Shows the banner ad.
             * @memberOf Cocoon.Ad.Banner
             * @function show
             * @example
             * myBanner = Cocoon.Ad.createBanner(settings);
             * myBanner.show();
             */
            show: function () {
                Cocoon.exec(this.serviceName, "showBanner", [this.id]);
            },

            /**
             * Hides the banner ad.
             * @memberOf Cocoon.Ad.Banner
             * @function hide
             * @example
             * banner = Cocoon.Ad.createBanner(settings);
             * banner.hide();
             */
            hide: function () {
                Cocoon.exec(this.serviceName, "hideBanner", [this.id]);
            },

            /**
             * Sets a specific layout for a banner ad.
             * @memberOf Cocoon.Ad.Banner
             * @function setLayout
             * @param {Cocoon.Ad.BannerLayout} layout The predefined layout for a banner ad.
             * @example
             * banner = Cocoon.Ad.createBanner(settings);
             * banner.setLayout(layout); // If CUSTOM layout
             */
            setLayout: function (layout) {
                Cocoon.exec(this.serviceName, "setBannerLayout", [this.id, layout]);
            },

            /**
             * Sets a specific position for a banner ad in CUSTOM layout.
             * @memberOf Cocoon.Ad.Banner
             * @function setPosition
             * @param {number} x The top lef x coordinate of the banner.
             * @param {number} y The top lef y coordinate of the banner.
             * @example
             * banner = Cocoon.Ad.createBanner(settings);
             * banner.setLayout(layout); // If CUSTOM layout
             * banner.setPosition(x, y);
             */
            setPosition: function (x, y) {
                Cocoon.exec(this.serviceName, "setBannerPosition", [this.id, x, y]);
            },

            /**
             * Loads a banner ad.
             * @memberOf Cocoon.Ad.Banner
             * @function load
             * @example
             * banner = Cocoon.Ad.createBanner(settings);
             * banner.load();
             */
            load: function () {
                Cocoon.exec(this.serviceName, "loadBanner", [this.id]);
            },

            /**
             * Checks if the banner is loaded and ready
             * @memberOf Cocoon.Ad.Banner
             * @function isReady
             * @example
             * var ready = banner.isReady();
             */
            isReady: function () {
                return this.ready;
            },

            /**
             * Triggered when a new banner is loaded.
             * @memberOf Cocoon.Ad.Banner
             * @event On load
             * @example
             * banner.on("load", function(){
        *    console.log("Banner loaded " + banner.width, banner.height);
        * });
             */

            /**
             * Triggered when the loading process of a banner has failed.
             * @memberOf Cocoon.Ad.Banner
             * @event On fail
             * @example
             * banner.on("fail", function(error){
        *    console.log("Banner failed to load: " + JSON.stringify(error));
        * });
             */

            /**
             * Triggered when a new banner is expanded to full screen.
             * @memberOf Cocoon.Ad.Banner
             * @event On show
             * @example
             * banner.on("show", function(){
        *    console.log("Banner shown a modal content");
        * });
             */

            /**
             * Triggered when a banner is collapsed.
             * @memberOf Cocoon.Ad.Banner
             * @event On dismiss
             * @example
             * banner.on("dismiss", function(){
        *    console.log("Banner dismissed the modal content");
        * });
             */

            /**
             * Triggered when a banner is clicked.
             * @memberOf Cocoon.Ad.Banner
             * @event On click
             * @example
             * banner.on("click", function(){
        *    console.log("Banner clicked");
        * });
             */

            on: function (eventName, handler) {
                this.signal.on(eventName, handler);
            }
        };

        /**
         * @private
         */
        extension.Interstitial = function (interstitialId, serviceName) {
            this.id = interstitialId;
            this.serviceName = serviceName;
            this.signal = new Cocoon.Signal();
            this.ready = false;
        };

        /**
         *
         * @namespace Cocoon.Ad.Interstitial
         * @example
         * interstitial = Cocoon.Ad.createInterstitial();
         *
         * interstitial.on("load", function(){
    *     console.log("Interstitial loaded");
    * });
         * interstitial.on("fail", function(){
    *     console.log("Interstitial failed");
    * });
         * interstitial.on("show", function(){
    *     console.log("Interstitial shown");
    * });
         * interstitial.on("dismiss", function(){
    *     console.log("Interstitial dismissed");
    * });
         *
         * interstitial.on("click", function(){
    *     console.log("Interstitial clicked");
    * });
         *
         * interstitial.load();
         */
        extension.Interstitial.prototype = {

            /**
             * Shows the interstitial ad.
             * @memberOf Cocoon.Ad.Interstitial
             * @function show
             * @example
             * interstitial = Cocoon.Ad.createInterstitial(settings);
             * interstitial.show();
             */
            show: function () {
                this.ready = false; //true on next load event
                Cocoon.exec(this.serviceName, "showInterstitial", [this.id]);
            },

            /**
             * Loads an interstitial ad.
             * @memberOf Cocoon.Ad.Interstitial
             * @function load
             * @example
             * interstitial = Cocoon.Ad.createInterstitial(settings);
             * interstitial.load();
             */
            load: function () {
                Cocoon.exec(this.serviceName, "loadInterstitial", [this.id]);
            },

            /**
             * Checks if the interstitial is loaded and ready
             * @memberOf Cocoon.Ad.Interstitial
             * @function isReady
             * @example
             * var ready = interstitial.isReady();
             */
            isReady: function () {
                return this.ready;
            },

            /**
             * Triggered when a new interstitial is loaded.
             * @memberOf Cocoon.Ad.Interstitial
             * @event On load
             * @example
             * banner.on("load", function(){
        *    console.log("Interstitial loaded");
        * });
             */

            /**
             * Triggered when the loading process of an interstitial has failed.
             * @memberOf Cocoon.Ad.Interstitial
             * @event On fail
             * @example
             * interstitial.on("fail", function(error){
        *    console.log("Interstitial failed to load: " + JSON.stringify(error));
        * });
             */

            /**
             * Triggered when a new interstitial is shown.
             * @memberOf Cocoon.Ad.Interstitial
             * @event On show
             * @example
             * interstitial.on("show", function(){
        *    console.log("Interstitial shown");
        * });
             */

            /**
             * Triggered when an interstitial is closed.
             * @memberOf Cocoon.Ad.Interstitial
             * @event On dismiss
             * @example
             * interstitial.on("dimissed", function(){
        *    console.log("Interstitial dimissed");
        * });
             */

            /**
             * Triggered when an interstitial is clicked.
             * @memberOf Cocoon.Ad.Interstitial
             * @event On click
             * @example
             * interstitial.on("click", function(){
        *    console.log("Interstitial clicked");
        * });
             */

            on: function (eventName, handler) {
                this.signal.on(eventName, handler);
            }
        };

        /**
         * @private
         */
        extension.RewardedVideo = function (rewardedVideoId, serviceName) {
            this.id = rewardedVideoId;
            this.serviceName = serviceName;
            this.signal = new Cocoon.Signal();
            this.ready = false;
        };

        /**
         *
         * @namespace Cocoon.Ad.RewardedVideo
         * @example
         * rewardedVideo = Cocoon.Ad.createRewardedVideo();
         *
         * rewardedVideo.on("load", function(){
    *     console.log("Rewarded video loaded");
    * });
         * rewardedVideo.on("fail", function(){
    *     console.log("Rewarded video failed");
    * });
         * rewardedVideo.on("show", function(){
    *     console.log("Rewarded video shown");
    * });
         * rewardedVideo.on("dismiss", function(){
    *     console.log("Rewarded video dismissed");
    * });
         *
         * rewardedVideo.on("click", function(){
    *     console.log("Rewarded video clicked");
    * });
         *
         * rewardedVideo.load();
         */
        extension.RewardedVideo.prototype = {

            /**
             * Shows the rewarded video ad.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @function show
             * @example
             * rewardedVideo = Cocoon.Ad.createRewardedVideo(settings);
             * rewardedVideo.show();
             */
            show: function () {
                this.ready = false; //true on next load event
                Cocoon.exec(this.serviceName, "showRewardedVideo", [this.id]);
            },

            /**
             * Loads an rewarded video ad.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @function load
             * @example
             * rewardedVideo = Cocoon.Ad.createRewardedVideo(settings);
             * rewardedVideo.load();
             */
            load: function () {
                Cocoon.exec(this.serviceName, "loadRewardedVideo", [this.id]);
            },

            /**
             * Checks if the rewarded video is loaded and ready
             * @memberOf Cocoon.Ad.RewardedVideo
             * @function isReady
             * @example
             * var ready = rewardedVideo.isReady();
             */
            isReady: function () {
                return this.ready;
            },

            /**
             * Triggered when a new rewarded video is loaded.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @event On load
             * @example
             * banner.on("load", function(){
        *    console.log("Rewarded video loaded");
        * });
             */

            /**
             * Triggered when the loading process of an rewarded video has failed.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @event On fail
             * @example
             * rewardedVideo.on("fail", function(error){
        *    console.log("Rewarded video failed to load: " + JSON.stringify(error));
        * });
             */

            /**
             * Triggered when a new rewarded video is shown.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @event On show
             * @example
             * rewardedVideo.on("show", function(){
        *    console.log("Rewarded video shown");
        * });
             */

            /**
             * Triggered when an rewarded video is closed.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @event On dismiss
             * @example
             * rewardedVideo.on("dimissed", function(){
        *    console.log("Rewarded video dismissed");
        * });
             */

            /**
             * Triggered when an rewarded video is clicked.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @event On click
             * @example
             * rewardedVideo.on("click", function(){
        *    console.log("Rewarded video clicked");
        * });
             */

            /**
             * Triggered when a video reward is completed.
             * @memberOf Cocoon.Ad.RewardedVideo
             * @event On reward
             * @example
             * rewardedVideo.on("reward", function(reward, error){
         *   if (reward && reward.amount > 0) {
         *     console.log("Reward completed. Earned " + reward.amount + " items");
         *   }
         * });
             */

            on: function (eventName, handler) {
                this.signal.on(eventName, handler);
            }
        };

        var idCounter = 0;


        extension.AdService = function (serviceName) {
            this.serviceName = serviceName;
            this.activeAds = {};
        };

        var proto = {};
        extension.AdService.prototype = proto;


        /**
         * @memberOf Cocoon.Ad
         * @function listenerHandler
         * @private
         */
        proto.listenerHandler = function (args) {
            var eventName = args[0];
            var adId = args[1];
            var params = args.slice(2);

            var ad = this.activeAds[adId];
            if (ad) {

                if (eventName === "load") {
                    ad.ready = true;
                }
                else if (eventName === "fail") {
                    ad.ready = false;
                }
                if (eventName === "load" && params.length > 0) {
                    //cache banner size
                    ad.width = params[0];
                    ad.height = params[1];
                    params = params.slice(2);
                }

                ad.signal.emit(eventName, null, params);
            }
        };

        /**
         * @memberOf Cocoon.Ad
         * @function init
         * @private
         */
        proto.init = function () {
            if (this.initialized) {
                return;
            }
            Cocoon.exec(this.serviceName, "setBannerListener", [], this.listenerHandler.bind(this));
            Cocoon.exec(this.serviceName, "setInterstitialListener", [], this.listenerHandler.bind(this));
            Cocoon.exec(this.serviceName, "setRewardedVideoListener", [], this.listenerHandler.bind(this));

            this.initialized = true;
        };

        /**
         * Configure default banner and interstitial adUnits.
         * @memberOf Cocoon.Ad
         * @function configure
         * @param {object} [settings] The banner optional settings.
         * @example
         * //Global configuration
         *Cocoon.Ads.configure({
    *     banner:"agltb3B1Yi1pbmNyDQsSBFNpdGUxxxxxxx",
    *     interstitial:"agltb3B1Yi1pbmNyDQsSBFNpdGUyyyyyyy"
    *})
         * //Or platform specific configuration
         *Cocoon.Ads.configure({
    *     ios: {
    *          banner:"agltb3B1Yi1pbmNyDQsSBFNpdGUxxxxxxx",
    *          bannerIpad:"agltb3B1Yi1pbmNyDQsSBFNpdGUzzzzz", //optional
    *          interstitial:"agltb3B1Yi1pbmNyDQsSBFNpdGUyyyyyyy",
    *          interstitialIpad:"agltb3B1Yi1pbmNyDQsSBFNpdGUtttttt", //optional
    *     },
    *     android: {
    *          banner:"agltb3B1Yi1pbmNyDQsSBFNpdGUwwwwww",
    *          interstitial:"agltb3B1Yi1pbmNyDQsSBFNpdGUhhhhhh"
    *     }
    *);*
    */
        proto.configure = function (settings) {

            var platform = Cocoon.getPlatform();
            if (platform === Cocoon.PlatformType.AMAZON && settings[Cocoon.PlatformType.ANDROID]) {
                //fallback from amazon to android if only android specified
                platform = Cocoon.PlatformType.ANDROID;
            }
            if (settings[platform]) {
                settings = settings[platform];
            }

            Cocoon.exec(this.serviceName, "configure", [settings]);
        };

        /**
         * Creates a banner.
         * @memberOf Cocoon.Ad
         * @function createBanner
         * @param {string} [adUnit] banner adUnit. Taken from cordova settings or configure method if not specified.
         * @param {Cocoon.Ad.BannerSize} [size] The banner size. Default value: Smart Size
         * @return {Cocoon.Ad.Banner} banner A new banner ad.
         * @example
         * var banner = Cocoon.Ad.createBanner();
         * banner.load();
         */
        proto.createBanner = function (adUnit, size) {
            this.init();
            var bannerId = idCounter++;
            Cocoon.exec(this.serviceName, "createBanner", [bannerId, adUnit, size]);
            var banner = new extension.Banner(bannerId, this.serviceName);
            this.activeAds[bannerId] = banner;
            return banner;
        };

        /**
         * Releases the banner given.
         * @memberOf Cocoon.Ad
         * @function releaseBanner
         * @param {Cocoon.Ad.Banner} banner The banner ad to release.
         * @example
         * Cocoon.Ad.releaseBanner(banner);
         */
        proto.releaseBanner = function (banner) {
            Cocoon.exec(this.serviceName, "releaseBanner", [banner.id]);
            delete this.activeAds[id];
        };

        /**
         * Creates an interstitial.
         * @memberOf Cocoon.Ad
         * @function createInterstitial
         * @param {string} [adUnit] Interstitial adUnit. Taken from cordova settings or configure method if not specified.
         * @return {Cocoon.Ad.Interstitial} A new interstitial.
         * @example
         * var interstitial = Cocoon.Ad.createInterstitial();
         * interstitial.load();
         */
        proto.createInterstitial = function (adUnit) {
            this.init();
            var interstitialId = idCounter++;
            Cocoon.exec(this.serviceName, "createInterstitial", [interstitialId, adUnit]);
            var interstitial = new extension.Interstitial(interstitialId, this.serviceName);
            this.activeAds[interstitialId] = interstitial;
            return interstitial;
        };

        /**
         * Releases the interstitial given.
         * @memberOf Cocoon.Ad
         * @function releaseInterstitial
         * @param {Cocoon.Ad.Interstitial} interstitial The interstitial to release.
         * @example
         * Cocoon.Ad.releaseInterstitial(interstitial);
         */
        proto.releaseInterstitial = function (interstitial) {
            Cocoon.exec(this.serviceName, "releaseInterstitial", [interstitial.id]);
            delete this.activeAds[interstitial.id];
        };

        /**
         * Creates a rewarded video (only supported in some networks)
         * @memberOf Cocoon.Ad
         * @function createRewardedVideo
         * @param {string} [adUnit] RewardedVideo adUnit. Taken from cordova settings or configure method if not specified.
         * @return {Cocoon.Ad.RewardedVideo} A new rewarded video.
         * @example
         * var rewardedVideo = Cocoon.Ad.createRewardedVideo();
         * rewardedVideo.load();
         */
        proto.createRewardedVideo = function (adUnit) {
            this.init();
            var rewardedVideoId = idCounter++;
            Cocoon.exec(this.serviceName, "createRewardedVideo", [rewardedVideoId, adUnit]);
            var rewardedVideo = new extension.RewardedVideo(rewardedVideoId, this.serviceName);
            this.activeAds[rewardedVideoId] = rewardedVideo;
            return rewardedVideo;
        };

        /**
         * Releases the rewarded video given.
         * @memberOf Cocoon.Ad
         * @function releaseRewardedVideo
         * @param {Cocoon.Ad.RewardedVideo} rewardedVideo The rewarded video to release.
         * @example
         * Cocoon.Ad.releaseRewardedVideo(rewardedVideo);
         */
        proto.releaseRewardedVideo = function (rewardedVideo) {
            Cocoon.exec(this.serviceName, "releaseRewardedVideo", [rewardedVideo.id]);
            delete this.activeAds[rewardedVideo.id];
        };

        //compatibility for Cocoon.Ad methods
        extension.serviceName = "LDAdService";
        extension.activeAds = {};
        for (var key in proto) {
            if (proto.hasOwnProperty(key)) {
                extension[key] = proto[key];
            }
        }

        return extension;
    });

})();