RubyGems - retreaverjs-rails - Versions diffs - 0.2.25 → 0.2.26 - Mend

retreaverjs-rails 0.2.25 → 0.2.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

data/vendor/documentation/javascript/v1/retreaver_campaign.js.html ADDED Viewed

@@ -0,0 +1,400 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: retreaver/campaign.js</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Source: retreaver/campaign.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>(function() {
+    // Dependencies
+    var RequestNumber = Retreaver.Base.RequestNumber;
+    /**
+     * @constructor
+     * @memberOf Retreaver
+     * @param {Object} options
+     * @param {String} options.campaign_key - Campaign key
+     * @example
+     * var campaign = new Retreaver.Campaign({ campaign_key: '67d9fb1917ae8f4eaff36831b41788c3' });
+     */
+    var Campaign = function(options) {
+        function initialize(data) {
+            // initialize data store
+            self.store(data);
+        }
+        function find_and_replace_number(replacement_numbers) {
+            for (var i = 0; i &lt; replacement_numbers.length; i++) {
+                var rn = replacement_numbers[i];
+                Retreaver.Vendor.findAndReplaceDOMText(document.getElementsByTagName('body')[0], {
+                    find: rn['find'],
+                    replace: rn['replace_with']
+                });
+                var links = document.getElementsByTagName('a');
+                for (var j = 0; j &lt; links.length; j++) {
+                    var link = links[j];
+                    var href = link.getAttribute('href');
+                    if (href !== null) {
+                        var match = href.match(/^(tel:|clk[a-z]\/tel\/)(.*)/);
+                        if (match &amp;&amp; match[2] === rn['find']) {
+                            link.setAttribute('href', match[1] + rn['replace_with']);
+                        }
+                    }
+                }
+            }
+        }
+        function get_integration_config(number, integration) {
+            const integrations = number.get("integrations");
+            if (typeof(integrations) != 'object') {
+                return;
+            }
+            const integrationConfig = integrations[integration];
+            if (typeof(integrationConfig) == 'undefined') {
+                return;
+            }
+            return integrationConfig;
+        }
+        function handle_google_analytics_integration(number) {
+            googleAnalyticsConfig = get_integration_config(number, "google_analytics");
+            if (typeof(googleAnalyticsConfig) == "undefined") {
+                return;
+            }
+            const obtainGoogleAnalyticsCookies = new Promise(function(resolve) {
+                const googleAnalyticsInterval = setInterval(function() {
+                    const gaSessionIdPattern = /_ga_[^=]+=([^;]*)/;
+                    const gaSessionMatch = document.cookie.match(gaSessionIdPattern);
+                    const gaSessionMatched = gaSessionMatch &amp;&amp; gaSessionMatch[1];
+                    const gaClientIdPattern = /_ga=([^;]*)/;
+                    const gaClientMatch = document.cookie.match(gaClientIdPattern);
+                    const gaClientMatched = gaClientMatch &amp;&amp; gaClientMatch[1];
+                    if (gaSessionMatched &amp;&amp; gaClientMatched) {
+                        resolve({
+                            gaSessionId: gaSessionMatched,
+                            gaClientId: gaClientMatched,
+                        });
+                        clearInterval(googleAnalyticsInterval);
+                    }
+                }, googleAnalyticsConfig["checkIntervalMs"]); // Try to get the Google Analytics session data every X milliseconds
+            })
+            obtainGoogleAnalyticsCookies.then(function (sessionData) {
+                number.replace_tags({
+                    ga_session_id: sessionData.gaSessionId,
+                    ga_client_id: sessionData.gaClientId,
+                });
+            });
+        }
+        function handle_true_call_integration(number) {
+            const trueCallConfig = get_integration_config(number, "truecall.com");
+            if (typeof(trueCallConfig) == "undefined") {
+                return;
+            }
+            // Load the trueCall script into the page it it's missing
+            if(!document.getElementById("__tc_script") || !window.TrueCall) {
+                (function () {
+                    const trueCallScriptTag = document.createElement('script');
+                    trueCallScriptTag.type = 'text/javascript';
+                    trueCallScriptTag.async = true;
+                    trueCallScriptTag.defer = true;
+                    trueCallScriptTag.dataset.campaign_uuid = trueCallConfig["tcCampaignUuid"];
+                    trueCallScriptTag.dataset.use_set_did = "1";
+                    trueCallScriptTag.id = "__tc_script"
+                    trueCallScriptTag.src = trueCallConfig["scriptSrc"];
+                    (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(trueCallScriptTag);
+                })();
+            }
+            const trueCallInterval = setInterval(function() {
+                if (window.TrueCall) {
+                    window.TrueCall.setDID(number.get("number")).then(function() {
+                        clearInterval(trueCallInterval);
+                        return window.TrueCall.getIdAsync();
+                    }).then(function(trueCallId) {
+                        const tags = {};
+                        tags[trueCallConfig["tagName"]] = trueCallId;
+                        number.replace_tags(tags);
+                    });
+                }
+            }, trueCallConfig["checkIntervalMs"]);
+        }
+        function handle_red_track_integration(number) {
+            const redTrackConfig = get_integration_config(number, "red_track");
+            if (typeof(redTrackConfig) == "undefined") {
+                return;
+            }
+            function getRedTrackClickID(name) {
+                const value = '; ' + document.cookie;
+                const parts = value.split('; ' + name + '=');
+                if (parts.length == 2) return parts.pop().split(';').shift();
+            }
+            const obtainRedTrackClickID = new Promise( function (resolve) {
+                const myInterval = setInterval(function () {
+                    const redTrackClickID = getRedTrackClickID('rtkclickid-store');
+                    if (redTrackClickID) {
+                        resolve(redTrackClickID);
+                        clearInterval(myInterval);
+                    }
+                }, redTrackConfig["checkIntervalMs"]);
+            });
+            obtainRedTrackClickID.then(function (redTrackClickID) {
+                const tags = {};
+                tags[redTrackConfig["tagName"]] = redTrackClickID;
+                number.replace_tags(tags);
+            });
+        }
+        function handle_click_flare_integration(number) {
+            const clickFlareConfig = get_integration_config(number, "click_flare");
+            if (typeof(clickFlareConfig) == "undefined") {
+                return;
+            }
+            const getClickFlareClickID = function() {
+                if (window.clickflare &amp;&amp; window.clickflare.data &amp;&amp; window.clickflare.data.event_tokens) {
+                    // ClickFlare has this cv_click_id which is an id that when present tracks the user better and takes
+                    // precedent over cf_click_id.
+                    return (window.clickflare.data.event_tokens.cv_click_id || window.clickflare.data.event_tokens.cf_click_id);
+                }
+            };
+            const obtainClickFlareClickID = new Promise(function (resolve) {
+                const myInterval = setInterval(function () {
+                    const clickFlareClickID = getClickFlareClickID();
+                    if (clickFlareClickID) {
+                        resolve(clickFlareClickID);
+                        clearInterval(myInterval);
+                    }
+                }, clickFlareConfig["checkIntervalMs"]);
+            });
+            obtainClickFlareClickID.then(function (clickFlareClickID) {
+                const tags = {};
+                tags[clickFlareConfig["tagName"]] = clickFlareClickID;
+                number.replace_tags(tags);
+            });
+        }
+        var self = this;
+        self.type = 'campaigns';
+        self.primary_key('campaign_key');
+        self.numbers = [];
+        /**
+         * Fetch a campaign number.
+         * @memberOf Retreaver.Campaign
+         * @function request_number
+         * @instance
+         * @param {Object} [tags] - A collection of tags as key-value pairs. The number returned will match these tags.
+         * @param {getNumberCallback} callback - Callback fired if the request completes successfully.
+         * @param {Function} error_callback - Callback fired if the request raises an error.
+         * @example
+         * campaign.request_number({calling_about: 'support'}, function (number) {
+         *   alert(number.get('number'))
+         * }, function(response){
+         *   alert('something went wrong: ' + response);
+         * };
+         */
+        self.request_number = function(tags, callback, error_callback) {
+            // if the first argument is a function, the user has decided to skip passing tags
+            // therefore cascade the arguments upwards so that everything works as expected
+            if (typeof(tags) === 'function') {
+                // argument 3 becomes argument 2
+                error_callback = callback;
+                // argument 2 becomes argument 1
+                callback = tags;
+                // argument 1 becomes an empty tags object
+                tags = {};
+            }
+            if (typeof callback === 'undefined') {
+                callback = function () {
+                };
+            }
+            if (typeof tags === 'undefined') {
+                tags = {};
+            }
+            // assign the tags (this is important since it runs it through set_number_matching_tags)
+            self.set('number_matching_tags', tags);
+            // request the number
+            new RequestNumber(self.get('campaign_key', 'number_matching_tags')).perform(function(data) {
+                // did retreaver return a valid number?
+                if (typeof(data) !== 'undefined' &amp;&amp; typeof(data.number) !== 'undefined' &amp;&amp; data.number !== '') {
+                    // initialize number
+                    var number = new Retreaver.Number(data.number);
+                    try {
+                        handle_true_call_integration(number);
+                    } catch (e) {
+                        console.error("Could not integrate with truecall.com, ", e);
+                    }
+                    try {
+                        handle_red_track_integration(number);
+                    } catch (e) {
+                        console.error("Could not integrate with Red Track, ", e);
+                    }
+                    try {
+                        handle_google_analytics_integration(number);
+                    } catch (e) {
+                        console.error("Could not integrate with google analytics, ", e);
+                    }
+                    try {
+                        handle_click_flare_integration(number);
+                    } catch (e) {
+                        console.error("Could not integrate with click flare, ", e);
+                    }
+                    // if there is a replacement in the response, replace all occurrences
+                    // of that number on the page with the retreaver number
+                    if (typeof(data.number.replacement_numbers) !== 'undefined') {
+                        find_and_replace_number(data.number.replacement_numbers);
+                    }
+                    // call callback
+                    callback.apply(self, [number]);
+                }
+                // otherwise fire the error callback
+                else if (typeof(error_callback) === 'function') {
+                    error_callback.apply(self, [data]);
+                }
+            });
+        };
+        /**
+         * Auto replace all numbers on page according to campaign settings
+         * Calls campaign.request_number
+         * @memberOf Retreaver.Campaign
+         * @function auto_replace_numbers
+         * @instance
+         * @param {Object} [tags] - A collection of tags as key-value pairs. The number returned will match these tags.
+         * @param {getNumberCallback} callback - Callback fired if the request completes successfully.
+         * @param {Function} error_callback - Callback fired if the request raises an error.
+         * @example
+         * campaign.auto_replace_numbers({calling_about: 'support'}, function (number) {
+         *   alert(number.get('number'))
+         * }, function(response){
+         *   alert('something went wrong: ' + response);
+         * };
+         */
+        self.auto_replace_numbers = function(tags, callback, error_callback) {
+            if (typeof callback === 'undefined') {
+                callback = function() {};
+            }
+            if (typeof error_callback === 'undefined') {
+                error_callback = function() {};
+            }
+            self.request_number(tags, callback, error_callback);
+        };
+        /**
+         * Retreaver.Campaign#request_number callback fired after the request completes.
+         * @callback getNumberCallback
+         * @param {Retreaver.Number} - The number that was returned
+         */
+        self.numbers = function() {
+            var output = [];
+            if (typeof(Retreaver.Base.Data._store) !== 'undefined') {
+                // get numbers
+                var numbers = Retreaver.Base.Data._store['numbers'];
+                // present?
+                if (typeof(numbers) !== 'undefined') {
+                    // collect numbers matching this campaign
+                    for (var primary_key in numbers) {
+                        var number = numbers[primary_key];
+                        if (self.get('campaign_key') == number.campaign_key) {
+                            output.push(new Retreaver.Number(number));
+                        }
+                    }
+                }
+            }
+            return output;
+        };
+        self.set_number_matching_tags = function(tags) {
+            if (typeof(tags) === 'string') {
+                tags = Retreaver.Number.extract_tags_from_string(tags);
+            }
+            if (tags &amp;&amp; (typeof tags === "object") &amp;&amp; !(tags instanceof Array)) {
+                return tags
+            } else {
+                throw "ArgumentError: Expected number_matching_tags to be an object. eg: {tag: 'value'}";
+            }
+        };
+        initialize(options);
+    };
+    Campaign.prototype = new Retreaver.Base.Model();
+    Retreaver.Campaign = Campaign;
+})();
+</code></pre>
+        </article>
+    </section>
+</div>
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Aug 23 2025 21:55:04 GMT+0300 (Eastern European Summer Time)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

data/vendor/documentation/javascript/v1/retreaver_number.js.html ADDED Viewed

@@ -0,0 +1,275 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: retreaver/number.js</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Source: retreaver/number.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>(function () {
+    // Dependencies
+    var Base = Retreaver.Base;
+    /**
+     * @constructor
+     * @memberOf Retreaver
+     * @param {Object} attributes - Attributes
+     * @property {Object} attributes
+     * @property {Number} attributes.id - The CallPixels internal number ID.
+     * @property {String} attributes.formatted_number - Nationally formatted phone number.
+     * @property {String} attributes.number - E.164 formatted phone number.
+     * @property {String} attributes.extension - The extension number.
+     * @property {String} attributes.plain_number - The unformatted phone number digits.
+     * @property {String} attributes.number_extension - The phone number digits with extension.
+     * @property {Boolean} attributes.target_open - Whether there is an open, available target.
+     */
+    Retreaver.Number = function (options) {
+        var self = this;
+        self.type = 'numbers';
+        function initialize(data) {
+            self.store(data);
+            self.set('is_active', 'true');
+        }
+        /**
+         * Add tags to a number.
+         * @memberOf Retreaver.Number
+         * @function add_tags
+         * @instance
+         * @param {Object} tags - A collection of tags {key: 'value', tag2: 'value2'}
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.add_tags = function (tags, callback) {
+            ensure_is_per_visitor();
+            self.post_data('numbers/tag', tags_payload(tags), callback);
+        };
+        /**
+         * Replace tags on a number. Any tags that already exist on the number that match the given keys will be
+         * removed. This can be used instead of calling remove_tags and then add_tags.
+         * @memberOf Retreaver.Number
+         * @function replace_tags
+         * @instance
+         * @param {Object} tags - A collection of tags {key: 'value', tag2: 'value2'}
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.replace_tags = function (tags, callback) {
+            ensure_is_per_visitor();
+            self.post_data('numbers/replace_tags', tags_payload(tags), callback);
+        };
+        /**
+         * Remove tags from a number.
+         * @memberOf Retreaver.Number
+         * @function remove_tags
+         * @instance
+         * @param {Object} tags - A collection of tags {key: 'value', tag2: 'value2'}
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.remove_tags = function (tags, callback) {
+            ensure_is_per_visitor();
+            self.post_data('numbers/untag', tags_payload(tags), callback);
+        };
+        /**
+         * Removes all tags with given keys from a number.
+         * @memberOf Retreaver.Number
+         * @function remove_tags_by_keys
+         * @instance
+         * @param {Array} keys - An array of keys to remove. eg: ['key1', 'key2']
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.remove_tags_by_keys = function (keys, callback) {
+            ensure_is_per_visitor();
+            if (typeof(keys) === 'string') keys = keys.split(',');
+            var payload = {
+                tag_keys: keys,
+                ids: [ get('id') ],
+                campaign_key: get('campaign_key')
+            };
+            self.post_data('numbers/untag/keys', payload, callback);
+        };
+        /**
+         * Clear all tags from a number.
+         * @memberOf Retreaver.Number
+         * @function clear_tags
+         * @instance
+         * @param {Function} callback - Callback that will be fired after request.
+         * @throws Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
+         * with per-visitor numbers enabled.
+         */
+        self.clear_tags = function (callback) {
+            ensure_is_per_visitor();
+            var payload = {
+                ids: [ get('id') ],
+                campaign_key: get('campaign_key'),
+                all: 'true'
+            };
+            self.post_data('numbers/untag', payload, callback);
+        };
+        /**
+         * Release number back to pool.
+         * @memberOf Retreaver.Number
+         * @function release
+         * @instance
+         */
+        self.release = function () {
+            self.set('is_active', 'false');
+        };
+        /**
+         * Start a call immediately by having a campaign target dial the visitor.
+         * @memberOf Retreaver.Number
+         * @function initiate_call
+         * @instance
+         * @param {String} dial - The number to call.
+         * @param {Object} payload - A collection of tags as key-value pairs and optional secure override properties.
+         * @param {string} [payload.target_map] - A string mapping a placeholder number to a phone number.
+         * @param {string} [payload.target_map_cs] - A SHA1 checksum of the target_map concatenated with your CallPixels API
+         * key.
+         * @param {number} [payload.timer_offset] - Number of seconds to offset the "connect" duration timers by.
+         * @param {string} [payload.timer_offset_cs] - An SHA1 checksum of the timer_offset concatenated with your
+         * CallPixels API key.
+         * @param {(string|number)} [payload.*] - Key value pairs treated as tags.
+         * @param {Function} callback - Callback that will be fired after request.
+         * @example
+         * number.initiate_call('4166686980', {company_name: 'CallPixels'}, function (call) {
+         *     alert('Call started with UUID ' + call.uuid)
+         * });
+         */
+        self.initiate_call = function (dial, payload, callback) {
+            if (typeof(payload) === 'undefined') payload = {};
+            // assign dial to payload
+            payload.dial = dial;
+            // merge payload into payload
+            payload = Base.merge(self.get('id', 'campaign_key'), payload);
+            // post the payload
+            self.post_data('numbers/initiate_call', payload, callback);
+        };
+        function tags_payload(tags) {
+            if (typeof(tags) === 'string') tags = Retreaver.Number.extract_tags_from_string(tags);
+            return {
+                tag_values: tags,
+                ids: [ get('id') ],
+                campaign_key: get('campaign_key')
+            };
+        }
+        function get(key) {
+            return self.get(key);
+        }
+        function ensure_is_per_visitor() {
+            if (self.get('is_per_visitor') === false) {
+                throw "Error: Tried to add tags to non per-visitor number.";
+            }
+        }
+        initialize(options);
+    };
+    Retreaver.Number.extract_tags_from_string = function (tags) {
+        var output = {};
+        var tags = tags.split(",");
+        for (var i = 0; i &lt; tags.length; i++) {
+            var tag = tags[i].split(":");
+            output[tag[0]] = tag[1]
+        }
+        return output;
+    };
+    Retreaver.Number.prototype = new Retreaver.Base.Model();
+    function ping_active_numbers(callback) {
+        if (typeof(Retreaver.Base.Data._store) !== 'undefined') {
+            // get numbers
+            var numbers = Retreaver.Base.Data._store['numbers'];
+            // for each number
+            if (typeof(numbers) !== 'undefined') {
+                // group number_ids by campaign_key
+                var grouped = {};
+                for (var primary_key in numbers) {
+                    var number = numbers[primary_key];
+                    if (number.is_active === 'true') {
+                        if (typeof(grouped[number.campaign_key]) === 'undefined') {
+                            grouped[number.campaign_key] = [];
+                            grouped[number.campaign_key]['ids'] = [];
+                            grouped[number.campaign_key]['hashes'] = [];
+                        }
+                        grouped[number.campaign_key]['ids'].push(number.id);
+                        grouped[number.campaign_key]['hashes'].push(number.id_checksum);
+                    }
+                }
+                // ping each group of number_ids
+                for (var campaign_key in grouped) {
+                    var payload = {
+                        ids: grouped[campaign_key].ids,
+                        hashes: grouped[campaign_key].hashes
+                    };
+                    Retreaver.Base.Request.connection().postJSON('/api/v1/numbers/ping', payload, [Retreaver.Base.Model.update, callback], this);
+                }
+            }
+        }
+        // call recursively
+        setTimeout(ping_active_numbers, 15000);
+    }
+    // always ping active numbers
+    ping_active_numbers();
+})();</code></pre>
+        </article>
+    </section>
+</div>
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3><a href="global.html">Global</a></h3>
+</nav>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Aug 23 2025 21:55:04 GMT+0300 (Eastern European Summer Time)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>